Initial commit of OpenSPARC T2 architecture model.
[OpenSPARC-T2-SAM] / sam-t2 / devtools / amd64 / html / python / dist / module-distutils.sysconfig.html
<!DOCTYPE html PUBLIC "-//W3C//DTD HTML 4.0 Transitional//EN">
<html>
<head>
<link rel="STYLESHEET" href="dist.css" type='text/css' />
<link rel="SHORTCUT ICON" href="../icons/pyfav.png" type="image/png" />
<link rel='start' href='../index.html' title='Python Documentation Index' />
<link rel="first" href="dist.html" title='Distributing Python Modules' />
<link rel='index' href='genindex.html' title='Index' />
<link rel='last' href='about.html' title='About this document...' />
<link rel='help' href='about.html' title='About this document...' />
<link rel="next" href="module-distutils.textfile.html" />
<link rel="prev" href="module-distutils.spawn.html" />
<link rel="parent" href="api-reference.html" />
<link rel="next" href="module-distutils.textfile.html" />
<meta name='aesop' content='information' />
<title>10.22 distutils.sysconfig -- System configuration information</title>
</head>
<body>
<DIV CLASS="navigation">
<div id='top-navigation-panel' xml:id='top-navigation-panel'>
<table align="center" width="100%" cellpadding="0" cellspacing="2">
<tr>
<td class='online-navigation'><a rel="prev" title="10.21 distutils.spawn "
href="module-distutils.spawn.html"><img src='../icons/previous.png'
border='0' height='32' alt='Previous Page' width='32' /></A></td>
<td class='online-navigation'><a rel="parent" title="10. API Reference"
href="api-reference.html"><img src='../icons/up.png'
border='0' height='32' alt='Up One Level' width='32' /></A></td>
<td class='online-navigation'><a rel="next" title="10.23 distutils.text_file "
href="module-distutils.textfile.html"><img src='../icons/next.png'
border='0' height='32' alt='Next Page' width='32' /></A></td>
<td align="center" width="100%">Distributing Python Modules</td>
<td class='online-navigation'><img src='../icons/blank.png'
border='0' height='32' alt='' width='32' /></td>
<td class='online-navigation'><a href="modindex.html" title="Module Index"><img src='../icons/modules.png'
border='0' height='32' alt='Module Index' width='32' /></a></td>
<td class='online-navigation'><a rel="index" title="Index"
href="genindex.html"><img src='../icons/index.png'
border='0' height='32' alt='Index' width='32' /></A></td>
</tr></table>
<div class='online-navigation'>
<b class="navlabel">Previous:</b>
<a class="sectref" rel="prev" href="module-distutils.spawn.html">10.21 distutils.spawn </A>
<b class="navlabel">Up:</b>
<a class="sectref" rel="parent" href="api-reference.html">10. API Reference</A>
<b class="navlabel">Next:</b>
<a class="sectref" rel="next" href="module-distutils.textfile.html">10.23 distutils.text_file </A>
</div>
<hr /></div>
</DIV>
<!--End of Navigation Panel-->
<H1><A NAME="SECTION00102200000000000000000">
10.22 <tt class="module">distutils.sysconfig</tt> --
System configuration information</A>
</H1>
<P>
<A NAME="module-distutils.sysconfig"></A>
<P>
The <tt class="module">distutils.sysconfig</tt> module provides access to Python's
low-level configuration information. The specific configuration
variables available depend heavily on the platform and configuration.
The specific variables depend on the build process for the specific
version of Python being run; the variables are those found in the
<span class="file">Makefile</span> and configuration header that are installed with
Python on <span class="Unix">Unix</span> systems. The configuration header is called
<span class="file">pyconfig.h</span> for Python versions starting with 2.2, and
<span class="file">config.h</span> for earlier versions of Python.
<P>
Some additional functions are provided which perform some useful
manipulations for other parts of the <tt class="module">distutils</tt> package.
<P>
<dl><dt><b><tt id='l2h-107' xml:id='l2h-107'>PREFIX</tt></b></dt>
<dd>
The result of <code>os.path.normpath(sys.prefix)</code>.
</dd></dl>
<P>
<dl><dt><b><tt id='l2h-108' xml:id='l2h-108'>EXEC_PREFIX</tt></b></dt>
<dd>
The result of <code>os.path.normpath(sys.exec_prefix)</code>.
</dd></dl>
<P>
<dl><dt><table cellpadding="0" cellspacing="0"><tr valign="baseline">
<td><nobr><b><tt id='l2h-109' xml:id='l2h-109' class="function">get_config_var</tt></b>(</nobr></td>
<td><var>name</var>)</td></tr></table></dt>
<dd>
Return the value of a single variable. This is equivalent to
<code>get_config_vars().get(<var>name</var>)</code>.
</dl>
<P>
<dl><dt><table cellpadding="0" cellspacing="0"><tr valign="baseline">
<td><nobr><b><tt id='l2h-110' xml:id='l2h-110' class="function">get_config_vars</tt></b>(</nobr></td>
<td><var>...</var>)</td></tr></table></dt>
<dd>
Return a set of variable definitions. If there are no arguments,
this returns a dictionary mapping names of configuration variables
to values. If arguments are provided, they should be strings, and
the return value will be a sequence giving the associated values.
If a given name does not have a corresponding value, <code>None</code>
will be included for that variable.
</dl>
<P>
<dl><dt><table cellpadding="0" cellspacing="0"><tr valign="baseline">
<td><nobr><b><tt id='l2h-111' xml:id='l2h-111' class="function">get_config_h_filename</tt></b>(</nobr></td>
<td><var></var>)</td></tr></table></dt>
<dd>
Return the full path name of the configuration header. For <span class="Unix">Unix</span>,
this will be the header generated by the <b class="program">configure</b> script;
for other platforms the header will have been supplied directly by
the Python source distribution. The file is a platform-specific
text file.
</dl>
<P>
<dl><dt><table cellpadding="0" cellspacing="0"><tr valign="baseline">
<td><nobr><b><tt id='l2h-112' xml:id='l2h-112' class="function">get_makefile_filename</tt></b>(</nobr></td>
<td><var></var>)</td></tr></table></dt>
<dd>
Return the full path name of the <span class="file">Makefile</span> used to build
Python. For <span class="Unix">Unix</span>, this will be a file generated by the
<b class="program">configure</b> script; the meaning for other platforms will
vary. The file is a platform-specific text file, if it exists.
This function is only useful on POSIX platforms.
</dl>
<P>
<dl><dt><table cellpadding="0" cellspacing="0"><tr valign="baseline">
<td><nobr><b><tt id='l2h-113' xml:id='l2h-113' class="function">get_python_inc</tt></b>(</nobr></td>
<td><var></var><big>[</big><var>plat_specific</var><big>[</big><var>, prefix</var><big>]</big><var></var><big>]</big><var></var>)</td></tr></table></dt>
<dd>
Return the directory for either the general or platform-dependent C
include files. If <var>plat_specific</var> is true, the
platform-dependent include directory is returned; if false or
omitted, the platform-independent directory is returned. If
<var>prefix</var> is given, it is used as either the prefix instead of
<tt class="constant">PREFIX</tt>, or as the exec-prefix instead of
<tt class="constant">EXEC_PREFIX</tt> if <var>plat_specific</var> is true.
</dl>
<P>
<dl><dt><table cellpadding="0" cellspacing="0"><tr valign="baseline">
<td><nobr><b><tt id='l2h-114' xml:id='l2h-114' class="function">get_python_lib</tt></b>(</nobr></td>
<td><var></var><big>[</big><var>plat_specific</var><big>[</big><var>,
standard_lib</var><big>[</big><var>, prefix</var><big>]</big><var></var><big>]</big><var></var><big>]</big><var></var>)</td></tr></table></dt>
<dd>
Return the directory for either the general or platform-dependent
library installation. If <var>plat_specific</var> is true, the
platform-dependent include directory is returned; if false or
omitted, the platform-independent directory is returned. If
<var>prefix</var> is given, it is used as either the prefix instead of
<tt class="constant">PREFIX</tt>, or as the exec-prefix instead of
<tt class="constant">EXEC_PREFIX</tt> if <var>plat_specific</var> is true. If
<var>standard_lib</var> is true, the directory for the standard library
is returned rather than the directory for the installation of
third-party extensions.
</dl>
<P>
The following function is only intended for use within the
<tt class="module">distutils</tt> package.
<P>
<dl><dt><table cellpadding="0" cellspacing="0"><tr valign="baseline">
<td><nobr><b><tt id='l2h-115' xml:id='l2h-115' class="function">customize_compiler</tt></b>(</nobr></td>
<td><var>compiler</var>)</td></tr></table></dt>
<dd>
Do any platform-specific customization of a
<tt class="class">distutils.ccompiler.CCompiler</tt> instance.
<P>
This function is only needed on <span class="Unix">Unix</span> at this time, but should be
called consistently to support forward-compatibility. It inserts
the information that varies across <span class="Unix">Unix</span> flavors and is stored in
Python's <span class="file">Makefile</span>. This information includes the selected
compiler, compiler and linker options, and the extension used by the
linker for shared objects.
</dl>
<P>
This function is even more special-purpose, and should only be used
from Python's own build procedures.
<P>
<dl><dt><table cellpadding="0" cellspacing="0"><tr valign="baseline">
<td><nobr><b><tt id='l2h-116' xml:id='l2h-116' class="function">set_python_build</tt></b>(</nobr></td>
<td><var></var>)</td></tr></table></dt>
<dd>
Inform the <tt class="module">distutils.sysconfig</tt> module that it is being used
as part of the build process for Python. This changes a lot of
relative locations for files, allowing them to be located in the
build area rather than in an installed Python.
</dl>
<P>
<DIV CLASS="navigation">
<div class='online-navigation'>
<p></p><hr />
<table align="center" width="100%" cellpadding="0" cellspacing="2">
<tr>
<td class='online-navigation'><a rel="prev" title="10.21 distutils.spawn "
href="module-distutils.spawn.html"><img src='../icons/previous.png'
border='0' height='32' alt='Previous Page' width='32' /></A></td>
<td class='online-navigation'><a rel="parent" title="10. API Reference"
href="api-reference.html"><img src='../icons/up.png'
border='0' height='32' alt='Up One Level' width='32' /></A></td>
<td class='online-navigation'><a rel="next" title="10.23 distutils.text_file "
href="module-distutils.textfile.html"><img src='../icons/next.png'
border='0' height='32' alt='Next Page' width='32' /></A></td>
<td align="center" width="100%">Distributing Python Modules</td>
<td class='online-navigation'><img src='../icons/blank.png'
border='0' height='32' alt='' width='32' /></td>
<td class='online-navigation'><a href="modindex.html" title="Module Index"><img src='../icons/modules.png'
border='0' height='32' alt='Module Index' width='32' /></a></td>
<td class='online-navigation'><a rel="index" title="Index"
href="genindex.html"><img src='../icons/index.png'
border='0' height='32' alt='Index' width='32' /></A></td>
</tr></table>
<div class='online-navigation'>
<b class="navlabel">Previous:</b>
<a class="sectref" rel="prev" href="module-distutils.spawn.html">10.21 distutils.spawn </A>
<b class="navlabel">Up:</b>
<a class="sectref" rel="parent" href="api-reference.html">10. API Reference</A>
<b class="navlabel">Next:</b>
<a class="sectref" rel="next" href="module-distutils.textfile.html">10.23 distutils.text_file </A>
</div>
</div>
<hr />
<span class="release-info">Release 2.4.2, documentation updated on 28 September 2005.</span>
</DIV>
<!--End of Navigation Panel-->
<ADDRESS>
See <i><a href="about.html">About this document...</a></i> for information on suggesting changes.
</ADDRESS>
</BODY>
</HTML>