1j`S @ d Z ddlmZ ddlZddlZddlZddlZddlmZ ddl m
Z
m Z ddl m
Z
mZmZmZmZ ddlmZmZmZmZmZ dd lmZ dd
lmZ e
rdd l m Z dd l m Z m Z e d
Z! edd Z" edd Z# edd Z$ G d d Z%dS )ztdistutils.cmd
Provides the Command class, the base class for the command classes
in the distutils.command package.
) annotationsN)abstractmethod)CallableMutableSequence)
TYPE_CHECKINGAnyClassVarTypeVaroverload ) _modified archive_utildir_util file_utilutillog)DistutilsOptionError Distribution) TypeVarTupleUnpack_Ts _StrPathTstr | os.PathLike[str])bound _BytesPathTbytes | os.PathLike[bytes] _CommandTCommandc e Zd ZU dZg Zded< g Zded< dmd
Zdnd Ze dnd Z
e dnd
Z dodZ e dnd Z
ej fdpdZdqdZdrdZdrdsd Zdtd Zdrd Zdtd Zdtd!Zdud"Zdvd&Zdwdxd+Ze dydzd. Z e dyd{d0 Z dyd|d2Z d}d3Z d~d5Z dqd6Z ddd<Z ddd@Z!e dddI Z"e dddM Z" dddPZ" dddRZ#e dddV Z$e dddX Z$ dddYZ$ ddd]Z%e ddde Z&e dddf Z& dddgZ& dddlZ'dS )r a} Abstract base class for defining command classes, the "worker bees"
of the Distutils. A useful analogy for command classes is to think of
them as subroutines with local variables called "options". The options
are "declared" in 'initialize_options()' and "defined" (given their
final values, aka "finalized") in 'finalize_options()', both of which
must be defined by every command class. The distinction between the
two is necessary because option values might come from the outside
world (command line, config file, ...), and any options dependent on
other options must be computed *after* these outside influences have
been processed -- hence 'finalize_options()'. The "body" of the
subroutine, where it does all its work based on the values of its
options, is the 'run()' method, which must also be implemented by every
command class.
z8ClassVar[list[tuple[str, Callable[[Any], bool] | None]]] sub_commandszHClassVar[list[tuple[str, str, str]] | list[tuple[str, str | None, str]]] user_optionsdistr returnNonec ddl m} t || st d | j t
u rt
d || _ | |j | _ d| _
d| _ d| _ dS )zCreate and initialize a new Command object. Most importantly,
invokes the 'initialize_options()' method, which is the real
initializer and depends on the actual command being
instantiated.
r r z$dist must be a Distribution instancez Command is an abstract classNF)
distutils.distr
isinstance TypeError __class__r RuntimeError distributioninitialize_optionsverboseforcehelp finalized)selfr$ r s P/opt/cloudlinux/venv/lib64/python3.11/site-packages/setuptools/_distutils/cmd.py__init__zCommand.__init__K s 0/////$ -- D BCC C >W $ $ =>> > !!! |
c J | j s| d| _ d S )NT)r2 finalize_optionsr3 s r4 ensure_finalizedzCommand.ensure_finalizedu s) ~ $ ! ! # # # r6 c 2 t d| j d )a Set default values for all the options that this command
supports. Note that these defaults may be overridden by other
commands, by the setup script, by config files, or by the
command-line. Thus, this is not the place to code dependencies
between options; generally, 'initialize_options()' implementations
are just a bunch of "self.foo = None" assignments.
This method must be implemented by all command classes.
abstract method -- subclass must overrider, r+ r9 s r4 r. zCommand.initialize_options & I4> I I I
r6 c 2 t d| j d )a Set final values for all the options that this command supports.
This is always called as late as possible, ie. after any option
assignments from the command-line or from other commands have been
done. Thus, this is the place to code option dependencies: if
'foo' depends on 'bar', then it is safe to set 'foo' from 'bar' as
long as 'foo' still has the same value it was assigned in
'initialize_options()'.
This method must be implemented by all command classes.
r< r= r> r9 s r4 r8 zCommand.finalize_options s& I4> I I I
r6 N c | ddl m} |d| d}| ||z t j |dz }| j D ]j\ }}}| | }|d dk r
|d d }t | | }| || d | z t j kd S )
Nr )
longopt_xlatezcommand options for 'z':)levelz =z = ) distutils.fancy_getoptrC get_command_nameannounceloggingINFOr# translategetattr)r3 headerindentrC option_values r4 dump_optionszCommand.dump_options s 888888 >HT-B-B-D-DHHHF
fvoW\
:::$ - N NLFAq%%m44FbzS D&))E MM&f#8#8#8#88 M M M M M N Nr6 c 2 t d| j d )a A command's raison d'etre: carry out the action it exists to
perform, controlled by the options initialized in
'initialize_options()', customized by other commands, the setup
script, the command-line, and config files, and finalized in
'finalize_options()'. All terminal output and filesystem
interaction should be done by 'run()'.
This method must be implemented by all command classes.
r< r= r> r9 s r4 runz Command.run r? r6 msgobjectrD intc 0 t j || d S Nr )r3 rV rD s r4 rI zCommand.announce s sr6 c t ddl m} |r/t | t j dS dS )z~Print 'msg' to stdout if the global DEBUG (taken from the
DISTUTILS_DEBUG environment variable) flag is true.
r )DEBUGN)distutils.debugr\ printsysstdoutflush)r3 rV r\ s r4 debug_printzCommand.debug_print sM *))))) #JJJ J r6 c t | | }|t | || |S t |t st d| d| d| d |S )N'z ' must be a z (got `z`))rM setattrr) strr )r3 rP whatdefaultvals r4 _ensure_stringlikezCommand._ensure_stringlike so dF## ; D&' * * *NC%% U&'S6'S'St'S'SC'S'S'STT T
r6 rP rf rh
str | Nonec 4 | |d| dS )zWEnsure that 'option' is a string; if not defined, set it to
'default'.
stringN)rj )r3 rP rh s r4
ensure_stringzCommand.ensure_string s"
':::::r6 c 6 t | | }|dS t |t r&t | |t j d| dS t |t rt d |D }nd}|st d| d|d dS )zEnsure that 'option' is a list of strings. If 'option' is
currently a string, we split it either on /,\s*/ or /\s+/, so
"foo bar baz", "foo,bar,baz", and "foo, bar baz" all become
["foo", "bar", "baz"].
Nz,\s*|\s+c 3 @ K | ]}t |t V d S rZ )r) rf ).0vs r4 z-Command.ensure_string_list.. s, 99As++999999r6 Frd z!' must be a list of strings (got )) rM r) rf re resplitlistallr )r3 rP ri oks r4 ensure_string_listzCommand.ensure_string_list s dF## ; F
S
!
!
D&"(;"<"< = = = = =#t$$
99S99999
*IIIIII
r6 c | ||| }|" || st d|z ||fz d S d S )Nzerror in '%s' option: )rj r )r3 rP testerrg error_fmtrh ri s r4 _ensure_tested_stringz Command._ensure_tested_string sX %%fdG<< ?66#;;?&)I5&# F
???r6 c T | |t j j dd dS )z5Ensure that 'option' is the name of an existing file.filenamez$'%s' does not exist or is not a fileN)r~ ospathisfiler3 rP s r4 ensure_filenamezCommand.ensure_filename s2 "" BGNJ0V
r6 c T | |t j j dd d S )Nzdirectory namez)'%s' does not exist or is not a directory)r~ r r isdirr s r4 ensure_dirnamezCommand.ensure_dirname s4 "" GM 7
r6 c H t | d r| j S | j j S )N command_name)hasattrr r+ __name__r9 s r4 rH zCommand.get_command_name s( 4 ( ( +$ $>* *r6 src_cmd option_pairstuple[str, str]c | j | }| |D ]4\ }}t | | t | |t || 5dS )a> Set the values of any "undefined" options from corresponding
option values in some other command object. "Undefined" here means
"is None", which is the convention used to indicate that an option
has not been changed between 'initialize_options()' and
'finalize_options()'. Usually called from 'finalize_options()' for
options that depend on some other command rather than another
option of the same command. 'src_cmd' is the other command from
which option values will be taken (a command object will be created
for it if necessary); the remaining arguments are
'(src_option,dst_option)' tuples which mean "take the value of
'src_option' in the 'src_cmd' command object, and copy it to
'dst_option' in the current command object".
N)r- get_command_objr: rM re )r3 r r src_cmd_obj
src_option
dst_options r4 set_undefined_optionsz Command.set_undefined_options s{ " '77@@ $$&&&&2 L L "J
tZ((0j'+z*J*JKKK L Lr6 Tcommandcreateboolc d | j || }| |S )zWrapper around Distribution's 'get_command_obj()' method: find
(create if necessary and 'create' is true) the command object for
'command', call its 'ensure_finalized()' method, and return the
finalized command object.
)r- r r: )r3 r r cmd_objs r4 get_finalized_commandz Command.get_finalized_command7 s3 #33GVDD """r6 Freinit_subcommandsc d S rZ r3 r r s r4 reinitialize_commandz Command.reinitialize_commandC s #r6 r c d S rZ r r s r4 r z Command.reinitialize_commandG s Cr6
str | Commandc 8 | j || S rZ )r- r r s r4 r z Command.reinitialize_commandK s 55g?QRRRr6 c : | j | dS )zRun some other command: uses the 'run_command()' method of
Distribution, which creates and finalizes the command object if
necessary and then invokes its 'run()' method.
N)r- run_command)r3 r s r4 r zCommand.run_commandP s!
%%g.....r6 list[str]c h g }| j D ]'\ }}| || r| | (|S )ak Determine the sub-commands that are relevant in the current
distribution (ie., that need to be run). This is based on the
'sub_commands' class attribute: each tuple in that list may include
a method that we call to determine if the subcommand needs to be
run for the current distribution. Return a list of command names.
)r" append)r3 commandscmd_namemethods r4 get_sub_commandszCommand.get_sub_commandsW sI $ 1 * * Hf~ ~)))r6 c V t j d| | d S )Nzwarning: %s: %s
)r warningrH )r3 rV s r4 warnz Command.warnf s) ')>)>)@)@#FFFFFr6 r func Callable[[Unpack[_Ts]], object]argstuple[Unpack[_Ts]]c 2 t j ||| d S rZ )r execute)r3 r r rV rD s r4 r zCommand.executei s
T4%%%%%r6 namemodec 0 t j || d S rZ )r mkpath)r3 r r s r4 r zCommand.mkpathr s d#####r6 infiler outfiler
preserve_modepreserve_timeslink tuple[_StrPathT | str, bool]c d S rZ r r3 r r r r r rD s r4 copy_filezCommand.copy_fileu s (+sr6 r r tuple[_BytesPathT | bytes, bool]c d S rZ r r s r4 r zCommand.copy_file s ,/3r6 3str | os.PathLike[str] | bytes | os.PathLike[bytes]@tuple[str | os.PathLike[str] | bytes | os.PathLike[bytes], bool]c @ t j ||||| j | S )zCopy a file respecting verbose, dry-run and force flags. (The
former two default to whatever is in the Distribution object, and
the latter defaults to false for commands that don't define it.))r r r0 r s r4 r zCommand.copy_file s/ "
N
r6 preserve_symlinksc @ t j |||||| j S )z\Copy an entire directory tree respecting verbose, dry-run,
and force flags.
)r copy_treer0 )r3 r r r r r rD s r4 r zCommand.copy_tree s/ !
N
r6 srcdst_StrPathT | strc d S rZ r r3 r r rD s r4 move_filezCommand.move_file s #r6 _BytesPathT | bytesc d S rZ r r s r4 r zCommand.move_file s "cr6 c , t j || S )z$Move a file respecting dry-run flag.)r r r s r4 r zCommand.move_file s "3,,,r6 cmdMutableSequence[str] search_pathc * ddl m} ||| dS )z2Spawn an external command respecting dry-run flag.r )spawnN)distutils.spawnr )r3 r r rD r s r4 r z
Command.spawn s. *)))))
c; r6 base_nameformatroot_dir:str | os.PathLike[str] | bytes | os.PathLike[bytes] | Nonebase_dirownergroupc d S rZ r r3 r r r r r r s r4 make_archivezCommand.make_archive cr6 c d S rZ r r s r4 r zCommand.make_archive r r6 c 6 t j |||||| S )N)r r )r r r s r4 r zCommand.make_archive s0 (
r6 infiles!str | list[str] | tuple[str, ...]exec_msgskip_msgc |d| d}t |t r|f}n+t |t t f st d |)d |d | }| j st j || r|
|||| dS t j | dS )a Special case of 'execute()' for operations that process one or
more input files and generate one output file. Works just like
'execute()', except the operation is skipped and a different
message printed if 'outfile' already exists and is newer than all
files listed in 'infiles'. If the command defined 'self.force',
and it is true, then the command is unconditionally run -- does no
timestamp checks.
Nz skipping z (inputs unchanged)z9'infiles' must be a string, or a list or tuple of stringszgenerating {} from {}z, )
r) rf rw tupler* r joinr0 r
newer_groupr r debug)r3 r r r r r r rD s r4 make_filezCommand.make_file s $ ?7???H gs # # Y jGGGdE]33 Y WXX X .55gtyy?Q?QRRH
: .w@@ LLtXu 5 5 5 5 5
Ih r6 )r$ r r% r& )r% r& )NrA )rV rW rD rX r% r& )rV rW r% r& rZ )rP rf rh rk r% r& )rP rf r% r& )r% rf )r rf r r r% r& )T)r rf r r r% r )F)r rf r r r% r )r r r r r% r )r r r% r )r rf r% r& )r% r )Nr )
r r r r rV rW rD rX r% r& )r )r rf r rX r% r& )TTNr )r r r r r r r r r rk rD rX r% r )r r r r r r r r r rk rD rX r% r )r r r r r r r r r rk rD rX r% r )TTFr )r r r rf r r r r r r rD rX r% r )r )r r r r rD rX r% r )r r r r rD rX r% r )r r r r rD rX r% r )Tr )r r r r rD rX r% r& )NNNN)r rf r rf r r r rk r rk r rk r% rf )NNN)r r r rf r r r rk r rk r rk r% rf )r r r rf r r r rk r rk r rk r% rf )NNr )r r r r r r r r r rW r rW rD rX r% r& )(r
__module__ __qualname____doc__r" __annotations__r# r5 r: r r. r8 rS rU rJ r\ rI rb rj rn rz r~ r r rH r r r r r r r r r r r r r r r r r6 r4 r r " s
> ( ( ( ( T $
^
^
N N N N
^
29 . ; ; ; ; ; *
+ + + + L L L L2 7< X =B X :?S S S S S
/ / / / G G G G & & & & &$ $ $ $ $
# # + + + + X+
# # / / / / X/ # #
2 # #"'
* HI X NO" " " " X" - - - - - QR
PT # X $ X PT #
0 % % % % % % % r6 )&r
__future__r rJ r ru r_ abcr collections.abcr r typingr r r r
r rA r
r r r r _logr errorsr r( r typing_extensionsr r r r r r r r r6 r4 r s # " " " " "
5 5 5 5 5 5 5 5 B B B B B B B B B B B B B B @ @ @ @ @ @ @ @ @ @ @ @ @ @ ( ( ( ( ( ( ++++++66666666
,u
C GK'? @ @ @ gm+GHHH GKy 1 1 1 u u u u u u u u u u r6