U
|
G=®dF ã @ sb d Z ddlZddlZddlZddlmZ ddlmZmZm Z m
|
Z
|
m Z ddlm Z G dd dZ dS )ztdistutils.cmd
|
|
Provides the Command class, the base class for the command classes
|
in the distutils.command package.
|
é N)ÚDistutilsOptionError)ÚutilÚdir_utilÚ file_utilÚ archive_utilÚdep_util©Úlogc @ s" e Zd ZdZg Zdd Zdd Zdd Zdd Zd
|
d Z dCddZ
|
dd Z dDddZ dd Z dEddZdFddZdd ZdGd d Zd d Zd!d" Zd#d$ Zd%d& ZdHd'd(ZdId*d+Zd,d- Zd.d/ Zd0d1 ZdJd2d3ZdKd5d6Z dLd7d8Z dMd9d:Z dNd;d<Z dOd=d>Z dPd?d@Z!dQdAdBZ"d S )RÚCommanda} 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.
|
c C sb ddl m} t||s td| jtkr0td|| _| ¡ d| _ |j
|
| _
|
d| _ d| _ d| _ dS )zÞCreate 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 )Ú Distributionz$dist must be a Distribution instancez Command is an abstract classN)Údistutils.distr Ú
|
isinstanceÚ TypeErrorÚ __class__r
|
Ú RuntimeErrorÚ distributionÚinitialize_optionsÚ_dry_runÚverboseÚforceÚhelpÚ finalized)ÚselfÚdistr © r úPD:\z\workplace\VsCode\pyvenv\venv\Lib\site-packages\setuptools/_distutils/cmd.pyÚ__init__/ s
|
|
|
zCommand.__init__c C s< |dkr0t | d| }|d kr*t | j|S |S nt|d S )NÚdry_runÚ_)Úgetattrr ÚAttributeError)r ÚattrÚmyvalr r r Ú __getattr___ s zCommand.__getattr__c C s | j s| ¡ d| _ d S )Né )r Úfinalize_options©r r r r Úensure_finalizedi s zCommand.ensure_finalizedc C s t d| j dS )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 %s must overrideN©r r r& r r r r { s
|
ÿzCommand.initialize_optionsc C s t d| j dS )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( Nr) r& r r r r% s ÿzCommand.finalize_optionsNÚ c C s ddl m} |d kr d| ¡ }| j|| tjd |d }| jD ]R\}}}| |¡}|d dkrn|d d
}t| |}| j|d||f tjd qBd S ) Nr )Ú longopt_xlatezcommand options for '%s':)Úlevelz éÿÿÿÿú=z%s = %s) Údistutils.fancy_getoptr+ Úget_command_nameÚannouncer ÚINFOÚ user_optionsÚ translater )r ÚheaderÚindentr+ Úoptionr Úvaluer r r Ú dump_options s
|
|
ÿzCommand.dump_optionsc C s t d| j dS )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( Nr) r& r r r Úrun¥ s
|
ÿz Command.runr$ c C s t ||¡ dS )zmIf the current verbosity level is of greater than or equal to
|
'level' print 'msg' to stdout.
|
Nr )r Úmsgr, r r r r1 ² s zCommand.announcec C s& ddl m} |r"t| tj ¡ dS )z~Print 'msg' to stdout if the global DEBUG (taken from the
|
DISTUTILS_DEBUG environment variable) flag is true.
|
r )ÚDEBUGN)Údistutils.debugr< ÚprintÚsysÚstdoutÚflush)r r; r< r r r Ú debug_print¸ s zCommand.debug_printc C sB t | |}|d kr"t| || |S t|ts>td|||f |S )Nz '%s' must be a %s (got `%s`))r Úsetattrr Ústrr )r r7 ÚwhatÚdefaultÚvalr r r Ú_ensure_stringlikeÏ s
|
|
ÿzCommand._ensure_stringlikec C s | |d|¡ dS )zWEnsure that 'option' is a string; if not defined, set it to
|
'default'.
|
ÚstringN)rH )r r7 rF r r r Ú ensure_stringÙ s zCommand.ensure_stringc C sp t | |}|dkrdS t|tr6t| |t d|¡ n6t|trTtdd |D }nd}|sltd||f dS )zîEnsure 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 s s | ]}t |tV qd S ©N)r rD )Ú.0Úvr r r Ú <genexpr>ì s z-Command.ensure_string_list.<locals>.<genexpr>Fz''%s' must be a list of strings (got %r)) r r rD rC ÚreÚsplitÚlistÚallr )r r7 rG Úokr r r Úensure_string_listß s
|
|
|
ÿÿzCommand.ensure_string_listc C s6 | |||¡}|d k r2||s2td| ||f d S )Nzerror in '%s' option: )rH r )r r7 ÚtesterrE Ú error_fmtrF rG r r r Ú_ensure_tested_stringô s
|
ÿz Command._ensure_tested_stringc C s | |tjjdd¡ dS )z5Ensure that 'option' is the name of an existing file.Úfilenamez$'%s' does not exist or is not a fileN)rW ÚosÚpathÚisfile©r r7 r r r Úensure_filenameû s þzCommand.ensure_filenamec C s | |tjjdd¡ d S )Nzdirectory namez)'%s' does not exist or is not a directory)rW rY rZ Úisdirr\ r r r Úensure_dirname s þzCommand.ensure_dirnamec C s t | dr| jS | jjS d S )NÚ command_name)Úhasattrr` r Ú__name__r& r r r r0 s
|
zCommand.get_command_namec G sF | j |¡}| ¡ |D ](\}}t| |dkrt| |t|| qdS )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' r rC )r Úsrc_cmdÚ option_pairsÚ src_cmd_objÚ
|
src_optionÚ
|
dst_optionr r r Úset_undefined_options s
|
z Command.set_undefined_optionsc C s | j ||¡}| ¡ |S )zûWrapper 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 rc r' )r ÚcommandÚcreateÚcmd_objr r r Úget_finalized_command$ s z Command.get_finalized_commandr c C s | j ||¡S rK )r Úreinitialize_command)r rj Úreinit_subcommandsr r r rn 0 s ÿz Command.reinitialize_commandc C s | j |¡ dS )zÂRun 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)r rj r r r rp 4 s zCommand.run_commandc C s2 g }| j D ]"\}}|dks"|| r
|
| |¡ q
|
|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.
|
N)Ú sub_commandsÚappend)r ÚcommandsÚcmd_nameÚmethodr r r Úget_sub_commands; s
|
zCommand.get_sub_commandsc C s t d| ¡ |¡ d S )Nzwarning: %s: %s
|
)r Úwarnr0 )r r; r r r rw K s z Command.warnc C s t j|||| jd d S ©N©r )r Úexecuter )r ÚfuncÚargsr; r, r r r rz N s zCommand.executeéÿ c C s t j||| jd d S rx )r Úmkpathr )r ÚnameÚmoder r r r~ Q s zCommand.mkpathc C s t j||||| j || jdS )zÑCopy 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.)ry )r Ú copy_filer r )r ÚinfileÚoutfileÚ preserve_modeÚpreserve_timesÚlinkr, r r r r T s
|
þzCommand.copy_filec C s t j|||||| j | jdS )z\Copy an entire directory tree respecting verbose, dry-run,
|
and force flags.
|
ry )r Ú copy_treer r )r r r r r
Úpreserve_symlinksr, r r r r ] s
|
þzCommand.copy_treec C s t j||| jdS )z$Move a file respecting dry-run flag.ry )r Ú move_filer )r ÚsrcÚdstr, r r r r f s zCommand.move_filec C s ddl m} |||| jd dS )z2Spawn an external command respecting dry-run flag.r )Úspawnry N)Údistutils.spawnr r )r ÚcmdÚ search_pathr, r r r r r j s z Command.spawnc C s t j||||| j||dS )N)r ÚownerÚgroup)r Ú make_archiver )r Ú base_nameÚformatÚroot_dirÚbase_dirr r r r r r o s
|
þzCommand.make_archivec C s |dkrd| }t |tr"|f}nt |ttfs8td|dkrRd|d |¡f }| jsdt ||¡rv| ||||¡ n
|
t
|
|¡ 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 %s (inputs unchanged)z9'infiles' must be a string, or a list or tuple of stringszgenerating %s from %sz, ) r rD rQ Útupler Újoinr r Ú newer_grouprz r Údebug)r Úinfilesr r{ r| Úexec_msgÚskip_msgr, r r r Ú make_fileu s
|
|
ÿzCommand.make_file)Nr* )r$ )N)N)N)r$ )r )Nr$ )r} )r$ r$ Nr$ )r$ r$ r r$ )r$ )r$ r$ )NNNN)NNr$ )#rb Ú
|
__module__Ú __qualname__Ú__doc__rq r r# r' r r% r9 r: r1 rB rH rJ rT rW r] r_ r0 ri rm rn rp rv rw rz r~ r r r r r r r r r r r
|
sZ 0
|
|
|
|
|
|
ÿ
|
|
|
|
|
ÿ
|
ÿ
|
|
|
ÿ
|
ÿr
|
)r¡ r? rY rO Údistutils.errorsr Ú distutilsr r r r r r r
|
r r r r Ú<module> s
|
|
