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

@@ -1,12 +1,11 @@
 import os
-import sys
 
 import cherrypy
-import settings
 from common import filters
 from common.utils import common_context, url_for
+from example import settings
 from jinja2 import Environment, FileSystemLoader
-from social_cherrypy.utils import backends, load_strategy
+from social_cherrypy.utils import load_strategy
 from social_cherrypy.views import CherryPyPSAViews
 from social_core.utils import setting_name
 
@@ -15,7 +14,8 @@
 from .db.user import User
 
 BASE_DIR = os.path.dirname(os.path.dirname(os.path.abspath(__file__)))
-DATABASE_NAME = "sqlite:///{dbname}".format(dbname=os.path.join(BASE_DIR, "db.sqlite3"))
+DATABASE_NAME = "sqlite:///{dbname}".format(  # fix: skip
+    dbname=os.path.join(BASE_DIR, "db.sqlite3"))
 
 SAEnginePlugin(cherrypy.engine, DATABASE_NAME).subscribe()
 
@@ -38,9 +38,9 @@ def render_home(self):
             cherrypy.config[setting_name("AUTHENTICATION_BACKENDS")],
             load_strategy(),
             user=getattr(cherrypy.request, "user", None),
-            plus_id=cherrypy.config.get(setting_name("SOCIAL_AUTH_GOOGLE_PLUS_KEY")),
         )
-        return cherrypy.tools.jinja2env.get_template("home.html").render(**context)
+        return cherrypy.tools.jinja2env.get_template(  # fix: skip
+            "home.html").render(**context)
 
 
 def load_user():
@@ -56,22 +56,24 @@ def session_commit():
 
 
 def get_settings(module):
+    not_in_items = ["__builtins__", "__file__"]
     return {
         key: value
         for key, value in module.__dict__.items()
-        if key not in module.__builtins__ and key not in ["__builtins__", "__file__"]
+        if key not in module.__builtins__ and key not in not_in_items
     }
 
 
 SOCIAL_SETTINGS = get_settings(settings)
 
 try:
-    import local_settings
+    from example import local_settings
 
     SOCIAL_SETTINGS.update(get_settings(local_settings))
 except ImportError:
     raise RuntimeError(
-        "Define a local_settings.py using " "local_settings.py.template as base"
+        "Define a local_settings.py using "  # fix: skip
+        "local_settings.py.template as base"
     )
 
 
@@ -82,7 +84,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,5 @@
-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,14 +23,14 @@ 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):
         try:
             self.session.commit()
-        except:
+        except Exception:
             self.session.rollback()
             raise
         finally:
-            self.session.remove()
+            self.session.close()

example-cherrypy/example/db/user.py

@@ -1,16 +1,19 @@
-from sqlalchemy import Boolean, Column, Integer, String
+from typing import Optional
+
+from sqlalchemy import String
+from sqlalchemy.orm import Mapped, mapped_column
 
 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-cherrypy/manage.py

@@ -3,18 +3,16 @@
 
 import cherrypy
 from sqlalchemy import create_engine
+from example.app import DATABASE_NAME, run_app
+from example.db import Base
+from social_cherrypy.models import SocialBase
 
 cherrypy.config.update(
     {
         "SOCIAL_AUTH_USER_MODEL": "example.db.user.User",
     }
 )
 
-from example.app import DATABASE_NAME, run_app
-from example.db import Base
-from example.db.user import User
-from social_cherrypy.models import SocialBase
-
 if __name__ == "__main__":
     if len(sys.argv) > 1 and sys.argv[1] == "syncdb":
         engine = create_engine(DATABASE_NAME)

example-common/filters.py

@@ -38,7 +38,7 @@ def icon_name(name):
 
 
 def slice_by(value, items):
-    return [value[n : n + items] for n in range(0, len(value), items)]
+    return [value[n: n + items] for n in range(0, len(value), items)]
 
 
 def social_backends(backends):

example-django-mongoengine/app/admin.py

@@ -1,3 +1,3 @@
-from django.contrib import admin
+from django.contrib import admin  # noqa: F401
 
 # Register your models here.

example-django-mongoengine/app/templatetags/backend_utils.py

@@ -49,7 +49,7 @@ def social_backends(backends):
         if name not in ["username", "email"]
     ]
     backends.sort(key=lambda b: b[0])
-    return [backends[n : n + 10] for n in range(0, len(backends), 10)]
+    return [backends[n: n + 10] for n in range(0, len(backends), 10)]
 
 
 @register.filter

example-django-mongoengine/app/tests.py

@@ -1,3 +1,3 @@
-from django.test import TestCase
+from django.test import TestCase  # noqa: F401
 
 # Create your tests here.

example-django-mongoengine/app/views.py

@@ -1,15 +1,12 @@
 import json
 
-from django.conf import settings
 from django.contrib.auth import login
 from django.contrib.auth import logout as auth_logout
 from django.contrib.auth.decorators import login_required
 from django.http import HttpResponse, HttpResponseBadRequest
 from django.shortcuts import redirect
-from social_core.backends.google import GooglePlusAuth
 from social_core.backends.oauth import BaseOAuth1, BaseOAuth2
-from social_core.backends.utils import load_backends
-from social_django.utils import load_strategy, psa
+from social_django.utils import psa
 
 from .decorators import render_to
 

example-django-mongoengine/example/settings.py

@@ -273,6 +273,6 @@
 STATIC_URL = "/static/"
 
 try:
-    from example.local_settings import *
+    from example.local_settings import *  # noqa: F401,F403
 except ImportError:
     pass

example-django-mongoengine/manage.py

@@ -11,7 +11,7 @@
         # issue is really that Django is missing to avoid masking other
         # exceptions on Python 2.
         try:
-            import django
+            import django  # noqa: F401
         except ImportError:
             raise ImportError(
                 "Couldn't import Django. Are you sure it's installed and "

example-django/app/admin.py

@@ -1,3 +1,3 @@
-from django.contrib import admin
+from django.contrib import admin  # noqa: F401
 
 # Register your models here.

example-django/app/templatetags/backend_utils.py

@@ -50,7 +50,7 @@ def social_backends(backends):
         if name not in ["username", "email"]
     ]
     backends.sort(key=lambda b: b[0])
-    return [backends[n : n + 10] for n in range(0, len(backends), 10)]
+    return [backends[n: n + 10] for n in range(0, len(backends), 10)]
 
 
 @register.filter

example-django/app/tests.py

@@ -1,3 +1,3 @@
-from django.test import TestCase
+from django.test import TestCase  # noqa: F401
 
 # Create your tests here.

example-django/app/views.py

@@ -1,15 +1,11 @@
 import json
-
-from django.conf import settings
 from django.contrib.auth import login
 from django.contrib.auth import logout as auth_logout
 from django.contrib.auth.decorators import login_required
 from django.http import HttpResponse, HttpResponseBadRequest
 from django.shortcuts import redirect
-from social_core.backends.google import GooglePlusAuth
 from social_core.backends.oauth import BaseOAuth1, BaseOAuth2
-from social_core.backends.utils import load_backends
-from social_django.utils import load_strategy, psa
+from social_django.utils import psa
 
 from .decorators import render_to
 

example-django/example/settings.py

@@ -272,6 +272,6 @@
 STATIC_URL = "/static/"
 
 try:
-    from example.local_settings import *
+    from example.local_settings import *  # noqa: F401,F403
 except ImportError:
     pass

example-django/manage.py

@@ -11,7 +11,7 @@
         # issue is really that Django is missing to avoid masking other
         # exceptions on Python 2.
         try:
-            import django
+            import django  # noqa: F401
         except ImportError:
             raise ImportError(
                 "Couldn't import Django. Are you sure it's installed and "

example-flask-mongoengine/example/__init__.py

@@ -3,13 +3,14 @@
 from common import filters
 from common.utils import common_context
 from common.utils import url_for as common_url_for
-from flask import Flask, g, url_for
+from flask import Flask, g
 from flask_login import LoginManager, current_user
 from flask_mongoengine import MongoEngine
 from social_flask.routes import social_auth
 from social_flask.template_filters import backends
 from social_flask.utils import load_strategy
 from social_flask_mongoengine.models import init_social
+from example import models
 
 BASE_DIR = os.path.dirname(os.path.dirname(os.path.abspath(__file__)))
 
@@ -32,8 +33,6 @@
 login_manager.login_message = ""
 login_manager.init_app(app)
 
-from example import models, routes
-
 
 @login_manager.user_loader
 def load_user(userid):

example-flask-mongoengine/example/models/__init__.py

@@ -1,2 +1,2 @@
-from example.models import user
-from social_flask_sqlalchemy import models
+from example.models import user  # noqa: F401
+from social_flask_sqlalchemy import models  # noqa: F401

example-flask-mongoengine/example/models/user.py

@@ -1,6 +1,6 @@
 from example import db
 from flask_login import UserMixin
-from mongoengine import BooleanField, EmailField, ListField, ReferenceField, StringField
+from mongoengine import BooleanField, EmailField, StringField
 from social_flask_mongoengine.models import FlaskStorage
 
 

example-flask-mongoengine/example/routes/__init__.py

@@ -1,2 +1,2 @@
-from example.routes import main
-from social_flask import routes
+from example.routes import main  # noqa: F401
+from social_flask import routes  # noqa: F401

example-flask-mongoengine/example/settings.py

@@ -1,5 +1,3 @@
-from os.path import abspath, dirname, join
-
 SECRET_KEY = "random-secret-key"
 SESSION_COOKIE_NAME = "python_social_auth_mongoengine_session"
 DEBUG = True

example-flask-mongoengine/manage.py

@@ -1,11 +1,17 @@
 #!/usr/bin/env python
+import click
 from example import app, db
-from flask_script import Manager, Server, Shell
+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."""
+
+    @app.shell_context_processor
+    def make_shell_context():
+        return dict(db=db)
 
 
 if __name__ == "__main__":
-    manager.run()
+    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/example/__init__.py

@@ -3,7 +3,7 @@
 from common import filters
 from common.utils import common_context
 from common.utils import url_for as common_url_for
-from flask import Flask, g, url_for
+from flask import Flask, g
 from flask_login import LoginManager, current_user
 from peewee import SqliteDatabase
 from social_flask.routes import social_auth
@@ -36,8 +36,6 @@
 login_manager.login_message = ""
 login_manager.init_app(app)
 
-from example import models, routes
-
 
 @login_manager.user_loader
 def load_user(userid):

example-flask-peewee/example/models/__init__.py

@@ -1,2 +1,2 @@
-from example.models import user
-from social_flask_peewee import models
+from example.models import user  # noqa: F401
+from social_flask_peewee import models  # noqa: F401