]> granicus.if.org Git - python/commit
Clean up packaging.util: add __all__, remove some unused functions.
authorÉric Araujo <merwok@netwok.org>
Thu, 1 Sep 2011 03:11:29 +0000 (05:11 +0200)
committerÉric Araujo <merwok@netwok.org>
Thu, 1 Sep 2011 03:11:29 +0000 (05:11 +0200)
commit95fc53f2b378e603dadb3629597b053c13e45965
treef37a8730f28839cac28c6ffded0a6bf057af6a22
parentab3bea6815a236af940b7d25a0d295e6bbf20c5b
Clean up packaging.util: add __all__, remove some unused functions.

This huge module is the heir of six distutils modules, and contains
a number of miscellaneous functions.  I have attempted to help readers
of the source code with an annoted __all__.  Removed or deprecated
functions have been removed from the documentation; I’m working on
another patch to document the remaining public functions.

For the curious:

The unzip_file and untar_file were used by (or intended to be used by)
“pysetup install path/to/archive.tar.gz”, but the code presently used
shutil.unpack_archive and an helper function, so I just deleted them.
They’re still in the repository if we need them in the future.

The find_packages function is not used anymore but I want to discuss
module and package auto-discovery (in “pysetup create”) again before
removing it.

subst_vars now lives in sysconfig; rfc822_escape is inlined in
packaging.metadata.  Other functions are for internal use only, or
deprecated; I have left them out of __all__ and sprinkled TODO notes
for future cleanups.
Doc/library/packaging.util.rst
Lib/packaging/command/build_py.py
Lib/packaging/command/install_lib.py
Lib/packaging/command/register.py
Lib/packaging/command/upload.py
Lib/packaging/config.py
Lib/packaging/create.py
Lib/packaging/tests/test_util.py
Lib/packaging/util.py