o Th/@sdZddlmZddlmZddlmZmZmZm Z m Z m Z er2ddl m Z ddlmZddlmZGd d d eZGd d d eZGd ddeZGdddeZGdddeZGdddeZGdddeZGdddeZGdddeZGdddeZGdddeZGdd d eZd!ed"eeeffd#d$Z Gd%d&d&eZ!Gd'd(d(eZ"Gd)d*d*e"Z#Gd+d,d,eZ$d-S).a Custom exception classes. These vary in use case from "we needed a specific data structure layout in exceptions used for message-passing" to simply "we needed to express an error condition in a way easily told apart from other, truly unexpected errors". )pformat)format_exception) TYPE_CHECKINGAnyDictListOptionalTuple) ParserContext)Result)ExceptionWrapperc@s"eZdZdededdfddZdS)CollectionNotFoundnamestartreturnNcC||_||_dSN)rr)selfrrrD/var/www/html/venv/lib/python3.10/site-packages/invoke/exceptions.py__init__ zCollectionNotFound.__init__)__name__ __module__ __qualname__strrrrrrrsrc@sdeZdZdZ ddddedddfdd Zdeeeffd d Zdefd d Z de defddZ dS)Failurea# Exception subclass representing failure of a command execution. "Failure" may mean the command executed and the shell indicated an unusual result (usually, a non-zero exit code), or it may mean something else, like a ``sudo`` command which was aborted when the supplied password failed authentication. Two attributes allow introspection to determine the nature of the problem: * ``result``: a `.Result` instance with info about the command being executed and, if it ran to completion, how it exited. * ``reason``: a wrapped exception instance if applicable (e.g. a `.StreamWatcher` raised `WatcherError`) or ``None`` otherwise, in which case, it's probably a `Failure` subclass indicating its own specific nature, such as `UnexpectedExit` or `CommandTimedOut`. This class is only rarely raised by itself; most of the time `.Runner.run` (or a wrapper of same, such as `.Context.sudo`) will raise a specific subclass like `UnexpectedExit` or `AuthFailure`. .. versionadded:: 1.0 Nresultr reason WatcherErrorrcCrr)rr)rrrrrrr2 zFailure.__init__cCsbd}d|jjvr |}n|jd}|jjrd}||fSd|jjvr'|}||fS|jd}||fS)a Return stdout/err streams as necessary for error display. Subject to the following rules: - If a given stream was *not* hidden during execution, a placeholder is used instead, to avoid printing it twice. - Only the last 10 lines of stream text is included. - PTY-driven execution will lack stderr, and a specific message to this effect is returned instead of a stderr dump. :returns: Two-tuple of stdout, stderr strings. .. versionadded:: 1.3 z already printedstdoutz n/a (PTYs have no stderr)stderr)rhidetailpty)ralready_printedr"r#rrrstreams_for_display8s    zFailure.streams_for_displaycCs|Sr)_reprrrrr__repr__VszFailure.__repr__kwargscKs>d}d}|rdddd|D}||jj|jj|S)zP Return ``__repr__``-like value from inner result + any kwargs. z<{}: cmd={!r}{}> css |] \}}d||VqdS)z{}={}N)format).0keyvaluerrr bs z Failure._repr..)joinitemsr/ __class__rrcommand)rr,templaterestrrrr)Ys  z Failure._reprr) rrr__doc__rrr rr(r+rr)rrrrrs rcs8eZdZdZdefddZdedeffdd ZZS)UnexpectedExita A shell command ran to completion but exited with an unexpected exit code. Its string representation displays the following: - Command executed; - Exit code; - The last 10 lines of stdout, if it was hidden; - The last 10 lines of stderr, if it was hidden and non-empty (e.g. pty=False; when pty=True, stderr never happens.) .. versionadded:: 1.0 rcCs0|\}}|jj}|jj}d}|||||S)NzZEncountered a bad command exit code! Command: {!r} Exit code: {} Stdout:{} Stderr:{} )r(rr7exitedr/)rr"r#r7r<r8rrr__str__ys  zUnexpectedExit.__str__r,c s"|d|jjtjdi|S)Nr<r) setdefaultrr<superr))rr,r6rrr)szUnexpectedExit._repr) rrrr:rr=rr) __classcell__rrr@rr;jsr;csJeZdZdZdddeddffdd Zdefd d Zdefd d ZZ S) CommandTimedOutzK Raised when a subprocess did not exit within a desired timeframe. rr timeoutrNct|||_dSr)r?rrC)rrrCr@rrrs  zCommandTimedOut.__init__cCs|j|jdS)N)rC)r)rCr*rrrr+zCommandTimedOut.__repr__cCs*|\}}|jj}d}||j|||S)NzRCommand did not complete within {} seconds! Command: {!r} Stdout:{} Stderr:{} )r(rr7r/rC)rr"r#r7r8rrrr=s  zCommandTimedOut.__str__) rrrr:intrrr+r=rArrr@rrBs rBc@s4eZdZdZdddeddfddZdefd d ZdS) AuthFailurea6 An authentication failure, e.g. due to an incorrect ``sudo`` password. .. note:: `.Result` objects attached to these exceptions typically lack exit code information, since the command was never fully executed - the exception was raised instead. .. versionadded:: 1.0 rr promptrNcCrr)rrH)rrrHrrrrrzAuthFailure.__init__cCsd}||jS)Nz3The password submitted to prompt {!r} was rejected.)r/rH)rerrrrrr=s zAuthFailure.__str__)rrrr:rrr=rrrrrGs rGcs6eZdZdZ d dededddffdd ZZS) ParseErrorz An error arising from the parsing of command-line flags/arguments. Ambiguous input, invalid task names, invalid flags, etc. .. versionadded:: 1.0 Nmsgcontextr rcrDr)r?rrL)rrKrLr@rrrs  zParseError.__init__r)rrrr:rrrrArrr@rrJs rJc@sDeZdZdZ d deedeeddfddZedefdd Z dS) Exita Simple custom stand-in for SystemExit. Replaces scattered sys.exit calls, improves testability, allows one to catch an exit request without intercepting real SystemExits (typically an unfriendly thing to do, as most users calling `sys.exit` rather expect it to truly exit.) Defaults to a non-printing, exit-0 friendly termination behavior if the exception is uncaught. If ``code`` (an int) given, that code is used to exit. If ``message`` (a string) given, it is printed to standard error, and the program exits with code ``1`` by default (unless overridden by also giving ``code`` explicitly.) .. versionadded:: 1.0 NmessagecodercCrr)rN_code)rrNrOrrrrr!z Exit.__init__cCs|jdur|jS|jr dSdS)Nr r)rPrNr*rrrrOs z Exit.code)NN) rrrr:rrrFrpropertyrOrrrrrMs rMc@eZdZdZdS) PlatformErrora Raised when an illegal operation occurs for the current platform. E.g. Windows users trying to use functionality requiring the ``pty`` module. Typically used to present a clearer error message to the user. .. versionadded:: 1.0 Nrrrr:rrrrrS rSc@rR)AmbiguousEnvVarze Raised when loading env var config keys has an ambiguous target. .. versionadded:: 1.0 NrTrrrrrVrVc@rR)UncastableEnvVara Raised on attempted env var loads whose default values are too rich. E.g. trying to stuff ``MY_VAR="foo"`` into ``{'my_var': ['uh', 'oh']}`` doesn't make any sense until/if we implement some sort of transform option. .. versionadded:: 1.0 NrTrrrrrX  rXc@rR)UnknownFileTypezi A config file of an unknown type was specified and cannot be loaded. .. versionadded:: 1.0 NrTrrrrrZrWrZc@rR)UnpicklableConfigMemberaw A config file contained module objects, which can't be pickled/copied. We raise this more easily catchable exception instead of letting the (unclearly phrased) TypeError bubble out of the pickle module. (However, to avoid our own fragile catching of that error, we head it off by explicitly testing for module members.) .. versionadded:: 1.0.2 NrTrrrrr[!rUr[r,rcCsvi}|D]2\}}|}|dkr4g}|D]}|}t|dr.t|dkr.d}|dd|g}||q|||<q|S)z Return print-friendly version of a thread-related ``kwargs`` dict. Extra care is taken with ``args`` members which are very long iterables - those need truncating to be useful. args__len__ z2<... remainder truncated during error display ...>N)r5hasattrlenappend)r, printabler1r2itemargnew_argrKrrr_printable_kwargs0s  rfc@sHeZdZUdZeZeded<dedddfddZ de fd d Z dS) ThreadExceptiona One or more exceptions were raised within background threads. The real underlying exceptions are stored in the `exceptions` attribute; see its documentation for data structure details. .. note:: Threads which did not encounter an exception, do not contribute to this exception object and thus are not present inside `exceptions`. .. versionadded:: 1.0 )r . exceptionsr rNcCst||_dSr)tuplerh)rrhrrrrbrEzThreadException.__init__c Csvg}|jD]}d}||tt|jdt|j|j |j qt |jddd|jDd|f}dj|S)NzThread args: {} {} z, css|]}|jjVqdSr)typer)r0xrrrr3rsz*ThreadException.__str__..z z- Saw {} exceptions within threads ({}): {} ) rhrar/rrfr,r4rrkr2 tracebackr`)rdetailsrldetailr\rrrr=es"  zThreadException.__str__) rrrr:rirhr __annotations__rrrr=rrrrrgFs rgc@rR)r a Generic parent exception class for `.StreamWatcher`-related errors. Typically, one of these exceptions indicates a `.StreamWatcher` noticed something anomalous in an output stream, such as an authentication response failure. `.Runner` catches these and attaches them to `.Failure` exceptions so they can be referenced by intermediate code and/or act as extra info for end users. .. versionadded:: 1.0 NrTrrrrr sr c@rR)ResponseNotAcceptedz A responder/watcher class noticed a 'bad' response to its submission. Mostly used by `.FailingResponder` and subclasses, e.g. "oh dear I autosubmitted a sudo password and it was incorrect." .. versionadded:: 1.0 NrTrrrrrqrYrqc@rR)SubprocessPipeErrora# Some problem was encountered handling subprocess pipes (stdout/err/in). Typically only for corner cases; most of the time, errors in this area are raised by the interpreter or the operating system, and end up wrapped in a `.ThreadException`. .. versionadded:: 1.3 NrTrrrrrrs rrN)%r:pprintrrmrtypingrrrrrr parserr runnersr utilr Exceptionrrr;rBrGrJrMrSrVrXrZr[rrfrgr rqrrrrrrs2      Q%"   9