alembic 1.11.0__py3-none-any.whl → 1.11.2__py3-none-any.whl

alembic/ddl/mssql.py

@@ -98,7 +98,6 @@ class MSSQLImpl(DefaultImpl):
         existing_nullable: Optional[bool] = None,
         **kw: Any,
     ) -> None:
-
         if nullable is not None:
             if type_ is not None:
                 # the NULL/NOT NULL alter will handle
@@ -171,7 +170,7 @@ class MSSQLImpl(DefaultImpl):
                 table_name, column_name, schema=schema, name=name
             )
 
-    def create_index(self, index: Index) -> None:
+    def create_index(self, index: Index, **kw: Any) -> None:
         # this likely defaults to None if not present, so get()
         # should normally not return the default value.  being
         # defensive in any case
@@ -180,7 +179,7 @@ class MSSQLImpl(DefaultImpl):
         for col in mssql_include:
             if col not in index.table.c:
                 index.table.append_column(Column(col, sqltypes.NullType))
-        self._exec(CreateIndex(index))
+        self._exec(CreateIndex(index, **kw))
 
     def bulk_insert(  # type:ignore[override]
         self, table: Union[TableClause, Table], rows: List[dict], **kw: Any
@@ -201,7 +200,7 @@ class MSSQLImpl(DefaultImpl):
     def drop_column(
         self,
         table_name: str,
-        column: Column,
+        column: Column[Any],
         schema: Optional[str] = None,
         **kw,
     ) -> None:
@@ -231,9 +230,7 @@ class MSSQLImpl(DefaultImpl):
         rendered_metadata_default,
         rendered_inspector_default,
     ):
-
         if rendered_metadata_default is not None:
-
             rendered_metadata_default = re.sub(
                 r"[\(\) \"\']", "", rendered_metadata_default
             )
@@ -273,7 +270,7 @@ class _ExecDropConstraint(Executable, ClauseElement):
     def __init__(
         self,
         tname: str,
-        colname: Union[Column, str],
+        colname: Union[Column[Any], str],
         type_: str,
         schema: Optional[str],
     ) -> None:
@@ -287,7 +284,7 @@ class _ExecDropFKConstraint(Executable, ClauseElement):
     inherit_cache = False
 
     def __init__(
-        self, tname: str, colname: Column, schema: Optional[str]
+        self, tname: str, colname: Column[Any], schema: Optional[str]
     ) -> None:
         self.tname = tname
         self.colname = colname
@@ -347,7 +344,9 @@ def visit_add_column(element: AddColumn, compiler: MSDDLCompiler, **kw) -> str:
     )
 
 
-def mssql_add_column(compiler: MSDDLCompiler, column: Column, **kw) -> str:
+def mssql_add_column(
+    compiler: MSDDLCompiler, column: Column[Any], **kw
+) -> str:
     return "ADD %s" % compiler.get_column_specification(column, **kw)
 
 

alembic/ddl/mysql.py

@@ -240,7 +240,6 @@ class MySQLImpl(DefaultImpl):
         metadata_unique_constraints,
         metadata_indexes,
     ):
-
         # TODO: if SQLA 1.0, make use of "duplicates_index"
         # metadata
         removed = set()

alembic/ddl/oracle.py

@@ -176,7 +176,7 @@ def alter_column(compiler: OracleDDLCompiler, name: str) -> str:
     return "MODIFY %s" % format_column_name(compiler, name)
 
 
-def add_column(compiler: OracleDDLCompiler, column: Column, **kw) -> str:
+def add_column(compiler: OracleDDLCompiler, column: Column[Any], **kw) -> str:
     return "ADD %s" % compiler.get_column_specification(column, **kw)
 
 

alembic/ddl/postgresql.py

@@ -12,7 +12,6 @@ from typing import TYPE_CHECKING
 from typing import Union
 
 from sqlalchemy import Column
-from sqlalchemy import Index
 from sqlalchemy import literal_column
 from sqlalchemy import Numeric
 from sqlalchemy import text
@@ -50,6 +49,8 @@ from ..util import sqla_compat
 if TYPE_CHECKING:
     from typing import Literal
 
+    from sqlalchemy import Index
+    from sqlalchemy import UniqueConstraint
     from sqlalchemy.dialects.postgresql.array import ARRAY
     from sqlalchemy.dialects.postgresql.base import PGDDLCompiler
     from sqlalchemy.dialects.postgresql.hstore import HSTORE
@@ -79,18 +80,19 @@ class PostgresqlImpl(DefaultImpl):
     )
     identity_attrs_ignore = ("on_null", "order")
 
-    def create_index(self, index):
+    def create_index(self, index: Index, **kw: Any) -> None:
         # this likely defaults to None if not present, so get()
         # should normally not return the default value.  being
         # defensive in any case
         postgresql_include = index.kwargs.get("postgresql_include", None) or ()
         for col in postgresql_include:
-            if col not in index.table.c:
-                index.table.append_column(Column(col, sqltypes.NullType))
-        self._exec(CreateIndex(index))
+            if col not in index.table.c:  # type: ignore[union-attr]
+                index.table.append_column(  # type: ignore[union-attr]
+                    Column(col, sqltypes.NullType)
+                )
+        self._exec(CreateIndex(index, **kw))
 
     def prep_table_for_batch(self, batch_impl, table):
-
         for constraint in table.constraints:
             if (
                 constraint.name is not None
@@ -157,7 +159,6 @@ class PostgresqlImpl(DefaultImpl):
         existing_autoincrement: Optional[bool] = None,
         **kw: Any,
     ) -> None:
-
         using = kw.pop("postgresql_using", None)
 
         if using is not None and type_ is None:
@@ -239,7 +240,6 @@ class PostgresqlImpl(DefaultImpl):
         metadata_unique_constraints,
         metadata_indexes,
     ):
-
         doubled_constraints = {
             index
             for index in conn_indexes
@@ -308,6 +308,21 @@ class PostgresqlImpl(DefaultImpl):
                 break
         return to_remove
 
+    def _dialect_sig(
+        self, item: Union[Index, UniqueConstraint]
+    ) -> Tuple[Any, ...]:
+        if (
+            item.dialect_kwargs.get("postgresql_nulls_not_distinct")
+            is not None
+        ):
+            return (
+                (
+                    "nulls_not_distinct",
+                    item.dialect_kwargs["postgresql_nulls_not_distinct"],
+                ),
+            )
+        return ()
+
     def create_index_sig(self, index: Index) -> Tuple[Any, ...]:
         return tuple(
             self._cleanup_index_expr(
@@ -319,7 +334,14 @@ class PostgresqlImpl(DefaultImpl):
                 ),
             )
             for e in index.expressions
-        )
+        ) + self._dialect_sig(index)
+
+    def create_unique_constraint_sig(
+        self, const: UniqueConstraint
+    ) -> Tuple[Any, ...]:
+        return tuple(
+            sorted([col.name for col in const.columns])
+        ) + self._dialect_sig(const)
 
     def _compile_element(self, element: ClauseElement) -> str:
         return element.compile(
@@ -486,7 +508,7 @@ class CreateExcludeConstraintOp(ops.AddConstraintOp):
         table_name: Union[str, quoted_name],
         elements: Union[
             Sequence[Tuple[str, str]],
-            Sequence[Tuple[ColumnClause, str]],
+            Sequence[Tuple[ColumnClause[Any], str]],
         ],
         where: Optional[Union[BinaryExpression, str]] = None,
         schema: Optional[str] = None,
@@ -638,7 +660,6 @@ def _render_inline_exclude_constraint(
 
 
 def _postgresql_autogenerate_prefix(autogen_context: AutogenContext) -> str:
-
     imports = autogen_context.imports
     if imports is not None:
         imports.add("from sqlalchemy.dialects import postgresql")
@@ -706,7 +727,9 @@ def _exclude_constraint(
 
 
 def _render_potential_column(
-    value: Union[ColumnClause, Column, TextClause, FunctionElement],
+    value: Union[
+        ColumnClause[Any], Column[Any], TextClause, FunctionElement[Any]
+    ],
     autogen_context: AutogenContext,
 ) -> str:
     if isinstance(value, ColumnClause):

alembic/ddl/sqlite.py

@@ -95,12 +95,11 @@ class SQLiteImpl(DefaultImpl):
 
     def compare_server_default(
         self,
-        inspector_column: Column,
-        metadata_column: Column,
+        inspector_column: Column[Any],
+        metadata_column: Column[Any],
         rendered_metadata_default: Optional[str],
         rendered_inspector_default: Optional[str],
     ) -> bool:
-
         if rendered_metadata_default is not None:
             rendered_metadata_default = re.sub(
                 r"^\((.+)\)$", r"\1", rendered_metadata_default
@@ -173,7 +172,7 @@ class SQLiteImpl(DefaultImpl):
 
     def cast_for_batch_migrate(
         self,
-        existing: Column,
+        existing: Column[Any],
         existing_transfer: Dict[str, Union[TypeEngine, Cast]],
         new_type: TypeEngine,
     ) -> None:
@@ -193,7 +192,6 @@ class SQLiteImpl(DefaultImpl):
         metadata_unique_constraints,
         metadata_indexes,
     ):
-
         self._skip_functional_indexes(metadata_indexes, conn_indexes)
 
 

alembic/op.pyi

@@ -45,7 +45,7 @@ _T = TypeVar("_T")
 ### end imports ###
 
 def add_column(
-    table_name: str, column: Column, *, schema: Optional[str] = None
+    table_name: str, column: Column[Any], *, schema: Optional[str] = None
 ) -> None:
     """Issue an "add column" instruction using the current
     migration context.
@@ -646,6 +646,7 @@ def create_index(
     *,
     schema: Optional[str] = None,
     unique: bool = False,
+    if_not_exists: Optional[bool] = None,
     **kw: Any,
 ) -> None:
     r"""Issue a "create index" instruction using the current
@@ -675,20 +676,24 @@ def create_index(
      :class:`~sqlalchemy.sql.elements.quoted_name`.
     :param unique: If True, create a unique index.
 
-    :param quote:
-        Force quoting of this column's name on or off, corresponding
-        to ``True`` or ``False``. When left at its default
-        of ``None``, the column identifier will be quoted according to
-        whether the name is case sensitive (identifiers with at least one
-        upper case character are treated as case sensitive), or if it's a
-        reserved word. This flag is only needed to force quoting of a
-        reserved word which is not known by the SQLAlchemy dialect.
+    :param quote: Force quoting of this column's name on or off,
+     corresponding to ``True`` or ``False``. When left at its default
+     of ``None``, the column identifier will be quoted according to
+     whether the name is case sensitive (identifiers with at least one
+     upper case character are treated as case sensitive), or if it's a
+     reserved word. This flag is only needed to force quoting of a
+     reserved word which is not known by the SQLAlchemy dialect.
+
+    :param if_not_exists: If True, adds IF NOT EXISTS operator when
+     creating the new index.
+
+     .. versionadded:: 1.12.0
 
     :param \**kw: Additional keyword arguments not mentioned above are
-        dialect specific, and passed in the form
-        ``<dialectname>_<argname>``.
-        See the documentation regarding an individual dialect at
-        :ref:`dialect_toplevel` for detail on documented arguments.
+     dialect specific, and passed in the form
+     ``<dialectname>_<argname>``.
+     See the documentation regarding an individual dialect at
+     :ref:`dialect_toplevel` for detail on documented arguments.
 
     """
 
@@ -933,8 +938,8 @@ def drop_column(
 def drop_constraint(
     constraint_name: str,
     table_name: str,
-    *,
     type_: Optional[str] = None,
+    *,
     schema: Optional[str] = None,
 ) -> None:
     r"""Drop a constraint of the given name, typically via DROP CONSTRAINT.
@@ -952,9 +957,10 @@ def drop_constraint(
 
 def drop_index(
     index_name: str,
-    *,
     table_name: Optional[str] = None,
+    *,
     schema: Optional[str] = None,
+    if_exists: Optional[bool] = None,
     **kw: Any,
 ) -> None:
     r"""Issue a "drop index" instruction using the current
@@ -971,11 +977,17 @@ def drop_index(
      quoting of the schema outside of the default behavior, use
      the SQLAlchemy construct
      :class:`~sqlalchemy.sql.elements.quoted_name`.
+
+    :param if_exists: If True, adds IF EXISTS operator when
+     dropping the index.
+
+     .. versionadded:: 1.12.0
+
     :param \**kw: Additional keyword arguments not mentioned above are
-        dialect specific, and passed in the form
-        ``<dialectname>_<argname>``.
-        See the documentation regarding an individual dialect at
-        :ref:`dialect_toplevel` for detail on documented arguments.
+     dialect specific, and passed in the form
+     ``<dialectname>_<argname>``.
+     See the documentation regarding an individual dialect at
+     :ref:`dialect_toplevel` for detail on documented arguments.
 
     """
 
@@ -1228,7 +1240,7 @@ def invoke(operation: MigrateOperation) -> Any:
 
 def register_operation(
     name: str, sourcename: Optional[str] = None
-) -> Callable[..., Any]:
+) -> Callable[[_T], _T]:
     """Register a new operation for this class.
 
     This method is normally used to add new operations

alembic/operations/base.py

@@ -86,7 +86,7 @@ class AbstractOperations(util.ModuleClsProxy):
     @classmethod
     def register_operation(
         cls, name: str, sourcename: Optional[str] = None
-    ) -> Callable[..., Any]:
+    ) -> Callable[[_T], _T]:
         """Register a new operation for this class.
 
         This method is normally used to add new operations
@@ -569,7 +569,7 @@ class Operations(AbstractOperations):
         def add_column(
             self,
             table_name: str,
-            column: Column,
+            column: Column[Any],
             *,
             schema: Optional[str] = None,
         ) -> None:
@@ -1035,6 +1035,7 @@ class Operations(AbstractOperations):
             *,
             schema: Optional[str] = None,
             unique: bool = False,
+            if_not_exists: Optional[bool] = None,
             **kw: Any,
         ) -> None:
             r"""Issue a "create index" instruction using the current
@@ -1064,20 +1065,24 @@ class Operations(AbstractOperations):
              :class:`~sqlalchemy.sql.elements.quoted_name`.
             :param unique: If True, create a unique index.
 
-            :param quote:
-                Force quoting of this column's name on or off, corresponding
-                to ``True`` or ``False``. When left at its default
-                of ``None``, the column identifier will be quoted according to
-                whether the name is case sensitive (identifiers with at least one
-                upper case character are treated as case sensitive), or if it's a
-                reserved word. This flag is only needed to force quoting of a
-                reserved word which is not known by the SQLAlchemy dialect.
+            :param quote: Force quoting of this column's name on or off,
+             corresponding to ``True`` or ``False``. When left at its default
+             of ``None``, the column identifier will be quoted according to
+             whether the name is case sensitive (identifiers with at least one
+             upper case character are treated as case sensitive), or if it's a
+             reserved word. This flag is only needed to force quoting of a
+             reserved word which is not known by the SQLAlchemy dialect.
+
+            :param if_not_exists: If True, adds IF NOT EXISTS operator when
+             creating the new index.
+
+             .. versionadded:: 1.12.0
 
             :param \**kw: Additional keyword arguments not mentioned above are
-                dialect specific, and passed in the form
-                ``<dialectname>_<argname>``.
-                See the documentation regarding an individual dialect at
-                :ref:`dialect_toplevel` for detail on documented arguments.
+             dialect specific, and passed in the form
+             ``<dialectname>_<argname>``.
+             See the documentation regarding an individual dialect at
+             :ref:`dialect_toplevel` for detail on documented arguments.
 
             """  # noqa: E501
             ...
@@ -1335,8 +1340,8 @@ class Operations(AbstractOperations):
             self,
             constraint_name: str,
             table_name: str,
-            *,
             type_: Optional[str] = None,
+            *,
             schema: Optional[str] = None,
         ) -> None:
             r"""Drop a constraint of the given name, typically via DROP CONSTRAINT.
@@ -1356,9 +1361,10 @@ class Operations(AbstractOperations):
         def drop_index(
             self,
             index_name: str,
-            *,
             table_name: Optional[str] = None,
+            *,
             schema: Optional[str] = None,
+            if_exists: Optional[bool] = None,
             **kw: Any,
         ) -> None:
             r"""Issue a "drop index" instruction using the current
@@ -1375,11 +1381,17 @@ class Operations(AbstractOperations):
              quoting of the schema outside of the default behavior, use
              the SQLAlchemy construct
              :class:`~sqlalchemy.sql.elements.quoted_name`.
+
+            :param if_exists: If True, adds IF EXISTS operator when
+             dropping the index.
+
+             .. versionadded:: 1.12.0
+
             :param \**kw: Additional keyword arguments not mentioned above are
-                dialect specific, and passed in the form
-                ``<dialectname>_<argname>``.
-                See the documentation regarding an individual dialect at
-                :ref:`dialect_toplevel` for detail on documented arguments.
+             dialect specific, and passed in the form
+             ``<dialectname>_<argname>``.
+             See the documentation regarding an individual dialect at
+             :ref:`dialect_toplevel` for detail on documented arguments.
 
             """  # noqa: E501
             ...
@@ -1574,7 +1586,7 @@ class BatchOperations(AbstractOperations):
 
         def add_column(
             self,
-            column: Column,
+            column: Column[Any],
             *,
             insert_before: Optional[str] = None,
             insert_after: Optional[str] = None,
@@ -1787,7 +1799,7 @@ class BatchOperations(AbstractOperations):
             ...
 
         def drop_constraint(
-            self, constraint_name: str, *, type_: Optional[str] = None
+            self, constraint_name: str, type_: Optional[str] = None
         ) -> None:
             """Issue a "drop constraint" instruction using the
             current batch migration context.

alembic/operations/batch.py

@@ -185,11 +185,11 @@ class BatchOperationsImpl:
     def rename_table(self, *arg, **kw):
         self.batch.append(("rename_table", arg, kw))
 
-    def create_index(self, idx: Index) -> None:
-        self.batch.append(("create_index", (idx,), {}))
+    def create_index(self, idx: Index, **kw: Any) -> None:
+        self.batch.append(("create_index", (idx,), kw))
 
-    def drop_index(self, idx: Index) -> None:
-        self.batch.append(("drop_index", (idx,), {}))
+    def drop_index(self, idx: Index, **kw: Any) -> None:
+        self.batch.append(("drop_index", (idx,), kw))
 
     def create_table_comment(self, table):
         self.batch.append(("create_table_comment", (table,), {}))
@@ -243,7 +243,7 @@ class ApplyBatchImpl:
 
     def _grab_table_elements(self) -> None:
         schema = self.table.schema
-        self.columns: Dict[str, Column] = OrderedDict()
+        self.columns: Dict[str, Column[Any]] = OrderedDict()
         for c in self.table.c:
             c_copy = _copy(c, schema=schema)
             c_copy.unique = c_copy.index = False
@@ -337,7 +337,6 @@ class ApplyBatchImpl:
         for const in (
             list(self.named_constraints.values()) + self.unnamed_constraints
         ):
-
             const_columns = {c.key for c in _columns_for_constraint(const)}
 
             if not const_columns.issubset(self.column_transfers):
@@ -607,7 +606,7 @@ class ApplyBatchImpl:
     def add_column(
         self,
         table_name: str,
-        column: Column,
+        column: Column[Any],
         insert_before: Optional[str] = None,
         insert_after: Optional[str] = None,
         **kw,
@@ -621,7 +620,10 @@ class ApplyBatchImpl:
         self.column_transfers[column.name] = {}
 
     def drop_column(
-        self, table_name: str, column: Union[ColumnClause, Column], **kw
+        self,
+        table_name: str,
+        column: Union[ColumnClause[Any], Column[Any]],
+        **kw,
     ) -> None:
         if column.name in self.table.primary_key.columns:
             _remove_column_from_collection(