o 8h@sddlmZddlmZddlmZddlmZddlZddlZddl m Z ddl Z ddl Z ddl mZddl mZdd l mZdd l mZdd l mZdd l mZdd l mZddl mZddl mZddl mZddlmZddlmZddlmZddlmZddlmZddlm Z GdddZ!ee"e"fZ#GdddeddZ$GdddeZ%Gd d!d!Z&  d-d.d*d+Z'e(d,kre'dSdS)/) annotations)ArgumentParser) Namespace) ConfigParserN)Path)Any)cast)Dict)Mapping)Optional)overload)Protocol)Sequence)TextIO)Union) TypedDict) __version__)command)util)compat)_preserving_path_as_strc@seZdZUdZddddejdedfdfddZdZ de d < dZ de d< dZ de d< e dgddZe dgddZdZde d< ejdhd!d"Zdid&d'Zejdjd)d*Zejdkd+d,Zdld-d.Zdmd0d1Ze 2dndod6d7Zedpd9d7Zedqdd7Zdtd@dAZdudBdCZdvdEdFZ drdwdGdHZedxdIdJZe drdydKdJZ drdydLdJZedxdMdNZe drdydOdNZ drdzdQdNZd{dSdTZ drd|dVdWZ!ejd}dYdZZ"d~d\d]Z#dd_d`Z$ddadbZ%ddddeZ&dS)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 programmatically, 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 if an ``alembic.ini`` is to be used. This should refer to the ``alembic.ini`` file, either as a filename or a full path to the file. This filename if passed must refer to an **ini file in ConfigParser format** only. :param toml\_file: name of the pyproject.toml file to open if a ``pyproject.toml`` file is to be used. This should refer to the ``pyproject.toml`` file, either as a filename or a full path to the file. This file must be in toml format. Both :paramref:`.Config.file\_` and :paramref:`.Config.toml\_file` may be passed simultaneously, or exclusively. .. versionadded:: 1.16.0 :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, as well as the pyproject.toml file, depending on which / both are used. The dictionary as given is **copied** to two new, independent dictionaries, stored locally under the attributes ``.config_args`` and ``.toml_args``. Both of these dictionaries will also be populated with the replacement variable ``%(here)s``, which refers to the location of the .ini and/or .toml file as appropriate. :param attributes: optional dictionary of arbitrary Python keys/values, which will be populated into the :attr:`.Config.attributes` dictionary. .. seealso:: :ref:`connection_sharing` Nalembicfile_"Union[str, os.PathLike[str], None] toml_file ini_sectionstr output_bufferOptional[TextIO]stdoutrcmd_optsOptional[Namespace] config_argsMapping[str, Any] attributesOptional[Dict[str, Any]]returnNonec Csh|rt|nd|_|rt|nd|_||_||_||_||_t||_t||_ |r2|j |dSdS)z Construct a new :class:`.Config`N) rconfig_file_nametoml_file_nameconfig_ini_sectionrr!r"dictr$ toml_argsr&update) selfrrrrr!r"r$r&r1V/var/www/html/figdemos/bartoux_crm/venv/lib/python3.10/site-packages/alembic/config.py__init__vs   zConfig.__init__ Optional[str]r*r+Optional[Path]cC|jdurdSt|jSN)r*rr0r1r1r2_config_file_path  zConfig._config_file_pathcCr6r7)r+rr8r1r1r2_toml_file_pathr:zConfig._toml_file_pathr,Dict[str, Any]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` r1r8r1r1r2r&szConfig.attributestextargrcGs8|r t||}nt|}tj|j|dfi|jdS)aRender 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. This is a no-op when the``quiet`` messaging option is enabled. e.g.:: >>> config.print_stdout('Some text %s', 'arg') Some Text arg  N)rrwrite_outstreamr!messaging_opts)r0r=r>outputr1r1r2 print_stdoutszConfig.print_stdoutrcCs\|jr |jj}nt}||jd<t|j}|jr&t||jg|S| |j |S)aReturn the underlying ``ConfigParser`` object. Dir*-ect 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) r9absoluteparentras_posixr$rrread_config_parser add_sectionr,)r0rD file_configr1r1r2rJs   zConfig.file_configcCs|jrI|jrI|jj}||jd<t|jd$}tj |}| di di}t |t s6t d|WdS1sBwYdSiS)zMReturn a dictionary of the [tool.alembic] section from pyproject.tomlrDrbZtoolrzIncorrect TOML formatN)r;existsrErFrGr.openrtomllibloadget isinstancer-r CommandError)r0rDfZ toml_datadatar1r1r2toml_alembic_configs    $zConfig.toml_alembic_configcCs$ddl}t|jj}t|dS)zReturn the directory where Alembic setup templates are found. This method is used by the alembic ``init`` and ``list_templates`` commands. rN templates)rr__file__rErFr)r0r package_dirr1r1r2get_template_directorys zConfig.get_template_directoryrcCs t|S)zReturn the directory where Alembic setup templates are found. This method is used by the alembic ``init`` and ``list_templates`` commands. .. versionadded:: 1.16.0 )rrYr8r1r1r2_get_template_paths zConfig._get_template_path.namedefaultOptional[Dict[str, str]]cCdSr7r1r0r[r\r1r1r2 get_section(zConfig.get_sectionDict[str, str]cCr^r7r1r_r1r1r2r`0raMapping[str, str](Union[Dict[str, str], Mapping[str, str]]cCr^r7r1r_r1r1r2r`5raOptional[Mapping[str, str]]cCs |j|s|St|j|S)zReturn all the configuration options from a given .ini file section as a dictionary. If the given section does not exist, the value of ``default`` is returned, which is expected to be a dictionary or other mapping. )rJ has_sectionr-itemsr_r1r1r2r`:s valuecCs||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,r0r[rhr1r1r2set_main_optionIszConfig.set_main_optioncCs|j|j|dSr7)rJ remove_optionr,)r0r[r1r1r2remove_main_optionZszConfig.remove_main_optionsectioncCs,|j|s |j||j|||dS)aWSet 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. Does **NOT** consume from the pyproject.toml file. .. seealso:: :meth:`.Config.get_alembic_option` - includes pyproject support :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)rJrfrIset)r0rnr[rhr1r1r2ri]s  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)rJrfrrRr* has_optionrP)r0rnr[r\r1r1r2get_section_option{s zConfig.get_section_optioncCr^r7r1r_r1r1r2get_main_optionzConfig.get_main_optioncCr^r7r1r_r1r1r2rrracCs||j||S)aReturn 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. Does **NOT** consume from the pyproject.toml file. .. seealso:: :meth:`.Config.get_alembic_option` - includes pyproject support )rqr,r_r1r1r2rrscCr^r7r1r_r1r1r2get_alembic_optionrszConfig.get_alembic_optioncCr^r7r1r_r1r1r2rtraFUnion[None, str, list[str], dict[str, str], list[dict[str, str]], int]cCs.|j|j|r|j|j|S|j||dS)aReturn an option from the "[alembic]" or "[tool.alembic]" section of the configparser-parsed .ini file (e.g. ``alembic.ini``) or toml-parsed ``pyproject.toml`` file. The value returned is expected to be None, string, list of strings, or dictionary of strings. Within each type of string value, the ``%(here)s`` token is substituted out with the absolute path of the ``pyproject.toml`` file, as are other tokens which are extracted from the :paramref:`.Config.config_args` dictionary. Searches always prioritize the configparser namespace first, before searching in the toml namespace. If Alembic was run using the ``-n/--name`` flag to indicate an alternate main section name, this is taken into account **only** for the configparser-parsed .ini file. The section name in toml is always ``[tool.alembic]``. .. versionadded:: 1.16.0 )r\)rJrpr,rP_get_toml_config_valuer_r1r1r2rtsboolcCsP|j|j|r|j|j|dkS|j|d}t|ts&td||S)NtrueFz*boolean value expected for TOML parameter ) rJrpr,rPrUrQrwrrRrjr1r1r2get_alembic_boolean_options z!Config.get_alembic_boolean_option Optional[Any]cst}j||}||ur|S|durkt|tr |j}|St|trG|r9t|dtr9fdd|D}|Stdfdd|D}|St|tr\tdfdd| D}|St|t rc|St d ||S) Nrcs"g|] }fdd|DqS)ci|] \}}||jqSr1r..0kvr8r1r2 z..)rg)r~Zdvr8r1r2 sz1Config._get_toml_config_value.. list[str]csg|]}|jqSr1r|)r~rr8r1r2rszdict[str, str]cr{r1r|r}r8r1r2rrz1Config._get_toml_config_value..z%unsupported TOML value type for key: ) objectrUrPrQrr.listr-rrgintrrR)r0r[r\Z USE_DEFAULTrhr1r8r2rvs>       zConfig._get_toml_config_valueMessagingOptionsc Cstttdt|jddiS)zThe messaging options.quietF)rrr immutabledictgetattrr"r8r1r1r2rAs zConfig.messaging_optsnamesc Gs|D] }||}|durnqdSddtjddd}z||}Wnty6}z td||f|d}~ww|dkr@td|S) N r?:;)spacenewlineosrrzM'%s' is not a valid value for %s; expected 'space', 'newline', 'os', ':', ';'version_path_separatorz[The version_path_separator configuration parameter is deprecated; please use path_separator)rrrpathsepKeyError ValueErrorrwarn_deprecated)r0rr[ separatorZ split_on_pathsepker1r1r2_get_file_separator_chars:  zConfig._get_file_separator_charOptional[list[str]]cCsp|jj|jddd}|r/|dd}|dur%tdtd}||Sdd||DSt d | ddS) Nversion_locationsfallbackpath_separatorrzNo path_separator found in configuration; falling back to legacy splitting on spaces/commas for version_locations. Consider adding path_separator=os to Alembic config. , *|(?: +)cSg|]}|r|qSr1stripr~xr1r1r2r@ z5Config.get_version_locations_list..r rJrPr,rrrrecompilesplitrrv)r0Zversion_locations_str split_char_split_on_space_commar1r1r2get_version_locations_list(s(   z!Config.get_version_locations_listcCsn|jj|jddd}|r.|d}|dur$tdtd}||Sdd||DSt d| ddS) Nprepend_sys_pathrrzNo path_separator found in configuration; falling back to legacy splitting on spaces, commas, and colons for prepend_sys_path. Consider adding path_separator=os to Alembic config.z , *|(?: +)|\:cSrr1rrr1r1r2r`rz5Config.get_prepend_sys_paths_list..rr)r0Zprepend_sys_path_strrZ_split_on_space_comma_colonr1r1r2get_prepend_sys_paths_listKs$    z!Config.get_prepend_sys_paths_listlist[PostWriteHookConfig]csg}|jds(td|dg}|D]}t|}|d|d<||q|Std}| di| dd}|D]sCq>fdd D}|d<||q>|S) Npost_write_hookszlist[dict[str, str]]r[ _hook_namerhookscs4i|]}|dr|tdd|qS).rN) startswithlen)r~keyZini_hook_configr[r1r2rs  z)Config.get_hooks_list..) rJrfrrvr-popappendrrr`rrP)r0rZtoml_hook_configcfgoptsrrr1rr2get_hooks_listks2       zConfig.get_hooks_list)rrrrrrrr r!rr"r#r$r%r&r'r(r))r(r5)r(r<)r=rr>rr(r))r(r)r(r%)r(r)r(r).)r[rr\r)r(r])r[rr\rbr(rb)r[rr\rcr(rdr7)r[rr\rer(re)r[rrhrr(r))r[rr(r))rnrr[rrhrr(r))rnrr[rr\r4r(r4)r[rr\rr(r)r[rr\r4r(r4)r[rr\r4r(ru)r[rr(rw)r[rr\rzr(ru)r(r)rrr(r4)r(r)r(r)'__name__ __module__ __qualname____doc__sysr!rrr3r"__annotations__r*r+propertyr9r;r,memoized_propertyr&rCrJrUrYrZr r`rkrmrirqrrrtryrvrArrrrr1r1r1r2rs X                       ! %  # rc@seZdZUded<dS)rrwrN)rrrrr1r1r1r2rs rF)totalc@s$eZdZUdZded<d d d Zd S)CommandFunctionzA function that may be registered in the CLI as an alembic command. It must be a named function and it must accept a :class:`.Config` object as the first argument. .. versionadded:: 1.15.3 rrconfigrargsrkwargsr(cOr^r7r1)r0rrrr1r1r2__call__szCommandFunction.__call__N)rrrrrrr(r)rrrrrrr1r1r1r2rs rc @seZdZUdZdidjddZid d d ed ed dfdddeeddfddedddfddeeddfddeeddfdd edd!dfd"d#ed$d%dfd&d'eed(dfd)d*eed+dfd,d-eed.dfd/d0d1edd2dfd3d4edd5dfd6d7edd8dfd9d:d;edd?d@eddAdfdBdCeddDdfdEdFeddGdfZedHdIedJdIedKdLdMdNZe j dOdPiiZ dQe dR<djdSdTZ dkdWdXZdldZd[Zdmd`daZdndcddZdidodgdhZdS)p CommandLinez/Provides the command line interface to Alembic.Nprogr4r(r)cCs||dSr7)_generate_args)r0rr1r1r2r3szCommandLine.__init__templatez-tz --templateZgenericz"Setup template for use with 'init')r\typehelpmessagez-mz --messagez%Message string to use with 'revision')rrsqlz--sql store_truez\Don't emit SQL to database - dump to standard output/file instead. See docs on offline mode.actionrtagz--tagz@head to base new revision on.splicez--splicez6Allow a non-head revision as the 'head' to splice onto depends_onz --depends-onrzNSpecify 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 directoryrzrevision identifier+z/one or more revisions, or 'heads' for all heads)nargsr) directoryrevision revisionsrrzdict[Any, dict[str, str]]_POSITIONAL_TRANSLATIONScCst|d}|jdddtd|jdddd d |jd d td dd|jdddd |jdddd |jddddd ||_ddddttDD}|D]}||qP||_ dS)Nrz --versionversionz %%(prog)s %s)rrz-cz--configrzAlternate config file; defaults to value of ALEMBIC_CONFIG environment variable, or "alembic.ini". May also refer to pyproject.toml file. May be specified twice to reference both files separatelyrz-nz--namerzfName of section in .ini file to use for Alembic config (only applies to configparser config, not toml))rr\rz-xzlAdditional arguments consumed by custom env.py scripts, e.g. -x setting1=somesetting -x setting2=somesettingz --raiseerrrz!Raise a full stack trace on errorz-qz--quietzDo not log to std output.css<|]}t|r|jddkr|jdkrtt|VqdS)r_zalembic.commandN)inspect isfunctionrrrr)r~fnr1r1r2 es z-CommandLine._generate_args..css|]}tt|VqdSr7)rrr~r[r1r1r2rgs) r add_argumentrradd_subparsers subparsersdirrregister_commandparser)r0rrZalembic_commandsrr1r1r2r:sP      zCommandLine._generate_argsrrc Cs||\}}}|jj|j|d}|j|||fd|D]}||jvr;|j|}|dd|d}} |j|i| q|D]}|j|i} |j|fi| q>dS)a-Registers a function as a CLI subcommand. The subcommand name matches the function name, the arguments are extracted from the signature and the help text is read from the docstring. .. versionadded:: 1.15.3 .. seealso:: :ref:`custom_commandline` r)cmdrN) _inspect_functionr add_parserr set_defaults _KWARGS_OPTSr_POSITIONAL_OPTSrP) r0r positionalkwarg help_textZ subparserr>Z kwarg_optrrr1r1r2rts   zCommandLine.register_commandtuple[Any, Any, str]c st}|ddur&|ddt|d }|dt|d d}n |ddd}g}jvr?fdd|D}j}|r\g}|dD]}|sSn||qKng}d|}|||fS)Nrrcsg|] }j||qSr1)rrPrrr0r1r2rsz1CommandLine._inspect_function..r?r) rinspect_getfullargspecrrrrrrjoin) r0rspecrrZhelp_ help_lineslinerr1r r2rs*      zCommandLine._inspect_functionrroptionsrc sj\}}}z||gfdd|DRifdd|DWdStjyF}zjr/tjt|fi|jWYd}~dSd}~ww)Ncsg|]}t|dqSr7rr~rrr1r2rsz'CommandLine.run_cmd..csi|] }|t|dqSr7rrrr1r2rsz'CommandLine.run_cmd..)rrrRraiseerrerrrrA)r0rrrrrer1rr2run_cmds  &zCommandLine.run_cmdtuple[str, str]c Cs|j}tjd}|rtj|dkr|}d}n |rd}|}nd}d}|s)||fSd}}|D]!}tj|dkrE|durBtd|}q/|durNtd|}q/|rU|n||r[|fS|fS)NZALEMBIC_CONFIGzpyproject.tomlz alembic.iniz'pyproject.toml indicated more than oncez"only one ini file may be indicated)rrenvironrPpathbasenamerrR) r0rrZalembic_config_envZdefault_pyproject_tomlZdefault_alembic_configtomlinir[r1r1r2_inis_from_configs@  zCommandLine._inis_from_configargvOptional[Sequence[str]]cCsV|j|}t|ds|jddS||\}}t|||j|d}|||dS)z6Executes the command line with the provided arguments.rztoo few arguments)rrrr"N)r parse_argshasattrerrorrrr[r)r0rrrrrr1r1r2mains  zCommandLine.mainr7)rr4r(r))rrr(r))rrr(r)rrrrr(r))rrr(r)rrr(r))rrrrr3r-rrrrstamprrrrrrrr#r1r1r1r2rs<     (/7?FM RYbjry  :   (rrrrr4rrr(r)cKst|dj|ddS)z(The console runner function for Alembic.r)rN)rr#)rrrr1r1r2r#sr#__main__)NN)rrrr4rrr(r))) __future__rargparserr configparserrrrpathlibrrrtypingrrr r r r r rrrtyping_extensionsrrrrrrZ util.pyfilesrrrPostWriteHookConfigrrrr#rr1r1r1r2sT                     tV