Skip to content

Commit 511dd03

Browse files
committed
document toml_file argument
Change-Id: I3edf7f32d818ffa4f6cf08d15a2d1e4f20137ff2
1 parent f0d6577 commit 511dd03

File tree

1 file changed

+14
-1
lines changed

1 file changed

+14
-1
lines changed

alembic/config.py

Lines changed: 14 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -75,7 +75,20 @@ class Config:
7575
alembic_cfg.attributes['connection'] = connection
7676
command.upgrade(alembic_cfg, "head")
7777
78-
:param file\_: name of the .ini file to open.
78+
:param file\_: name of the .ini file to open if an ``alembic.ini`` is
79+
to be used. This should refer to the ``alembic.ini`` file, either as
80+
a filename or a full path to the file. This filename if passed must refer
81+
to an **ini file in ConfigParser format** only.
82+
83+
:param toml\_file: name of the pyproject.toml file to open if a
84+
``pyproject.toml`` file is to be used. This should refer to the
85+
``pyproject.toml`` file, either as a filename or a full path to the file.
86+
This file must be in toml format. Both :paramref:`.Config.file\_` and
87+
:paramref:`.Config.toml\_file` may be passed simultaneously, or
88+
exclusively.
89+
90+
.. versionadded:: 1.16.0
91+
7992
:param ini_section: name of the main Alembic section within the
8093
.ini file
8194
:param output_buffer: optional file-like input buffer which

0 commit comments

Comments
 (0)