forked from python/cpython
-
Notifications
You must be signed in to change notification settings - Fork 5
Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
Merged revisions 79307,79408,79430,79533,79542,79579-79580,79585-7958…
…7,79607-79608,79622,79717,79820,79822,79828,79862,79875,79923-79924,79941-79943,79945,79947,79951-79952 via svnmerge from svn+ssh://[email protected]/python/trunk ........ r79307 | florent.xicluna | 2010-03-22 17:45:50 -0500 (Mon, 22 Mar 2010) | 2 lines python#7667: Fix doctest failures with non-ASCII paths. ........ r79408 | victor.stinner | 2010-03-24 20:18:38 -0500 (Wed, 24 Mar 2010) | 2 lines Fix a gcc warning introduced by r79397. ........ r79430 | brian.curtin | 2010-03-25 18:48:54 -0500 (Thu, 25 Mar 2010) | 2 lines Fix python#6538. Markup RegexObject and MatchObject as classes. Patch by Ryan Arana. ........ r79533 | barry.warsaw | 2010-03-31 16:07:16 -0500 (Wed, 31 Mar 2010) | 6 lines - Issue python#8233: When run as a script, py_compile.py optionally takes a single argument `-` which tells it to read files to compile from stdin. Each line is read on demand and the named file is compiled immediately. (Original patch by Piotr O?\197?\188arowski). ........ r79542 | r.david.murray | 2010-03-31 20:28:39 -0500 (Wed, 31 Mar 2010) | 3 lines A couple small grammar fixes in test.rst, and rewrite the check_warnings docs to be clearer. ........ r79579 | georg.brandl | 2010-04-02 03:34:41 -0500 (Fri, 02 Apr 2010) | 1 line Add 2.6.5. ........ r79580 | georg.brandl | 2010-04-02 03:39:09 -0500 (Fri, 02 Apr 2010) | 1 line python#2768: add a note on how to get a file descriptor. ........ r79585 | georg.brandl | 2010-04-02 04:03:18 -0500 (Fri, 02 Apr 2010) | 1 line Remove col-spanning cells in logging docs. ........ r79586 | georg.brandl | 2010-04-02 04:07:42 -0500 (Fri, 02 Apr 2010) | 1 line Document PyImport_ExecCodeModuleEx(). ........ r79587 | georg.brandl | 2010-04-02 04:11:49 -0500 (Fri, 02 Apr 2010) | 1 line python#8012: clarification in generator glossary entry. ........ r79607 | andrew.kuchling | 2010-04-02 12:48:23 -0500 (Fri, 02 Apr 2010) | 1 line python#6647: document that catch_warnings is not thread-safe ........ r79608 | andrew.kuchling | 2010-04-02 12:54:26 -0500 (Fri, 02 Apr 2010) | 1 line python#6647: add note to two examples ........ r79622 | tarek.ziade | 2010-04-02 16:34:19 -0500 (Fri, 02 Apr 2010) | 1 line removed documentation on code that was reverted and pushed into distutils2 ........ r79717 | antoine.pitrou | 2010-04-03 16:22:38 -0500 (Sat, 03 Apr 2010) | 4 lines Fix wording / typography, and a slightly misleading statement (memoryviews don't support complex structures right now) ........ r79820 | benjamin.peterson | 2010-04-05 22:34:09 -0500 (Mon, 05 Apr 2010) | 1 line ready _sre types ........ r79822 | georg.brandl | 2010-04-06 03:18:15 -0500 (Tue, 06 Apr 2010) | 1 line python#8320: document return value of recv_into(). ........ r79828 | georg.brandl | 2010-04-06 09:33:44 -0500 (Tue, 06 Apr 2010) | 1 line Add JP. ........ r79862 | georg.brandl | 2010-04-06 15:27:59 -0500 (Tue, 06 Apr 2010) | 1 line Fix syntax. ........ r79875 | mark.dickinson | 2010-04-06 17:18:23 -0500 (Tue, 06 Apr 2010) | 1 line More NaN consistency doc fixes. ........ r79923 | georg.brandl | 2010-04-10 06:15:24 -0500 (Sat, 10 Apr 2010) | 1 line python#8360: skipTest was added in 2.7. ........ r79924 | georg.brandl | 2010-04-10 06:16:59 -0500 (Sat, 10 Apr 2010) | 1 line python#8346: update version. ........ r79941 | andrew.kuchling | 2010-04-10 20:39:36 -0500 (Sat, 10 Apr 2010) | 1 line Two grammar fixes ........ r79942 | andrew.kuchling | 2010-04-10 20:40:06 -0500 (Sat, 10 Apr 2010) | 1 line Punctuation fix ........ r79943 | andrew.kuchling | 2010-04-10 20:40:30 -0500 (Sat, 10 Apr 2010) | 1 line Add various items ........ r79945 | andrew.kuchling | 2010-04-10 20:40:49 -0500 (Sat, 10 Apr 2010) | 1 line name correct ........ r79947 | andrew.kuchling | 2010-04-10 20:44:13 -0500 (Sat, 10 Apr 2010) | 1 line Remove distutils section ........ r79951 | andrew.kuchling | 2010-04-11 07:48:08 -0500 (Sun, 11 Apr 2010) | 1 line Two typo fixes ........ r79952 | andrew.kuchling | 2010-04-11 07:49:37 -0500 (Sun, 11 Apr 2010) | 1 line Add two items ........
- Loading branch information
Showing
24 changed files
with
279 additions
and
231 deletions.
There are no files selected for viewing
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
|
@@ -233,103 +233,6 @@ With exactly the same source tree layout, this extension can be put in the | |
ext_modules=[Extension('foopkg.foo', ['foo.c'])], | ||
) | ||
|
||
Checking a package | ||
================== | ||
|
||
The ``check`` command allows you to verify if your package meta-data | ||
meet the minimum requirements to build a distribution. | ||
|
||
To run it, just call it using your :file:`setup.py` script. If something is | ||
missing, ``check`` will display a warning. | ||
|
||
Let's take an example with a simple script:: | ||
|
||
from distutils.core import setup | ||
|
||
setup(name='foobar') | ||
|
||
Running the ``check`` command will display some warnings:: | ||
|
||
$ python setup.py check | ||
running check | ||
warning: check: missing required meta-data: version, url | ||
warning: check: missing meta-data: either (author and author_email) or | ||
(maintainer and maintainer_email) must be supplied | ||
|
||
|
||
If you use the reStructuredText syntax in the ``long_description`` field and | ||
`docutils <http://docutils.sourceforge.net/>`_ is installed you can check if | ||
the syntax is fine with the ``check`` command, using the ``restructuredtext`` | ||
option. | ||
|
||
For example, if the :file:`setup.py` script is changed like this:: | ||
|
||
from distutils.core import setup | ||
|
||
desc = """\ | ||
My description | ||
============= | ||
|
||
This is the description of the ``foobar`` package. | ||
""" | ||
|
||
setup(name='foobar', version='1', author='tarek', | ||
author_email='[email protected]', | ||
url='http://example.com', long_description=desc) | ||
|
||
Where the long description is broken, ``check`` will be able to detect it | ||
by using the :mod:`docutils` parser:: | ||
|
||
$ pythontrunk setup.py check --restructuredtext | ||
running check | ||
warning: check: Title underline too short. (line 2) | ||
warning: check: Could not finish the parsing. | ||
|
||
|
||
.. _reading-metadata: | ||
|
||
Reading the metadata | ||
==================== | ||
|
||
The :func:`distutils.core.setup` function provides a command-line interface | ||
that allows you to query the metadata fields of a project through the | ||
:file:`setup.py` script of a given project:: | ||
|
||
$ python setup.py --name | ||
distribute | ||
|
||
This call reads the ``name`` metadata by running the | ||
:func:`distutils.core.setup` function. Although, when a source or binary | ||
distribution is created with Distutils, the metadata fields are written | ||
in a static file called :file:`PKG-INFO`. When a Distutils-based project is | ||
installed in Python, the :file:`PKG-INFO` file is copied alongside the modules | ||
and packages of the distribution under :file:`NAME-VERSION-pyX.X.egg-info`, | ||
where ``NAME`` is the name of the project, ``VERSION`` its version as defined | ||
in the Metadata, and ``pyX.X`` the major and minor version of Python like | ||
``2.7`` or ``3.2``. | ||
|
||
You can read back this static file, by using the | ||
:class:`distutils.dist.DistributionMetadata` class and its | ||
:func:`read_pkg_file` method:: | ||
|
||
>>> from distutils.dist import DistributionMetadata | ||
>>> metadata = DistributionMetadata() | ||
>>> metadata.read_pkg_file(open('distribute-0.6.8-py2.7.egg-info')) | ||
>>> metadata.name | ||
'distribute' | ||
>>> metadata.version | ||
'0.6.8' | ||
>>> metadata.description | ||
'Easily download, build, install, upgrade, and uninstall Python packages' | ||
|
||
Notice that the class can also be instanciated with a metadata file path to | ||
loads its values:: | ||
|
||
>>> pkg_info_path = 'distribute-0.6.8-py2.7.egg-info' | ||
>>> DistributionMetadata(pkg_info_path).name | ||
'distribute' | ||
|
||
|
||
.. % \section{Multiple extension modules} | ||
.. % \label{multiple-ext} | ||
|
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Oops, something went wrong.