Back to index

python3.2  3.2.2
Public Member Functions | Public Attributes | Static Public Attributes
setup.DocBuild Class Reference
Inheritance diagram for setup.DocBuild:
Inheritance graph
[legend]
Collaboration diagram for setup.DocBuild:
Collaboration graph
[legend]

List of all members.

Public Member Functions

def initialize_options
def finalize_options
def spawn
def downloadDocs
def run
def has_pure_modules
def has_c_libraries
def has_ext_modules
def has_scripts

Public Attributes

 build_html
 build_dest
 download
 doc_version
 build_base
 build_purelib
 build_platlib
 build_lib
 build_temp
 build_scripts
 compiler
 plat_name
 debug
 force
 executable

Static Public Attributes

string description = "build everything needed to install"
list user_options
list boolean_options = ['debug', 'force']
list help_options
list sub_commands

Detailed Description

Definition at line 35 of file setup.py.


Member Function Documentation

Definition at line 53 of file setup.py.

00053 
00054     def downloadDocs(self):
00055         workdir = os.getcwd()
00056         # XXX Note: the next strings may change from version to version
00057         url = 'http://www.python.org/ftp/python/doc/%s/html-%s.tar.bz2' % \
00058                 (self.doc_version,self.doc_version)
00059         tarfile = 'html-%s.tar.bz2' % self.doc_version
00060         dirname = 'Python-Docs-%s' % self.doc_version
00061 
00062         if os.path.exists(self.build_html):
00063             raise RuntimeError('%s: already exists, please remove and try again' % self.build_html)
00064         os.chdir(self.build_base)
00065         self.spawn('curl','-O', url)
00066         self.spawn('tar', '-xjf', tarfile)
00067         os.rename(dirname, 'html')
        os.chdir(workdir)

Here is the call graph for this function:

Reimplemented from distutils.command.build.build.

Definition at line 43 of file setup.py.

00043 
00044     def finalize_options(self):
00045         build.finalize_options(self)
00046         if self.build_html is None:
00047             self.build_html = os.path.join(self.build_base, 'html')
00048         if self.build_dest is None:
00049             self.build_dest = os.path.join(self.build_base, 'PythonDocumentation')

Definition at line 134 of file build.py.

00134 
00135     def has_c_libraries(self):
00136         return self.distribution.has_c_libraries()

Here is the caller graph for this function:

Definition at line 137 of file build.py.

00137 
00138     def has_ext_modules(self):
00139         return self.distribution.has_ext_modules()

Here is the caller graph for this function:

Definition at line 131 of file build.py.

00131 
00132     def has_pure_modules(self):
00133         return self.distribution.has_pure_modules()

Here is the caller graph for this function:

def distutils.command.build.build.has_scripts (   self) [inherited]

Definition at line 140 of file build.py.

00140 
00141     def has_scripts(self):
00142         return self.distribution.has_scripts()
00143 

Reimplemented from distutils.command.build.build.

Definition at line 36 of file setup.py.

00036 
00037     def initialize_options(self):
00038         build.initialize_options(self)
00039         self.build_html = None
00040         self.build_dest = None
00041         self.download = 1
00042         self.doc_version = MINOR_VERSION # Only needed if download is true

def distutils.command.build.build.run (   self) [inherited]

Definition at line 119 of file build.py.

00119 
00120     def run(self):
00121         # Run all relevant sub-commands.  This will be some subset of:
00122         #  - build_py      - pure Python modules
00123         #  - build_clib    - standalone C libraries
00124         #  - build_ext     - Python extensions
00125         #  - build_scripts - (Python) scripts
00126         for cmd_name in self.get_sub_commands():
00127             self.run_command(cmd_name)
00128 

Here is the call graph for this function:

Here is the caller graph for this function:

def setup.DocBuild.spawn (   self,
  args 
)

Definition at line 50 of file setup.py.

00050 
00051     def spawn(self, *args):
00052         spawn(args, 1,  self.verbose, self.dry_run)

Here is the call graph for this function:

Here is the caller graph for this function:


Member Data Documentation

list distutils.command.build.build.boolean_options = ['debug', 'force'] [static, inherited]

Definition at line 47 of file build.py.

Definition at line 55 of file build.py.

Definition at line 39 of file setup.py.

Definition at line 38 of file setup.py.

Definition at line 60 of file build.py.

Definition at line 59 of file build.py.

Definition at line 58 of file build.py.

Definition at line 62 of file build.py.

Definition at line 61 of file build.py.

Definition at line 63 of file build.py.

Definition at line 65 of file build.py.

string distutils.command.build.build.description = "build everything needed to install" [static, inherited]

Definition at line 18 of file build.py.

Definition at line 41 of file setup.py.

Definition at line 40 of file setup.py.

Definition at line 67 of file build.py.

Definition at line 66 of file build.py.

Initial value:
[
        ('help-compiler', None,
         "list available compilers", show_compilers),
        ]

Definition at line 49 of file build.py.

Definition at line 64 of file build.py.

Initial value:
[('build_py',      has_pure_modules),
                    ('build_clib',    has_c_libraries),
                    ('build_ext',     has_ext_modules),
                    ('build_scripts', has_scripts),
                   ]

Definition at line 144 of file build.py.

Initial value:
[
        ('build-base=', 'b',
         "base directory for build library"),
        ('build-purelib=', None,
         "build directory for platform-neutral distributions"),
        ('build-platlib=', None,
         "build directory for platform-specific distributions"),
        ('build-lib=', None,
         "build directory for all distribution (defaults to either " +
         "build-purelib or build-platlib"),
        ('build-scripts=', None,
         "build directory for scripts"),
        ('build-temp=', 't',
         "temporary build directory"),
        ('plat-name=', 'p',
         "platform name to build for, if supported "
         "(default: %s)" % get_platform()),
        ('compiler=', 'c',
         "specify the compiler type"),
        ('debug', 'g',
         "compile extensions and libraries with debugging information"),
        ('force', 'f',
         "forcibly build everything (ignore file timestamps)"),
        ('executable=', 'e',
         "specify final destination interpreter path (build.py)"),
        ]

Definition at line 20 of file build.py.


The documentation for this class was generated from the following file: