alembic 1.14.1__py3-none-any.whl → 1.15.1__py3-none-any.whl

alembic/testing/env.py

@@ -1,5 +1,6 @@
 import importlib.machinery
 import os
+from pathlib import Path
 import shutil
 import textwrap
 
@@ -16,7 +17,7 @@ from ..script import ScriptDirectory
 
 def _get_staging_directory():
     if provision.FOLLOWER_IDENT:
-        return "scratch_%s" % provision.FOLLOWER_IDENT
+        return f"scratch_{provision.FOLLOWER_IDENT}"
     else:
         return "scratch"
 
@@ -24,7 +25,7 @@ def _get_staging_directory():
 def staging_env(create=True, template="generic", sourceless=False):
     cfg = _testing_config()
     if create:
-        path = os.path.join(_get_staging_directory(), "scripts")
+        path = _join_path(_get_staging_directory(), "scripts")
         assert not os.path.exists(path), (
             "staging directory %s already exists; poor cleanup?" % path
         )
@@ -47,7 +48,7 @@ def staging_env(create=True, template="generic", sourceless=False):
                 "pep3147_everything",
             ), sourceless
             make_sourceless(
-                os.path.join(path, "env.py"),
+                _join_path(path, "env.py"),
                 "pep3147" if "pep3147" in sourceless else "simple",
             )
 
@@ -63,14 +64,14 @@ def clear_staging_env():
 
 
 def script_file_fixture(txt):
-    dir_ = os.path.join(_get_staging_directory(), "scripts")
-    path = os.path.join(dir_, "script.py.mako")
+    dir_ = _join_path(_get_staging_directory(), "scripts")
+    path = _join_path(dir_, "script.py.mako")
     with open(path, "w") as f:
         f.write(txt)
 
 
 def env_file_fixture(txt):
-    dir_ = os.path.join(_get_staging_directory(), "scripts")
+    dir_ = _join_path(_get_staging_directory(), "scripts")
     txt = (
         """
 from alembic import context
@@ -80,7 +81,7 @@ config = context.config
         + txt
     )
 
-    path = os.path.join(dir_, "env.py")
+    path = _join_path(dir_, "env.py")
     pyc_path = util.pyc_file_from_path(path)
     if pyc_path:
         os.unlink(pyc_path)
@@ -90,26 +91,26 @@ config = context.config
 
 
 def _sqlite_file_db(tempname="foo.db", future=False, scope=None, **options):
-    dir_ = os.path.join(_get_staging_directory(), "scripts")
+    dir_ = _join_path(_get_staging_directory(), "scripts")
     url = "sqlite:///%s/%s" % (dir_, tempname)
-    if scope and util.sqla_14:
+    if scope:
         options["scope"] = scope
     return testing_util.testing_engine(url=url, future=future, options=options)
 
 
 def _sqlite_testing_config(sourceless=False, future=False):
-    dir_ = os.path.join(_get_staging_directory(), "scripts")
-    url = "sqlite:///%s/foo.db" % dir_
+    dir_ = _join_path(_get_staging_directory(), "scripts")
+    url = f"sqlite:///{dir_}/foo.db"
 
     sqlalchemy_future = future or ("future" in config.db.__class__.__module__)
 
     return _write_config_file(
-        """
+        f"""
 [alembic]
-script_location = %s
-sqlalchemy.url = %s
-sourceless = %s
-%s
+script_location = {dir_}
+sqlalchemy.url = {url}
+sourceless = {"true" if sourceless else "false"}
+{"sqlalchemy.future = true" if sqlalchemy_future else ""}
 
 [loggers]
 keys = root,sqlalchemy
@@ -140,29 +141,24 @@ keys = generic
 format = %%(levelname)-5.5s [%%(name)s] %%(message)s
 datefmt = %%H:%%M:%%S
     """
-        % (
-            dir_,
-            url,
-            "true" if sourceless else "false",
-            "sqlalchemy.future = true" if sqlalchemy_future else "",
-        )
     )
 
 
 def _multi_dir_testing_config(sourceless=False, extra_version_location=""):
-    dir_ = os.path.join(_get_staging_directory(), "scripts")
+    dir_ = _join_path(_get_staging_directory(), "scripts")
     sqlalchemy_future = "future" in config.db.__class__.__module__
 
     url = "sqlite:///%s/foo.db" % dir_
 
     return _write_config_file(
-        """
+        f"""
 [alembic]
-script_location = %s
-sqlalchemy.url = %s
-sqlalchemy.future = %s
-sourceless = %s
-version_locations = %%(here)s/model1/ %%(here)s/model2/ %%(here)s/model3/ %s
+script_location = {dir_}
+sqlalchemy.url = {url}
+sqlalchemy.future = {"true" if sqlalchemy_future else "false"}
+sourceless = {"true" if sourceless else "false"}
+version_locations = %(here)s/model1/ %(here)s/model2/ %(here)s/model3/ \
+{extra_version_location}
 
 [loggers]
 keys = root
@@ -188,26 +184,19 @@ keys = generic
 format = %%(levelname)-5.5s [%%(name)s] %%(message)s
 datefmt = %%H:%%M:%%S
     """
-        % (
-            dir_,
-            url,
-            "true" if sqlalchemy_future else "false",
-            "true" if sourceless else "false",
-            extra_version_location,
-        )
     )
 
 
 def _no_sql_testing_config(dialect="postgresql", directives=""):
     """use a postgresql url with no host so that
     connections guaranteed to fail"""
-    dir_ = os.path.join(_get_staging_directory(), "scripts")
+    dir_ = _join_path(_get_staging_directory(), "scripts")
     return _write_config_file(
-        """
+        f"""
 [alembic]
-script_location = %s
-sqlalchemy.url = %s://
-%s
+script_location ={dir_}
+sqlalchemy.url = {dialect}://
+{directives}
 
 [loggers]
 keys = root
@@ -234,7 +223,6 @@ format = %%(levelname)-5.5s [%%(name)s] %%(message)s
 datefmt = %%H:%%M:%%S
 
 """
-        % (dir_, dialect, directives)
     )
 
 
@@ -250,7 +238,7 @@ def _testing_config():
 
     if not os.access(_get_staging_directory(), os.F_OK):
         os.mkdir(_get_staging_directory())
-    return Config(os.path.join(_get_staging_directory(), "test_alembic.ini"))
+    return Config(_join_path(_get_staging_directory(), "test_alembic.ini"))
 
 
 def write_script(
@@ -270,9 +258,7 @@ def write_script(
     script = Script._from_path(scriptdir, path)
     old = scriptdir.revision_map.get_revision(script.revision)
     if old.down_revision != script.down_revision:
-        raise Exception(
-            "Can't change down_revision " "on a refresh operation."
-        )
+        raise Exception("Can't change down_revision on a refresh operation.")
     scriptdir.revision_map.add_revision(script, _replace=True)
 
     if sourceless:
@@ -312,9 +298,9 @@ def three_rev_fixture(cfg):
     write_script(
         script,
         a,
-        """\
+        f"""\
 "Rev A"
-revision = '%s'
+revision = '{a}'
 down_revision = None
 
 from alembic import op
@@ -327,8 +313,7 @@ def upgrade():
 def downgrade():
     op.execute("DROP STEP 1")
 
-"""
-        % a,
+""",
     )
 
     script.generate_revision(b, "revision b", refresh=True, head=a)
@@ -358,10 +343,10 @@ def downgrade():
     write_script(
         script,
         c,
-        """\
+        f"""\
 "Rev C"
-revision = '%s'
-down_revision = '%s'
+revision = '{c}'
+down_revision = '{b}'
 
 from alembic import op
 
@@ -373,8 +358,7 @@ def upgrade():
 def downgrade():
     op.execute("DROP STEP 3")
 
-"""
-        % (c, b),
+""",
     )
     return a, b, c
 
@@ -396,10 +380,10 @@ def multi_heads_fixture(cfg, a, b, c):
     write_script(
         script,
         d,
-        """\
+        f"""\
 "Rev D"
-revision = '%s'
-down_revision = '%s'
+revision = '{d}'
+down_revision = '{b}'
 
 from alembic import op
 
@@ -411,8 +395,7 @@ def upgrade():
 def downgrade():
     op.execute("DROP STEP 4")
 
-"""
-        % (d, b),
+""",
     )
 
     script.generate_revision(
@@ -421,10 +404,10 @@ def downgrade():
     write_script(
         script,
         e,
-        """\
+        f"""\
 "Rev E"
-revision = '%s'
-down_revision = '%s'
+revision = '{e}'
+down_revision = '{d}'
 
 from alembic import op
 
@@ -436,8 +419,7 @@ def upgrade():
 def downgrade():
     op.execute("DROP STEP 5")
 
-"""
-        % (e, d),
+""",
     )
 
     script.generate_revision(
@@ -446,10 +428,10 @@ def downgrade():
     write_script(
         script,
         f,
-        """\
+        f"""\
 "Rev F"
-revision = '%s'
-down_revision = '%s'
+revision = '{f}'
+down_revision = '{b}'
 
 from alembic import op
 
@@ -461,8 +443,7 @@ def upgrade():
 def downgrade():
     op.execute("DROP STEP 6")
 
-"""
-        % (f, b),
+""",
     )
 
     return d, e, f
@@ -471,25 +452,25 @@ def downgrade():
 def _multidb_testing_config(engines):
     """alembic.ini fixture to work exactly with the 'multidb' template"""
 
-    dir_ = os.path.join(_get_staging_directory(), "scripts")
+    dir_ = _join_path(_get_staging_directory(), "scripts")
 
     sqlalchemy_future = "future" in config.db.__class__.__module__
 
     databases = ", ".join(engines.keys())
     engines = "\n\n".join(
-        "[%s]\n" "sqlalchemy.url = %s" % (key, value.url)
+        f"[{key}]\nsqlalchemy.url = {value.url}"
         for key, value in engines.items()
     )
 
     return _write_config_file(
-        """
+        f"""
 [alembic]
-script_location = %s
+script_location = {dir_}
 sourceless = false
-sqlalchemy.future = %s
-databases = %s
+sqlalchemy.future = {"true" if sqlalchemy_future else "false"}
+databases = {databases}
 
-%s
+{engines}
 [loggers]
 keys = root
 
@@ -514,5 +495,8 @@ keys = generic
 format = %%(levelname)-5.5s [%%(name)s] %%(message)s
 datefmt = %%H:%%M:%%S
     """
-        % (dir_, "true" if sqlalchemy_future else "false", databases, engines)
     )
+
+
+def _join_path(base: str, *more: str):
+    return str(Path(base).joinpath(*more).as_posix())

alembic/testing/fixtures.py

@@ -8,6 +8,7 @@ from typing import Any
 from typing import Dict
 
 from sqlalchemy import Column
+from sqlalchemy import create_mock_engine
 from sqlalchemy import inspect
 from sqlalchemy import MetaData
 from sqlalchemy import String
@@ -17,6 +18,7 @@ from sqlalchemy import text
 from sqlalchemy.testing import config
 from sqlalchemy.testing import mock
 from sqlalchemy.testing.assertions import eq_
+from sqlalchemy.testing.fixtures import FutureEngineMixin
 from sqlalchemy.testing.fixtures import TablesTest as SQLAlchemyTablesTest
 from sqlalchemy.testing.fixtures import TestBase as SQLAlchemyTestBase
 
@@ -26,8 +28,6 @@ from ..environment import EnvironmentContext
 from ..migration import MigrationContext
 from ..operations import Operations
 from ..util import sqla_compat
-from ..util.sqla_compat import create_mock_engine
-from ..util.sqla_compat import sqla_14
 from ..util.sqla_compat import sqla_2
 
 
@@ -65,14 +65,6 @@ class TablesTest(TestBase, SQLAlchemyTablesTest):
     pass
 
 
-if sqla_14:
-    from sqlalchemy.testing.fixtures import FutureEngineMixin
-else:
-
-    class FutureEngineMixin:  # type:ignore[no-redef]
-        __requires__ = ("sqlalchemy_14",)
-
-
 FutureEngineMixin.is_sqlalchemy_future = True
 
 
@@ -190,12 +182,8 @@ def op_fixture(
         opts["as_sql"] = as_sql
     if literal_binds:
         opts["literal_binds"] = literal_binds
-    if not sqla_14 and dialect == "mariadb":
-        ctx_dialect = _get_dialect("mysql")
-        ctx_dialect.server_version_info = (10, 4, 0, "MariaDB")
 
-    else:
-        ctx_dialect = _get_dialect(dialect)
+    ctx_dialect = _get_dialect(dialect)
     if native_boolean is not None:
         ctx_dialect.supports_native_boolean = native_boolean
         # this is new as of SQLAlchemy 1.2.7 and is used by SQL Server,

alembic/testing/requirements.py

@@ -1,7 +1,6 @@
 from sqlalchemy.testing.requirements import Requirements
 
 from alembic import util
-from alembic.util import sqla_compat
 from ..testing import exclusions
 
 
@@ -74,13 +73,6 @@ class SuiteRequirements(Requirements):
     def reflects_fk_options(self):
         return exclusions.closed()
 
-    @property
-    def sqlalchemy_14(self):
-        return exclusions.skip_if(
-            lambda config: not util.sqla_14,
-            "SQLAlchemy 1.4 or greater required",
-        )
-
     @property
     def sqlalchemy_1x(self):
         return exclusions.skip_if(
@@ -105,7 +97,7 @@ class SuiteRequirements(Requirements):
             else:
                 return True
 
-        return self.sqlalchemy_14 + exclusions.only_if(go)
+        return exclusions.only_if(go)
 
     @property
     def comments(self):
@@ -121,26 +113,6 @@ class SuiteRequirements(Requirements):
     def computed_columns(self):
         return exclusions.closed()
 
-    @property
-    def computed_columns_api(self):
-        return exclusions.only_if(
-            exclusions.BooleanPredicate(sqla_compat.has_computed)
-        )
-
-    @property
-    def computed_reflects_normally(self):
-        return exclusions.only_if(
-            exclusions.BooleanPredicate(sqla_compat.has_computed_reflection)
-        )
-
-    @property
-    def computed_reflects_as_server_default(self):
-        return exclusions.closed()
-
-    @property
-    def computed_doesnt_reflect_as_server_default(self):
-        return exclusions.closed()
-
     @property
     def autoincrement_on_composite_pk(self):
         return exclusions.closed()
@@ -202,9 +174,3 @@ class SuiteRequirements(Requirements):
     @property
     def identity_columns_alter(self):
         return exclusions.closed()
-
-    @property
-    def identity_columns_api(self):
-        return exclusions.only_if(
-            exclusions.BooleanPredicate(sqla_compat.has_identity)
-        )

alembic/testing/suite/test_autogen_computed.py

@@ -6,9 +6,7 @@ from sqlalchemy import Table
 
 from ._autogen_fixtures import AutogenFixtureTest
 from ... import testing
-from ...testing import config
 from ...testing import eq_
-from ...testing import exclusions
 from ...testing import is_
 from ...testing import is_true
 from ...testing import mock
@@ -63,18 +61,8 @@ class AutogenerateComputedTest(AutogenFixtureTest, TestBase):
         c = diffs[0][3]
         eq_(c.name, "foo")
 
-        if config.requirements.computed_reflects_normally.enabled:
-            is_true(isinstance(c.computed, sa.Computed))
-        else:
-            is_(c.computed, None)
-
-        if config.requirements.computed_reflects_as_server_default.enabled:
-            is_true(isinstance(c.server_default, sa.DefaultClause))
-            eq_(str(c.server_default.arg.text), "5")
-        elif config.requirements.computed_reflects_normally.enabled:
-            is_true(isinstance(c.computed, sa.Computed))
-        else:
-            is_(c.computed, None)
+        is_true(isinstance(c.computed, sa.Computed))
+        is_true(isinstance(c.server_default, sa.Computed))
 
     @testing.combinations(
         lambda: (None, sa.Computed("bar*5")),
@@ -85,7 +73,6 @@ class AutogenerateComputedTest(AutogenFixtureTest, TestBase):
         ),
         lambda: (sa.Computed("bar*5"), sa.Computed("bar * 42")),
     )
-    @config.requirements.computed_reflects_normally
     def test_cant_change_computed_warning(self, test_case):
         arg_before, arg_after = testing.resolve_lambda(test_case, **locals())
         m1 = MetaData()
@@ -125,10 +112,6 @@ class AutogenerateComputedTest(AutogenFixtureTest, TestBase):
         lambda: (sa.Computed("5"), sa.Computed("5")),
         lambda: (sa.Computed("bar*5"), sa.Computed("bar*5")),
         lambda: (sa.Computed("bar*5"), sa.Computed("bar * \r\n\t5")),
-        (
-            lambda: (sa.Computed("bar*5"), None),
-            config.requirements.computed_doesnt_reflect_as_server_default,
-        ),
     )
     def test_computed_unchanged(self, test_case):
         arg_before, arg_after = testing.resolve_lambda(test_case, **locals())
@@ -159,46 +142,3 @@ class AutogenerateComputedTest(AutogenFixtureTest, TestBase):
         eq_(mock_warn.mock_calls, [])
 
         eq_(list(diffs), [])
-
-    @config.requirements.computed_reflects_as_server_default
-    def test_remove_computed_default_on_computed(self):
-        """Asserts the current behavior which is that on PG and Oracle,
-        the GENERATED ALWAYS AS is reflected as a server default which we can't
-        tell is actually "computed", so these come out as a modification to
-        the server default.
-
-        """
-        m1 = MetaData()
-        m2 = MetaData()
-
-        Table(
-            "user",
-            m1,
-            Column("id", Integer, primary_key=True),
-            Column("bar", Integer),
-            Column("foo", Integer, sa.Computed("bar + 42")),
-        )
-
-        Table(
-            "user",
-            m2,
-            Column("id", Integer, primary_key=True),
-            Column("bar", Integer),
-            Column("foo", Integer),
-        )
-
-        diffs = self._fixture(m1, m2)
-
-        eq_(diffs[0][0][0], "modify_default")
-        eq_(diffs[0][0][2], "user")
-        eq_(diffs[0][0][3], "foo")
-        old = diffs[0][0][-2]
-        new = diffs[0][0][-1]
-
-        is_(new, None)
-        is_true(isinstance(old, sa.DefaultClause))
-
-        if exclusions.against(config, "postgresql"):
-            eq_(str(old.arg.text), "(bar + 42)")
-        elif exclusions.against(config, "oracle"):
-            eq_(str(old.arg.text), '"BAR"+42')

alembic/testing/warnings.py

@@ -10,8 +10,6 @@ import warnings
 
 from sqlalchemy import exc as sa_exc
 
-from ..util import sqla_14
-
 
 def setup_filters():
     """Set global warning behavior for the test suite."""
@@ -23,13 +21,6 @@ def setup_filters():
 
     # some selected deprecations...
     warnings.filterwarnings("error", category=DeprecationWarning)
-    if not sqla_14:
-        # 1.3 uses pkg_resources in PluginLoader
-        warnings.filterwarnings(
-            "ignore",
-            "pkg_resources is deprecated as an API",
-            DeprecationWarning,
-        )
     try:
         import pytest
     except ImportError:

alembic/util/__init__.py

@@ -25,11 +25,4 @@ from .pyfiles import coerce_resource_to_filename as coerce_resource_to_filename
 from .pyfiles import load_python_file as load_python_file
 from .pyfiles import pyc_file_from_path as pyc_file_from_path
 from .pyfiles import template_to_file as template_to_file
-from .sqla_compat import has_computed as has_computed
-from .sqla_compat import sqla_13 as sqla_13
-from .sqla_compat import sqla_14 as sqla_14
 from .sqla_compat import sqla_2 as sqla_2
-
-
-if not sqla_13:
-    raise CommandError("SQLAlchemy 1.3.0 or greater is required.")

alembic/util/exc.py

@@ -1,6 +1,25 @@
+from __future__ import annotations
+
+from typing import Any
+from typing import List
+from typing import Tuple
+from typing import TYPE_CHECKING
+
+if TYPE_CHECKING:
+    from alembic.autogenerate import RevisionContext
+
+
 class CommandError(Exception):
     pass
 
 
 class AutogenerateDiffsDetected(CommandError):
-    pass
+    def __init__(
+        self,
+        message: str,
+        revision_context: RevisionContext,
+        diffs: List[Tuple[Any, ...]],
+    ) -> None:
+        super().__init__(message)
+        self.revision_context = revision_context
+        self.diffs = diffs

alembic/util/messaging.py

@@ -13,8 +13,6 @@ import warnings
 
 from sqlalchemy.engine import url
 
-from . import sqla_compat
-
 log = logging.getLogger(__name__)
 
 # disable "no handler found" errors
@@ -76,8 +74,7 @@ def err(message: str, quiet: bool = False) -> None:
 
 
 def obfuscate_url_pw(input_url: str) -> str:
-    u = url.make_url(input_url)
-    return sqla_compat.url_render_as_string(u, hide_password=True)  # type: ignore  # noqa: E501
+    return url.make_url(input_url).render_as_string(hide_password=True)
 
 
 def warn(msg: str, stacklevel: int = 2) -> None: