xj! ddlZddlZddlZddlZddlZddlZddlmZddlm Z m Z m Z m Z m Z mZmZmZddlmZmZmZmZddlmZmZddlmZmZmZmZddlmZm 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+GddZ,dS)N) import_module) TYPE_CHECKINGAnyDictListOptionalSequenceTupleType) CollectionConfigExecutorFilesystemLoader)completeprint_completion_script)CollectionNotFoundExit ParseErrorUnexpectedExit)ArgumentParser ParserContext)pty_size)debugenable_logginghelpline)Loader) ParseResult)Lexiconc$eZdZUdZded<dedfdZdedfdZeeed<d Z d e zZ d Z d e zZ d Z dFdeededdeedeedeeddeeddeeddeeedd fdZdGdZdHdedd fdZdIdeeededd fd Zdeeedd fd!ZdGd"ZdGd#ZdGd$ZdGd%Zdeeedd fd&Zedefd'Zedefd(Zedefd)Zedeefd*ZedJd,Z ede!fd-Z"dGd.Z#dGd/Z$dGd0Z%dGd1Z&d2e!d3e'ee(fdd fd4Z)de*fd5Z+dGd6Z,dedd fd7Z-dGd8Z.dGd9Z/dGd:Z0 dKd;ddZ3dLd@edefdAZ4 dLdBe5e1eeefd@edd fdCZ6dDe5e1eeefdd fdEZ7d S)MProgramau 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 rcorereturnrctdtdtdtddtdd td tdd td tddtdtddtdddtdd tdddtdtddtdddtd td!d"td#tdd$td%tdd&td'tdd(td)tdd*td+tdd,gS)-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.)rintboolstrselfs ?C:\Projects\Historical\venv\Lib\site-packages\invoke/program.py core_argszProgram.core_args0s .N    #Q     %9    $+     "8     #=     #;    A    #O    )J     *y    2`     3Z     "?     &-     (J     $5    s_ _ cttddtdtddtdd gS) 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.)rrJrLs rN task_argszProgram.task_argss` )7    $2     *K     rPargv NrD namespacer namebinary loader_classrexecutor_classr config_classr binary_namesc |dn||_||_||_||_||_g|_|pt |_|pt|_ |pt|_ 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) rDr]_name_binary _binary_namesrXrr`rrarrb) rMrDr]r^r_r`rarbrcs rN__init__zProgram.__init__shj%,Oyy "  ) (<,<,8(2FrPc8||_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)rbr-rLs rN create_configzProgram.create_configs'')) rPTmergecBi}|jdjrd|d<|jjjrd|d<|jjjr|jjj|d<|jjjrd|d<|jjjrd|d<i}d|jvr|jdjrd |d <i}|jd j}|r||d <i}|jd jrd}t j||d<t||||}|j |d |jjj} | tj dd} |j | |jd |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 rFTwarnrBr7r3r1rTFdeduper&commandrAz&Desired 'sudo.password' config value: password)runtaskssudotimeouts)rlNINVOKE_RUNTIME_CONFIG)argsvaluerBr7r3r1getpassdictr-load_overridesosenvirongetset_runtime_path load_runtimerl) rMrlrrrsrurprtprompt overrides runtime_paths rN update_configzProgram.update_config.s& 9[ ! ' CK 9=  CJ 9>  /)..CK 9>  CK 9=  CJ $) # # +(>(D ##E(O)-.4  *")HY  9/ 0 6 7=F&v66D SD8LLL  ""9E":::y'-  :>>*A4HHL $$\222   u ---  K         rPexitcH ||||||||dS#tttf$rX}td |t|trt|tjt|tr'|jr t|jtjt|tr(|jjrt|tjd|rkt|tr |jj}n4t|tr|j}nt|trd}tj|ntdYd}~dSYd}~dSd}~wt,$rtjdYdSwxYw)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)rk parse_coreparse_collection parse_tasks parse_cleanuprexecuterrrrformat isinstanceprintsysstderrmessageresultr7exitedcoderKeyboardInterrupt)rMrXrr4rs rNrrz Program.runcs(/     OOD ! ! !  ! ! # # #               LLNNNNNj1 M M M AHHKK L L L!Z(( *acj))))!T"" 2qy 2aicj1111!^,, 2 2acjb1111 Ma008?DD4((6DD:..DKLLLLLLLLL!    HQKKKKKK sB BH!)EG< > >    J 9. / 5  #i 9:@'    J   rPcN|jtd|j|_n`td|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>) r]rrRrwr*rx print_helprload_collection list_root list_depth list_formatscoped_collectionrLs rNrzProgram.parse_collections > % M   #nDOO M    y~#t++N!!!  " " ")-)-!!%rPc|jjj}|dur*td|t |r]||jjvr-d}t|||t td ||jj j}|jdj|_ |jdj|_ |rt|tr\||_ |j|}||_n2#t($r%d}t | |wxYw|t |jjjr:t-|j|j|j|j||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!r<r:zSub-collection '{}' not found!)r(r#initial_contextrRparserN)rwr*rxrrrrcontextsprint_task_helprrr8rrrrKrrRsubcollection_from_pathrKeyError list_tasksrrcr#r _make_parserrsr,no_tasks_given)rMhalpmsgrsubs rNrzProgram.parse_cleanups y~# 4<< < = = = OO   J  Gt{+++Oc $$T*** !!8!?!?!E!EFFFIN( 9]39)L17  )S)) 6!*6/AA)LLC-0D**666:Cszz)445556 OO   J 9  #  'Y $ 4?((**    z "$/"9 "    ! ! ! ! ! " " " "s =!D/EcVtd|t)NzVNo tasks specified for execution and no default task; printing global help as fallback)rrrrLs rNrzProgram.no_tasks_given(s. d     rPc|j}|jjj}|8|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.) rar-rs rpartitionrgetattrrRr#r)rMklass config_path module_path_ class_namemoduleexecutors rNrzProgram.execute/s#k'6  ")4)?)?)D)D &KJ#;//FFJ//E5$+tyAA$*%%%%rPc |/tj}td|nKt |t r6|}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})rrXrrrrKsplitrs rNrzProgram.normalize_argvIsx <8D 7>>tDD E E E E c " " H::< ! DNN$$ $D$''''rPcdtd|j|jpddS)N{} {}re)rrr^rDrLs rNrzProgram.print_versions- gnnTY (A BBCCCCCrPcXd}|jd}td|j|tdtdtd||j|j|dSdS)Nz-task1 [--task1-opts] ... taskN [--taskN-opts]z$ [--subcommand-opts] ...zUsage: {} [--core-opts] {}r@z Core options:)r]rrr_ print_columnsr help_tuplesr)rM usage_suffixs rNrzProgram.print_helpsF > %AL *11$+|LLMMM b  o b  4/;;==>>> > % OO      & %rPctdt|jd}||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_argvrXr#runparsed)rMrrs rNrzProgram.parse_core_argssu 3444 4TJJJ%%dim44 = cjjDI$67788888rPc|jdj}||j|}|jjj} ||\}}|j||jtj |||jj j |_dS#t$r,}td|jd}~wwxYw)zq Load a task collection based on parsed core args, or die trying. .. versionadded:: 1.0 rU)r-start) loaded_fromauto_dash_namesz%Can't find any collection named {!r}!N)rwrxr`r-rRloadset_project_location load_projectr from_modulersrrrrr^)rMrloader coll_namerparentr4s rNrzProgram.load_collections -(."";e#  I(.  O#[[33NFF K , ,V 4 4 4 K $ $ & & &(4" $ 1 ADOOO " O O O>EEafMMNN N OsA6B99 C/'C**C/contextnew_argscv|D]#\}}|jr|j|j|_$dSN)items got_value_valuerw)rMrrkeyargs rN_update_core_contextzProgram._update_core_contextsG!(( 6 6HC} 6+.: S!( 6 6rPc~t|j|j|jjjS)N)ignore_unknown_help)rr)rrrR to_contextsr-rsrrLs rNrzProgram._make_parsersD(_00$(K$5$I1    rPc||_td|j|j|jj}|d|_ | |jd|j j ||_ 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) rrrrrRrr#rpopcore_via_tasksrrwrs)rMrs rNrzProgram.parse_taskss''))  *11$/BBCCC'' (:;;$jjmm !!IaL4+>+C "     -44TZ@@AAAAArPc|jj|}|}tj|j|}d}|rdnd}t ||j||t dt d|rb| D]=}| rt |j |z.t d>t dn&t |j dzt dt d|r| |dSt |j dzt ddS)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) rrrinspectgetdocrRrrr_ splitlinesstripleading_indentr)rMr^ctxtuples docstringheaderoptslines rNrzProgram.print_task_helps`k"4(""N4?4#899 F!'/~~R fmmDKt44555 b  l  !,,..  ::<<$-45555"IIII "IIII $%. / / / "III j     v & & & & & $%. / / / "IIIIIrPc|j}|s)d}t||jt |d|jdS)Nz"No tasks found in collection '{}'!zlist_{})rrrr^rr)rMfocusrs rNrzProgram.list_tasks'sd& /6Cszz%*--.. . :i&&t'78899;;;;;rPcf||j}||dS)N)pairs _make_pairsrdisplay_with_columns)rMrs rN list_flatzProgram.list_flat1s5  !788 !!!.....rPcl||j}d}|||dS)Nz'*' denotes collection defaults)rextrar)rMrrs rN list_nestedzProgram.list_nested5s<  !7881 !!U!;;;;;rPcoll ancestorsc |g}g}t||jz}dd|D}t|jD] \}}||jk}|} tt|j t|j } |s|j r!d | } d| D} |j dkr ||r| dz } |j dkr8|r |j rdzfd| D} |r|r| d | r(d d | nd } | z| z} || t!|f"|jot|d z|jk} t|jD]\}|} |s|j rd | } | r9fddD}| d d |z } |j dkr(||| zt!fn4|j dkr)| r'||| zt!f| s0|||gz}|||S)Nrc3K|]}|VdSr.0xs rN z&Program._make_pairs..Cs" 6 6q 6 6 6 6 6 6rP.{}c8g|]}d|S)r)rrs rN z'Program._make_pairs..Os"<<cg|]}|zSr r )raliasprefixs rNrz'Program._make_pairs..^s???e6E>???rPrz ({})z, r@r c g|]C}t|dtt||DS)r)rrlen)rattrsubcolls rNrz'Program._make_pairs..lsYw--NN3ww'='=#>#>EErP)rs collectionsz [{}])r r )rindentjoinsortedrsrr,r8map transformaliasesrrrinsertappendrrrrextend)rMr r rr ancestor_pathr^task is_default displaynamer$ alias_strfulltruncatetalliesrecursed_pairsrrs @@rNrzProgram._make_pairs:s>  IY$+- 6 6I 6 6 666  !1!1!3!344 1 1JD$-JK3t~vdl/C/CDDEEG =DN =#ll;77 <EMtyy'9'9:::2IK')3D LL$/ 0 0 0 0?NI(:t'N#D$4$:$:$<$<== - -MD'K 8DN 8#ll;77  B 8 w~~dii.@.@AAA 8++ f{2HW4E4EFGGGG!V+++ mk98G;L;LMNNN -!%!1!1 I,>"2"" ^,,, rPc|jrtd|j}|}t t j|dS)Nz:The --list-depth option is not supported with JSON format!)rrr serializedrjsondumps)rMr datas rN list_jsonzProgram.list_jsonsZ ? L  %   djrPr@rc|j}|j}|rd|nd}d}|s|r8|rd|nd}|r|rdnd}d|||}d||}|jd}|S)N '{}'r@zdepth={}z; z ({}{}{})zAvailable{} tasks{} Subcommands)rrrr]) rMrrootdepth specifiertaildepthstrjoinertexts rNtask_list_openerzProgram.task_list_openers~,08GNN4(((b   ?E ?38@z((///bH#66TTBF%%h>>D$++It<< > % D rPrcl|j}td|||||jj}|rSd}|r*d|}d|}td||dSdS)Nz{}: )rr@r8rzDefault{} task: {} )rrrrArrr,)rMrrr:r,specifics rNrzProgram.display_with_columnss~ gnnT222??@@AAA 5!!!(0  DH 0">>$//,,w// (//'BB C C C C C  D DrPrcbtd|D}td|z |jz |jz dz }t j|}|D]\}}|d}||}|t|z }d|j ||dz|jdzf} |rHt| |dz|ddD]$} tdt| z| z%t| tddS)z Print tabbed columns from (name, help) ``tuples``. Useful for listing tasks + docstrings, flags + help strings, etc. .. versionadded:: 1.0 c3@K|]}t|dVdS)rN)rrs rNrz(Program.print_columns..s,33qQqT333333rPrr )widthNr@rZ) maxrleading_indent_width col_paddingtextwrap TextWrapperwraprr rrrstrip) rMr name_width desc_widthwrapperr^help_str help_chunks name_paddingspecchunks rNrzProgram.print_columnssi33F33333 JJqM ' (    &Z888$ % %ND(!,,x00K%D 1L77' 3&$s* D %d[^+,,,(_55E3T?e344445dkkmm$$$$ b rP)NNNNNNNN)r$N)T)NT)r$r r)r@)8__name__ __module__ __qualname____doc____annotations__rrOrWrKrHr indent_widthrrIrr rirkrJrrrrrrrrrpropertyr^rr_rcrwrrrrrrrrrrrrrrrrr rr6rAr rrr rPrNr"r" s   f 4 +f f f f P 4 +    : s)OOO//NL < FK"&,0" $155915,0_3_3#_3L)_3sm _3  _3 tH~. _3!j!12_3tH~._3tCy)_3 _3_3_3_3B * * * *3 3 43 43 3 3 3 jCCc+C$C$CCCCJxS 2t< 1 1 1 1H<"<"<"<"|&&&&48DI#64.6c666X6 C3 C C CX C....X.6d3i666X6!!!X! ( ( ( (X (DDDD     9 9 9 9OOOO: 6$ 604S#X 6  6 6 6 6 f    BBBB0CDB<<<<////<<<<*.CCCDI&C eC#&' ( CCCCJ    c3"HJDDeC#$678DADD DDDD"+uS(3-%789+ ++++++rPr")-ryrr3r|rrJ importlibrtypingrrrrrr r r r@r rrrcompletion.completerr exceptionsrrrrrrrr terminalsrutilrrrrrrr r"r rPrNrcs ######                    =<<<<<<<<<<<BBBBBBBBLLLLLLLLLLLL33333333331111111111######{{{{{{{{{{rP