You signed in with another tab or window. Reload to refresh your session.You signed out in another tab or window. Reload to refresh your session.You switched accounts on another tab or window. Reload to refresh your session.Dismiss alert
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Although we had configured the feature to merge language-specific instructions from user settings into the extra instructions, that logic was not being executed in our GitHub Action.
Changes (What)
Added logic to merge language-specific instructions specified in user settings into the extra_instructions array
PR Type
Enhancement
Description
• Add language-specific instructions to extra instructions for non-English locales
• Merge response language settings into PR tools configuration
• Enhance internationalization support for PR agent tools
Changes diagram
flowchart LR
A["User Settings"] --> B["Check Response Language"]
B --> C{"Language != en-us?"}
C -->|Yes| D["Create Language Instruction"]
D --> E["Append to Extra Instructions"]
E --> F["Update PR Tools Config"]
C -->|No| G["Skip Language Instructions"]
Loading
Changes walkthrough 📝
Relevant files
Enhancement
utils.py
Add language-specific instruction merging logic
pr_agent/git_providers/utils.py
• Import DynaBox from dynaconf utilities • Add logic to check response_language setting • Append language-specific instructions to PR tools when non-English locale is set • Update extra_instructions for PR description, code suggestions, and reviewer tools
The code iterates through all settings using get_settings() in a loop, which could be inefficient. Consider directly accessing the specific settings needed instead of iterating through all configuration keys.
The string containment check lang_instruction_text not in str(extra_instructions) may produce false positives if the language instruction text appears as a substring in existing instructions, potentially leading to duplicate additions.
The hardcoded list of tool names in the condition check makes the code brittle and harder to maintain. Consider using a configuration-driven approach or constants to define which tools should receive language instructions.
ifkey.lower() in ['pr_description', 'pr_code_suggestions', 'pr_reviewer']:
ifhasattr(setting, 'extra_instructions'):
Iterating over the entire settings object may not yield the specific review components. Target the known instruction keys directly using getattr on get_settings(), ensuring you only update pr_description, pr_code_suggestions, and pr_reviewer. This change avoids missing or unintended keys during the update.
-for key in get_settings():- setting = get_settings().get(key)+settings = get_settings()+for key in ['pr_description', 'pr_code_suggestions', 'pr_reviewer']:+ setting = getattr(settings, key, None)
if isinstance(setting, DynaBox):
Apply / Chat
Suggestion importance[1-10]: 5
__
Why: Narrowing the loop to only pr_description, pr_code_suggestions, and pr_reviewer makes the intent clearer and avoids iterating unrelated settings, improving maintainability with minimal impact.
Low
Guard against non-string locale values
Ensure response_language is a string before calling .lower() to prevent attribute errors if the setting is non-string. Converting it with str() guards against unexpected types.
Why: Casting response_language to str prevents potential attribute errors for unexpected types, but it's a defensive change with low overall impact.
Low
General
Cache settings before loop
Cache the result of get_settings() in a local variable before the loop to avoid repeated calls and improve performance. This also prevents any side effects if get_settings() has internal state.
The current logic may append multiple conflicting language instructions if the language setting is changed, as it only checks for the new instruction text. Additionally, the loop iterates over all settings inefficiently. The suggested change makes the update idempotent by removing any pre-existing language instruction before adding the new one, and it improves performance by iterating only over relevant keys.
-for key in get_settings():- setting = get_settings().get(key)- if isinstance(setting, DynaBox):- if key.lower() in ['pr_description', 'pr_code_suggestions', 'pr_reviewer']:- if hasattr(setting, 'extra_instructions'):- extra_instructions = setting.extra_instructions+settings = get_settings()+tool_keys = ['pr_description', 'pr_code_suggestions', 'pr_reviewer']+base_instruction = "Your response MUST be written in the language corresponding to locale code:"- if lang_instruction_text not in str(extra_instructions):- updated_instructions = (- str(extra_instructions) + separator_text + lang_instruction_text- if extra_instructions else lang_instruction_text- )- setting.extra_instructions = updated_instructions+for key in tool_keys:+ setting = settings.get(key)+ if isinstance(setting, DynaBox) and hasattr(setting, 'extra_instructions'):+ instructions_str = str(setting.extra_instructions or "")+ # Remove previous language instruction to ensure idempotency+ instruction_pos = instructions_str.find(base_instruction)+ if instruction_pos != -1:+ separator_pos = instructions_str.rfind(separator_text, 0, instruction_pos)+ if separator_pos != -1:+ instructions_str = instructions_str[:separator_pos]+ else:+ instructions_str = ""++ # Add the new language instruction+ if instructions_str:+ updated_instructions = f"{instructions_str}{separator_text}{lang_instruction_text}"+ else:+ updated_instructions = lang_instruction_text+ setting.extra_instructions = updated_instructions+
Suggestion importance[1-10]: 8
__
Why: The suggestion correctly identifies a potential bug where changing the response language could lead to multiple, conflicting language instructions being appended. It also rightly points out that iterating over a predefined list of keys is more efficient than iterating over all settings. The proposed fix is robust and improves the correctness of the new feature.
The current loop iterates over all settings, which is inefficient. It's better to iterate directly over the specific tool configurations you intend to modify. This change makes the code more direct, readable, and performant by avoiding unnecessary iterations and checks.
Calling get_settings() multiple times in a loop is inefficient and could lead to inconsistent state. Store the settings object once and reuse it throughout the loop.
-for key in get_settings():- setting = get_settings().get(key)+settings = get_settings()+for key in settings:+ setting = settings.get(key)
if isinstance(setting, DynaBox):
if key.lower() in ['pr_description', 'pr_code_suggestions', 'pr_reviewer']:
Suggestion importance[1-10]: 6
__
Why: The suggestion correctly identifies that get_settings() is called multiple times within a loop, which is inefficient. Caching the settings object in a variable before the loop is a good practice that improves both performance and code readability.
Low
Add explicit None check
The string conversion and substring check could fail if extra_instructions is None or has unexpected type. Add explicit None check before string operations to prevent potential runtime errors.
-if lang_instruction_text not in str(extra_instructions):+if extra_instructions is None or lang_instruction_text not in str(extra_instructions):
updated_instructions = (
str(extra_instructions) + separator_text + lang_instruction_text
if extra_instructions else lang_instruction_text
)
setting.extra_instructions = updated_instructions
Suggestion importance[1-10]: 5
__
Why: The suggestion improves code clarity and robustness by adding an explicit extra_instructions is None check. While the original code handles the None case correctly due to the ternary operator, the suggested change makes the intent clearer and avoids the potentially confusing str(None) conversion in the condition.
Low
Fix case-insensitive string comparison
The comparison should be case-insensitive for both the retrieved value and the default. The current code only lowercases the retrieved value but not the default comparison value.
Why: The suggestion to use .lower() on the hardcoded string 'en-us' is redundant because the string is already in lowercase. This change has no functional impact on the code's behavior.
Add this suggestion to a batch that can be applied as a single commit.This suggestion is invalid because no changes were made to the code.Suggestions cannot be applied while the pull request is closed.Suggestions cannot be applied while viewing a subset of changes.Only one suggestion per line can be applied in a batch.Add this suggestion to a batch that can be applied as a single commit.Applying suggestions on deleted lines is not supported.You must change the existing code in this line in order to create a valid suggestion.Outdated suggestions cannot be applied.This suggestion has been applied or marked resolved.Suggestions cannot be applied from pending reviews.Suggestions cannot be applied on multi-line comments.Suggestions cannot be applied while the pull request is queued to merge.Suggestion cannot be applied right now. Please check back later.
User description
Background (Why)
Although we had configured the feature to merge language-specific instructions from user settings into the extra instructions, that logic was not being executed in our GitHub Action.
Changes (What)
extra_instructionsarrayPR Type
Enhancement
Description
• Add language-specific instructions to extra instructions for non-English locales
• Merge response language settings into PR tools configuration
• Enhance internationalization support for PR agent tools
Changes diagram
flowchart LR A["User Settings"] --> B["Check Response Language"] B --> C{"Language != en-us?"} C -->|Yes| D["Create Language Instruction"] D --> E["Append to Extra Instructions"] E --> F["Update PR Tools Config"] C -->|No| G["Skip Language Instructions"]Changes walkthrough 📝
utils.py
Add language-specific instruction merging logicpr_agent/git_providers/utils.py
• Import
DynaBoxfrom dynaconf utilities• Add logic to check
response_languagesetting• Append language-specific instructions to
PR tools when non-English locale is set
• Update
extra_instructionsfor PR description, code suggestions, and reviewer tools