관리-도구
편집 파일: api.cpython-38.pyc
U 0?�f�V � @ s d dl mZ d dlZd dlmZ d dlmZ d dlmZ d dlmZ d dlmZ d dlm Z d d lm Z d d lm Z d d lm Z d d l mZ d dlmZ d dlmZ ddlmZ ddlmZ ddlmZ e �r�d dlmZ d dlmZ d dlmZ d dlmZ d dlm Z d dlm Z ddl m Z ddl m!Z! dd l m"Z" dd l m#Z# dd l$m%Z% dd l$m&Z& dd l$m'Z' dd!l$m(Z( dd"l)m*Z* dd#l+m,Z, dd$l+m-Z- dd%l.m/Z/ d&d'd(d)�d*d+�Z0d&d'd,d)�d-d.�Z1dFd3d4d4d5d6d7d8d9d4d:� d;d<�Z2d&d=d>d?�d@dA�Z3G dBdC� dC�Z4G dDdE� dE�Z5dS )G� )� annotationsN)�Any)�Dict)�Iterator)�List)�Optional)�Sequence)�Set)� TYPE_CHECKING)�Union)�inspect� )�compare)�render� )�util)�ops)� sqla_compat)� Connection)�Dialect)� Inspector)�MetaData)� SchemaItem)�Table)�Config)� DowngradeOps)�MigrationScript)� UpgradeOps)�NameFilterParentNames)�NameFilterType)�ProcessRevisionDirectiveFn)� RenderItemFn��MigrationContext)�Script)�ScriptDirectory)� _GetRevArgr# r r )�context�metadata�returnc C s" t | |�}|jdk st�|j�� S )aB 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 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(), Column("info", String(), table=<bat>), schema=None, ), ), ( "remove_table", Table( "bar", MetaData(), Column("data", VARCHAR(), table=<bar>), schema=None, ), ), ( "add_column", None, "foo", Column("data", Integer(), table=<foo>), ), [ ( "modify_nullable", None, "foo", "x", { "existing_comment": None, "existing_server_default": False, "existing_type": INTEGER(), }, True, False, ) ], ( "remove_column", None, "foo", Column("old_data", VARCHAR(), table=<foo>), ), ] :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. N)�produce_migrations� upgrade_ops�AssertionErrorZas_diffs)r' r( �migration_script� r. �F/opt/hc_python/lib/python3.8/site-packages/alembic/autogenerate/api.py�compare_metadata/ s y r0 r c C s8 t | |d�}tjdt�g �t�g �d�}t�||� |S )a� Produce 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( N��rev_idr+ � downgrade_ops)�AutogenContextr r r r r �_populate_migration_script)r' r( �autogen_contextr- r. r. r/ r* � s � r* �sa.�op.Fr. z Union[UpgradeOps, DowngradeOps]�str�boolz Sequence[str]zOptional[RenderItemFn]zOptional[MigrationContext]� Optional[str]) � up_or_down_op�sqlalchemy_module_prefix�alembic_module_prefix�render_as_batch�imports� render_item�migration_context�user_module_prefixr) c C sf |||||d�}|dkr>ddl m} ddlm} | j| � d�}t||d�} t|�| _t� t� | | ��S ) a* Render Python code given an :class:`.UpgradeOps` or :class:`.DowngradeOps` object. This is a convenience function that can be used to test the autogenerate output of a user-defined :class:`.MigrationScript` structure. :param up_or_down_op: :class:`.UpgradeOps` or :class:`.DowngradeOps` object :param sqlalchemy_module_prefix: module prefix for SQLAlchemy objects :param alembic_module_prefix: module prefix for Alembic constructs :param render_as_batch: use "batch operations" style for rendering :param imports: sequence of import symbols to add :param render_item: callable to render items :param migration_context: optional :class:`.MigrationContext` :param user_module_prefix: optional string prefix for user-defined types .. versionadded:: 1.11.0 )r= r> rA r? rC Nr r" r )�DefaultDialect)�dialect)�opts) �runtime.migrationr# Zsqlalchemy.engine.defaultrD � configurer4 �setr@ r �_indentZ_render_cmd_body) r< r= r> r? r@ rA rB rC rF r# rD r6 r. r. r/ �render_python_code� s" � � �rK zDict[Any, Any]�None)r' � template_argsr) c C sD t | �}t�g �}t�||� tjd||�� d�}t�|||� dS )z6legacy, used by test_autogen_composition at the momentNr1 ) r4 r r r Z_produce_net_changesr �reverser � _render_python_into_templatevars)r' rM r6 r+ r- r. r. r/ �_render_migration_diffs� s � �rP c @ s� e Zd ZU dZdZded< dZded< dZded< dZd ed < dZ d ed < d-d ddddd�dd�Z e j dd�dd��Z ejdd�dd��Zdd d dd �d d �Zd!d"d dd#dd$�d%d&�ZeZe j d'd�d(d)��Ze j d*d�d+d,��ZdS ).r4 zSMaintains configuration and state that's specific to an autogenerate operation.NzOptional[MetaData]r( zOptional[Connection]� connectionzOptional[Dialect]rE zSet[str]r@ r# rB TzOptional[Dict[str, Any]]r: rL )rB r( rF � autogenerater) c C s� |r |d k r |j r t�d��|d kr*|j}|d kr>|�dd �n| | _}|rx|d krx|d k rx|jd k rxt�d|jj ��|�dd �}|�dd �}g }g }|r�|�|� |r�|�|� || _ || _ || _ | j d k r�| j j | _ | j j| _t� | _|| _d| _d S )Nz^autogenerate can't use as_sql=True as it prevents querying the database for schema informationZtarget_metadataz�Can'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 � CommandErrorrF �getr( �scriptZenv_py_location�append�_object_filters� _name_filtersrB �bindrQ rE rI r@ � _has_batch) �selfrB r( rF rR rS rT Zobject_filtersZ name_filtersr. r. r/ �__init__L sV ����������� zAutogenContext.__init__r �r) c C s | j d krtd��t| j �S )NzHcan't return inspector as this AutogenContext has no database connection)rQ � TypeErrorr �r] r. r. r/ � inspector� s �zAutogenContext.inspectorzIterator[None]c c s d| _ d V d| _ d S )NTF)r\ ra r. r. r/ � _within_batch� s z AutogenContext._within_batchr; r r )�name�type_� parent_namesr) c C sn d|krL|dkr|}n |� dd�}|rL|d }|rDd||f |d< n||d< | jD ]}||||�sR dS qRdS ) a� Run 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_name�table� table_nameNz%s.%sZschema_qualified_table_nameFT)rV rZ )r] rd re rf ri rg �fnr. r. r/ �run_name_filters� s � z AutogenContext.run_name_filtersr zsqla_compat._ConstraintNamezOptional[SchemaItem])�object_rd re � reflected� compare_tor) c C s& | j D ]}||||||�s dS qdS )a� Run 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)rY )r] rl rd re rm rn rj r. r. r/ �run_object_filters� s z!AutogenContext.run_object_filtersz List[Table]c C s& g }t �| j�D ]}|�|j� q|S )ai Return 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. )r �to_listr( �extend� sorted_tables)r] �result�mr. r. r/ rr � s z AutogenContext.sorted_tableszDict[str, Table]c C s^ i }t �| j�D ]H}t|��t|j��}|rLtdd�dd� t|�D �� ��|� |j� q|S )a� Return 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, c s s | ]}d | V qdS )z"%s"Nr. )�.0�keyr. r. r/ � <genexpr>� s z4AutogenContext.table_key_to_table.<locals>.<genexpr>) r rp r( rI � intersectionZtables� ValueError�join�sorted�update)r] rs rt Z intersectr. r. r/ �table_key_to_table� s ��z!AutogenContext.table_key_to_table)NNT)�__name__� __module__� __qualname__�__doc__r( �__annotations__rQ rE r@ rB r^ r Zmemoized_propertyrb � contextlib�contextmanagerrc rk ro Z run_filtersrr r} r. r. r. r/ r4 s* �;%r4 c @ s� e Zd ZU dZded< ded< d$ddd dd d �d d �Zddd�dd�Zddd d�dd�Zddd d�dd�Zdddd d�d d �Z dd �d d �Z d!d �d"d#�Z dS )%�RevisionContextz^Maintains configuration and state that's specific to a revision file generation operation.zList[MigrationScript]�generated_revisionsz$Optional[ProcessRevisionDirectiveFn]�process_revision_directivesNr r% zDict[str, Any]rL )�config�script_directory� command_argsr� r) c C s2 || _ || _|| _|| _d|i| _| �� g| _d S )Nr� )r� r� r� r� rM �_default_revisionr� )r] r� r� r� r� r. r. r/ r^ s �zRevisionContext.__init__r zOptional[Script])r- r) c C s� | j �� }t|dd�rF| j}t� |_|jr8|j�|j� t�|||� |j d k sTt �| j j |j |j fd|j|j|j|j|jd�|��S )N� _needs_renderFT)�refresh�head�spliceZ branch_labels� version_path� depends_on)rM �copy�getattr�_last_autogen_contextrI r@ r| r rO r2 r, r� Zgenerate_revision�messager� r� � branch_labelr� r� )r] r- rM r6 r. r. r/ � _to_script s2 ��� �zRevisionContext._to_scriptr& r# )�revrB r) c C s | � ||d� d S )NT��_run_environment�r] r� rB r. r. r/ �run_autogenerate7 s z RevisionContext.run_autogeneratec C s | � ||d� d S )NFr� r� r. r. r/ �run_no_autogenerate< s z#RevisionContext.run_no_autogenerater: )r� rB rR r) c C s& |rB| j d rt�d��t| j�|��t| j�d��krBt�d��|jd }|jd }| jd }t|dd �s�||j d _ ||j d _ d |_ n,|j�tjg |d �� |j�tjg |d �� t||d �}|| _|r�t�||� | jr�| �||| j� |jd }|�r|||| j� | jD ] }d |_ �qd S )N�sqlz7Using --sql with --autogenerate does not make any senseZheadsz"Target database is not up to date.� upgrade_token�downgrade_token���r� FT)r� )r� )rR r� )r� r rU rI r� Z get_revisionsrF r� r� Zupgrade_ops_listr� Zdowngrade_ops_listr� r� Z _upgrade_opsrX r r Z_downgrade_opsr r4 r� r r5 r� ) r] r� rB rR r� r� r- r6 �hookr. r. r/ r� A sX � � � � � � � � z RevisionContext._run_environmentr_ c C sV | j }tj|d pt�� |d t�g �t�g �|d |d |d |d |d d� }|S ) Nr2 r� r� r� r� r� r� ) r2 r� r+ r3 r� r� r� r� r� )r� r r r r2 r r )r] r� �opr. r. r/ r� y s � z!RevisionContext._default_revisionzIterator[Optional[Script]]c c s | j D ]}| �|�V qd S )N)r� r� )r] Zgenerated_revisionr. r. r/ �generate_scripts� s z RevisionContext.generate_scripts)N) r~ r r� r� r� r^ r� r� r� r� r� r� r. r. r. r/ r� � s � 8r� )r7 r8 Fr. NNN)6� __future__r r� �typingr r r r r r r r r Z sqlalchemyr � r r r � operationsr r Zsqlalchemy.enginer r r Zsqlalchemy.sql.schemar r r r� r Zoperations.opsr r r Zruntime.environmentr r r r! rG r# Z script.baser$ r% Zscript.revisionr& r0 r* rK rP r4 r� r. r. r. r/ �<module> sb ~! � 3 l