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

[search5]

• 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
• Fixed social login not connecting issue found while testing example program code (for example-pyramid)
• Fixed issue with social connection termination (for example-cherrypy, example-tornado, example-webpy)
• Added local_settings.py.template file to some example folders to make it easier to create local_settings.py files
• Fixed import errors found in several examples

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:

• [X] Release (new release request)
• [X] Bugfix (non-breaking change which fixes an issue)
• [ ] New feature (non-breaking change which adds functionality)
• [ ] Code style update (PEP8, lint, formatting, renaming, etc)
• [X] Refactoring (no functional changes, no api changes)
• [X] Breaking change (fix or feature that would cause existing functionality to not work as expected)
• [X] 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
• [X] I created a running environment for the program and carefully verified that my modifications worked.

Summary by CodeRabbit

• Bug Fixes

  • Addressed import issues across several examples (CherryPy, WebPy, Flask).
  • Fixed DB session handling and model creation for SQLAlchemy 2 compatibility.

• New Features

  • Introduced templates for easier configuration in Tornado and WebPy examples.

• Refactor

  • Removed flask-script dependency, transitioning to Flask's built-in CLI.
  • Updated session management from db_session.remove() to db_session.close().
  • Refactored command line management in Flask, Flask-MongoEngine, and Flask-Peewee examples to use click and FlaskGroup.
  • Enhanced readability and structure in filters.py, pipeline.py, and utils.py across examples.
  • Modified SQLAlchemy column declarations using Mapped and mapped_column for improved type hinting.

• Chores

  • Added # noqa: F401 comments to suppress unused import warnings in Django and Django-MongoEngine examples.

• Documentation

  • Improved error message clarity in CherryPy example.

[coderabbitai[bot]]

[!WARNING]

Rate Limit Exceeded

@pre-commit-ci[bot] has exceeded the limit for the number of commits or files that can be reviewed per hour. Please wait 21 minutes and 8 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 dbc3d62151c5250cd55f608bac5d0886e454f0ce and e6b31e0105e9104d85b7d8909bea3b2ffb468973.

Walkthrough

This update focuses on enhancing compatibility with SQLAlchemy 2 across various Python web frameworks, removing deprecated dependencies, and refining the codebase for better configuration and readability. It addresses import bugs, session handling, and model creation adjustments, alongside removing the flask-script dependency and introducing template configurations for easier setup.

Changes

Files	Summary
example-cherrypy/example/app.py, example-tornado/example/app.py, example-webpy/app.py	Updated import statements, session handling, and SQLAlchemy column declarations. Introduced template configuration.
example-flask/example/__init__.py, example-flask-mongoengine/manage.py, example-flask-peewee/manage.py, example-flask/manage.py	Removed flask-script dependency, refactored for click and FlaskGroup, updated session and SQLAlchemy handling.
example-pyramid/example/__init__.py, example-django-mongoengine/app/views.py, example-django/app/views.py	Adjusted DB session binding, removed Google Plus ID retrieval, and updated social login key handling.
example-common/..., example-django-mongoengine/..., example-django/..., example-flask-mongoengine/..., example-flask-peewee/..., example-flask/...	Various readability and code quality improvements.

Related issues

• python-social-auth/social-examples#49: The changes in this PR address the need for SQLAlchemy 2 compatibility, as mentioned in the issue.
• python-social-auth/social-storage-sqlalchemy#9: This PR's adjustments for SQLAlchemy 2 compatibility directly relate to the objectives outlined in the issue.
• python-social-auth/social-app-cherrypy#2, python-social-auth/social-app-webpy#1, python-social-auth/social-app-pyramid#4, python-social-auth/social-app-flask-sqlalchemy#3, python-social-auth/social-app-tornado#2: Each of these issues discusses the need for updates to accommodate SQLAlchemy 2, which this PR addresses through its various framework-specific changes.

Poem

In the land of code, where the rabbits hop,
Changes abound, making old bugs stop.
SQLAlchemy two, now friends with all,
Flask-script gone, no longer to stall.
🐇 With every commit, we leap and cheer,
For cleaner code, the goal is near.
Let's celebrate, with carrots near, this code so dear! 🥕

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

• X
• Mastodon
• Reddit
• LinkedIn

---

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.