summaryrefslogtreecommitdiffstats
path: root/Lib/packaging
diff options
context:
space:
mode:
authorJeremy Kloth <jeremy.kloth@gmail.com>2011-09-12 17:12:42 (GMT)
committerJeremy Kloth <jeremy.kloth@gmail.com>2011-09-12 17:12:42 (GMT)
commitaa2b442bdccf68c191a0023084b1160804fb5e4c (patch)
tree6e6b9ade0d959ea36e21fa72d1f308215e7fc80c /Lib/packaging
parent4c3124c2b94add8cc168ebe29aa47f0f7326d7d8 (diff)
downloadcpython-aa2b442bdccf68c191a0023084b1160804fb5e4c.zip
cpython-aa2b442bdccf68c191a0023084b1160804fb5e4c.tar.gz
cpython-aa2b442bdccf68c191a0023084b1160804fb5e4c.tar.bz2
Factor out the distribution file-system safe name functions from install_distinfo to allow all metadata consumers access to them.
Diffstat (limited to 'Lib/packaging')
-rw-r--r--Lib/packaging/command/install_distinfo.py32
-rw-r--r--Lib/packaging/dist.py4
-rw-r--r--Lib/packaging/metadata.py16
3 files changed, 16 insertions, 36 deletions
diff --git a/Lib/packaging/command/install_distinfo.py b/Lib/packaging/command/install_distinfo.py
index 1f48eed..c1f85ed 100644
--- a/Lib/packaging/command/install_distinfo.py
+++ b/Lib/packaging/command/install_distinfo.py
@@ -63,9 +63,7 @@ class install_distinfo(Command):
metadata = self.distribution.metadata
- basename = "%s-%s.dist-info" % (
- to_filename(safe_name(metadata['Name'])),
- to_filename(safe_version(metadata['Version'])))
+ basename = metadata.get_fullname(filesafe=True) + ".dist-info"
self.distinfo_dir = os.path.join(self.distinfo_dir, basename)
@@ -145,31 +143,3 @@ class install_distinfo(Command):
def get_outputs(self):
return self.outfiles
-
-
-# The following functions are taken from setuptools' pkg_resources module.
-
-def safe_name(name):
- """Convert an arbitrary string to a standard distribution name
-
- Any runs of non-alphanumeric/. characters are replaced with a single '-'.
- """
- return re.sub('[^A-Za-z0-9.]+', '-', name)
-
-
-def safe_version(version):
- """Convert an arbitrary string to a standard version string
-
- Spaces become dots, and all other non-alphanumeric characters become
- dashes, with runs of multiple dashes condensed to a single dash.
- """
- version = version.replace(' ', '.')
- return re.sub('[^A-Za-z0-9.]+', '-', version)
-
-
-def to_filename(name):
- """Convert a project or version name to its filename-escaped form
-
- Any '-' characters are currently replaced with '_'.
- """
- return name.replace('-', '_')
diff --git a/Lib/packaging/dist.py b/Lib/packaging/dist.py
index f1441d1..de718cc 100644
--- a/Lib/packaging/dist.py
+++ b/Lib/packaging/dist.py
@@ -228,8 +228,8 @@ Common commands: (see '--help-commands' for more)
d = self.command_options[command] = {}
return d
- def get_fullname(self):
- return self.metadata.get_fullname()
+ def get_fullname(self, filesafe=False):
+ return self.metadata.get_fullname(filesafe)
def dump_option_dicts(self, header=None, commands=None, indent=""):
from pprint import pformat
diff --git a/Lib/packaging/metadata.py b/Lib/packaging/metadata.py
index dbb53b2..a3db51c 100644
--- a/Lib/packaging/metadata.py
+++ b/Lib/packaging/metadata.py
@@ -182,6 +182,7 @@ _UNICODEFIELDS = ('Author', 'Maintainer', 'Summary', 'Description')
_MISSING = object()
+_FILESAFE = re.compile('[^A-Za-z0-9.]+')
class Metadata:
"""The metadata of a release.
@@ -285,9 +286,18 @@ class Metadata:
#
# Public API
#
- def get_fullname(self):
- """Return the distribution name with version"""
- return '%s-%s' % (self['Name'], self['Version'])
+ def get_fullname(self, filesafe=False):
+ """Return the distribution name with version.
+
+ If filesafe is true, return a filename-escaped form."""
+ name, version = self['Name'], self['Version']
+ if filesafe:
+ # For both name and version any runs of non-alphanumeric or '.'
+ # characters are replaced with a single '-'. Additionally any
+ # spaces in the version string become '.'
+ name = _FILESAFE.sub('-', name)
+ version = _FILESAFE.sub('-', version.replace(' ', '.'))
+ return '%s-%s' % (name, version)
def is_metadata_field(self, name):
"""return True if name is a valid metadata key"""