perf: cache parsed requirements#828
Merged
abn merged 1 commit intopython-poetry:mainfrom Jan 26, 2025
Merged
Conversation
Reviewer's Guide by SourceryThis pull request introduces caching for parsed requirements using the Sequence diagram for cached requirement parsingsequenceDiagram
participant Client
participant Parser
participant Cache
Note over Parser: New caching mechanism
Client->>Parser: parse_requirement(requirement_string)
alt Cache hit
Parser->>Cache: Check cache
Cache-->>Parser: Return cached Requirement
Parser-->>Client: Return cached Requirement
else Cache miss
Parser->>Cache: Check cache
Cache-->>Parser: Not found
Parser->>Parser: Create new Requirement
Parser->>Cache: Store in cache
Parser-->>Client: Return new Requirement
end
Class diagram for requirement parsing changesclassDiagram
class Requirement {
+str name
+str url
+Sequence[str] extras
+str constraint
+__init__(requirement_string: str)
+__str__()
+__repr__()
}
class RequirementParser {
+@cache parse_requirement(requirement_string: str)
}
RequirementParser ..> Requirement : creates
note for RequirementParser "New cached parser function"
File-Level Changes
Tips and commandsInteracting with Sourcery
Customizing Your ExperienceAccess your dashboard to:
Getting Help
|
![sourcery-ai[bot]](https://avatars.githubusercontent.com/in/48477?s=60&v=4){kind=small}
There was a problem hiding this comment.
Hey @radoering - I've reviewed your changes and they look great!
Here's what I looked at during the review
- 🟢 General issues: all looks good
- 🟢 Security: all looks good
- 🟢 Testing: all looks good
- 🟢 Complexity: all looks good
- 🟢 Documentation: all looks good
Help me be more useful! Please click 👍 or 👎 on each comment and I'll use the feedback to improve your reviews.
2 tasks
abn
approved these changes
Jan 26, 2025
3 tasks
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
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
2 participants
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.
Caching the requirements should be safe because we use them read-only.
Testing with the
pyproject.tomlfrom python-poetry/poetry#9956 (comment):Summary by Sourcery
Cache parsed requirement strings to improve performance, especially when regenerating lock files.
Enhancements:
functools.cache.Tests: