a g gNP @sddlmZddlZddlmZddlmZddlmZddlmZddlmZddlm Z dd lm Z dd lm Z dd lm Z dd l mZd dlmZd dlmZddlmZddlmZe rvddlmZddlmZddlmZddlmZddlmZddlmZddlmZddlmZddlmZddl m!Z!ddl"m#Z#ddl"m$Z$ddl%m&Z&dd l'm(Z(dd!l'm)Z)d"d#d$d%d&d'Z*d"d#d(d%d)d*Z+d@d/d0d0d1d2d3d4d0d5d6d7Z,d"d8d3d9d:d;Z-Gdd?d?Z/dS)A) annotationsN)Any)Callable)Dict)Iterator)Optional)Set)Tuple) TYPE_CHECKING)Union)inspect)compare)render)util)ops) Connection)Dialect) Inspector)Column)ForeignKeyConstraint)Index)MetaData)Table)UniqueConstraint)Config)MigrationScript) UpgradeOpsMigrationContext)Script)ScriptDirectoryr rr)contextmetadatareturncCst||}|jS)a Compare a database schema to that given in a :class:`~sqlalchemy.schema.MetaData` instance. The database connection is presented in the context of a :class:`.MigrationContext` object, which provides database connectivity as well as optional comparison functions to use for datatypes and server defaults - see the "autogenerate" arguments at :meth:`.EnvironmentContext.configure` for details on these. The return format is a list of "diff" directives, each representing individual differences:: from alembic.migration import MigrationContext from alembic.autogenerate import compare_metadata from sqlalchemy.schema import SchemaItem from sqlalchemy.types import TypeEngine from sqlalchemy import (create_engine, MetaData, Column, Integer, String, Table, text) import pprint engine = create_engine("sqlite://") with engine.begin() as conn: conn.execute(text(''' create table foo ( id integer not null primary key, old_data varchar, x integer )''')) conn.execute(text(''' create table bar ( data varchar )''')) metadata = MetaData() Table('foo', metadata, Column('id', Integer, primary_key=True), Column('data', Integer), Column('x', Integer, nullable=False) ) Table('bat', metadata, Column('info', String) ) mc = MigrationContext.configure(engine.connect()) diff = compare_metadata(mc, metadata) pprint.pprint(diff, indent=2, width=20) Output:: [ ( 'add_table', Table('bat', MetaData(bind=None), Column('info', String(), table=), schema=None)), ( 'remove_table', Table(u'bar', MetaData(bind=None), Column(u'data', VARCHAR(), table=), schema=None)), ( 'add_column', None, 'foo', Column('data', Integer(), table=)), ( 'remove_column', None, 'foo', Column(u'old_data', VARCHAR(), table=None)), [ ( 'modify_nullable', None, 'foo', u'x', { 'existing_server_default': None, 'existing_type': INTEGER()}, True, False)]] :param context: a :class:`.MigrationContext` instance. :param metadata: a :class:`~sqlalchemy.schema.MetaData` instance. .. seealso:: :func:`.produce_migrations` - produces a :class:`.MigrationScript` structure based on metadata comparison. )produce_migrations upgrade_opsZas_diffs)r#r$migration_scriptr)[/var/www/html/llm_bihealth/app/venv/lib/python3.9/site-packages/alembic/autogenerate/api.pycompare_metadata+s[ r+rcCs8t||d}tjdtgtgd}t|||S)aProduce a :class:`.MigrationScript` structure based on schema comparison. This function does essentially what :func:`.compare_metadata` does, but then runs the resulting list of diffs to produce the full :class:`.MigrationScript` object. For an example of what this looks like, see the example in :ref:`customizing_revision`. .. seealso:: :func:`.compare_metadata` - returns more fundamental "diff" data from comparing a schema. )r$Nrev_idr' downgrade_ops)AutogenContextrrr DowngradeOpsr_populate_migration_script)r#r$autogen_contextr(r)r)r*r&s  r&sa.op.Fr)rstrboolzTuple[str, ...]NonezOptional[MigrationContext]) up_or_down_opsqlalchemy_module_prefixalembic_module_prefixrender_as_batchimports render_itemmigration_contextr%c Csd||||d}|durrAr r?r2r)r)r*render_python_codes      rEzDict[Any, Any])r# template_argsr%cCsDt|}tg}t||tjd||d}t|||dS)z6legacy, used by test_autogen_composition at the momentNr,) r/rrrZ_produce_net_changesrreverser _render_python_into_templatevars)r#rFr2r'r(r)r)r*_render_migration_diffss  rIc@seZdZUdZdZded<dZded<dZded<dZd ed <dZ d ed <d*d dddddddZ e j ddddZ ejddddZddddddd Zd!dddd"dd#d$d%ZeZe j d&d'Ze j d(d)ZdS)+r/zSMaintains configuration and state that's specific to an autogenerate operation.NzOptional[MetaData]r$zOptional[Connection] connectionzOptional[Dialect]r@zSet[str]r<r r>TzOptional[dict]r6r7)r>r$rA autogenerater%c Cs|r|dur|jrtd|dur*|j}|dur>|ddn||_}|rx|durx|durx|jdurxtd|jj|dd}|dd}g}g}|r|||r||||_ ||_ ||_ |j dur|j j |_ |j j|_t|_||_d|_dS)Nz^autogenerate can't use as_sql=True as it prevents querying the database for schema informationZtarget_metadatazCan't proceed with --autogenerate option; environment script %s does not provide a MetaData object or sequence of objects to the context.include_object include_nameF)Zas_sqlr CommandErrorrAgetr$scriptZenv_py_locationappend_object_filters _name_filtersr>bindrJr@rCr< _has_batch) selfr>r$rArKrLrMZobject_filtersZ name_filtersr)r)r*__init__sV        zAutogenContext.__init__rr%cCs|jdurtdt|jS)NzHcan't return inspector as this AutogenContext has no database connection)rJ TypeErrorr rVr)r)r* inspectorXs  zAutogenContext.inspectorzIterator[None]ccsd|_dVd|_dS)NTF)rUrZr)r)r* _within_batchaszAutogenContext._within_batchz Optional[str]r5zDict[str, Optional[str]])nametype_ parent_namesr%cCsnd|vrL|dkr|}n |dd}|rL|d}|rDd||f|d<n||d<|jD]}||||sRdSqRdS) aRun the context's name filters and return True if the targets should be part of the autogenerate operation. This method should be run for every kind of name encountered within the reflection side of an autogenerate operation, giving the environment the chance to filter what names should be reflected as database objects. The filters here are produced directly via the :paramref:`.EnvironmentContext.configure.include_name` parameter. schema_nametable table_nameNz%s.%sZschema_qualified_table_nameFT)rOrS)rVr]r^r_rbr`fnr)r)r*run_name_filtersgs     zAutogenContext.run_name_filterszCUnion[Table, Index, Column, UniqueConstraint, ForeignKeyConstraint]z7Optional[Union[Table, Index, Column, UniqueConstraint]])object_r]r^ reflected compare_tor%cCs&|jD]}||||||sdSqdS)aRun the context's object filters and return True if the targets should be part of the autogenerate operation. This method should be run for every kind of object encountered within an autogenerate operation, giving the environment the chance to filter what objects should be included in the comparison. The filters here are produced directly via the :paramref:`.EnvironmentContext.configure.include_object` parameter. FTN)rR)rVrer]r^rfrgrcr)r)r*run_object_filterss z!AutogenContext.run_object_filterscCs&g}t|jD]}||jq|S)aiReturn an aggregate of the :attr:`.MetaData.sorted_tables` collection(s). For a sequence of :class:`.MetaData` objects, this concatenates the :attr:`.MetaData.sorted_tables` collection for each individual :class:`.MetaData` in the order of the sequence. It does **not** collate the sorted tables collections. )rto_listr$extend sorted_tables)rVresultmr)r)r*rks zAutogenContext.sorted_tablescCs^i}t|jD]H}t|t|j}|rLtddddt|D| |jq|S)aReturn an aggregate of the :attr:`.MetaData.tables` dictionaries. The :attr:`.MetaData.tables` collection is a dictionary of table key to :class:`.Table`; this method aggregates the dictionary across multiple :class:`.MetaData` objects into one dictionary. Duplicate table keys are **not** supported; if two :class:`.MetaData` objects contain the same table key, an exception is raised. z9Duplicate table keys across multiple MetaData objects: %sz, css|]}d|VqdS)z"%s"Nr)).0keyr)r)r* z4AutogenContext.table_key_to_table..) rrir$rC intersectionZtables ValueErrorjoinsortedupdate)rVrlrmZ intersectr)r)r*table_key_to_tables z!AutogenContext.table_key_to_table)NNT)__name__ __module__ __qualname____doc__r$__annotations__rJr@r<r>rWrZmemoized_propertyr[ contextlibcontextmanagerr\rdrhZ run_filtersrkrwr)r)r)r*r/s*     <& r/c@seZdZdZd!ddddddd d Zd d d ddZddddddZddddddZdddddddZd dddZ dddd Z dS)"RevisionContextz^Maintains configuration and state that's specific to a revision file generation operation.Nrr"zDict[str, Any]zOptional[Callable]r7)configscript_directory command_argsprocess_revision_directivesr%cCs2||_||_||_||_d|i|_|g|_dS)Nr)rrrrrF_default_revisiongenerated_revisions)rVrrrrr)r)r*rWszRevisionContext.__init__rzOptional[Script])r(r%c Cs|j}t|ddrF|j}t|_|jr8|j|jt||||j dusTJ|j j |j |j fd|j |j|j|j|jd|S)N _needs_renderFT)ZrefreshheadspliceZ branch_labels version_path depends_on)rFcopygetattr_last_autogen_contextrCr<rvrrHr-rZgenerate_revisionmessagerr branch_labelrr)rVr(rFr2r)r)r* _to_scripts.   zRevisionContext._to_scripttupler )revr>r%cCs|||ddS)NT_run_environmentrVrr>r)r)r*run_autogenerate sz RevisionContext.run_autogeneratecCs|||ddS)NFrrr)r)r*run_no_autogeneratesz#RevisionContext.run_no_autogenerater6)rr>rKr%c Cs&|rB|jdrtdt|j|t|jdkrBtd|jd}|jd}|jd}t|dd s||j d_ ||j d_ d |_ n,|jtjg|d |jtjg|d t||d }||_|rt|||jr||||j|jd}|r||||j|jD] }d |_ qdS)NZsqlz7Using --sql with --autogenerate does not make any senseZheadsz"Target database is not up to date. upgrade_tokendowngrade_tokenrFT)r)r)rKr)rrrNrCrZ get_revisionsrArrZupgrade_ops_listrZdowngrade_ops_listrrZ _upgrade_opsrQrrZ_downgrade_opsr0r/rrr1r) rVrr>rKrrr(r2hookr)r)r*rsT            z RevisionContext._run_environmentrXc CsV|j}tj|dpt|dtgtg|d|d|d|d|dd }|S) Nr-rrrrrr) r-rr'r.rrrrr)rrrrr-rr0)rVropr)r)r*rLs z!RevisionContext._default_revisionzIterator[Optional[Script]]ccs|jD]}||VqdS)N)rr)rVZgenerated_revisionr)r)r*generate_scripts[s z RevisionContext.generate_scripts)N) rxryrzr{rWrrrrrrr)r)r)r*rs8r)r3r4Fr)NN)0 __future__rr}typingrrrrrrr r r Z sqlalchemyr rrr operationsrZsqlalchemy.enginerrrZsqlalchemy.sql.schemarrrrrrZalembic.configrZalembic.operations.opsrrZalembic.runtime.migrationr Zalembic.script.baser!r"r+r&rErIr/rr)r)r)r*sX                              _!&t