Blame - Doc/distutils/apiref.rst - platform/external/python/cpython3

2009-01-03 21:18:54 +0000

[diff] [blame]

763

.. %

Georg Brandl

2007-08-15 14:28:22 +0000

[diff] [blame]

764

.. % The following modules implement concrete subclasses of the abstract

765

.. % \class{CCompiler} class. They should not be instantiated directly, but should

766

.. % be created using \function{distutils.ccompiler.new_compiler()} factory

.. % function.

:mod:`distutils.unixccompiler` --- Unix C Compiler

771

==================================================

772

773

.. module:: distutils.unixccompiler

774

:synopsis: UNIX C Compiler

775

776

777

This module provides the :class:`UnixCCompiler` class, a subclass of

778

:class:`CCompiler` that handles the typical Unix-style command-line C compiler:

779

780

* macros defined with :option:`-Dname[=value]`

781

782

* macros undefined with :option:`-Uname`

783

784

* include search directories specified with :option:`-Idir`

785

786

* libraries specified with :option:`-llib`

787

788

* library search directories specified with :option:`-Ldir`

789

790

* compile handled by :program:`cc` (or similar) executable with :option:`-c`

791

option: compiles :file:`.c` to :file:`.o`

792

793

* link static library handled by :program:`ar` command (possibly with

794

:program:`ranlib`)

795

796

* link shared library handled by :program:`cc` :option:`-shared`

797

798

799

:mod:`distutils.msvccompiler` --- Microsoft Compiler

800

====================================================

801

802

.. module:: distutils.msvccompiler

803

:synopsis: Microsoft Compiler

804

805

806

This module provides :class:`MSVCCompiler`, an implementation of the abstract

807

:class:`CCompiler` class for Microsoft Visual Studio. Typically, extension

808

modules need to be compiled with the same compiler that was used to compile

809

Python. For Python 2.3 and earlier, the compiler was Visual Studio 6. For Python

810

2.4 and 2.5, the compiler is Visual Studio .NET 2003. The AMD64 and Itanium

811

binaries are created using the Platform SDK.

812

813

:class:`MSVCCompiler` will normally choose the right compiler, linker etc. on

814

its own. To override this choice, the environment variables *DISTUTILS_USE_SDK*

815

and *MSSdk* must be both set. *MSSdk* indicates that the current environment has

816

been setup by the SDK's ``SetEnv.Cmd`` script, or that the environment variables

817

had been registered when the SDK was installed; *DISTUTILS_USE_SDK* indicates

818

that the distutils user has made an explicit choice to override the compiler

819

selection by :class:`MSVCCompiler`.

820

821

822

:mod:`distutils.bcppcompiler` --- Borland Compiler

823

==================================================

824

825

.. module:: distutils.bcppcompiler

826

827

828

This module provides :class:`BorlandCCompiler`, an subclass of the abstract

829

:class:`CCompiler` class for the Borland C++ compiler.

830

831

832

:mod:`distutils.cygwincompiler` --- Cygwin Compiler

833

===================================================

834

835

.. module:: distutils.cygwinccompiler

836

837

838

This module provides the :class:`CygwinCCompiler` class, a subclass of

839

:class:`UnixCCompiler` that handles the Cygwin port of the GNU C compiler to

840

Windows. It also contains the Mingw32CCompiler class which handles the mingw32

841

port of GCC (same as cygwin in no-cygwin mode).

842

843

844

:mod:`distutils.emxccompiler` --- OS/2 EMX Compiler

845

===================================================

846

847

.. module:: distutils.emxccompiler

848

:synopsis: OS/2 EMX Compiler support

849

850

851

This module provides the EMXCCompiler class, a subclass of

852

:class:`UnixCCompiler` that handles the EMX port of the GNU C compiler to OS/2.

853

854

Georg Brandl

2007-08-15 14:28:22 +0000

[diff] [blame]

855

:mod:`distutils.archive_util` --- Archiving utilities

856

======================================================

857

858

.. module:: distutils.archive_util

859

:synopsis: Utility functions for creating archive files (tarballs, zip files, ...)

860

861

862

This module provides a few functions for creating archive files, such as

863

tarballs or zipfiles.

864

865

866

.. function:: make_archive(base_name, format[, root_dir=None, base_dir=None, verbose=0, dry_run=0])

867

868

Create an archive file (eg. ``zip`` or ``tar``). *base_name* is the name of

869

the file to create, minus any format-specific extension; *format* is the

870

archive format: one of ``zip``, ``tar``, ``ztar``, or ``gztar``. *root_dir* is

871

a directory that will be the root directory of the archive; ie. we typically

872

``chdir`` into *root_dir* before creating the archive. *base_dir* is the

873

directory where we start archiving from; ie. *base_dir* will be the common

874

prefix of all files and directories in the archive. *root_dir* and *base_dir*

875

both default to the current directory. Returns the name of the archive file.

876

Georg Brandl

2009-04-27 16:23:47 +0000

[diff] [blame]

877

.. XXX This should be changed to support bz2 files.

Georg Brandl

2007-08-15 14:28:22 +0000

[diff] [blame]

878

879

880

.. function:: make_tarball(base_name, base_dir[, compress='gzip', verbose=0, dry_run=0])

881

882

'Create an (optional compressed) archive as a tar file from all files in and

883

under *base_dir*. *compress* must be ``'gzip'`` (the default), ``'compress'``,

884

``'bzip2'``, or ``None``. Both :program:`tar` and the compression utility named

885

by *compress* must be on the default program search path, so this is probably

886

Unix-specific. The output tar file will be named :file:`base_dir.tar`,

887

possibly plus the appropriate compression extension (:file:`.gz`, :file:`.bz2`

888

or :file:`.Z`). Return the output filename.

889

Georg Brandl

2009-04-27 16:23:47 +0000

[diff] [blame]

890

.. XXX This should be replaced with calls to the :mod:`tarfile` module.

Georg Brandl

2007-08-15 14:28:22 +0000

[diff] [blame]

891

892

893

.. function:: make_zipfile(base_name, base_dir[, verbose=0, dry_run=0])

894

895

Create a zip file from all files in and under *base_dir*. The output zip file

Éric Araujo

4433a5f

2010-12-15 20:26:30 +0000

[diff] [blame]

896

will be named *base_name* + :file:`.zip`. Uses either the :mod:`zipfile` Python

Georg Brandl

2007-08-15 14:28:22 +0000

[diff] [blame]

897

module (if available) or the InfoZIP :file:`zip` utility (if installed and

898

found on the default search path). If neither tool is available, raises

899

:exc:`DistutilsExecError`. Returns the name of the output zip file.

900

901

902

:mod:`distutils.dep_util` --- Dependency checking

903

=================================================

904

905

.. module:: distutils.dep_util

906

:synopsis: Utility functions for simple dependency checking

907

908

909

This module provides functions for performing simple, timestamp-based

910

dependency of files and groups of files; also, functions based entirely on such

911

timestamp dependency analysis.

912

913

914

.. function:: newer(source, target)

915

916

Return true if *source* exists and is more recently modified than *target*, or

917

if *source* exists and *target* doesn't. Return false if both exist and *target*

918

is the same age or newer than *source*. Raise :exc:`DistutilsFileError` if

919

*source* does not exist.

920

921

922

.. function:: newer_pairwise(sources, targets)

923

924

Walk two filename lists in parallel, testing if each source is newer than its

925

corresponding target. Return a pair of lists (*sources*, *targets*) where

926

source is newer than target, according to the semantics of :func:`newer`

927

928

.. % % equivalent to a listcomp...

929

930

931

.. function:: newer_group(sources, target[, missing='error'])

932

933

Return true if *target* is out-of-date with respect to any file listed in

934

*sources* In other words, if *target* exists and is newer than every file in

935

*sources*, return false; otherwise return true. *missing* controls what we do

936

when a source file is missing; the default (``'error'``) is to blow up with an

937

:exc:`OSError` from inside :func:`os.stat`; if it is ``'ignore'``, we silently

938

drop any missing source files; if it is ``'newer'``, any missing source files

939

make us assume that *target* is out-of-date (this is handy in "dry-run" mode:

940

it'll make you pretend to carry out commands that wouldn't work because inputs

941

are missing, but that doesn't matter because you're not actually going to run

the commands).

:mod:`distutils.dir_util` --- Directory tree operations

946

=======================================================

947

948

.. module:: distutils.dir_util

949

:synopsis: Utility functions for operating on directories and directory trees

950

951

952

This module provides functions for operating on directories and trees of

directories.

Georg Brandl

2008-05-26 17:55:52 +0000

[diff] [blame]

956

.. function:: mkpath(name[, mode=0o777, verbose=0, dry_run=0])

Georg Brandl

2007-08-15 14:28:22 +0000

[diff] [blame]

957

958

Create a directory and any missing ancestor directories. If the directory

959

already exists (or if *name* is the empty string, which means the current

960

directory, which of course exists), then do nothing. Raise

961

:exc:`DistutilsFileError` if unable to create some directory along the way (eg.

962

some sub-path exists, but is a file rather than a directory). If *verbose* is

963

true, print a one-line summary of each mkdir to stdout. Return the list of

964

directories actually created.

965

966

Georg Brandl

f4a4123

2008-05-26 17:55:52 +0000

[diff] [blame]

967

.. function:: create_tree(base_dir, files[, mode=0o777, verbose=0, dry_run=0])

Georg Brandl

2007-08-15 14:28:22 +0000

[diff] [blame]

968

969

Create all the empty directories under *base_dir* needed to put *files* there.

970

*base_dir* is just the a name of a directory which doesn't necessarily exist

971

yet; *files* is a list of filenames to be interpreted relative to *base_dir*.

972

*base_dir* + the directory portion of every file in *files* will be created if

973

it doesn't already exist. *mode*, *verbose* and *dry_run* flags are as for

:func:`mkpath`.

.. function:: copy_tree(src, dst[, preserve_mode=1, preserve_times=1, preserve_symlinks=0, update=0, verbose=0, dry_run=0])

978

979

Copy an entire directory tree *src* to a new location *dst*. Both *src* and

980

*dst* must be directory names. If *src* is not a directory, raise

981

:exc:`DistutilsFileError`. If *dst* does not exist, it is created with

982

:func:`mkpath`. The end result of the copy is that every file in *src* is

983

copied to *dst*, and directories under *src* are recursively copied to *dst*.

984

Return the list of files that were copied or might have been copied, using their

985

output name. The return value is unaffected by *update* or *dry_run*: it is

986

simply the list of all files under *src*, with the names changed to be under

987

*dst*.

988

989

*preserve_mode* and *preserve_times* are the same as for :func:`copy_file` in

990

:mod:`distutils.file_util`; note that they only apply to regular files, not to

991

directories. If *preserve_symlinks* is true, symlinks will be copied as

992

symlinks (on platforms that support them!); otherwise (the default), the

993

destination of the symlink will be copied. *update* and *verbose* are the same

994

as for :func:`copy_file`.

995

996

997

.. function:: remove_tree(directory[, verbose=0, dry_run=0])

998

999

Recursively remove *directory* and all files and directories underneath it. Any

1000

errors are ignored (apart from being reported to ``sys.stdout`` if *verbose* is

1001

true).

1002

Georg Brandl

d5f2d6e

2010-07-31 09:15:10 +0000

[diff] [blame]

1003

.. XXX Some of this could be replaced with the shutil module?

Georg Brandl

2007-08-15 14:28:22 +0000

[diff] [blame]

1004

1005

1006

:mod:`distutils.file_util` --- Single file operations

1007

=====================================================

1008

1009

.. module:: distutils.file_util

1010

:synopsis: Utility functions for operating on single files

1011

1012

1013

This module contains some utility functions for operating on individual files.

1014

1015

1016

.. function:: copy_file(src, dst[, preserve_mode=1, preserve_times=1, update=0, link=None, verbose=0, dry_run=0])

1017

1018

Copy file *src* to *dst*. If *dst* is a directory, then *src* is copied there

1019

with the same name; otherwise, it must be a filename. (If the file exists, it

1020

will be ruthlessly clobbered.) If *preserve_mode* is true (the default), the

1021

file's mode (type and permission bits, or whatever is analogous on the

1022

current platform) is copied. If *preserve_times* is true (the default), the

1023

last-modified and last-access times are copied as well. If *update* is true,

1024

*src* will only be copied if *dst* does not exist, or if *dst* does exist but

1025

is older than *src*.

1026

1027

*link* allows you to make hard links (using :func:`os.link`) or symbolic links

1028

(using :func:`os.symlink`) instead of copying: set it to ``'hard'`` or

1029

``'sym'``; if it is ``None`` (the default), files are copied. Don't set *link*

1030

on systems that don't support it: :func:`copy_file` doesn't check if hard or

1031

symbolic linking is available. It uses :func:`_copy_file_contents` to copy file

1032

contents.

1033

1034

Return a tuple ``(dest_name, copied)``: *dest_name* is the actual name of the

1035

output file, and *copied* is true if the file was copied (or would have been

1036

copied, if *dry_run* true).

1037

1038

.. % XXX if the destination file already exists, we clobber it if

1039

.. % copying, but blow up if linking. Hmmm. And I don't know what

1040

.. % macostools.copyfile() does. Should definitely be consistent, and

1041

.. % should probably blow up if destination exists and we would be

1042

.. % changing it (ie. it's not already a hard/soft link to src OR

1043

.. % (not update) and (src newer than dst)).

1044

1045

1046

.. function:: move_file(src, dst[, verbose, dry_run])

1047

1048

Move file *src* to *dst*. If *dst* is a directory, the file will be moved into

1049

it with the same name; otherwise, *src* is just renamed to *dst*. Returns the

1050

new full name of the file.

.. warning::

Benjamin Peterson

2009-04-05 19:13:16 +0000

[diff] [blame]

1054

Handles cross-device moves on Unix using :func:`copy_file`. What about

1055

other systems?

Georg Brandl

2007-08-15 14:28:22 +0000

[diff] [blame]

1056

1057

1058

.. function:: write_file(filename, contents)

1059

1060

Create a file called *filename* and write *contents* (a sequence of strings

1061

without line terminators) to it.

1062

1063

1064

:mod:`distutils.util` --- Miscellaneous other utility functions

1065

===============================================================

1066

1067

.. module:: distutils.util

1068

:synopsis: Miscellaneous other utility functions

1069

1070

1071

This module contains other assorted bits and pieces that don't fit into any

1072

other utility module.

1073

1074

1075

.. function:: get_platform()

1076

1077

Return a string that identifies the current platform. This is used mainly to

1078

distinguish platform-specific build directories and platform-specific built

1079

distributions. Typically includes the OS name and version and the architecture

1080

(as supplied by 'os.uname()'), although the exact information included depends

1081

on the OS; eg. for IRIX the architecture isn't particularly important (IRIX only

1082

runs on SGI hardware), but for Linux the kernel version isn't particularly

1083

important.

1084

1085

Examples of returned values:

* ``linux-i586``

* ``linux-alpha``

* ``solaris-2.6-sun4u``

* ``irix-5.3``

* ``irix64-6.2``

For non-POSIX platforms, currently just returns ``sys.platform``.

1094

Benjamin Peterson

2009-04-05 19:13:16 +0000

[diff] [blame]

1095

For Mac OS X systems the OS version reflects the minimal version on which

Benjamin Peterson

2008-12-30 17:56:45 +0000

[diff] [blame]

1096

binaries will run (that is, the value of ``MACOSX_DEPLOYMENT_TARGET``

Georg Brandl

2009-01-03 21:18:54 +0000

[diff] [blame]

1097

during the build of Python), not the OS version of the current system.

Benjamin Peterson

2008-12-30 17:56:45 +0000

[diff] [blame]

1098

Benjamin Peterson

2009-04-05 19:13:16 +0000

[diff] [blame]

1099

For universal binary builds on Mac OS X the architecture value reflects

Benjamin Peterson

2008-12-30 17:56:45 +0000

[diff] [blame]

1100

the univeral binary status instead of the architecture of the current

Georg Brandl

2009-01-03 21:18:54 +0000

[diff] [blame]

1101

processor. For 32-bit universal binaries the architecture is ``fat``,

1102

for 64-bit universal binaries the architecture is ``fat64``, and

Ronald Oussoren

bea37ae

2009-09-15 19:16:02 +0000

[diff] [blame]

1103

for 4-way universal binaries the architecture is ``universal``. Starting

1104

from Python 2.7 and Python 3.2 the architecture ``fat3`` is used for

1105

a 3-way universal build (ppc, i386, x86_64) and ``intel`` is used for

1106

a univeral build with the i386 and x86_64 architectures

Benjamin Peterson

2008-12-30 17:56:45 +0000

[diff] [blame]

1107

Benjamin Peterson

2009-04-05 19:13:16 +0000

[diff] [blame]

1108

Examples of returned values on Mac OS X:

Benjamin Peterson

2008-12-30 17:56:45 +0000

[diff] [blame]

1109

1110

* ``macosx-10.3-ppc``

1111

1112

* ``macosx-10.3-fat``

1113

1114

* ``macosx-10.5-universal``

1115

Ronald Oussoren

bea37ae

2009-09-15 19:16:02 +0000

[diff] [blame]

1116

* ``macosx-10.6-intel``

1117

Georg Brandl

2007-08-15 14:28:22 +0000

[diff] [blame]

1118

.. % XXX isn't this also provided by some other non-distutils module?

1119

1120

1121

.. function:: convert_path(pathname)

1122

1123

Return 'pathname' as a name that will work on the native filesystem, i.e. split

1124

it on '/' and put it back together again using the current directory separator.

1125

Needed because filenames in the setup script are always supplied in Unix style,

1126

and have to be converted to the local convention before we can actually use them

1127

in the filesystem. Raises :exc:`ValueError` on non-Unix-ish systems if

1128

*pathname* either starts or ends with a slash.

1129

1130

1131

.. function:: change_root(new_root, pathname)

1132

1133

Return *pathname* with *new_root* prepended. If *pathname* is relative, this is

1134

equivalent to ``os.path.join(new_root,pathname)`` Otherwise, it requires making

1135

*pathname* relative and then joining the two, which is tricky on DOS/Windows.

1136

1137

1138

.. function:: check_environ()

1139

1140

Ensure that 'os.environ' has all the environment variables we guarantee that

1141

users can use in config files, command-line options, etc. Currently this

1142

includes:

1143

1144

* :envvar:`HOME` - user's home directory (Unix only)

1145

* :envvar:`PLAT` - description of the current platform, including hardware and

1146

OS (see :func:`get_platform`)

1147

1148

1149

.. function:: subst_vars(s, local_vars)

1150

1151

Perform shell/Perl-style variable substitution on *s*. Every occurrence of

1152

``$`` followed by a name is considered a variable, and variable is substituted

1153

by the value found in the *local_vars* dictionary, or in ``os.environ`` if it's

1154

not in *local_vars*. *os.environ* is first checked/augmented to guarantee that

1155

it contains certain values: see :func:`check_environ`. Raise :exc:`ValueError`

1156

for any variables not found in either *local_vars* or ``os.environ``.

1157

1158

Note that this is not a fully-fledged string interpolation function. A valid

1159

``$variable`` can consist only of upper and lower case letters, numbers and an

1160

underscore. No { } or ( ) style quoting is available.

1161

1162

1163

.. function:: grok_environment_error(exc[, prefix='error: '])

1164

1165

Generate a useful error message from an :exc:`EnvironmentError` (:exc:`IOError`

1166

or :exc:`OSError`) exception object. Handles Python 1.5.1 and later styles,

1167

and does what it can to deal with exception objects that don't have a filename

1168

(which happens when the error is due to a two-file operation, such as

1169

:func:`rename` or :func:`link`). Returns the error message as a string

1170

prefixed with *prefix*.

1171

1172

1173

.. function:: split_quoted(s)

1174

1175

Split a string up according to Unix shell-like rules for quotes and backslashes.

1176

In short: words are delimited by spaces, as long as those spaces are not escaped

1177

by a backslash, or inside a quoted string. Single and double quotes are

1178

equivalent, and the quote characters can be backslash-escaped. The backslash is

1179

stripped from any two-character escape sequence, leaving only the escaped

1180

character. The quote characters are stripped from any quoted string. Returns a

1181

list of words.

1182

1183

.. % Should probably be moved into the standard library.

1184

1185

1186

.. function:: execute(func, args[, msg=None, verbose=0, dry_run=0])

1187

1188

Perform some action that affects the outside world (for instance, writing to the

1189

filesystem). Such actions are special because they are disabled by the

1190

*dry_run* flag. This method takes care of all that bureaucracy for you; all

1191

you have to do is supply the function to call and an argument tuple for it (to

1192

embody the "external action" being performed), and an optional message to print.

1193

1194

1195

.. function:: strtobool(val)

1196

1197

Convert a string representation of truth to true (1) or false (0).

1198

1199

True values are ``y``, ``yes``, ``t``, ``true``, ``on`` and ``1``; false values

1200

are ``n``, ``no``, ``f``, ``false``, ``off`` and ``0``. Raises

1201

:exc:`ValueError` if *val* is anything else.

1202

1203

1204

.. function:: byte_compile(py_files[, optimize=0, force=0, prefix=None, base_dir=None, verbose=1, dry_run=0, direct=None])

1205

1206

Byte-compile a collection of Python source files to either :file:`.pyc` or

Éric Araujo

47a4521

2011-10-08 00:34:13 +0200

[diff] [blame]

1207

:file:`.pyo` files in a :file:`__pycache__` subdirectory (see :pep:`3147`).

1208

*py_files* is a list of files to compile; any files that don't end in

1209

:file:`.py` are silently skipped. *optimize* must be one of the following:

Georg Brandl

2007-08-15 14:28:22 +0000

[diff] [blame]

1210

1211

* ``0`` - don't optimize (generate :file:`.pyc`)

1212

* ``1`` - normal optimization (like ``python -O``)

1213

* ``2`` - extra optimization (like ``python -OO``)

1214

1215

If *force* is true, all files are recompiled regardless of timestamps.

1216

Georg Brandl

9afde1c

2007-11-01 20:32:30 +0000

[diff] [blame]

1217

The source filename encoded in each :term:`bytecode` file defaults to the filenames

Georg Brandl

2007-08-15 14:28:22 +0000

[diff] [blame]

1218

listed in *py_files*; you can modify these with *prefix* and *basedir*.

1219

*prefix* is a string that will be stripped off of each source filename, and

1220

*base_dir* is a directory name that will be prepended (after *prefix* is

1221

stripped). You can supply either or both (or neither) of *prefix* and

1222

*base_dir*, as you wish.

1223

1224

If *dry_run* is true, doesn't actually do anything that would affect the

1225

filesystem.

1226

1227

Byte-compilation is either done directly in this interpreter process with the

1228

standard :mod:`py_compile` module, or indirectly by writing a temporary script

1229

and executing it. Normally, you should let :func:`byte_compile` figure out to

1230

use direct compilation or not (see the source for details). The *direct* flag

1231

is used by the script generated in indirect mode; unless you know what you're

1232

doing, leave it set to ``None``.

1233

Éric Araujo

47a4521

2011-10-08 00:34:13 +0200

[diff] [blame]

1234

.. versionchanged:: 3.2.3

1235

Create ``.pyc`` or ``.pyo`` files with an :func:`import magic tag

1236

<imp.get_tag>` in their name, in a :file:`__pycache__` subdirectory

1237

instead of files without tag in the current directory.

1238

Georg Brandl

2007-08-15 14:28:22 +0000

[diff] [blame]

1239

1240

.. function:: rfc822_escape(header)

1241

1242

Return a version of *header* escaped for inclusion in an :rfc:`822` header, by

1243

ensuring there are 8 spaces space after each newline. Note that it does no other

1244

modification of the string.

1245

1246

.. % this _can_ be replaced

1247

1248

.. % \subsection{Distutils objects}

1249

1250

1251

:mod:`distutils.dist` --- The Distribution class

1252

================================================

1253

1254

.. module:: distutils.dist

1255

:synopsis: Provides the Distribution class, which represents the module distribution being

1256

built/installed/distributed

1257

1258

1259

This module provides the :class:`Distribution` class, which represents the

1260

module distribution being built/installed/distributed.

1261

1262

1263

:mod:`distutils.extension` --- The Extension class

1264

==================================================

1265

1266

.. module:: distutils.extension

1267

:synopsis: Provides the Extension class, used to describe C/C++ extension modules in setup

scripts

This module provides the :class:`Extension` class, used to describe C/C++

1272

extension modules in setup scripts.

1273

1274

.. % \subsection{Ungrouped modules}

1275

.. % The following haven't been moved into a more appropriate section yet.

1276

1277

1278

:mod:`distutils.debug` --- Distutils debug mode

1279

===============================================

1280

1281

.. module:: distutils.debug

1282

:synopsis: Provides the debug flag for distutils

1283

1284

1285

This module provides the DEBUG flag.

1286

1287

1288

:mod:`distutils.errors` --- Distutils exceptions

1289

================================================

1290

1291

.. module:: distutils.errors

1292

:synopsis: Provides standard distutils exceptions

1293

1294

1295

Provides exceptions used by the Distutils modules. Note that Distutils modules

1296

may raise standard exceptions; in particular, SystemExit is usually raised for

1297

errors that are obviously the end-user's fault (eg. bad command-line arguments).

1298

1299

This module is safe to use in ``from ... import *`` mode; it only exports

1300

symbols whose names start with ``Distutils`` and end with ``Error``.

1301

1302

1303

:mod:`distutils.fancy_getopt` --- Wrapper around the standard getopt module

1304

===========================================================================

1305

1306

.. module:: distutils.fancy_getopt

1307

:synopsis: Additional getopt functionality

1308

1309

1310

This module provides a wrapper around the standard :mod:`getopt` module that

1311

provides the following additional features:

1312

1313

* short and long options are tied together

1314

1315

* options have help strings, so :func:`fancy_getopt` could potentially create a

1316

complete usage summary

1317

1318

* options set attributes of a passed-in object

1319

1320

* boolean options can have "negative aliases" --- eg. if :option:`--quiet` is

1321

the "negative alias" of :option:`--verbose`, then :option:`--quiet` on the

1322

command line sets *verbose* to false.

1323

Georg Brandl

d5f2d6e

2010-07-31 09:15:10 +0000

[diff] [blame]

1324

.. XXX Should be replaced with optparse

Georg Brandl

2007-08-15 14:28:22 +0000

[diff] [blame]

1325

1326

.. function:: fancy_getopt(options, negative_opt, object, args)

1327

1328

Wrapper function. *options* is a list of ``(long_option, short_option,

1329

help_string)`` 3-tuples as described in the constructor for

1330

:class:`FancyGetopt`. *negative_opt* should be a dictionary mapping option names

1331

to option names, both the key and value should be in the *options* list.

1332

*object* is an object which will be used to store values (see the :meth:`getopt`

1333

method of the :class:`FancyGetopt` class). *args* is the argument list. Will use

1334

``sys.argv[1:]`` if you pass ``None`` as *args*.

1335

1336

1337

.. function:: wrap_text(text, width)

1338

1339

Wraps *text* to less than *width* wide.

1340

Georg Brandl

2009-04-27 16:23:47 +0000

[diff] [blame]

1341

.. XXX Should be replaced with :mod:`textwrap` (which is available in Python

1342

2.3 and later).

Georg Brandl

2007-08-15 14:28:22 +0000

[diff] [blame]

1343

1344

1345

.. class:: FancyGetopt([option_table=None])

1346

1347

The option_table is a list of 3-tuples: ``(long_option, short_option,

1348

help_string)``

1349

1350

If an option takes an argument, its *long_option* should have ``'='`` appended;

1351

*short_option* should just be a single character, no ``':'`` in any case.

1352

*short_option* should be ``None`` if a *long_option* doesn't have a

1353

corresponding *short_option*. All option tuples must have long options.

1354

1355

The :class:`FancyGetopt` class provides the following methods:

1356

1357

1358

.. method:: FancyGetopt.getopt([args=None, object=None])

1359

1360

Parse command-line options in args. Store as attributes on *object*.

1361

1362

If *args* is ``None`` or not supplied, uses ``sys.argv[1:]``. If *object* is

1363

``None`` or not supplied, creates a new :class:`OptionDummy` instance, stores

1364

option values there, and returns a tuple ``(args, object)``. If *object* is

1365

supplied, it is modified in place and :func:`getopt` just returns *args*; in

1366

both cases, the returned *args* is a modified copy of the passed-in *args* list,

1367

which is left untouched.

1368

1369

.. % and args returned are?

1370

1371

1372

.. method:: FancyGetopt.get_option_order()

1373

1374

Returns the list of ``(option, value)`` tuples processed by the previous run of

1375

:meth:`getopt` Raises :exc:`RuntimeError` if :meth:`getopt` hasn't been called

yet.

.. method:: FancyGetopt.generate_help([header=None])

1380

1381

Generate help text (a list of strings, one per suggested line of output) from

1382

the option table for this :class:`FancyGetopt` object.

1383

1384

If supplied, prints the supplied *header* at the top of the help.

1385

1386

1387

:mod:`distutils.filelist` --- The FileList class

1388

================================================

1389

1390

.. module:: distutils.filelist

Georg Brandl

2009-04-27 16:23:47 +0000

[diff] [blame]

1391

:synopsis: The FileList class, used for poking about the file system and

1392

building lists of files.

Georg Brandl

2007-08-15 14:28:22 +0000

[diff] [blame]

1393

1394

1395

This module provides the :class:`FileList` class, used for poking about the

1396

filesystem and building lists of files.

1397

1398

1399

:mod:`distutils.log` --- Simple PEP 282-style logging

1400

=====================================================

1401

1402

.. module:: distutils.log

1403

:synopsis: A simple logging mechanism, 282-style

1404

1405

Georg Brandl

2009-04-27 16:23:47 +0000

[diff] [blame]

1406

.. XXX Should be replaced with standard :mod:`logging` module.

Georg Brandl

2007-08-15 14:28:22 +0000

[diff] [blame]

1407

Georg Brandl

2007-08-15 14:28:22 +0000

[diff] [blame]

1408

1409

1410

:mod:`distutils.spawn` --- Spawn a sub-process

1411

==============================================

1412

1413

.. module:: distutils.spawn

1414

:synopsis: Provides the spawn() function

1415

1416

1417

This module provides the :func:`spawn` function, a front-end to various

1418

platform-specific functions for launching another program in a sub-process.

1419

Also provides :func:`find_executable` to search the path for a given executable

name.

:mod:`distutils.sysconfig` --- System configuration information

1424

===============================================================

1425

1426

.. module:: distutils.sysconfig

1427

:synopsis: Low-level access to configuration information of the Python interpreter.

1428

.. moduleauthor:: Fred L. Drake, Jr. <fdrake@acm.org>

1429

.. moduleauthor:: Greg Ward <gward@python.net>

1430

.. sectionauthor:: Fred L. Drake, Jr. <fdrake@acm.org>

1431

1432

1433

The :mod:`distutils.sysconfig` module provides access to Python's low-level

1434

configuration information. The specific configuration variables available

1435

depend heavily on the platform and configuration. The specific variables depend

1436

on the build process for the specific version of Python being run; the variables

1437

are those found in the :file:`Makefile` and configuration header that are

1438

installed with Python on Unix systems. The configuration header is called

1439

:file:`pyconfig.h` for Python versions starting with 2.2, and :file:`config.h`

1440

for earlier versions of Python.

1441

1442

Some additional functions are provided which perform some useful manipulations

1443

for other parts of the :mod:`distutils` package.

.. data:: PREFIX

The result of ``os.path.normpath(sys.prefix)``.

1449

1450

1451

.. data:: EXEC_PREFIX

1452

1453

The result of ``os.path.normpath(sys.exec_prefix)``.

1454

1455

1456

.. function:: get_config_var(name)

1457

1458

Return the value of a single variable. This is equivalent to

1459

``get_config_vars().get(name)``.

1460

1461

1462

.. function:: get_config_vars(...)

1463

1464

Return a set of variable definitions. If there are no arguments, this returns a

1465

dictionary mapping names of configuration variables to values. If arguments are

1466

provided, they should be strings, and the return value will be a sequence giving

1467

the associated values. If a given name does not have a corresponding value,

1468

``None`` will be included for that variable.

1469

1470

1471

.. function:: get_config_h_filename()

1472

1473

Return the full path name of the configuration header. For Unix, this will be

1474

the header generated by the :program:`configure` script; for other platforms the

1475

header will have been supplied directly by the Python source distribution. The

1476

file is a platform-specific text file.

1477

1478

1479

.. function:: get_makefile_filename()

1480

1481

Return the full path name of the :file:`Makefile` used to build Python. For

1482

Unix, this will be a file generated by the :program:`configure` script; the

1483

meaning for other platforms will vary. The file is a platform-specific text

1484

file, if it exists. This function is only useful on POSIX platforms.

1485

1486

1487

.. function:: get_python_inc([plat_specific[, prefix]])

1488

1489

Return the directory for either the general or platform-dependent C include

1490

files. If *plat_specific* is true, the platform-dependent include directory is

1491

returned; if false or omitted, the platform-independent directory is returned.

1492

If *prefix* is given, it is used as either the prefix instead of

1493

:const:`PREFIX`, or as the exec-prefix instead of :const:`EXEC_PREFIX` if

1494

*plat_specific* is true.

1495

1496

1497

.. function:: get_python_lib([plat_specific[, standard_lib[, prefix]]])

1498

1499

Return the directory for either the general or platform-dependent library

1500

installation. If *plat_specific* is true, the platform-dependent include

1501

directory is returned; if false or omitted, the platform-independent directory

1502

is returned. If *prefix* is given, it is used as either the prefix instead of

1503

:const:`PREFIX`, or as the exec-prefix instead of :const:`EXEC_PREFIX` if

1504

*plat_specific* is true. If *standard_lib* is true, the directory for the

1505

standard library is returned rather than the directory for the installation of

1506

third-party extensions.

1507

1508

The following function is only intended for use within the :mod:`distutils`

package.

.. function:: customize_compiler(compiler)

1513

1514

Do any platform-specific customization of a

1515

:class:`distutils.ccompiler.CCompiler` instance.

1516

1517

This function is only needed on Unix at this time, but should be called

1518

consistently to support forward-compatibility. It inserts the information that

1519

varies across Unix flavors and is stored in Python's :file:`Makefile`. This

1520

information includes the selected compiler, compiler and linker options, and the

1521

extension used by the linker for shared objects.

1522

1523

This function is even more special-purpose, and should only be used from

1524

Python's own build procedures.

1525

1526

1527

.. function:: set_python_build()

1528

1529

Inform the :mod:`distutils.sysconfig` module that it is being used as part of

1530

the build process for Python. This changes a lot of relative locations for

1531

files, allowing them to be located in the build area rather than in an installed

Python.

:mod:`distutils.text_file` --- The TextFile class

1536

=================================================

1537

1538

.. module:: distutils.text_file

1539

:synopsis: provides the TextFile class, a simple interface to text files

1540

1541

1542

This module provides the :class:`TextFile` class, which gives an interface to

1543

text files that (optionally) takes care of stripping comments, ignoring blank

1544

lines, and joining lines with backslashes.

1545

1546

1547

.. class:: TextFile([filename=None, file=None, **options])

1548

1549

This class provides a file-like object that takes care of all the things you

1550

commonly want to do when processing a text file that has some line-by-line

1551

syntax: strip comments (as long as ``#`` is your comment character), skip blank

1552

lines, join adjacent lines by escaping the newline (ie. backslash at end of

1553

line), strip leading and/or trailing whitespace. All of these are optional and

1554

independently controllable.

1555

1556

The class provides a :meth:`warn` method so you can generate warning messages

1557

that report physical line number, even if the logical line in question spans

1558

multiple physical lines. Also provides :meth:`unreadline` for implementing

1559

line-at-a-time lookahead.

1560

1561

:class:`TextFile` instances are create with either *filename*, *file*, or both.

1562

:exc:`RuntimeError` is raised if both are ``None``. *filename* should be a

1563

string, and *file* a file object (or something that provides :meth:`readline`

1564

and :meth:`close` methods). It is recommended that you supply at least

1565

*filename*, so that :class:`TextFile` can include it in warning messages. If

1566

*file* is not supplied, :class:`TextFile` creates its own using the

1567

:func:`open` built-in function.

1568

1569

The options are all boolean, and affect the values returned by :meth:`readline`

1570

1571

+------------------+--------------------------------+---------+

1572

| option name | description | default |

1573

+==================+================================+=========+

1574

| *strip_comments* | strip from ``'#'`` to end-of- | true |

1575

| | line, as well as any | |

1576

| | whitespace leading up to the | |

1577

| | ``'#'``\ ---unless it is | |

1578

| | escaped by a backslash | |

1579

+------------------+--------------------------------+---------+

1580

| *lstrip_ws* | strip leading whitespace from | false |

1581

| | each line before returning it | |

1582

+------------------+--------------------------------+---------+

1583

| *rstrip_ws* | strip trailing whitespace | true |

1584

| | (including line terminator!) | |

1585

| | from each line before | |

1586

| | returning it. | |

1587

+------------------+--------------------------------+---------+

1588

| *skip_blanks* | skip lines that are empty | true |

1589

| | \*after\* stripping comments | |

1590

| | and whitespace. (If both | |

1591

| | lstrip_ws and rstrip_ws are | |

1592

| | false, then some lines may | |

1593

| | consist of solely whitespace: | |

1594

| | these will \*not\* be skipped, | |

1595

| | even if *skip_blanks* is | |

1596

| | true.) | |

1597

+------------------+--------------------------------+---------+

1598

| *join_lines* | if a backslash is the last | false |

1599

| | non-newline character on a | |

1600

| | line after stripping comments | |

1601

| | and whitespace, join the | |

1602

| | following line to it to form | |

1603

| | one logical line; if N | |

1604

| | consecutive lines end with a | |

1605

| | backslash, then N+1 physical | |

1606

| | lines will be joined to form | |

1607

| | one logical line. | |

1608

+------------------+--------------------------------+---------+

1609

| *collapse_join* | strip leading whitespace from | false |

1610

| | lines that are joined to their | |

1611

| | predecessor; only matters if | |

1612

| | ``(join_lines and not | |

1613

| | lstrip_ws)`` | |

1614

+------------------+--------------------------------+---------+

1615

1616

Note that since *rstrip_ws* can strip the trailing newline, the semantics of

Georg Brandl

22b3431

2009-07-26 14:54:51 +0000

[diff] [blame]

1617

:meth:`readline` must differ from those of the built-in file object's

Georg Brandl

2007-08-15 14:28:22 +0000

[diff] [blame]

1618

:meth:`readline` method! In particular, :meth:`readline` returns ``None`` for

1619

end-of-file: an empty string might just be a blank line (or an all-whitespace

1620

line), if *rstrip_ws* is true but *skip_blanks* is not.

1621

1622

1623

.. method:: TextFile.open(filename)

1624

Georg Brandl

22b3431

2009-07-26 14:54:51 +0000

[diff] [blame]

1625

Open a new file *filename*. This overrides any *file* or *filename*

1626

constructor arguments.

Georg Brandl

2007-08-15 14:28:22 +0000

[diff] [blame]

1627

1628

1629

.. method:: TextFile.close()

1630

1631

Close the current file and forget everything we know about it (including the

1632

filename and the current line number).

1633

1634

1635

.. method:: TextFile.warn(msg[,line=None])

1636

1637

Print (to stderr) a warning message tied to the current logical line in the

1638

current file. If the current logical line in the file spans multiple physical

1639

lines, the warning refers to the whole range, such as ``"lines 3-5"``. If

1640

*line* is supplied, it overrides the current line number; it may be a list or

1641

tuple to indicate a range of physical lines, or an integer for a single

physical line.

.. method:: TextFile.readline()

1646

1647

Read and return a single logical line from the current file (or from an internal

1648

buffer if lines have previously been "unread" with :meth:`unreadline`). If the

1649

*join_lines* option is true, this may involve reading multiple physical lines

1650

concatenated into a single string. Updates the current line number, so calling

1651

:meth:`warn` after :meth:`readline` emits a warning about the physical line(s)

1652

just read. Returns ``None`` on end-of-file, since the empty string can occur

1653

if *rstrip_ws* is true but *strip_blanks* is not.

1654

1655

1656

.. method:: TextFile.readlines()

1657

1658

Read and return the list of all logical lines remaining in the current file.

1659

This updates the current line number to the last line of the file.

1660

1661

1662

.. method:: TextFile.unreadline(line)

1663

1664

Push *line* (a string) onto an internal buffer that will be checked by future

1665

:meth:`readline` calls. Handy for implementing a parser with line-at-a-time

1666

lookahead. Note that lines that are "unread" with :meth:`unreadline` are not

1667

subsequently re-cleansed (whitespace stripped, or whatever) when read with

1668

:meth:`readline`. If multiple calls are made to :meth:`unreadline` before a call

1669

to :meth:`readline`, the lines will be returned most in most recent first order.

1670

1671

1672

:mod:`distutils.version` --- Version number classes

1673

===================================================

1674

1675

.. module:: distutils.version

1676

:synopsis: implements classes that represent module version numbers.

.. % todo

.. % \section{Distutils Commands}

Georg Brandl

2009-01-03 21:18:54 +0000

[diff] [blame]

1681

.. %

Georg Brandl

2007-08-15 14:28:22 +0000

[diff] [blame]

1682

.. % This part of Distutils implements the various Distutils commands, such

1683

.. % as \code{build}, \code{install} \&c. Each command is implemented as a

1684

.. % separate module, with the command name as the name of the module.

1685

1686

1687

:mod:`distutils.cmd` --- Abstract base class for Distutils commands

1688

===================================================================

1689

1690

.. module:: distutils.cmd

Georg Brandl

2010-10-06 08:26:09 +0000

[diff] [blame]

1691

:synopsis: This module provides the abstract base class Command. This class

1692

is subclassed by the modules in the distutils.command subpackage.

Georg Brandl

2007-08-15 14:28:22 +0000

[diff] [blame]

1693

1694

1695

This module supplies the abstract base class :class:`Command`.

1696

1697

1698

.. class:: Command(dist)

1699

1700

Abstract base class for defining command classes, the "worker bees" of the

1701

Distutils. A useful analogy for command classes is to think of them as

Georg Brandl

2010-10-06 08:26:09 +0000

[diff] [blame]

1702

subroutines with local variables called *options*. The options are declared

1703

in :meth:`initialize_options` and defined (given their final values) in

1704

:meth:`finalize_options`, both of which must be defined by every command

1705

class. The distinction between the two is necessary because option values

1706

might come from the outside world (command line, config file, ...), and any

1707

options dependent on other options must be computed after these outside

1708

influences have been processed --- hence :meth:`finalize_options`. The body

1709

of the subroutine, where it does all its work based on the values of its

1710

options, is the :meth:`run` method, which must also be implemented by every

1711

command class.

Georg Brandl

2007-08-15 14:28:22 +0000

[diff] [blame]

1712

Georg Brandl

2010-10-06 08:26:09 +0000

[diff] [blame]

1713

The class constructor takes a single argument *dist*, a :class:`Distribution`

Georg Brandl

2007-08-15 14:28:22 +0000

[diff] [blame]

instance.

Georg Brandl

2010-10-06 08:26:09 +0000

[diff] [blame]

1717

Creating a new Distutils command

1718

================================

1719

1720

This section outlines the steps to create a new Distutils command.

1721

1722

A new command lives in a module in the :mod:`distutils.command` package. There

1723

is a sample template in that directory called :file:`command_template`. Copy

1724

this file to a new module with the same name as the new command you're

1725

implementing. This module should implement a class with the same name as the

1726

module (and the command). So, for instance, to create the command

1727

``peel_banana`` (so that users can run ``setup.py peel_banana``), you'd copy

1728

:file:`command_template` to :file:`distutils/command/peel_banana.py`, then edit

1729

it so that it's implementing the class :class:`peel_banana`, a subclass of

1730

:class:`distutils.cmd.Command`.

1731

1732

Subclasses of :class:`Command` must define the following methods.

1733

1734

.. method:: Command.initialize_options()

1735

1736

Set default values for all the options that this command supports. Note that

1737

these defaults may be overridden by other commands, by the setup script, by

1738

config files, or by the command-line. Thus, this is not the place to code

1739

dependencies between options; generally, :meth:`initialize_options`

1740

implementations are just a bunch of ``self.foo = None`` assignments.

1741

1742

1743

.. method:: Command.finalize_options()

1744

1745

Set final values for all the options that this command supports. This is

1746

always called as late as possible, ie. after any option assignments from the

1747

command-line or from other commands have been done. Thus, this is the place

Ezio Melotti

e130a52

2011-10-19 10:58:56 +0300

[diff] [blame]

1748

to code option dependencies: if *foo* depends on *bar*, then it is safe to

Georg Brandl

2010-10-06 08:26:09 +0000

[diff] [blame]

1749

set *foo* from *bar* as long as *foo* still has the same value it was

1750

assigned in :meth:`initialize_options`.

1751

1752

1753

.. method:: Command.run()

1754

1755

A command's raison d'etre: carry out the action it exists to perform, controlled

1756

by the options initialized in :meth:`initialize_options`, customized by other

1757

commands, the setup script, the command-line, and config files, and finalized in

1758

:meth:`finalize_options`. All terminal output and filesystem interaction should

1759

be done by :meth:`run`.

1760

1761

1762

.. attribute:: Command.sub_commands

1763

1764

*sub_commands* formalizes the notion of a "family" of commands,

1765

e.g. ``install`` as the parent with sub-commands ``install_lib``,

1766

``install_headers``, etc. The parent of a family of commands defines

1767

*sub_commands* as a class attribute; it's a list of 2-tuples ``(command_name,

1768

predicate)``, with *command_name* a string and *predicate* a function, a

1769

string or ``None``. *predicate* is a method of the parent command that

1770

determines whether the corresponding command is applicable in the current

Éric Araujo

000893f

2011-05-29 00:14:45 +0200

[diff] [blame]

1771

situation. (E.g. ``install_headers`` is only applicable if we have any C

Georg Brandl

2010-10-06 08:26:09 +0000

[diff] [blame]

1772

header files to install.) If *predicate* is ``None``, that command is always

1773

applicable.

1774

1775

*sub_commands* is usually defined at the *end* of a class, because

1776

predicates can be methods of the class, so they must already have been

1777

defined. The canonical example is the :command:`install` command.

1778

1779

Georg Brandl

2007-08-15 14:28:22 +0000

[diff] [blame]

1780

:mod:`distutils.command` --- Individual Distutils commands

1781

==========================================================

1782

1783

.. module:: distutils.command

1784

:synopsis: This subpackage contains one module for each standard Distutils command.

1785

1786

1787

.. % \subsubsection{Individual Distutils commands}

.. % todo

:mod:`distutils.command.bdist` --- Build a binary installer

1792

===========================================================

1793

1794

.. module:: distutils.command.bdist

1795

:synopsis: Build a binary installer for a package

.. % todo

:mod:`distutils.command.bdist_packager` --- Abstract base class for packagers

1802

=============================================================================

1803

1804

.. module:: distutils.command.bdist_packager

1805

:synopsis: Abstract base class for packagers

.. % todo

:mod:`distutils.command.bdist_dumb` --- Build a "dumb" installer

1812

================================================================

1813

1814

.. module:: distutils.command.bdist_dumb

1815

:synopsis: Build a "dumb" installer - a simple archive of files

.. % todo

:mod:`distutils.command.bdist_msi` --- Build a Microsoft Installer binary package

1822

=================================================================================

1823

1824

.. module:: distutils.command.bdist_msi

1825

:synopsis: Build a binary distribution as a Windows MSI file

1826

Éric Araujo

5864b9f

2011-05-31 21:50:38 +0200

[diff] [blame]

1827

.. class:: bdist_msi

Georg Brandl

2007-08-15 14:28:22 +0000

[diff] [blame]

1828

Benjamin Peterson

2009-04-05 19:13:16 +0000

[diff] [blame]

1829

Builds a `Windows Installer`_ (.msi) binary package.

1830

1831

.. _Windows Installer: http://msdn.microsoft.com/en-us/library/cc185688(VS.85).aspx

1832

1833

In most cases, the ``bdist_msi`` installer is a better choice than the

1834

``bdist_wininst`` installer, because it provides better support for

1835

Win64 platforms, allows administrators to perform non-interactive

1836

installations, and allows installation through group policies.

Georg Brandl

2007-08-15 14:28:22 +0000

[diff] [blame]

1837

1838

1839

:mod:`distutils.command.bdist_rpm` --- Build a binary distribution as a Redhat RPM and SRPM

1840

===========================================================================================

1841

1842

.. module:: distutils.command.bdist_rpm

1843

:synopsis: Build a binary distribution as a Redhat RPM and SRPM

.. % todo

:mod:`distutils.command.bdist_wininst` --- Build a Windows installer

1850

====================================================================

1851

1852

.. module:: distutils.command.bdist_wininst

1853

:synopsis: Build a Windows installer

.. % todo

:mod:`distutils.command.sdist` --- Build a source distribution

1860

==============================================================

1861

1862

.. module:: distutils.command.sdist

1863

:synopsis: Build a source distribution

.. % todo

:mod:`distutils.command.build` --- Build all files of a package

1870

===============================================================

1871

1872

.. module:: distutils.command.build

1873

:synopsis: Build all files of a package

.. % todo

:mod:`distutils.command.build_clib` --- Build any C libraries in a package

1880

==========================================================================

1881

1882

.. module:: distutils.command.build_clib

1883

:synopsis: Build any C libraries in a package

.. % todo

:mod:`distutils.command.build_ext` --- Build any extensions in a package

1890

========================================================================

1891

1892

.. module:: distutils.command.build_ext

1893

:synopsis: Build any extensions in a package

.. % todo

:mod:`distutils.command.build_py` --- Build the .py/.pyc files of a package

1900

===========================================================================

1901

1902

.. module:: distutils.command.build_py

1903

:synopsis: Build the .py/.pyc files of a package

1904

1905

Éric Araujo

5864b9f

2011-05-31 21:50:38 +0200

[diff] [blame]

1906

.. class:: build_py

Martin v. Löwis

73a22f0

2008-03-22 00:35:10 +0000

[diff] [blame]

1907

Éric Araujo

5864b9f

2011-05-31 21:50:38 +0200

[diff] [blame]

1908

.. class:: build_py_2to3

Martin v. Löwis

73a22f0

2008-03-22 00:35:10 +0000

[diff] [blame]

1909

1910

Alternative implementation of build_py which also runs the

1911

2to3 conversion library on each .py file that is going to be

1912

installed. To use this in a setup.py file for a distribution

1913

that is designed to run with both Python 2.x and 3.x, add::

1914

1915

try:

1916

from distutils.command.build_py import build_py_2to3 as build_py

1917

except ImportError:

1918

from distutils.command.build_py import build_py

1919

1920

to your setup.py, and later::

1921

Georg Brandl

682d7e0

2010-10-06 10:26:05 +0000

[diff] [blame]

1922

cmdclass = {'build_py': build_py}

Martin v. Löwis

73a22f0

2008-03-22 00:35:10 +0000

[diff] [blame]

1923

1924

to the invocation of setup().

Georg Brandl