o 8c`L@sddlmZddlZddlZddlZddlmZddlmZddlmZddlm Z ddl m Z Gd d d e Z Gd d d e Zdd dZedkrNedSdS))ArgumentParserN) __version__)command)util)compat)SafeConfigParserc@seZdZdZdddejdedfddZdZ dZ dZ ej ddZ dd Zej d d Zd d ZdddZddZddZddZdddZdddZdS)Configac 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 ``SafeConfigParser()`` 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` NalembiccCs@||_||_||_||_||_t||_|r|j|dSdS)z Construct a new :class:`.Config`N) config_file_nameconfig_ini_section output_bufferstdoutcmd_optsdict config_args attributesupdate)selffile_ ini_sectionr rrrrrD/var/www/html/gps/gps/lib/python3.10/site-packages/alembic/config.py__init__Ws  zConfig.__init__cCsiS)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)rrrrrszConfig.attributescGs2|r t||}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)r text_typerwrite_outstreamr)rtextargoutputrrr print_stdouts zConfig.print_stdoutcCs^|jrtjtj|j}nd}||jd<t|j}|jr'||jg|S||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) r ospathabspathdirnamerrread add_sectionr )rr" file_configrrrr)s    zConfig.file_configcCs,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. rN templates)r r#r$r%r&__file__join)rr package_dirrrrget_template_directoryszConfig.get_template_directorycCs |j|s|St|j|S)zfReturn all the configuration options from a given .ini file section as a dictionary. )r) has_sectionritemsrnamedefaultrrr get_sections zConfig.get_sectioncCs||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 )rr2valuerrrset_main_optionszConfig.set_main_optioncCs|j|j|dSN)r) remove_optionr )rr2rrrremove_main_optionszConfig.remove_main_optioncCs,|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)r)r/r(set)rsectionr2r6rrrr5s  zConfig.set_section_optioncCs@|j|std|j|f|j||r|j||S|S)z9Return an option from the given section of the .ini file.z6No config file %r found, or file has no '[%s]' section)r)r/r CommandErrorr has_optionget)rr<r2r3rrrget_section_options zConfig.get_section_optioncCs||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. )r@r r1rrrget_main_optionszConfig.get_main_optionr8)__name__ __module__ __qualname____doc__sysrr immutabledictrrr r memoized_propertyrr r)r.r4r7r:r5r@rArrrrr s8J        r c@s0eZdZd ddZddZddZd dd ZdS) CommandLineNcCs||dSr8)_generate_args)rprogrrrrszCommandLine.__init__c sfdd}t|d}|jdddtd|jdd ttjd d d d |jddtddd |jdddd|jdddd|}tj ddiiddt tDD]t r܈j ddkr܈jdkrt}|d r|dd!t|d  }|dt|d  d}n |dd!d}g}vrfd"d|D}j}|rg} |d#D]} | sn| | qnd$} |jj d%| d&|||j||fd'qS||_dS)(Nc sidddtdtddfddd ttd d fd d tdddfddttdd fddttdd fddtdddfddtdddfddttd d fd!d"ttd#d fd$d%ttd&d fd'd(d)tdd*dfd+d,tdd-dfd.d/tdd0dfd1d2d3td4d5dfd6d7d8tdd9dfd:d;tddtdd?df}d@dAdBdC}|D]}||vr||}|dDdE|dE}}|j|i|q|D](}|dFks|vr||dFkrjdFdG|dFdHqɈj|||dIqdS)JNtemplatez-tz --templategenericz"Setup template for use with 'init')r3typehelpmessagez-mz --messagez%Message string to use with 'revision')rNrOsqlz--sql store_truez\Don't emit SQL to database - dump to standard output/file instead. See docs on offline mode.actionrOtagz--tagz@head to base new revision on.splicez--splicez6Allow a non-head revision as the 'head' to splice onto depends_onz --depends-onappendzNSpecify one or more revision identifiers which this revision should depend on.rev_idz--rev-idz9Specify a hardcoded revision id instead of generating one version_pathz--version-pathz2Specify specific path from config for version file branch_labelz--branch-labelz3Specify a branch label to apply to the new revisionverbosez-vz --verbosezUse more verbose outputresolve_dependenciesz--resolve-dependenciesz+Treat dependency versions as down revisions autogeneratez--autogeneratezgPopulate revision script with candidate migration operations, based on comparison of database to model. rev_rangez-rz --rev-rangestorez1Specify a revision range; format is [start]:[end]indicate_currentz-iz--indicate-currentzIndicate the current revisionpurgez--purgez7Unconditionally erase the version table before stampingpackagez --packagezFWrite empty __init__.py files to the environment and version locationszlocation of scripts directoryzrevision identifierz/one or more revisions, or 'heads' for all heads) directoryrevision revisionsrrg+)nargsrOrO)rstr add_argumentr?) fnparser positionalkwargs kwargs_optspositional_helprargskw)positional_translations subparserrr add_options sL "*2:BJR W^gpx z/CommandLine._generate_args..add_optionsrKz --versionversionz %%(prog)s %s)rTrzz-cz--configALEMBIC_CONFIGz alembic.inizaAlternate config file; defaults to value of ALEMBIC_CONFIG environment variable, or "alembic.ini")rNr3rOz-nz--namer z6Name of section in .ini file to use for Alembic configz-xrYzlAdditional arguments consumed by custom env.py scripts, e.g. -x setting1=somesetting -x setting2=somesettingrSz --raiseerrrRz!Raise a full stack trace on errorrfrgcSsg|]}tt|qSr)getattrr).0nrrr sz.CommandLine._generate_args..r_zalembic.commandrcsg|] }||qSr)r?)r}r2)rnrvrrrsrr! rk)cmd)rrmrrlr#environr?add_subparsersrstampdirinspect isfunctionrBrCrinspect_getargspeclenrEsplitstriprY add_parserr, set_defaultsro) rrKrxro subparsersspecrpkwarghelp_ help_textliner)rnrvrwrrJs $       zCommandLine._generate_argsc sj\}}}z||gfdd|DRitfdd|DWdStjyC}zjr1tt|WYd}~dSd}~ww)Ncsg|]}t|dqSr8r|r}koptionsrrrsz'CommandLine.run_cmd..c3s |] }|t|dfVqdSr8rrrrr sz&CommandLine.run_cmd..)rrrr=raiseerrerrrl)rconfigrrnrprerrrrun_cmds  zCommandLine.run_cmdcCsH|j|}t|ds|jddSt|j|j|d}|||dS)Nrztoo few arguments)rrr)ro parse_argshasattrerrorr rr2r)rargvrcfgrrrmains  zCommandLine.mainr8)rBrCrDrrJrrrrrrrIs  prIcKst|dj|ddS)z(The console runner function for Alembic.ry)rN)rIr)rrKrqrrrr,sr__main__)NN)argparserrr#rFr!rrrr util.compatrobjectr rIrrBrrrrs&