cpython-lru_cache-weakref: Lib/packaging/database.py annotate

annotate Lib/packaging/database.py @ 70817:dd775b1561ba

Fix markup.

author	Georg Brandl <georg@python.org>
date	Tue, 14 Jun 2011 21:09:55 +0200
parents	79f7ad26829e
children	af4ad88e90b5

rev	line source
70194 1a31c3be88b1 initial import of the packaging package in the standard library Tarek Ziade <tarek@ziade.org> parents: diff changeset	1 """PEP 376 implementation."""
1a31c3be88b1 initial import of the packaging package in the standard library Tarek Ziade <tarek@ziade.org> parents: diff changeset	2
1a31c3be88b1 initial import of the packaging package in the standard library Tarek Ziade <tarek@ziade.org> parents: diff changeset	3 import io
1a31c3be88b1 initial import of the packaging package in the standard library Tarek Ziade <tarek@ziade.org> parents: diff changeset	4 import os
1a31c3be88b1 initial import of the packaging package in the standard library Tarek Ziade <tarek@ziade.org> parents: diff changeset	5 import re
1a31c3be88b1 initial import of the packaging package in the standard library Tarek Ziade <tarek@ziade.org> parents: diff changeset	6 import csv
1a31c3be88b1 initial import of the packaging package in the standard library Tarek Ziade <tarek@ziade.org> parents: diff changeset	7 import sys
1a31c3be88b1 initial import of the packaging package in the standard library Tarek Ziade <tarek@ziade.org> parents: diff changeset	8 import zipimport
1a31c3be88b1 initial import of the packaging package in the standard library Tarek Ziade <tarek@ziade.org> parents: diff changeset	9 from hashlib import md5
1a31c3be88b1 initial import of the packaging package in the standard library Tarek Ziade <tarek@ziade.org> parents: diff changeset	10 from packaging import logger
1a31c3be88b1 initial import of the packaging package in the standard library Tarek Ziade <tarek@ziade.org> parents: diff changeset	11 from packaging.errors import PackagingError
1a31c3be88b1 initial import of the packaging package in the standard library Tarek Ziade <tarek@ziade.org> parents: diff changeset	12 from packaging.version import suggest_normalized_version, VersionPredicate
1a31c3be88b1 initial import of the packaging package in the standard library Tarek Ziade <tarek@ziade.org> parents: diff changeset	13 from packaging.metadata import Metadata
1a31c3be88b1 initial import of the packaging package in the standard library Tarek Ziade <tarek@ziade.org> parents: diff changeset	14
1a31c3be88b1 initial import of the packaging package in the standard library Tarek Ziade <tarek@ziade.org> parents: diff changeset	15
1a31c3be88b1 initial import of the packaging package in the standard library Tarek Ziade <tarek@ziade.org> parents: diff changeset	16 __all__ = [
1a31c3be88b1 initial import of the packaging package in the standard library Tarek Ziade <tarek@ziade.org> parents: diff changeset	17 'Distribution', 'EggInfoDistribution', 'distinfo_dirname',
1a31c3be88b1 initial import of the packaging package in the standard library Tarek Ziade <tarek@ziade.org> parents: diff changeset	18 'get_distributions', 'get_distribution', 'get_file_users',
1a31c3be88b1 initial import of the packaging package in the standard library Tarek Ziade <tarek@ziade.org> parents: diff changeset	19 'provides_distribution', 'obsoletes_distribution',
1a31c3be88b1 initial import of the packaging package in the standard library Tarek Ziade <tarek@ziade.org> parents: diff changeset	20 'enable_cache', 'disable_cache', 'clear_cache',
70517 d3f8c1cda108 cleanup packaging.database Tarek Ziade <tarek@ziade.org> parents: 70516 diff changeset	21 'get_file_path', 'get_file']
70194 1a31c3be88b1 initial import of the packaging package in the standard library Tarek Ziade <tarek@ziade.org> parents: diff changeset	22
1a31c3be88b1 initial import of the packaging package in the standard library Tarek Ziade <tarek@ziade.org> parents: diff changeset	23
1a31c3be88b1 initial import of the packaging package in the standard library Tarek Ziade <tarek@ziade.org> parents: diff changeset	24 # TODO update docs
1a31c3be88b1 initial import of the packaging package in the standard library Tarek Ziade <tarek@ziade.org> parents: diff changeset	25
1a31c3be88b1 initial import of the packaging package in the standard library Tarek Ziade <tarek@ziade.org> parents: diff changeset	26 DIST_FILES = ('INSTALLER', 'METADATA', 'RECORD', 'REQUESTED', 'RESOURCES')
1a31c3be88b1 initial import of the packaging package in the standard library Tarek Ziade <tarek@ziade.org> parents: diff changeset	27
1a31c3be88b1 initial import of the packaging package in the standard library Tarek Ziade <tarek@ziade.org> parents: diff changeset	28 # Cache
1a31c3be88b1 initial import of the packaging package in the standard library Tarek Ziade <tarek@ziade.org> parents: diff changeset	29 _cache_name = {} # maps names to Distribution instances
1a31c3be88b1 initial import of the packaging package in the standard library Tarek Ziade <tarek@ziade.org> parents: diff changeset	30 _cache_name_egg = {} # maps names to EggInfoDistribution instances
1a31c3be88b1 initial import of the packaging package in the standard library Tarek Ziade <tarek@ziade.org> parents: diff changeset	31 _cache_path = {} # maps paths to Distribution instances
1a31c3be88b1 initial import of the packaging package in the standard library Tarek Ziade <tarek@ziade.org> parents: diff changeset	32 _cache_path_egg = {} # maps paths to EggInfoDistribution instances
1a31c3be88b1 initial import of the packaging package in the standard library Tarek Ziade <tarek@ziade.org> parents: diff changeset	33 _cache_generated = False # indicates if .dist-info distributions are cached
1a31c3be88b1 initial import of the packaging package in the standard library Tarek Ziade <tarek@ziade.org> parents: diff changeset	34 _cache_generated_egg = False # indicates if .dist-info and .egg are cached
1a31c3be88b1 initial import of the packaging package in the standard library Tarek Ziade <tarek@ziade.org> parents: diff changeset	35 _cache_enabled = True
1a31c3be88b1 initial import of the packaging package in the standard library Tarek Ziade <tarek@ziade.org> parents: diff changeset	36
1a31c3be88b1 initial import of the packaging package in the standard library Tarek Ziade <tarek@ziade.org> parents: diff changeset	37
1a31c3be88b1 initial import of the packaging package in the standard library Tarek Ziade <tarek@ziade.org> parents: diff changeset	38 def enable_cache():
1a31c3be88b1 initial import of the packaging package in the standard library Tarek Ziade <tarek@ziade.org> parents: diff changeset	39 """
1a31c3be88b1 initial import of the packaging package in the standard library Tarek Ziade <tarek@ziade.org> parents: diff changeset	40 Enables the internal cache.
1a31c3be88b1 initial import of the packaging package in the standard library Tarek Ziade <tarek@ziade.org> parents: diff changeset	41
1a31c3be88b1 initial import of the packaging package in the standard library Tarek Ziade <tarek@ziade.org> parents: diff changeset	42 Note that this function will not clear the cache in any case, for that
1a31c3be88b1 initial import of the packaging package in the standard library Tarek Ziade <tarek@ziade.org> parents: diff changeset	43 functionality see :func:`clear_cache`.
1a31c3be88b1 initial import of the packaging package in the standard library Tarek Ziade <tarek@ziade.org> parents: diff changeset	44 """
1a31c3be88b1 initial import of the packaging package in the standard library Tarek Ziade <tarek@ziade.org> parents: diff changeset	45 global _cache_enabled
1a31c3be88b1 initial import of the packaging package in the standard library Tarek Ziade <tarek@ziade.org> parents: diff changeset	46
1a31c3be88b1 initial import of the packaging package in the standard library Tarek Ziade <tarek@ziade.org> parents: diff changeset	47 _cache_enabled = True
1a31c3be88b1 initial import of the packaging package in the standard library Tarek Ziade <tarek@ziade.org> parents: diff changeset	48
1a31c3be88b1 initial import of the packaging package in the standard library Tarek Ziade <tarek@ziade.org> parents: diff changeset	49
1a31c3be88b1 initial import of the packaging package in the standard library Tarek Ziade <tarek@ziade.org> parents: diff changeset	50 def disable_cache():
1a31c3be88b1 initial import of the packaging package in the standard library Tarek Ziade <tarek@ziade.org> parents: diff changeset	51 """
1a31c3be88b1 initial import of the packaging package in the standard library Tarek Ziade <tarek@ziade.org> parents: diff changeset	52 Disables the internal cache.
1a31c3be88b1 initial import of the packaging package in the standard library Tarek Ziade <tarek@ziade.org> parents: diff changeset	53
1a31c3be88b1 initial import of the packaging package in the standard library Tarek Ziade <tarek@ziade.org> parents: diff changeset	54 Note that this function will not clear the cache in any case, for that
1a31c3be88b1 initial import of the packaging package in the standard library Tarek Ziade <tarek@ziade.org> parents: diff changeset	55 functionality see :func:`clear_cache`.
1a31c3be88b1 initial import of the packaging package in the standard library Tarek Ziade <tarek@ziade.org> parents: diff changeset	56 """
1a31c3be88b1 initial import of the packaging package in the standard library Tarek Ziade <tarek@ziade.org> parents: diff changeset	57 global _cache_enabled
1a31c3be88b1 initial import of the packaging package in the standard library Tarek Ziade <tarek@ziade.org> parents: diff changeset	58
1a31c3be88b1 initial import of the packaging package in the standard library Tarek Ziade <tarek@ziade.org> parents: diff changeset	59 _cache_enabled = False
1a31c3be88b1 initial import of the packaging package in the standard library Tarek Ziade <tarek@ziade.org> parents: diff changeset	60
1a31c3be88b1 initial import of the packaging package in the standard library Tarek Ziade <tarek@ziade.org> parents: diff changeset	61
1a31c3be88b1 initial import of the packaging package in the standard library Tarek Ziade <tarek@ziade.org> parents: diff changeset	62 def clear_cache():
1a31c3be88b1 initial import of the packaging package in the standard library Tarek Ziade <tarek@ziade.org> parents: diff changeset	63 """ Clears the internal cache. """
1a31c3be88b1 initial import of the packaging package in the standard library Tarek Ziade <tarek@ziade.org> parents: diff changeset	64 global _cache_name, _cache_name_egg, _cache_path, _cache_path_egg, \
1a31c3be88b1 initial import of the packaging package in the standard library Tarek Ziade <tarek@ziade.org> parents: diff changeset	65 _cache_generated, _cache_generated_egg
1a31c3be88b1 initial import of the packaging package in the standard library Tarek Ziade <tarek@ziade.org> parents: diff changeset	66
1a31c3be88b1 initial import of the packaging package in the standard library Tarek Ziade <tarek@ziade.org> parents: diff changeset	67 _cache_name = {}
1a31c3be88b1 initial import of the packaging package in the standard library Tarek Ziade <tarek@ziade.org> parents: diff changeset	68 _cache_name_egg = {}
1a31c3be88b1 initial import of the packaging package in the standard library Tarek Ziade <tarek@ziade.org> parents: diff changeset	69 _cache_path = {}
1a31c3be88b1 initial import of the packaging package in the standard library Tarek Ziade <tarek@ziade.org> parents: diff changeset	70 _cache_path_egg = {}
1a31c3be88b1 initial import of the packaging package in the standard library Tarek Ziade <tarek@ziade.org> parents: diff changeset	71 _cache_generated = False
1a31c3be88b1 initial import of the packaging package in the standard library Tarek Ziade <tarek@ziade.org> parents: diff changeset	72 _cache_generated_egg = False
1a31c3be88b1 initial import of the packaging package in the standard library Tarek Ziade <tarek@ziade.org> parents: diff changeset	73
1a31c3be88b1 initial import of the packaging package in the standard library Tarek Ziade <tarek@ziade.org> parents: diff changeset	74
1a31c3be88b1 initial import of the packaging package in the standard library Tarek Ziade <tarek@ziade.org> parents: diff changeset	75 def _yield_distributions(include_dist, include_egg, paths=sys.path):
1a31c3be88b1 initial import of the packaging package in the standard library Tarek Ziade <tarek@ziade.org> parents: diff changeset	76 """
1a31c3be88b1 initial import of the packaging package in the standard library Tarek Ziade <tarek@ziade.org> parents: diff changeset	77 Yield .dist-info and .egg(-info) distributions, based on the arguments
1a31c3be88b1 initial import of the packaging package in the standard library Tarek Ziade <tarek@ziade.org> parents: diff changeset	78
1a31c3be88b1 initial import of the packaging package in the standard library Tarek Ziade <tarek@ziade.org> parents: diff changeset	79 :parameter include_dist: yield .dist-info distributions
1a31c3be88b1 initial import of the packaging package in the standard library Tarek Ziade <tarek@ziade.org> parents: diff changeset	80 :parameter include_egg: yield .egg(-info) distributions
1a31c3be88b1 initial import of the packaging package in the standard library Tarek Ziade <tarek@ziade.org> parents: diff changeset	81 """
1a31c3be88b1 initial import of the packaging package in the standard library Tarek Ziade <tarek@ziade.org> parents: diff changeset	82 for path in paths:
1a31c3be88b1 initial import of the packaging package in the standard library Tarek Ziade <tarek@ziade.org> parents: diff changeset	83 realpath = os.path.realpath(path)
1a31c3be88b1 initial import of the packaging package in the standard library Tarek Ziade <tarek@ziade.org> parents: diff changeset	84 if not os.path.isdir(realpath):
1a31c3be88b1 initial import of the packaging package in the standard library Tarek Ziade <tarek@ziade.org> parents: diff changeset	85 continue
1a31c3be88b1 initial import of the packaging package in the standard library Tarek Ziade <tarek@ziade.org> parents: diff changeset	86 for dir in os.listdir(realpath):
1a31c3be88b1 initial import of the packaging package in the standard library Tarek Ziade <tarek@ziade.org> parents: diff changeset	87 dist_path = os.path.join(realpath, dir)
1a31c3be88b1 initial import of the packaging package in the standard library Tarek Ziade <tarek@ziade.org> parents: diff changeset	88 if include_dist and dir.endswith('.dist-info'):
1a31c3be88b1 initial import of the packaging package in the standard library Tarek Ziade <tarek@ziade.org> parents: diff changeset	89 yield Distribution(dist_path)
1a31c3be88b1 initial import of the packaging package in the standard library Tarek Ziade <tarek@ziade.org> parents: diff changeset	90 elif include_egg and (dir.endswith('.egg-info') or
1a31c3be88b1 initial import of the packaging package in the standard library Tarek Ziade <tarek@ziade.org> parents: diff changeset	91 dir.endswith('.egg')):
1a31c3be88b1 initial import of the packaging package in the standard library Tarek Ziade <tarek@ziade.org> parents: diff changeset	92 yield EggInfoDistribution(dist_path)
1a31c3be88b1 initial import of the packaging package in the standard library Tarek Ziade <tarek@ziade.org> parents: diff changeset	93
1a31c3be88b1 initial import of the packaging package in the standard library Tarek Ziade <tarek@ziade.org> parents: diff changeset	94
1a31c3be88b1 initial import of the packaging package in the standard library Tarek Ziade <tarek@ziade.org> parents: diff changeset	95 def _generate_cache(use_egg_info=False, paths=sys.path):
1a31c3be88b1 initial import of the packaging package in the standard library Tarek Ziade <tarek@ziade.org> parents: diff changeset	96 global _cache_generated, _cache_generated_egg
1a31c3be88b1 initial import of the packaging package in the standard library Tarek Ziade <tarek@ziade.org> parents: diff changeset	97
1a31c3be88b1 initial import of the packaging package in the standard library Tarek Ziade <tarek@ziade.org> parents: diff changeset	98 if _cache_generated_egg or (_cache_generated and not use_egg_info):
1a31c3be88b1 initial import of the packaging package in the standard library Tarek Ziade <tarek@ziade.org> parents: diff changeset	99 return
1a31c3be88b1 initial import of the packaging package in the standard library Tarek Ziade <tarek@ziade.org> parents: diff changeset	100 else:
1a31c3be88b1 initial import of the packaging package in the standard library Tarek Ziade <tarek@ziade.org> parents: diff changeset	101 gen_dist = not _cache_generated
1a31c3be88b1 initial import of the packaging package in the standard library Tarek Ziade <tarek@ziade.org> parents: diff changeset	102 gen_egg = use_egg_info
1a31c3be88b1 initial import of the packaging package in the standard library Tarek Ziade <tarek@ziade.org> parents: diff changeset	103
1a31c3be88b1 initial import of the packaging package in the standard library Tarek Ziade <tarek@ziade.org> parents: diff changeset	104 for dist in _yield_distributions(gen_dist, gen_egg, paths):
1a31c3be88b1 initial import of the packaging package in the standard library Tarek Ziade <tarek@ziade.org> parents: diff changeset	105 if isinstance(dist, Distribution):
1a31c3be88b1 initial import of the packaging package in the standard library Tarek Ziade <tarek@ziade.org> parents: diff changeset	106 _cache_path[dist.path] = dist
70725 79f7ad26829e Style change in packaging: use “not in” over “not x in”. Éric Araujo <merwok@netwok.org> parents: 70517 diff changeset	107 if dist.name not in _cache_name:
70194 1a31c3be88b1 initial import of the packaging package in the standard library Tarek Ziade <tarek@ziade.org> parents: diff changeset	108 _cache_name[dist.name] = []
1a31c3be88b1 initial import of the packaging package in the standard library Tarek Ziade <tarek@ziade.org> parents: diff changeset	109 _cache_name[dist.name].append(dist)
1a31c3be88b1 initial import of the packaging package in the standard library Tarek Ziade <tarek@ziade.org> parents: diff changeset	110 else:
1a31c3be88b1 initial import of the packaging package in the standard library Tarek Ziade <tarek@ziade.org> parents: diff changeset	111 _cache_path_egg[dist.path] = dist
70725 79f7ad26829e Style change in packaging: use “not in” over “not x in”. Éric Araujo <merwok@netwok.org> parents: 70517 diff changeset	112 if dist.name not in _cache_name_egg:
70194 1a31c3be88b1 initial import of the packaging package in the standard library Tarek Ziade <tarek@ziade.org> parents: diff changeset	113 _cache_name_egg[dist.name] = []
1a31c3be88b1 initial import of the packaging package in the standard library Tarek Ziade <tarek@ziade.org> parents: diff changeset	114 _cache_name_egg[dist.name].append(dist)
1a31c3be88b1 initial import of the packaging package in the standard library Tarek Ziade <tarek@ziade.org> parents: diff changeset	115
1a31c3be88b1 initial import of the packaging package in the standard library Tarek Ziade <tarek@ziade.org> parents: diff changeset	116 if gen_dist:
1a31c3be88b1 initial import of the packaging package in the standard library Tarek Ziade <tarek@ziade.org> parents: diff changeset	117 _cache_generated = True
1a31c3be88b1 initial import of the packaging package in the standard library Tarek Ziade <tarek@ziade.org> parents: diff changeset	118 if gen_egg:
1a31c3be88b1 initial import of the packaging package in the standard library Tarek Ziade <tarek@ziade.org> parents: diff changeset	119 _cache_generated_egg = True
1a31c3be88b1 initial import of the packaging package in the standard library Tarek Ziade <tarek@ziade.org> parents: diff changeset	120
1a31c3be88b1 initial import of the packaging package in the standard library Tarek Ziade <tarek@ziade.org> parents: diff changeset	121
1a31c3be88b1 initial import of the packaging package in the standard library Tarek Ziade <tarek@ziade.org> parents: diff changeset	122 class Distribution:
1a31c3be88b1 initial import of the packaging package in the standard library Tarek Ziade <tarek@ziade.org> parents: diff changeset	123 """Created with the path of the ``.dist-info`` directory provided to the
1a31c3be88b1 initial import of the packaging package in the standard library Tarek Ziade <tarek@ziade.org> parents: diff changeset	124 constructor. It reads the metadata contained in ``METADATA`` when it is
1a31c3be88b1 initial import of the packaging package in the standard library Tarek Ziade <tarek@ziade.org> parents: diff changeset	125 instantiated."""
1a31c3be88b1 initial import of the packaging package in the standard library Tarek Ziade <tarek@ziade.org> parents: diff changeset	126
1a31c3be88b1 initial import of the packaging package in the standard library Tarek Ziade <tarek@ziade.org> parents: diff changeset	127 name = ''
1a31c3be88b1 initial import of the packaging package in the standard library Tarek Ziade <tarek@ziade.org> parents: diff changeset	128 """The name of the distribution."""
1a31c3be88b1 initial import of the packaging package in the standard library Tarek Ziade <tarek@ziade.org> parents: diff changeset	129
1a31c3be88b1 initial import of the packaging package in the standard library Tarek Ziade <tarek@ziade.org> parents: diff changeset	130 version = ''
1a31c3be88b1 initial import of the packaging package in the standard library Tarek Ziade <tarek@ziade.org> parents: diff changeset	131 """The version of the distribution."""
1a31c3be88b1 initial import of the packaging package in the standard library Tarek Ziade <tarek@ziade.org> parents: diff changeset	132
1a31c3be88b1 initial import of the packaging package in the standard library Tarek Ziade <tarek@ziade.org> parents: diff changeset	133 metadata = None
1a31c3be88b1 initial import of the packaging package in the standard library Tarek Ziade <tarek@ziade.org> parents: diff changeset	134 """A :class:`packaging.metadata.Metadata` instance loaded with
1a31c3be88b1 initial import of the packaging package in the standard library Tarek Ziade <tarek@ziade.org> parents: diff changeset	135 the distribution's ``METADATA`` file."""
1a31c3be88b1 initial import of the packaging package in the standard library Tarek Ziade <tarek@ziade.org> parents: diff changeset	136
1a31c3be88b1 initial import of the packaging package in the standard library Tarek Ziade <tarek@ziade.org> parents: diff changeset	137 requested = False
1a31c3be88b1 initial import of the packaging package in the standard library Tarek Ziade <tarek@ziade.org> parents: diff changeset	138 """A boolean that indicates whether the ``REQUESTED`` metadata file is
1a31c3be88b1 initial import of the packaging package in the standard library Tarek Ziade <tarek@ziade.org> parents: diff changeset	139 present (in other words, whether the package was installed by user
1a31c3be88b1 initial import of the packaging package in the standard library Tarek Ziade <tarek@ziade.org> parents: diff changeset	140 request or it was installed as a dependency)."""
1a31c3be88b1 initial import of the packaging package in the standard library Tarek Ziade <tarek@ziade.org> parents: diff changeset	141
1a31c3be88b1 initial import of the packaging package in the standard library Tarek Ziade <tarek@ziade.org> parents: diff changeset	142 def __init__(self, path):
1a31c3be88b1 initial import of the packaging package in the standard library Tarek Ziade <tarek@ziade.org> parents: diff changeset	143 if _cache_enabled and path in _cache_path:
1a31c3be88b1 initial import of the packaging package in the standard library Tarek Ziade <tarek@ziade.org> parents: diff changeset	144 self.metadata = _cache_path[path].metadata
1a31c3be88b1 initial import of the packaging package in the standard library Tarek Ziade <tarek@ziade.org> parents: diff changeset	145 else:
1a31c3be88b1 initial import of the packaging package in the standard library Tarek Ziade <tarek@ziade.org> parents: diff changeset	146 metadata_path = os.path.join(path, 'METADATA')
1a31c3be88b1 initial import of the packaging package in the standard library Tarek Ziade <tarek@ziade.org> parents: diff changeset	147 self.metadata = Metadata(path=metadata_path)
1a31c3be88b1 initial import of the packaging package in the standard library Tarek Ziade <tarek@ziade.org> parents: diff changeset	148
1a31c3be88b1 initial import of the packaging package in the standard library Tarek Ziade <tarek@ziade.org> parents: diff changeset	149 self.name = self.metadata['Name']
1a31c3be88b1 initial import of the packaging package in the standard library Tarek Ziade <tarek@ziade.org> parents: diff changeset	150 self.version = self.metadata['Version']
1a31c3be88b1 initial import of the packaging package in the standard library Tarek Ziade <tarek@ziade.org> parents: diff changeset	151 self.path = path
1a31c3be88b1 initial import of the packaging package in the standard library Tarek Ziade <tarek@ziade.org> parents: diff changeset	152
70725 79f7ad26829e Style change in packaging: use “not in” over “not x in”. Éric Araujo <merwok@netwok.org> parents: 70517 diff changeset	153 if _cache_enabled and path not in _cache_path:
70194 1a31c3be88b1 initial import of the packaging package in the standard library Tarek Ziade <tarek@ziade.org> parents: diff changeset	154 _cache_path[path] = self
1a31c3be88b1 initial import of the packaging package in the standard library Tarek Ziade <tarek@ziade.org> parents: diff changeset	155
1a31c3be88b1 initial import of the packaging package in the standard library Tarek Ziade <tarek@ziade.org> parents: diff changeset	156 def __repr__(self):
1a31c3be88b1 initial import of the packaging package in the standard library Tarek Ziade <tarek@ziade.org> parents: diff changeset	157 return '<Distribution %r %s at %r>' % (
1a31c3be88b1 initial import of the packaging package in the standard library Tarek Ziade <tarek@ziade.org> parents: diff changeset	158 self.name, self.version, self.path)
1a31c3be88b1 initial import of the packaging package in the standard library Tarek Ziade <tarek@ziade.org> parents: diff changeset	159
1a31c3be88b1 initial import of the packaging package in the standard library Tarek Ziade <tarek@ziade.org> parents: diff changeset	160 def _get_records(self, local=False):
1a31c3be88b1 initial import of the packaging package in the standard library Tarek Ziade <tarek@ziade.org> parents: diff changeset	161 with self.get_distinfo_file('RECORD') as record:
70259 391aa4da36b5 use the same line terminator everywhere Tarek Ziade <tarek@ziade.org> parents: 70194 diff changeset	162 record_reader = csv.reader(record, delimiter=',',
391aa4da36b5 use the same line terminator everywhere Tarek Ziade <tarek@ziade.org> parents: 70194 diff changeset	163 lineterminator='\n')
70194 1a31c3be88b1 initial import of the packaging package in the standard library Tarek Ziade <tarek@ziade.org> parents: diff changeset	164 # XXX needs an explaining comment
1a31c3be88b1 initial import of the packaging package in the standard library Tarek Ziade <tarek@ziade.org> parents: diff changeset	165 for row in record_reader:
1a31c3be88b1 initial import of the packaging package in the standard library Tarek Ziade <tarek@ziade.org> parents: diff changeset	166 path, checksum, size = (row[:] +
1a31c3be88b1 initial import of the packaging package in the standard library Tarek Ziade <tarek@ziade.org> parents: diff changeset	167 [None for i in range(len(row), 3)])
1a31c3be88b1 initial import of the packaging package in the standard library Tarek Ziade <tarek@ziade.org> parents: diff changeset	168 if local:
1a31c3be88b1 initial import of the packaging package in the standard library Tarek Ziade <tarek@ziade.org> parents: diff changeset	169 path = path.replace('/', os.sep)
1a31c3be88b1 initial import of the packaging package in the standard library Tarek Ziade <tarek@ziade.org> parents: diff changeset	170 path = os.path.join(sys.prefix, path)
1a31c3be88b1 initial import of the packaging package in the standard library Tarek Ziade <tarek@ziade.org> parents: diff changeset	171 yield path, checksum, size
1a31c3be88b1 initial import of the packaging package in the standard library Tarek Ziade <tarek@ziade.org> parents: diff changeset	172
1a31c3be88b1 initial import of the packaging package in the standard library Tarek Ziade <tarek@ziade.org> parents: diff changeset	173 def get_resource_path(self, relative_path):
1a31c3be88b1 initial import of the packaging package in the standard library Tarek Ziade <tarek@ziade.org> parents: diff changeset	174 with self.get_distinfo_file('RESOURCES') as resources_file:
70259 391aa4da36b5 use the same line terminator everywhere Tarek Ziade <tarek@ziade.org> parents: 70194 diff changeset	175 resources_reader = csv.reader(resources_file, delimiter=',',
391aa4da36b5 use the same line terminator everywhere Tarek Ziade <tarek@ziade.org> parents: 70194 diff changeset	176 lineterminator='\n')
70194 1a31c3be88b1 initial import of the packaging package in the standard library Tarek Ziade <tarek@ziade.org> parents: diff changeset	177 for relative, destination in resources_reader:
1a31c3be88b1 initial import of the packaging package in the standard library Tarek Ziade <tarek@ziade.org> parents: diff changeset	178 if relative == relative_path:
1a31c3be88b1 initial import of the packaging package in the standard library Tarek Ziade <tarek@ziade.org> parents: diff changeset	179 return destination
1a31c3be88b1 initial import of the packaging package in the standard library Tarek Ziade <tarek@ziade.org> parents: diff changeset	180 raise KeyError(
1a31c3be88b1 initial import of the packaging package in the standard library Tarek Ziade <tarek@ziade.org> parents: diff changeset	181 'no resource file with relative path %r is installed' %
1a31c3be88b1 initial import of the packaging package in the standard library Tarek Ziade <tarek@ziade.org> parents: diff changeset	182 relative_path)
1a31c3be88b1 initial import of the packaging package in the standard library Tarek Ziade <tarek@ziade.org> parents: diff changeset	183
1a31c3be88b1 initial import of the packaging package in the standard library Tarek Ziade <tarek@ziade.org> parents: diff changeset	184 def list_installed_files(self, local=False):
1a31c3be88b1 initial import of the packaging package in the standard library Tarek Ziade <tarek@ziade.org> parents: diff changeset	185 """
1a31c3be88b1 initial import of the packaging package in the standard library Tarek Ziade <tarek@ziade.org> parents: diff changeset	186 Iterates over the ``RECORD`` entries and returns a tuple
1a31c3be88b1 initial import of the packaging package in the standard library Tarek Ziade <tarek@ziade.org> parents: diff changeset	187 ``(path, md5, size)`` for each line. If local is ``True``,
1a31c3be88b1 initial import of the packaging package in the standard library Tarek Ziade <tarek@ziade.org> parents: diff changeset	188 the returned path is transformed into a local absolute path.
1a31c3be88b1 initial import of the packaging package in the standard library Tarek Ziade <tarek@ziade.org> parents: diff changeset	189 Otherwise the raw value from RECORD is returned.
1a31c3be88b1 initial import of the packaging package in the standard library Tarek Ziade <tarek@ziade.org> parents: diff changeset	190
1a31c3be88b1 initial import of the packaging package in the standard library Tarek Ziade <tarek@ziade.org> parents: diff changeset	191 A local absolute path is an absolute path in which occurrences of
1a31c3be88b1 initial import of the packaging package in the standard library Tarek Ziade <tarek@ziade.org> parents: diff changeset	192 ``'/'`` have been replaced by the system separator given by ``os.sep``.
1a31c3be88b1 initial import of the packaging package in the standard library Tarek Ziade <tarek@ziade.org> parents: diff changeset	193
1a31c3be88b1 initial import of the packaging package in the standard library Tarek Ziade <tarek@ziade.org> parents: diff changeset	194 :parameter local: flag to say if the path should be returned a local
1a31c3be88b1 initial import of the packaging package in the standard library Tarek Ziade <tarek@ziade.org> parents: diff changeset	195 absolute path
1a31c3be88b1 initial import of the packaging package in the standard library Tarek Ziade <tarek@ziade.org> parents: diff changeset	196
1a31c3be88b1 initial import of the packaging package in the standard library Tarek Ziade <tarek@ziade.org> parents: diff changeset	197 :type local: boolean
1a31c3be88b1 initial import of the packaging package in the standard library Tarek Ziade <tarek@ziade.org> parents: diff changeset	198 :returns: iterator of (path, md5, size)
1a31c3be88b1 initial import of the packaging package in the standard library Tarek Ziade <tarek@ziade.org> parents: diff changeset	199 """
1a31c3be88b1 initial import of the packaging package in the standard library Tarek Ziade <tarek@ziade.org> parents: diff changeset	200 return self._get_records(local)
1a31c3be88b1 initial import of the packaging package in the standard library Tarek Ziade <tarek@ziade.org> parents: diff changeset	201
1a31c3be88b1 initial import of the packaging package in the standard library Tarek Ziade <tarek@ziade.org> parents: diff changeset	202 def uses(self, path):
1a31c3be88b1 initial import of the packaging package in the standard library Tarek Ziade <tarek@ziade.org> parents: diff changeset	203 """
1a31c3be88b1 initial import of the packaging package in the standard library Tarek Ziade <tarek@ziade.org> parents: diff changeset	204 Returns ``True`` if path is listed in ``RECORD``. path can be a local
1a31c3be88b1 initial import of the packaging package in the standard library Tarek Ziade <tarek@ziade.org> parents: diff changeset	205 absolute path or a relative ``'/'``-separated path.
1a31c3be88b1 initial import of the packaging package in the standard library Tarek Ziade <tarek@ziade.org> parents: diff changeset	206
1a31c3be88b1 initial import of the packaging package in the standard library Tarek Ziade <tarek@ziade.org> parents: diff changeset	207 :rtype: boolean
1a31c3be88b1 initial import of the packaging package in the standard library Tarek Ziade <tarek@ziade.org> parents: diff changeset	208 """
1a31c3be88b1 initial import of the packaging package in the standard library Tarek Ziade <tarek@ziade.org> parents: diff changeset	209 for p, checksum, size in self._get_records():
1a31c3be88b1 initial import of the packaging package in the standard library Tarek Ziade <tarek@ziade.org> parents: diff changeset	210 local_absolute = os.path.join(sys.prefix, p)
1a31c3be88b1 initial import of the packaging package in the standard library Tarek Ziade <tarek@ziade.org> parents: diff changeset	211 if path == p or path == local_absolute:
1a31c3be88b1 initial import of the packaging package in the standard library Tarek Ziade <tarek@ziade.org> parents: diff changeset	212 return True
1a31c3be88b1 initial import of the packaging package in the standard library Tarek Ziade <tarek@ziade.org> parents: diff changeset	213 return False
1a31c3be88b1 initial import of the packaging package in the standard library Tarek Ziade <tarek@ziade.org> parents: diff changeset	214
1a31c3be88b1 initial import of the packaging package in the standard library Tarek Ziade <tarek@ziade.org> parents: diff changeset	215 def get_distinfo_file(self, path, binary=False):
1a31c3be88b1 initial import of the packaging package in the standard library Tarek Ziade <tarek@ziade.org> parents: diff changeset	216 """
1a31c3be88b1 initial import of the packaging package in the standard library Tarek Ziade <tarek@ziade.org> parents: diff changeset	217 Returns a file located under the ``.dist-info`` directory. Returns a
1a31c3be88b1 initial import of the packaging package in the standard library Tarek Ziade <tarek@ziade.org> parents: diff changeset	218 ``file`` instance for the file pointed by path.
1a31c3be88b1 initial import of the packaging package in the standard library Tarek Ziade <tarek@ziade.org> parents: diff changeset	219
1a31c3be88b1 initial import of the packaging package in the standard library Tarek Ziade <tarek@ziade.org> parents: diff changeset	220 :parameter path: a ``'/'``-separated path relative to the
1a31c3be88b1 initial import of the packaging package in the standard library Tarek Ziade <tarek@ziade.org> parents: diff changeset	221 ``.dist-info`` directory or an absolute path;
1a31c3be88b1 initial import of the packaging package in the standard library Tarek Ziade <tarek@ziade.org> parents: diff changeset	222 If path is an absolute path and doesn't start
1a31c3be88b1 initial import of the packaging package in the standard library Tarek Ziade <tarek@ziade.org> parents: diff changeset	223 with the ``.dist-info`` directory path,
1a31c3be88b1 initial import of the packaging package in the standard library Tarek Ziade <tarek@ziade.org> parents: diff changeset	224 a :class:`PackagingError` is raised
1a31c3be88b1 initial import of the packaging package in the standard library Tarek Ziade <tarek@ziade.org> parents: diff changeset	225 :type path: string
1a31c3be88b1 initial import of the packaging package in the standard library Tarek Ziade <tarek@ziade.org> parents: diff changeset	226 :parameter binary: If binary is ``True``, opens the file in read-only
1a31c3be88b1 initial import of the packaging package in the standard library Tarek Ziade <tarek@ziade.org> parents: diff changeset	227 binary mode (``rb``), otherwise opens it in
1a31c3be88b1 initial import of the packaging package in the standard library Tarek Ziade <tarek@ziade.org> parents: diff changeset	228 read-only mode (``r``).
1a31c3be88b1 initial import of the packaging package in the standard library Tarek Ziade <tarek@ziade.org> parents: diff changeset	229 :rtype: file object
1a31c3be88b1 initial import of the packaging package in the standard library Tarek Ziade <tarek@ziade.org> parents: diff changeset	230 """
1a31c3be88b1 initial import of the packaging package in the standard library Tarek Ziade <tarek@ziade.org> parents: diff changeset	231 open_flags = 'r'
1a31c3be88b1 initial import of the packaging package in the standard library Tarek Ziade <tarek@ziade.org> parents: diff changeset	232 if binary:
1a31c3be88b1 initial import of the packaging package in the standard library Tarek Ziade <tarek@ziade.org> parents: diff changeset	233 open_flags += 'b'
1a31c3be88b1 initial import of the packaging package in the standard library Tarek Ziade <tarek@ziade.org> parents: diff changeset	234
1a31c3be88b1 initial import of the packaging package in the standard library Tarek Ziade <tarek@ziade.org> parents: diff changeset	235 # Check if it is an absolute path # XXX use relpath, add tests
1a31c3be88b1 initial import of the packaging package in the standard library Tarek Ziade <tarek@ziade.org> parents: diff changeset	236 if path.find(os.sep) >= 0:
1a31c3be88b1 initial import of the packaging package in the standard library Tarek Ziade <tarek@ziade.org> parents: diff changeset	237 # it's an absolute path?
1a31c3be88b1 initial import of the packaging package in the standard library Tarek Ziade <tarek@ziade.org> parents: diff changeset	238 distinfo_dirname, path = path.split(os.sep)[-2:]
1a31c3be88b1 initial import of the packaging package in the standard library Tarek Ziade <tarek@ziade.org> parents: diff changeset	239 if distinfo_dirname != self.path.split(os.sep)[-1]:
1a31c3be88b1 initial import of the packaging package in the standard library Tarek Ziade <tarek@ziade.org> parents: diff changeset	240 raise PackagingError(
1a31c3be88b1 initial import of the packaging package in the standard library Tarek Ziade <tarek@ziade.org> parents: diff changeset	241 'dist-info file %r does not belong to the %r %s '
1a31c3be88b1 initial import of the packaging package in the standard library Tarek Ziade <tarek@ziade.org> parents: diff changeset	242 'distribution' % (path, self.name, self.version))
1a31c3be88b1 initial import of the packaging package in the standard library Tarek Ziade <tarek@ziade.org> parents: diff changeset	243
1a31c3be88b1 initial import of the packaging package in the standard library Tarek Ziade <tarek@ziade.org> parents: diff changeset	244 # The file must be relative
1a31c3be88b1 initial import of the packaging package in the standard library Tarek Ziade <tarek@ziade.org> parents: diff changeset	245 if path not in DIST_FILES:
1a31c3be88b1 initial import of the packaging package in the standard library Tarek Ziade <tarek@ziade.org> parents: diff changeset	246 raise PackagingError('invalid path for a dist-info file: %r' %
1a31c3be88b1 initial import of the packaging package in the standard library Tarek Ziade <tarek@ziade.org> parents: diff changeset	247 path)
1a31c3be88b1 initial import of the packaging package in the standard library Tarek Ziade <tarek@ziade.org> parents: diff changeset	248
1a31c3be88b1 initial import of the packaging package in the standard library Tarek Ziade <tarek@ziade.org> parents: diff changeset	249 path = os.path.join(self.path, path)
1a31c3be88b1 initial import of the packaging package in the standard library Tarek Ziade <tarek@ziade.org> parents: diff changeset	250 return open(path, open_flags)
1a31c3be88b1 initial import of the packaging package in the standard library Tarek Ziade <tarek@ziade.org> parents: diff changeset	251
1a31c3be88b1 initial import of the packaging package in the standard library Tarek Ziade <tarek@ziade.org> parents: diff changeset	252 def list_distinfo_files(self, local=False):
1a31c3be88b1 initial import of the packaging package in the standard library Tarek Ziade <tarek@ziade.org> parents: diff changeset	253 """
1a31c3be88b1 initial import of the packaging package in the standard library Tarek Ziade <tarek@ziade.org> parents: diff changeset	254 Iterates over the ``RECORD`` entries and returns paths for each line if
1a31c3be88b1 initial import of the packaging package in the standard library Tarek Ziade <tarek@ziade.org> parents: diff changeset	255 the path is pointing to a file located in the ``.dist-info`` directory
1a31c3be88b1 initial import of the packaging package in the standard library Tarek Ziade <tarek@ziade.org> parents: diff changeset	256 or one of its subdirectories.
1a31c3be88b1 initial import of the packaging package in the standard library Tarek Ziade <tarek@ziade.org> parents: diff changeset	257
1a31c3be88b1 initial import of the packaging package in the standard library Tarek Ziade <tarek@ziade.org> parents: diff changeset	258 :parameter local: If local is ``True``, each returned path is
1a31c3be88b1 initial import of the packaging package in the standard library Tarek Ziade <tarek@ziade.org> parents: diff changeset	259 transformed into a local absolute path. Otherwise the
1a31c3be88b1 initial import of the packaging package in the standard library Tarek Ziade <tarek@ziade.org> parents: diff changeset	260 raw value from ``RECORD`` is returned.
1a31c3be88b1 initial import of the packaging package in the standard library Tarek Ziade <tarek@ziade.org> parents: diff changeset	261 :type local: boolean
1a31c3be88b1 initial import of the packaging package in the standard library Tarek Ziade <tarek@ziade.org> parents: diff changeset	262 :returns: iterator of paths
1a31c3be88b1 initial import of the packaging package in the standard library Tarek Ziade <tarek@ziade.org> parents: diff changeset	263 """
1a31c3be88b1 initial import of the packaging package in the standard library Tarek Ziade <tarek@ziade.org> parents: diff changeset	264 for path, checksum, size in self._get_records(local):
1a31c3be88b1 initial import of the packaging package in the standard library Tarek Ziade <tarek@ziade.org> parents: diff changeset	265 yield path
1a31c3be88b1 initial import of the packaging package in the standard library Tarek Ziade <tarek@ziade.org> parents: diff changeset	266
1a31c3be88b1 initial import of the packaging package in the standard library Tarek Ziade <tarek@ziade.org> parents: diff changeset	267 def __eq__(self, other):
1a31c3be88b1 initial import of the packaging package in the standard library Tarek Ziade <tarek@ziade.org> parents: diff changeset	268 return isinstance(other, Distribution) and self.path == other.path
1a31c3be88b1 initial import of the packaging package in the standard library Tarek Ziade <tarek@ziade.org> parents: diff changeset	269
1a31c3be88b1 initial import of the packaging package in the standard library Tarek Ziade <tarek@ziade.org> parents: diff changeset	270 # See http://docs.python.org/reference/datamodel#object.__hash__
1a31c3be88b1 initial import of the packaging package in the standard library Tarek Ziade <tarek@ziade.org> parents: diff changeset	271 __hash__ = object.__hash__
1a31c3be88b1 initial import of the packaging package in the standard library Tarek Ziade <tarek@ziade.org> parents: diff changeset	272
1a31c3be88b1 initial import of the packaging package in the standard library Tarek Ziade <tarek@ziade.org> parents: diff changeset	273
1a31c3be88b1 initial import of the packaging package in the standard library Tarek Ziade <tarek@ziade.org> parents: diff changeset	274 class EggInfoDistribution:
1a31c3be88b1 initial import of the packaging package in the standard library Tarek Ziade <tarek@ziade.org> parents: diff changeset	275 """Created with the path of the ``.egg-info`` directory or file provided
1a31c3be88b1 initial import of the packaging package in the standard library Tarek Ziade <tarek@ziade.org> parents: diff changeset	276 to the constructor. It reads the metadata contained in the file itself, or
1a31c3be88b1 initial import of the packaging package in the standard library Tarek Ziade <tarek@ziade.org> parents: diff changeset	277 if the given path happens to be a directory, the metadata is read from the
1a31c3be88b1 initial import of the packaging package in the standard library Tarek Ziade <tarek@ziade.org> parents: diff changeset	278 file ``PKG-INFO`` under that directory."""
1a31c3be88b1 initial import of the packaging package in the standard library Tarek Ziade <tarek@ziade.org> parents: diff changeset	279
1a31c3be88b1 initial import of the packaging package in the standard library Tarek Ziade <tarek@ziade.org> parents: diff changeset	280 name = ''
1a31c3be88b1 initial import of the packaging package in the standard library Tarek Ziade <tarek@ziade.org> parents: diff changeset	281 """The name of the distribution."""
1a31c3be88b1 initial import of the packaging package in the standard library Tarek Ziade <tarek@ziade.org> parents: diff changeset	282
1a31c3be88b1 initial import of the packaging package in the standard library Tarek Ziade <tarek@ziade.org> parents: diff changeset	283 version = ''
1a31c3be88b1 initial import of the packaging package in the standard library Tarek Ziade <tarek@ziade.org> parents: diff changeset	284 """The version of the distribution."""
1a31c3be88b1 initial import of the packaging package in the standard library Tarek Ziade <tarek@ziade.org> parents: diff changeset	285
1a31c3be88b1 initial import of the packaging package in the standard library Tarek Ziade <tarek@ziade.org> parents: diff changeset	286 metadata = None
1a31c3be88b1 initial import of the packaging package in the standard library Tarek Ziade <tarek@ziade.org> parents: diff changeset	287 """A :class:`packaging.metadata.Metadata` instance loaded with
1a31c3be88b1 initial import of the packaging package in the standard library Tarek Ziade <tarek@ziade.org> parents: diff changeset	288 the distribution's ``METADATA`` file."""
1a31c3be88b1 initial import of the packaging package in the standard library Tarek Ziade <tarek@ziade.org> parents: diff changeset	289
1a31c3be88b1 initial import of the packaging package in the standard library Tarek Ziade <tarek@ziade.org> parents: diff changeset	290 _REQUIREMENT = re.compile(
1a31c3be88b1 initial import of the packaging package in the standard library Tarek Ziade <tarek@ziade.org> parents: diff changeset	291 r'(?P<name>[-A-Za-z0-9_.]+)\s*'
1a31c3be88b1 initial import of the packaging package in the standard library Tarek Ziade <tarek@ziade.org> parents: diff changeset	292 r'(?P<first>(?:<\|<=\|!=\|==\|>=\|>)[-A-Za-z0-9_.]+)?\s*'
1a31c3be88b1 initial import of the packaging package in the standard library Tarek Ziade <tarek@ziade.org> parents: diff changeset	293 r'(?P<rest>(?:\s,\s(?:<\|<=\|!=\|==\|>=\|>)[-A-Za-z0-9_.]+))\s'
1a31c3be88b1 initial import of the packaging package in the standard library Tarek Ziade <tarek@ziade.org> parents: diff changeset	294 r'(?P<extras>\[.*\])?')
1a31c3be88b1 initial import of the packaging package in the standard library Tarek Ziade <tarek@ziade.org> parents: diff changeset	295
1a31c3be88b1 initial import of the packaging package in the standard library Tarek Ziade <tarek@ziade.org> parents: diff changeset	296 def __init__(self, path):
1a31c3be88b1 initial import of the packaging package in the standard library Tarek Ziade <tarek@ziade.org> parents: diff changeset	297 self.path = path
1a31c3be88b1 initial import of the packaging package in the standard library Tarek Ziade <tarek@ziade.org> parents: diff changeset	298 if _cache_enabled and path in _cache_path_egg:
1a31c3be88b1 initial import of the packaging package in the standard library Tarek Ziade <tarek@ziade.org> parents: diff changeset	299 self.metadata = _cache_path_egg[path].metadata
1a31c3be88b1 initial import of the packaging package in the standard library Tarek Ziade <tarek@ziade.org> parents: diff changeset	300 self.name = self.metadata['Name']
1a31c3be88b1 initial import of the packaging package in the standard library Tarek Ziade <tarek@ziade.org> parents: diff changeset	301 self.version = self.metadata['Version']
1a31c3be88b1 initial import of the packaging package in the standard library Tarek Ziade <tarek@ziade.org> parents: diff changeset	302 return
1a31c3be88b1 initial import of the packaging package in the standard library Tarek Ziade <tarek@ziade.org> parents: diff changeset	303
1a31c3be88b1 initial import of the packaging package in the standard library Tarek Ziade <tarek@ziade.org> parents: diff changeset	304 # reused from Distribute's pkg_resources
1a31c3be88b1 initial import of the packaging package in the standard library Tarek Ziade <tarek@ziade.org> parents: diff changeset	305 def yield_lines(strs):
1a31c3be88b1 initial import of the packaging package in the standard library Tarek Ziade <tarek@ziade.org> parents: diff changeset	306 """Yield non-empty/non-comment lines of a ``basestring``
1a31c3be88b1 initial import of the packaging package in the standard library Tarek Ziade <tarek@ziade.org> parents: diff changeset	307 or sequence"""
1a31c3be88b1 initial import of the packaging package in the standard library Tarek Ziade <tarek@ziade.org> parents: diff changeset	308 if isinstance(strs, str):
1a31c3be88b1 initial import of the packaging package in the standard library Tarek Ziade <tarek@ziade.org> parents: diff changeset	309 for s in strs.splitlines():
1a31c3be88b1 initial import of the packaging package in the standard library Tarek Ziade <tarek@ziade.org> parents: diff changeset	310 s = s.strip()
1a31c3be88b1 initial import of the packaging package in the standard library Tarek Ziade <tarek@ziade.org> parents: diff changeset	311 # skip blank lines/comments
1a31c3be88b1 initial import of the packaging package in the standard library Tarek Ziade <tarek@ziade.org> parents: diff changeset	312 if s and not s.startswith('#'):
1a31c3be88b1 initial import of the packaging package in the standard library Tarek Ziade <tarek@ziade.org> parents: diff changeset	313 yield s
1a31c3be88b1 initial import of the packaging package in the standard library Tarek Ziade <tarek@ziade.org> parents: diff changeset	314 else:
1a31c3be88b1 initial import of the packaging package in the standard library Tarek Ziade <tarek@ziade.org> parents: diff changeset	315 for ss in strs:
1a31c3be88b1 initial import of the packaging package in the standard library Tarek Ziade <tarek@ziade.org> parents: diff changeset	316 for s in yield_lines(ss):
1a31c3be88b1 initial import of the packaging package in the standard library Tarek Ziade <tarek@ziade.org> parents: diff changeset	317 yield s
1a31c3be88b1 initial import of the packaging package in the standard library Tarek Ziade <tarek@ziade.org> parents: diff changeset	318
1a31c3be88b1 initial import of the packaging package in the standard library Tarek Ziade <tarek@ziade.org> parents: diff changeset	319 requires = None
1a31c3be88b1 initial import of the packaging package in the standard library Tarek Ziade <tarek@ziade.org> parents: diff changeset	320
1a31c3be88b1 initial import of the packaging package in the standard library Tarek Ziade <tarek@ziade.org> parents: diff changeset	321 if path.endswith('.egg'):
1a31c3be88b1 initial import of the packaging package in the standard library Tarek Ziade <tarek@ziade.org> parents: diff changeset	322 if os.path.isdir(path):
1a31c3be88b1 initial import of the packaging package in the standard library Tarek Ziade <tarek@ziade.org> parents: diff changeset	323 meta_path = os.path.join(path, 'EGG-INFO', 'PKG-INFO')
1a31c3be88b1 initial import of the packaging package in the standard library Tarek Ziade <tarek@ziade.org> parents: diff changeset	324 self.metadata = Metadata(path=meta_path)
1a31c3be88b1 initial import of the packaging package in the standard library Tarek Ziade <tarek@ziade.org> parents: diff changeset	325 try:
1a31c3be88b1 initial import of the packaging package in the standard library Tarek Ziade <tarek@ziade.org> parents: diff changeset	326 req_path = os.path.join(path, 'EGG-INFO', 'requires.txt')
1a31c3be88b1 initial import of the packaging package in the standard library Tarek Ziade <tarek@ziade.org> parents: diff changeset	327 with open(req_path, 'r') as fp:
1a31c3be88b1 initial import of the packaging package in the standard library Tarek Ziade <tarek@ziade.org> parents: diff changeset	328 requires = fp.read()
1a31c3be88b1 initial import of the packaging package in the standard library Tarek Ziade <tarek@ziade.org> parents: diff changeset	329 except IOError:
1a31c3be88b1 initial import of the packaging package in the standard library Tarek Ziade <tarek@ziade.org> parents: diff changeset	330 requires = None
1a31c3be88b1 initial import of the packaging package in the standard library Tarek Ziade <tarek@ziade.org> parents: diff changeset	331 else:
1a31c3be88b1 initial import of the packaging package in the standard library Tarek Ziade <tarek@ziade.org> parents: diff changeset	332 # FIXME handle the case where zipfile is not available
1a31c3be88b1 initial import of the packaging package in the standard library Tarek Ziade <tarek@ziade.org> parents: diff changeset	333 zipf = zipimport.zipimporter(path)
1a31c3be88b1 initial import of the packaging package in the standard library Tarek Ziade <tarek@ziade.org> parents: diff changeset	334 fileobj = io.StringIO(
1a31c3be88b1 initial import of the packaging package in the standard library Tarek Ziade <tarek@ziade.org> parents: diff changeset	335 zipf.get_data('EGG-INFO/PKG-INFO').decode('utf8'))
1a31c3be88b1 initial import of the packaging package in the standard library Tarek Ziade <tarek@ziade.org> parents: diff changeset	336 self.metadata = Metadata(fileobj=fileobj)
1a31c3be88b1 initial import of the packaging package in the standard library Tarek Ziade <tarek@ziade.org> parents: diff changeset	337 try:
1a31c3be88b1 initial import of the packaging package in the standard library Tarek Ziade <tarek@ziade.org> parents: diff changeset	338 requires = zipf.get_data('EGG-INFO/requires.txt')
1a31c3be88b1 initial import of the packaging package in the standard library Tarek Ziade <tarek@ziade.org> parents: diff changeset	339 except IOError:
1a31c3be88b1 initial import of the packaging package in the standard library Tarek Ziade <tarek@ziade.org> parents: diff changeset	340 requires = None
1a31c3be88b1 initial import of the packaging package in the standard library Tarek Ziade <tarek@ziade.org> parents: diff changeset	341 self.name = self.metadata['Name']
1a31c3be88b1 initial import of the packaging package in the standard library Tarek Ziade <tarek@ziade.org> parents: diff changeset	342 self.version = self.metadata['Version']
1a31c3be88b1 initial import of the packaging package in the standard library Tarek Ziade <tarek@ziade.org> parents: diff changeset	343
1a31c3be88b1 initial import of the packaging package in the standard library Tarek Ziade <tarek@ziade.org> parents: diff changeset	344 elif path.endswith('.egg-info'):
1a31c3be88b1 initial import of the packaging package in the standard library Tarek Ziade <tarek@ziade.org> parents: diff changeset	345 if os.path.isdir(path):
1a31c3be88b1 initial import of the packaging package in the standard library Tarek Ziade <tarek@ziade.org> parents: diff changeset	346 path = os.path.join(path, 'PKG-INFO')
1a31c3be88b1 initial import of the packaging package in the standard library Tarek Ziade <tarek@ziade.org> parents: diff changeset	347 try:
1a31c3be88b1 initial import of the packaging package in the standard library Tarek Ziade <tarek@ziade.org> parents: diff changeset	348 with open(os.path.join(path, 'requires.txt'), 'r') as fp:
1a31c3be88b1 initial import of the packaging package in the standard library Tarek Ziade <tarek@ziade.org> parents: diff changeset	349 requires = fp.read()
1a31c3be88b1 initial import of the packaging package in the standard library Tarek Ziade <tarek@ziade.org> parents: diff changeset	350 except IOError:
1a31c3be88b1 initial import of the packaging package in the standard library Tarek Ziade <tarek@ziade.org> parents: diff changeset	351 requires = None
1a31c3be88b1 initial import of the packaging package in the standard library Tarek Ziade <tarek@ziade.org> parents: diff changeset	352 self.metadata = Metadata(path=path)
1a31c3be88b1 initial import of the packaging package in the standard library Tarek Ziade <tarek@ziade.org> parents: diff changeset	353 self.name = self.metadata['name']
1a31c3be88b1 initial import of the packaging package in the standard library Tarek Ziade <tarek@ziade.org> parents: diff changeset	354 self.version = self.metadata['Version']
1a31c3be88b1 initial import of the packaging package in the standard library Tarek Ziade <tarek@ziade.org> parents: diff changeset	355
1a31c3be88b1 initial import of the packaging package in the standard library Tarek Ziade <tarek@ziade.org> parents: diff changeset	356 else:
1a31c3be88b1 initial import of the packaging package in the standard library Tarek Ziade <tarek@ziade.org> parents: diff changeset	357 raise ValueError('path must end with .egg-info or .egg, got %r' %
1a31c3be88b1 initial import of the packaging package in the standard library Tarek Ziade <tarek@ziade.org> parents: diff changeset	358 path)
1a31c3be88b1 initial import of the packaging package in the standard library Tarek Ziade <tarek@ziade.org> parents: diff changeset	359
1a31c3be88b1 initial import of the packaging package in the standard library Tarek Ziade <tarek@ziade.org> parents: diff changeset	360 if requires is not None:
1a31c3be88b1 initial import of the packaging package in the standard library Tarek Ziade <tarek@ziade.org> parents: diff changeset	361 if self.metadata['Metadata-Version'] == '1.1':
1a31c3be88b1 initial import of the packaging package in the standard library Tarek Ziade <tarek@ziade.org> parents: diff changeset	362 # we can't have 1.1 metadata and Setuptools requires
1a31c3be88b1 initial import of the packaging package in the standard library Tarek Ziade <tarek@ziade.org> parents: diff changeset	363 for field in ('Obsoletes', 'Requires', 'Provides'):
1a31c3be88b1 initial import of the packaging package in the standard library Tarek Ziade <tarek@ziade.org> parents: diff changeset	364 del self.metadata[field]
1a31c3be88b1 initial import of the packaging package in the standard library Tarek Ziade <tarek@ziade.org> parents: diff changeset	365
1a31c3be88b1 initial import of the packaging package in the standard library Tarek Ziade <tarek@ziade.org> parents: diff changeset	366 reqs = []
1a31c3be88b1 initial import of the packaging package in the standard library Tarek Ziade <tarek@ziade.org> parents: diff changeset	367
1a31c3be88b1 initial import of the packaging package in the standard library Tarek Ziade <tarek@ziade.org> parents: diff changeset	368 if requires is not None:
1a31c3be88b1 initial import of the packaging package in the standard library Tarek Ziade <tarek@ziade.org> parents: diff changeset	369 for line in yield_lines(requires):
1a31c3be88b1 initial import of the packaging package in the standard library Tarek Ziade <tarek@ziade.org> parents: diff changeset	370 if line.startswith('['):
1a31c3be88b1 initial import of the packaging package in the standard library Tarek Ziade <tarek@ziade.org> parents: diff changeset	371 logger.warning(
1a31c3be88b1 initial import of the packaging package in the standard library Tarek Ziade <tarek@ziade.org> parents: diff changeset	372 'extensions in requires.txt are not supported '
1a31c3be88b1 initial import of the packaging package in the standard library Tarek Ziade <tarek@ziade.org> parents: diff changeset	373 '(used by %r %s)', self.name, self.version)
1a31c3be88b1 initial import of the packaging package in the standard library Tarek Ziade <tarek@ziade.org> parents: diff changeset	374 break
1a31c3be88b1 initial import of the packaging package in the standard library Tarek Ziade <tarek@ziade.org> parents: diff changeset	375 else:
1a31c3be88b1 initial import of the packaging package in the standard library Tarek Ziade <tarek@ziade.org> parents: diff changeset	376 match = self._REQUIREMENT.match(line.strip())
1a31c3be88b1 initial import of the packaging package in the standard library Tarek Ziade <tarek@ziade.org> parents: diff changeset	377 if not match:
1a31c3be88b1 initial import of the packaging package in the standard library Tarek Ziade <tarek@ziade.org> parents: diff changeset	378 # this happens when we encounter extras; since they
1a31c3be88b1 initial import of the packaging package in the standard library Tarek Ziade <tarek@ziade.org> parents: diff changeset	379 # are written at the end of the file we just exit
1a31c3be88b1 initial import of the packaging package in the standard library Tarek Ziade <tarek@ziade.org> parents: diff changeset	380 break
1a31c3be88b1 initial import of the packaging package in the standard library Tarek Ziade <tarek@ziade.org> parents: diff changeset	381 else:
1a31c3be88b1 initial import of the packaging package in the standard library Tarek Ziade <tarek@ziade.org> parents: diff changeset	382 if match.group('extras'):
1a31c3be88b1 initial import of the packaging package in the standard library Tarek Ziade <tarek@ziade.org> parents: diff changeset	383 msg = ('extra requirements are not supported '
1a31c3be88b1 initial import of the packaging package in the standard library Tarek Ziade <tarek@ziade.org> parents: diff changeset	384 '(used by %r %s)', self.name, self.version)
1a31c3be88b1 initial import of the packaging package in the standard library Tarek Ziade <tarek@ziade.org> parents: diff changeset	385 logger.warning(msg, self.name)
1a31c3be88b1 initial import of the packaging package in the standard library Tarek Ziade <tarek@ziade.org> parents: diff changeset	386 name = match.group('name')
1a31c3be88b1 initial import of the packaging package in the standard library Tarek Ziade <tarek@ziade.org> parents: diff changeset	387 version = None
1a31c3be88b1 initial import of the packaging package in the standard library Tarek Ziade <tarek@ziade.org> parents: diff changeset	388 if match.group('first'):
1a31c3be88b1 initial import of the packaging package in the standard library Tarek Ziade <tarek@ziade.org> parents: diff changeset	389 version = match.group('first')
1a31c3be88b1 initial import of the packaging package in the standard library Tarek Ziade <tarek@ziade.org> parents: diff changeset	390 if match.group('rest'):
1a31c3be88b1 initial import of the packaging package in the standard library Tarek Ziade <tarek@ziade.org> parents: diff changeset	391 version += match.group('rest')
1a31c3be88b1 initial import of the packaging package in the standard library Tarek Ziade <tarek@ziade.org> parents: diff changeset	392 version = version.replace(' ', '') # trim spaces
1a31c3be88b1 initial import of the packaging package in the standard library Tarek Ziade <tarek@ziade.org> parents: diff changeset	393 if version is None:
1a31c3be88b1 initial import of the packaging package in the standard library Tarek Ziade <tarek@ziade.org> parents: diff changeset	394 reqs.append(name)
1a31c3be88b1 initial import of the packaging package in the standard library Tarek Ziade <tarek@ziade.org> parents: diff changeset	395 else:
1a31c3be88b1 initial import of the packaging package in the standard library Tarek Ziade <tarek@ziade.org> parents: diff changeset	396 reqs.append('%s (%s)' % (name, version))
1a31c3be88b1 initial import of the packaging package in the standard library Tarek Ziade <tarek@ziade.org> parents: diff changeset	397
1a31c3be88b1 initial import of the packaging package in the standard library Tarek Ziade <tarek@ziade.org> parents: diff changeset	398 if len(reqs) > 0:
1a31c3be88b1 initial import of the packaging package in the standard library Tarek Ziade <tarek@ziade.org> parents: diff changeset	399 self.metadata['Requires-Dist'] += reqs
1a31c3be88b1 initial import of the packaging package in the standard library Tarek Ziade <tarek@ziade.org> parents: diff changeset	400
1a31c3be88b1 initial import of the packaging package in the standard library Tarek Ziade <tarek@ziade.org> parents: diff changeset	401 if _cache_enabled:
1a31c3be88b1 initial import of the packaging package in the standard library Tarek Ziade <tarek@ziade.org> parents: diff changeset	402 _cache_path_egg[self.path] = self
1a31c3be88b1 initial import of the packaging package in the standard library Tarek Ziade <tarek@ziade.org> parents: diff changeset	403
1a31c3be88b1 initial import of the packaging package in the standard library Tarek Ziade <tarek@ziade.org> parents: diff changeset	404 def __repr__(self):
1a31c3be88b1 initial import of the packaging package in the standard library Tarek Ziade <tarek@ziade.org> parents: diff changeset	405 return '<EggInfoDistribution %r %s at %r>' % (
1a31c3be88b1 initial import of the packaging package in the standard library Tarek Ziade <tarek@ziade.org> parents: diff changeset	406 self.name, self.version, self.path)
1a31c3be88b1 initial import of the packaging package in the standard library Tarek Ziade <tarek@ziade.org> parents: diff changeset	407
1a31c3be88b1 initial import of the packaging package in the standard library Tarek Ziade <tarek@ziade.org> parents: diff changeset	408 def list_installed_files(self, local=False):
1a31c3be88b1 initial import of the packaging package in the standard library Tarek Ziade <tarek@ziade.org> parents: diff changeset	409
1a31c3be88b1 initial import of the packaging package in the standard library Tarek Ziade <tarek@ziade.org> parents: diff changeset	410 def _md5(path):
1a31c3be88b1 initial import of the packaging package in the standard library Tarek Ziade <tarek@ziade.org> parents: diff changeset	411 with open(path, 'rb') as f:
1a31c3be88b1 initial import of the packaging package in the standard library Tarek Ziade <tarek@ziade.org> parents: diff changeset	412 content = f.read()
1a31c3be88b1 initial import of the packaging package in the standard library Tarek Ziade <tarek@ziade.org> parents: diff changeset	413 return md5(content).hexdigest()
1a31c3be88b1 initial import of the packaging package in the standard library Tarek Ziade <tarek@ziade.org> parents: diff changeset	414
1a31c3be88b1 initial import of the packaging package in the standard library Tarek Ziade <tarek@ziade.org> parents: diff changeset	415 def _size(path):
1a31c3be88b1 initial import of the packaging package in the standard library Tarek Ziade <tarek@ziade.org> parents: diff changeset	416 return os.stat(path).st_size
1a31c3be88b1 initial import of the packaging package in the standard library Tarek Ziade <tarek@ziade.org> parents: diff changeset	417
1a31c3be88b1 initial import of the packaging package in the standard library Tarek Ziade <tarek@ziade.org> parents: diff changeset	418 path = self.path
1a31c3be88b1 initial import of the packaging package in the standard library Tarek Ziade <tarek@ziade.org> parents: diff changeset	419 if local:
1a31c3be88b1 initial import of the packaging package in the standard library Tarek Ziade <tarek@ziade.org> parents: diff changeset	420 path = path.replace('/', os.sep)
1a31c3be88b1 initial import of the packaging package in the standard library Tarek Ziade <tarek@ziade.org> parents: diff changeset	421
1a31c3be88b1 initial import of the packaging package in the standard library Tarek Ziade <tarek@ziade.org> parents: diff changeset	422 # XXX What about scripts and data files ?
1a31c3be88b1 initial import of the packaging package in the standard library Tarek Ziade <tarek@ziade.org> parents: diff changeset	423 if os.path.isfile(path):
1a31c3be88b1 initial import of the packaging package in the standard library Tarek Ziade <tarek@ziade.org> parents: diff changeset	424 return [(path, _md5(path), _size(path))]
1a31c3be88b1 initial import of the packaging package in the standard library Tarek Ziade <tarek@ziade.org> parents: diff changeset	425 else:
1a31c3be88b1 initial import of the packaging package in the standard library Tarek Ziade <tarek@ziade.org> parents: diff changeset	426 files = []
1a31c3be88b1 initial import of the packaging package in the standard library Tarek Ziade <tarek@ziade.org> parents: diff changeset	427 for root, dir, files_ in os.walk(path):
1a31c3be88b1 initial import of the packaging package in the standard library Tarek Ziade <tarek@ziade.org> parents: diff changeset	428 for item in files_:
1a31c3be88b1 initial import of the packaging package in the standard library Tarek Ziade <tarek@ziade.org> parents: diff changeset	429 item = os.path.join(root, item)
1a31c3be88b1 initial import of the packaging package in the standard library Tarek Ziade <tarek@ziade.org> parents: diff changeset	430 files.append((item, _md5(item), _size(item)))
1a31c3be88b1 initial import of the packaging package in the standard library Tarek Ziade <tarek@ziade.org> parents: diff changeset	431 return files
1a31c3be88b1 initial import of the packaging package in the standard library Tarek Ziade <tarek@ziade.org> parents: diff changeset	432
1a31c3be88b1 initial import of the packaging package in the standard library Tarek Ziade <tarek@ziade.org> parents: diff changeset	433 return []
1a31c3be88b1 initial import of the packaging package in the standard library Tarek Ziade <tarek@ziade.org> parents: diff changeset	434
1a31c3be88b1 initial import of the packaging package in the standard library Tarek Ziade <tarek@ziade.org> parents: diff changeset	435 def uses(self, path):
1a31c3be88b1 initial import of the packaging package in the standard library Tarek Ziade <tarek@ziade.org> parents: diff changeset	436 return False
1a31c3be88b1 initial import of the packaging package in the standard library Tarek Ziade <tarek@ziade.org> parents: diff changeset	437
1a31c3be88b1 initial import of the packaging package in the standard library Tarek Ziade <tarek@ziade.org> parents: diff changeset	438 def __eq__(self, other):
1a31c3be88b1 initial import of the packaging package in the standard library Tarek Ziade <tarek@ziade.org> parents: diff changeset	439 return (isinstance(other, EggInfoDistribution) and
1a31c3be88b1 initial import of the packaging package in the standard library Tarek Ziade <tarek@ziade.org> parents: diff changeset	440 self.path == other.path)
1a31c3be88b1 initial import of the packaging package in the standard library Tarek Ziade <tarek@ziade.org> parents: diff changeset	441
1a31c3be88b1 initial import of the packaging package in the standard library Tarek Ziade <tarek@ziade.org> parents: diff changeset	442 # See http://docs.python.org/reference/datamodel#object.__hash__
1a31c3be88b1 initial import of the packaging package in the standard library Tarek Ziade <tarek@ziade.org> parents: diff changeset	443 __hash__ = object.__hash__
1a31c3be88b1 initial import of the packaging package in the standard library Tarek Ziade <tarek@ziade.org> parents: diff changeset	444
1a31c3be88b1 initial import of the packaging package in the standard library Tarek Ziade <tarek@ziade.org> parents: diff changeset	445
1a31c3be88b1 initial import of the packaging package in the standard library Tarek Ziade <tarek@ziade.org> parents: diff changeset	446 def distinfo_dirname(name, version):
1a31c3be88b1 initial import of the packaging package in the standard library Tarek Ziade <tarek@ziade.org> parents: diff changeset	447 """
1a31c3be88b1 initial import of the packaging package in the standard library Tarek Ziade <tarek@ziade.org> parents: diff changeset	448 The name and version parameters are converted into their
1a31c3be88b1 initial import of the packaging package in the standard library Tarek Ziade <tarek@ziade.org> parents: diff changeset	449 filename-escaped form, i.e. any ``'-'`` characters are replaced
1a31c3be88b1 initial import of the packaging package in the standard library Tarek Ziade <tarek@ziade.org> parents: diff changeset	450 with ``'_'`` other than the one in ``'dist-info'`` and the one
1a31c3be88b1 initial import of the packaging package in the standard library Tarek Ziade <tarek@ziade.org> parents: diff changeset	451 separating the name from the version number.
1a31c3be88b1 initial import of the packaging package in the standard library Tarek Ziade <tarek@ziade.org> parents: diff changeset	452
1a31c3be88b1 initial import of the packaging package in the standard library Tarek Ziade <tarek@ziade.org> parents: diff changeset	453 :parameter name: is converted to a standard distribution name by replacing
1a31c3be88b1 initial import of the packaging package in the standard library Tarek Ziade <tarek@ziade.org> parents: diff changeset	454 any runs of non- alphanumeric characters with a single
1a31c3be88b1 initial import of the packaging package in the standard library Tarek Ziade <tarek@ziade.org> parents: diff changeset	455 ``'-'``.
1a31c3be88b1 initial import of the packaging package in the standard library Tarek Ziade <tarek@ziade.org> parents: diff changeset	456 :type name: string
1a31c3be88b1 initial import of the packaging package in the standard library Tarek Ziade <tarek@ziade.org> parents: diff changeset	457 :parameter version: is converted to a standard version string. Spaces
1a31c3be88b1 initial import of the packaging package in the standard library Tarek Ziade <tarek@ziade.org> parents: diff changeset	458 become dots, and all other non-alphanumeric characters
1a31c3be88b1 initial import of the packaging package in the standard library Tarek Ziade <tarek@ziade.org> parents: diff changeset	459 (except dots) become dashes, with runs of multiple
1a31c3be88b1 initial import of the packaging package in the standard library Tarek Ziade <tarek@ziade.org> parents: diff changeset	460 dashes condensed to a single dash.
1a31c3be88b1 initial import of the packaging package in the standard library Tarek Ziade <tarek@ziade.org> parents: diff changeset	461 :type version: string
1a31c3be88b1 initial import of the packaging package in the standard library Tarek Ziade <tarek@ziade.org> parents: diff changeset	462 :returns: directory name
1a31c3be88b1 initial import of the packaging package in the standard library Tarek Ziade <tarek@ziade.org> parents: diff changeset	463 :rtype: string"""
1a31c3be88b1 initial import of the packaging package in the standard library Tarek Ziade <tarek@ziade.org> parents: diff changeset	464 file_extension = '.dist-info'
1a31c3be88b1 initial import of the packaging package in the standard library Tarek Ziade <tarek@ziade.org> parents: diff changeset	465 name = name.replace('-', '_')
1a31c3be88b1 initial import of the packaging package in the standard library Tarek Ziade <tarek@ziade.org> parents: diff changeset	466 normalized_version = suggest_normalized_version(version)
1a31c3be88b1 initial import of the packaging package in the standard library Tarek Ziade <tarek@ziade.org> parents: diff changeset	467 # Because this is a lookup procedure, something will be returned even if
1a31c3be88b1 initial import of the packaging package in the standard library Tarek Ziade <tarek@ziade.org> parents: diff changeset	468 # it is a version that cannot be normalized
1a31c3be88b1 initial import of the packaging package in the standard library Tarek Ziade <tarek@ziade.org> parents: diff changeset	469 if normalized_version is None:
1a31c3be88b1 initial import of the packaging package in the standard library Tarek Ziade <tarek@ziade.org> parents: diff changeset	470 # Unable to achieve normality?
1a31c3be88b1 initial import of the packaging package in the standard library Tarek Ziade <tarek@ziade.org> parents: diff changeset	471 normalized_version = version
1a31c3be88b1 initial import of the packaging package in the standard library Tarek Ziade <tarek@ziade.org> parents: diff changeset	472 return '-'.join([name, normalized_version]) + file_extension
1a31c3be88b1 initial import of the packaging package in the standard library Tarek Ziade <tarek@ziade.org> parents: diff changeset	473
1a31c3be88b1 initial import of the packaging package in the standard library Tarek Ziade <tarek@ziade.org> parents: diff changeset	474
1a31c3be88b1 initial import of the packaging package in the standard library Tarek Ziade <tarek@ziade.org> parents: diff changeset	475 def get_distributions(use_egg_info=False, paths=sys.path):
1a31c3be88b1 initial import of the packaging package in the standard library Tarek Ziade <tarek@ziade.org> parents: diff changeset	476 """
1a31c3be88b1 initial import of the packaging package in the standard library Tarek Ziade <tarek@ziade.org> parents: diff changeset	477 Provides an iterator that looks for ``.dist-info`` directories in
1a31c3be88b1 initial import of the packaging package in the standard library Tarek Ziade <tarek@ziade.org> parents: diff changeset	478 ``sys.path`` and returns :class:`Distribution` instances for each one of
1a31c3be88b1 initial import of the packaging package in the standard library Tarek Ziade <tarek@ziade.org> parents: diff changeset	479 them. If the parameters use_egg_info is ``True``, then the ``.egg-info``
1a31c3be88b1 initial import of the packaging package in the standard library Tarek Ziade <tarek@ziade.org> parents: diff changeset	480 files and directores are iterated as well.
1a31c3be88b1 initial import of the packaging package in the standard library Tarek Ziade <tarek@ziade.org> parents: diff changeset	481
1a31c3be88b1 initial import of the packaging package in the standard library Tarek Ziade <tarek@ziade.org> parents: diff changeset	482 :rtype: iterator of :class:`Distribution` and :class:`EggInfoDistribution`
1a31c3be88b1 initial import of the packaging package in the standard library Tarek Ziade <tarek@ziade.org> parents: diff changeset	483 instances
1a31c3be88b1 initial import of the packaging package in the standard library Tarek Ziade <tarek@ziade.org> parents: diff changeset	484 """
1a31c3be88b1 initial import of the packaging package in the standard library Tarek Ziade <tarek@ziade.org> parents: diff changeset	485 if not _cache_enabled:
1a31c3be88b1 initial import of the packaging package in the standard library Tarek Ziade <tarek@ziade.org> parents: diff changeset	486 for dist in _yield_distributions(True, use_egg_info, paths):
1a31c3be88b1 initial import of the packaging package in the standard library Tarek Ziade <tarek@ziade.org> parents: diff changeset	487 yield dist
1a31c3be88b1 initial import of the packaging package in the standard library Tarek Ziade <tarek@ziade.org> parents: diff changeset	488 else:
1a31c3be88b1 initial import of the packaging package in the standard library Tarek Ziade <tarek@ziade.org> parents: diff changeset	489 _generate_cache(use_egg_info, paths)
1a31c3be88b1 initial import of the packaging package in the standard library Tarek Ziade <tarek@ziade.org> parents: diff changeset	490
1a31c3be88b1 initial import of the packaging package in the standard library Tarek Ziade <tarek@ziade.org> parents: diff changeset	491 for dist in _cache_path.values():
1a31c3be88b1 initial import of the packaging package in the standard library Tarek Ziade <tarek@ziade.org> parents: diff changeset	492 yield dist
1a31c3be88b1 initial import of the packaging package in the standard library Tarek Ziade <tarek@ziade.org> parents: diff changeset	493
1a31c3be88b1 initial import of the packaging package in the standard library Tarek Ziade <tarek@ziade.org> parents: diff changeset	494 if use_egg_info:
1a31c3be88b1 initial import of the packaging package in the standard library Tarek Ziade <tarek@ziade.org> parents: diff changeset	495 for dist in _cache_path_egg.values():
1a31c3be88b1 initial import of the packaging package in the standard library Tarek Ziade <tarek@ziade.org> parents: diff changeset	496 yield dist
1a31c3be88b1 initial import of the packaging package in the standard library Tarek Ziade <tarek@ziade.org> parents: diff changeset	497
1a31c3be88b1 initial import of the packaging package in the standard library Tarek Ziade <tarek@ziade.org> parents: diff changeset	498
1a31c3be88b1 initial import of the packaging package in the standard library Tarek Ziade <tarek@ziade.org> parents: diff changeset	499 def get_distribution(name, use_egg_info=False, paths=None):
1a31c3be88b1 initial import of the packaging package in the standard library Tarek Ziade <tarek@ziade.org> parents: diff changeset	500 """
1a31c3be88b1 initial import of the packaging package in the standard library Tarek Ziade <tarek@ziade.org> parents: diff changeset	501 Scans all elements in ``sys.path`` and looks for all directories
1a31c3be88b1 initial import of the packaging package in the standard library Tarek Ziade <tarek@ziade.org> parents: diff changeset	502 ending with ``.dist-info``. Returns a :class:`Distribution`
1a31c3be88b1 initial import of the packaging package in the standard library Tarek Ziade <tarek@ziade.org> parents: diff changeset	503 corresponding to the ``.dist-info`` directory that contains the
1a31c3be88b1 initial import of the packaging package in the standard library Tarek Ziade <tarek@ziade.org> parents: diff changeset	504 ``METADATA`` that matches name for the name metadata field.
1a31c3be88b1 initial import of the packaging package in the standard library Tarek Ziade <tarek@ziade.org> parents: diff changeset	505 If no distribution exists with the given name and the parameter
1a31c3be88b1 initial import of the packaging package in the standard library Tarek Ziade <tarek@ziade.org> parents: diff changeset	506 use_egg_info is set to ``True``, then all files and directories ending
1a31c3be88b1 initial import of the packaging package in the standard library Tarek Ziade <tarek@ziade.org> parents: diff changeset	507 with ``.egg-info`` are scanned. A :class:`EggInfoDistribution` instance is
1a31c3be88b1 initial import of the packaging package in the standard library Tarek Ziade <tarek@ziade.org> parents: diff changeset	508 returned if one is found that has metadata that matches name for the
1a31c3be88b1 initial import of the packaging package in the standard library Tarek Ziade <tarek@ziade.org> parents: diff changeset	509 name metadata field.
1a31c3be88b1 initial import of the packaging package in the standard library Tarek Ziade <tarek@ziade.org> parents: diff changeset	510
1a31c3be88b1 initial import of the packaging package in the standard library Tarek Ziade <tarek@ziade.org> parents: diff changeset	511 This function only returns the first result found, as no more than one
1a31c3be88b1 initial import of the packaging package in the standard library Tarek Ziade <tarek@ziade.org> parents: diff changeset	512 value is expected. If the directory is not found, ``None`` is returned.
1a31c3be88b1 initial import of the packaging package in the standard library Tarek Ziade <tarek@ziade.org> parents: diff changeset	513
1a31c3be88b1 initial import of the packaging package in the standard library Tarek Ziade <tarek@ziade.org> parents: diff changeset	514 :rtype: :class:`Distribution` or :class:`EggInfoDistribution` or None
1a31c3be88b1 initial import of the packaging package in the standard library Tarek Ziade <tarek@ziade.org> parents: diff changeset	515 """
1a31c3be88b1 initial import of the packaging package in the standard library Tarek Ziade <tarek@ziade.org> parents: diff changeset	516 if paths == None:
1a31c3be88b1 initial import of the packaging package in the standard library Tarek Ziade <tarek@ziade.org> parents: diff changeset	517 paths = sys.path
1a31c3be88b1 initial import of the packaging package in the standard library Tarek Ziade <tarek@ziade.org> parents: diff changeset	518
1a31c3be88b1 initial import of the packaging package in the standard library Tarek Ziade <tarek@ziade.org> parents: diff changeset	519 if not _cache_enabled:
1a31c3be88b1 initial import of the packaging package in the standard library Tarek Ziade <tarek@ziade.org> parents: diff changeset	520 for dist in _yield_distributions(True, use_egg_info, paths):
1a31c3be88b1 initial import of the packaging package in the standard library Tarek Ziade <tarek@ziade.org> parents: diff changeset	521 if dist.name == name:
1a31c3be88b1 initial import of the packaging package in the standard library Tarek Ziade <tarek@ziade.org> parents: diff changeset	522 return dist
1a31c3be88b1 initial import of the packaging package in the standard library Tarek Ziade <tarek@ziade.org> parents: diff changeset	523 else:
1a31c3be88b1 initial import of the packaging package in the standard library Tarek Ziade <tarek@ziade.org> parents: diff changeset	524 _generate_cache(use_egg_info, paths)
1a31c3be88b1 initial import of the packaging package in the standard library Tarek Ziade <tarek@ziade.org> parents: diff changeset	525
1a31c3be88b1 initial import of the packaging package in the standard library Tarek Ziade <tarek@ziade.org> parents: diff changeset	526 if name in _cache_name:
1a31c3be88b1 initial import of the packaging package in the standard library Tarek Ziade <tarek@ziade.org> parents: diff changeset	527 return _cache_name[name][0]
1a31c3be88b1 initial import of the packaging package in the standard library Tarek Ziade <tarek@ziade.org> parents: diff changeset	528 elif use_egg_info and name in _cache_name_egg:
1a31c3be88b1 initial import of the packaging package in the standard library Tarek Ziade <tarek@ziade.org> parents: diff changeset	529 return _cache_name_egg[name][0]
1a31c3be88b1 initial import of the packaging package in the standard library Tarek Ziade <tarek@ziade.org> parents: diff changeset	530 else:
1a31c3be88b1 initial import of the packaging package in the standard library Tarek Ziade <tarek@ziade.org> parents: diff changeset	531 return None
1a31c3be88b1 initial import of the packaging package in the standard library Tarek Ziade <tarek@ziade.org> parents: diff changeset	532
1a31c3be88b1 initial import of the packaging package in the standard library Tarek Ziade <tarek@ziade.org> parents: diff changeset	533
1a31c3be88b1 initial import of the packaging package in the standard library Tarek Ziade <tarek@ziade.org> parents: diff changeset	534 def obsoletes_distribution(name, version=None, use_egg_info=False):
1a31c3be88b1 initial import of the packaging package in the standard library Tarek Ziade <tarek@ziade.org> parents: diff changeset	535 """
1a31c3be88b1 initial import of the packaging package in the standard library Tarek Ziade <tarek@ziade.org> parents: diff changeset	536 Iterates over all distributions to find which distributions obsolete
1a31c3be88b1 initial import of the packaging package in the standard library Tarek Ziade <tarek@ziade.org> parents: diff changeset	537 name.
1a31c3be88b1 initial import of the packaging package in the standard library Tarek Ziade <tarek@ziade.org> parents: diff changeset	538
1a31c3be88b1 initial import of the packaging package in the standard library Tarek Ziade <tarek@ziade.org> parents: diff changeset	539 If a version is provided, it will be used to filter the results.
1a31c3be88b1 initial import of the packaging package in the standard library Tarek Ziade <tarek@ziade.org> parents: diff changeset	540 If the argument use_egg_info is set to ``True``, then ``.egg-info``
1a31c3be88b1 initial import of the packaging package in the standard library Tarek Ziade <tarek@ziade.org> parents: diff changeset	541 distributions will be considered as well.
1a31c3be88b1 initial import of the packaging package in the standard library Tarek Ziade <tarek@ziade.org> parents: diff changeset	542
1a31c3be88b1 initial import of the packaging package in the standard library Tarek Ziade <tarek@ziade.org> parents: diff changeset	543 :type name: string
1a31c3be88b1 initial import of the packaging package in the standard library Tarek Ziade <tarek@ziade.org> parents: diff changeset	544 :type version: string
1a31c3be88b1 initial import of the packaging package in the standard library Tarek Ziade <tarek@ziade.org> parents: diff changeset	545 :parameter name:
1a31c3be88b1 initial import of the packaging package in the standard library Tarek Ziade <tarek@ziade.org> parents: diff changeset	546 """
1a31c3be88b1 initial import of the packaging package in the standard library Tarek Ziade <tarek@ziade.org> parents: diff changeset	547 for dist in get_distributions(use_egg_info):
1a31c3be88b1 initial import of the packaging package in the standard library Tarek Ziade <tarek@ziade.org> parents: diff changeset	548 obsoleted = (dist.metadata['Obsoletes-Dist'] +
1a31c3be88b1 initial import of the packaging package in the standard library Tarek Ziade <tarek@ziade.org> parents: diff changeset	549 dist.metadata['Obsoletes'])
1a31c3be88b1 initial import of the packaging package in the standard library Tarek Ziade <tarek@ziade.org> parents: diff changeset	550 for obs in obsoleted:
1a31c3be88b1 initial import of the packaging package in the standard library Tarek Ziade <tarek@ziade.org> parents: diff changeset	551 o_components = obs.split(' ', 1)
1a31c3be88b1 initial import of the packaging package in the standard library Tarek Ziade <tarek@ziade.org> parents: diff changeset	552 if len(o_components) == 1 or version is None:
1a31c3be88b1 initial import of the packaging package in the standard library Tarek Ziade <tarek@ziade.org> parents: diff changeset	553 if name == o_components[0]:
1a31c3be88b1 initial import of the packaging package in the standard library Tarek Ziade <tarek@ziade.org> parents: diff changeset	554 yield dist
1a31c3be88b1 initial import of the packaging package in the standard library Tarek Ziade <tarek@ziade.org> parents: diff changeset	555 break
1a31c3be88b1 initial import of the packaging package in the standard library Tarek Ziade <tarek@ziade.org> parents: diff changeset	556 else:
1a31c3be88b1 initial import of the packaging package in the standard library Tarek Ziade <tarek@ziade.org> parents: diff changeset	557 try:
1a31c3be88b1 initial import of the packaging package in the standard library Tarek Ziade <tarek@ziade.org> parents: diff changeset	558 predicate = VersionPredicate(obs)
1a31c3be88b1 initial import of the packaging package in the standard library Tarek Ziade <tarek@ziade.org> parents: diff changeset	559 except ValueError:
1a31c3be88b1 initial import of the packaging package in the standard library Tarek Ziade <tarek@ziade.org> parents: diff changeset	560 raise PackagingError(
1a31c3be88b1 initial import of the packaging package in the standard library Tarek Ziade <tarek@ziade.org> parents: diff changeset	561 'distribution %r has ill-formed obsoletes field: '
1a31c3be88b1 initial import of the packaging package in the standard library Tarek Ziade <tarek@ziade.org> parents: diff changeset	562 '%r' % (dist.name, obs))
1a31c3be88b1 initial import of the packaging package in the standard library Tarek Ziade <tarek@ziade.org> parents: diff changeset	563 if name == o_components[0] and predicate.match(version):
1a31c3be88b1 initial import of the packaging package in the standard library Tarek Ziade <tarek@ziade.org> parents: diff changeset	564 yield dist
1a31c3be88b1 initial import of the packaging package in the standard library Tarek Ziade <tarek@ziade.org> parents: diff changeset	565 break
1a31c3be88b1 initial import of the packaging package in the standard library Tarek Ziade <tarek@ziade.org> parents: diff changeset	566
1a31c3be88b1 initial import of the packaging package in the standard library Tarek Ziade <tarek@ziade.org> parents: diff changeset	567
1a31c3be88b1 initial import of the packaging package in the standard library Tarek Ziade <tarek@ziade.org> parents: diff changeset	568 def provides_distribution(name, version=None, use_egg_info=False):
1a31c3be88b1 initial import of the packaging package in the standard library Tarek Ziade <tarek@ziade.org> parents: diff changeset	569 """
1a31c3be88b1 initial import of the packaging package in the standard library Tarek Ziade <tarek@ziade.org> parents: diff changeset	570 Iterates over all distributions to find which distributions provide name.
1a31c3be88b1 initial import of the packaging package in the standard library Tarek Ziade <tarek@ziade.org> parents: diff changeset	571 If a version is provided, it will be used to filter the results. Scans
1a31c3be88b1 initial import of the packaging package in the standard library Tarek Ziade <tarek@ziade.org> parents: diff changeset	572 all elements in ``sys.path`` and looks for all directories ending with
1a31c3be88b1 initial import of the packaging package in the standard library Tarek Ziade <tarek@ziade.org> parents: diff changeset	573 ``.dist-info``. Returns a :class:`Distribution` corresponding to the
1a31c3be88b1 initial import of the packaging package in the standard library Tarek Ziade <tarek@ziade.org> parents: diff changeset	574 ``.dist-info`` directory that contains a ``METADATA`` that matches name
1a31c3be88b1 initial import of the packaging package in the standard library Tarek Ziade <tarek@ziade.org> parents: diff changeset	575 for the name metadata. If the argument use_egg_info is set to ``True``,
1a31c3be88b1 initial import of the packaging package in the standard library Tarek Ziade <tarek@ziade.org> parents: diff changeset	576 then all files and directories ending with ``.egg-info`` are considered
1a31c3be88b1 initial import of the packaging package in the standard library Tarek Ziade <tarek@ziade.org> parents: diff changeset	577 as well and returns an :class:`EggInfoDistribution` instance.
1a31c3be88b1 initial import of the packaging package in the standard library Tarek Ziade <tarek@ziade.org> parents: diff changeset	578
1a31c3be88b1 initial import of the packaging package in the standard library Tarek Ziade <tarek@ziade.org> parents: diff changeset	579 This function only returns the first result found, since no more than
1a31c3be88b1 initial import of the packaging package in the standard library Tarek Ziade <tarek@ziade.org> parents: diff changeset	580 one values are expected. If the directory is not found, returns ``None``.
1a31c3be88b1 initial import of the packaging package in the standard library Tarek Ziade <tarek@ziade.org> parents: diff changeset	581
1a31c3be88b1 initial import of the packaging package in the standard library Tarek Ziade <tarek@ziade.org> parents: diff changeset	582 :parameter version: a version specifier that indicates the version
1a31c3be88b1 initial import of the packaging package in the standard library Tarek Ziade <tarek@ziade.org> parents: diff changeset	583 required, conforming to the format in ``PEP-345``
1a31c3be88b1 initial import of the packaging package in the standard library Tarek Ziade <tarek@ziade.org> parents: diff changeset	584
1a31c3be88b1 initial import of the packaging package in the standard library Tarek Ziade <tarek@ziade.org> parents: diff changeset	585 :type name: string
1a31c3be88b1 initial import of the packaging package in the standard library Tarek Ziade <tarek@ziade.org> parents: diff changeset	586 :type version: string
1a31c3be88b1 initial import of the packaging package in the standard library Tarek Ziade <tarek@ziade.org> parents: diff changeset	587 """
1a31c3be88b1 initial import of the packaging package in the standard library Tarek Ziade <tarek@ziade.org> parents: diff changeset	588 predicate = None
1a31c3be88b1 initial import of the packaging package in the standard library Tarek Ziade <tarek@ziade.org> parents: diff changeset	589 if not version is None:
1a31c3be88b1 initial import of the packaging package in the standard library Tarek Ziade <tarek@ziade.org> parents: diff changeset	590 try:
1a31c3be88b1 initial import of the packaging package in the standard library Tarek Ziade <tarek@ziade.org> parents: diff changeset	591 predicate = VersionPredicate(name + ' (' + version + ')')
1a31c3be88b1 initial import of the packaging package in the standard library Tarek Ziade <tarek@ziade.org> parents: diff changeset	592 except ValueError:
1a31c3be88b1 initial import of the packaging package in the standard library Tarek Ziade <tarek@ziade.org> parents: diff changeset	593 raise PackagingError('invalid name or version: %r, %r' %
1a31c3be88b1 initial import of the packaging package in the standard library Tarek Ziade <tarek@ziade.org> parents: diff changeset	594 (name, version))
1a31c3be88b1 initial import of the packaging package in the standard library Tarek Ziade <tarek@ziade.org> parents: diff changeset	595
1a31c3be88b1 initial import of the packaging package in the standard library Tarek Ziade <tarek@ziade.org> parents: diff changeset	596 for dist in get_distributions(use_egg_info):
1a31c3be88b1 initial import of the packaging package in the standard library Tarek Ziade <tarek@ziade.org> parents: diff changeset	597 provided = dist.metadata['Provides-Dist'] + dist.metadata['Provides']
1a31c3be88b1 initial import of the packaging package in the standard library Tarek Ziade <tarek@ziade.org> parents: diff changeset	598
1a31c3be88b1 initial import of the packaging package in the standard library Tarek Ziade <tarek@ziade.org> parents: diff changeset	599 for p in provided:
1a31c3be88b1 initial import of the packaging package in the standard library Tarek Ziade <tarek@ziade.org> parents: diff changeset	600 p_components = p.rsplit(' ', 1)
1a31c3be88b1 initial import of the packaging package in the standard library Tarek Ziade <tarek@ziade.org> parents: diff changeset	601 if len(p_components) == 1 or predicate is None:
1a31c3be88b1 initial import of the packaging package in the standard library Tarek Ziade <tarek@ziade.org> parents: diff changeset	602 if name == p_components[0]:
1a31c3be88b1 initial import of the packaging package in the standard library Tarek Ziade <tarek@ziade.org> parents: diff changeset	603 yield dist
1a31c3be88b1 initial import of the packaging package in the standard library Tarek Ziade <tarek@ziade.org> parents: diff changeset	604 break
1a31c3be88b1 initial import of the packaging package in the standard library Tarek Ziade <tarek@ziade.org> parents: diff changeset	605 else:
1a31c3be88b1 initial import of the packaging package in the standard library Tarek Ziade <tarek@ziade.org> parents: diff changeset	606 p_name, p_ver = p_components
1a31c3be88b1 initial import of the packaging package in the standard library Tarek Ziade <tarek@ziade.org> parents: diff changeset	607 if len(p_ver) < 2 or p_ver[0] != '(' or p_ver[-1] != ')':
1a31c3be88b1 initial import of the packaging package in the standard library Tarek Ziade <tarek@ziade.org> parents: diff changeset	608 raise PackagingError(
1a31c3be88b1 initial import of the packaging package in the standard library Tarek Ziade <tarek@ziade.org> parents: diff changeset	609 'distribution %r has invalid Provides field: %r' %
1a31c3be88b1 initial import of the packaging package in the standard library Tarek Ziade <tarek@ziade.org> parents: diff changeset	610 (dist.name, p))
1a31c3be88b1 initial import of the packaging package in the standard library Tarek Ziade <tarek@ziade.org> parents: diff changeset	611 p_ver = p_ver[1:-1] # trim off the parenthesis
1a31c3be88b1 initial import of the packaging package in the standard library Tarek Ziade <tarek@ziade.org> parents: diff changeset	612 if p_name == name and predicate.match(p_ver):
1a31c3be88b1 initial import of the packaging package in the standard library Tarek Ziade <tarek@ziade.org> parents: diff changeset	613 yield dist
1a31c3be88b1 initial import of the packaging package in the standard library Tarek Ziade <tarek@ziade.org> parents: diff changeset	614 break
1a31c3be88b1 initial import of the packaging package in the standard library Tarek Ziade <tarek@ziade.org> parents: diff changeset	615
1a31c3be88b1 initial import of the packaging package in the standard library Tarek Ziade <tarek@ziade.org> parents: diff changeset	616
1a31c3be88b1 initial import of the packaging package in the standard library Tarek Ziade <tarek@ziade.org> parents: diff changeset	617 def get_file_users(path):
1a31c3be88b1 initial import of the packaging package in the standard library Tarek Ziade <tarek@ziade.org> parents: diff changeset	618 """
1a31c3be88b1 initial import of the packaging package in the standard library Tarek Ziade <tarek@ziade.org> parents: diff changeset	619 Iterates over all distributions to find out which distributions use
1a31c3be88b1 initial import of the packaging package in the standard library Tarek Ziade <tarek@ziade.org> parents: diff changeset	620 path.
1a31c3be88b1 initial import of the packaging package in the standard library Tarek Ziade <tarek@ziade.org> parents: diff changeset	621
1a31c3be88b1 initial import of the packaging package in the standard library Tarek Ziade <tarek@ziade.org> parents: diff changeset	622 :parameter path: can be a local absolute path or a relative
1a31c3be88b1 initial import of the packaging package in the standard library Tarek Ziade <tarek@ziade.org> parents: diff changeset	623 ``'/'``-separated path.
1a31c3be88b1 initial import of the packaging package in the standard library Tarek Ziade <tarek@ziade.org> parents: diff changeset	624 :type path: string
1a31c3be88b1 initial import of the packaging package in the standard library Tarek Ziade <tarek@ziade.org> parents: diff changeset	625 :rtype: iterator of :class:`Distribution` instances
1a31c3be88b1 initial import of the packaging package in the standard library Tarek Ziade <tarek@ziade.org> parents: diff changeset	626 """
1a31c3be88b1 initial import of the packaging package in the standard library Tarek Ziade <tarek@ziade.org> parents: diff changeset	627 for dist in get_distributions():
1a31c3be88b1 initial import of the packaging package in the standard library Tarek Ziade <tarek@ziade.org> parents: diff changeset	628 if dist.uses(path):
1a31c3be88b1 initial import of the packaging package in the standard library Tarek Ziade <tarek@ziade.org> parents: diff changeset	629 yield dist
70516 035ffa0af9f9 a resource module for 2 functions is overkill. database is the right place for those Tarek Ziade <tarek@ziade.org> parents: 70259 diff changeset	630
035ffa0af9f9 a resource module for 2 functions is overkill. database is the right place for those Tarek Ziade <tarek@ziade.org> parents: 70259 diff changeset	631
035ffa0af9f9 a resource module for 2 functions is overkill. database is the right place for those Tarek Ziade <tarek@ziade.org> parents: 70259 diff changeset	632 def get_file_path(distribution_name, relative_path):
035ffa0af9f9 a resource module for 2 functions is overkill. database is the right place for those Tarek Ziade <tarek@ziade.org> parents: 70259 diff changeset	633 """Return the path to a resource file."""
035ffa0af9f9 a resource module for 2 functions is overkill. database is the right place for those Tarek Ziade <tarek@ziade.org> parents: 70259 diff changeset	634 dist = get_distribution(distribution_name)
035ffa0af9f9 a resource module for 2 functions is overkill. database is the right place for those Tarek Ziade <tarek@ziade.org> parents: 70259 diff changeset	635 if dist != None:
035ffa0af9f9 a resource module for 2 functions is overkill. database is the right place for those Tarek Ziade <tarek@ziade.org> parents: 70259 diff changeset	636 return dist.get_resource_path(relative_path)
035ffa0af9f9 a resource module for 2 functions is overkill. database is the right place for those Tarek Ziade <tarek@ziade.org> parents: 70259 diff changeset	637 raise LookupError('no distribution named %r found' % distribution_name)
035ffa0af9f9 a resource module for 2 functions is overkill. database is the right place for those Tarek Ziade <tarek@ziade.org> parents: 70259 diff changeset	638
035ffa0af9f9 a resource module for 2 functions is overkill. database is the right place for those Tarek Ziade <tarek@ziade.org> parents: 70259 diff changeset	639
035ffa0af9f9 a resource module for 2 functions is overkill. database is the right place for those Tarek Ziade <tarek@ziade.org> parents: 70259 diff changeset	640 def get_file(distribution_name, relative_path, args, *kwargs):
035ffa0af9f9 a resource module for 2 functions is overkill. database is the right place for those Tarek Ziade <tarek@ziade.org> parents: 70259 diff changeset	641 """Open and return a resource file."""
035ffa0af9f9 a resource module for 2 functions is overkill. database is the right place for those Tarek Ziade <tarek@ziade.org> parents: 70259 diff changeset	642 return open(get_file_path(distribution_name, relative_path),
035ffa0af9f9 a resource module for 2 functions is overkill. database is the right place for those Tarek Ziade <tarek@ziade.org> parents: 70259 diff changeset	643 args, *kwargs)

Mercurial > cpython-lru_cache-weakref

annotate Lib/packaging/database.py @ 70817:dd775b1561ba