Update token_handler.py

[DedyKredo]

Type

bug_fix, enhancement

---

Description

• Introduced error handling in _get_system_user_tokens to return -1 when an exception occurs, enhancing robustness.
• Adjusted formatting in count_tokens method without altering its functionality.

---

Changes walkthrough

	Relevant files
Error handling	token_handler.py Enhance Token Calculation with Error Handling                        pr_agent/algo/token_handler.py Wrapped token calculation in _get_system_user_tokens with a try-except block. Returns -1 if an exception occurs during token calculation. No changes made to the count_tokens method, only formatting adjusted. +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 straightforward and localized to a single file with clear purposes: error handling and formatting. The logic within the methods is not complex.
🏅 Score	85
🧪 Relevant tests	No
🔍 Possible issues	Silent Failure: Returning -1 on exception in _get_system_user_tokens could lead to silent failures where the error is not properly logged or handled upstream. Consider logging the exception or rethrowing a custom exception with additional context.
🔒 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, which can make debugging harder. For instance, if you're expecting a TemplateSyntaxError from Jinja2 when rendering the template, you should catch that specific exception. 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 TemplateSyntaxError: return -1
	Clarify the handling of special tokens in count_tokens. When encoding the patch in count_tokens, consider handling or documenting the choice of passing an empty tuple to disallowed_special. This could potentially lead to confusion or unintended behavior if special tokens are expected to be filtered or handled differently. pr_agent/algo/token_handler.py [72] +# If special tokens need to be considered, adjust the disallowed_special parameter accordingly. return len(self.encoder.encode(patch, disallowed_special=()))
Maintainability	Extract token encoding and counting logic into a separate method. To improve code readability and maintainability, consider extracting the token encoding and counting logic into a separate private method. This will make _get_system_user_tokens more concise and easier to understand. pr_agent/algo/token_handler.py [56-58] -system_prompt_tokens = len(encoder.encode(system_prompt)) -user_prompt_tokens = len(encoder.encode(user_prompt)) +def _encode_and_count_tokens(self, prompt): + return len(self.encoder.encode(prompt)) + +system_prompt_tokens = self._encode_and_count_tokens(system_prompt) +user_prompt_tokens = self._encode_and_count_tokens(user_prompt) return system_prompt_tokens + user_prompt_tokens

---

✨ 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.

[DedyKredo]

/help

[codiumai-pr-agent-pro]

PR Agent Walkthrough

🤖 Welcome to the PR Agent, an AI-powered tool for automated pull request analysis, feedback, suggestions and more.

Here is a list of tools you can use to interact with the PR Agent:

Tool	Description	Invoke Interactively 💎
DESCRIBE	Generates PR description - title, type, summary, code walkthrough and labels	Run
REVIEW	Adjustable feedback about the PR, possible issues, security concerns, review effort and more	Run
IMPROVE	Code suggestions for improving the PR.	Run
ANALYZE 💎	Identifies code components that changed in the PR, and enables to interactively generate tests, docs, and code suggestions for each component.	Run
UPDATE CHANGELOG	Automatically updates the changelog.	Run
ADD DOCUMENTATION 💎	Generates documentation to methods/functions/classes that changed in the PR.	Run
ASK	Answering free-text questions about the PR.	[*]
GENERATE CUSTOM LABELS	Generates custom labels for the PR, based on specific guidelines defined by the user	[*]
TEST 💎	Generates unit tests for a specific component, based on the PR code change.	[*]
CI FEEDBACK 💎	Generates feedback and analysis for a failed CI job.	[*]
CUSTOM SUGGESTIONS 💎	Generates custom suggestions for improving the PR code, based on specific guidelines defined by the user.	[*]
SIMILAR ISSUE	Automatically retrieves and presents similar issues.	[*]

(1) Note that each tool be triggered automatically when a new PR is opened, or called manually by commenting on a PR.

(2) Tools marked with [*] require additional parameters to be passed. For example, to invoke the /ask tool, you need to comment on a PR: /ask "<question content>". See the relevant documentation for each tool for more details.

[codiumai-pr-agent-pro]

PR Documentation

Here is a list of the files that were modified in the PR, with docstring for each altered code component:

token_handler.py                                                                                                                                _get_system_user_tokens (method) [+9/-6]                                                                                                        Component signature: def _get_system_user_tokens(self, pr, encoder, vars: dict, system, user): Docstring: """ Calculates the number of tokens in the system and user strings. Args: - pr: The pull request object. - encoder: An object of the encoding_for_model class from the tiktoken module. - vars: A dictionary of variables. - system: The system string. - user: The user string. Returns: The sum of the number of tokens in the system and user strings. """

[codiumai-pr-agent-pro]

Changelog updates:

2024-03-14

Enhanced

• Introduced error handling in _get_system_user_tokens to return -1 when an exception occurs, enhancing robustness.
• Adjusted formatting in count_tokens method without altering its functionality.

to commit the new content to the CHANGELOG.md file, please type:
'/update_changelog --pr_update_changelog.push_changelog_changes=true'