refactor: update cache storage initialization to use create_with method - #16
Merged
Conversation
Contributor
There was a problem hiding this comment.
Pull Request Overview
This PR refactors the cache storage initialization approach by replacing lambda functions with a new create_with class method for TTLMapStorage and TTLMapAsyncStorage. This change improves code readability and provides a more consistent API pattern for storage configuration.
- Introduces
create_withclass methods that return callables for creating storage instances - Updates all documentation and test files to use the new initialization pattern
- Maintains backward compatibility while offering a cleaner alternative to lambda-based initialization
Reviewed Changes
Copilot reviewed 9 out of 9 changed files in this pull request and generated 2 comments.
Show a summary per file
| File | Description |
|---|---|
| cachium/storages/ttl_map.py | Adds create_with class methods to both storage classes for simplified instantiation |
| tests/test__decorator.py | Updates test cases to use new create_with method instead of lambda functions |
| docs/index.md | Updates documentation examples to demonstrate new initialization pattern |
| docs/guides/tutorials.md | Updates tutorial examples with new storage initialization approach |
| docs/guides/quickstart.md | Updates quickstart guide to use create_with method |
| docs/examples.md | Updates all code examples to use new storage initialization pattern |
| cachium/_decorators.py | Updates docstring example to show new initialization method |
| README.md | Refactors examples to use new pattern and improves async example clarity |
| todo | Minor addition of refactor task item |
Tip: Customize your code reviews with copilot-instructions.md. Create the file or learn how to get started.
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
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.
No description provided.