Skip to content

⚡ Bolt: [performance improvement] Pre-compile regexes and cache static lists in keyword_density#314

Open
anchapin wants to merge 1 commit into
mainfrom
bolt-optimize-keyword-density-6125094139170230434
Open

⚡ Bolt: [performance improvement] Pre-compile regexes and cache static lists in keyword_density#314
anchapin wants to merge 1 commit into
mainfrom
bolt-optimize-keyword-density-6125094139170230434

Conversation

@anchapin
Copy link
Copy Markdown
Owner

@anchapin anchapin commented May 22, 2026

💡 What: Extracted regex objects and statically defined lists from inside functions (_extract_job_details, _simple_keyword_extraction, _suggest_sections_for_keyword) into module-level constants. tech_keywords was converted from a list to a set.

🎯 Why: During text parsing and report generation, recreating arrays, compiling regexes, and doing linear scans through lists on each method call introduces an unnecessary overhead. The KeywordDensityGenerator analyzes block text and these elements are static.

📊 Impact: Reduces memory allocations and avoids repetitive regex compilation parsing during keyword extraction and density analysis. O(1) membership checking on _TECH_KEYWORDS.

🔬 Measurement: Verify changes in cli/utils/keyword_density.py. Run make format, make lint and the python -m pytest tests/test_keyword_density.py testing suite to ensure the text parsing and analysis remains identical.


PR created automatically by Jules for task 6125094139170230434 started by @anchapin

Summary by Sourcery

Optimize keyword density analysis by hoisting regex patterns and keyword collections to module-level constants and updating internal documentation with the new performance learnings.

Enhancements:

  • Pre-compile job title and company regex patterns and reuse them across keyword density operations.
  • Cache common keyword lists as module-level constants and switch tech keyword storage to a set for faster membership checks.

Documentation:

  • Expand internal bolt notes with guidance on caching regexes and static collections at module scope for performance.

Moves inline compiled regexes and list/set allocations in `cli/utils/keyword_density.py` to module-level constants (`_TITLE_PATTERNS`, `_COMPANY_PATTERNS`, `_COMMON_KEYWORDS`, `_TECH_KEYWORDS`) to prevent overhead on every function call. Includes converting `_TECH_KEYWORDS` from a list to a set for O(1) lookups.

Co-authored-by: anchapin <6326294+anchapin@users.noreply.github.com>
@google-labs-jules
Copy link
Copy Markdown
Contributor

👋 Jules, reporting for duty! I'm here to lend a hand with this pull request.

When you start a review, I'll add a 👀 emoji to each comment to let you know I've read it. I'll focus on feedback directed at me and will do my best to stay out of conversations between you and other bots or reviewers to keep the noise down.

I'll push a commit with your requested changes shortly after. Please note there might be a delay between these steps, but rest assured I'm on the job!

For more direct control, you can switch me to Reactive Mode. When this mode is on, I will only act on comments where you specifically mention me with @jules. You can find this option in the Pull Request section of your global Jules UI settings. You can always switch back!

New to Jules? Learn more at jules.google/docs.


For security, I will only act on instructions from the user who triggered this task.

@sourcery-ai
Copy link
Copy Markdown

sourcery-ai Bot commented May 22, 2026

Reviewer's Guide

Pre-compiles regex patterns and hoists static keyword collections in keyword_density to module-level constants, switching tech keyword lookups to a set for faster membership checks, and documents the performance pattern in the Bolt notes.

File-Level Changes

Change Details Files
Hoisted job title and company regex patterns to pre-compiled module-level constants and updated extraction logic to use them.
  • Introduced _TITLE_PATTERNS as a list of compiled regex objects for job title extraction.
  • Introduced _COMPANY_PATTERNS as a list of compiled regex objects for company extraction.
  • Replaced re.search calls in _extract_job_details with iteration over the pre-compiled regex objects using pattern.search.
cli/utils/keyword_density.py
Extracted common keyword list to a module-level constant and reused it in simple keyword extraction.
  • Defined _COMMON_KEYWORDS as a module-level tuple of (keyword, importance) pairs.
  • Updated _simple_keyword_extraction to iterate over _COMMON_KEYWORDS instead of creating a new list each call.
cli/utils/keyword_density.py
Converted tech keyword list to a module-level set for O(1) membership checks in section suggestions.
  • Defined _TECH_KEYWORDS as a module-level set of technology keywords.
  • Replaced per-call tech_keywords list construction in _suggest_sections_for_keyword with membership checks against _TECH_KEYWORDS.
cli/utils/keyword_density.py
Documented the new performance optimization pattern in Bolt engineering notes.
  • Added a "Module-level Regex and List Caching" entry describing the learning and action items around hoisting regex and list allocations for performance.
.jules/bolt.md

Tips and commands

Interacting with Sourcery

  • Trigger a new review: Comment @sourcery-ai review on the pull request.
  • Continue discussions: Reply directly to Sourcery's review comments.
  • Generate a GitHub issue from a review comment: Ask Sourcery to create an
    issue from a review comment by replying to it. You can also reply to a
    review comment with @sourcery-ai issue to create an issue from it.
  • Generate a pull request title: Write @sourcery-ai anywhere in the pull
    request title to generate a title at any time. You can also comment
    @sourcery-ai title on the pull request to (re-)generate the title at any time.
  • Generate a pull request summary: Write @sourcery-ai summary anywhere in
    the pull request body to generate a PR summary at any time exactly where you
    want it. You can also comment @sourcery-ai summary on the pull request to
    (re-)generate the summary at any time.
  • Generate reviewer's guide: Comment @sourcery-ai guide on the pull
    request to (re-)generate the reviewer's guide at any time.
  • Resolve all Sourcery comments: Comment @sourcery-ai resolve on the
    pull request to resolve all Sourcery comments. Useful if you've already
    addressed all the comments and don't want to see them anymore.
  • Dismiss all Sourcery reviews: Comment @sourcery-ai dismiss on the pull
    request to dismiss all existing Sourcery reviews. Especially useful if you
    want to start fresh with a new review - don't forget to comment
    @sourcery-ai review to trigger a new review!

Customizing Your Experience

Access your dashboard to:

  • Enable or disable review features such as the Sourcery-generated pull request
    summary, the reviewer's guide, and others.
  • Change the review language.
  • Add, remove or edit custom review instructions.
  • Adjust other review settings.

Getting Help

Copy link
Copy Markdown

@sourcery-ai sourcery-ai Bot left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Hey - I've left some high level feedback:

  • Consider deriving _TECH_KEYWORDS programmatically from _COMMON_KEYWORDS (or documenting why it intentionally diverges), so future changes to one list don’t silently fall out of sync with the other.
  • Since these pre-compiled regexes and keyword collections are effectively constants, you might standardize the naming convention (e.g., either drop the leading underscore or add a short comment about them being private module-level constants) to make their intended usage and visibility clearer.
Prompt for AI Agents
Please address the comments from this code review:

## Overall Comments
- Consider deriving `_TECH_KEYWORDS` programmatically from `_COMMON_KEYWORDS` (or documenting why it intentionally diverges), so future changes to one list don’t silently fall out of sync with the other.
- Since these pre-compiled regexes and keyword collections are effectively constants, you might standardize the naming convention (e.g., either drop the leading underscore or add a short comment about them being private module-level constants) to make their intended usage and visibility clearer.

Sourcery is free for open source - if you like our reviews please consider sharing them ✨
Help me be more useful! Please click 👍 or 👎 on each comment and I'll use the feedback to improve your reviews.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

1 participant