o Th@sddlZddlZddlZddlZddlmZddlmZddlmZm Z m Z ddlm Z ddl m Z mZmZmZmZmZmZddlmZdd lmZmZdd lmZdd lmZdd lmZmZzdd l m!Z!Wne"ywddl#m$Z!Ynwde%de%dee%e ffddZ&GdddZ'Gddde'Z(Gddde)Z*dee%e fdee%e fdee%e ffddZ+de,de,de*fd d!Z-d"e,de%fd#d$Z.d%ee%e fdee%e ffd&d'Z/d(ee%e fd)ee%d*fddfd+d,Z0dee%e fd-ee%e fddfd.d/Z1dS)0N)spec_from_loader)PathLike)joinsplitext expanduser) ModuleType)AnyDictIteratorOptionalTupleTypeUnion) Environment)UnknownFileTypeUnpicklableConfigMember)Local)WINDOWS)debugyaml)SourceFileLoader)_SourceFileLoadernamepathreturncCs@tj|siStd|}td}td||_||t|S)Nmod) osrexistsrrr__spec__ exec_modulevars)rrloaderrr#@/var/www/html/venv/lib/python3.10/site-packages/invoke/config.py load_sources    r%c seZdZdZededddDZedefdee e fde dd e e d fd dfd d Z de d e fddZde de d dffdd Zd eee e ffddZded efddZd efddZde de d dfddZde d e fddZde d e fdd Zd!e d"e d dfd#d$Zd e fd%d&Zde d efd'd(Zed efd)d*Zed efd+d,Zde d dfd-d.Z de de d dfd/d0Z!de d dfd1d2Z"d3e d dfd4d5Z#d@d6d7Z$d!e d e fd8d9Z%d e fd:d;Z&d!e d e fdd?Z(Z)S)A DataProxya Helper class implementing nested dict+attr access for `.Config`. Specifically, is used both for `.Config` itself, and to wrap any other dicts assigned as config values (recursively). .. warning:: All methods (of this object or in subclasses) must take care to initialize new attributes via ``self._set(name='value')``, or they'll run into recursion errors! .. versionadded:: 1.0 z get has_key items iteritems iterkeys itervalues keys values ccs|]}d|VqdS)z__{}__N)format.0xr#r#r$ As  zDataProxy.z> cmp contains iter sizeof Ndatarootkeypath.rcCs.|}|j|d|j|d|j|d|S)a  Alternate constructor for 'baby' DataProxies used as sub-dict values. Allows creating standalone DataProxy objects while also letting subclasses like `.Config` define their own ``__init__`` without muddling the two. :param dict data: This particular DataProxy's personal data. Required, it's the Data being Proxied. :param root: Optional handle on a root DataProxy/Config which needs notification on data updates. :param tuple keypath: Optional tuple describing the path of keys leading to this DataProxy's location inside the ``root`` structure. Required if ``root`` was given (and vice versa.) .. versionadded:: 1.0 _config)_root)_keypath_set)clsr,r-r.objr#r#r$ from_dataLs    zDataProxy.from_datakeyc Csz||WStyB||jvrt|j|YSd|}ddt|jD}|dtt |j 7}|d|7}t |w)Nz)No attribute or config key found for {!r}cSsg|] }|ds|qS)_) startswithr(r#r#r$ |sz)DataProxy.__getattr__..z Valid keys: {!r}z Valid real attributes: {!r}) _getKeyError_proxiesgetattrr0r'dir __class__sortedlistkeysAttributeError)selfr8errattrsr#r#r$ __getattr__os    zDataProxy.__getattr__valuecs.|t|v}|s|||<dSt||dSN)r@super __setattr__)rFr8rJ has_real_attrrAr#r$rMs  zDataProxy.__setattr__cC t|jSrK)iterr0rFr#r#r$__iter__s zDataProxy.__iter__othercCs(t|dd}t|tr |}t|j|kS)Nr0)r? isinstancedictboolr0)rFrT other_valr#r#r$__eq__s  zDataProxy.__eq__cCrPrK)lenr0rRr#r#r$__len__ zDataProxy.__len__cCs||j|<|||dSrK)r0_track_modification_of)rFr8rJr#r#r$ __setitem__s zDataProxy.__setitem__cCs ||SrK)r<rFr8r#r#r$ __getitem__r\zDataProxy.__getitem__cCs^|dvrt||j|}t|tr-|f}t|dr|j|}t|d|}tj|||d}|S)N) __setstate__r2r1)r,r-r.) rEr0rUrVhasattrr2r?r&r7)rFr8rJr.r-r#r#r$r<s     zDataProxy._getargskwargscOs:|r tj|g|R|D] \}}t|||qdS)a Convenience workaround of default 'attrs are config keys' behavior. Uses `object.__setattr__` to work around the class' normal proxying behavior, but is less verbose than using that directly. Has two modes (which may be combined if you really want): - ``self._set('attrname', value)``, just like ``__setattr__`` - ``self._set(attname=value)`` (i.e. kwargs), even less typing. N)objectrMitems)rFrcrdr8rJr#r#r$r4s  zDataProxy._setcCsd|jj|jS)Nz<{}: {}>)r'rA__name__r0rRr#r#r$__repr__szDataProxy.__repr__cCs ||jvSrKr/r_r#r#r$ __contains__r\zDataProxy.__contains__cC t|dS)Nr1rbrRr#r#r$_is_leaf zDataProxy._is_leafcCrj)N_modifyrkrRr#r#r$_is_rootrmzDataProxy._is_rootcCsBd}|jr |j}n|jr|}|dur|t|dt|dSdSNr2)rlr1ro_remover?tuple)rFr8targetr#r#r$_track_removal_ofszDataProxy._track_removal_ofcCsDd}|jr |j}n|jr|}|dur |t|dt||dSdSrp)rlr1rornr?rr)rFr8rJrsr#r#r$r]sz DataProxy._track_modification_ofcCs|j|=||dSrK)r0rtr_r#r#r$ __delitem__szDataProxy.__delitem__rcCs"||vr ||=dSt||dSrK)re __delattr__)rFrr#r#r$rvs zDataProxy.__delattr__cCs t|}|D]}||=qdSrK)rCrD)rFrDr8r#r#r$clears zDataProxy.clearcGs8|o|d|jv}|jj|}|s|S||d|SNr)r0poprt)rFrc key_existedretr#r#r$rys  z DataProxy.popcCs|j}||d|Srx)r0popitemrt)rFr{r#r#r$r|s zDataProxy.popitemcGs>|o|d|jv}|jj|}|r|S|\}}||||Srx)r0 setdefaultr])rFrcrzr{r8defaultr#r#r$r}s  zDataProxy.setdefaultcOst|r|D]\}}|||<qdS|r6|d}t|tr)|D]}||||<qdS|D] }|d||d<q+dSdS)Nrr)rfrUrV)rFrcrdr8rJargpairr#r#r$update)s  zDataProxy.updaterN)*rg __module__ __qualname____doc__rrsplitr> classmethodr strrr r r7rIrMr rSrerWrYintr[r^r`r<r4rhripropertyrlrortr]rurvrwryr|r}r __classcell__r#r#rOr$r&$s`     "     r&c@seZdZdZdZdZdZedee e ffddZ       dHde ee e fd e ee e fd e e d e e d e e d e e defddZdIddZdJdee e fdeddfddZdJdee e fdeddfddZdJdeddfddZdJdeddfddZdJdeddfddZd e e ddfd!d"ZdJdeddfd#d$ZdId%d&Z dJdee e fdeddfd'd(Zd ee e dfddfd)d*Z dKd+e d,ededdfd-d.Zd e de fd/d0ZeZd e de fd1d2Zd e dee e ffd3d4Z dId5d6Z!d7e d8e ddfd9d:Z"dLd;e e#dddfdd?Z%d@e&e dAfdBe dCe ddfdDdEZ'd@e&e dAfdBe ddfdFdGZ(dS)MConfigaT Invoke's primary configuration handling class. See :doc:`/concepts/configuration` for details on the configuration system this class implements, including the :ref:`configuration hierarchy `. The rest of this class' documentation assumes familiarity with that document. **Access** Configuration values may be accessed and/or updated using dict syntax:: config['foo'] or attribute syntax:: config.foo Nesting works the same way - dict config values are turned into objects which honor both the dictionary protocol and the attribute-access method:: config['foo']['bar'] config.foo.bar **A note about attribute access and methods** This class implements the entire dictionary protocol: methods such as ``keys``, ``values``, ``items``, ``pop`` and so forth should all function as they do on regular dicts. It also implements new config-specific methods such as `load_system`, `load_collection`, `merge`, `clone`, etc. .. warning:: Accordingly, this means that if you have configuration options sharing names with these methods, you **must** use dictionary syntax (e.g. ``myconfig['keys']``) to access the configuration data. **Lifecycle** At initialization time, `.Config`: - creates per-level data structures; - stores any levels supplied to `__init__`, such as defaults or overrides, as well as the various config file paths/filename patterns; - and loads config files, if found (though typically this just means system and user-level files, as project and runtime files need more info before they can be found and loaded.) - This step can be skipped by specifying ``lazy=True``. At this point, `.Config` is fully usable - and because it pre-emptively loads some config files, those config files can affect anything that comes after, like CLI parsing or loading of task collections. In the CLI use case, further processing is done after instantiation, using the ``load_*`` methods such as `load_overrides`, `load_project`, etc: - the result of argument/option parsing is applied to the overrides level; - a project-level config file is loaded, as it's dependent on a loaded tasks collection; - a runtime config file is loaded, if its flag was supplied; - then, for each task being executed: - per-collection data is loaded (only possible now that we have collection & task in hand); - shell environment data is loaded (must be done at end of process due to using the rest of the config as a guide for interpreting env var names.) At this point, the config object is handed to the task being executed, as part of its execution `.Context`. Any modifications made directly to the `.Config` itself after this point end up stored in their own (topmost) config level, making it easier to debug final values. Finally, any *deletions* made to the `.Config` (e.g. applications of dict-style mutators like ``pop``, ``clear`` etc) are also tracked in their own structure, allowing the config object to honor such method calls without mutating the underlying source data. **Special class attributes** The following class-level attributes are used for low-level configuration of the config system itself, such as which file paths to load. They are primarily intended for overriding by subclasses. - ``prefix``: Supplies the default value for ``file_prefix`` (directly) and ``env_prefix`` (uppercased). See their descriptions for details. Its default value is ``"invoke"``. - ``file_prefix``: The config file 'basename' default (though it is not a literal basename; it can contain path parts if desired) which is appended to the configured values of ``system_prefix``, ``user_prefix``, etc, to arrive at the final (pre-extension) file paths. Thus, by default, a system-level config file path concatenates the ``system_prefix`` of ``/etc/`` with the ``file_prefix`` of ``invoke`` to arrive at paths like ``/etc/invoke.json``. Defaults to ``None``, meaning to use the value of ``prefix``. - ``env_prefix``: A prefix used (along with a joining underscore) to determine which environment variables are loaded as the env var configuration level. Since its default is the value of ``prefix`` capitalized, this means env vars like ``INVOKE_RUN_ECHO`` are sought by default. Defaults to ``None``, meaning to use the value of ``prefix``. .. versionadded:: 1.0 invokeNrc Cstr tjdd}nd}iddddddddd d d d d id d dddd dd dd ddddddd|dddgidtid dd ddddd dd ddd id S)!a Return the core default settings for Invoke. Generally only for use by `.Config` internals. For descriptions of these values, see :ref:`default-values`. Subclasses may choose to override this method, calling ``Config.global_defaults`` and applying `.merge_dicts` to the result, to add to or modify these values. .. versionadded:: 1.0 COMSPECzcmd.exez /bin/bash asynchronousFdisowndryecho echo_stdinNencodingenv err_streamfallbackThide in_stream out_stream echo_formatz{command}pty replace_envshellwarnwatcherslocalz[sudo] password: )passwordpromptusertasks)auto_dash_namescollection_namededupeexecutor_classignore_unknown_help search_rootcommand)runrunnerssudortimeouts)rrenvirongetr)rr#r#r$global_defaultssl     zConfig.global_defaultsF overridesdefaults system_prefix user_prefixproject_location runtime_pathlazyc CsV|jid|jdd|durt|}|j|d|jid|dur*ts*d}|j|d|jdd |jdd |jid |durHd }|j|d |jdd|jdd|jid|||j}|duro|j}d|}|j|d|jid| ||duri}|j|d|jid|jid|s| | dS)a Creates a new config object. :param dict defaults: A dict containing default (lowest level) config data. Default: `global_defaults`. :param dict overrides: A dict containing override-level config data. Default: ``{}``. :param str system_prefix: Base path for the global config file location; combined with the prefix and file suffixes to arrive at final file path candidates. Default: ``/etc/`` (thus e.g. ``/etc/invoke.yaml`` or ``/etc/invoke.json``). :param str user_prefix: Like ``system_prefix`` but for the per-user config file. These variables are joined as strings, not via path-style joins, so they may contain partial file paths; for the per-user config file this often means a leading dot, to make the final result a hidden file on most systems. Default: ``~/.`` (e.g. ``~/.invoke.yaml``). :param str project_location: Optional directory path of the currently loaded `.Collection` (as loaded by `.Loader`). When non-empty, will trigger seeking of per-project config files in this directory. :param str runtime_path: Optional file path to a runtime configuration file. Used to fill the penultimate slot in the config hierarchy. Should be a full file path to an existing file, not a directory path or a prefix. :param bool lazy: Whether to automatically load some of the lower config levels. By default (``lazy=False``), ``__init__`` automatically calls `load_system` and `load_user` to load system and user config files, respectively. For more control over what is loaded when, you can say ``lazy=True``, and no automatic loading is done. .. note:: If you give ``defaults`` and/or ``overrides`` as ``__init__`` kwargs instead of waiting to use `load_defaults` or `load_overrides` afterwards, those *will* still end up 'loaded' immediately. r/)rymljsonpy)_file_suffixesN _defaults _collectionz/etc/)_system_prefix) _system_path) _system_found)_systemz~/.) _user_prefix) _user_path) _user_found)_userz{}_) _env_prefix_env _overrides)_modifications) _deletions) r4 copy_dictrrset_project_location env_prefixprefixr'upperset_runtime_pathload_base_conf_filesmerge) rFrrrrrrrrr#r#r$__init__sD B                     zConfig.__init__cCs|jdd|jdddS)NF)r) load_system load_userrRr#r#r$rs zConfig.load_base_conf_filesTr,rcC |j|d|r|dSdS)aZ Set or replace the 'defaults' configuration level, from ``data``. :param dict data: The config data to load as the defaults level. :param bool merge: Whether to merge the loaded data into the central config. Default: ``True``. :returns: ``None``. .. versionadded:: 1.0 rNr4rrFr,rr#r#r$ load_defaults  zConfig.load_defaultscCr)a\ Set or replace the 'overrides' configuration level, from ``data``. :param dict data: The config data to load as the overrides level. :param bool merge: Whether to merge the loaded data into the central config. Default: ``True``. :returns: ``None``. .. versionadded:: 1.0 rNrrr#r#r$load_overridesrzConfig.load_overridescC|jd|ddS)a Load a system-level config file, if possible. Checks the configured ``_system_prefix`` path, which defaults to ``/etc``, and will thus load files like ``/etc/invoke.yml``. :param bool merge: Whether to merge the loaded data into the central config. Default: ``True``. :returns: ``None``. .. versionadded:: 1.0 systemrrN _load_filerFrr#r#r$rzConfig.load_systemcCr)a Load a user-level config file, if possible. Checks the configured ``_user_prefix`` path, which defaults to ``~/.``, and will thus load files like ``~/.invoke.yml``. :param bool merge: Whether to merge the loaded data into the central config. Default: ``True``. :returns: ``None``. .. versionadded:: 1.0 rrNrrr#r#r$rrzConfig.load_usercCr)a Load a project-level config file, if possible. Checks the configured ``_project_prefix`` value derived from the path given to `set_project_location`, which is typically set to the directory containing the loaded task collection. Thus, if one were to run the CLI tool against a tasks collection ``/home/myuser/code/tasks.py``, `load_project` would seek out files like ``/home/myuser/code/invoke.yml``. :param bool merge: Whether to merge the loaded data into the central config. Default: ``True``. :returns: ``None``. .. versionadded:: 1.0 projectrNrrr#r#r$ load_projectszConfig.load_projectrcCs(|j|d|jid|jdddS)zR Set the runtime config file path. .. versionadded:: 1.0 ) _runtime_path)_runtimeN)_runtime_foundr3)rFrr#r#r$rs  zConfig.set_runtime_pathcCs|jdd|ddS)a Load a runtime-level config file, if one was specified. When the CLI framework creates a `Config`, it sets ``_runtime_path``, which is a full path to the requested config file. This method attempts to load that file. :param bool merge: Whether to merge the loaded data into the central config. Default: ``True``. :returns: ``None``. .. versionadded:: 1.0 runtimeT)rabsoluterNrrr#r#r$ load_runtimeszConfig.load_runtimecCsLtd|tdt|j|jd}|j|dtd|dS)a Load values from the shell environment. `.load_shell_env` is intended for execution late in a `.Config` object's lifecycle, once all other sources (such as a runtime config file or per-collection configurations) have been loaded. Loading from the shell is not terrifically expensive, but must be done at a specific point in time to ensure the "only known config keys are loaded from the env" behavior works correctly. See :ref:`env-vars` for details on this design decision and other info re: how environment variables are scanned and loaded. .. versionadded:: 1.0 z*Running pre-merge for shell env loading...zDone with pre-merge.)configrrz0Loaded shell environment, triggering final mergeN)rrrr0rr4load)rFr"r#r#r$load_shell_envs zConfig.load_shell_envcCs(td|j|d|r|dSdS)a( Update collection-driven config data. `.load_collection` is intended for use by the core task execution machinery, which is responsible for obtaining collection-driven data. See :ref:`collection-configuration` for details. .. versionadded:: 1.0 z Loading collection configurationrN)rr4rrr#r#r$load_collection+s   zConfig.load_collectioncCsJd}|dur t|d}|j|d|jdd|jdd|jiddS)z Set the directory path where a project-level config file may be found. Does not do any file loading on its own; for that, see `load_project`. .. versionadded:: 1.0 N)_project_prefix) _project_path)_project_found)_project)rr4)rFrproject_prefixr#r#r$r<s     zConfig.set_project_locationrrc sd|}d|}d|}|jdur|jt||dur"dS|r3t||}|dur/dS|g}nt|d|durAdSfdd|jD}|D]f} t| } z>zt| dd} t|d | } Wnty{d } t | | | |jw| || | | || | |d Wn"t y} z| j d krd }t || nWYd} ~ qNd} ~ wwt||dur| |ddS|r|dSdS)N _{}_found_{}_path_{}z _{}_prefixcsg|] }d|fqS).)rr(midfix path_prefixr#r$r;lsz%Config._load_file..rrz_load_{}zUConfig files of type {!r} (from file {!r}) are not supported! Please use one of: {!r}TzDidn't see any {}, skipping.F)r' file_prefixrr?rrrlstriprErr4IOErrorerrnorr)rFrrrfoundrr, absolute_pathpathsfilepathtype_r"msgerGr#rr$rRs`           zConfig._load_filecC6t| }t|WdS1swYdSrK)openr safe_loadrFrfdr#r#r$ _load_yaml $zConfig._load_yamlcCrrK)rrrrr#r#r$ _load_jsonrzConfig._load_jsoncCsRi}td|D]\}}|drq t|tjr"d}t|||||<q |S)Nr__z'{}' is a module, which can't be used as a config value. (Are you perhaps giving a tasks file instead of a config file by mistake?))r%rfr:rUtypesrrr')rFrr,r8rJrGr#r#r$_load_pys   zConfig._load_pycCstd|jidtd|jt|j|jtd|jt|j|j|dd|dd|d d td |jt|j|j|d d td|j t|j|j td|j t|j|j td|j t |j|j dS)zT Merge all config sources, in order. .. versionadded:: 1.0 z9Merging config sources in order onto new empty _config...r/zDefaults: {!r}zCollection-driven: {!r}rz System-widerzPer-userrz Per-projectz!Environment variable config: {!r}rRuntimezOverrides: {!r}zModifications: {!r}zDeletions: {!r}N) rr4r'r merge_dictsr0r _merge_filerrrr obliteraterRr#r#r$rs$     z Config.mergerdesccCs|d7}t|d|}t|d|}t|d|}|dur)td|dS|rsV   $     Y    ;"& *