risclog.sqlalchemy 7.2__tar.gz → 9.0__tar.gz

risclog_sqlalchemy-9.0/.github/workflows/tests.yml

@@ -0,0 +1,41 @@
+name: Test
+
+on:
+  push:
+    branches:
+      - master
+      - testing
+  pull_request:
+  schedule:
+    # * is a special character in YAML so you have to quote this string
+    - cron:  '0 1 * * *'
+
+jobs:
+  test:
+    uses: risclog-solution/gha_workflow_templates/.github/workflows/pytest_uv.yml@master
+    with:
+      timeout_minutes: 30
+    secrets:
+      UVCONF: ${{ secrets.UVCONF }}
+
+  coverage:
+    needs: test
+    uses: risclog-solution/gha_workflow_templates/.github/workflows/coverage.yml@master
+    with:
+      min_coverage: 80
+
+  pre-commit:
+    uses: risclog-solution/gha_workflow_templates/.github/workflows/pre_commit.yml@master
+
+  sonarqube:
+    needs: coverage
+    uses: risclog-solution/gha_workflow_templates/.github/workflows/sonarqube.yml@master
+    secrets:
+      SONARQUBETOKEN: ${{ secrets.SONARQUBETOKEN }}
+
+  publish-test-results:
+    needs: test
+    uses: risclog-solution/gha_workflow_templates/.github/workflows/publish_test_results.yml@master
+
+  cleanup:
+    uses: risclog-solution/gha_workflow_templates/.github/workflows/cleanup.yml@master

risclog_sqlalchemy-9.0/.gitignore

@@ -0,0 +1,24 @@
+*.egg-info
+*.pyc
+.Python
+.cache/v/cache/lastfailed
+.coverage
+.installed.cfg
+.tags
+.tox
+__pycache__
+bin
+build
+coverage-report
+coverage.xml
+develop-eggs
+dist
+docs
+docs/_api
+eggs
+include
+lib
+local.cfg
+parts
+testreport.xml
+.venv

{risclog.sqlalchemy-7.2 → risclog_sqlalchemy-9.0}/CHANGES.rst

@@ -2,6 +2,18 @@
 Change log for risclog.sqlalchemy
 =================================
 
+9.0 (2026-08-24)
+================
+
+- deps: Switch to uv, pyproject.toml and PEP-420 namespace package.
+
+
+8.0 (2025-12-02)
+================
+
+- Add compatability to sqlalchemy 2. Break with compatability to sqlalchemy < 1.4.
+
+
 7.2 (2024-04-19)
 ================
 

{risclog.sqlalchemy-7.2 → risclog_sqlalchemy-9.0}/HACKING.rst

@@ -24,7 +24,7 @@ Developing risclog.sqlalchemy
 Running tests
 =============
 
-Simply run `./pytest` in the root of the repository.
+Simply run `uv run pytest` in the root of the repository.
 
 
 Documentation

{risclog.sqlalchemy-7.2 → risclog_sqlalchemy-9.0}/PKG-INFO

@@ -1,12 +1,11 @@
-Metadata-Version: 2.1
+Metadata-Version: 2.4
 Name: risclog.sqlalchemy
-Version: 7.2
+Version: 9.0
 Summary: Encapsulate sqlalchemy modelling infrastructure.
-Home-page: https://github.com/gocept/risclog.sqlalchemy
-Author: gocept <mail@gocept.com>
-Author-email: mail@gocept.com
+Author-email: gocept <mail@gocept.com>
 License: ZPL 2.1
-Keywords: sqlalchemy alembic model infrastructure utility
+Project-URL: Homepage, https://github.com/gocept/risclog.sqlalchemy
+Keywords: sqlalchemy,alembic,model,infrastructure,utility
 Classifier: Development Status :: 5 - Production/Stable
 Classifier: Framework :: Pyramid
 Classifier: Intended Audience :: Developers
@@ -16,20 +15,19 @@ Classifier: Natural Language :: English
 Classifier: Operating System :: OS Independent
 Classifier: Programming Language :: Python
 Classifier: Programming Language :: Python :: 3
-Classifier: Programming Language :: Python :: 3.7
-Classifier: Programming Language :: Python :: 3.8
-Classifier: Programming Language :: Python :: 3.9
 Classifier: Programming Language :: Python :: 3.10
-Classifier: Programming Language :: Python :: 3.11
+Classifier: Programming Language :: Python :: 3.12
 Classifier: Programming Language :: Python :: Implementation
 Classifier: Programming Language :: Python :: Implementation :: CPython
 Classifier: Topic :: Database
 Classifier: Topic :: Software Development :: Libraries
 Classifier: Topic :: Software Development :: Libraries :: Python Modules
 Requires-Python: >=3.7
+Description-Content-Type: text/x-rst
 License-File: LICENSE.txt
-Requires-Dist: SQLAlchemy<2,>=1.0
+Requires-Dist: SQLAlchemy>=1.4
 Requires-Dist: alembic>=0.7
+Requires-Dist: importlib_resources
 Requires-Dist: pytz
 Requires-Dist: setuptools
 Requires-Dist: transaction
@@ -42,8 +40,12 @@ Provides-Extra: self-test
 Requires-Dist: mock; extra == "self-test"
 Requires-Dist: pyramid; extra == "self-test"
 Requires-Dist: pytest; extra == "self-test"
+Requires-Dist: psycopg2-binary; extra == "self-test"
+Requires-Dist: greenlet; extra == "self-test"
+Requires-Dist: pytest-cov; extra == "self-test"
 Provides-Extra: pyramid
 Requires-Dist: pyramid; extra == "pyramid"
+Dynamic: license-file
 
 ==================
 risclog.sqlalchemy
@@ -57,7 +59,6 @@ This package is compatible with Python version 3.7 up to 3.11.
 
 .. _`sqlalchemy`: http://www.sqlalchemy.org
 
-
 =============================
 Developing risclog.sqlalchemy
 =============================
@@ -84,7 +85,7 @@ Developing risclog.sqlalchemy
 Running tests
 =============
 
-Simply run `./pytest` in the root of the repository.
+Simply run `uv run pytest` in the root of the repository.
 
 
 Documentation
@@ -101,11 +102,22 @@ python, where ``sphinx-pypi-upload`` is installed::
 
     $ python setup.py upload_sphinx
 
-
 =================================
 Change log for risclog.sqlalchemy
 =================================
 
+9.0 (2026-08-24)
+================
+
+- deps: Switch to uv, pyproject.toml and PEP-420 namespace package.
+
+
+8.0 (2025-12-02)
+================
+
+- Add compatability to sqlalchemy 2. Break with compatability to sqlalchemy < 1.4.
+
+
 7.2 (2024-04-19)
 ================
 

{risclog.sqlalchemy-7.2/doc → risclog_sqlalchemy-9.0/docs}/conf.py

@@ -4,20 +4,20 @@ import sys
 # If extensions (or modules to document with autodoc) are in another directory,
 # add these directories to sys.path here. If the directory is relative to the
 # documentation root, use os.path.abspath to make it absolute, like shown here.
-sys.path.insert(0, os.path.abspath('_themes'))
+sys.path.insert(0, os.path.abspath("_themes"))
 extensions = []
 
-source_suffix = '.txt'
-master_doc = 'index'
-exclude_patterns = ['_build']
+source_suffix = ".txt"
+master_doc = "index"
+exclude_patterns = ["_build"]
 
-project = u'risclog.sqlalchemy'
-copyright = u"""\
+project = "risclog.sqlalchemy"
+copyright = """\
     2011 - 2017 Zope Foundation and Contributors.
     <a href="http://sphinx.pocoo.org/">Sphinx</a>-Theme adapted from
     <a href="http://jinja.pocoo.org/docs/">Jinja</a>
 """
-version = '2.0'  # XXX determine automatically
+version = "2.0"  # XXX determine automatically
 release = version
 
-pygments_style = 'sphinx'
+pygments_style = "sphinx"

risclog_sqlalchemy-9.0/pyproject.toml

@@ -0,0 +1,105 @@
+[build-system]
+requires = ["setuptools>=40.6.0", "wheel"]
+build-backend = "setuptools.build_meta"
+
+[project]
+name = "risclog.sqlalchemy"
+version = "9.0"
+description = "Encapsulate sqlalchemy modelling infrastructure."
+keywords = ["sqlalchemy", "alembic", "model", "infrastructure", "utility"]
+requires-python = ">=3.7"
+authors = [{ name = "gocept", email = "mail@gocept.com" }]
+license = { text = "ZPL 2.1" }
+urls = { Homepage = "https://github.com/gocept/risclog.sqlalchemy" }
+dynamic = ["readme"]
+classifiers = [
+    "Development Status :: 5 - Production/Stable",
+    "Framework :: Pyramid",
+    "Intended Audience :: Developers",
+    "License :: OSI Approved",
+    "License :: OSI Approved :: Zope Public License",
+    "Natural Language :: English",
+    "Operating System :: OS Independent",
+    "Programming Language :: Python",
+    "Programming Language :: Python :: 3",
+    "Programming Language :: Python :: 3.10",
+    "Programming Language :: Python :: 3.12",
+    "Programming Language :: Python :: Implementation",
+    "Programming Language :: Python :: Implementation :: CPython",
+    "Topic :: Database",
+    "Topic :: Software Development :: Libraries",
+    "Topic :: Software Development :: Libraries :: Python Modules",
+]
+dependencies = [
+    "SQLAlchemy >= 1.4",
+    "alembic >= 0.7",
+    "importlib_resources",
+    "pytz",
+    "setuptools",
+    "transaction",
+    "zope.component >= 4.0.1",
+    "zope.interface",
+    "zope.sqlalchemy >= 1.3",
+]
+
+[project.optional-dependencies]
+test = ["gocept.testdb"]
+self-test = [
+    "mock",
+    "pyramid",
+    "pytest",
+    "psycopg2-binary",
+    "greenlet",
+    "pytest-cov",
+]
+pyramid = ["pyramid"]
+
+[tool.setuptools]
+include-package-data = true
+
+[tool.setuptools.packages.find]
+where = ["src"]
+include = ["risclog.*"]
+
+[tool.setuptools.dynamic]
+readme = { file = ["README.rst", "HACKING.rst", "CHANGES.rst"], content-type = "text/x-rst" }
+
+[tool.coverage.run]
+relative_files = true
+parallel = true
+branch = true
+source = ["risclog.sqlalchemy"]
+
+[tool.coverage.paths]
+source = ["src", ".pytest/*/site-packages"]
+
+[tool.coverage.html]
+directory = "coverage-report"
+
+[tool.coverage.report]
+precision = 2
+show_missing = true
+skip_covered = true
+exclude_lines = [
+    # a more strict default pragma
+    "\\# pragma: no cover\\b",
+
+    # allow defensive code
+    "^\\s*raise AssertionError\\b",
+    "^\\s*raise NotImplementedError\\b",
+    "^\\s*return NotImplemented\\b",
+    "^\\s*raise$",
+
+    # typing-related code
+    "^if (False|TYPE_CHECKING):",
+    ": \\.\\.\\.(\\s*#.*)?$",
+    "^ +\\.\\.\\.$",
+    "-> ['\"]?NoReturn['\"]?:",
+]
+
+[tool.ruff]
+target-version = "py312"
+line-length = 79
+
+[tool.check-manifest]
+ignore-bad-ideas = ["*.mo"]

{risclog.sqlalchemy-7.2 → risclog_sqlalchemy-9.0}/src/risclog/sqlalchemy/cache.py

@@ -100,26 +100,26 @@ class ModelCache:
             self.hp.setrelheap()
 
     def __sizeof__(self):
-        if not hasattr(self, 'hp'):
+        if not hasattr(self, "hp"):
             return 0
 
         h = self.hp.heap()
         return h.size
 
-    def _sizeof_fmt(self, num, suffix='B'):
-        for unit in ['', 'Ki', 'Mi', 'Gi', 'Ti', 'Pi', 'Ei', 'Zi']:
+    def _sizeof_fmt(self, num, suffix="B"):
+        for unit in ["", "Ki", "Mi", "Gi", "Ti", "Pi", "Ei", "Zi"]:
             if abs(num) < 1024.0:
-                return f'{num:3.1f} {unit}{suffix}'
+                return f"{num:3.1f} {unit}{suffix}"
             num /= 1024.0
-        return f'{num:.1f}Yi{suffix}'
+        return f"{num:.1f}Yi{suffix}"
 
     def log_memory_usage(self):
-        if not hasattr(self, 'hp'):
+        if not hasattr(self, "hp"):
             return
 
         bsize = sys.getsizeof(self)
         size = self._sizeof_fmt(bsize)
-        self._log('info', f'Memory usage: {size} ({bsize})')
+        self._log("info", f"Memory usage: {size} ({bsize})")
 
     def find(self, model, **kwargs):
         """
@@ -205,7 +205,7 @@ class ModelCache:
                 .connection.cursor()
             )
 
-        self._log('debug', 'Flushing model cache.')
+        self._log("debug", "Flushing model cache.")
         self._assign_sequences()
         self._sync_relationship_attrs()
 
@@ -239,7 +239,7 @@ class ModelCache:
             cursor.connection.commit()
 
         self.clear(session)
-        self._log('info', 'Flushed model cache.')
+        self._log("info", "Flushed model cache.")
 
     def _save_by_copy(self, cursor, objects):
         """
@@ -273,7 +273,7 @@ class ModelCache:
                         if column.default is not None:
                             value = column.default.arg
                         else:
-                            value = r'\N'
+                            value = r"\N"
                     elif type(value) != column.type.python_type:
                         value = column.type.python_type(value)
                     row[column.key] = value
@@ -281,11 +281,11 @@ class ModelCache:
 
             file.seek(0)
 
-            columns_string = ','.join(
+            columns_string = ",".join(
                 [f'"{column}"' for column in table.columns.keys()]
             )
             cursor.copy_expert(
-                f'COPY {table} ({columns_string}) '
+                f"COPY {table} ({columns_string}) "
                 "FROM STDIN WITH CSV DELIMITER ',' NULL '\\N'",
                 file,
             )
@@ -451,12 +451,12 @@ class ModelCache:
     def _register_change_handler(self, model, event_handler):
         """Register an event handler for every column of a model."""
         for attr in inspect(model).column_attrs:
-            sqlalchemy.event.listen(attr, 'set', event_handler)
+            sqlalchemy.event.listen(attr, "set", event_handler)
 
     def _deregister_change_handler(self, model, event_handler):
         """Removes an event handler for every column of a model."""
         for attr in inspect(model).column_attrs:
-            sqlalchemy.event.listen(attr, 'set', event_handler)
+            sqlalchemy.event.listen(attr, "set", event_handler)
 
     def _instance_change_handler(self, instance, value, oldvalue, initiator):
         """
@@ -466,7 +466,7 @@ class ModelCache:
         attribute was changed. For more information,
         see: https://docs.sqlalchemy.org/en/13/orm/events.html
         """  # noqa: E501
-        if oldvalue is sqlalchemy.util.symbol('NEVER_SET'):
+        if oldvalue is sqlalchemy.util.symbol("NEVER_SET"):
             return
 
         model = type(instance)

{risclog.sqlalchemy-7.2 → risclog_sqlalchemy-9.0}/src/risclog/sqlalchemy/db.py

@@ -14,18 +14,19 @@ import zope.interface
 import zope.sqlalchemy
 from packaging.version import Version as parse_version
 from sqlalchemy import __version__ as sqlalchemy_version
+from sqlalchemy import text
 
 # Mapping engine name registered using Database.register_engine --> base class
 _ENGINE_CLASS_MAPPING = {}
 
-SA_GE_14 = parse_version(sqlalchemy_version) >= parse_version('1.4.0')
+SA_GE_14 = parse_version(sqlalchemy_version) >= parse_version("1.4.0")
 
 
 def assert_engine_not_registered(name, mapping):
     """Ensure a consistent error message."""
     assert (
         name not in mapping
-    ), f'An engine for name `{name}` is already registered.'
+    ), f"An engine for name `{name}` is already registered."
 
 
 def register_class(class_):
@@ -74,13 +75,10 @@ class RoutingSession(sqlalchemy.orm.Session):
             if issubclass(mapper.class_, class_):
                 return db_util.get_engine(engine_name)
 
-        raise RuntimeError(f'Did not find an engine for {mapper.class_}')
+        raise RuntimeError(f"Did not find an engine for {mapper.class_}")
 
     def _bound_execute(self, bind, *args, **kwargs):
-        if SA_GE_14:
-            return self.execute(*args, bind_arguments={'bind': bind}, **kwargs)
-        else:
-            return self.execute(*args, bind=bind, **kwargs)
+        return self.execute(*args, bind_arguments={"bind": bind}, **kwargs)
 
     def execute_with_bind(self, engine_name, *args, **kwargs):
         """
@@ -141,10 +139,9 @@ def get_database(testing=False, keep_session=False, expire_on_commit=False):
     db = zope.component.queryUtility(risclog.sqlalchemy.interfaces.IDatabase)
     if db is None:
         db = Database(testing, keep_session, expire_on_commit)
-    assert (
-        db.testing == testing
-    ), 'Requested testing status `%s` does not match Database.testing.' % (
-        testing
+    assert db.testing == testing, (
+        "Requested testing status `%s` does not match Database.testing."
+        % (testing)
     )
     return db
 
@@ -160,8 +157,8 @@ class Database:
             )
             is None
         ), (
-            'Cannot create Database twice, use `.get_database()` to get '
-            'the instance.'
+            "Cannot create Database twice, use `.get_database()` to get "
+            "the instance."
         )
         self._engines = {}
         self.testing = testing
@@ -176,11 +173,11 @@ class Database:
         self._setup_utility()
 
     def register_engine(
-        self, dsn, engine_args={}, name='', alembic_location=None
+        self, dsn, engine_args={}, name="", alembic_location=None
     ):
         assert_engine_not_registered(name, self._engines)
-        engine_args['echo'] = bool(
-            int(os.environ.get('ECHO_SQLALCHEMY_QUERIES', '0'))
+        engine_args["echo"] = bool(
+            int(os.environ.get("ECHO_SQLALCHEMY_QUERIES", "0"))
         )
         engine = sqlalchemy.create_engine(dsn, **engine_args)
         self._verify_engine(engine)
@@ -192,13 +189,13 @@ class Database:
         # reflection now.
         self.prepare_deferred(_ENGINE_CLASS_MAPPING.get(name))
 
-    def get_engine(self, name=''):
-        return self._engines[name]['engine']
+    def get_engine(self, name=""):
+        return self._engines[name]["engine"]
 
     def get_all_engines(self):
-        return [x['engine'] for x in self._engines.values()]
+        return [x["engine"] for x in self._engines.values()]
 
-    def drop_engine(self, name=''):
+    def drop_engine(self, name=""):
         engine = self.get_engine(name)
         engine.dispose()
         del self._engines[name]
@@ -209,30 +206,32 @@ class Database:
         if issubclass(class_, sqlalchemy.ext.declarative.DeferredReflection):
             class_.prepare(self.get_engine(class_._engine_name))
 
-    def create_all(self, engine_name='', create_defaults=True):
+    def create_all(self, engine_name="", create_defaults=True):
         """Create all tables etc. for an engine."""
         engine = self._engines[engine_name]
         _ENGINE_CLASS_MAPPING[engine_name].metadata.create_all(
-            engine['engine']
+            engine["engine"]
         )
 
         # mark the database to be in the latest revision
-        location = engine['alembic_location']
+        location = engine["alembic_location"]
         if location:
-            with alembic_context(engine['engine'], location) as ac:
-                ac.migration_context.stamp(
-                    ac.script, ac.script.get_current_head()
-                )
+            with alembic_context(engine["engine"], location) as ac:
+                with ac.migration_context.begin_transaction():
+                    ac.migration_context.stamp(
+                        ac.script, ac.script.get_current_head()
+                    )
+
         if create_defaults:
             self.create_defaults(engine_name)
 
-    def create_defaults(self, engine_name=''):
+    def create_defaults(self, engine_name=""):
         for name, class_ in risclog.sqlalchemy.model.class_registry.items():
             # do not call create_defaults for foreign engines,
             # since they may not be set up yet
-            if engine_name != getattr(class_, '_engine_name', NotImplemented):
+            if engine_name != getattr(class_, "_engine_name", NotImplemented):
                 continue
-            if hasattr(class_, 'create_defaults'):
+            if hasattr(class_, "create_defaults"):
                 class_.create_defaults()
 
     def _verify_engine(self, engine):
@@ -241,7 +240,7 @@ class Database:
         from sqlalchemy import text
 
         try:
-            conn.execute(text('SELECT * FROM tmp_functest'))
+            conn.execute(text("SELECT * FROM tmp_functest"))
         except sqlalchemy.exc.DatabaseError:
             db_is_testing = False
         else:
@@ -258,25 +257,25 @@ class Database:
 
         # We're not in a valid state. Bail out.
         raise SystemExit(
-            'Not working against correct database (live vs '
-            'testing). Refusing to set up database connection '
-            'to {}.'.format(engine.url)
+            "Not working against correct database (live vs "
+            "testing). Refusing to set up database connection "
+            "to {}.".format(engine.url)
         )
 
-    def assert_database_revision_is_current(self, engine_name=''):
+    def assert_database_revision_is_current(self, engine_name=""):
         def assert_revision(ac, head_rev, db_rev):
             if head_rev != db_rev:
                 raise ValueError(
                     'Database revision {} of engine "{}" does not match '
-                    'current revision {}.\nMaybe you want to call '
-                    '`bin/alembic upgrade head`.'.format(
+                    "current revision {}.\nMaybe you want to call "
+                    "`bin/alembic upgrade head`.".format(
                         db_rev, engine_name, head_rev
                     )
                 )
 
         self._run_in_alembic_context(assert_revision, engine_name)
 
-    def update_database_revision_to_current(self, engine_name=''):
+    def update_database_revision_to_current(self, engine_name=""):
         def upgrade_revision(ac, head_rev, db_rev):
             if head_rev != db_rev:
                 ac.upgrade(head_rev)
@@ -318,7 +317,7 @@ class Database:
 
             try:
                 # never truncate the PostGIS table
-                table_names.remove('spatial_ref_sys')
+                table_names.remove("spatial_ref_sys")
             except ValueError:
                 pass
 
@@ -328,25 +327,27 @@ class Database:
                 # does not change the schema. Clearing the alembic_version will
                 # cause "confusion and delay".
                 try:
-                    table_names.remove('alembic_version')
+                    table_names.remove("alembic_version")
                 except ValueError:
                     pass
         if not table_names:
             return
-        tables = ', '.join('"%s"' % x for x in table_names)
+        tables = ", ".join('"%s"' % x for x in table_names)
         self.session._bound_execute(
             engine,
-            'TRUNCATE {} {} {}'.format(
-                tables,
-                'RESTART IDENTITY' if restart_sequences else '',
-                'CASCADE' if cascade else '',
+            text(
+                "TRUNCATE {} {} {}".format(
+                    tables,
+                    "RESTART IDENTITY" if restart_sequences else "",
+                    "CASCADE" if cascade else "",
+                )
             ),
         )
         zope.sqlalchemy.mark_changed(self.session)
         if commit:
             transaction.commit()
 
-    def _run_in_alembic_context(self, func, engine_name=''):
+    def _run_in_alembic_context(self, func, engine_name=""):
         """Run a function in `alembic_context`.
 
         The function must take three parameters:
@@ -356,10 +357,10 @@ class Database:
 
         """
         engine = self._engines[engine_name]
-        location = engine['alembic_location']
+        location = engine["alembic_location"]
         if not location:
             return
-        with alembic_context(engine['engine'], location) as ac:
+        with alembic_context(engine["engine"], location) as ac:
             head_rev = ac.script.get_current_head()
             db_rev = ac.migration_context.get_current_revision()
             return func(ac, head_rev, db_rev)
@@ -385,7 +386,7 @@ class AlembicContext:
     def __init__(self, conn, script_location):
         self.conn = conn
         self.config = alembic.config.Config()
-        self.config.set_main_option('script_location', script_location)
+        self.config.set_main_option("script_location", script_location)
         self.migration_context = alembic.migration.MigrationContext.configure(
             conn
         )
@@ -402,3 +403,5 @@ class AlembicContext:
         ) as ec:
             ec.configure(self.conn)
             ec.run_migrations()
+            if hasattr(self.conn, "commit"):
+                self.conn.commit()