o Th!@sddlZddlZddlZddlZddlZddlZddlmZddlm Z m Z m Z m Z m Z mZmZmZddlmZmZmZmZddlmZmZddlmZmZmZddlmZmZm Z m!Z!dd l"m#Z#dd l$m%Z%m&Z&m'Z'e rdd l(m)Z)dd lm*Z*dd l$m+Z+GdddZ,dS)N) import_module) TYPE_CHECKINGAnyDictListOptionalSequenceTupleType) CollectionConfigExecutorFilesystemLoader)completeprint_completion_script)Parser ParserContextArgument)UnexpectedExitCollectionNotFound ParseErrorExit)pty_size)debugenable_logginghelpline)Loader) ParseResult)Lexiconc@seZdZUdZded<dedfddZdedfdd Zeeed <d Z d e Z d Z d e Z dZ        dhdeededdeedeedeeddeeddeeddeeeddfddZdiddZdjd!eddfd"d#Zdkd eeed$eddfd%d&Zd eeeddfd'd(Zdid)d*Zdid+d,Zdid-d.Zdid/d0Zd eeeddfd1d2Zedefd3d4Zedefd5d6Zedefd7d8Zedeefd9d:Zedldd?Z"did@dAZ#didBdCZ$didDdEZ%didFdGZ&dHe!dIe'ee(fddfdJdKZ)de*fdLdMZ+didNdOZ,deddfdPdQZ-didRdSZ.didTdUZ/didVdWZ0 dmdXddYeeedee1eeeffdZd[Z2did\d]Z3dnd_edefd`daZ4 ^dndbe5e1eeefd_eddfdcddZ6dee5e1eeefddfdfdgZ7dS)oProgramau Manages top-level CLI invocation, typically via ``setup.py`` entrypoints. Designed for distributing Invoke task collections as standalone programs, but also used internally to implement the ``invoke`` program itself. .. seealso:: :ref:`reusing-as-a-binary` for a tutorial/walkthrough of this functionality. .. versionadded:: 1.0 rcorereturnrcCstdtddtdtdddtdd d td tdd dtd tdddtdtdddtddddtddd tddddtdtdddtddddtd td!d"dtd#tdd$dtd%tdd&dtd'tdd(dtd)tdd*dtd+tdd,dgS)-zd Return default core `.Argument` objects, as a list. .. versionadded:: 1.0 )command-timeoutTz7Specify a global command execution timeout, in seconds.)nameskindhelp)rFz:Print tab-completion candidates for given parse remainder.r%r&defaultr')configfz"Runtime configuration file to use.r%r')rdzEnable debug output.)dryRz!Echo commands instead of running.)echoez&Echo executed commands before running.)r'hTz$Show core or per-task help and exit.)r%optionalr')hidez*Set default value of run()'s 'hide' kwarg.)listlz8List available tasks, optionally limited to a namespace.) list-depthDrz3When listing tasks, only show the first INT levels.) list-formatFzbChange the display format used when listing tasks. Should be one of: flat (default), nested, json.flat)r%r'r))print-completion-scriptzIPrint the tab-completion script for your preferred shell (bash|zsh|fish).)prompt-for-sudo-passwordzCPrompt user at start of session for the sudo.password config value.)ptypz(Use a pty when executing shell commands.)versionVzShow version and exit.) warn-onlywz3Warn, instead of failing, when shell commands fail.) write-pyczEnable creation of .pyc files.)rintboolstrselfrKA/var/www/html/venv/lib/python3.10/site-packages/invoke/program.py core_args0szProgram.core_argscCs&tdddtdtdddtdd dgS) aU Return default task-related `.Argument` objects, as a list. These are only added to the core args in "task runner" mode (the default for ``invoke`` itself) - they are omitted when the constructor is given a non-empty ``namespace`` argument ("bundled namespace" mode). .. versionadded:: 1.0 ) collectioncz Specify collection name to load.r,) no-dedupeFzDisable task deduplication.r() search-rootrz4Change root directory used for finding task modules.)rrGrIrKrKrL task_argss zProgram.task_argsargv NrA namespacer namebinary loader_classrexecutor_classr config_classr binary_namesc CsR|durdn||_||_||_||_||_g|_|pt|_|p t|_ |p%t |_ dS)a^ Create a new, parameterized `.Program` instance. :param str version: The program's version, e.g. ``"0.1.0"``. Defaults to ``"unknown"``. :param namespace: A `.Collection` to use as this program's subcommands. If ``None`` (the default), the program will behave like ``invoke``, seeking a nearby task namespace with a `.Loader` and exposing arguments such as :option:`--list` and :option:`--collection` for inspecting or selecting specific namespaces. If given a `.Collection` object, will use it as if it had been handed to :option:`--collection`. Will also update the parser to remove references to tasks and task-related options, and display the subcommands in ``--help`` output. The result will be a program that has a static set of subcommands. :param str name: The program's name, as displayed in ``--version`` output. If ``None`` (default), is a capitalized version of the first word in the ``argv`` handed to `.run`. For example, when invoked from a binstub installed as ``foobar``, it will default to ``Foobar``. :param str binary: Descriptive lowercase binary name string used in help text. For example, Invoke's own internal value for this is ``inv[oke]``, denoting that it is installed as both ``inv`` and ``invoke``. As this is purely text intended for help display, it may be in any format you wish, though it should match whatever you've put into your ``setup.py``'s ``console_scripts`` entry. If ``None`` (default), uses the first word in ``argv`` verbatim (as with ``name`` above, except not capitalized). :param binary_names: List of binary name strings, for use in completion scripts. This list ensures that the shell completion scripts generated by :option:`--print-completion-script` instruct the shell to use that completion for all of this program's installed names. For example, Invoke's internal default for this is ``["inv", "invoke"]``. If ``None`` (the default), the first word in ``argv`` (in the invocation of :option:`--print-completion-script`) is used in a single-item list. :param loader_class: The `.Loader` subclass to use when loading task collections. Defaults to `.FilesystemLoader`. :param executor_class: The `.Executor` subclass to use when executing tasks. Defaults to `.Executor`; may also be overridden at runtime by the :ref:`configuration system ` and its ``tasks.executor_class`` setting (anytime that setting is not ``None``). :param config_class: The `.Config` subclass to use for the base config object. Defaults to `.Config`. .. versionchanged:: 1.2 Added the ``binary_names`` argument. Nunknown) rArY_name_binary _binary_namesrTrr\rr]r r^) rJrArYrZr[r\r]r^r_rKrKrL__init__sU  zProgram.__init__cCs||_dS)a Instantiate a `.Config` (or subclass, depending) for use in task exec. This Config is fully usable but will lack runtime-derived data like project & runtime config files, CLI arg overrides, etc. That data is added later in `update_config`. See `.Config` docstring for lifecycle details. :returns: ``None``; sets ``self.config`` instead. .. versionadded:: 1.0 N)r^r*rIrKrKrL create_configs zProgram.create_configTmergec Cs6i}|jdjr d|d<|jjjrd|d<|jjjr!|jjj|d<|jjjr*d|d<|jjjr3d|d<i}d|jvrD|jdjrDd |d <i}|jd j}|rR||d <i}|jd jrcd}t||d<t||||d}|jj |d d|jjj} | durt j dd} |j | |jjd d|r|jdSdS)as Update the previously instantiated `.Config` with parsed data. For example, this is how ``--echo`` is able to override the default config value for ``run.echo``. :param bool merge: Whether to merge at the end, or defer. Primarily useful for subclassers. Default: ``True``. .. versionadded:: 1.0 rCTwarnr?r4r0r.rPFdeduper#commandr>z&Desired 'sudo.password' config value: password)runtaskssudotimeouts)rfNINVOKE_RUNTIME_CONFIG)argsvaluer?r4r0r.getpassdictr*load_overridesosenvirongetset_runtime_path load_runtimerf) rJrfrkrlrnrirmprompt overrides runtime_pathrKrKrL update_config.s@         zProgram.update_configexitc CsLz ||||||||WdSttt fy}zht d |t |t r>t |tjdt |trN|jrNt |jtjdt |tr_|jjr_t |tjdd|rt |trk|jj}nt |trt|j}nt |t r{d}t|n t dWYd}~dSWYd}~dSd}~wtytdYdSw)a Execute main CLI logic, based on ``argv``. :param argv: The arguments to execute against. May be ``None``, a list of strings, or a string. See `.normalize_argv` for details. :param bool exit: When ``False`` (default: ``True``), will ignore `.ParseError`, `.Exit` and `.Failure` exceptions, which otherwise trigger calls to `sys.exit`. .. note:: This is mostly a concession to testing. If you're setting this to ``False`` in a production setting, you should probably be using `.Executor` and friends directly instead! .. versionadded:: 1.0 z-Received a possibly-skippable exception: {!r})filer=)rendr z3Invoked as run(..., exit=False), ignoring exceptionN)re parse_coreparse_collection parse_tasks parse_cleanupr}executerrrrformat isinstanceprintsysstderrmessageresultr4exitedcoder~KeyboardInterrupt)rJrTr~r1rrKrKrLrkcs<        z Program.runcCstd||||td|jdj t_|jjjr$t|jj jr3td| t |jdjrFt |jdj|j dt dS)Nzargv given to Program.run: {!r}zFinished parsing core argsrEz)Saw --version, printing version & exitingr<)shellr%)rrnormalize_argvparse_core_argsrprqrdont_write_bytecoderrA print_versionrrr_rJrTrKrKrLrs$     zProgram.parse_corecCsl|jdurtd|j|_ntd|jjjdur#td|t|d|_ d|_ d|_ |j|_ dS)z` Load a tasks collection & project-level config. .. versionadded:: 1.0 Nz;Program was given default namespace, not loading collectionz;No default namespace provided, trying to load one from diskTz8No bundled namespace & bare --help given; printing help.r;) rYrrNrpr'rq print_helprload_collection list_root list_depth list_formatscoped_collectionrIrKrKrLrs&   zProgram.parse_collectioncCs&|jjj}|durtd|t|r/||jjvr(d}t|||tt d ||jj j}|jdj|_ |jdj|_ |rnt|trh||_z |j|}||_Wntygd}t| |w|t|jjjrt|j|j|j|j|d|js|jjs|d Sd Sd S) zo Post-parsing, pre-execution steps such as --help, --list, etc. .. versionadded:: 1.0 Tz(Saw bare --help, printing help & exitingz7Saw --help , printing per-task help & exitingzNo idea what '{}' is!r9r7zSub-collection '{}' not found!)r%r!initial_contextrNparserN)rpr'rqrrrrcontextsprint_task_helprrr5rrrrHrrNsubcollection_from_pathrKeyError list_tasksrr_r!r _make_parserrlr)no_tasks_given)rJhalpmsgrsubrKrKrLrsL          zProgram.parse_cleanupcCstd|t)NzVNo tasks specified for execution and no default task; printing global help as fallback)rrrrIrKrKrLr(s zProgram.no_tasks_givencCs\|j}|jjj}|dur|d\}}}t|}t||}||j|j|j}|j|jdS)a Hand off data & tasks-to-execute specification to an `.Executor`. .. note:: Client code just wanting a different `.Executor` subclass can just set ``executor_class`` in `.__init__`, or override ``tasks.executor_class`` anywhere in the :ref:`config system ` (which may allow you to avoid using a custom Program entirely). .. versionadded:: 1.0 N.) r]r*rl rpartitionrgetattrrNr!r)rJklass config_path module_path_ class_namemoduleexecutorrKrKrLr/s  zProgram.executecCsH|durtj}td|nt|tr|}td|||_dS)a Massages ``argv`` into a useful list of strings. **If None** (the default), uses `sys.argv`. **If a non-string iterable**, uses that in place of `sys.argv`. **If a string**, performs a `str.split` and then executes with the result. (This is mostly a convenience; when in doubt, use a list.) Sets ``self.argv`` to the result. .. versionadded:: 1.0 Nz#argv was None; using sys.argv: {!r}z%argv was string-like; splitting: {!r})rrTrrrrHsplitrrKrKrLrIs  zProgram.normalize_argvcCs|jp|jS)zi Derive program's human-readable name based on `.binary`. .. versionadded:: 1.0 )rar[ capitalizerIrKrKrLrZ`sz Program.namecCs|jr tj|jdSdS)z Returns the program name we were actually called as. Specifically, this is the (Python's os module's concept of a) basename of the first argument in the parsed argument vector. .. versionadded:: 1.2 rr=)rTrupathbasenamerIrKrKrL called_asis zProgram.called_ascCs |jp|jS)zu Derive program's help-oriented binary name(s) from init args & argv. .. versionadded:: 1.0 )rbrrIrKrKrLr[v zProgram.binarycCs|jp|jgS)zv Derive program's completion-oriented binary name(s) from args & argv. .. versionadded:: 1.2 )rcrrIrKrKrLr_szProgram.binary_namesrcCs |jdjS)zj Obtain core program args from ``self.core`` parse result. .. versionadded:: 1.0 r)r!rprIrKrKrLrprz Program.argscCs(|}|jdur||7}t|dS)z The initial parser context, aka core program flags. The specific arguments contained therein will differ depending on whether a bundled namespace was specified in `.__init__`. .. versionadded:: 1.0 N)rp)rMrYrSr)rJrprKrKrLrs   zProgram.initial_contextcCstd|j|jp ddS)N{} {}r`)rrrZrArIrKrKrLrszProgram.print_versioncCsfd}|jdur d}td|j|tdtdtd||j|jdur1|dSdS)Nz-task1 [--task1-opts] ... taskN [--taskN-opts]z$ [--subcommand-opts] ...zUsage: {} [--core-opts] {}r=z Core options:)rYrrr[ print_columnsr help_tuplesr)rJ usage_suffixrKrKrLrs   zProgram.print_helpcCsJtdt|jdd}||jdd|_d}t||j|jjdS)z Filter out core args, leaving any tasks or their args for later. Sets ``self.core`` to the `.ParseResult` from this step. .. versionadded:: 1.0 z#Parsing initial context (core args)T)initialignore_unknownr Nz-Core-args parse result: {!r} & unparsed: {!r})rrr parse_argvrTr!runparsed)rJrrrKrKrLrs zProgram.parse_core_argsc Cs|jdj}|j|j|d}|jjj}z!||\}}|j||jtj |||jj j d|_WdSt yH}zt d|jd}~ww)zq Load a task collection based on parsed core args, or die trying. .. versionadded:: 1.0 rQ)r*start) loaded_fromauto_dash_namesz%Can't find any collection named {!r}!N)rprqr\r*rNloadset_project_location load_projectr from_modulerlrrrrrZ)rJrloader coll_namerparentr1rKrKrLrs$    zProgram.load_collectioncontextnew_argscCs*|D]\}}|jr|j|j|_qdSN)items got_value_valuerp)rJrrkeyargrKrKrL_update_core_contexts zProgram._update_core_contextcCst|j|jj|jjjddS)N)ignore_unknown_help)rr)rrrN to_contextsr*rlrrIrKrKrLrs zProgram._make_parsercCsh||_td|j|j|jj}|d|_ |j |jd|j j d||_ td|j dS)a Parse leftover args, which are typically tasks & per-task args. Sets ``self.parser`` to the parser used, ``self.tasks`` to the parsed per-task contexts, and ``self.core_via_tasks`` to a context holding any core flags seen within the task contexts. Also modifies ``self.core`` to include the data from ``core_via_tasks`` (so that it correctly reflects any supplied core flags regardless of where they appeared). .. versionadded:: 1.0 zParsing tasks against {!r}r)rrzResulting task contexts: {!r}N) rrrrrNrr!rpopcore_via_tasksrrprl)rJrrKrKrLrs  zProgram.parse_taskscCs|jj|}|}t|j|}d}|rdnd}t||j||tdtd|rJ| D]}| r@t|j |q2tdq2tdn t|j dtdtd|rb| |dSt|j dtddS)zp Print help for a specific task, e.g. ``inv --help ``. .. versionadded:: 1.0 z3Usage: {} [--core-opts] {} {}[other tasks here ...]z [--options] r=z Docstring:nonezOptions:N) rrrinspectgetdocrNrrr[ splitlinesstripleading_indentr)rJrZctxtuples docstringheaderoptslinerKrKrLrs*      zProgram.print_task_helpcCs6|j}|sd}t||jt|d|jdS)Nz"No tasks found in collection '{}'!zlist_{})rrrrZrr)rJfocusrrKrKrLr's zProgram.list_taskscCs||j}|j|ddS)N)pairs _make_pairsrdisplay_with_columns)rJrrKrKrL list_flat1s zProgram.list_flatcCs"||j}d}|j||ddS)Nz'*' denotes collection defaults)rextrar)rJrrrKrKrL list_nested5s zProgram.list_nestedcoll ancestorscs|durg}g}t||j}ddd|D}t|jD]r\}}||jk}|} tt|j t|j } |s;|j rGd | } dd| D} |j dkrT||rT| d7} |j d krw|rd|j rddfd d| D} |rw|rw| d | rd d | nd} | | } || t|fq |jot|d|jk} t|jD]Y\}|} |s|j rd | } | rˇfdddD}| d d |7} |j dkr||| tfn|j d kr| r||| tf| s|j||gd}||q|S)Nrcss|]}|VqdSrrK.0xrKrKrL Csz&Program._make_pairs...{}cSsg|]}d|qS)r)rrrKrKrL Osz'Program._make_pairs..nested*r;csg|]}|qSrKrK)ralias)prefixrKrLr^srz ({})z, r=r cs,g|]}t|rdtt||qS)r)rrlen)rattr)subcollrKrLrls )rl collectionsz [{}])rr)rindentjoinsortedrlrr)r5map transformaliasesrrrinsertappendrrrrextend)rJrrrr ancestor_pathrZtask is_default displaynamer alias_strfulltruncatetalliesrecursed_pairsrK)rrrLr:s^              zProgram._make_pairscCs.|jrtd|j}|}tt|dS)Nz:The --list-depth option is not supported with JSON format!)rrr serializedrjsondumps)rJrdatarKrKrL list_jsonszProgram.list_jsonr=rc Csx|j}|j}|r d|nd}d}|s|r-|rd|nd}|r$|r$dnd}d|||}d||}|jdur:d}|S)N '{}'r=zdepth={}z; z ({}{}{})zAvailable{} tasks{} Subcommands)rrrrY) rJrrootdepth specifiertaildepthstrjoinertextrKrKrLtask_list_openers  zProgram.task_list_openerrcCsf|j}td|j|d|||jj}|r1d}|r'd|}d|}td||dSdS)Nz{}: )rr=rrzDefault{} task: {} )rrrrrrr))rJrrrr)specificrKrKrLrs   zProgram.display_with_columnsrc Cstdd|D}td||j|jd}tj|d}|D]H\}}|dur*d}||}|t|}d|j ||d|jdf} |rbt | |d|ddD] } t dt| | qTq t | q t ddS) z Print tabbed columns from (name, help) ``tuples``. Useful for listing tasks + docstrings, flags + help strings, etc. .. versionadded:: 1.0 css|] }t|dVqdS)rN)rrrKrKrLrsz(Program.print_columns..rr )widthNr=rV) maxrleading_indent_width col_paddingtextwrap TextWrapperwraprrrrrstrip) rJr name_width desc_widthwrapperrZhelp_str help_chunks name_paddingspecchunkrKrKrLrs>       zProgram.print_columns)NNNNNNNN)r"N)T)NT)r"rr)r=)8__name__ __module__ __qualname____doc____annotations__rrMrSrHrr indent_widthrr rr rdrerGr}rkrrrrrrpropertyrZrr[r_rprrrrrrrrrrrrrrrrr rrrrrrrKrKrKrLr s  h      a 5E  $ >          !   E r )-rrrrrurr! importlibrtypingrrrrrrr r r=r r rrcompletion.completerrrrrr exceptionsrrrr terminalsrutilrrrrrrrr rKrKrKrLs& (