xjEeddlZddlZddlmZddlmZddlmZddlmZm Z m Z m Z m Z m Z ddlmZddlmZmZdd lmZmZmZdd lmZmZdd lmZGd d eZGddeZdS)N)contextmanager)cycle)PathLike)Any GeneratorIteratorListOptionalUnion)Mock)Config DataProxy) AuthFailureFailureResponseNotAccepted)ResultRunner)FailingResponderceZdZUdZeeed<eeed<eed< ddeededdfd Z e defd Z e j d eddfd Z d ede defdZddd ede defdZd ede defdZddd ede defdZd edefdZed ededfdZe defdZedeeefdedfdZdS)Contexta  Context-aware API wrapper & state-passing object. `.Context` objects are created during command-line parsing (or, if desired, by hand) and used to share parser and configuration state with executed tasks (see :ref:`why-context`). Specifically, the class offers wrappers for core API calls (such as `.run`) which take into account CLI parser flags, configuration files, and/or changes made at runtime. It also acts as a proxy for its `~.Context.config` attribute - see that attribute's documentation for details. Instances of `.Context` may be shared between tasks when executing sub-tasks - either the same context the caller was given, or an altered copy thereof (or, theoretically, a brand new one). .. versionadded:: 1.0 command_prefixes command_cwds remainderNconfigreturnc\||n t}||gg|dS)a+ :param config: `.Config` object to use as the base configuration. Defaults to an anonymous/default `.Config` instance. :param remainder: The invoking program's :ref:`parser remainder ` value, if any was obtained. N)_configrrr)r_set)selfrrs ?C:\Projects\Historical\venv\Lib\site-packages\invoke/context.py__init__zContext.__init__;sG"-688       c|jS)a The fully merged `.Config` object appropriate for this context. `.Config` settings (see their documentation for details) may be accessed like dictionary keys (``c.config['foo']``) or object attributes (``c.config.foo``). As a convenience shorthand, the `.Context` object proxies to its ``config`` attribute in the same way - e.g. ``c['foo']`` or ``c.foo`` returns the same value as ``c.config['foo']``. r)r!s r"rzContext.configRs |r$valuec2||dS)Nr&)r )r!r's r"rzContext.configcs %      r$commandkwargsc ^|jj|}|j||fi|S)a Execute a local shell command, honoring config options. Specifically, this method instantiates a `.Runner` subclass (according to the ``runner`` config option; default is `.Local`) and calls its ``.run`` method with ``command`` and ``kwargs``. See `.Runner.run` for details on ``command`` and the available keyword arguments. .. versionadded:: 1.0 )rrunnerslocal_runr!r)r*runners r"runz Context.runls8$**400ty33F333r$r0rc H||}|j|fi|SN)_prefix_commandsr1)r!r0r)r*s r"r.z Context._runs/''00vz',,V,,,r$c ^|jj|}|j||fi|S)a Execute a shell command via ``sudo`` with password auto-response. **Basics** This method is identical to `run` but adds a handful of convenient behaviors around invoking the ``sudo`` program. It doesn't do anything users could not do themselves by wrapping `run`, but the use case is too common to make users reinvent these wheels themselves. .. note:: If you intend to respond to sudo's password prompt by hand, just use ``run("sudo command")`` instead! The autoresponding features in this method will just get in your way. Specifically, `sudo`: * Places a `.FailingResponder` into the ``watchers`` kwarg (see :doc:`/concepts/watchers`) which: * searches for the configured ``sudo`` password prompt; * responds with the configured sudo password (``sudo.password`` from the :doc:`configuration `); * can tell when that response causes an authentication failure (e.g. if the system requires a password and one was not configured), and raises `.AuthFailure` if so. * Builds a ``sudo`` command string using the supplied ``command`` argument, prefixed by various flags (see below); * Executes that command via a call to `run`, returning the result. **Flags used** ``sudo`` flags used under the hood include: - ``-S`` to allow auto-responding of password via stdin; - ``-p `` to explicitly state the prompt to use, so we can be sure our auto-responder knows what to look for; - ``-u `` if ``user`` is not ``None``, to execute the command as a user other than ``root``; - When ``-u`` is present, ``-H`` is also added, to ensure the subprocess has the requested user's ``$HOME`` set properly. **Configuring behavior** There are a couple of ways to change how this method behaves: - Because it wraps `run`, it honors all `run` config parameters and keyword arguments, in the same way that `run` does. - Thus, invocations such as ``c.sudo('command', echo=True)`` are possible, and if a config layer (such as a config file or env var) specifies that e.g. ``run.warn = True``, that too will take effect under `sudo`. - `sudo` has its own set of keyword arguments (see below) and they are also all controllable via the configuration system, under the ``sudo.*`` tree. - Thus you could, for example, pre-set a sudo user in a config file; such as an ``invoke.json`` containing ``{"sudo": {"user": "someuser"}}``. :param str password: Runtime override for ``sudo.password``. :param str user: Runtime override for ``sudo.user``. .. versionadded:: 1.0 )rr,r-_sudor/s r"sudoz Context.sudos9J$**400tz&'44V444r$c |jjj}|d|jjj}|d|jjj}|di}d}|d|}d} |r:dd| } | |}d|| ||} ttj |d |d } |d t|jjj} | |  |j| fd | i|S#t$$r8} t'| jt*rt-| j| }|d} ~ wwxYw)Npassworduserenvrz -H -u {} z--preserve-env='{}' ,zsudo -S -p '{}' {}{}{}z{} zSorry, try again. )patternresponsesentinelwatchers)resultprompt)rr7rBpopr9r:getformatjoinkeysr4rreescapelistr1r@appendr isinstancereasonrrrA)r!r0r)r*rBr9r:r; user_flags env_flagscmd_strwatcherr@failureerrors r"r6z Context._sudos!(::j$+*:*CDDzz&$+"2"788jj##  $++D11J  L.55chhsxxzz6J6JKKI''00*11 Iz7  #If%%]]8,,*   ::j$t{/G*H*HII    6:gCCCFCC C   '.*=>> #7>&III  s5F G3GGct|j}|j}|r)|dd|d||gzS)z Prefixes ``command`` with all prefixes found in ``command_prefixes``. ``command_prefixes`` is a list of strings which is modified by the `prefix` context manager. rzcd {}z && )rJrcwdinsertrErF)r!r)prefixescurrent_directorys r"r4zContext._prefix_commands s_-.. H  B OOAw~~.?@@ A A A{{8wi/000r$)NNNc#K|j| dV|jdS#|jwxYw)a Prefix all nested `run`/`sudo` commands with given command plus ``&&``. Most of the time, you'll want to be using this alongside a shell script which alters shell state, such as ones which export or alter shell environment variables. For example, one of the most common uses of this tool is with the ``workon`` command from `virtualenvwrapper `_:: with c.prefix('workon myvenv'): c.run('./manage.py migrate') In the above snippet, the actual shell command run would be this:: $ workon myvenv && ./manage.py migrate This context manager is compatible with `cd`, so if your virtualenv doesn't ``cd`` in its ``postactivate`` script, you could do the following:: with c.cd('/path/to/app'): with c.prefix('workon myvenv'): c.run('./manage.py migrate') c.run('./manage.py loaddata fixture') Which would result in executions like so:: $ cd /path/to/app && workon myvenv && ./manage.py migrate $ cd /path/to/app && workon myvenv && ./manage.py loaddata fixture Finally, as alluded to above, `prefix` may be nested if desired, e.g.:: with c.prefix('workon myenv'): c.run('ls') with c.prefix('source /some/script'): c.run('touch a_file') The result:: $ workon myenv && ls $ workon myenv && source /some/script && touch a_file Contrived, but hopefully illustrative. .. versionadded:: 1.0 N)rrKrC)r!r)s r"prefixzContext.prefixsdd $$W--- ( EEE  ! % % ' ' ' ' 'D ! % % ' ' ' 's =AcF|jsdSttt|jD]1\}}|ds|drn2d|j|dD}t t jj|S)zs Return the current working directory, accounting for uses of `cd`. .. versionadded:: 1.0 r~/c:g|]}|ddS) z\ )replace).0paths r" zContext.cwd..ds&LLLdc5))LLLr$N) rreversedrJ enumerate startswithstrosrbrF)r!irbpathss r"rUz Context.cwdPs  2 Yt/@%A%A B BCC  GAts## ts';';   MLd6G6KLLL27<'(((r$rbc#Kt|}|j| dV|jdS#|jwxYw)aq Context manager that keeps directory state when executing commands. Any calls to `run`, `sudo`, within the wrapped block will implicitly have a string similar to ``"cd && "`` prefixed in order to give the sense that there is actually statefulness involved. Because use of `cd` affects all such invocations, any code making use of the `cwd` property will also be affected by use of `cd`. Like the actual 'cd' shell builtin, `cd` may be called with relative paths (keep in mind that your default starting directory is your user's ``$HOME``) and may be nested as well. Below is a "normal" attempt at using the shell 'cd', which doesn't work since all commands are executed in individual subprocesses -- state is **not** kept between invocations of `run` or `sudo`:: c.run('cd /var/www') c.run('ls') The above snippet will list the contents of the user's ``$HOME`` instead of ``/var/www``. With `cd`, however, it will work as expected:: with c.cd('/var/www'): c.run('ls') # Turns into "cd /var/www && ls" Finally, a demonstration (see inline comments) of nesting:: with c.cd('/var/www'): c.run('ls') # cd /var/www && ls with c.cd('website1'): c.run('ls') # cd /var/www/website1 && ls .. note:: Space characters will be escaped automatically to make dealing with such directory names easier. .. versionadded:: 1.0 .. versionchanged:: 1.5 Explicitly cast the ``path`` argument (the only argument) to a string; this allows any object defining ``__str__`` to be handed in (such as the various ``Path`` objects out there), and not just string literals. N)rgrrKrC)r!rbs r"cdz Context.cdgso^4yy   &&& $ EEE   ! ! # # # # #D  ! ! # # # #s A A')Nr)__name__ __module__ __qualname____doc__r rg__annotations__r rr#propertyrsetterrrr1r.r7r6r4rrrZrUr rrlr$r"rrs^63is)NNN$(           .X  ]!F!t!!!]!434#4&4444&-8-c-S-V----F5CF53F56F5F5F5F5R9H9s9c9f9999| 1 1 1 1 1 15(c5(i0@&A5(5(5(^5(n)S)))X),3$uXs]+3$ :J0K3$3$3$^3$3$3$r$rceZdZdZddeededdffd ZdedeefdZ d e d e de fd Z d e d edede fd Z d e d edede fdZd e d e de ddfdZxZS) MockContexta A `.Context` whose methods' return values can be predetermined. Primarily useful for testing Invoke-using codebases. .. note:: This class wraps its ``run``, etc methods in `unittest.mock.Mock` objects. This allows you to easily assert that the methods (still returning the values you prepare them with) were actually called. .. note:: Methods not given `Results <.Result>` to yield will raise ``NotImplementedError`` if called (since the alternative is to call the real underlying method - typically undesirable when mocking.) .. versionadded:: 1.0 .. versionchanged:: 1.5 Added ``Mock`` wrapping of ``run`` and ``sudo``. Nrr*rc t||d|dd|D]$\}}t t tf}t|tr3|D]\}}| |||<ngt||st|dr| |}n1d}t| t||d ||||tt!||&dS) a Create a ``Context``-like object whose methods yield `.Result` objects. :param config: A Configuration object to use. Identical in behavior to `.Context`. :param run: A data structure indicating what `.Result` objects to return from calls to the instantiated object's `~.Context.run` method (instead of actually executing the requested shell command). Specifically, this kwarg accepts: - A single `.Result` object. - A boolean; if True, yields a `.Result` whose ``exited`` is ``0``, and if False, ``1``. - An iterable of the above values, which will be returned on each subsequent call to ``.run`` (the first item on the first call, the second on the second call, etc). - A dict mapping command strings or compiled regexen to the above values (including an iterable), allowing specific call-and-response semantics instead of assuming a call order. :param sudo: Identical to ``run``, but whose values are yielded from calls to `~.Context.sudo`. :param bool repeat: A flag determining whether results yielded by this class' methods repeat or are consumed. For example, when a single result is indicated, it will normally only be returned once, causing ``NotImplementedError`` afterwards. But when ``repeat=True`` is given, that result is returned on every call, forever. Similarly, iterable results are normally exhausted once, but when this setting is enabled, they are wrapped in `itertools.cycle`. Default: ``True``. :raises: ``TypeError``, if the values given to ``run`` or other kwargs aren't of the expected types. .. versionchanged:: 1.5 Added support for boolean and string result values. .. versionchanged:: 1.5 Added support for regex dict keys. .. versionchanged:: 1.5 Added the ``repeat`` keyword argument. .. versionchanged:: 2.0 Changed ``repeat`` default value from ``False`` to ``True``. __repeatrepeatT__iter__z)Not sure how to yield results from a {!r}__{})wrapsN)superr#r rCitemsrboolrgrLdict _normalizehasattr TypeErrorrEtyper getattr) r!rr*methodresults singletonskeyr'err __class__s r"r#zMockContext.__init__sqp     *fjj488999%||~~ A AOFG!$,J'4(( ;")--//::JC#'??5#9#9GCLL:GZ00 ;G55 ;//'22B 4== 9 9::: IIfmmF++W 5 5 5 IIfdv)>)>??? @ @ @ @% A Ar$r'ct|drt|tr|g}g}|D]e}t|trt |rdnd}n$t|trt |}||ft |drt|nt|S)Nrzrr )exitedrx) rrLrgrrrKrriter)r!r'robjs r"rzMockContext._normalizesuj)) Zs-C-C GE  C#t$$ "OAA!444C%% "Skk NN3    !(z!:!:MuW~~~W Mr$attnamer)c t||}t|trd ||}nZ#t$rM|D].\}}t |dr||r|}n/tYnwxYwt|}|js||_|S#ttttf$rt|wxYw)Nmatch) rrLrKeyErrorr~rrnextr)AttributeError IndexError StopIterationNotImplementedError)r!rr)rrr'rAs r" _yield_resultzMockContext._yield_results /$((C#t$$ ' 'g,CC ' ' ''*iikk'' U"300"SYYw5G5G""'C!E'"E '"#YYF> )!(M HmD / / /%g.. . /s,%B*1B*ABB*B!B**-Cargsc.|d|S)N__runrr!r)rr*s r"r1zMockContext.run5s !!'7333r$c.|d|S)N__sudorrs r"r7zMockContext.sudo<s !!(G444r$rAcd|}td} t||}n#t$r|wxYwt |t s|||||<dS)a Modify the stored mock results for given ``attname`` (e.g. ``run``). This is similar to how one instantiates `MockContext` with a ``run`` or ``sudo`` dict kwarg. For example, this:: mc = MockContext(run={'mycommand': Result("mystdout")}) assert mc.run('mycommand').stdout == "mystdout" is functionally equivalent to this:: mc = MockContext() mc.set_result_for('run', 'mycommand', Result("mystdout")) assert mc.run('mycommand').stdout == "mystdout" `set_result_for` is mostly useful for modifying an already-instantiated `MockContext`, such as one created by test setup or helper methods. .. versionadded:: 1.0 r{z>Can't update results for non-dict or nonexistent mock results!N)rErrrrLrr)r!rr)rAheckr's r"set_result_forzMockContext.set_result_forCs.--(( L    D'**EE   J %&& J00gs 7 Ar3)rmrnrorpr rrr#rrrgrrr1r7r __classcell__)rs@r"rvrvsd(NANAx/NA#NA$NANANANANANA` N N N N N N(/S/3/6////<434s4c4f44445C55s5v5555%1%1%(%128%1 %1%1%1%1%1%1%1%1r$rv)rhrH contextlibr itertoolsrrtypingrrrr r r unittest.mockr rrr exceptionsrrrr,rrr@rrrvrtr$r"rs %%%%%%%%%%%%%%AAAAAAAAAA########&&&&&&E$E$E$E$E$iE$E$E$P J1J1J1J1J1'J1J1J1J1J1r$