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

.pre-commit-config.yaml

@@ -0,0 +1,37 @@
+# See https://pre-commit.com for more information
+# See https://pre-commit.com/hooks.html for more hooks
+repos:
+- repo: https://github.com/pre-commit/pre-commit-hooks
+  rev: v4.5.0
+  hooks:
+  - id: check-merge-conflict
+  - id: debug-statements
+  - id: mixed-line-ending
+    args: [--fix=lf]
+- repo: https://github.com/pycqa/isort
+  rev: 5.13.2
+  hooks:
+  - id: isort
+    args: [--profile=black]
+- repo: https://github.com/asottile/pyupgrade
+  rev: v3.15.1
+  hooks:
+  - id: pyupgrade
+    args: [--py36-plus]
+- repo: https://github.com/psf/black
+  rev: 24.2.0
+  hooks:
+  - id: black
+- repo: https://github.com/PyCQA/flake8
+  rev: 7.0.0
+  hooks:
+  - id: flake8
+- repo: meta
+  hooks:
+  - id: check-hooks-apply
+  - id: check-useless-excludes
+- repo: https://github.com/macisamuele/language-formatters-pre-commit-hooks
+  rev: v2.12.0
+  hooks:
+  - id: pretty-format-yaml
+    args: [--autofix, --indent, '2']

CHANGELOG.md

@@ -7,6 +7,11 @@ and this project adheres to [Semantic Versioning](http://semver.org/).
 
 ## [Unreleased](https://github.com/python-social-auth/social-app-flask-sqlalchemy/commits/master)
 
+### Changed
+- Modified model and access code to work with SQLAlchemy version 2 (Issue #3)
+- Updated packaging information files per PEP 517, PEP 518 (Issue #4)
+- Restricted Python minimum working version to 3.7 or higher to align with SQLAlchemy 2 (Issue #3)
+
 ## [1.0.1](https://github.com/python-social-auth/social-app-flask-sqlalchemy/releases/tag/1.0.1) - 2017-01-29
 
 ### Added

Makefile

@@ -1,12 +1,8 @@
 build:
-	@ python setup.py sdist
-	@ python setup.py bdist_wheel --python-tag py2
-	@ BUILD_VERSION=3 python setup.py bdist_wheel --python-tag py3
+	@ python -m build
 
 publish:
-	@ python setup.py sdist upload
-	@ python setup.py bdist_wheel --python-tag py2 upload
-	@ BUILD_VERSION=3 python setup.py bdist_wheel --python-tag py3 upload
+	@ twine upload dist/*
 
 clean:
 	@ find . -name '*.py[co]' -delete

pyproject.toml

@@ -0,0 +1,60 @@
+[build-system]
+requires = ["setuptools"]
+build-backend = "setuptools.build_meta"
+
+[project]
+name = 'social-auth-app-flask-sqlalchemy'
+dynamic = ["version"]
+dependencies = [
+    "six",
+    "sqlalchemy",
+    "social-auth-core>=1.0.0",
+    "social-auth-app-flask>=1.0.0",
+    "social-auth-storage-sqlalchemy>=1.0.1",
+]
+authors = [
+  {name = "Matias Aguirre", email = "[email protected]"},
+  {name = "Lee Ji-ho", email = "[email protected]"},
+]
+description = 'Python Social Authentication, SQLAlchemy Flask models integration.'
+license = {text = 'BSD'}
+keywords = ["flask", "sqlalchemy", "social auth"]
+readme = "README.md"
+classifiers=[
+    'Development Status :: 4 - Beta',
+    'Topic :: Internet',
+    'License :: OSI Approved :: BSD License',
+    'Intended Audience :: Developers',
+    'Environment :: Web Environment',
+    'Programming Language :: Python',
+    'Programming Language :: Python :: 3.7',
+    'Programming Language :: Python :: 3.8',
+    'Programming Language :: Python :: 3.9',
+    'Programming Language :: Python :: 3.10',
+    'Programming Language :: Python :: 3.11',
+    'Programming Language :: Python :: 3.12'
+]
+requires-python = ">= 3.7"
+
+[project.urls]
+Repository = 'https://github.com/python-social-auth/social-app-flask-sqlalchemy'
+Documentation = 'http://python-social-auth.readthedocs.org'
+Issues = 'https://github.com/python-social-auth/social-app-flask-sqlalchemy/issues'
+Changelog = 'https://github.com/python-social-auth/social-app-flask-sqlalchemy/blob/master/CHANGELOG.md'
+
+[options]
+zip_safe = false
+
+[tool.setuptools]
+include-package-data = true
+
+[tool.setuptools.packages]
+find = {}
+
+[tool.setuptools.dynamic]
+version = {attr = "social_flask_sqlalchemy.__version__"}
+
+[tool.flake8]
+max-line-length = 79
+# Ignore some well known paths
+exclude = ['.venv','.tox','dist','doc','build','*.egg','db/env.py','db/versions/*.py','site','Pipfile','Pipfile.lock']

social_flask_sqlalchemy/__init__.py

@@ -1 +1 @@
-__version__ = '1.0.1'
+__version__ = "1.0.1"

social_flask_sqlalchemy/models.py

@@ -1,19 +1,26 @@
 """Flask SQLAlchemy ORM models for Social Auth"""
-from sqlalchemy import Column, String, ForeignKey
-from sqlalchemy.orm import relationship, backref
-from sqlalchemy.schema import UniqueConstraint
-from sqlalchemy.ext.declarative import declarative_base
 
-from social_core.utils import setting_name, module_member
-from social_sqlalchemy.storage import SQLAlchemyUserMixin, \
-                                      SQLAlchemyAssociationMixin, \
-                                      SQLAlchemyNonceMixin, \
-                                      SQLAlchemyCodeMixin, \
-                                      SQLAlchemyPartialMixin, \
-                                      BaseSQLAlchemyStorage
+from social_core.utils import module_member, setting_name
+from social_sqlalchemy.storage import (
+    BaseSQLAlchemyStorage,
+    SQLAlchemyAssociationMixin,
+    SQLAlchemyCodeMixin,
+    SQLAlchemyNonceMixin,
+    SQLAlchemyPartialMixin,
+    SQLAlchemyUserMixin,
+)
+from sqlalchemy import ForeignKey
+from sqlalchemy.orm import (  # fmt: skip
+    DeclarativeBase,
+    backref,
+    mapped_column,
+    relationship,
+)
+from sqlalchemy.schema import UniqueConstraint
 
 
-PSABase = declarative_base()
+class PSABase(DeclarativeBase):
+    pass
 
 
 class _AppSession(PSABase):
@@ -30,9 +37,9 @@ def _session(cls):
 
 class UserSocialAuth(_AppSession, SQLAlchemyUserMixin):
     """Social Auth association model"""
+
     # Temporary override of constraints to avoid an error on the still-to-be
     # missing column uid.
-    __table_args__ = ()
 
     @classmethod
     def user_model(cls):
@@ -41,26 +48,30 @@ def user_model(cls):
     @classmethod
     def username_max_length(cls):
         user_model = cls.user_model()
-        return user_model.__table__.columns.get('username').type.length
+        return user_model.__table__.columns.get("username").type.length
 
 
 class Nonce(_AppSession, SQLAlchemyNonceMixin):
     """One use numbers"""
+
     pass
 
 
 class Association(_AppSession, SQLAlchemyAssociationMixin):
     """OpenId account association"""
+
     pass
 
 
 class Code(_AppSession, SQLAlchemyCodeMixin):
     """Mail validation single one time use code"""
+
     pass
 
 
 class Partial(_AppSession, SQLAlchemyPartialMixin):
     """Partial pipeline storage"""
+
     pass
 
 
@@ -73,12 +84,12 @@ class FlaskStorage(BaseSQLAlchemyStorage):
 
 
 def init_social(app, session):
-    UID_LENGTH = app.config.get(setting_name('UID_LENGTH'), 255)
-    User = module_member(app.config[setting_name('USER_MODEL')])
+    User = module_member(app.config[setting_name("USER_MODEL")])
     _AppSession._set_session(session)
-    UserSocialAuth.__table_args__ = (UniqueConstraint('provider', 'uid'),)
-    UserSocialAuth.uid = Column(String(UID_LENGTH))
-    UserSocialAuth.user_id = Column(User.id.type, ForeignKey(User.id),
-                                    nullable=False, index=True)
-    UserSocialAuth.user = relationship(User, backref=backref('social_auth',
-                                                             lazy='dynamic'))
+    UserSocialAuth.__table_args__ = (UniqueConstraint("provider", "uid"),)
+    UserSocialAuth.user_id = mapped_column(
+        ForeignKey(User.id), nullable=False, index=True
+    )
+    UserSocialAuth.user = relationship(
+        User, backref=backref("social_auth", lazy="dynamic")
+    )