o 3gM@spddlmZddlZddlZddlZddlZddlmZmZddlm Z ddl m Z ddl m Z ddlZddlmZmZdZGd d d eZd Zd Zd dZddZGdddZGdddeZGdddeZGdddeZGdddeZGdddeZGdddeZ Gdd d eZ!Gd!d"d"eZ"Gd#d$d$e#Z$e$ej%Z&Gd%d&d&eZ'Gd'd(d(eZ(dS))) annotationsN)PIPEPopen) TemporaryFile) MethodType)ClassVar) iter_linesrun_proc)rr shquote shquote_listRedirectionError BaseCommandPipelineBaseRedirection BoundCommandBoundEnvCommandConcreteCommandERROUTStdinRedirectionStdoutRedirectionStderrRedirectionAppendingStdoutRedirectionStdinDataRedirectionc@seZdZdZdS)r zwRaised when an attempt is made to redirect an process' standard handle, which was already redirected to/from a fileN)__name__ __module__ __qualname____doc__rrM/home/garg/my-data/venv/lib/python3.10/site-packages/plumbum/commands/base.pyr $sr zIabcdefghijklmnopqrstuvwxyzABCDEFGHIJKLMNOPQRSTUVWXYZ0123456789!@%_-+=:,./z"`$\cCst|}t|S)zOQuotes the given text with shell escaping (assumes as syntax similar to ``sh``))strshlexquote)textrrrr 1s r cCsdd|DS)NcSsg|]}t|qSr)r ).0itemrrr 8sz shquote_list..r)seqrrrr 7r c@seZdZdZdZddZddZddZd d Zd d Z d dZ ddZ ddZ ddZ ddZddZddZddZeZeddZd=d!d"Zd>d#d$Zd?d)d*Zejd>d+d,Zd>d-d.Zd/d0Zd1d2Zd3d4Zd5d6Zd7d8Z d9d:Z!d;d<Z"d'S)@r zBase of all command objects)cwdenvcustom_encoding __weakref__cCsd|S)N )join formulateselfrrr__str__Cr'zBaseCommand.__str__cC t||S)z%Creates a pipe with the other command)r)r0otherrrr__or__F zBaseCommand.__or__cCr2)z/Redirects the process' stdout to the given file)rr0filerrr__gt__Jr5zBaseCommand.__gt__cCr2)z;Redirects the process' stdout to the given file (appending))rr6rrr __rshift__Nr5zBaseCommand.__rshift__cCr2)z/Redirects the process' stderr to the given file)rr6rrr__ge__Rr5zBaseCommand.__ge__cCr2)z0Redirects the given file into the process' stdin)rr6rrr__lt__Vr5zBaseCommand.__lt__cCr2)z0Redirects the given data into the process' stdin)r)r0datarrr __lshift__Zr5zBaseCommand.__lshift__cCst|ttfs |g}|j|S)zUCreates a bound-command with the given arguments. Shortcut for bound_command.) isinstancetuplelist bound_commandr0argsrrr __getitem__^s zBaseCommand.__getitem__cGs2|s|St|trt|j|jt|St||S)z0Creates a bound-command with the given arguments)r>rcmdrCr@rBrrrrAgs   zBaseCommand.bound_commandcOs|j|fi|dS)z>A shortcut for `run(args)`, returning only the process' stdout)runr0rCkwargsrrr__call__qszBaseCommand.__call__cCtNNotImplementedErrorr/rrr _get_encodinguzBaseCommand._get_encodingcK|s|St||dS)z>Returns a BoundEnvCommand with the given environment variables)r)r)r0r)rrrwith_envxs zBaseCommand.with_envcCrQ)z Returns a BoundEnvCommand with the specified working directory. This overrides a cwd specified in a wrapping `machine.cwd()` context manager. )r(rR)r0pathrrrwith_cwd~s zBaseCommand.with_cwdcCrKrLrMr/rrrmachinezBaseCommand.machinerrcCrK)aFormulates the command into a command-line, i.e., a list of shell-quoted strings that can be executed by ``Popen`` or shells. :param level: The nesting level of the formulation; it dictates how much shell-quoting (if any) should be performed :param args: The arguments passed to this command (a tuple) :returns: A list of strings rMr0levelrCrrrr.s zBaseCommand.formulatecKrK)aSpawns the given command, returning a ``Popen``-like object. .. note:: When processes run in the **background** (either via ``popen`` or :class:`& BG `), their stdout/stderr pipes might fill up, causing them to hang. If you know a process produces output, be sure to consume it every once in a while, using a monitoring thread/reactor in the background. For more info, see `#48 `_ :param args: Any arguments to be passed to the process (a tuple) :param kwargs: Any keyword-arguments to be passed to the ``Popen`` constructor :returns: A ``Popen``-like object rMrHrrrpopenszBaseCommand.popen. nohup.outNTcCs|j|||||S)zRuns a command detached.)rVdaemonic_popen)r0r(stdoutstderrappendrrrnohupszBaseCommand.nohupc+sZ|dd|dd|j|fi|dgfdd}|_V|dS)aYRuns the given command as a context manager, allowing you to create a `pipeline `_ (not in the UNIX sense) of programs, parallelizing their work. In other words, instead of running programs one after the other, you can start all of them at the same time and wait for them to finish. For a more thorough review, see `Lightweight Asynchronism `_. Example:: from plumbum.cmd import mkfs with mkfs["-t", "ext3", "/dev/sda1"] as p1: with mkfs["-t", "ext3", "/dev/sdb1"] as p2: pass .. note:: When processes run in the **background** (either via ``popen`` or :class:`& BG `), their stdout/stderr pipes might fill up, causing them to hang. If you know a process produces output, be sure to consume it every once in a while, using a monitoring thread/reactor in the background. For more info, see `#48 `_ For the arguments, see :func:`run `. :returns: A Popen object, augmented with a ``.run()`` method, which returns a tuple of (return code, stdout, stderr) retcodertimeoutNFcsdrdSdd<z-tW`jjjfD]}tt |Wdn1s1wYqS`jjjfD]}tt |Wdn1sXwYqBw)NrT) r rGstdinr^r_ contextlibsuppress Exceptionclose)fprbrcwas_runrrrunners&     z!BaseCommand.bgrun..runner)poprZrG)r0rCrIrmrrjrbgruns    zBaseCommand.bgruncKs>|j|fi| }|WdS1swYdS)aRuns the given command (equivalent to popen() followed by :func:`run_proc `). If the exit code of the process does not match the expected one, :class:`ProcessExecutionError ` is raised. :param args: Any arguments to be passed to the process (a tuple) :param retcode: The expected return code of this process (defaults to 0). In order to disable exit-code validation, pass ``None``. It may also be a tuple (or any iterable) of expected exit codes. .. note:: this argument must be passed as a keyword argument. :param timeout: The maximal amount of time (in seconds) to allow the process to run. ``None`` means no timeout is imposed; otherwise, if the process hasn't terminated after that many seconds, the process will be forcefully terminated an exception will be raised .. note:: this argument must be passed as a keyword argument. :param kwargs: Any keyword-arguments to be passed to the ``Popen`` constructor :returns: A tuple of (return code, stdout, stderr) N)rorG)r0rCrIrkrrrrGs$zBaseCommand.runcCs|di|}||@S)z Applies a modifier to the current object (e.g. FG, NOHUP) :param modifier: The modifier class to apply (e.g. FG) :param args: A dictionary of arguments to pass to this modifier :return: Nrr)r0modifierrCmodifier_instancerrr _use_modifierszBaseCommand._use_modifiercK|tjjj|S)z Run this command in the background. Uses all arguments from the BG construct :py:class: `plumbum.commands.modifiers.BG` )rrplumbumcommands modifiersBGr0rIrrrrun_bg zBaseCommand.run_bgcKrs)z Run this command in the foreground. Uses all arguments from the FG construct :py:class: `plumbum.commands.modifiers.FG` )rrrtrurvFGrxrrrrun_fgrzzBaseCommand.run_fgcKrs)z Run this command using the TEE construct. Inherits all arguments from TEE :py:class: `plumbum.commands.modifiers.TEE` )rrrtrurvTEErxrrrrun_teerzzBaseCommand.run_teecKrs)z Run this command using the TF construct. Inherits all arguments from TF :py:class: `plumbum.commands.modifiers.TF` )rrrtrurvTFrxrrrrun_tfrzzBaseCommand.run_tfcKrs)z Run this command using the RETCODE construct. Inherits all arguments from RETCODE :py:class: `plumbum.commands.modifiers.RETCODE` )rrrtrurvRETCODErxrrr run_retcode&rzzBaseCommand.run_retcodecKrs)z Run this command using the NOHUP construct. Inherits all arguments from NOHUP :py:class: `plumbum.commands.modifiers.NOHUP` )rrrtrurvNOHUPrxrrr run_nohup-rzzBaseCommand.run_nohuprrr)r[r\NT)#rrrr __slots__r1r4r8r9r:r;r=rDrArJrOrSrUsetenvpropertyrVr.rZrarecontextmanagerrorGrrryr|r~rrrrrrrr >s@        2  r c@HeZdZdZddZddZddZdd d Zed d Z dddZ dS)rrErCcCs||_t||_dSrL)rEr@rC)r0rErCrrr__init__8szBoundCommand.__init__cCd|jd|jdS)Nz BoundCommand(, )rr/rrr__repr__<zBoundCommand.__repr__cC |jSrLrErOr/rrrrO? zBoundCommand._get_encodingrrcCs|j|d|jt|S)NrF)rEr.rCr@rXrrrr.BszBoundCommand.formulatecC|jjSrLrErVr/rrrrVEzBoundCommand.machinecKs.t|tr|g}|jj|jt|fi|SrL)r>rrErZrCr@rHrrrrZIs zBoundCommand.popenNrr rrrrrrrOr.rrVrZrrrrr5s  rc@sJeZdZdZdddZddZddZdd d Zed dZ dddZ dS)r)rENcCs||_|pi|_||_dSrL)rEr)r()r0rEr)r(rrrrTs  zBoundEnvCommand.__init__cCr)NzBoundEnvCommand(rr)rEr)r/rrrrYrzBoundEnvCommand.__repr__cCrrLrr/rrrrO\rzBoundEnvCommand._get_encodingrrcCs|j||SrL)rEr.rXrrrr._r'zBoundEnvCommand.formulatecCrrLrr/rrrrVbrzBoundEnvCommand.machinecKs>|pi}|jj|f|dur|jn|t|jfi|d|S)N)r(r))rErZr(dictr))r0rCr(r)rIrrrrZfszBoundEnvCommand.popen)NNr)rNNrrrrrrQs   rc@r)rsrccmddstcmdcC||_||_dSrLr)r0rrrrrrs zPipeline.__init__cCr)Nz Pipeline(rrrr/rrrrwrzPipeline.__repr__cCs|jp |jSrL)rrOrr/rrrrOzszPipeline._get_encodingrrcCs*g|j|dd|j|d|S)NrF|)rr.rrXrrrr.}szPipeline.formulatecCrrL)rrVr/rrrrVrzPipeline.machinec s|}t|d<d|vr|d|d<|jj|fi|j|d<|jjdi|jjr>|dtkr>j_ j t t j fdd}|j_ jfdd}t|_j_S)Nr^rdcs.|i|}j|i|}|p|_jSrL)wait returncode)rCrIrc_dstrc_src)dstproc dstproc_waitsrcprocrrwait2s zPipeline.popen..wait2cs^z dgt|}Wnty|durdnd|g}Ynw|j||||||||dS)Nr)r@ TypeErrorrverify)procrbrcr^r_ or_retcode)dstproc_verifyrrrs zPipeline.popen..verifyr)copyrrrZr^rrhrdgetrr functoolswrapsr_procrr)r0rCrI src_kwargsrrr)rrrrrrZs(       zPipeline.popenNrrrrrrrrps  rc@sbeZdZUdZded<ded<ded<ddZdd Zd d ZdddZe ddZ dddZ dS)rrEr7z ClassVar[str]SYMKWARGMODEcCrrLr)r0rEr7rrrrrzBaseRedirection.__init__cCrrLrr/rrrrOrzBaseRedirection._get_encodingcCs|jjd|jd|jdS)N(rr) __class__rrEr7r/rrrrszBaseRedirection.__repr__rrcCs0g|j|d||jtt|jd|jS)NrFname)rEr.rr getattrr7rXrrrr.szBaseRedirection.formulatecCrrLrr/rrrrVrzBaseRedirection.machinecKsddlm}ddlm}|j|vr"||jtdfvr"t|jdt|j|r,t dt|jt |frEt t |j|j dd}||j<n|j||j<d}z|j j|fi|W|r_|SS|rg|ww)Nr) LocalPath) RemotePathz is already redirectedz$Cannot redirect to/from remote pathszutf-8)encoding)plumbum.machines.localrplumbum.machines.remoterrrr r>r7rropenrrErZrh)r0rCrIrrrirrrrZs"   "   zBaseRedirection.popenNrr) rrrr__annotations__rrOrr.rrVrZrrrrrs   rc@eZdZdZdZdZdZdS)rrr^wNrrrrrrrrc@r)rrz>>r^aNrrrrrrrrc@r)rrz2>r_rNrrrrrrrrc@seZdZddZddZdS)_ERROUTcCdS)Nrrr/rrrrz_ERROUT.__repr__cCr)Nz&1rr/rrrr1rz_ERROUT.__str__N)rrrrr1rrrrrs rc@sDeZdZdZdZddZddZdd d Zed d Z dd dZ dS)rrEr<i>cCrrLr)r0rEr<rrrrrzStdinDataRedirection.__init__cCrrLrr/rrrrOrz"StdinDataRedirection._get_encodingrrcCs&dt|jdg|j|d|S)Nzecho rrF)r r<rEr.rXrrrr.s zStdinDataRedirection.formulatecCrrLrr/rrrrV rzStdinDataRedirection.machinecKs|dtdfvr td|j}t|tr"|dur"||}t}|r<|d|j }| |||j d}|s'| d||d<|j j |fi|S)Nrdzstdin is already redirectedr)rrr r<r>rrOencoder CHUNK_SIZEwriteseekrErZ)r0rCrIr<richunkrrrrZ$s  zStdinDataRedirection.popenNrr) rrrrrrrOr.rrVrZrrrrrs  rc@sZeZdZUdZded<ddZddZdd Zd d ZdddZ e ddZ dddZ dS)r) executablez ClassVar[int] QUOTE_LEVELcCs||_||_d|_d|_dSrL)rr*r(r))r0rrrrrr=s zConcreteCommand.__init__cCs t|jSrL)rrr/rrrr1CrzConcreteCommand.__str__cCst|jd|jdS)Nrr)typerrr/rrrrFszConcreteCommand.__repr__cCs|jSrL)r*r/rrrrOIrPzConcreteCommand._get_encodingrrcstjg}|D]N}|durqt|tr1jkr&|t|dq||dqt|tt frF|fdd|Dq| jkrQt |nt|q|S)NrFc3s*|]}jkr t|nt|VqdSrL)rr r)r#brYr0rr Ws z,ConcreteCommand.formulate..) rrr>r rextendr r.r@r?r`r )r0rYrCargvrrrrr.Ls    "zConcreteCommand.formulatecCrKrLrMr/rrrrV`rWzConcreteCommand.machinecKrKrLrMrHrrrrZdrPzConcreteCommand.popenNrr) rrrrrrr1rrOr.rrVrZrrrrr7s   r)) __future__rrerr subprocessrrtempfilertypesrtypingrplumbum.commands.modifiersrtplumbum.commands.processesrr __all__rgr _safechars _funnycharsr r r rrrrrrrrintrSTDOUTrrrrrrrs>     xF1 )