Binding DB sessions based on SQLAlchemy 1, changing how to declare Base Model classes, and other code modernization #11
Conversation
…se Model classes, and other code modernization - DB session binding based on SQLAlchemy 2, Base Model class declaration method change - Reflected select, delete code based on SQLAlchemy 2 - Changed how to declare Model class based on SQLAlchemy 2 - Added pyproject.toml file after removing setup.py due to the introduction of PEP 517/518 - Fixed minimum installed version to Python 3.7
|
Warning Rate Limit Exceeded@search5 has exceeded the limit for the number of commits or files that can be reviewed per hour. Please wait 10 minutes and 27 seconds before requesting another review. How to resolve this issue?After the wait time has elapsed, a review can be triggered using the We recommend that you space out your commits to avoid hitting the rate limit. How do rate limits work?CodeRabbit enforces hourly rate limits for each developer per organization. WalkthroughThe modifications primarily adapt the codebase for compatibility with SQLAlchemy version 2, reflecting a significant shift in the way database interactions are handled. This includes changes to model declarations, query methods, and the build and publish process to align with modern Python packaging standards as defined by PEP 517 and PEP 518, setting a new baseline for Python version compatibility and streamlining development workflows. Changes
Related issues
Thank you for using CodeRabbit. We offer it for free to the OSS community and would appreciate your support in helping us grow. If you find it useful, would you consider giving us a shout-out on your favorite social media? TipsChatThere are 3 ways to chat with CodeRabbit:
Note: Be mindful of the bot's finite context window. It's strongly recommended to break down tasks such as reading entire modules into smaller chunks. For a focused discussion, use review comments to chat about specific files and their changes, instead of using the PR comments. CodeRabbit Commands (invoked as PR comments)
Additionally, you can add CodeRabbit Configration File (
|
![coderabbitai[bot]](https://avatars.githubusercontent.com/in/347564?s=60&v=4){kind=small}
There was a problem hiding this comment.
Review Status
Actionable comments generated: 0
Configuration used: CodeRabbit UI
Files ignored due to path filters (1)
pyproject.tomlis excluded by:!**/*.toml
Files selected for processing (3)
- CHANGELOG.md (1 hunks)
- Makefile (1 hunks)
- social_sqlalchemy/storage.py (10 hunks)
Additional comments: 17
Makefile (2)
- 2-2: The update to use
python -m buildaligns with modern Python packaging practices. Good change!- 5-5: Using
twine upload dist/*for publishing packages is a best practice and ensures secure uploads. Well done!CHANGELOG.md (1)
- 10-13: The updates documented in the CHANGELOG.md accurately reflect the PR's objectives and changes. It's important to keep this file updated for clear communication with users. Great job!
social_sqlalchemy/storage.py (14)
- 3-3: Adding
from typing import Optionalis a good practice for type hinting, enhancing code readability and maintainability.- 13-13: Replacing
Column, Integerwithselect, delete, String, func, Integeraligns with SQLAlchemy 2's approach to handling database operations. This change is necessary for compatibility.- 18-18: Introducing
from sqlalchemy.orm import declared_attr, Mapped, mapped_columnis crucial for the new way SQLAlchemy 2 handles model declarations. This is a positive change for compatibility.- 57-57: Changing the
_querymethod to useselect(cls)instead ofcls._session().query(cls)aligns with SQLAlchemy 2's new query interface. This is a necessary update for compatibility.- 92-100: The modifications to column declarations using
Mappedandmapped_columnare in line with SQLAlchemy 2's requirements for type hinting and column mapping. This enhances the code's compatibility and readability.- 113-126: Updating the
allowed_to_disconnectmethod to use the new query interface and scalar for counting is a good practice for SQLAlchemy 2 compatibility. It also improves the method's readability and performance.- 137-152: The changes to
user_existsmethod, including the use ofselect(func.count())andscalar, align with SQLAlchemy 2's approach and improve the method's efficiency.- 164-164: Updating
get_userto directly use_session().getsimplifies the code and is a good practice for fetching records in SQLAlchemy 2.- 168-168: The update to
get_users_by_emailto usescalarfor direct fetching aligns with SQLAlchemy 2's practices, improving code efficiency.- 161-179: > 📝 NOTE
This review was outside the diff hunks and was mapped to the diff hunk with the greatest overlap. Original lines [175-187]
The modifications in
get_social_auth_for_userto use the new query interface andscalarsfor fetching multiple records are well-aligned with SQLAlchemy 2's paradigms.
- 200-203: The updates to column declarations in
SQLAlchemyNonceMixinusingMappedandmapped_columnare necessary for SQLAlchemy 2 compatibility and enhance code readability.- 218-224: The changes in
SQLAlchemyAssociationMixinto column declarations and the use ofdeletein theremovemethod align with SQLAlchemy 2's requirements and best practices.- 255-257: The modifications to column declarations in
SQLAlchemyCodeMixinusingMappedandmapped_columnare in line with SQLAlchemy 2's approach, enhancing compatibility and readability.- 266-270: The updates to column declarations in
SQLAlchemyPartialMixinusingMappedandmapped_columnensure compatibility with SQLAlchemy 2 and improve the code's maintainability.
for more information, see https://pre-commit.ci
for more information, see https://pre-commit.ci
Proposed changes
With the introduction of PEP 517/518, the Python package build process has changed to allow the use of multiple build backends. We've improved the build process accordingly.
In addition, we improved the program to ensure that several previously developed libraries work properly with the newly updated SQLAlchemy 2 in January 2023.
Please consider this PR and look forward to the new version release. I took the time to fix the program and submit the patch because I'm planning to include it in a Korean Flask-based programming book I'm writing.
I'm sure there will be other PRs like this one in the future, so I'm mentioning this one in advance.
Types of changes
Please check the type of change your PR introduces:
Checklist
Put an
xin the boxes that apply. You can also fill these out after creatingthe PR. If you're unsure about any of them, don't hesitate to ask. We're here to
help! This is simply a reminder of what we are going to look for before merging
your code.
Summary by CodeRabbit
New Features
Refactor
Chores
Makefileto simplify the process.