fix: adjusted type hints for UUID when uuid-utils is not installed
#133
Conversation
![sourcery-ai[bot]](https://avatars.githubusercontent.com/in/48477?s=60&v=4){kind=small}
There was a problem hiding this comment.
PR Type: Refactoring
PR Summary: This pull request focuses on adjusting type hints and import logic for UUID handling within the advanced_alchemy project, specifically when the optional dependency uuid-utils is not installed. It introduces conditional imports based on the presence of uuid-utils and refines type annotations and checks throughout the affected modules to ensure compatibility and correct behavior regardless of whether uuid-utils is available.
Decision: Comment
📝 Type: 'Refactoring' - not supported yet.
- Sourcery currently only approves 'Typo fix' PRs.
✅ Issue addressed: this change correctly addresses the issue or implements the desired feature.
No details provided.
✅ Small diff: the diff is small enough to approve with confidence.
No details provided.
General suggestions:
- Consider using
isinstancefor type checks instead of comparing the class name as a string. This approach is more robust and idiomatic in Python, providing better support for inheritance and readability. - When casting types, especially in the context of decoding values, ensure that the input data is of the expected format to avoid runtime errors. It might be beneficial to add explicit checks or try-except blocks to handle unexpected data formats gracefully.
- Review the use of type casting throughout the changes to ensure that they are necessary and correctly applied, particularly when dealing with external libraries or data that might not always conform to expected formats.
Thanks for using Sourcery. We offer it for free for open source projects and would be very grateful if you could help us grow. If you like it, would you consider sharing Sourcery on your favourite social media? ✨
|
|
Documentation preview will be available shortly at https://jolt-org.github.io/advanced-alchemy-docs-preview/133 |
This PR addresses an issue with type hints when
uuid-utilsis not installed.❯ pdm run pip uninstall uuid-utils Found existing installation: uuid_utils 0.6.1 Uninstalling uuid_utils-0.6.1: Would remove: .../.venv/lib/python3.12/site-packages/uuid_utils-0.6.1.dist-info/* .../.venv/lib/python3.12/site-packages/uuid_utils/* Proceed (Y/n)? y Successfully uninstalled uuid_utils-0.6.1 ❯ pdm run pyright -p pyproject.toml advanced_alchemy/base.py 0 errors, 0 warnings, 0 informations ❯ pdm run pyright -p pyproject.toml advanced_alchemy/types/guid.py 0 errors, 0 warnings, 0 informations