summaryrefslogtreecommitdiff
path: root/alembic/context.pyi
diff options
context:
space:
mode:
authorMike Bayer <mike_mp@zzzcomputing.com>2022-11-07 13:05:08 -0500
committerMike Bayer <mike_mp@zzzcomputing.com>2022-11-15 14:27:21 -0500
commitcfe87f59d1bbe0eaa49ae183ba29bc6721c66581 (patch)
tree1e603b5e17c69e8f105d1c23090c740caef36082 /alembic/context.pyi
parentc76fd4bbf13a51c41429b7e14cba387d36536006 (diff)
downloadalembic-cfe87f59d1bbe0eaa49ae183ba29bc6721c66581.tar.gz
add typing parameters
Fixed typing issue where :paramref:`.revision.process_revision_directives` was not fully typed; additionally ensured all ``Callable`` and ``Dict`` arguments to :meth:`.EnvironmentContext.configure` include parameters in the typing declaration. Change-Id: I3ac389992f357359439be5659af33525fc290f96 Fixes: #1110
Diffstat (limited to 'alembic/context.pyi')
-rw-r--r--alembic/context.pyi22
1 files changed, 13 insertions, 9 deletions
diff --git a/alembic/context.pyi b/alembic/context.pyi
index a2e5399..9871fad 100644
--- a/alembic/context.pyi
+++ b/alembic/context.pyi
@@ -19,13 +19,13 @@ if TYPE_CHECKING:
from sqlalchemy.sql.schema import MetaData
from .config import Config
+ from .operations import MigrateOperation
from .runtime.migration import _ProxyTransaction
from .runtime.migration import MigrationContext
from .script import ScriptDirectory
-
### end imports ###
-def begin_transaction() -> Union["_ProxyTransaction", ContextManager]:
+def begin_transaction() -> Union[_ProxyTransaction, ContextManager]:
"""Return a context manager that will
enclose an operation within a "transaction",
as defined by the environment's offline
@@ -75,29 +75,33 @@ def configure(
connection: Optional[Connection] = None,
url: Optional[str] = None,
dialect_name: Optional[str] = None,
- dialect_opts: Optional[dict] = None,
+ dialect_opts: Optional[Dict[str, Any]] = None,
transactional_ddl: Optional[bool] = None,
transaction_per_migration: bool = False,
output_buffer: Optional[TextIO] = None,
starting_rev: Optional[str] = None,
tag: Optional[str] = None,
- template_args: Optional[dict] = None,
+ template_args: Optional[Dict[str, Any]] = None,
render_as_batch: bool = False,
target_metadata: Optional[MetaData] = None,
- include_name: Optional[Callable] = None,
- include_object: Optional[Callable] = None,
+ include_name: Optional[Callable[..., bool]] = None,
+ include_object: Optional[Callable[..., bool]] = None,
include_schemas: bool = False,
- process_revision_directives: Optional[Callable] = None,
+ process_revision_directives: Optional[
+ Callable[
+ [MigrationContext, Tuple[str, str], List[MigrateOperation]], None
+ ]
+ ] = None,
compare_type: bool = False,
compare_server_default: bool = False,
- render_item: Optional[Callable] = None,
+ render_item: Optional[Callable[..., bool]] = None,
literal_binds: bool = False,
upgrade_token: str = "upgrades",
downgrade_token: str = "downgrades",
alembic_module_prefix: str = "op.",
sqlalchemy_module_prefix: str = "sa.",
user_module_prefix: Optional[str] = None,
- on_version_apply: Optional[Callable] = None,
+ on_version_apply: Optional[Callable[..., None]] = None,
**kw: Any,
) -> None:
"""Configure a :class:`.MigrationContext` within this