Update token_handler.py

[DedyKredo]

Type

enhancement, bug_fix

---

Description

• Introduced error handling in _get_system_user_tokens to return -1 when an exception occurs, enhancing robustness.
• Minor formatting fix in count_tokens method.

---

Changes walkthrough

	Relevant files
Error handling	token_handler.py Enhance Error Handling in Token Calculation                            pr_agent/algo/token_handler.py Wrapped token calculation logic in _get_system_user_tokens with a try-except block. Returns -1 if an exception occurs during token calculation. No change in the logic of count_tokens method, just formatting adjustment. +10/-7

---

✨ PR-Agent usage:
Comment /help on the PR to get a list of all available PR-Agent tools and their descriptions

[codiumai-pr-agent-pro]

PR Description updated to latest commit (a461c2a)

• Copy walkthrough table to "Files Changed" Tab

[codiumai-pr-agent-pro]

PR Review

⏱️ Estimated effort to review [1-5]	2, because the changes are localized to a single file and involve straightforward enhancements, including error handling and minor formatting adjustments. The logic within the methods is not complex, and the modifications are concise.
🏅 Score	85
🧪 Relevant tests	No
🔍 Possible issues	Error Handling Generality: The exception handling in _get_system_user_tokens uses a bare except, which might catch more exceptions than intended, potentially masking different kinds of errors. It's generally a good practice to catch specific exceptions.
	Magic Number: Returning -1 in case of an error is not self-explanatory and could benefit from either documentation or using a named constant that explains its significance.
🔒 Security concerns	No

---

✨ Review tool usage guide:

---

Overview:
The review tool scans the PR code changes, and generates a PR review. The tool can be triggered automatically every time a new PR is opened, or can be invoked manually by commenting on any PR.
When commenting, to edit configurations related to the review tool (pr_reviewer section), use the following template:

/review --pr_reviewer.some_config1=... --pr_reviewer.some_config2=...

With a configuration file, use the following template:

[pr_reviewer]
some_config1=...
some_config2=...

Utilizing extra instructions The review tool can be configured with extra instructions, which can be used to guide the model to a feedback tailored to the needs of your project. Be specific, clear, and concise in the instructions. With extra instructions, you are the prompter. Specify the relevant sub-tool, and the relevant aspects of the PR that you want to emphasize. Examples for extra instructions: [pr_reviewer] # /review # extra_instructions=""" In the 'possible issues' section, emphasize the following: - Does the code logic cover relevant edge cases? - Is the code logic clear and easy to understand? - Is the code logic efficient? ... """ Use triple quotes to write multi-line instructions. Use bullet points to make the instructions more readable.

How to enable\disable automation When you first install PR-Agent app, the default mode for the review tool is: pr_commands = ["/review", ...] meaning the review tool will run automatically on every PR, with the default configuration. Edit this field to enable/disable the tool, or to change the used configurations

Auto-labels The review tool can auto-generate two specific types of labels for a PR: a possible security issue label, that detects possible security issues (enable_review_labels_security flag) a Review effort [1-5]: x label, where x is the estimated effort to review the PR (enable_review_labels_effort flag)

Extra sub-tools The review tool provides a collection of possible feedbacks about a PR. It is recommended to review the possible options, and choose the ones relevant for your use case. Some of the feature that are disabled by default are quite useful, and should be considered for enabling. For example: require_score_review, require_soc2_ticket, and more.

Auto-approve PRs By invoking: /review auto_approve The tool will automatically approve the PR, and add a comment with the approval. To ensure safety, the auto-approval feature is disabled by default. To enable auto-approval, you need to actively set in a pre-defined configuration file the following: [pr_reviewer] enable_auto_approval = true (this specific flag cannot be set with a command line argument, only in the configuration file, committed to the repository) You can also enable auto-approval only if the PR meets certain requirements, such as that the estimated_review_effort is equal or below a certain threshold, by adjusting the flag: [pr_reviewer] maximal_review_effort = 5

More PR-Agent commands To invoke the PR-Agent, add a comment using one of the following commands: /review: Request a review of your Pull Request. /describe: Update the PR title and description based on the contents of the PR. /improve [--extended]: Suggest code improvements. Extended mode provides a higher quality feedback. /ask <QUESTION>: Ask a question about the PR. /update_changelog: Update the changelog based on the PR's contents. /add_docs 💎: Generate docstring for new components introduced in the PR. /generate_labels 💎: Generate labels for the PR based on the PR's contents. /analyze 💎: Automatically analyzes the PR, and presents changes walkthrough for each component. See the tools guide for more details. To list the possible configuration parameters, add a /config comment.

See the review usage page for a comprehensive guide on using this tool.

[codiumai-pr-agent-pro]

PR Code Suggestions

Category	Suggestions
Best practice	Specify the exception type in the try-except block. It's recommended to specify the exception type in the try-except block to avoid catching unexpected exceptions. This will make the error handling more precise and easier to debug. For instance, if you're expecting a template rendering error, you might catch jinja2.exceptions.TemplateError. pr_agent/algo/token_handler.py [52-60] try: environment = Environment(undefined=StrictUndefined) system_prompt = environment.from_string(system).render(vars) user_prompt = environment.from_string(user).render(vars) system_prompt_tokens = len(encoder.encode(system_prompt)) user_prompt_tokens = len(encoder.encode(user_prompt)) return system_prompt_tokens + user_prompt_tokens -except: +except jinja2.exceptions.TemplateError: return -1
	Use custom exceptions instead of magic numbers for error handling. Instead of returning a magic number (-1) to indicate an error, consider raising a custom exception. This approach makes the error handling more explicit and allows the caller to decide how to handle the error. pr_agent/algo/token_handler.py [60] -except: - return -1 +except jinja2.exceptions.TemplateError as e: + raise CustomTemplateRenderException("Failed to render templates") from e
Maintainability	Reduce code duplication by creating a function for encoding prompts. The encoder.encode method is called twice with similar arguments. Consider refactoring this by creating a function that takes a string and returns the number of tokens. This will reduce code duplication and improve readability. pr_agent/algo/token_handler.py [56-57] -system_prompt_tokens = len(encoder.encode(system_prompt)) -user_prompt_tokens = len(encoder.encode(user_prompt)) +def get_token_count(prompt): + return len(encoder.encode(prompt)) +system_prompt_tokens = get_token_count(system_prompt) +user_prompt_tokens = get_token_count(user_prompt) +
Clarity	Clarify the intention behind the disallowed_special parameter in encoder.encode. The disallowed_special parameter is set to an empty tuple, which might not be the intended behavior. If there are specific special tokens that should be disallowed, specify them explicitly. Otherwise, if the intention is to allow all tokens, consider removing the parameter for clarity. pr_agent/algo/token_handler.py [72] -return len(self.encoder.encode(patch, disallowed_special=())) +return len(self.encoder.encode(patch))
Readability	Use more descriptive variable names than vars. To improve the maintainability and readability of the code, consider using more descriptive variable names than vars. For example, template_vars or render_vars would provide more context about the purpose and usage of this variable. pr_agent/algo/token_handler.py [54-55] -system_prompt = environment.from_string(system).render(vars) -user_prompt = environment.from_string(user).render(vars) +system_prompt = environment.from_string(system).render(template_vars) +user_prompt = environment.from_string(user).render(template_vars)

---

✨ Improve tool usage guide:

---

Overview:
The improve tool scans the PR code changes, and automatically generates suggestions for improving the PR code. The tool can be triggered automatically every time a new PR is opened, or can be invoked manually by commenting on a PR.
When commenting, to edit configurations related to the improve tool (pr_code_suggestions section), use the following template:

/improve --pr_code_suggestions.some_config1=... --pr_code_suggestions.some_config2=...

With a configuration file, use the following template:

[pr_code_suggestions]
some_config1=...
some_config2=...

Enabling\disabling automation When you first install the app, the default mode for the improve tool is: pr_commands = ["/improve --pr_code_suggestions.summarize=true", ...] meaning the improve tool will run automatically on every PR, with summarization enabled. Delete this line to disable the tool from running automatically.

Utilizing extra instructions Extra instructions are very important for the improve tool, since they enable to guide the model to suggestions that are more relevant to the specific needs of the project. Be specific, clear, and concise in the instructions. With extra instructions, you are the prompter. Specify relevant aspects that you want the model to focus on. Examples for extra instructions: [pr_code_suggestions] # /improve # extra_instructions=""" Emphasize the following aspects: - Does the code logic cover relevant edge cases? - Is the code logic clear and easy to understand? - Is the code logic efficient? ... """ Use triple quotes to write multi-line instructions. Use bullet points to make the instructions more readable.

A note on code suggestions quality While the current AI for code is getting better and better (GPT-4), it's not flawless. Not all the suggestions will be perfect, and a user should not accept all of them automatically. Suggestions are not meant to be simplistic. Instead, they aim to give deep feedback and raise questions, ideas and thoughts to the user, who can then use his judgment, experience, and understanding of the code base. Recommended to use the 'extra_instructions' field to guide the model to suggestions that are more relevant to the specific needs of the project, or use the custom suggestions 💎 tool With large PRs, best quality will be obtained by using 'improve --extended' mode.

More PR-Agent commands To invoke the PR-Agent, add a comment using one of the following commands: /review: Request a review of your Pull Request. /describe: Update the PR title and description based on the contents of the PR. /improve [--extended]: Suggest code improvements. Extended mode provides a higher quality feedback. /ask <QUESTION>: Ask a question about the PR. /update_changelog: Update the changelog based on the PR's contents. /add_docs 💎: Generate docstring for new components introduced in the PR. /generate_labels 💎: Generate labels for the PR based on the PR's contents. /analyze 💎: Automatically analyzes the PR, and presents changes walkthrough for each component. See the tools guide for more details. To list the possible configuration parameters, add a /config comment.

See the improve usage page for a more comprehensive guide on using this tool.