Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Binding DB sessions based on SQLAlchemy 1, changing how to declare Base Model classes, and other code modernization #6

Open
wants to merge 9 commits into
base: master
Choose a base branch
from

Conversation

search5
Copy link

@search5 search5 commented Feb 24, 2024

  • 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

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.

Types of changes

Please check the type of change your PR introduces:

  • Release (new release request)
  • Bugfix (non-breaking change which fixes an issue)
  • New feature (non-breaking change which adds functionality)
  • Code style update (PEP8, lint, formatting, renaming, etc)
  • Refactoring (no functional changes, no api changes)
  • Breaking change (fix or feature that would cause existing functionality to not work as expected)
  • Build related changes (build process, tests runner, etc)
  • Other (please describe):

Checklist

Put an x in the boxes that apply. You can also fill these out after creating
the 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.

  • Lint and unit tests pass locally with my changes
  • I have added tests that prove my fix is effective or that my feature works
  • I have added documentation to https://github.com/python-social-auth/social-docs
  • I created a running environment for the program and carefully verified that my modifications worked.

Summary by CodeRabbit

  • Documentation
    • Updated the CHANGELOG and packaging information for better clarity and compliance with recent standards.
  • Refactor
    • Simplified the build and publish process in the Makefile.
    • Enhanced compatibility with SQLAlchemy version 2 in the project, including updates to model access code.
  • New Features
    • Improved the UserSocialAuth class in the social authentication system for better type annotation and clarity.

…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
Copy link

coderabbitai bot commented Feb 24, 2024

Warning

Rate Limit Exceeded

@search5 has exceeded the limit for the number of commits or files that can be reviewed per hour. Please wait 8 minutes and 11 seconds before requesting another review.

How to resolve this issue?

After the wait time has elapsed, a review can be triggered using the @coderabbitai review command as a PR comment. Alternatively, push new commits to this PR.

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.
Our paid plans have higher rate limits than the trial, open-source and free plans. In all cases, we re-allow further reviews after a brief timeout.
Please see our FAQ for further information.

Commits Files that changed from the base of the PR and between 9c33e59 and b5ececd.

Walkthrough

The updates primarily focus on ensuring compatibility with SQLAlchemy version 2 across various components, streamlining the build and publish process for packages, and refining model annotations in the social_pyramid module. These changes are critical for aligning with the latest standards and technologies, including adherence to PEP 517/518 and updating the Python minimum version requirement to 3.7+.

Changes

File(s) Change Summary
CHANGELOG.md, Makefile Updated for SQLAlchemy 2 compatibility, streamlined build/publish process, and set Python 3.7+ min
social_pyramid/.../models.py Modified SQLAlchemy ORM models for Social Auth using Mapped and mapped_column annotations

Related issues

  • Issue python-social-auth/social-storage-sqlalchemy#9: Updates address SQLAlchemy version 2 compatibility, which is the core objective of the issue.
  • Issue python-social-auth/social-examples#49: Changes in ORM models and compatibility updates align with the need for example code updates mentioned.

🐰✨
A hop, a skip, in the code we dip,
To the future, we swing and sway,
With SQLAlchemy 2, we've found our way.
Build and publish, now a smoother trip,
For Python 3.7+, we've tightened our grip.
🌟🚀🐾

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?

Share

Tips

Chat

There are 3 ways to chat with CodeRabbit:

  • Review comments: Directly reply to a review comment made by CodeRabbit. Example:
    • I pushed a fix in commit <commit_id>.
    • Generate unit-tests for this file.
    • Open a follow-up GitHub issue for this discussion.
  • Files and specific lines of code (under the "Files changed" tab): Tag @coderabbitai in a new review comment at the desired location with your query. Examples:
    • @coderabbitai generate unit tests for this file.
    • @coderabbitai modularize this function.
  • PR comments: Tag @coderabbitai in a new PR comment to ask questions about the PR branch. For the best results, please provide a very specific query, as very limited context is provided in this mode. Examples:
    • @coderabbitai generate interesting stats about this repository and render them as a table.
    • @coderabbitai show all the console.log statements in this repository.
    • @coderabbitai read src/utils.ts and generate unit tests.
    • @coderabbitai read the files in the src/scheduler package and generate a class diagram using mermaid and a README in the markdown format.

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)

  • @coderabbitai pause to pause the reviews on a PR.
  • @coderabbitai resume to resume the paused reviews.
  • @coderabbitai review to trigger a review. This is useful when automatic reviews are disabled for the repository.
  • @coderabbitai resolve resolve all the CodeRabbit review comments.
  • @coderabbitai help to get help.

Additionally, you can add @coderabbitai ignore anywhere in the PR description to prevent this PR from being reviewed.

CodeRabbit Configration File (.coderabbit.yaml)

  • You can programmatically configure CodeRabbit by adding a .coderabbit.yaml file to the root of your repository.
  • The JSON schema for the configuration file is available here.
  • If your editor has YAML language server enabled, you can add the path at the top of this file to enable auto-completion and validation: # yaml-language-server: $schema=https://coderabbit.ai/integrations/coderabbit-overrides.v2.json

CodeRabbit Discord Community

Join our Discord Community to get help, request features, and share feedback.

Copy link

@coderabbitai coderabbitai bot left a comment

Choose a reason for hiding this comment

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

Review Status

Actionable comments generated: 0

Configuration used: CodeRabbit UI

Commits Files that changed from the base of the PR and between 9e1f285 and 9c33e59.
Files ignored due to path filters (1)
  • pyproject.toml is excluded by: !**/*.toml
Files selected for processing (3)
  • CHANGELOG.md (1 hunks)
  • Makefile (1 hunks)
  • social_pyramid/models.py (2 hunks)
Additional comments: 5
Makefile (3)
  • 2-2: The use of python -m build is a modern and recommended approach for building packages, aligning with PEP 517/518. This change simplifies the build process and ensures compatibility with modern Python packaging standards.
  • 5-5: Using twine upload dist/* for publishing packages is a secure and recommended practice. It ensures that the package is uploaded securely to PyPI, protecting against potential man-in-the-middle attacks that could compromise package integrity.
  • 1-8: > 📝 NOTE

This review was outside the diff hunks and was mapped to the diff hunk with the greatest overlap. Original lines [8-10]

The clean command effectively removes bytecode files, __pycache__ directories, and build artifacts, ensuring a clean state for subsequent builds. This is a good practice for maintaining a clean and manageable project structure.

CHANGELOG.md (1)
  • 10-13: The changelog entries clearly document the significant changes made in this release, including compatibility updates for SQLAlchemy 2, packaging information updates per PEP 517/518, and the update to the minimum Python version requirement. This adherence to the Keep a Changelog format helps users understand the impact of the changes and the project's adherence to Semantic Versioning.
social_pyramid/models.py (1)
  • 38-42: The use of Mapped and mapped_column for type annotations in the UserSocialAuth class aligns with SQLAlchemy 2's recommended practices for ORM model declarations. This modern approach enhances readability and maintainability of the code by clearly indicating the types of the model attributes. It's also worth noting the correct use of ForeignKey and relationship to establish the association between UserSocialAuth and User, which is crucial for maintaining referential integrity in the database.

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

Successfully merging this pull request may close these issues.

1 participant