o jk@sUddlmZddlmZddlZddlZddlZddlZddl Z ddl Z ddl Z ddl Z ddlmZddlmZddlmZddlmZddlmZdd lmZe jr`dd lmZdd lmZe jd kroe jd Zded<n e jdZded<ee e!e!efZ"ded<GdddZ#ej$d-ddZ%GdddZ&Gdddej'Z(GdddZ)Gd d!d!ej*Z+d.d'd(Z,Gd)d*d*Z-Gd+d,d,Z.dS)/) annotationsN) TracebackType)_compat) formatting)termui)utils)_find_binary_reader)ReadableBuffer)Commandwin32sysz t.TypeAlias CaptureMode)r fd ExceptionInfoc@seZdZUded<ded<ded<d'd d Zd(ddZd)ddZd*d+ddZd*d+ddZd*d+ddZ d,dd Z d-d"d#Z d.d$d%Z d&S)/ EchoingStdin t.BinaryIO_input_outputbool_pausedinputoutputreturnNonecCs||_||_d|_dS)NF)rrr)selfrrr/root/aizidognhua/tmp/workspace/projects/ec89d86c-575f-41c9-af57-ac45cbdbf775/venv/lib/python3.10/site-packages/click/testing.py__init__% zEchoingStdin.__init__xstrt.AnycCs t|j|SN)getattrr)rr rrr __getattr__*s zEchoingStdin.__getattr__rvbytescCs|js |j||Sr#)rrwrite)rr&rrr_echo-s zEchoingStdin._echonintcC||j|Sr#)r)rreadrr+rrrr.3zEchoingStdin.readcCr-r#)r)rread1r/rrrr16r0zEchoingStdin.read1cCr-r#)r)rreadliner/rrrr29r0zEchoingStdin.readline list[bytes]csfddjDS)Ncsg|]}|qSrr).0r rrr =sz*EchoingStdin.readlines..)r readlinesr7rr7rr9<zEchoingStdin.readlinescabc.Iterator[bytes]cstfddjDS)Nc3s|]}|VqdSr#r4r5r7rr @sz(EchoingStdin.__iter__..)iterrr7rr7r__iter__?r:zEchoingStdin.__iter__cCs t|jSr#)reprrr7rrr__repr__Bs zEchoingStdin.__repr__N)rrrrrr)r r!rr")r&r'rr')r*)r+r,rr')rr3)rr;rr!) __name__ __module__ __qualname____annotations__rr%r)r.r1r2r9r>r@rrrrr s         rstreamEchoingStdin | Nonercabc.Generator[None]ccs*|dur dVdSd|_dVd|_dS)NTF)r)rFrrr _pause_echoFs   rIc@sHeZdZUdZded<ded<ded<dd d Zdd d ZdddZdS) _FDCaptureaVRedirect a file descriptor to a temporary file for capture. Saves the current target of *targetfd* via :func:`os.dup`, then redirects it to a temporary file via :func:`os.dup2`. On :meth:`stop`, restores the original ``fd`` and returns the captured bytes. Inspired by Pytest's ``FDCapture``. .. versionadded:: 8.4.0 r, _targetfdsaved_fdzt.BinaryIO | None_tmpfiletargetfdrrcCs||_d|_d|_dSNr*)rKrLrM)rrNrrrr_rz_FDCapture.__init__cCs4t|j|_tjdd|_t|j|jdS)Nr) buffering) osduprKrLtempfile TemporaryFilerMdup2filenor7rrrstartdsz_FDCapture.startr'cCs^|jdus Jdt|j|jt|jd|_|jd|j}|jd|_|S)Nz!_FDCapture.start() was not calledr*r)rMrQrUrLrKcloseseekr.)rdatarrrstopis    z_FDCapture.stopN)rNr,rrrr)rr')rBrCrD__doc__rErrWr[rrrrrJPs    rJcsHeZdZUdZded<dfdd Zdfdd Zdfd d ZZS) BytesIOCopyzdPatch ``io.BytesIO`` to let the written stream be copied to another. .. versionadded:: 8.2 io.BytesIOcopy_torrcst||_dSr#)superrr`)rr` __class__rrr}s  zBytesIOCopy.__init__cst|jdSr#)raflushr`r7rbrrrds zBytesIOCopy.flushbr r,cs|j|t|Sr#)r`r(ra)rrerbrrr(s  zBytesIOCopy.write)r`r_rrr\)rer rr,) rBrCrDr]rErrdr( __classcell__rrrbrr^us r^c@s4eZdZUdZded<ded<ded<d d d Zd S) StreamMixerzMixes `` and `` streams. The result is available in the ``output`` attribute. .. versionadded:: 8.2 r_rr^stdoutstderrrrcCs*t|_t|jd|_t|jd|_dS)N)r`)ioBytesIOrr^rhrir7rrrrs zStreamMixer.__init__Nr\)rBrCrDr]rErrrrrrgs rgcspeZdZUdZded<ded<ded<dfdd ZdddZdfdd ZedddZ edddZ Z S)_NamedTextIOWrapperaA :class:`~io.TextIOWrapper` with custom ``name`` and ``mode`` that does not close its underlying buffer. When ``CliRunner`` runs in ``fd`` mode, ``_original_fd`` is patched to point at the saved (pre-redirection) ``fd``, so C-level consumers that call :meth:`fileno` (like ``faulthandler`` or ``subprocess``) keep working. In the default ``sys`` mode ``_original_fd`` stays at ``-1`` and :meth:`fileno` raises :exc:`io.UnsupportedOperation`, matching the pre-``8.3.3`` behavior. r!_name_moder, _original_fdbufferrnamemodekwargsr"rrc s*tj|fi|||_||_d|_dSrO)rarrmrnro)rrprqrrrsrbrrrs z_NamedTextIOWrapper.__init__cCsdS)zThe buffer this object contains belongs to some other object, so prevent the default ``__del__`` implementation from closing that buffer. .. versionadded:: 8.3.2 Nrr7rrrrXsz_NamedTextIOWrapper.closecs|jdkr|jStS)zReturn the file descriptor of the saved original stream when ``CliRunner`` runs in ``fd`` mode. Otherwise delegate to :class:`~io.TextIOWrapper`, which raises :exc:`io.UnsupportedOperation` for a ``BytesIO``-backed buffer. r)rorarVr7rbrrrVs  z_NamedTextIOWrapper.filenocC|jSr#)rmr7rrrrqz_NamedTextIOWrapper.namecCrtr#)rnr7rrrrrruz_NamedTextIOWrapper.mode) rprrqr!rrr!rsr"rrr\)rr,rA) rBrCrDr]rErrXrVpropertyrqrrrfrrrbrrls    rlr str | bytes | t.IO[t.Any] | Nonecharsetr!rcCsZt|drttd|}|dur|Std|durd}n t|tr(||}t |S)Nr.z t.IO[t.Any]z.Could not find binary reader for input stream.) hasattrr tcast TypeError isinstancer!encoderjrk)rrxr&rrrmake_input_streams    rc@seZdZUdZded<ded<ded<ded<ded <d ed <d ed <ded< ddddZed ddZed ddZed ddZ d ddZ dS)!ResultaCHolds the captured result of an invoked CLI script. :param runner: The runner that created the result :param stdout_bytes: The standard output as bytes. :param stderr_bytes: The standard error as bytes. :param output_bytes: A mix of ``stdout_bytes`` and ``stderr_bytes``, as the user would see it in its terminal. :param return_value: The value returned from the invoked command. :param exit_code: The exit code as integer. :param exception: The exception that happened if one did. :param exc_info: Exception information (exception type, exception instance, traceback type). .. versionchanged:: 8.2 ``stderr_bytes`` no longer optional, ``output_bytes`` introduced and ``mix_stderr`` has been removed. .. versionadded:: 8.0 Added ``return_value``. CliRunnerrunnerr' stdout_bytes stderr_bytes output_bytesr" return_valuer, exit_codeBaseException | None exceptionExceptionInfo | Noneexc_infoNrrc Cs4||_||_||_||_||_||_||_||_dSr#rrrrrrrr) rrrrrrrrrrrrrs  zResult.__init__r!cC|j|jjdddS)aThe terminal output as unicode string, as the user would see it. .. versionchanged:: 8.2 No longer a proxy for ``self.stdout``. Now has its own independent stream that is mixing `` and ``, in the order they were written. replace  )rdecoderrxrr7rrrrsz Result.outputcCr)z&The standard output as unicode string.rrr)rrrrxrr7rrrrh&sz Result.stdoutcCr)zThe standard error as unicode string. .. versionchanged:: 8.2 No longer raise an exception, always returns the `` string. rrr)rrrrxrr7rrrri-sz Result.stderrcCs,|jrt|jnd}dt|jd|dS)Nokay< >)rr?typerB)rexc_strrrrr@8szResult.__repr__r#)rrrr'rr'rr'rr"rr,rrrrrrrA) rBrCrDr]rErrvrrhrir@rrrrrs&      rc@seZdZUdZded<ded<ded<ded<d ed <  d/d0ddZd1ddZ d2d3ddZej d4d5d d!Z d6d7d(d)Z ej d2d8d-d.Z d S)9raThe CLI runner provides functionality to invoke a Click command line script for unittesting purposes in a isolated environment. This only works in single-threaded systems without any concurrency as it changes the global interpreter state. :param charset: the character set for the input and output data. :param env: a dictionary with environment variables for overriding. :param echo_stdin: if this is set to `True`, then reading from `` writes to ``. This is useful for showing examples in some circumstances. Note that regular prompts will automatically echo the input. :param catch_exceptions: Whether to catch any exceptions other than ``SystemExit`` when running :meth:`~CliRunner.invoke`. :param capture: Selects the output capture strategy. ``sys`` (default) captures Python-level writes only and leaves :meth:`sys.stdout.fileno` raising :exc:`io.UnsupportedOperation`, so user code that calls :func:`os.dup2` on ``sys.stdout.fileno()`` cannot clobber the host runner's stdout. ``fd`` redirects file descriptors ``1`` and ``2`` via :func:`os.dup2` to a temporary file, also catching output from stale stream references, C extensions, and subprocesses. ``fd`` is not supported on Windows. .. versionchanged:: 8.4.0 Added the ``capture`` parameter. The default ``sys`` mode no longer exposes the original fd through :meth:`fileno`, reverting the change introduced in ``8.3.3`` that broke Pytest's ``fd``-level capture teardown. Use ``capture="fd"`` to restore that behavior with proper isolation. :issue:`3384` .. versionchanged:: 8.2 Added the ``catch_exceptions`` parameter. .. versionchanged:: 8.2 ``mix_stderr`` parameter has been removed. r!rxcabc.Mapping[str, str | None]envr echo_stdincatch_exceptionsrcaptureutf-8NFTr $cabc.Mapping[str, str | None] | NonerrcCs`|dvr td|d|dkrtjdkrtd|d||_|p#i|_||_||_||_dS)N>rr zcapture=z) is not valid. Choose from 'sys' or 'fd'.rr z( is not supported on Windows. Use 'sys'.) ValueErrorr platformrxrrrr)rrxrrrrrrrrhs    zCliRunner.__init__clir cCs |jpdS)zGiven a command object it will return the default program name for it. The default is the `name` attribute or ``"root"`` if not set. root)rq)rrrrrget_default_prog_name~s zCliRunner.get_default_prog_name overridescCst|j}|r |||S)z8Returns the environment overrides for invoking a script.)dictrupdate)rrr&rrrmake_envs  zCliRunner.make_envrrwcolor9cabc.Generator[tuple[io.BytesIO, io.BytesIO, io.BytesIO]]c#st||j}d}tj}tj}tj}tj} dt_||}t } |j r0t t j t|| j}}t||jdddt_|j rBd_t| j|jdddt_t| j|jd dd d t_t|d*d+fdd } t|d*d+fdd } t|d,dd} | d-d.fdd }tj}tj}tj}tj}tj}tjj| t_| t_| t_|t_|t_   d/d0fd(d) }|tj_i}zy|D]%\}}tj|||<|durztj|=Wqt yYqw|tj|<q| j| j| j!fVW|D]\}}|dur ztj|=Wqt y Yqw|tj|<q|t_|t_|t_|t_|t_|t_|t_|t_| t_tj_dS|D]"\}}|durRztj|=Wq6t yQYq6w|tj|<q6|t_|t_|t_|t_|t_|t_|t_|t_| t_tj_w)1a\A context manager that sets up the isolation for invoking of a command line tool. This sets up `` with the given input data and `os.environ` with the overrides from the given dictionary. This also rebinds some internals in Click to be mocked (like the prompt functionality). This is automatically done in the :meth:`invoke` method. :param input: the input stream to put into `sys.stdin`. :param env: the environment overrides as dictionary. :param color: whether the output should contain color codes. The application can still override this explicitly. .. versionadded:: 8.2 An additional output stream is returned, which is a mix of `` and `` streams. .. versionchanged:: 8.2 Always returns the `` stream. .. versionchanged:: 8.0 `` is opened with ``errors="backslashreplace"`` instead of the default ``"strict"``. .. versionchanged:: 4.0 Added the ``color`` parameter. NPzr)encodingrqrrrzwzbackslashreplace)rrqrrerrorsprompt str | Nonerr!c sdtj|pdz td}Wnty!}zt|d}~wwtj|dtj|S)Nrr)r rhr(nextrstrip StopIterationEOFErrorrd)rvale text_inputrr visible_inputs z*CliRunner.isolation..visible_inputc sRtj|pddtjztdWSty(}zt|d}~ww)Nrrr)r rhr(rdrrrr)rrrrr hidden_inputs z)CliRunner.isolation..hidden_inputechorcSs*tjd}|rtj|tj|S)Nr)r stdinr.rhr(rd)rcharrrr_getchars   z%CliRunner.isolation.._getcharrFt.IO[t.Any] | Noner bool | Nonecs|dur S| Sr#r)rFr) default_colorrrshould_strip_ansisz.CliRunner.isolation..should_strip_ansitabrpdb.Pdb completekeyrt.IO[str] | Nonerhrsr"rcs8|durtj}|durtj}|f|||d|dS)abDefault ``pdb.Pdb`` to real terminal streams during ``CliRunner`` isolation. Without this patch, ``pdb.Pdb.__init__`` inherits from ``cmd.Cmd`` which falls back to ``sys.stdin``/``sys.stdout`` when no explicit streams are provided. During isolation those are ``BytesIO``-backed wrappers, so the debugger reads from an empty buffer and writes to captured output, making interactive debugging impossible. By defaulting to ``sys.__stdin__``/``sys.__stdout__`` (the original terminal streams Python preserves regardless of redirection), debuggers can interact with the user while ``click.echo`` output is still captured normally. This covers ``pdb.set_trace()``, ``breakpoint()``, ``pdb.post_mortem()``, and debuggers that subclass ``pdb.Pdb`` (ipdb, pdbpp). Explicit ``stdin``/``stdout`` arguments are honored and not overridden. Debuggers that do not subclass ``pdb.Pdb`` (pudb, debugpy) are not covered. N)rrrh)r __stdin__ __stdout__)rrrrhrs) old_pdb_initrr_patched_pdb_init s z.CliRunner.isolation.._patched_pdb_initr#)rrrr!)rrrr!)NN)rFrrrrr)rNN) rrrr!rrrhrrsr"rr)"rrxr rrhrir FORCED_WIDTHrrgrr{r|BinaryIOrrl _CHUNK_SIZErIrvisible_prompt_funchidden_prompt_funcrrrrpdbPdbritemsrQenvironget Exceptionr)rrrr bytes_input echo_input old_stdin old_stdout old_stderrold_forced_width stream_mixerrrrrold_visible_prompt_funcold_hidden_prompt_funcold__getchar_funcold_should_strip_ansiold__compat_should_strip_ansirold_envkeyvaluer)rrrr isolations "      %         zCliRunner.isolationargsstr | cabc.Sequence[str] | Nonerextrar"rc Ksd}|dur |j}d} d} |jdkr2td} td} z | | Wn ty1d} } Ynw|j|||d4} | durN| durN| jtj_ | jtj _ d} d} d}t |t r^t |}z|d}Wntys||}Ynwzz|jd|p|d|d |} Wn\ty}z4t}td |j}|durd}|dkr|} t |tstjt |tjd d}|}WYd}~n!d}~wty}z|s΂|} d}t}WYd}~nd}~wwWtjtj | dur| dur| }| }|r| d||r| d|| d}| d}| d}nCtjtj | durU| durU| }| }|rK| d||rU| d|| d}| d}| d}wWdn 1sswYt||||| || |d S) a{Invokes a command in an isolated environment. The arguments are forwarded directly to the command line script, the `extra` keyword arguments are passed to the :meth:`~clickpkg.Command.main` function of the command. This returns a :class:`Result` object. :param cli: the command to invoke :param args: the arguments to invoke. It may be given as an iterable or a string. When given as string it will be interpreted as a Unix shell command. More details at :func:`shlex.split`. :param input: the input data for `sys.stdin`. :param env: the environment overrides. :param catch_exceptions: Whether to catch any other exceptions than ``SystemExit``. If :data:`None`, the value from :class:`CliRunner` is used. :param extra: the keyword arguments to pass to :meth:`main`. :param color: whether the output should contain color codes. The application can still override this explicitly. .. versionadded:: 8.2 The result object has the ``output_bytes`` attribute with the mix of ``stdout_bytes`` and ``stderr_bytes``, as the user would see it in its terminal. .. versionchanged:: 8.2 The result object always returns the ``stderr_bytes`` stream. .. versionchanged:: 8.0 The result object has the ``return_value`` attribute with the value returned from the invoked command. .. versionchanged:: 4.0 Added the ``color`` parameter. .. versionchanged:: 3.0 Added the ``catch_exceptions`` parameter. .. versionchanged:: 3.0 The result object has the ``exc_info`` attribute with the traceback if available. Nrr)rrrr prog_namer)rrzint | t.Any | Nonerr)rrrJrWOSErrorrrLr rhrorir~r!shlexsplitpopKeyErrorrmain SystemExitrr{r|coder,r(rrdr[getvaluer)rrrrrrrrrcap_outcap_err outstreamsrrrrre_codefd_outfd_errrhrirrrrinvokeTs5                  @zCliRunner.invoketemp_dirstr | os.PathLike[str] | Nonecabc.Generator[str]ccsddl}|jdtddt}tj|d}t|z&|VWt||durAddl}z| |WdSt y@YdSwdSt||duraddl}z| |Wwt y`Ywww)aA context manager that creates a temporary directory and changes the current working directory to it. This isolates tests that affect the contents of the CWD to prevent them from interfering with each other. .. warning:: This helper predates Python 3 and modern pytest, and is not thread-safe: it relies on :func:`os.chdir`, which mutates process-global state, and :meth:`invoke` swaps the process-global standard streams too. Parallelize tests with processes (``pytest-xdist``), not threads. Locking the runner (:pr:`3511`, :pr:`3520`, :pr:`3530`) and a ``set_filesystem()`` API (:issue:`3123`) were declined: neither removes the global-state mutation. See :issue:`3700` and :issue:`3501`. :param temp_dir: Create the temporary directory under this directory. If given, the created directory is not removed when exiting. .. deprecated:: 8.5.0 Will be removed in Click 9.0. Use :class:`tempfile.TemporaryDirectory` or pytest's ``tmp_path`` fixture with absolute paths instead. .. versionchanged:: 8.0 Added the ``temp_dir`` parameter. rNz'isolated_filesystem' is deprecated and will be removed in Click 9.0. Use 'tempfile.TemporaryDirectory' or pytest's 'tmp_path' fixture with absolute paths instead.) stacklevel)dir) warningswarnDeprecationWarningrQgetcwdrSmkdtempchdirshutilrmtreer)rrrcwddtr rrrisolated_filesystems<       zCliRunner.isolated_filesystem)rNFTr ) rxr!rrrrrrrrrr)rr rr!r#)rrrr)NNF)rrwrrrrrr)NNNNF)rr rrrrwrrrrrrrr"rr)rrrr) rBrCrDr]rErrr contextlibcontextmanagerrrrrrrrr=s@ $   I r)rFrGrrH)rrwrxr!rr)/ __future__rcollections.abcabccabcrrjrQrrr rStypingr{typesrrrrrrr TYPE_CHECKING _typeshedr corer rLiteralrrEtupler BaseExceptionrrrrIrJrkr^rg TextIOWrapperrlrrrrrrrsB          &  % 7V