a g gP@sddlmZddlmZddlmZddlmZddlZddlZddl Z ddl m Z ddl m Z ddl m Z dd l mZdd l mZd d lmZd d lmZd dlmZd dlmZGdddZGdddZdddZedkredS)) annotations)ArgumentParser) Namespace) ConfigParserN)Dict)Optional)overload)TextIO)Union) __version__)command)util)compatc @sdeZdZUdZdddejdedfdddddd d d d d dZdZ de d<dZ de d<dZ de d<ej ddZdd dddZej ddZddddZeddddddZed6dd!d!dd"dZd7dd#d$dZddd d%d&d'Zdd d(d)d*Zdddd d+d,d-Zd8ddd.d.d/d0d1Zeddddd2d3Zed9dd.d.dd4d3Zd:d5d3ZdS);Configa_ Represent an Alembic configuration. Within an ``env.py`` script, this is available via the :attr:`.EnvironmentContext.config` attribute, which in turn is available at ``alembic.context``:: from alembic import context some_param = context.config.get_main_option("my option") When invoking Alembic programatically, a new :class:`.Config` can be created by passing the name of an .ini file to the constructor:: from alembic.config import Config alembic_cfg = Config("/path/to/yourapp/alembic.ini") With a :class:`.Config` object, you can then run Alembic commands programmatically using the directives in :mod:`alembic.command`. The :class:`.Config` object can also be constructed without a filename. Values can be set programmatically, and new sections will be created as needed:: from alembic.config import Config alembic_cfg = Config() alembic_cfg.set_main_option("script_location", "myapp:migrations") alembic_cfg.set_main_option("sqlalchemy.url", "postgresql://foo/bar") alembic_cfg.set_section_option("mysection", "foo", "bar") .. warning:: When using programmatic configuration, make sure the ``env.py`` file in use is compatible with the target configuration; including that the call to Python ``logging.fileConfig()`` is omitted if the programmatic configuration doesn't actually include logging directives. For passing non-string values to environments, such as connections and engines, use the :attr:`.Config.attributes` dictionary:: with engine.begin() as connection: alembic_cfg.attributes['connection'] = connection command.upgrade(alembic_cfg, "head") :param file\_: name of the .ini file to open. :param ini_section: name of the main Alembic section within the .ini file :param output_buffer: optional file-like input buffer which will be passed to the :class:`.MigrationContext` - used to redirect the output of "offline generation" when using Alembic programmatically. :param stdout: buffer where the "print" output of commands will be sent. Defaults to ``sys.stdout``. :param config_args: A dictionary of keys and values that will be used for substitution in the alembic config file. The dictionary as given is **copied** to a new one, stored locally as the attribute ``.config_args``. When the :attr:`.Config.file_config` attribute is first invoked, the replacement variable ``here`` will be added to this dictionary before the dictionary is passed to ``ConfigParser()`` to parse the .ini file. :param attributes: optional dictionary of arbitrary Python keys/values, which will be populated into the :attr:`.Config.attributes` dictionary. .. seealso:: :ref:`connection_sharing` Nalembicz"Union[str, os.PathLike[str], None]strzOptional[TextIO]r zOptional[Namespace]zutil.immutabledictzOptional[dict]None)file_ ini_section output_bufferstdoutcmd_opts config_args attributesreturncCs<||_||_||_||_||_t||_|r8|j|dS)z Construct a new :class:`.Config`N) config_file_nameconfig_ini_sectionrrrdictrrupdate)selfrrrrrrrr!Q/var/www/html/llm_bihealth/app/venv/lib/python3.9/site-packages/alembic/config.py__init___s  zConfig.__init__rrrcCsiS)aA Python dictionary for storage of additional state. This is a utility dictionary which can include not just strings but engines, connections, schema objects, or anything else. Use this to pass objects into an env.py script, such as passing a :class:`sqlalchemy.engine.base.Connection` when calling commands from :mod:`alembic.command` programmatically. .. seealso:: :ref:`connection_sharing` :paramref:`.Config.attributes` r!)r r!r!r"rszConfig.attributes)textrcGs.|rt||}nt|}t|j|ddS)a\Render a message to standard out. When :meth:`.Config.print_stdout` is called with additional args those arguments will formatted against the provided text, otherwise we simply output the provided text verbatim. e.g.:: >>> config.print_stdout('Some text %s', 'arg') Some Text arg  N)rrZwrite_outstreamr)r r$argoutputr!r!r" print_stdoutszConfig.print_stdoutcCs\|jrtjtj|j}nd}||jd<t|j}|jrL||jgn ||j |S)aReturn the underlying ``ConfigParser`` object. Direct access to the .ini file is available here, though the :meth:`.Config.get_section` and :meth:`.Config.get_main_option` methods provide a possibly simpler interface. here) rospathabspathdirnamerrread add_sectionr)r r* file_configr!r!r"r1s    zConfig.file_config)rcCs,ddl}tjtj|j}tj|dS)zReturn the directory where Alembic setup templates are found. This method is used by the alembic ``init`` and ``list_templates`` commands. rNZ templates)rr+r,r-r.__file__join)r r package_dirr!r!r"get_template_directoryszConfig.get_template_directoryzDict[str, str])namedefaultrcCsdSNr!r r6r7r!r!r" get_sectionszConfig.get_section.zOptional[Dict[str, str]]cCsdSr8r!r9r!r!r"r:s)r6cCs |j|s|St|j|S)zfReturn all the configuration options from a given .ini file section as a dictionary. )r1 has_sectionritemsr9r!r!r"r:s )r6valuercCs||j||dS)a:Set an option programmatically within the 'main' section. This overrides whatever was in the .ini file. :param name: name of the value :param value: the value. Note that this value is passed to ``ConfigParser.set``, which supports variable interpolation using pyformat (e.g. ``%(some_value)s``). A raw percent sign not part of an interpolation symbol must therefore be escaped, e.g. ``%%``. The given value may refer to another value already in the file using the interpolation format. N)set_section_optionr)r r6r=r!r!r"set_main_optionszConfig.set_main_option)r6rcCs|j|j|dSr8)r1 remove_optionr)r r6r!r!r"remove_main_optionszConfig.remove_main_option)sectionr6r=rcCs,|j|s|j||j|||dS)aSet an option programmatically within the given section. The section is created if it doesn't exist already. The value here will override whatever was in the .ini file. :param section: name of the section :param name: name of the value :param value: the value. Note that this value is passed to ``ConfigParser.set``, which supports variable interpolation using pyformat (e.g. ``%(some_value)s``). A raw percent sign not part of an interpolation symbol must therefore be escaped, e.g. ``%%``. The given value may refer to another value already in the file using the interpolation format. N)r1r;r0set)r rBr6r=r!r!r"r>s  zConfig.set_section_option Optional[str])rBr6r7rcCsD|j|s td|j|f|j||r<|j||S|SdS)z9Return an option from the given section of the .ini file.z6No config file %r found, or file has no '[%s]' sectionN)r1r;r CommandErrorr has_optionget)r rBr6r7r!r!r"get_section_options zConfig.get_section_optioncCsdSr8r!r9r!r!r"get_main_option&szConfig.get_main_optioncCsdSr8r!r9r!r!r"rI*scCs||j||S)zReturn an option from the 'main' section of the .ini file. This defaults to being a key from the ``[alembic]`` section, unless the ``-n/--name`` flag were used to indicate a different section. )rHrr9r!r!r"rI0s).)N)N)N)N)__name__ __module__ __qualname____doc__sysrrZ immutabledictr#r__annotations__rrZmemoized_propertyrr(r1r5rr:r?rAr>rHrIr!r!r!r"rsF J      rc@sJeZdZddddddZdddddZd d dd d d ZdddZdS) CommandLineNrDr)progrcCs||dSr8)_generate_args)r rQr!r!r"r#<szCommandLine.__init__c sfdd}t|d}|jdddtd|jdd ttjd d d d |jddtddd |jdddd|jdddd|}tj ddiiddt tDD]$t rj ddkrjdkrt}|d dur|dd!t|d  }|dt|d  d}n|dd!d}g}vrNfd"d|D}j}|rg} |d#D]&} | s~qn| | qhng} |jj d$| d%|||j||fd&q||_dS)'Nc sddtdtddfddttdd fd td d d fdttdd fdttdd fdtd dd fdtddd fdttdd fdttdd fdttdd fddtd dd fd td d!d fd"td d#d fd$d%td&d'd fd(d)td d*d fd+td d,d fd-td d.d fd/}d0d1d2d3}|D]>}||vr||}|d4d5|d5}}|j|i|q|D]X}|d6ks~|vr||d6krjd6d7|d6d8nj|||d9qTdS):Nz-tz --templateZgenericz"Setup template for use with 'init')r7typehelpz-mz --messagez%Message string to use with 'revision')rSrTz--sql store_truez\Don't emit SQL to database - dump to standard output/file instead. See docs on offline mode.actionrTz--tagz@head to base new revision on.z--splicez6Allow a non-head revision as the 'head' to splice ontoz --depends-onappendzNSpecify one or more revision identifiers which this revision should depend on.z--rev-idz9Specify a hardcoded revision id instead of generating onez--version-pathz2Specify specific path from config for version filez--branch-labelz3Specify a branch label to apply to the new revisionz-vz --verbosezUse more verbose outputz--resolve-dependenciesz+Treat dependency versions as down revisionsz--autogeneratezgPopulate revision script with candidate migration operations, based on comparison of database to model.z-rz --rev-rangestorez1Specify a revision range; format is [start]:[end]z-iz--indicate-currentzIndicate the current revisionz--purgez7Unconditionally erase the version table before stampingz --packagezFWrite empty __init__.py files to the environment and version locations)templatemessageZsqltagheadZspliceZ depends_onZrev_idZ version_pathZ branch_labelverboseZresolve_dependenciesZ autogenerateZ rev_rangeZindicate_currentpurgepackagezlocation of scripts directoryzrevision identifierz/one or more revisions, or 'heads' for all heads) directoryrevision revisionsrrc+)nargsrTrT)rr add_argumentrG) fnparser positionalkwargsZ kwargs_optsZpositional_helpr&argskw)positional_translations subparserr!r" add_options@s                z/CommandLine._generate_args..add_optionsrQz --versionversionz %%(prog)s %s)rWrsz-cz--configZALEMBIC_CONFIGz alembic.inizaAlternate config file; defaults to value of ALEMBIC_CONFIG environment variable, or "alembic.ini")rSr7rTz-nz--namerz6Name of section in .ini file to use for Alembic configz-xrXzlAdditional arguments consumed by custom env.py scripts, e.g. -x setting1=somesetting -x setting2=somesettingrVz --raiseerrrUz!Raise a full stack trace on errorrbrccSsg|]}tt|qSr!)getattrr ).0nr!r!r" z.CommandLine._generate_args..r_zalembic.commandr csg|]}||qSr!)rG)rur6)riror!r"rwsr% rg)cmd)rrhr rr+environrGadd_subparsersr Zstampdirinspect isfunctionrJrKrZinspect_getfullargspeclenrMsplitstriprX add_parserr3 set_defaultsrj) r rQrqrjZ subparsersspecrkkwarghelp_ help_textliner!)rirorpr"rR?s~$         zCommandLine._generate_argsrr)configoptionsrc sj\}}}z6||gfdd|DRifdd|DWn>tjy}z$jr^ntt|WYd}~n d}~00dS)Ncsg|]}t|dqSr8rtrukrr!r"rw4rxz'CommandLine.run_cmd..csi|]}|t|dqSr8rrrr!r" 5rxz'CommandLine.run_cmd..)r|rrEZraiseerrerrr)r rrrirkrer!rr"run_cmd.s  zCommandLine.run_cmdcCsF|j|}t|ds$|jdnt|j|j|d}|||dS)Nr|ztoo few arguments)rrr)rj parse_argshasattrerrorrrr6r)r argvrcfgr!r!r"main=s  zCommandLine.main)N)N)rJrKrLr#rRrrr!r!r!r"rP;s prPcKst|dj|ddS)z(The console runner function for Alembic.rr)rN)rPr)rrQrlr!r!r"rLsr__main__)NN) __future__rargparserr configparserrrr+rNtypingrrrr r r)r r rrrrPrrJr!r!r!r"s0             (