o Thc@sddlZddlZddlmZddlmZddlmZddlmZm Z m Z m Z m Z m Z mZddlmZddlmZmZdd lmZmZmZdd lmZdd lmZerXdd lmZGd ddeZGdddeZdS)N)contextmanager)cycle)PathLike) TYPE_CHECKINGAny GeneratorIteratorListOptionalUnion)Mock)Config DataProxy)Failure AuthFailureResponseNotAccepted)Result)FailingResponder)Runnerc @s"eZdZdZd!deeddfddZedefddZej d eddfd dZd e d e dee fd dZ ddd e d e dee fddZd e d e dee fddZddd e d e dee fddZd e de fddZed e dedfddZede fddZedeee fdedfdd ZdS)"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 NconfigreturncCsF|dur|nt}|j|dt}|j|dt}|j|ddS)z :param config: `.Config` object to use as the base configuration. Defaults to an anonymous/default `.Config` instance. N_config)command_prefixes) command_cwds)r_setlist)selfrrrr A/var/www/html/venv/lib/python3.10/site-packages/invoke/context.py__init__.s   zContext.__init__cCs|jSNr)rr r r!rKszContext.configvaluecCs|j|ddS)Nr)r)rr$r r r!rQscommandkwargscK"|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_runrr%r&runnerr r r!runZs z Context.runr,rcKs||}|j|fi|Sr#)_prefix_commandsr-)rr,r%r&r r r!r*ms z Context._runcKr')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+r r r!sudossEz Context.sudoc Ks|jjj}|d|jjj}|d|jjj}|di}d}|dur(d|}d} |r6dd| } | |}d|| ||} t t |d |d d } |d t|jjj} | | z |j| fd | i|WSty} zt| jtrt| j|d }|d} ~ ww)Npassworduserenvz -H -u {} z--preserve-env='{}' ,zsudo -S -p '{}' {}{}{}z{} zSorry, try again. )patternresponsesentinelwatchers)resultprompt)rr0r;popr1r2getformatjoinkeysr.rreescaperr-r9appendr isinstancereasonrrr:)rr,r%r&r;r1r2r3 user_flags env_flagscmd_strwatcherr9failureerrorr r r!r/s<       z Context._sudocCs6t|j}|j}|r|dd|d||gS)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 && )rrcwdinsertr>r?)rr%prefixescurrent_directoryr r r!r.s zContext._prefix_commands)NNNccs2|j|z dVW|jdS|jw)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)rrCr<)rr%r r r!prefix s  2zContext.prefixcCsf|jsdSttt|jD]\}}|ds|drnqdd|j|dD}ttjj|S)zs Return the current working directory, accounting for uses of `cd`. .. versionadded:: 1.0 r4~/cSsg|]}|ddqS) z\ )replace).0pathr r r! VszContext.cwd..N) rreversedr enumerate startswithstrosrVr?)rirVpathsr r r!rLBsz Context.cwdrVccs:t|}|j|z dVW|jdS|jw)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)r[rrCr<)rrVr r r!cdYs / z Context.cdr#)__name__ __module__ __qualname____doc__r rr"propertyrsetterr[rrr-r*r0r/r.rrrPrLr rr_r r r r!rsD I @7$rcseZdZdZddeededdffdd Zdedeefd d Z d e d e de fd dZ d e dedede fddZ d e dedede fddZd e d e de ddfddZZS) 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  st||d|dd|D]O\}}tttf}t|t r3|D] \}}| |||<q&nt||s=t |drC| |}n d}t | t||d ||||tt||dqdS) 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"rr<itemsrboolr[rDdict _normalizehasattr TypeErrorr>typer getattr) rrr&methodresults singletonskeyr$err __class__r r!r"s" 8    zMockContext.__init__r$cCs|t|dr t|tr |g}g}|D]}t|tr"t|rdndd}n t|tr+t|}||qt|dr:t|St|S)Nrirr )exitedrg) rqrDr[rnrrCrtriter)rr$rvobjr r r!rps   zMockContext._normalizeattnamer%c Csz@t||}t|tr4z||}Wn"ty3|D]\}}t|dr.||r.|}nqtYnwt|}|js>||_|WSt t tt fyOt |w)Nmatch) rtrDroKeyErrorrmrqrnextr%AttributeError IndexError StopIterationNotImplementedError)rrr%r~rxr$r:r r r! _yield_result s*     zMockContext._yield_resultargscO |d|S)N__runrrr%rr&r r r!r-' zMockContext.runcOr)N__sudorrr r r!r0.rzMockContext.sudor:cCsTd|}td}zt||}Wn ty|wt|ts!|||||<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 rjz>Can't update results for non-dict or nonexistent mock results!N)r>rrrtrrDrorp)rrr%r:heckr$r r r!set_result_for5s   zMockContext.set_result_forr#)r`rarbrcr rrr"rrpr[rrr-r0r __classcell__r r rzr!rfs  Prf) r\rA contextlibr itertoolsrrtypingrrrrr r r unittest.mockr rrr exceptionsrrrr(rr9rinvoke.runnersrrrfr r r r!s"   $    x