o 3gE.@sddlmZddlZddlZddlZddlZddlZddlmZm Z ddl m Z ddl m Z GdddeZGdd d e eZGd d d eZGd d d eZGdddeZedZGdddZGddde ZGdddZdS)) annotationsN) BaseCommandrun_proc)ProcessExecutionError) PopenAddonsc@eZdZdZdS)ShellSessionErrorzqRaises when something goes wrong when calling :func:`ShellSession.popen `N__name__ __module__ __qualname____doc__rrP/home/garg/my-data/venv/lib/python3.10/site-packages/plumbum/machines/session.pyrrc@r) SSHCommsErrorz^Raises when the communication channel can't be created on the remote host or it times out.Nr rrrrrrrc@r)SSHCommsChannel2Errorz/Raises when channel 2 (stderr) is not availableNr rrrrrrrc@r)IncorrectLoginz4Raises when incorrect login credentials are providedNr rrrrrrrc@r)HostPublicKeyUnknownz+Raises when the host public key isn't knownNr rrrrr rrz plumbum.shellc@s0eZdZdZgdZddZddZddZd S) MarkedPipezA pipe-like object from which you can read lines; the pipe will return report EOF (the empty string) when a special marker is detected)pipemarker __weakref__cCs||_||_t|jd|_dS)Nascii)rrbytes)selfrrrrr__init__0szMarkedPipe.__init__cCs|r |sd|_dS)zI'Closes' the marked pipe; following calls to ``readline`` will return "" N)readlinerrrrrclose5s zMarkedPipe.closecCs>|jdurdS|j}|st||jkrd|_dS|S)zReads the next line from the pipe; returns "" when the special marker is reached. Raises ``EOFError`` if the underlying pipe has closedN)rrEOFErrorstripr)rlinerrrr<s  zMarkedPipe.readlineN)r r r r __slots__rrrrrrrr*s  rc@s2eZdZdZddZddZddZd d d ZdS) SessionPopenzA shell-session-based ``Popen``-like object (has the following attributes: ``stdin``, ``stdout``, ``stderr``, ``returncode``)c Cs@||_||_||_||_||_||_||_||_d|_d|_ dS)NF) hostprocargvisattystdinstdoutstderrcustom_encoding returncode_done) rr'r(r)r*r+r,encodingr&rrrrNs zSessionPopen.__init__cCs|jr|jSdS)z@Returns the process' exit code or ``None`` if it's still runningN)r/r.rrrrpollZszSessionPopen.pollcCs||jS)z %rz%s> Nothing returned.r ignore;z'Incorrect username or password provided)messager&z1The authenticity of the host can't be establishedzSSH communication failedzJNo stderr result detected. Does the remote have Bash as the default shell?z9No communication channel detected. Does the remote exist?UnknownT)r+r)appendr,r*writeflushlenr shell_loggerdebugr!r'r1r.joindecoder-r(splitrr&rrrpopint IndexError ValueErrorr/)rinputr+r,sourcesichunknamecollrr#errr.r(rrrr2cs       6 E    zSessionPopen.communicateN)r r r r rr1r3r2rrrrr%Js  r%c@s\eZdZdZ dddddZd d Zd d Zd dZddZddZ ddZ dddZ dS) ShellSessiona\An abstraction layer over *shell sessions*. A shell session is the execution of an interactive shell (``/bin/sh`` or something compatible), over which you may run commands (sent over stdin). The output of is then read from stdout and stderr. Shell sessions are less "robust" than executing a process on its own, and they are susseptible to all sorts of malformatted-strings attacks, and there is little benefit from using them locally. However, they can greatly speed up remote connections, and are required for the implementation of :class:`SshMachine `, as they allow us to send multiple commands over a single SSH connection (setting up separate SSH connections incurs a high overhead). Try to avoid using shell sessions, unless you know what you're doing. Instances of this class may be used as *context-managers*. :param proc: The underlying shell process (with open stdin, stdout and stderr) :param encoding: The encoding to use for the shell session. If ``"auto"``, the underlying process' encoding is used. :param isatty: If true, assume the shell has a TTY and that stdout and stderr are unified :param connect_timeout: The timeout to connect to the shell, after which, if no prompt is seen, the shell process is killed autoFr9Nr&cs|__|dkr jn|_|_t_d_d_r2fdd}t |}| z d_WrB| dSdSrK| ww)NrTcstddS)Nz#Connection to %s timed out (%d sec))rBerrorrrconnect_timeoutr'rrrclosers z%ShellSession.__init__..closer) r&r'r-r) threadingRLock_lock_current_startup_resultTimerstartruncancel)rr'r0r)rXr&rYtimerrrWrrs$    zShellSession.__init__cCs|SrRrrrrr __enter__szShellSession.__enter__cCs |dSrR)r)rtvtbrrr__exit__s zShellSession.__exit__cCs8tt |WddS1swYdSrR) contextlibsuppress Exceptionrrrrr__del__s  "zShellSession.__del__cCs|jo |jduS)zNReturns ``True`` if the underlying shell process is alive, ``False`` otherwiseN)r'r1rrrraliveszShellSession.alivec Cs|sdSttt|jjd|jjt dWdn1s)wY|jj|jj |jj fD]}tt  |Wdn1sOwYq9tt |jWdn1sjwYd|_dS)z%Closes (terminates) the shell sessionNs exit exit g?)rnrjrkrJOSErrorr'r*r?r@timesleepr+r,rlrkill)rprrrrs        zShellSession.closec Cs|jdur td|jr|jjstdt|tr|dn|}dttd}| r5|d7}nd}|d |d 7}|j sJ|d |d 7}|j rS| |j }t d ||jj|d|jjt|j||j |jjt|jj|t|jj||j |jd|_|jS)aaRuns the given command in the shell, adding some decoration around it. Only a single command can be executed at any given time. :param cmd: The command (string or :class:`Command ` object) to run :returns: A :class:`SessionPopen ` instance Nz%Shell session has already been closedz/Each shell may start only one process at a timer6z--.ENDz.--z ; ztrue ; zecho $? ; echo ''z ; echo 'z' 1>&2z Running %r rU)r'rr^r/ isinstancer formulaterprandomr"r)r-encoderBrCr*r?r@r%rr+r,r&)rcmdfull_cmdrrrrpopen s8        zShellSession.popenrcCs:|jt|||WdS1swYdS)alRuns the given command :param cmd: The command (string or :class:`Command ` object) to run :param retcode: The expected return code (0 by default). Set to ``None`` in order to ignore erroneous return codes :returns: A tuple of (return code, stdout, stderr) N)r]rr|)rrzretcoderrrrb4s $zShellSession.run)rTFr9)r) r r r r rrerirmrnrr|rbrrrrrSs 'rS) __future__rrjloggingrxr[rpplumbum.commandsrrplumbum.commands.processesrplumbum.machines.baserrlrr!rrrr getLoggerrBrr%rSrrrrs$     w