khcddlZddlZddlmZddlmZddlmZddlmZm Z m Z m Z m Z m Z mZddlmZddlmZmZdd lmZmZmZdd lmZdd lmZerdd lmZGd deZGddeZy)N)contextmanager)cycle)PathLike) TYPE_CHECKINGAny GeneratorIteratorListOptionalUnion)Mock)Config DataProxy)Failure AuthFailureResponseNotAccepted)Result)FailingResponder)Runnerc LeZdZdZddeeddfdZedefdZejdeddfdZd e d e dee fd Z d d d e d e dee fdZd e d e dee fdZd d d e d e dee fdZd e de fdZed e dedfdZede fdZedeee fdedfdZy)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 Nconfigreturnc||n t}|j|t}|j|t}|j|y)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)selfrrrs `/var/www/pru.catia.catastroantioquia-mas.com/tasa/lib/python3.12/site-packages/invoke/context.py__init__zContext.__init__.sP "-68 & !'+f #3 4#'&  | ,c|jSNr)r"s r#rzContext.configKs||r%valuec(|j|y)Nr)r )r"r(s r#rzContext.configQs %  r%commandkwargsc t|jjj|}|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.runZs6$$**40tyy3F33r%r1rc J|j|}|j|fi|Sr')_prefix_commandsr2)r"r1r*r+s r#r/z Context._runms*''0vzz',V,,r%c t|jjj|}|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._sudor0s r#sudoz Context.sudoss7J$$**40tzz&'4V44r%c |jjj}|jd|jjj}|jd|jjj }|j di}d}|dj|}d} |r.djdj|j} |j|}dj|| ||} ttj|d j|d } |jd t|jjj } | j#|  |j| fd | i|S#t$$r9} t'| j(t*rt-| j.| }|d} ~ wwxYw)Npassworduserenvz -H -u {} z--preserve-env='{}' ,zsudo -S -p '{}' {}{}{}z{} zSorry, try again. )patternresponsesentinelwatchers)resultprompt)rr7rCpopr9r:getformatjoinkeysr4rreescaper!r2rAappendr isinstancereasonrrrB)r"r1r*r+rCr9r:r; user_flags env_flagscmd_strwatcherrAfailureerrors r#r6z Context._sudos!!((::j$++*:*:*C*CDzz&$++"2"2"7"78jj#  $++D1J .55chhsxxz6JKI''0*11 Iz7 #IIf%]]8,* ::j$t{{/G/G*HI  6::gCCFC C '..*=>#7>>&I  s:F G4G  Gct|j}|j}|r!|jddj |dj ||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 && )r!rcwdinsertrFrG)r"r*prefixescurrent_directorys r#r4zContext._prefix_commandssO--. HH  OOAw~~.?@ A{{8wi/00r%)NNNc#K|jj| d|jjy#|jjwxYww)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)rrKrD)r"r*s r#prefixzContext.prefix sId $$W- (   ! ! % % 'D ! ! % % 'sA>AAAcn|jsyttt|jD])\}}|j ds|j ds)n|jdDcgc]}|j dd}}t tjj|Scc}w)zs Return the current working directory, accounting for uses of `cd`. .. versionadded:: 1.0 r<~/N z\ ) rreversedr! enumerate startswithreplacestrospathrG)r"irepathss r#rUz Context.cwdBs   Yt/@/@%A BC GAts#ts';  7;6G6G6KLdc5)LL277<<'((Ms2B2rec#Kt|}|jj| d|jjy#|jjwxYww)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)rcrrKrD)r"res r#cdz Context.cdYsR^4y   & $     ! ! #D   ! ! #s'A(A A( A%%A(r')__name__ __module__ __qualname____doc__r rr$propertyrsetterrcrrr2r/r7r6r4rrrZrUr rrir%r#rrs&-x/-4-:  ]]!F!t!!434#4(62B4&--),-8;- & - F5CF53F58F3CF5R;;),;8;; & ;@ 1 1 15(c5(i0@&A5(5(n)S)),3$uXs]+3$ :J0K3$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 |||jd|jdd|j D]\}}t t tf}t|tr-|j D]\}}|j|||<nOt||s t|dr|j|}n%d}t|jt||jdj|||j|tt!||y) 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 rDitemsrboolrcrLdict _normalizehasattr TypeErrorrFtyper getattr) r"rr+methodresults singletonskeyr(err __class__s r#r$zMockContext.__init__sp   *fjj489%||~ AOFG!$,J'4(")--/:JC#'??5#9GCL:GZ0G5//'2B 4= 9:: IIfmmF+W 5 IIfdv)>? @% Ar%r(c0t|drt|tr|g}g}|D]O}t|trt |rdnd}nt|tr t |}|j |Qt |dr t|St|S)Nrvrr)exitedrt) r~rLrcr{rrKrriter)r"r(robjs r#r}zMockContext._normalizesuj)Zs-CGE C#t$A!4C%Sk NN3   ")z!:uW~MW Mr%attnamer*cv t||}t|tr ||}t|}|js||_|S#t$rC|j D]'\}}t |ds|j |s%|}ntYkwxYw#ttttf$r t|wxYw)Nmatch) rrLr|KeyErrorrzr~rnextr*AttributeError IndexError StopIterationNotImplementedError)r"rr*rrr(rBs r# _yield_resultzMockContext._yield_result s /$(C#t$ 'g,C"#YF>>!(M% ''*iik' U"30SYYw5G"'C!' '" '& HmD /%g. . /s9BAB+B0B B BBB%B8argsc&|jd|S)N__runrr"r*rr+s r#r2zMockContext.run's !!'733r%c&|jd|S)N__sudorrs r#r7zMockContext.sudo.s !!(G44r%rBcdj|}td} t||}t |t s||j |||<y#t$r|wxYw)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 rwz>Can't update results for non-dict or nonexistent mock results!N)rFrrrrLr|r})r"rr*rBheckr(s r#set_result_forzMockContext.set_result_for5si.--( L   D'*E%&J0g  J s A Ar')rjrkrlrmr rrr$r r}rcrrr2r7r __classcell__)rs@r#rrrrs(NAx/NA#NA$NA` N N N(/S/3/6/<434s4c4f45C55s5v5%1%1%(%128%1 %1r%rr) rdrI contextlibr itertoolsrrtypingrrrr r r r unittest.mockr rrr exceptionsrrrr-rrArinvoke.runnersrrrrrpr%r#rsZ %%AA&%s$is$l J1'J1r%