[ZEBRA-1139] Merge OG sqlalchemy-continuum updates into our version

.github/workflows/main.yml

@@ -0,0 +1,73 @@
+name: "Test"
+
+on:
+  push:
+    paths-ignore:
+      - "docs/**"
+  pull_request:
+    paths-ignore:
+      - "docs/**"
+  schedule:
+    - cron: '40 1 * * 3'
+
+
+jobs:
+  test:
+    name: test-python${{ matrix.python-version }}-sa${{ matrix.sqlalchemy-version }}-${{ matrix.db-engine }}
+    strategy:
+      matrix:
+        python-version:
+#          - "2.7"
+#          - "3.4"
+#          - "3.5"
+#          - "3.6"
+#          - "3.7"
+          - "3.8"
+#          - "3.9"
+#          - "3.10"
+#          - "pypy-3.7"
+        sqlalchemy-version:
+          - "<1.4"
+          - ">=1.4"
+        db-engine:
+          - sqlite
+          - postgres
+          - postgres-native
+          - mysql
+    runs-on: ubuntu-latest
+    services:
+      mysql:
+        image: mysql
+        ports:
+          - 3306:3306
+        env:
+          MYSQL_DATABASE: sqlalchemy_continuum_test
+          MYSQL_ALLOW_EMPTY_PASSWORD: yes
+        options: >-
+          --health-cmd "mysqladmin ping"
+          --health-interval 5s
+          --health-timeout 2s
+          --health-retries 3
+      postgres:
+        image: postgres
+        ports:
+          - 5432:5432
+        env:
+          POSTGRES_PASSWORD: postgres
+          POSTGRES_DB: sqlalchemy_continuum_test
+        options: >-
+          --health-cmd pg_isready
+          --health-interval 5s
+          --health-timeout 2s
+          --health-retries 3
+    steps:
+      - uses: actions/checkout@v1
+      - name: Install sqlalchemy
+        run: pip3 install 'sqlalchemy${{ matrix.sqlalchemy-version }}'
+      - name: Build
+        run: pip3 install -e '.[test]'
+      - name: Run tests
+        run: pytest
+        env:
+          DB: ${{ matrix.db-engine }}
+

.gitignore

@@ -34,3 +34,9 @@ nosetests.xml
 .mr.developer.cfg
 .project
 .pydevproject
+
+# mypy
+.mypy_cache/
+
+# Unit test / coverage reports
+.cache

.travis.yml

@@ -1,5 +1,9 @@
-addons:
-  postgresql: 9.3
+services:
+  - mysql
+  - postgresql
+
+dist: xenial
+sudo: true
 
 env:
   - DB=mysql
@@ -15,9 +19,10 @@ before_script:
 language: python
 python:
   - 2.7
-  - 3.3
   - 3.4
   - 3.5
+  - 3.6
+  - 3.7
 install:
   - pip install -e  ".[test]"
 script:

CHANGES.rst

@@ -4,10 +4,71 @@ Changelog
 Here you can see the full list of changes between each SQLAlchemy-Continuum release.
 
 
-1.3.12 (2019-03-18)
+1.3.12 (2022-01-18)
+^^^^^^^^^^^^^^^^^^^
+
+- Support SA 1.4
+
+1.3.11 (2020-05-24)
+^^^^^^^^^^^^^^^^^^^
+
+- Made ModelBuilder create column aliases in version models (#246, courtesy of killthekitten)
+
+
+1.3.10 (2020-05-10)
+^^^^^^^^^^^^^^^^^^^
+
+- Added explicit "pseudo-backref" relationships for version/parent (#240, courtesy of lgedgar)
+- Fixed m2m Bug when an unrelated change is made to a model (#242, courtesy of Andrew-Dickinson)
+
+
+1.3.9 (2019-03-19)
 ^^^^^^^^^^^^^^^^^^
 
 - Added SA 1.3 support
+- Reverted trigger creation from 1.3.7
+
+
+1.3.8 (2019-02-27)
+^^^^^^^^^^^^^^^^^^
+
+- Fixed revert to ignore non-columns (#197, courtesy of mauler)
+
+
+1.3.7 (2019-01-13)
+^^^^^^^^^^^^^^^^^^
+
+- Fix trigger creation during alembic migrations (#209, courtesy of lyndsysimon)
+
+
+1.3.6 (2018-07-30)
+^^^^^^^^^^^^^^^^^^
+
+- Fixed ResourceClosedErrors from connections leaking when using an external transaction (#196, courtesy of vault)
+
+
+1.3.5 (2018-06-03)
+^^^^^^^^^^^^^^^^^^
+
+- Track cloned connections (#167, courtesy of netcriptus)
+
+
+1.3.4 (2018-03-07)
+^^^^^^^^^^^^^^^^^^
+
+- Exclude many-to-many properties from versioning if they are added in exclude parameter (#169, courtesy of fuhrysteve)
+
+
+1.3.3 (2017-11-05)
+^^^^^^^^^^^^^^^^^^
+
+- Fixed changeset when updating object in same transaction as inserting it (#141, courtesy of oinopion)
+
+
+1.3.2 (2017-10-12)
+^^^^^^^^^^^^^^^^^^
+
+- Fixed multiple schema handling (#132, courtesy of vault)
 
 
 1.3.1 (2017-06-28)

LICENSE

@@ -12,8 +12,9 @@ modification, are permitted provided that the following conditions are met:
   this list of conditions and the following disclaimer in the documentation
   and/or other materials provided with the distribution.
 
-* The names of the contributors may not be used to endorse or promote products
-  derived from this software without specific prior written permission.
+* Neither the name of the copyright holder nor the names of its
+  contributors may be used to endorse or promote products derived from
+  this software without specific prior written permission.
 
 THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS "AS IS" AND
 ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED

benchmark.py

@@ -50,7 +50,7 @@ def test_versioning(
 
     make_versioned(options=options)
 
-    dns = 'postgres://postgres@localhost/sqlalchemy_continuum_test'
+    dns = 'postgresql://postgres:postgres@localhost/sqlalchemy_continuum_test'
     versioning_manager.plugins = plugins
     versioning_manager.transaction_cls = transaction_cls
     versioning_manager.user_cls = user_cls

docs/alembic.rst

@@ -1,6 +1,11 @@
 Alembic migrations
 ==================
 
-Each time you make changes to database structure you should also change the associated history tables. When you make changes to your models SQLAlchemy-Continuum automatically alters the history model definitions, hence you can use `alembic revision --autogenerate` just like before. You just need to make sure `make_versioned` function gets called before alembic gathers all your models.
+Each time you make changes to database structure you should also change the associated history tables. When you make changes to your models SQLAlchemy-Continuum automatically alters the history model definitions, hence you can use `alembic revision --autogenerate` just like before. You just need to make sure `make_versioned` function gets called before alembic gathers all your models and `configure_mappers` is called afterwards.
 
 Pay close attention when dropping or moving data from parent tables and reflecting these changes to history tables.
+
+Troubleshooting
+###############
+
+If alembic didn't detect any changes or generates reversed migration (tries to remove `*_version` tables from database instead of creating), make sure that `configure_mappers` was called by alembic command.

docs/intro.rst

@@ -5,7 +5,7 @@ Introduction
 Why?
 ^^^^
 
-SQLAlchemy already has versioning extension. This extension however is very limited. It does not support versioning entire transactions.
+SQLAlchemy `already has a versioning extension <https://docs.sqlalchemy.org/en/13/orm/examples.html#module-examples.versioned_history>`_. This extension however is very limited. It does not support versioning entire transactions.
 
 Hibernate for Java has Envers, which had nice features but lacks a nice API. Ruby on Rails has papertrail_, which has very nice API but lacks the efficiency and feature set of Envers.
 
@@ -54,7 +54,7 @@ In order to make your models versioned you need two things:
     from sqlalchemy_continuum import make_versioned
 
 
-    make_versioned()
+    make_versioned(user_cls=None)
 
 
     class Article(Base):

docs/native_versioning.rst

@@ -25,9 +25,13 @@ Schema migrations
 When making schema migrations (for example adding new columns to version tables) you need to remember to call sync_trigger in order to keep the version trigger up-to-date.
 ::
 
-    from sqlalchemy_continuum import versioning_manager # or import your custom one, if you have one
-    sync_trigger(conn,
-                 'article_version',
-                 versioning_manager=versioning_manager)
+    from sqlalchemy_continuum.dialects.postgresql import sync_trigger
 
 
+    sync_trigger(conn, 'article_version')
+
+If you don't use `PropertyModTrackerPlugin`, then you have to disable it:
+
+::
+
+    sync_trigger(conn, 'article_version', use_property_mod_tracking=False)

docs/plugins.rst

@@ -7,7 +7,7 @@ Using plugins
 
 ::
 
-    from sqlalchemy.continuum.plugins import PropertyModTrackerPlugin
+    from sqlalchemy_continuum.plugins import PropertyModTrackerPlugin
 
 
     versioning_manager.plugins.append(PropertyModTrackerPlugin())

docs/version_objects.rst

@@ -102,7 +102,7 @@ you can easily check the changeset of given object in current transaction.
 
     article = Article(name=u'Some article')
     changeset(article)
-    # {'name': [u'Some article', None]}
+    # {'name': [None, u'Some article']}
 
 
 Version relationships

setup.py

@@ -28,15 +28,14 @@ def get_version():
         'pytest>=2.3.5',
         'flexmock>=0.9.7',
         'psycopg2>=2.4.6',
-        'PyMySQL==0.6.1',
+        'PyMySQL>=0.8.0',
         'six>=1.4.0'
     ],
-    'anyjson': ['anyjson>=0.3.3'],
     'flask': ['Flask>=0.9'],
     'flask-login': ['Flask-Login>=0.2.9'],
     'flask-sqlalchemy': ['Flask-SQLAlchemy>=1.0'],
     'flexmock': ['flexmock>=0.9.7'],
-    'i18n': ['SQLAlchemy-i18n>=0.8.4'],
+    'i18n': ['SQLAlchemy-i18n>=0.8.4,!=1.1.0'],
 }
 
 
@@ -77,9 +76,10 @@ def get_version():
         'Programming Language :: Python :: 2',
         'Programming Language :: Python :: 2.7',
         'Programming Language :: Python :: 3',
-        'Programming Language :: Python :: 3.3',
         'Programming Language :: Python :: 3.4',
         'Programming Language :: Python :: 3.5',
+        'Programming Language :: Python :: 3.6',
+        'Programming Language :: Python :: 3.7',
         'Topic :: Internet :: WWW/HTTP :: Dynamic Content',
         'Topic :: Software Development :: Libraries :: Python Modules'
     ]

sqlalchemy_continuum/__init__.py

@@ -20,7 +20,7 @@
 )
 
 
-__version__ = '1.4.3'
+__version__ = '1.5.0'
 
 
 versioning_manager = VersioningManager()
@@ -72,6 +72,18 @@ def make_versioned(
         manager.track_association_operations
     )
 
+    sa.event.listen(
+        sa.engine.Engine,
+        'rollback',
+        manager.clear_connection
+    )
+
+    sa.event.listen(
+        sa.engine.Engine,
+        'set_connection_execution_options',
+        manager.track_cloned_connections
+    )
+
 
 def remove_versioning(
     mapper=sa.orm.mapper,
@@ -98,3 +110,15 @@ def remove_versioning(
         'before_cursor_execute',
         manager.track_association_operations
     )
+
+    sa.event.remove(
+        sa.engine.Engine,
+        'rollback',
+        manager.clear_connection
+    )
+
+    sa.event.remove(
+        sa.engine.Engine,
+        'set_connection_execution_options',
+        manager.track_cloned_connections
+    )