lJc @sdZdZddkZddkZddkZddkZddkTddkTddkl Z l Z l Z l Z l Z ddklZdfdYZd efd YZed jo d GHndS( 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 $iN(t*(tutiltdir_utilt file_utilt archive_utiltdep_util(tlogtCommandcBsseZdZgZdZdZdZdZdZd#ddZ dZ d d Z d Z d#d Zd#d ZdZd#dZdZdZdZdZd dZddZdZdZdZd#d dZddZd d d#d dZd d dd dZd dZd d d Z d#d#d!Z!d#d#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. cCsddkl}t||p tdn|itjo tdn||_|id|_ |i |_ d|_ d|_ d|_dS(sCreate 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. i(t Distributions$dist must be a Distribution instancesCommand is an abstract classiN(tdistutils.distRt isinstancet TypeErrort __class__Rt RuntimeErrort distributiontinitialize_optionstNonet_dry_runtverbosetforcethelpt finalized(tselftdistR((s /sys/lib/python/distutils/cmd.pyt__init__4s       cCsV|djo<t|d|}|djot|i|SqR|Sn t|dS(Ntdry_runt_(tgetattrRRtAttributeError(Rtattrtmyval((s /sys/lib/python/distutils/cmd.pyt __getattr__hs   cCs%|ip|ind|_dS(Ni(Rtfinalize_options(R((s /sys/lib/python/distutils/cmd.pytensure_finalizedss cCstd|idS(sSet 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 R (R((s /sys/lib/python/distutils/cmd.pyRs cCstd|idS(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 R (R((s /sys/lib/python/distutils/cmd.pyR s tcCsddkl}|djod|i}n||GH|d}xm|iD]b\}}}ti||}|ddjo|d }nt||}|d||fGHqNWdS(Ni(t longopt_xlatescommand options for '%s':s t=s%s = %s(tdistutils.fancy_getoptR#Rtget_command_namet user_optionststringt translateR(RtheadertindentR#toptionRtvalue((s /sys/lib/python/distutils/cmd.pyt dump_optionss    cCstd|idS(sA 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 R (R((s /sys/lib/python/distutils/cmd.pytruns icCsti||dS(smIf the current verbosity level is of greater than or equal to 'level' print 'msg' to stdout. N(R(Rtmsgtlevel((s /sys/lib/python/distutils/cmd.pytannouncescCs1ddkl}|o|GHtiindS(s~Print 'msg' to stdout if the global DEBUG (taken from the DISTUTILS_DEBUG environment variable) flag is true. i(tDEBUGN(tdistutils.debugR3tsyststdouttflush(RR0R3((s /sys/lib/python/distutils/cmd.pyt debug_printscCset||}|djot||||Sn.t|tj otd|||fn|S(Ns'%s' must be a %s (got `%s`)(RRtsetattrttypet StringTypetDistutilsOptionError(RR,twhattdefaulttval((s /sys/lib/python/distutils/cmd.pyt_ensure_stringlikes cCs|i|d|dS(sWEnsure that 'option' is a string; if not defined, set it to 'default'. R(N(R@(RR,R>((s /sys/lib/python/distutils/cmd.pyt ensure_stringscCst||}|djodSnt|tjo t||tid|ndt|tjo,tt|}|tgt |j}nd}|pt d||fndS(sEnsure 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:R;R9tretsplittListTypetmaptlenR<(RR,R?ttypestok((s /sys/lib/python/distutils/cmd.pytensure_string_lists  cCsO|i|||}|dj o)|| otd|||fndS(Nserror in '%s' option: (R@RR<(RR,ttesterR=t error_fmtR>R?((s /sys/lib/python/distutils/cmd.pyt_ensure_tested_stringscCs |i|tiidddS(s5Ensure that 'option' is the name of an existing file.tfilenames$'%s' does not exist or is not a fileN(RLtostpathtisfile(RR,((s /sys/lib/python/distutils/cmd.pytensure_filename scCs |i|tiidddS(Nsdirectory names)'%s' does not exist or is not a directory(RLRNROtisdir(RR,((s /sys/lib/python/distutils/cmd.pytensure_dirnamescCs)t|do |iSn |iiSdS(Nt command_name(thasattrRTR t__name__(R((s /sys/lib/python/distutils/cmd.pyR&s cGsj|ii|}|ixG|D]?\}}t||djot||t||q#q#WdS(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(Rtget_command_objR!RRR9(Rtsrc_cmdt option_pairst src_cmd_objt src_optiont dst_option((s /sys/lib/python/distutils/cmd.pytset_undefined_optionss   cCs#|ii||}|i|S(sWrapper 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. (RRWR!(Rtcommandtcreatetcmd_obj((s /sys/lib/python/distutils/cmd.pytget_finalized_command8s icCs|ii||S(N(Rtreinitialize_command(RR^treinit_subcommands((s /sys/lib/python/distutils/cmd.pyRbDs cCs|ii|dS(sRun 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(Rt run_command(RR^((s /sys/lib/python/distutils/cmd.pyRdHscCsOg}xB|iD]7\}}|djp ||o|i|qqW|S(skDetermine 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(t sub_commandsRtappend(Rtcommandstcmd_nametmethod((s /sys/lib/python/distutils/cmd.pytget_sub_commandsPs  cCs$tiid|i|fdS(Nswarning: %s: %s (R5tstderrtwriteR&(RR0((s /sys/lib/python/distutils/cmd.pytwarn`s cCs ti|||d|idS(NR(RtexecuteR(RtfunctargsR0R1((s /sys/lib/python/distutils/cmd.pyRnesicCsti||d|idS(NR(RtmkpathR(Rtnametmode((s /sys/lib/python/distutils/cmd.pyRqisc Cs)ti|||||i |d|iS(sCopy 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(Rt copy_fileRR(Rtinfiletoutfilet preserve_modetpreserve_timestlinkR1((s /sys/lib/python/distutils/cmd.pyRtms c Cs)ti||||||i d|iS(s\Copy an entire directory tree respecting verbose, dry-run, and force flags. R(Rt copy_treeRR(RRuRvRwRxtpreserve_symlinksR1((s /sys/lib/python/distutils/cmd.pyRz{s   cCsti||d|iS(s#Move a file respectin dry-run flag.R(Rt move_fileR(RtsrctdstR1((s /sys/lib/python/distutils/cmd.pyR|scCs*ddkl}|||d|idS(s2Spawn an external command respecting dry-run flag.i(tspawnRN(tdistutils.spawnRR(Rtcmdt search_pathR1R((s /sys/lib/python/distutils/cmd.pyRscCsti||||d|iS(NR(Rt make_archiveR(Rt base_nametformattroot_dirtbase_dir((s /sys/lib/python/distutils/cmd.pyRscCs|djo d|ti|df}n|djod|}nt|tjo |f}n't|ttfjo tdn|ipt i ||o|i ||||nt i |dS(sSpecial 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(RR(tjoinR:R;RDt TupleTypeR RRt newer_groupRnRtdebug(RtinfilesRvRoRptexec_msgtskip_msgR1((s /sys/lib/python/distutils/cmd.pyt make_files    N(#RVt __module__t__doc__ReRRR!RR RR.R/R2R8R@RARIRLRQRSR&R]RaRbRdRjRmRnRqRtRzR|RRR(((s /sys/lib/python/distutils/cmd.pyRsB 4                   t install_misccBs;eZdZdgZdZdZdZdZRS( s{Common base class for installing some files in a subdirectory. Currently used by install_data and install_scripts. s install-dir=tds!directory to install the files tocCsd|_g|_dS(N(Rt install_dirtoutfiles(R((s /sys/lib/python/distutils/cmd.pyRs cCs|id|dfdS(NtinstallR(R](Rtdirname((s /sys/lib/python/distutils/cmd.pyt_install_dir_fromscCsrg|_|pdSn|i|ixC|D];}|i||i|iitii|i|q/WdS(N(RRqRRtRfRNROR(Rtfilelisttf((s /sys/lib/python/distutils/cmd.pyt _copy_filess cCs|iS(N(R(R((s /sys/lib/python/distutils/cmd.pyt get_outputss(s install-dir=Rs!directory to install the files to(RVRRR'RRRR(((s /sys/lib/python/distutils/cmd.pyRs     t__main__RH(Rt __revision__R5RNR(RBRGtdistutils.errorst distutilsRRRRRRRRRV(((s /sys/lib/python/distutils/cmd.pyss0  (