alembic 1.13.3__tar.gz → 1.14.0__tar.gz

{alembic-1.13.3/alembic.egg-info → alembic-1.14.0}/PKG-INFO

@@ -1,6 +1,6 @@
 Metadata-Version: 2.1
 Name: alembic
-Version: 1.13.3
+Version: 1.14.0
 Summary: A database migration tool for SQLAlchemy.
 Home-page: https://alembic.sqlalchemy.org
 Author: Mike Bayer

{alembic-1.13.3 → alembic-1.14.0}/alembic/__init__.py

@@ -1,4 +1,4 @@
 from . import context
 from . import op
 
-__version__ = "1.13.3"
+__version__ = "1.14.0"

{alembic-1.13.3 → alembic-1.14.0}/alembic/ddl/base.py

@@ -175,7 +175,7 @@ class ColumnComment(AlterColumn):
         self.comment = comment
 
 
-@compiles(RenameTable)  # type: ignore[misc]
+@compiles(RenameTable)
 def visit_rename_table(
     element: RenameTable, compiler: DDLCompiler, **kw
 ) -> str:
@@ -185,7 +185,7 @@ def visit_rename_table(
     )
 
 
-@compiles(AddColumn)  # type: ignore[misc]
+@compiles(AddColumn)
 def visit_add_column(element: AddColumn, compiler: DDLCompiler, **kw) -> str:
     return "%s %s" % (
         alter_table(compiler, element.table_name, element.schema),
@@ -193,7 +193,7 @@ def visit_add_column(element: AddColumn, compiler: DDLCompiler, **kw) -> str:
     )
 
 
-@compiles(DropColumn)  # type: ignore[misc]
+@compiles(DropColumn)
 def visit_drop_column(element: DropColumn, compiler: DDLCompiler, **kw) -> str:
     return "%s %s" % (
         alter_table(compiler, element.table_name, element.schema),
@@ -201,7 +201,7 @@ def visit_drop_column(element: DropColumn, compiler: DDLCompiler, **kw) -> str:
     )
 
 
-@compiles(ColumnNullable)  # type: ignore[misc]
+@compiles(ColumnNullable)
 def visit_column_nullable(
     element: ColumnNullable, compiler: DDLCompiler, **kw
 ) -> str:
@@ -212,7 +212,7 @@ def visit_column_nullable(
     )
 
 
-@compiles(ColumnType)  # type: ignore[misc]
+@compiles(ColumnType)
 def visit_column_type(element: ColumnType, compiler: DDLCompiler, **kw) -> str:
     return "%s %s %s" % (
         alter_table(compiler, element.table_name, element.schema),
@@ -221,7 +221,7 @@ def visit_column_type(element: ColumnType, compiler: DDLCompiler, **kw) -> str:
     )
 
 
-@compiles(ColumnName)  # type: ignore[misc]
+@compiles(ColumnName)
 def visit_column_name(element: ColumnName, compiler: DDLCompiler, **kw) -> str:
     return "%s RENAME %s TO %s" % (
         alter_table(compiler, element.table_name, element.schema),
@@ -230,7 +230,7 @@ def visit_column_name(element: ColumnName, compiler: DDLCompiler, **kw) -> str:
     )
 
 
-@compiles(ColumnDefault)  # type: ignore[misc]
+@compiles(ColumnDefault)
 def visit_column_default(
     element: ColumnDefault, compiler: DDLCompiler, **kw
 ) -> str:
@@ -245,7 +245,7 @@ def visit_column_default(
     )
 
 
-@compiles(ComputedColumnDefault)  # type: ignore[misc]
+@compiles(ComputedColumnDefault)
 def visit_computed_column(
     element: ComputedColumnDefault, compiler: DDLCompiler, **kw
 ):
@@ -255,7 +255,7 @@ def visit_computed_column(
     )
 
 
-@compiles(IdentityColumnDefault)  # type: ignore[misc]
+@compiles(IdentityColumnDefault)
 def visit_identity_column(
     element: IdentityColumnDefault, compiler: DDLCompiler, **kw
 ):

{alembic-1.13.3 → alembic-1.14.0}/alembic/ddl/impl.py

@@ -21,7 +21,12 @@ from typing import TYPE_CHECKING
 from typing import Union
 
 from sqlalchemy import cast
+from sqlalchemy import Column
+from sqlalchemy import MetaData
+from sqlalchemy import PrimaryKeyConstraint
 from sqlalchemy import schema
+from sqlalchemy import String
+from sqlalchemy import Table
 from sqlalchemy import text
 
 from . import _autogen
@@ -43,11 +48,9 @@ if TYPE_CHECKING:
     from sqlalchemy.sql import Executable
     from sqlalchemy.sql.elements import ColumnElement
     from sqlalchemy.sql.elements import quoted_name
-    from sqlalchemy.sql.schema import Column
     from sqlalchemy.sql.schema import Constraint
     from sqlalchemy.sql.schema import ForeignKeyConstraint
     from sqlalchemy.sql.schema import Index
-    from sqlalchemy.sql.schema import Table
     from sqlalchemy.sql.schema import UniqueConstraint
     from sqlalchemy.sql.selectable import TableClause
     from sqlalchemy.sql.type_api import TypeEngine
@@ -136,6 +139,40 @@ class DefaultImpl(metaclass=ImplMeta):
         self.output_buffer.write(text + "\n\n")
         self.output_buffer.flush()
 
+    def version_table_impl(
+        self,
+        *,
+        version_table: str,
+        version_table_schema: Optional[str],
+        version_table_pk: bool,
+        **kw: Any,
+    ) -> Table:
+        """Generate a :class:`.Table` object which will be used as the
+        structure for the Alembic version table.
+
+        Third party dialects may override this hook to provide an alternate
+        structure for this :class:`.Table`; requirements are only that it
+        be named based on the ``version_table`` parameter and contains
+        at least a single string-holding column named ``version_num``.
+
+        .. versionadded:: 1.14
+
+        """
+        vt = Table(
+            version_table,
+            MetaData(),
+            Column("version_num", String(32), nullable=False),
+            schema=version_table_schema,
+        )
+        if version_table_pk:
+            vt.append_constraint(
+                PrimaryKeyConstraint(
+                    "version_num", name=f"{version_table}_pkc"
+                )
+            )
+
+        return vt
+
     def requires_recreate_in_batch(
         self, batch_op: BatchOperationsImpl
     ) -> bool:

{alembic-1.13.3 → alembic-1.14.0}/alembic/runtime/migration.py

@@ -24,10 +24,6 @@ from typing import Union
 
 from sqlalchemy import Column
 from sqlalchemy import literal_column
-from sqlalchemy import MetaData
-from sqlalchemy import PrimaryKeyConstraint
-from sqlalchemy import String
-from sqlalchemy import Table
 from sqlalchemy.engine import Engine
 from sqlalchemy.engine import url as sqla_url
 from sqlalchemy.engine.strategies import MockEngineStrategy
@@ -36,6 +32,7 @@ from .. import ddl
 from .. import util
 from ..util import sqla_compat
 from ..util.compat import EncodedIO
+from ..util.sqla_compat import _select
 
 if TYPE_CHECKING:
     from sqlalchemy.engine import Dialect
@@ -190,18 +187,6 @@ class MigrationContext:
         self.version_table_schema = version_table_schema = opts.get(
             "version_table_schema", None
         )
-        self._version = Table(
-            version_table,
-            MetaData(),
-            Column("version_num", String(32), nullable=False),
-            schema=version_table_schema,
-        )
-        if opts.get("version_table_pk", True):
-            self._version.append_constraint(
-                PrimaryKeyConstraint(
-                    "version_num", name="%s_pkc" % version_table
-                )
-            )
 
         self._start_from_rev: Optional[str] = opts.get("starting_rev")
         self.impl = ddl.DefaultImpl.get_by_dialect(dialect)(
@@ -212,6 +197,13 @@ class MigrationContext:
             self.output_buffer,
             opts,
         )
+
+        self._version = self.impl.version_table_impl(
+            version_table=version_table,
+            version_table_schema=version_table_schema,
+            version_table_pk=opts.get("version_table_pk", True),
+        )
+
         log.info("Context impl %s.", self.impl.__class__.__name__)
         if self.as_sql:
             log.info("Generating static SQL")
@@ -540,7 +532,10 @@ class MigrationContext:
                 return ()
         assert self.connection is not None
         return tuple(
-            row[0] for row in self.connection.execute(self._version.select())
+            row[0]
+            for row in self.connection.execute(
+                _select(self._version.c.version_num)
+            )
         )
 
     def _ensure_version_table(self, purge: bool = False) -> None:

{alembic-1.13.3 → alembic-1.14.0}/alembic/templates/async/alembic.ini.mako

@@ -90,12 +90,12 @@ keys = console
 keys = generic
 
 [logger_root]
-level = WARN
+level = WARNING
 handlers = console
 qualname =
 
 [logger_sqlalchemy]
-level = WARN
+level = WARNING
 handlers =
 qualname = sqlalchemy.engine
 

{alembic-1.13.3 → alembic-1.14.0}/alembic/templates/generic/alembic.ini.mako

@@ -92,12 +92,12 @@ keys = console
 keys = generic
 
 [logger_root]
-level = WARN
+level = WARNING
 handlers = console
 qualname =
 
 [logger_sqlalchemy]
-level = WARN
+level = WARNING
 handlers =
 qualname = sqlalchemy.engine
 

{alembic-1.13.3 → alembic-1.14.0}/alembic/templates/multidb/alembic.ini.mako

@@ -97,12 +97,12 @@ keys = console
 keys = generic
 
 [logger_root]
-level = WARN
+level = WARNING
 handlers = console
 qualname =
 
 [logger_sqlalchemy]
-level = WARN
+level = WARNING
 handlers =
 qualname = sqlalchemy.engine
 

{alembic-1.13.3 → alembic-1.14.0}/alembic/testing/env.py

@@ -118,7 +118,7 @@ keys = root,sqlalchemy
 keys = console
 
 [logger_root]
-level = WARN
+level = WARNING
 handlers = console
 qualname =
 
@@ -171,7 +171,7 @@ keys = root
 keys = console
 
 [logger_root]
-level = WARN
+level = WARNING
 handlers = console
 qualname =
 
@@ -216,7 +216,7 @@ keys = root
 keys = console
 
 [logger_root]
-level = WARN
+level = WARNING
 handlers = console
 qualname =
 
@@ -497,7 +497,7 @@ keys = root
 keys = console
 
 [logger_root]
-level = WARN
+level = WARNING
 handlers = console
 qualname =
 

{alembic-1.13.3 → alembic-1.14.0/alembic.egg-info}/PKG-INFO

@@ -1,6 +1,6 @@
 Metadata-Version: 2.1
 Name: alembic
-Version: 1.13.3
+Version: 1.14.0
 Summary: A database migration tool for SQLAlchemy.
 Home-page: https://alembic.sqlalchemy.org
 Author: Mike Bayer

{alembic-1.13.3 → alembic-1.14.0}/alembic.egg-info/SOURCES.txt

@@ -150,16 +150,13 @@ docs/_static/webpack-macros.html
 docs/_static/images/logo_colab.png
 docs/_static/scripts/bootstrap.js
 docs/_static/scripts/bootstrap.js.LICENSE.txt
+docs/_static/scripts/fontawesome.js
+docs/_static/scripts/fontawesome.js.LICENSE.txt
 docs/_static/scripts/pydata-sphinx-theme.js
 docs/_static/scripts/sphinx-book-theme.js
-docs/_static/styles/bootstrap.css
 docs/_static/styles/pydata-sphinx-theme.css
 docs/_static/styles/sphinx-book-theme.css
 docs/_static/styles/theme.css
-docs/_static/vendor/fontawesome/6.5.2/LICENSE.txt
-docs/_static/vendor/fontawesome/6.5.2/css/all.min.css
-docs/_static/vendor/fontawesome/6.5.2/js/all.min.js
-docs/_static/vendor/fontawesome/6.5.2/js/all.min.js.LICENSE.txt
 docs/api/autogenerate.html
 docs/api/commands.html
 docs/api/config.html

{alembic-1.13.3 → alembic-1.14.0}/docs/_sources/changelog.rst

@@ -3,6 +3,23 @@
 Changelog
 ==========
 
+.. changelog::
+    :version: 1.14.0
+    :released: November 4, 2024
+
+    .. change::
+        :tags: usecase, runtime
+        :tickets: 1560
+
+        Added a new hook to the :class:`.DefaultImpl`
+        :meth:`.DefaultImpl.version_table_impl`.  This allows third party dialects
+        to define the exact structure of the alembic_version table, to include use
+        cases where the table requires special directives and/or additional columns
+        so that it may function correctly on a particular backend.  This is not
+        intended as a user-expansion hook, only a dialect implementation hook to
+        produce a working alembic_version table. Pull request courtesy Maciek
+        Bryński.
+
 .. changelog::
     :version: 1.13.3
     :released: September 23, 2024

{alembic-1.13.3 → alembic-1.14.0}/docs/_sources/tutorial.rst

@@ -217,12 +217,12 @@ The file generated with the "generic" configuration looks like::
     keys = generic
 
     [logger_root]
-    level = WARN
+    level = WARNING
     handlers = console
     qualname =
 
     [logger_sqlalchemy]
-    level = WARN
+    level = WARNING
     handlers =
     qualname = sqlalchemy.engine
 

{alembic-1.13.3 → alembic-1.14.0}/docs/_static/basic.css

@@ -1,12 +1,5 @@
 /*
- * basic.css
- * ~~~~~~~~~
- *
  * Sphinx stylesheet -- basic theme.
- *
- * :copyright: Copyright 2007-2024 by the Sphinx team, see AUTHORS.
- * :license: BSD, see LICENSE for details.
- *
  */
 
 /* -- main layout ----------------------------------------------------------- */
@@ -115,15 +108,11 @@ img {
 /* -- search page ----------------------------------------------------------- */
 
 ul.search {
-    margin: 10px 0 0 20px;
-    padding: 0;
+    margin-top: 10px;
 }
 
 ul.search li {
-    padding: 5px 0 5px 20px;
-    background-image: url(file.png);
-    background-repeat: no-repeat;
-    background-position: 0 7px;
+    padding: 5px 0;
 }
 
 ul.search li a {

{alembic-1.13.3 → alembic-1.14.0}/docs/_static/doctools.js

@@ -1,12 +1,5 @@
 /*
- * doctools.js
- * ~~~~~~~~~~~
- *
  * Base JavaScript utilities for all Sphinx HTML documentation.
- *
- * :copyright: Copyright 2007-2024 by the Sphinx team, see AUTHORS.
- * :license: BSD, see LICENSE for details.
- *
  */
 "use strict";
 

{alembic-1.13.3 → alembic-1.14.0}/docs/_static/documentation_options.js

@@ -1,5 +1,5 @@
 const DOCUMENTATION_OPTIONS = {
-    VERSION: '1.13.3',
+    VERSION: '1.14.0',
     LANGUAGE: 'en',
     COLLAPSE_INDEX: false,
     BUILDER: 'html',

{alembic-1.13.3 → alembic-1.14.0}/docs/_static/language_data.js

@@ -1,13 +1,6 @@
 /*
- * language_data.js
- * ~~~~~~~~~~~~~~~~
- *
  * This script contains the language-specific data used by searchtools.js,
  * namely the list of stopwords, stemmer, scorer and splitter.
- *
- * :copyright: Copyright 2007-2024 by the Sphinx team, see AUTHORS.
- * :license: BSD, see LICENSE for details.
- *
  */
 
 var stopwords = ["a", "and", "are", "as", "at", "be", "but", "by", "for", "if", "in", "into", "is", "it", "near", "no", "not", "of", "on", "or", "such", "that", "the", "their", "then", "there", "these", "they", "this", "to", "was", "will", "with"];