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

CHANGELOG.md

@@ -12,3 +12,18 @@ and this project adheres to [Semantic Versioning](http://semver.org/).
   codebase
 - Use host 0.0.0.0 for test servers
 - Fix bug with example-flask-peewee import
+- Fix bug with example-cherrypy import (Specify parent package name when importing setting, local_setting modules)
+- Changed the DB session creation, DB connection closing, and DB model creation to align with SQLAlchemy 2. (for example-flask program)
+- Removed flask-script package from requirements.txt as it doesn't work with recent flasks (programs: example-flask, example-flask-mongoengine, example-flask-peewee)
+- Configured the manage.py file to use the CLI environment built into flask (programs: example-flask, example-flask-mongoengine, example-flask-peewee) as the flask-script package has been removed
+- Changed the part that binds the DB session to comply with SQLAlchemy 2 (for example-pyramid program)
+- Changed the part that fetches authenticated users from DB to be SQLAlchemy 2 based (for example-pyramid program)
+- Removed all entries in the SOCIAL_AUTH_KEYS dictionary in local_settings.py.template into a single variable (tests showed that adding provider-supplied key information in SOCIAL_AUTH_KEYS caused errors on social login) (for example-pyramid program)
+- Changed the DB model creation part. (for example-pyramid program)
+- Error occurred when social login integration was completed because it was supposed to find google plus ID in the redirected URL. google plus is discontinued, so delete the part that gets plus ID. (for example-pyramid program)
+- Changed the part that binds the DB session and creates the Base Model class to comply with SQLAlchemy 2 (for example-tornado, example-webpy program)
+- Added local_settings.py.template file to reference other programs to easily generate local_settings.py (for example-tornado, example-webpy program)
+- Fixed an error importing the local_settings module from settings.py (for the example-tornado program)
+- Change the declaration of the Model class based on SQLAlchemy 2 (corresponds to the example-tornado, example-webpy program)
+- Fix bug with example-webpy import
+- Separated AUTHENTICATION_BACKENDS and PIPELINE entries into separate settings.py entries as web.config entries in app.py (for example-webpy program)

example-cherrypy/example/app.py

@@ -2,7 +2,7 @@
 import sys
 
 import cherrypy
-import settings
+from example import settings
 from common import filters
 from common.utils import common_context, url_for
 from jinja2 import Environment, FileSystemLoader
@@ -66,7 +66,7 @@ def get_settings(module):
 SOCIAL_SETTINGS = get_settings(settings)
 
 try:
-    import local_settings
+    from example import local_settings
 
     SOCIAL_SETTINGS.update(get_settings(local_settings))
 except ImportError:
@@ -82,7 +82,7 @@ def run_app(listen_address="0.0.0.0:8001"):
             "server.socket_port": int(port),
             "server.socket_host": host,
             "tools.sessions.on": True,
-            "tools.sessions.storage_type": "ram",
+            "tools.sessions.storage_class": cherrypy.lib.sessions.RamSession,
             "tools.db.on": True,
             "tools.authenticate.on": True,
             "SOCIAL_AUTH_USER_MODEL": "example.db.user.User",

example-cherrypy/example/db/__init__.py

@@ -1,3 +1,4 @@
-from sqlalchemy.ext.declarative import declarative_base
+from sqlalchemy.orm import DeclarativeBase
 
-Base = declarative_base()
+class Base(DeclarativeBase):
+    pass

example-cherrypy/example/db/saplugin.py

@@ -1,13 +1,13 @@
 from cherrypy.process import plugins
 from sqlalchemy import create_engine
-from sqlalchemy.orm import scoped_session, sessionmaker
+from sqlalchemy.orm import Session
 
 
 class SAEnginePlugin(plugins.SimplePlugin):
     def __init__(self, bus, connection_string=None):
         self.sa_engine = None
         self.connection_string = connection_string
-        self.session = scoped_session(sessionmaker(autoflush=True, autocommit=False))
+        self.session = Session(autoflush=True, autocommit=False)
         super().__init__(bus)
 
     def start(self):
@@ -23,7 +23,7 @@ def stop(self):
             self.sa_engine = None
 
     def bind(self):
-        self.session.configure(bind=self.sa_engine)
+        self.session.bind = self.sa_engine
         return self.session
 
     def commit(self):
@@ -33,4 +33,4 @@ def commit(self):
             self.session.rollback()
             raise
         finally:
-            self.session.remove()
+            self.session.close()

example-cherrypy/example/db/user.py

@@ -1,16 +1,18 @@
-from sqlalchemy import Boolean, Column, Integer, String
+from sqlalchemy import Boolean, String
+from sqlalchemy.orm import Mapped, mapped_column
+from typing import Optional
 
 from . import Base
 
 
 class User(Base):
     __tablename__ = "users"
-    id = Column(Integer, primary_key=True)
-    username = Column(String(200))
-    password = Column(String(200), default="")
-    name = Column(String(100))
-    email = Column(String(200))
-    active = Column(Boolean, default=True)
+    id: Mapped[int] = mapped_column(primary_key=True)
+    username: Mapped[str] = mapped_column(String(200))
+    password: Mapped[str] = mapped_column(String(200), default="")
+    name: Mapped[Optional[str]] = mapped_column(String(100))
+    email: Mapped[Optional[str]] = mapped_column(String(200))
+    active: Mapped[bool] = mapped_column(default=True)
 
     def is_active(self):
         return self.active

example-flask-mongoengine/manage.py

@@ -1,11 +1,17 @@
 #!/usr/bin/env python
 from example import app, db
-from flask_script import Manager, Server, Shell
+import click
+from flask.cli import FlaskGroup
 
-manager = Manager(app)
-manager.add_command("runserver", Server())
-manager.add_command("shell", Shell(make_context=lambda: {"app": app, "db": db}))
 
+@click.group(cls=FlaskGroup, create_app=lambda: app)
+def cli():
+    """Management script for the Example Flask Social Login application."""
 
-if __name__ == "__main__":
-    manager.run()
+    @app.shell_context_processor
+    def make_shell_context():
+        return dict(db=db)
+
+
+if __name__ == '__main__':
+    cli()

example-flask-mongoengine/requirements.txt

@@ -1,4 +1,3 @@
 -r ../requirements.txt
-flask-script
 flask-mongoengine
 social-auth-app-flask-mongoengine

example-flask-peewee/manage.py

@@ -1,13 +1,15 @@
 #!/usr/bin/env python
 from example import app, database
-from flask_script import Manager, Server, Shell
+import click
+from flask.cli import FlaskGroup
 
-manager = Manager(app)
-manager.add_command("runserver", Server())
-manager.add_command("shell", Shell(make_context=lambda: {"app": app}))
 
+@click.group(cls=FlaskGroup, create_app=lambda: app)
+def cli():
+    """Management script for the Example Flask Social Login application."""
 
-@manager.command
+
+@app.cli.command()
 def syncdb():
     from example.models.user import User
     from social_flask_peewee.models import FlaskStorage
@@ -24,5 +26,5 @@ def syncdb():
         model.create_table(True)
 
 
-if __name__ == "__main__":
-    manager.run()
+if __name__ == '__main__':
+    cli()

example-flask-peewee/requirements.txt

@@ -1,3 +1,2 @@
 -r ../requirements.txt
-flask-script
 social-auth-app-flask-peewee

example-flask/example/__init__.py

@@ -10,7 +10,7 @@
 from social_flask.utils import load_strategy
 from social_flask_sqlalchemy.models import init_social
 from sqlalchemy import create_engine
-from sqlalchemy.orm import scoped_session, sessionmaker
+from sqlalchemy.orm import Session
 
 BASE_DIR = os.path.dirname(os.path.dirname(os.path.abspath(__file__)))
 
@@ -25,8 +25,7 @@
 
 # DB
 engine = create_engine(app.config["SQLALCHEMY_DATABASE_URI"])
-Session = sessionmaker(autocommit=False, autoflush=False, bind=engine)
-db_session = scoped_session(Session)
+db_session = Session(engine, autocommit=False, autoflush=False)
 
 app.register_blueprint(social_auth)
 init_social(app, db_session)
@@ -42,7 +41,7 @@
 @login_manager.user_loader
 def load_user(userid):
     try:
-        return models.user.User.query.get(int(userid))
+        return db_session.get(models.user.User, int(userid))
     except (TypeError, ValueError):
         pass
 
@@ -60,7 +59,7 @@ def commit_on_success(error=None):
     else:
         db_session.rollback()
 
-    db_session.remove()
+    db_session.close()
 
 
 @app.context_processor

example-flask/example/models/user.py

@@ -1,20 +1,22 @@
+from typing import Optional
 from example import db_session
 from flask_login import UserMixin
-from sqlalchemy import Boolean, Column, Integer, String
-from sqlalchemy.ext.declarative import declarative_base
+from sqlalchemy import String
+from sqlalchemy.orm import DeclarativeBase, Mapped, mapped_column
 
-Base = declarative_base()
-Base.query = db_session.query_property()
+
+class Base(DeclarativeBase):
+    pass
 
 
 class User(Base, UserMixin):
     __tablename__ = "users"
-    id = Column(Integer, primary_key=True)
-    username = Column(String(200))
-    password = Column(String(200), default="")
-    name = Column(String(100))
-    email = Column(String(200))
-    active = Column(Boolean, default=True)
+    id: Mapped[int] = mapped_column(primary_key=True)
+    username: Mapped[str] = mapped_column(String(200))
+    password: Mapped[str] = mapped_column(String(200), default="")
+    name: Mapped[Optional[str]] = mapped_column(String(100))
+    email: Mapped[Optional[str]] = mapped_column(String(200))
+    active: Mapped[bool] = mapped_column(default=True)
 
     def is_active(self):
         return self.active

example-flask/manage.py

@@ -1,15 +1,17 @@
-#!/usr/bin/env python
+import click
+from flask.cli import FlaskGroup
 from example import app, db_session, engine
-from flask_script import Manager, Server, Shell
 
-manager = Manager(app)
-manager.add_command("runserver", Server())
-manager.add_command(
-    "shell", Shell(make_context=lambda: {"app": app, "db_session": db_session})
-)
 
+@click.group(cls=FlaskGroup, create_app=lambda: app)
+def cli():
+    """Management script for the Example Flask Social Login application."""
 
-@manager.command
+    @app.shell_context_processor
+    def make_shell_context():
+        return dict(db_session=db_session)
+
+@app.cli.command()
 def syncdb():
     from example.models import user
     from social_flask_sqlalchemy import models
@@ -18,5 +20,5 @@ def syncdb():
     models.PSABase.metadata.create_all(engine)
 
 
-if __name__ == "__main__":
-    manager.run()
+if __name__ == '__main__':
+    cli()

example-flask/requirements.txt

@@ -1,7 +1,6 @@
 -r ../requirements.txt
 Flask
 Flask-Login
-Flask-Script
 Werkzeug
 Jinja2
 social-auth-app-flask

example-pyramid/example/__init__.py

@@ -22,7 +22,7 @@ def get_settings(module):
 def main(global_config, **settings):
     """This function returns a Pyramid WSGI application."""
     engine = engine_from_config(settings, "sqlalchemy.")
-    DBSession.configure(bind=engine)
+    DBSession.bind = engine
     Base.metadata.bind = engine
     session_factory = SignedCookieSessionFactory("thisisasecret")
     settings["jinja2.globals"] = {"url": utils.url_for}

example-pyramid/example/auth.py

@@ -1,4 +1,5 @@
 from example.models import DBSession, User
+from sqlalchemy import select
 from pyramid.events import BeforeRender, subscriber
 from social_pyramid.utils import backends
 
@@ -14,7 +15,7 @@ def login_required(request):
 def get_user(request):
     user_id = request.session.get("user_id")
     if user_id:
-        user = DBSession.query(User).filter(User.id == user_id).first()
+        user = DBSession.scalar(select(User).where(User.id == user_id))
     else:
         user = None
     return user