m�
�=5Dc@s�dZd
Z
dkZdkZdkZdkZdkTdkTdkl	Z	l
Z
lZlZl
Z

dklZ
dfd��YZdef
d	��YZed
jo	
dGHn

dS(stdistutils.cmd

Provides the Command class, the base class for the command classes
in the distutils.command package.
s/$Id: cmd.py 37828 2004-11-10 22:23:15Z loewis $N(
t
*(sutilsdir_utils	file_utilsarchive_utilsdep_util(
slogtCommandcBss
tZ
dZgZd
�Zd�Zd�Zd�Zd�Ze	dd�Z
d�Zd	d
�
Zd�Z
e	d�
Ze	d
�
Zd�Ze	d�
Zd�Zd�Zd�Zd�Zd	d�
Zdd�
Zd�Zd�Zd�Ze	d	d�Zdd�
Zd	d	e	d	d�Zd	d	dd	d�Zd	d�
Zd	d	d �Z e	e	d!�Z!e	e	d	d"�Z"RS(#s}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.
    cCs�d
kl
}
t|
|�p

td�n

|itjo

td�n

|
|_	|i
�
d|_|
i
|_
d|_d|_d|_dS(s�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.
        (
sDistributions$dist must be a Distribution instancesCommand is an abstract classiN(tdistutils.disttDistributiont
isinstancetdistt	TypeErrortselft	__class__R
tRuntimeErrortdistributiontinitialize_optionstNonet_dry_runtverbosetforcethelpt	finalized(RRR((t#/usr/lib/python2.4/distutils/cmd.pyt__init__4s





	


			cCsV|
d
jo<
t
|d|
�}|djo
t
|i|
�SqR
|Sn

t|
�dS(Ntdry_runt
_(tattrtgetattrRtmyvalRR
tAttributeError(RRR((Rt__getattr__hs





c

Cs%|i
p
|i�
n

d
|_
dS(Ni
(RRtfinalize_options(
R((Rtensure_finalizedss



c

Cstd
|i�dS(s�
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.
        s,abstract method -- subclass %s must overrideN(R	RR(
R((RR�s	
c

Cstd
|i�dS(sSet 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.
        s,abstract method -- subclass %s must overrideN(R	RR(
R((RR�s

tcCs�d
kl
}
|
djo
d|i�}
n

||
GH|d}xm|iD]b\}}}t
i||�}|ddjo
|d }n

t||�}|d||fGHqKWdS(N(
s
longopt_xlatescommand options for '%s':s  i����t
=s%s = %s(tdistutils.fancy_getoptt
longopt_xlatetheaderRRtget_command_nametindenttuser_optionstoptionRtstringt	translateRtvalue(RR!R#R%R(R R((Rtdump_options�s





	








c

Cstd
|i�dS(s�
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.
        s,abstract method -- subclass %s must overrideN(R	RR(
R((Rtrun�s	i
cCsti||
�
d
S(smIf the current verbosity level is of greater than or equal to
        'level' print 'msg' to stdout.
        N(tlogtleveltmsg(RR-R,((Rtannounce�s
cCs.d
kl
}
|o
|
GHtii�
n

dS(s~Print 'msg' to stdout if the global DEBUG (taken from the
        DISTUTILS_DEBUG environment variable) flag is true.
        (
sDEBUGN(tdistutils.debugtDEBUGR-tsyststdouttflush(RR-R0((Rtdebug_print�s





cCset||
�}|djo
t||
|�
|Sn.
t|�
tj	o
t	d
|
||f�n

|S(Ns'%s' must be a %s (got `%s`)(RRR%tvalRtsetattrtdefaultttypet
StringTypetDistutilsOptionErrortwhat(RR%R;R7R5((Rt_ensure_stringlike�s






cCs|i
|
d
|�
dS(sWEnsure that 'option' is a string; if not defined, set it to
        'default'.
        R&N(RR<R%R7(RR%R7((Rt
ensure_string�s
cCs�t||
�}|d
jo
d
Sn�
t|�
tjo 
t||
ti	d|��
nd
t|�
t
jo,
tt|�}|tg
t
|�
j}n
d}|p
td|
|f�n

d
S(s�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"].
        Ns,\s*|\s+is''%s' must be a list of strings (got %r)(RRR%R5RR8R9R6tretsplittListTypetmapttypestlentokR:(RR%RDR5RB((Rtensure_string_list�s





 


cCsO|i
|
||�}|dj	o)
||�
o
td
||
|f�n

dS(Nserror in '%s' option: (
RR<R%R;R7R5RttesterR:t	error_fmt(RR%RFR;RGR7R5((Rt_ensure_tested_string
s

cCs |i
|
tiid
d�
dS(s5Ensure that 'option' is the name of an existing file.tfilenames$'%s' does not exist or is not a fileN(RRHR%tostpathtisfile(RR%((Rtensure_filename

s



cCs |i
|
tiid
d�
dS(Nsdirectory names)'%s' does not exist or is not a directory(RRHR%RJRKtisdir(RR%((Rtensure_dirname
s


c

Cs)t|d
�o
|iSn
|iiSdS(Ntcommand_name(thasattrRRPRt__name__(
R((RR"
s

cGsj|i
i|
�
}|i�
xG|D]?\}}t	||�d
jo
t||t	||��
q#
q#Wd
S(s>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(RR
tget_command_objtsrc_cmdtsrc_cmd_objRtoption_pairst
src_optiont
dst_optionRRR6(RRTRVRURXRW((Rtset_undefined_options
s





	
cCs#|i
i|
|�}|i�
|S(s�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.
        N(RR
RStcommandtcreatetcmd_objR(RRZR[R\((Rtget_finalized_command8
s



icCs|i
i|
|�S(
N(RR
treinitialize_commandRZtreinit_subcommands(RRZR_((RR^D
s
cCs|i
i|
�

d
S(s�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(RR
trun_commandRZ(RRZ((RR`H
s
c
CsOg}xB|iD]7\}
}|d
jp

||�
o
|i|
�

q
qW|S(sk
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(tcommandsRtsub_commandstcmd_nametmethodRtappend(RRcRaRd((Rtget_sub_commandsP
s





cCs$ti
id
|i�|
f�

dS(Nswarning: %s: %s
(R1tstderrtwriteRR"R-(RR-((Rtwarn`
s
cCs ti
|
||d
|i�

dS(NR(tutiltexecutetfunctargsR-RR(RRlRmR-R,((RRke
s
i�
cCsti
|
|d
|i�

dS(NR(tdir_utiltmkpathtnametmodeRR(RRpRq((RRoi
s
c	Cs)ti
|
||||i|d
|i	�
S(s�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.)RN(
t	file_utilt	copy_filetinfiletoutfilet
preserve_modetpreserve_timesRRtlinkR(RRtRuRvRwRxR,((RRsm
s


c	Cs)ti
|
|||||id
|i	�
S(s\Copy an entire directory tree respecting verbose, dry-run,
        and force flags.
        RN(
Rnt	copy_treeRtRuRvRwtpreserve_symlinksRRR(RRtRuRvRwRzR,((RRy{
s

	

cCsti
|
|d
|i�
S(s#Move a file respectin dry-run flag.RN(Rrt	move_filetsrctdstRR(RR|R}R,((RR{�
s

cCs'd
kl
}
||
|d|i�

dS(s2Spawn an external command respecting dry-run flag.(
sspawnRN(tdistutils.spawntspawntcmdtsearch_pathRR(RR�R�R,R((RR�
s



cCsti
|
|||d
|i�
S(NR(tarchive_utiltmake_archivet	base_nametformattroot_dirtbase_dirRR(RR�R�R�R�((RR��
scCs�|djo 
d
|ti|
d�f}n

|djo
d|}n

t|
�
tjo

|
f
}
n'
t|
�
t	t
fjo

td�n

|i
p
ti|
|�o
|i||||�
n
ti|�

dS(s�
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.
        sgenerating %s from %ss, sskipping %s (inputs unchanged)s9'infiles' must be a string, or a list or tuple of stringsN(texec_msgRRuR&tjointinfilestskip_msgR8R9R@t	TupleTypeRRRtdep_utiltnewer_groupRkRlRmR,R+tdebug(RR�RuRlRmR�R�R,((Rt	make_file�
s	


 







(#RRt
__module__t__doc__RbRRRRRRR)R*R.R4R<R=RERHRMROR"RYR]R^R`RfRiRkRoRsRyR{RR�R�(((RR
s@	4			
			
								tinstall_misccBs;tZ
dZdg
Zd�Zd�Zd�Zd�ZRS(	s{Common base class for installing some files in a subdirectory.
    Currently used by install_data and install_scripts.
    sinstall-dir=t
ds!directory to install the files toc

Csd|_g|_dS(
N(RRtinstall_dirtoutfiles(
R((RR�
s
	
cCs|i
d
|
df�
dS(NtinstallR�(RRYtdirname(RR�((Rt_install_dir_from�
s
cCsrg|_
|
p
dSn

|i|i�

xC|
D];}|i||i�
|i
iti	i
|i|��

q/WdS(
N(RR�tfilelistRoR�t
fRsReRJRKR�(RR�R�((Rt_copy_files�
s
	





c


Cs|i
S(
N(RR�(
R((Rtget_outputs�
s
(sinstall-dir=R�s!directory to install the files to(RRR�R�R$RR�R�R�(((RR��
s					t__main__RD(R�t__revision__R1RJR&R>RBtdistutils.errorst	distutilsRjRnRrR�R�R+R
R�RR(
R�RjR�R�R&R�RrR1R>RnR
RJR+((Rt
?s$


%

��