alembic 1.16.0__tar.gz → 1.16.2__tar.gz

{alembic-1.16.0/alembic.egg-info → alembic-1.16.2}/PKG-INFO

@@ -1,6 +1,6 @@
 Metadata-Version: 2.4
 Name: alembic
-Version: 1.16.0
+Version: 1.16.2
 Summary: A database migration tool for SQLAlchemy.
 Author-email: Mike Bayer <mike_mp@zzzcomputing.com>
 License-Expression: MIT

{alembic-1.16.0 → alembic-1.16.2}/alembic/__init__.py

@@ -1,4 +1,4 @@
 from . import context
 from . import op
 
-__version__ = "1.16.0"
+__version__ = "1.16.2"

{alembic-1.16.0 → alembic-1.16.2}/alembic/autogenerate/compare.py

@@ -683,7 +683,7 @@ def _compare_indexes_and_uniques(
             ):
                 modify_ops.ops.append(ops.CreateIndexOp.from_index(obj.const))
                 log.info(
-                    "Detected added index '%r' on '%s'",
+                    "Detected added index %r on '%s'",
                     obj.name,
                     obj.column_names,
                 )
@@ -1282,7 +1282,7 @@ def _compare_foreign_keys(
             obj.const, obj.name, "foreign_key_constraint", False, compare_to
         ):
             modify_table_ops.ops.append(
-                ops.CreateForeignKeyOp.from_constraint(const.const)  # type: ignore[has-type]  # noqa: E501
+                ops.CreateForeignKeyOp.from_constraint(const.const)
             )
 
             log.info(

{alembic-1.16.0 → alembic-1.16.2}/alembic/autogenerate/render.py

@@ -18,6 +18,7 @@ from mako.pygen import PythonPrinter
 from sqlalchemy import schema as sa_schema
 from sqlalchemy import sql
 from sqlalchemy import types as sqltypes
+from sqlalchemy.sql.base import _DialectArgView
 from sqlalchemy.sql.elements import conv
 from sqlalchemy.sql.elements import Label
 from sqlalchemy.sql.elements import quoted_name
@@ -31,7 +32,6 @@ if TYPE_CHECKING:
 
     from sqlalchemy import Computed
     from sqlalchemy import Identity
-    from sqlalchemy.sql.base import DialectKWArgs
     from sqlalchemy.sql.elements import ColumnElement
     from sqlalchemy.sql.elements import TextClause
     from sqlalchemy.sql.schema import CheckConstraint
@@ -304,11 +304,11 @@ def _drop_table(autogen_context: AutogenContext, op: ops.DropTableOp) -> str:
 
 
 def _render_dialect_kwargs_items(
-    autogen_context: AutogenContext, item: DialectKWArgs
+    autogen_context: AutogenContext, dialect_kwargs: _DialectArgView
 ) -> list[str]:
     return [
         f"{key}={_render_potential_expr(val, autogen_context)}"
-        for key, val in item.dialect_kwargs.items()
+        for key, val in dialect_kwargs.items()
     ]
 
 
@@ -331,7 +331,7 @@ def _add_index(autogen_context: AutogenContext, op: ops.CreateIndexOp) -> str:
 
     assert index.table is not None
 
-    opts = _render_dialect_kwargs_items(autogen_context, index)
+    opts = _render_dialect_kwargs_items(autogen_context, index.dialect_kwargs)
     if op.if_not_exists is not None:
         opts.append("if_not_exists=%r" % bool(op.if_not_exists))
     text = tmpl % {
@@ -365,7 +365,7 @@ def _drop_index(autogen_context: AutogenContext, op: ops.DropIndexOp) -> str:
             "%(prefix)sdrop_index(%(name)r, "
             "table_name=%(table_name)r%(schema)s%(kwargs)s)"
         )
-    opts = _render_dialect_kwargs_items(autogen_context, index)
+    opts = _render_dialect_kwargs_items(autogen_context, index.dialect_kwargs)
     if op.if_exists is not None:
         opts.append("if_exists=%r" % bool(op.if_exists))
     text = tmpl % {
@@ -389,6 +389,7 @@ def _add_unique_constraint(
 def _add_fk_constraint(
     autogen_context: AutogenContext, op: ops.CreateForeignKeyOp
 ) -> str:
+    constraint = op.to_constraint()
     args = [repr(_render_gen_name(autogen_context, op.constraint_name))]
     if not autogen_context._has_batch:
         args.append(repr(_ident(op.source_table)))
@@ -418,9 +419,16 @@ def _add_fk_constraint(
             if value is not None:
                 args.append("%s=%r" % (k, value))
 
-    return "%(prefix)screate_foreign_key(%(args)s)" % {
+    dialect_kwargs = _render_dialect_kwargs_items(
+        autogen_context, constraint.dialect_kwargs
+    )
+
+    return "%(prefix)screate_foreign_key(%(args)s%(dialect_kwargs)s)" % {
         "prefix": _alembic_autogenerate_prefix(autogen_context),
         "args": ", ".join(args),
+        "dialect_kwargs": (
+            ", " + ", ".join(dialect_kwargs) if dialect_kwargs else ""
+        ),
     }
 
 
@@ -664,7 +672,9 @@ def _uq_constraint(
         opts.append(
             ("name", _render_gen_name(autogen_context, constraint.name))
         )
-    dialect_options = _render_dialect_kwargs_items(autogen_context, constraint)
+    dialect_options = _render_dialect_kwargs_items(
+        autogen_context, constraint.dialect_kwargs
+    )
 
     if alter:
         args = [repr(_render_gen_name(autogen_context, constraint.name))]

{alembic-1.16.0 → alembic-1.16.2}/alembic/autogenerate/rewriter.py

@@ -177,7 +177,7 @@ class Rewriter:
                 )
             upgrade_ops_list.append(ret[0])
 
-        directive.upgrade_ops = upgrade_ops_list  # type: ignore
+        directive.upgrade_ops = upgrade_ops_list
 
         downgrade_ops_list: List[DowngradeOps] = []
         for downgrade_ops in directive.downgrade_ops_list:
@@ -187,7 +187,7 @@ class Rewriter:
                     "Can only return single object for DowngradeOps traverse"
                 )
             downgrade_ops_list.append(ret[0])
-        directive.downgrade_ops = downgrade_ops_list  # type: ignore
+        directive.downgrade_ops = downgrade_ops_list
 
     @_traverse.dispatch_for(ops.OpContainer)
     def _traverse_op_container(

{alembic-1.16.0 → alembic-1.16.2}/alembic/command.py

@@ -68,7 +68,7 @@ def init(
     template_path = config._get_template_path() / template
 
     if not template_path.exists():
-        raise util.CommandError("No such template {template_path}")
+        raise util.CommandError(f"No such template {template_path}")
 
     # left as os.access() to suit unit test mocking
     if not os.access(directory_path, os.F_OK):

{alembic-1.16.0 → alembic-1.16.2}/alembic/config.py

@@ -75,7 +75,20 @@ class Config:
             alembic_cfg.attributes['connection'] = connection
             command.upgrade(alembic_cfg, "head")
 
-    :param file\_: name of the .ini file to open.
+    :param file\_: name of the .ini file to open if an ``alembic.ini`` is
+     to be used.    This should refer to the ``alembic.ini`` file, either as
+     a filename or a full path to the file.  This filename if passed must refer
+     to an **ini file in ConfigParser format** only.
+
+    :param toml\_file: name of the pyproject.toml file to open if a
+     ``pyproject.toml`` file is to be used.  This should refer to the
+     ``pyproject.toml`` file, either as a filename or a full path to the file.
+     This file must be in toml format. Both :paramref:`.Config.file\_` and
+     :paramref:`.Config.toml\_file` may be passed simultaneously, or
+     exclusively.
+
+     .. versionadded:: 1.16.0
+
     :param ini_section: name of the main Alembic section within the
      .ini file
     :param output_buffer: optional file-like input buffer which
@@ -264,7 +277,10 @@ class Config:
         commands.
 
         """
-        return self._get_template_path().as_posix()
+        import alembic
+
+        package_dir = Path(alembic.__file__).absolute().parent
+        return str(package_dir / "templates")
 
     def _get_template_path(self) -> Path:
         """Return the directory where Alembic setup templates are found.
@@ -275,10 +291,7 @@ class Config:
         .. versionadded:: 1.16.0
 
         """
-        import alembic
-
-        package_dir = Path(alembic.__file__).absolute().parent
-        return package_dir / "templates"
+        return Path(self.get_template_directory())
 
     @overload
     def get_section(

{alembic-1.16.0 → alembic-1.16.2}/alembic/runtime/environment.py

@@ -338,7 +338,7 @@ class EnvironmentContext(util.ModuleClsProxy):
             line.
 
         """
-        return self.context_opts.get("tag", None)  # type: ignore[no-any-return]  # noqa: E501
+        return self.context_opts.get("tag", None)
 
     @overload
     def get_x_argument(self, as_dictionary: Literal[False]) -> List[str]: ...

{alembic-1.16.0 → alembic-1.16.2}/alembic/runtime/migration.py

@@ -175,7 +175,11 @@ class MigrationContext:
                 opts["output_encoding"],
             )
         else:
-            self.output_buffer = opts.get("output_buffer", sys.stdout)
+            self.output_buffer = opts.get(
+                "output_buffer", sys.stdout
+            )  # type:ignore[assignment]  # noqa: E501
+
+        self.transactional_ddl = transactional_ddl
 
         self._user_compare_type = opts.get("compare_type", True)
         self._user_compare_server_default = opts.get(

{alembic-1.16.0 → alembic-1.16.2}/alembic/script/base.py

@@ -560,7 +560,11 @@ class ScriptDirectory:
             **self.messaging_opts,
         ):
             util.template_to_file(
-                src, dest, self.output_encoding, append=True, **kw
+                src,
+                dest,
+                self.output_encoding,
+                append_with_newlines=True,
+                **kw,
             )
 
     def _generate_template(self, src: Path, dest: Path, **kw: Any) -> None:
@@ -846,7 +850,7 @@ class Script(revision.Revision):
                 doc = doc.decode(  # type: ignore[attr-defined]
                     self.module._alembic_source_encoding
                 )
-            return doc.strip()  # type: ignore[union-attr]
+            return doc.strip()
         else:
             return ""
 

{alembic-1.16.0 → alembic-1.16.2}/alembic/templates/async/script.py.mako

@@ -13,7 +13,7 @@ ${imports if imports else ""}
 
 # revision identifiers, used by Alembic.
 revision: str = ${repr(up_revision)}
-down_revision: Union[str, None] = ${repr(down_revision)}
+down_revision: Union[str, Sequence[str], None] = ${repr(down_revision)}
 branch_labels: Union[str, Sequence[str], None] = ${repr(branch_labels)}
 depends_on: Union[str, Sequence[str], None] = ${repr(depends_on)}
 

{alembic-1.16.0 → alembic-1.16.2}/alembic/templates/generic/script.py.mako

@@ -13,7 +13,7 @@ ${imports if imports else ""}
 
 # revision identifiers, used by Alembic.
 revision: str = ${repr(up_revision)}
-down_revision: Union[str, None] = ${repr(down_revision)}
+down_revision: Union[str, Sequence[str], None] = ${repr(down_revision)}
 branch_labels: Union[str, Sequence[str], None] = ${repr(branch_labels)}
 depends_on: Union[str, Sequence[str], None] = ${repr(depends_on)}
 

{alembic-1.16.0 → alembic-1.16.2}/alembic/templates/multidb/script.py.mako

@@ -16,7 +16,7 @@ ${imports if imports else ""}
 
 # revision identifiers, used by Alembic.
 revision: str = ${repr(up_revision)}
-down_revision: Union[str, None] = ${repr(down_revision)}
+down_revision: Union[str, Sequence[str], None] = ${repr(down_revision)}
 branch_labels: Union[str, Sequence[str], None] = ${repr(branch_labels)}
 depends_on: Union[str, Sequence[str], None] = ${repr(depends_on)}
 

{alembic-1.16.0 → alembic-1.16.2}/alembic/templates/pyproject/script.py.mako

@@ -13,7 +13,7 @@ ${imports if imports else ""}
 
 # revision identifiers, used by Alembic.
 revision: str = ${repr(up_revision)}
-down_revision: Union[str, None] = ${repr(down_revision)}
+down_revision: Union[str, Sequence[str], None] = ${repr(down_revision)}
 branch_labels: Union[str, Sequence[str], None] = ${repr(branch_labels)}
 depends_on: Union[str, Sequence[str], None] = ${repr(depends_on)}
 

{alembic-1.16.0 → alembic-1.16.2}/alembic/util/pyfiles.py

@@ -26,7 +26,7 @@ def template_to_file(
     dest: Union[str, os.PathLike[str]],
     output_encoding: str,
     *,
-    append: bool = False,
+    append_with_newlines: bool = False,
     **kw: Any,
 ) -> None:
     template = Template(filename=_preserving_path_as_str(template_file))
@@ -45,7 +45,9 @@ def template_to_file(
             "template-oriented traceback." % fname
         )
     else:
-        with open(dest, "ab" if append else "wb") as f:
+        with open(dest, "ab" if append_with_newlines else "wb") as f:
+            if append_with_newlines:
+                f.write("\n\n".encode(output_encoding))
             f.write(output)
 
 

{alembic-1.16.0 → alembic-1.16.2/alembic.egg-info}/PKG-INFO

@@ -1,6 +1,6 @@
 Metadata-Version: 2.4
 Name: alembic
-Version: 1.16.0
+Version: 1.16.2
 Summary: A database migration tool for SQLAlchemy.
 Author-email: Mike Bayer <mike_mp@zzzcomputing.com>
 License-Expression: MIT

{alembic-1.16.0 → alembic-1.16.2}/docs/_sources/changelog.rst

@@ -3,6 +3,51 @@
 Changelog
 ==========
 
+.. changelog::
+    :version: 1.16.2
+    :released: June 16, 2025
+
+    .. change::
+        :tags: bug, autogenerate
+        :tickets: 1671
+
+        Fixed issue where dialect-specific keyword arguments in ``dialect_kwargs``
+        were not rendered when rendering the :meth:`.Operations.create_foreign_key`
+        operation.   This prevented dialect-specific keywords from being rendered
+        using custom :class:`.Rewriter` recipes that modify
+        :class:`.ops.CreateForeignKeyOp`, similar to other issues such as
+        :ticket:`1635`.  Pull request courtesy Justin Malin.
+
+    .. change::
+        :tags: bug, command
+        :tickets: 1679
+
+        Fixed rendering of ``pyproject.toml`` to include two newlines when
+        appending content to an existing file.  Pull request courtesy Jonathan
+        Vanasco.
+
+
+.. changelog::
+    :version: 1.16.1
+    :released: May 21, 2025
+
+    .. change::
+        :tags: bug, command
+        :tickets: 1660
+
+        Fixed regression caused by the ``pathlib`` refactoring that removed the use
+        of :meth:`.Config.get_template_directory` as the canonical source of
+        templates; the method is still present however it no longer would be
+        consulted for a custom config subclass, as was the case with flask-migrate.
+
+    .. change::
+        :tags: bug, command
+        :tickets: 1659
+
+        Fixed regression caused by the ``pathlib`` refactoring where the "missing
+        template" error message failed to render the name of the template that
+        could not be found.
+
 .. changelog::
     :version: 1.16.0
     :released: May 21, 2025

{alembic-1.16.0/docs/build → alembic-1.16.2/docs/_sources}/tutorial.rst

@@ -141,7 +141,7 @@ indicate an alternative location, the ``--config`` option may be used, or the
     The file generated with the ``generic`` configuration template contains all directives
     for both source code configuration as well as database configuration.  When using
     the ``pyproject`` template, the source code configuration elements will instead
-    be in a separate ``pyproject.toml`` file, described in the :ref:`next section <using_pep_621>`.
+    be in a separate ``pyproject.toml`` file, described in the section :ref:`using_pep_621`.
 
 The all-in-one .ini file created by ``generic`` is illustrated below::
 
@@ -232,6 +232,8 @@ The all-in-one .ini file created by ``generic`` is illustrated below::
     # database URL.  This is consumed by the user-maintained env.py script only.
     # other means of configuring database URLs may be customized within the env.py
     # file.
+    # See notes in "escaping characters in ini files" for guidelines on
+    # passwords
     sqlalchemy.url = driver://user:pass@localhost/dbname
 
     # [post_write_hooks]
@@ -295,6 +297,13 @@ provided as a substitution which is populated with the absolute path to the
 ``alembic.ini`` file itself.  This can be used to produce correct pathnames
 to directories and files relative to where the config file is located.
 
+.. tip:: Percent signs in ``alembic.ini`` configuration variables that are
+   not part of an interpolation token like ``%(here)s``, including percent
+   signs that are part of the SQLAlchemy database URL for its own URL-escaping
+   requirements, must themselves be escaped.
+   See the section :ref:`escaping_percent_signs` for more information.
+
+
 This file contains the following features:
 
 * ``[alembic]`` - this is the section read by Alembic to determine configuration.  Alembic's
@@ -416,6 +425,141 @@ the SQLAlchemy URL is all that's needed::
 
     sqlalchemy.url = postgresql://scott:tiger@localhost/test
 
+.. _escaping_percent_signs:
+
+Escaping Characters in ini files
+--------------------------------
+
+As mentioned previously, Alembic's .ini file format uses Python `ConfigParser
+<https://docs.python.org/3/library/configparser.html#configparser.ConfigParser>`_
+to parse the file.   ``ConfigParser`` 's `interpolation feature is enabled
+<https://docs.python.org/3/library/configparser.html#interpolation-of-values>`_
+in this operation to support the use of the ``%(here)s`` token, as well as any
+other tokens that are user-configurable via the :paramref:`.Config.config_args`
+parameter when creating a custom :class:`.Config` object.
+
+This means that any literal string that includes a percent sign that is not
+part of an interpolated variable must be escaped by doubling it.  That is, for
+a configuration value like this in a Python script::
+
+  my_configuration_value = "some % string"
+
+To be parsed from the .ini file would need to be placed as::
+
+  [alembic]
+
+  my_configuration_value = some %% string
+
+This escaping can be seen in the sample ``alembic.ini`` file, illustrated in
+such values as ``file_template``::
+
+    # template used to generate migration file names; The default value is %%(rev)s_%%(slug)s
+    file_template = %%(year)d_%%(month).2d_%%(day).2d_%%(hour).2d%%(minute).2d-%%(rev)s_%%(slug)s
+
+Where above, the actual ``file_template`` that is sent to Alembic's file generation system
+would be ``%(year)d_%(month).2d_%(day).2d_%(hour).2d%(minute).2d-%(rev)s_%(slug)s``.
+
+.. tip::  Alembic also employs percent-sign interpolation of values when retrieving
+   values from a ``pyproject.toml`` file, as documented at :ref:`using_pep_621`.
+   So the same percent-doubling steps must be applied in Alembic-parsed values,
+   for fields such as ``file_template``.
+
+For the SQLAlchemy URL, percent signs are used to escape syntactically-
+significant characters such as the ``@`` sign as well as the percent sign
+itself.  For a password such as ``"P@ssw%rd"``::
+
+  >>> my_actual_password = "P@ssw%rd"
+
+As `documented by SQLAlchemy <https://docs.sqlalchemy.org/core/engines.html#escaping-special-characters-such-as-signs-in-passwords>`_,
+the ``@`` sign as well as the percent sign when placed into a URL should be escaped with ``urllib.parse.quote_plus``::
+
+  >>> import urllib.parse
+  >>> sqlalchemy_quoted_password = urllib.parse.quote_plus(my_actual_password)
+  >>> sqlalchemy_quoted_password
+  'P%40ssw%25rd'
+
+This URL quoting can also be seen in SQLAlchemy's own stringification of
+URLs::
+
+  >>> from sqlalchemy import URL
+  >>> URL.create(
+  ...   "some_db", username="scott", password=my_actual_password, host="host"
+  ... ).render_as_string(hide_password=False)
+  'some_db://scott:P%40ssw%25rd@host'
+
+For the above escaped password string ``'P%40ssw%rd'`` to be placed into a ``ConfigParser`` file that
+includes interpolation of percent signs, ``%`` characters are doubled::
+
+  >>> sqlalchemy_quoted_password.replace("%", "%%")
+  'P%%40ssw%%25rd'
+
+Here's a complete program that will compose a URL and show the correct configparser form
+for a given set of database connection details, as well as illustrate how to assert these
+forms for correctness::
+
+    from sqlalchemy import URL, make_url
+
+    database_driver = input("database driver? ")
+    username = input("username? ")
+    password = input("password? ")
+    host = input("host? ")
+    port = input("port? ")
+    database = input("database? ")
+
+    sqlalchemy_url = URL.create(
+        drivername=database_driver,
+        username=username,
+        password=password,
+        host=host,
+        port=int(port),
+        database=database,
+    )
+
+    stringified_sqlalchemy_url = sqlalchemy_url.render_as_string(
+        hide_password=False
+    )
+
+    # assert make_url round trip
+    assert make_url(stringified_sqlalchemy_url) == sqlalchemy_url
+
+    print(
+        f"The correctly escaped string that can be passed "
+        f"to SQLAlchemy make_url() and create_engine() is:"
+        f"\n\n     {stringified_sqlalchemy_url!r}\n"
+    )
+
+    percent_replaced_url = stringified_sqlalchemy_url.replace("%", "%%")
+
+    # assert percent-interpolated plus make_url round trip
+    assert make_url(percent_replaced_url % {}) == sqlalchemy_url
+
+    print(
+        f"The SQLAlchemy URL that can be placed in a ConfigParser "
+        f"file such as alembic.ini is:\n\n      "
+        f"sqlalchemy.url = {percent_replaced_url}\n"
+    )
+
+The above program should eliminate any ambiguity when placing a SQLAlchemy
+URL into a configparser file::
+
+    $ python alembic_pw_script.py
+    database driver? postgresql+psycopg2
+    username? scott
+    password? P@ssw%rd
+    host? localhost
+    port? 5432
+    database? testdb
+    The correctly escaped string that can be passed to SQLAlchemy make_url() and create_engine() is:
+
+        'postgresql+psycopg2://scott:P%40ssw%25rd@localhost:5432/testdb'
+
+    The SQLAlchemy URL that can be placed in a ConfigParser file such as alembic.ini is:
+
+          sqlalchemy.url = postgresql+psycopg2://scott:P%%40ssw%%25rd@localhost:5432/testdb
+
+
+
+
 .. _using_pep_621:
 
 Using pyproject.toml for configuration
@@ -539,6 +683,12 @@ remains available as the absolute path to the ``pyproject.toml`` file::
     # executable = "%(here)s/.venv/bin/ruff"
     # options = "check --fix REVISION_SCRIPT_FILENAME"
 
+.. tip:: As Alembic adds support for interpolation tokens like ``%(here)s`` to
+   its handling of ``pyproject.toml`` values, the same percent-sign escaping
+   steps that apply to ``alembic.ini`` configuration variables also apply
+   to ``pyproject.toml``, even though database URLs are not configured in this
+   file.  This escaping can be seen in the sample ``file_template`` value
+   above.   See the section :ref:`escaping_percent_signs` for background.
 
 The ``alembic.ini`` file for this template is truncated and contains
 only database configuration and logging configuration::

{alembic-1.16.0 → alembic-1.16.2}/docs/_static/documentation_options.js

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

{alembic-1.16.0 → alembic-1.16.2}/docs/api/autogenerate.html

@@ -8,7 +8,7 @@
     <meta charset="utf-8" />
     <meta name="viewport" content="width=device-width, initial-scale=1.0" /><meta name="viewport" content="width=device-width, initial-scale=1" />
 
-    <title>Autogeneration &#8212; Alembic 1.16.0 documentation</title>
+    <title>Autogeneration &#8212; Alembic 1.16.2 documentation</title>
   
   
   
@@ -40,7 +40,7 @@
 <link rel="preload" as="script" href="../_static/scripts/pydata-sphinx-theme.js?digest=dfe6caa3a7d634c4db9b" />
   <script src="../_static/vendor/fontawesome/6.5.2/js/all.min.js?digest=dfe6caa3a7d634c4db9b"></script>
 
-    <script src="../_static/documentation_options.js?v=c8a63786"></script>
+    <script src="../_static/documentation_options.js?v=642e35fd"></script>
     <script src="../_static/doctools.js?v=9bcbadda"></script>
     <script src="../_static/sphinx_highlight.js?v=dc90522c"></script>
     <script src="../_static/clipboard.min.js?v=a7894cd8"></script>
@@ -138,7 +138,7 @@
   
   
   
-    <p class="title logo__title">Alembic 1.16.0 documentation</p>
+    <p class="title logo__title">Alembic 1.16.2 documentation</p>
   
 </a></div>
         <div class="sidebar-primary-item"><ul class="navbar-icon-links"

{alembic-1.16.0 → alembic-1.16.2}/docs/api/commands.html

@@ -8,7 +8,7 @@
     <meta charset="utf-8" />
     <meta name="viewport" content="width=device-width, initial-scale=1.0" /><meta name="viewport" content="width=device-width, initial-scale=1" />
 
-    <title>Commands &#8212; Alembic 1.16.0 documentation</title>
+    <title>Commands &#8212; Alembic 1.16.2 documentation</title>
   
   
   
@@ -40,7 +40,7 @@
 <link rel="preload" as="script" href="../_static/scripts/pydata-sphinx-theme.js?digest=dfe6caa3a7d634c4db9b" />
   <script src="../_static/vendor/fontawesome/6.5.2/js/all.min.js?digest=dfe6caa3a7d634c4db9b"></script>
 
-    <script src="../_static/documentation_options.js?v=c8a63786"></script>
+    <script src="../_static/documentation_options.js?v=642e35fd"></script>
     <script src="../_static/doctools.js?v=9bcbadda"></script>
     <script src="../_static/sphinx_highlight.js?v=dc90522c"></script>
     <script src="../_static/clipboard.min.js?v=a7894cd8"></script>
@@ -138,7 +138,7 @@
   
   
   
-    <p class="title logo__title">Alembic 1.16.0 documentation</p>
+    <p class="title logo__title">Alembic 1.16.2 documentation</p>
   
 </a></div>
         <div class="sidebar-primary-item"><ul class="navbar-icon-links"

{alembic-1.16.0 → alembic-1.16.2}/docs/api/config.html

@@ -8,7 +8,7 @@
     <meta charset="utf-8" />
     <meta name="viewport" content="width=device-width, initial-scale=1.0" /><meta name="viewport" content="width=device-width, initial-scale=1" />
 
-    <title>Configuration &#8212; Alembic 1.16.0 documentation</title>
+    <title>Configuration &#8212; Alembic 1.16.2 documentation</title>
   
   
   
@@ -40,7 +40,7 @@
 <link rel="preload" as="script" href="../_static/scripts/pydata-sphinx-theme.js?digest=dfe6caa3a7d634c4db9b" />
   <script src="../_static/vendor/fontawesome/6.5.2/js/all.min.js?digest=dfe6caa3a7d634c4db9b"></script>
 
-    <script src="../_static/documentation_options.js?v=c8a63786"></script>
+    <script src="../_static/documentation_options.js?v=642e35fd"></script>
     <script src="../_static/doctools.js?v=9bcbadda"></script>
     <script src="../_static/sphinx_highlight.js?v=dc90522c"></script>
     <script src="../_static/clipboard.min.js?v=a7894cd8"></script>
@@ -138,7 +138,7 @@
   
   
   
-    <p class="title logo__title">Alembic 1.16.0 documentation</p>
+    <p class="title logo__title">Alembic 1.16.2 documentation</p>
   
 </a></div>
         <div class="sidebar-primary-item"><ul class="navbar-icon-links"
@@ -504,7 +504,20 @@ engines, use the <a class="reference internal" href="#alembic.config.Config.attr
 <dl class="field-list simple">
 <dt class="field-odd">Parameters<span class="colon">:</span></dt>
 <dd class="field-odd"><ul class="simple">
-<li><p><span class="target" id="alembic.config.Config.params.file_"></span><strong>file_</strong><a class="paramlink headerlink reference internal" href="#alembic.config.Config.params.file_">¶</a> – name of the .ini file to open.</p></li>
+<li><p><span class="target" id="alembic.config.Config.params.file_"></span><strong>file_</strong><a class="paramlink headerlink reference internal" href="#alembic.config.Config.params.file_">¶</a> – name of the .ini file to open if an <code class="docutils literal notranslate"><span class="pre">alembic.ini</span></code> is
+to be used.    This should refer to the <code class="docutils literal notranslate"><span class="pre">alembic.ini</span></code> file, either as
+a filename or a full path to the file.  This filename if passed must refer
+to an <strong>ini file in ConfigParser format</strong> only.</p></li>
+<li><p><span class="target" id="alembic.config.Config.params.toml_file"></span><strong>toml_file</strong><a class="paramlink headerlink reference internal" href="#alembic.config.Config.params.toml_file">¶</a> – <p>name of the pyproject.toml file to open if a
+<code class="docutils literal notranslate"><span class="pre">pyproject.toml</span></code> file is to be used.  This should refer to the
+<code class="docutils literal notranslate"><span class="pre">pyproject.toml</span></code> file, either as a filename or a full path to the file.
+This file must be in toml format. Both <a class="reference internal" href="#alembic.config.Config.params.file_" title="alembic.config.Config"><code class="xref py py-paramref docutils literal notranslate"><span class="pre">Config.file_</span></code></a> and
+<a class="reference internal" href="#alembic.config.Config.params.toml_file" title="alembic.config.Config"><code class="xref py py-paramref docutils literal notranslate"><span class="pre">Config.toml_file</span></code></a> may be passed simultaneously, or
+exclusively.</p>
+<div class="versionadded">
+<p><span class="versionmodified added">Added in version 1.16.0.</span></p>
+</div>
+</p></li>
 <li><p><span class="target" id="alembic.config.Config.params.ini_section"></span><strong>ini_section</strong><a class="paramlink headerlink reference internal" href="#alembic.config.Config.params.ini_section">¶</a> – name of the main Alembic section within the
 .ini file</p></li>
 <li><p><span class="target" id="alembic.config.Config.params.output_buffer"></span><strong>output_buffer</strong><a class="paramlink headerlink reference internal" href="#alembic.config.Config.params.output_buffer">¶</a> – optional file-like input buffer which