Mailman 3 May 2005 - Python-checkins

python/nondist/sandbox/setuptools pkg_resources.py, 1.16, 1.17
by pje＠users.sourceforge.net May 24, 2005

May 24, 2005

Update of /cvsroot/python/python/nondist/sandbox/setuptools In directory sc8-pr-cvs1.sourceforge.net:/tmp/cvs-serv11404 Modified Files: pkg_resources.py Log Message: Implement a draft version of 'find_distributions()' with hardcoded support for packed and unpacked .egg files and .egg-info dirs. This will need to be refactored later to support registering adapters for arbitrary PEP 302 importers, so that it can deal with non-filesystem sys.path entries. In the meantime, however, this means that 'require()' now works and that intrepid souls may now witness the power of this fully operational battle station... Index: pkg_resources.py =================================================================== RCS file: /cvsroot/python/python/nondist/sandbox/setuptools/pkg_resources.py,v retrieving revision 1.16 retrieving revision 1.17 diff -u -d -r1.16 -r1.17 --- pkg_resources.py 23 May 2005 02:17:52 -0000 1.16 +++ pkg_resources.py 24 May 2005 01:15:24 -0000 1.17 @@ -414,13 +414,8 @@ `requirements` must be a string or a (possibly-nested) sequence thereof, specifying the distributions and versions required. - XXX This doesn't work yet, because: - - * find_distributions() isn't implemented - * AvailableDistributions.scan() is untested - - There may be other things missing as well, but this definitely won't work - as long as any of the above items remain unimplemented. + XXX This doesn't support arbitrary PEP 302 sys.path items yet, because + ``find_distributions()`` is hardcoded at the moment. """ requirements = parse_requirements(requirements) @@ -449,15 +444,21 @@ -class DefaultProvider: - """Provides access to package resources in the filesystem""" + + + + +class NullProvider: + """Try to implement resources and metadata for arbitrary PEP 302 loaders""" + + egg_name = None egg_info = None + loader = None def __init__(self, module): - self.module = module self.loader = getattr(module, '__loader__', None) - self.module_path = os.path.dirname(module.__file__) + self.module_path = os.path.dirname(getattr(module, '__file__', '')) def get_resource_filename(self, manager, resource_name): return self._fn(resource_name) @@ -484,33 +485,6 @@ def get_metadata_lines(self, name): return yield_lines(self.get_metadata(name)) - - - - - - - def _has(self, path): - return os.path.exists(path) - - def _get(self, path): - stream = open(path, 'rb') - try: - return stream.read() - finally: - stream.close() - - def _fn(self, resource_name): - return os.path.join(self.module_path, *resource_name.split('/')) - - -register_loader_type(type(None), DefaultProvider) - - - -class NullProvider(DefaultProvider): - """Try to implement resource support for arbitrary PEP 302 loaders""" - def _has(self, path): raise NotImplementedError( "Can't perform this operation for unregistered loader type" @@ -523,27 +497,18 @@ "Can't perform this operation for loaders without 'get_data()'" ) + def _fn(self, resource_name): + return os.path.join(self.module_path, *resource_name.split('/')) register_loader_type(object, NullProvider) +class DefaultProvider(NullProvider): + """Provides access to package resources in the filesystem""" - - - -class ZipProvider(DefaultProvider): - """Resource support for zips and eggs""" - - egg_name = None - eagers = None - - def __init__(self, module): - self.module = module - self.loader = module.__loader__ - self.zipinfo = zipimport._zip_directory_cache[self.loader.archive] - self.zip_pre = self.loader.archive+os.sep - - path = self.module_path = os.path.dirname(module.__file__) + def __init__(self,module): + NullProvider.__init__(self,module) + path = self.module_path old = None self.prefix = [] while path!=old: @@ -555,6 +520,27 @@ path, base = os.path.split(path) self.prefix.append(base) + def _has(self, path): return os.path.exists(path) + + def _get(self, path): + stream = open(path, 'rb') + try: + return stream.read() + finally: + stream.close() + +register_loader_type(type(None), DefaultProvider) + +class ZipProvider(DefaultProvider): + """Resource support for zips and eggs""" + + eagers = None + + def __init__(self, module): + DefaultProvider.__init__(self,module) + self.zipinfo = zipimport._zip_directory_cache[self.loader.archive] + self.zip_pre = self.loader.archive+os.sep + def _short_name(self, path): if path.startswith(self.zip_pre): return path[len(self.zip_pre):] @@ -569,6 +555,20 @@ def get_resource_stream(self, manager, resource_name): return StringIO(self.get_resource_string(manager, resource_name)) + def get_resource_filename(self, manager, resource_name): + if not self.egg_name: + raise NotImplementedError( + "resource_filename() only supported for .egg, not .zip" + ) + + # should lock for extraction here + eagers = self._get_eager_resources() + if resource_name in eagers: + for name in eagers: + self._extract_resource(manager, name) + + return self._extract_resource(manager, resource_name) + @@ -608,27 +608,50 @@ return self.eagers +register_loader_type(zipimport.zipimporter, ZipProvider) +class PathMetadata(DefaultProvider): + """Metadata provider for egg directories - def get_resource_filename(self, manager, resource_name): - if not self.egg_name: - raise NotImplementedError( - "resource_filename() only supported for .egg, not .zip" - ) + Usage:: - # should lock for extraction here - eagers = self._get_eager_resources() - if resource_name in eagers: - for name in eagers: - self._extract_resource(manager, name) + # Development eggs: - return self._extract_resource(manager, resource_name) + egg_info = "/path/to/PackageName.egg-info" + base_dir = os.path.dirname(egg_info) + metadata = PathMetadata(base_dir, egg_info) + dist_name = os.path.splitext(os.path.basename(egg_info))[0] + dist = Distribution(basedir,name=dist_name,metadata=metadata) + # Unpacked egg directories: -register_loader_type(zipimport.zipimporter, ZipProvider) + egg_path = "/path/to/PackageName-ver-pyver-etc.egg" + metadata = PathMetadata(egg_path, os.path.join(egg_path,'EGG-INFO')) + dist = Distribution.from_filename(egg_path, metadata=metadata) + """ + + def __init__(self, path, egg_info): + self.module_path = path + self.egg_info = egg_info + + +class EggMetadata(ZipProvider): + """Metadata provider for .egg files""" + + def __init__(self, importer): + """Create a metadata provider from a zipimporter""" + + self.zipinfo = zipimport._zip_directory_cache[importer.archive] + self.zip_pre = importer.archive+os.sep + self.loader = importer + self.module_path = os.path.join(importer.archive, importer.prefix) + + # we assume here that our metadata may be nested inside a "basket" + # of multiple eggs; that's why we use module_path instead of .archive + self.egg_info = os.path.join(self.module_path, 'EGG-INFO') def StringIO(*args, **kw): @@ -642,16 +665,34 @@ def find_distributions(path_item): - return () # XXX - - - - - - - - - + """Yield distributions accessible via `path_item`""" + if not os.path.exists(path_item): + return + elif os.path.isdir(path_item): + if path_item.lower().endswith('.egg'): + # unpacked egg + yield Distribution.from_filename( + egg_path, metadata=PathMetadata( + path_item,os.path.join(path_item,'EGG-INFO') + ) + ) + else: + # scan for .egg and .egg-info in directory + for entry in os.listdir(path_item): + fullpath = os.path.join(path_item, entry) + if entry.lower().endswith('.egg'): + for dist in find_distributions(fullpath): + yield dist + elif entry.lower().endswith('.egg-info'): + if os.path.isdir(fullpath): + # development egg + metadata = PathMetadata(path_item, fullpath) + dist_name = os.path.splitext(entry)[0] + yield Distribution(path_item,metadata,name=dist_name) + elif path_item.lower().endswith('.egg'): + # packed egg + metadata = EggMetadata(zipimport.zipimporter(path_item)) + yield Distribution.from_filename(path_item, metadata=metadata) def yield_lines(strs): @@ -761,7 +802,7 @@ #@classmethod def from_filename(cls,filename,metadata=None): - name,version,py_version,platform = [None]*4 + name,version,py_version,platform = [None,None,PY_MAJOR,None] basename,ext = os.path.splitext(os.path.basename(filename)) if ext.lower()==".egg": match = EGG_NAME(basename)

1 0

python/nondist/peps pep-0000.txt, 1.309, 1.310 pep-0345.txt, 1.1, 1.2
by akuchling＠users.sourceforge.net May 23, 2005

May 23, 2005

Update of /cvsroot/python/python/nondist/peps In directory sc8-pr-cvs1.sourceforge.net:/tmp/cvs-serv10118 Modified Files: pep-0000.txt pep-0345.txt Log Message: Fix title typo Index: pep-0000.txt =================================================================== RCS file: /cvsroot/python/python/nondist/peps/pep-0000.txt,v retrieving revision 1.309 retrieving revision 1.310 diff -u -d -r1.309 -r1.310 --- pep-0000.txt 23 May 2005 00:59:53 -0000 1.309 +++ pep-0000.txt 23 May 2005 13:08:09 -0000 1.310 @@ -121,7 +121,7 @@ S 342 Enhanced Iterators GvR S 343 Anonymous Block Redux GvR S 344 Exception Chaining and Embedded Tracebacks Yee - S 345 Medatadata for Python Software Packages 1.2 Jones + S 345 Metadata for Python Software Packages 1.2 Jones S 754 IEEE 754 Floating Point Special Values Warnes Finished PEPs (done, implemented in CVS) @@ -385,7 +385,7 @@ S 342 Enhanced Iterators GvR S 343 Anonymous Block Redux GvR S 344 Exception Chaining and Embedded Tracebacks Yee - S 345 Medatadata for Python Software Packages 1.2 Jones + S 345 Metadata for Python Software Packages 1.2 Jones SR 666 Reject Foolish Indentation Creighton S 754 IEEE 754 Floating Point Special Values Warnes I 3000 Python 3.0 Plans Kuchling, Cannon Index: pep-0345.txt =================================================================== RCS file: /cvsroot/python/python/nondist/peps/pep-0345.txt,v retrieving revision 1.1 retrieving revision 1.2 diff -u -d -r1.1 -r1.2 --- pep-0345.txt 23 May 2005 00:59:54 -0000 1.1 +++ pep-0345.txt 23 May 2005 13:08:09 -0000 1.2 @@ -1,5 +1,5 @@ PEP: 345 -Title: Medatadata for Python Software Packages 1.2 +Title: Metadata for Python Software Packages 1.2 Version: $Revision$ Last-Modified: $Date$ Author: Richard Jones <richard(a)mechanicalcat.net>

1 0

python/nondist/sandbox/setuptools pkg_resources.py, 1.15, 1.16
by pje＠users.sourceforge.net May 23, 2005

May 23, 2005

Update of /cvsroot/python/python/nondist/sandbox/setuptools In directory sc8-pr-cvs1.sourceforge.net:/tmp/cvs-serv21643 Modified Files: pkg_resources.py Log Message: Make AvailableDistributions check distributions for Python version compatibility as well as platform compatibility. Rename get_distro_source to 'find_distributions', and get rid of intermediate distro-source objects. Index: pkg_resources.py =================================================================== RCS file: /cvsroot/python/python/nondist/sandbox/setuptools/pkg_resources.py,v retrieving revision 1.15 retrieving revision 1.16 diff -u -d -r1.15 -r1.16 --- pkg_resources.py 23 May 2005 02:00:42 -0000 1.15 +++ pkg_resources.py 23 May 2005 02:17:52 -0000 1.16 @@ -40,6 +40,7 @@ """Invalid or unrecognized option name for a distribution""" _provider_factories = {} +PY_MAJOR = sys.version[:3] def register_loader_type(loader_type, provider_factory): """Register `provider_factory` to make providers for `loader_type` @@ -76,7 +77,6 @@ return True # easy case # XXX all the tricky cases go here - return False @@ -124,25 +124,16 @@ class AvailableDistributions(object): """Searchable snapshot of distributions on a search path""" - def __init__(self, search_path=None, platform=get_platform()): + def __init__(self,search_path=None,platform=get_platform(),python=PY_MAJOR): """Snapshot distributions available on a search path - `search_path` should be a sequence of ``sys.path`` items. If not - supplied, ``sys.path`` is used. - - The `platform` is an optional string specifying the name of the - platform that platform-specific distributions must be compatible - with. If not specified, it defaults to the current platform - (as defined by the result of ``get_platform()`` when ``pkg_resources`` - was first imported.) - - You may explicitly set `platform` to ``None`` if you wish to map *all* - distributions, not just those compatible with a single platform. + The constructor arguments are the same as those for the ``scan()`` + method; see that method's documentation for details. """ self._distmap = {} self._cache = {} - self.scan(search_path,platform) + self.scan(search_path,platform,python) def __iter__(self): """Iterate over distribution keys""" @@ -162,7 +153,7 @@ else: return default - def scan(self, search_path=None, platform=get_platform()): + def scan(self, search_path=None, platform=get_platform(), python=PY_MAJOR): """Scan `search_path` for distributions usable on `platform` Any distributions found are added to the distribution map. @@ -170,19 +161,27 @@ supplied, ``sys.path`` is used. `platform` is an optional string specifying the name of the platform that platform-specific distributions must be compatible with. If unspecified, it defaults to - the current platform. + the current platform. `python` is an optional string naming the + desired version of Python (e.g. ``'2.4'``); it defaults to the current + version. - You may explicitly set `platform` to ``None`` if you wish to map *all* - distributions, not just those compatible with the running platform. + You may explicitly set `platform` (and/or `python`) to ``None`` if you + wish to map *all* distributions, not just those compatible with the + running platform or Python version. """ + if search_path is None: search_path = sys.path + add = self.add + for item in search_path: - source = get_distro_source(item) - for dist in source.iter_distributions(requirement): + for dist in find_distributions(item): + if python is not None and dist.py_version!=python: + continue if compatible_platforms(dist.platform, platform): - add(dist) # XXX should also check python version! + add(dist) + def __getitem__(self,key): """Return a newest-to-oldest list of distributions for the given key @@ -190,6 +189,7 @@ The returned list may be modified in-place, e.g. for narrowing down usable distributions. """ + try: return self._cache[key] except KeyError: @@ -416,7 +416,7 @@ XXX This doesn't work yet, because: - * get_distro_source() isn't implemented + * find_distributions() isn't implemented * AvailableDistributions.scan() is untested There may be other things missing as well, but this definitely won't work @@ -641,8 +641,8 @@ return StringIO(*args,**kw) -def get_distro_source(path_item): - pass # XXX +def find_distributions(path_item): + return () # XXX @@ -741,7 +741,7 @@ def __init__(self, path_str, metadata=None, name=None, version=None, - py_version=sys.version[:3], platform=None + py_version=PY_MAJOR, platform=None ): if name: self.name = name.replace('_','-')

1 0

python/nondist/sandbox/setuptools pkg_resources.py, 1.14, 1.15
by pje＠users.sourceforge.net May 23, 2005

May 23, 2005

Update of /cvsroot/python/python/nondist/sandbox/setuptools In directory sc8-pr-cvs1.sourceforge.net:/tmp/cvs-serv18564 Modified Files: pkg_resources.py Log Message: Add a rough draft of Distribution.install_on(), to let others experiment with 'require()' before the "official" version is complete. Index: pkg_resources.py =================================================================== RCS file: /cvsroot/python/python/nondist/sandbox/setuptools/pkg_resources.py,v retrieving revision 1.14 retrieving revision 1.15 diff -u -d -r1.14 -r1.15 --- pkg_resources.py 23 May 2005 01:56:26 -0000 1.14 +++ pkg_resources.py 23 May 2005 02:00:42 -0000 1.15 @@ -417,7 +417,6 @@ XXX This doesn't work yet, because: * get_distro_source() isn't implemented - * Distribution.install_on() isn't implemented * AvailableDistributions.scan() is untested There may be other things missing as well, but this definitely won't work @@ -449,6 +448,7 @@ + class DefaultProvider: """Provides access to package resources in the filesystem""" @@ -846,6 +846,11 @@ raise InvalidOption("No such option", self, opt) return deps + def install_on(self,path=None): + # XXX this needs to interface with namespace packages and such + if path is None: path = sys.path + if self.path not in path: + path.append(self.path) def _sort_dists(dists): @@ -854,11 +859,6 @@ dists[::-1] = [d for v,d in tmp] - - - - - def parse_requirements(strs): """Yield ``Requirement`` objects for each specification in `strs`

1 0

python/nondist/sandbox/setuptools pkg_resources.py, 1.13, 1.14
by pje＠users.sourceforge.net May 23, 2005

May 23, 2005

Update of /cvsroot/python/python/nondist/sandbox/setuptools In directory sc8-pr-cvs1.sourceforge.net:/tmp/cvs-serv17806 Modified Files: pkg_resources.py Log Message: Add tests for AvailableDistributions().resolve(). This effectively completes the core dependency resolution engine; all we need now is a way to turn sys.path entries into "distribution sources" that can list Distribution objects for inclusion in an instance of AvailableDistributions, and the 'require("SomePkg>=2.7")' API will be usable. Index: pkg_resources.py =================================================================== RCS file: /cvsroot/python/python/nondist/sandbox/setuptools/pkg_resources.py,v retrieving revision 1.13 retrieving revision 1.14 diff -u -d -r1.13 -r1.14 --- pkg_resources.py 22 May 2005 20:28:46 -0000 1.13 +++ pkg_resources.py 23 May 2005 01:56:26 -0000 1.14 @@ -250,12 +250,12 @@ if path is None: path = sys.path - requirements = list(requirements)[::1] # set up the stack + requirements = list(requirements)[::-1] # set up the stack processed = {} # set of processed requirements best = {} # key -> dist + to_install = [] while requirements: - req = requirements.pop() if req in processed: # Ignore cyclic or redundant dependencies @@ -268,15 +268,16 @@ dist = best[req.key] = self.best_match(req,path) if dist is None: raise DistributionNotFound(req) # XXX put more info here + to_install.append(dist) - elif dist not in requirement: + elif dist not in req: # Oops, the "best" so far conflicts with a dependency raise VersionConflict(req,dist) # XXX put more info here requirements.extend(dist.depends(req.options)[::-1]) processed[req] = True - return best.values() # return list of distros to install + return to_install # return list of distros to install def obtain(self, requirement): @@ -284,7 +285,6 @@ return None # override this in subclasses - class ResourceManager: """Manage resource extraction and packages""" @@ -418,7 +418,6 @@ * get_distro_source() isn't implemented * Distribution.install_on() isn't implemented - * AvailableDistributions.resolve() is untested * AvailableDistributions.scan() is untested There may be other things missing as well, but this definitely won't work @@ -449,6 +448,7 @@ + class DefaultProvider: """Provides access to package resources in the filesystem"""

1 0

python/nondist/sandbox/setuptools/setuptools/tests test_resources.py, 1.9, 1.10
by pje＠users.sourceforge.net May 23, 2005

May 23, 2005

Update of /cvsroot/python/python/nondist/sandbox/setuptools/setuptools/tests In directory sc8-pr-cvs1.sourceforge.net:/tmp/cvs-serv17806/setuptools/tests Modified Files: test_resources.py Log Message: Add tests for AvailableDistributions().resolve(). This effectively completes the core dependency resolution engine; all we need now is a way to turn sys.path entries into "distribution sources" that can list Distribution objects for inclusion in an instance of AvailableDistributions, and the 'require("SomePkg>=2.7")' API will be usable. Index: test_resources.py =================================================================== RCS file: /cvsroot/python/python/nondist/sandbox/setuptools/setuptools/tests/test_resources.py,v retrieving revision 1.9 retrieving revision 1.10 diff -u -d -r1.9 -r1.10 --- test_resources.py 22 May 2005 20:28:47 -0000 1.9 +++ test_resources.py 23 May 2005 01:56:27 -0000 1.10 @@ -121,6 +121,47 @@ self.checkDepends(self.distDepends(v), v) + def testResolve(self): + ad = AvailableDistributions([]) + + # Resolving no requirements -> nothing to install + self.assertEqual( list(ad.resolve([],[])), [] ) + + # Request something not in the collection -> DistributionNotFound + self.assertRaises( + DistributionNotFound, ad.resolve, parse_requirements("Foo"), [] + ) + + Foo = Distribution.from_filename( + "/foo_dir/Foo-1.2.egg", + metadata=Metadata(('depends.txt', "[bar]\nBaz>=2.0")) + ) + ad.add(Foo) + + # Request thing(s) that are available -> list to install + self.assertEqual( + list(ad.resolve(parse_requirements("Foo"),[])), [Foo] + ) + + # Request an option that causes an unresolved dependency for "Baz" + self.assertRaises( + DistributionNotFound, ad.resolve,parse_requirements("Foo[bar]"),[] + ) + Baz = Distribution.from_filename( + "/foo_dir/Baz-2.1.egg", metadata=Metadata(('depends.txt', "Foo")) + ) + ad.add(Baz) + + # Install list now includes resolved dependency + self.assertEqual( + list(ad.resolve(parse_requirements("Foo[bar]"),[])), [Foo,Baz] + ) + # Requests for conflicting versions produce VersionConflict + self.assertRaises( + VersionConflict, + ad.resolve, parse_requirements("Foo==1.2\nFoo!=1.2"), [] + ) + def testDistroDependsOptions(self): d = self.distDepends(""" Twisted>=1.5

1 0

python/nondist/peps pep-0345.txt, NONE, 1.1 pep-0000.txt, 1.308, 1.309
by goodger＠users.sourceforge.net May 23, 2005

May 23, 2005

Update of /cvsroot/python/python/nondist/peps In directory sc8-pr-cvs1.sourceforge.net:/tmp/cvs-serv10012 Modified Files: pep-0000.txt Added Files: pep-0345.txt Log Message: added PEP 345, Medatadata for Python Software Packages 1.2, by Richard Jones --- NEW FILE: pep-0345.txt --- PEP: 345 Title: Medatadata for Python Software Packages 1.2 Version: $Revision: 1.1 $ Last-Modified: $Date: 2005/05/23 00:59:54 $ Author: Richard Jones <richard(a)mechanicalcat.net> Discussions-To: Distutils SIG Status: Draft Type: Standards Track Content-type: text/x-rst Created: 28-Apr-2005 Python-Version: 2.5 Post-History: Replaces: 314 Abstract ======== This PEP describes a mechanism for adding metadata to Python packages. It includes specifics of the field names, and their semantics and usage. This document specifies version 1.2 of the metadata format. Version 1.0 is specified in PEP 241. Version 1.1 is specified in PEP 314. Version 1.2 of the metadata format adds a number of optional fields designed to make third-party packaging of Python Software easier. These fields are "Requires-Python" and "Requires-External". Also, the "Metadata-Version" field is updated. Fields ====== This section specifies the names and semantics of each of the supported metadata fields. Fields marked with "(Multiple use)" may be specified multiple times in a single PKG-INFO file. Other fields may only occur once in a PKG-INFO file. Fields marked with "(optional)" are not required to appear in a valid PKG-INFO file; all other fields must be present. Metadata-Version Version of the file format; "1.0", "1.1" and "1.2" are the only legal values here. Example:: Metadata-Version: 1.2 Name The name of the package. Example:: Name: BeagleVote Version A string containing the package's version number. This field should be parseable by one of the Version classes (StrictVersion or LooseVersion) in the distutils.version module. Example:: Version: 1.0a2 Platform (multiple use) A comma-separated list of platform specifications, summarizing the operating systems supported by the package which are not listed in the "Operating System" Trove classifiers. See "Classifier" below. Example:: Platform: ObscureUnix, RareDOS Supported-Platform (multiple use) Binary distributions containing a PKG-INFO file will use the Supported-Platform field in their metadata to specify the OS and CPU for which the binary package was compiled. The semantics of the Supported-Platform field are not specified in this PEP. Example:: Supported-Platform: RedHat 7.2 Supported-Platform: i386-win32-2791 Summary A one-line summary of what the package does. Example:: Summary: A module for collecting votes from beagles. Description (optional) A longer description of the package that can run to several paragraphs. Software that deals with metadata should not assume any maximum size for this field, though people shouldn't include their instruction manual as the description. The contents of this field can be written using reStructuredText markup [1]_. For programs that work with the metadata, supporting markup is optional; programs can also display the contents of the field as-is. This means that authors should be conservative in the markup they use. Example:: Description: This module collects votes from beagles in order to determine their electoral wishes. Do *not* try to use this module with basset hounds; it makes them grumpy. Keywords (optional) A list of additional keywords to be used to assist searching for the package in a larger catalog. Example:: Keywords: dog puppy voting election Home-page (optional) A string containing the URL for the package's home page. Example:: Home-page: http://www.example.com/~cschultz/bvote/ Download-URL A string containing the URL from which this version of the package can be downloaded. (This means that the URL can't be something like ".../package-latest.tgz", but instead must be "../package-0.45.tgz".) Author (optional) A string containing the author's name at a minimum; additional contact information may be provided. Example:: Author: C. Schultz, Universal Features Syndicate, Los Angeles, CA <cschultz(a)peanuts.example.com> Author-email A string containing the author's e-mail address. It can contain a name and e-mail address in the legal forms for a RFC-822 'From:' header. It's not optional because cataloging systems can use the e-mail portion of this field as a unique key representing the author. A catalog might provide authors the ability to store their GPG key, personal home page, and other additional metadata *about the author*, and optionally the ability to associate several e-mail addresses with the same person. Author-related metadata fields are not covered by this PEP. Example:: Author-email: "C. Schultz" <cschultz(a)example.com> License Text indicating the license covering the package where the license is not a selection from the "License" Trove classifiers. See "Classifier" below. Example:: License: This software may only be obtained by sending the author a postcard, and then the user promises not to redistribute it. Classifier (multiple use) Each entry is a string giving a single classification value for the package. Classifiers are described in PEP 301 [2]. Examples:: Classifier: Development Status :: 4 - Beta Classifier: Environment :: Console (Text Based) Requires (multiple use) Each entry contains a string describing some other module or package required by this package. The format of a requirement string is identical to that of a module or package name usable with the 'import' statement, optionally followed by a version declaration within parentheses. A version declaration is a series of conditional operators and version numbers, separated by commas. Conditional operators must be one of "<", ">", "<=", ">=", "==", and "!=". Version numbers must be in the format accepted by the distutils.version.StrictVersion class: two or three dot-separated numeric components, with an optional "pre-release" tag on the end consisting of the letter 'a' or 'b' followed by a number. Example version numbers are "1.0", "2.3a2", "1.3.99", Any number of conditional operators can be specified, e.g. the string ">1.0, !=1.3.4, <2.0" is a legal version declaration. All of the following are possible requirement strings: "rfc822", "zlib (>=1.1.4)", "zope". There's no canonical list of what strings should be used; the Python community is left to choose its own standards. Example:: Requires: re Requires: sys Requires: zlib Requires: xml.parsers.expat (>1.0) Requires: psycopg Provides (multiple use) Each entry contains a string describing a package or module that will be provided by this package once it is installed. These strings should match the ones used in Requirements fields. A version declaration may be supplied (without a comparison operator); the package's version number will be implied if none is specified. Example:: Provides: xml Provides: xml.utils Provides: xml.utils.iso8601 Provides: xml.dom Provides: xmltools (1.3) Obsoletes (multiple use) Each entry contains a string describing a package or module that this package renders obsolete, meaning that the two packages should not be installed at the same time. Version declarations can be supplied. The most common use of this field will be in case a package name changes, e.g. Gorgon 2.3 gets subsumed into Torqued Python 1.0. When you install Torqued Python, the Gorgon package should be removed. Example:: Obsoletes: Gorgon Requires-Python This field specifies the Python version(s) that the package is guaranteed to be compatible with. The format of the field is a series of conditional operators and version numbers, separated by commas. Conditional operators must be one of "<", ">", "<=", ">=", "==", and "!=". Version numbers must be in the format accepted by the distutils.version.StrictVersion class: two or three dot-separated numeric components, with an optional "pre-release" tag on the end consisting of the letter 'a' or 'b' followed by a number. Example version numbers are "1.0", "2.3a2" and "1.3.99". Any number of conditional operators can be specified, e.g. the string ">1.0, !=1.3.4, <2.0" is a legal version declaration. Example:: Requires-Python: >2.1 Requires-Python: >=2.3.4 XXX This field doesn't take into account possible future incompatibilities through deprecation. We could specify that the ">" operator only work for up to two releases? This is based on the typical deprecation plan that Python usually follows (warning for two releases and then error). That is, >=2.3.4 works for 2.3.4, 2.4 and 2.5. Requires-External (multiple use) Each entry contains a string describing some dependency in the system that the package is to be used. The format of a requirement string is a name of an external dependency, optionally followed by a version declaration within parentheses. A version declaration is a series of conditional operators and version numbers, separated by commas. Conditional operators must be one of "<", ">", "<=", ">=", "==", and "!=". Version numbers must be in the format accepted by the distutils.version.StrictVersion class: two or three dot-separated numeric components, with an optional "pre-release" tag on the end consisting of the letter 'a' or 'b' followed by a number. Example version numbers are "1.0", "2.3a2", "1.3.99", Any number of conditional operators can be specified, e.g. the string ">1.0, !=1.3.4, <2.0" is a legal version declaration. The canonical list of what strings are allowed is available in the `Cheese Shop`_ database. New names may be added to the database either through the web or using the command-line; Python community is left to choose its own standards. Some dependencies are anticipated to be quite broad, eg. "C", indicating a C compiler is required. Example:: Requires: C Requires: libpng Copyright Indicates the party or parties, and the year of copyright covering the package. Example:: Copyright: Guido van Rossum, 1991 Copyright: Python Software Foundation, 2005 Copyright: Public Domain External References Registry ============================ Stores in the `Cheese Shop`_ database a list of (name, description, URI) identifying an external reference that may be used as a value in a Requires-External field. The name and description are required, but URI is not (as there is no single useful URI for "C"). Submissions to the registry are open to the community, and may be performed through the web or using the command-line. The names in the registry will be created under a first-comes first-wins basis. Other packagers of Python software (eg. to deb, rpm, etc) should be able to translate the requires-external field to names in their own packaging system. XXX command-line interface needs work, obviously References ========== This document specifies version 1.2 of the metadata format. Version 1.0 is specified in PEP 241. Version 1.1 is specified in PEP 314. .. [1] reStructuredText markup: http://docutils.sourceforge.net/ .. _`Cheese Shop`: http://cheeseshop.python.org/ Copyright ========= This document has been placed in the public domain. Acknowledgements ================ Fred Drake, Anthony Baxter and Matthias Klose have all contributed to the ideas presented in this PEP. .. Local Variables: mode: indented-text indent-tabs-mode: nil sentence-end-double-space: t fill-column: 70 End: Index: pep-0000.txt =================================================================== RCS file: /cvsroot/python/python/nondist/peps/pep-0000.txt,v retrieving revision 1.308 retrieving revision 1.309 diff -u -d -r1.308 -r1.309 --- pep-0000.txt 16 May 2005 00:34:33 -0000 1.308 +++ pep-0000.txt 23 May 2005 00:59:53 -0000 1.309 @@ -121,6 +121,7 @@ S 342 Enhanced Iterators GvR S 343 Anonymous Block Redux GvR S 344 Exception Chaining and Embedded Tracebacks Yee + S 345 Medatadata for Python Software Packages 1.2 Jones S 754 IEEE 754 Floating Point Special Values Warnes Finished PEPs (done, implemented in CVS) @@ -384,6 +385,7 @@ S 342 Enhanced Iterators GvR S 343 Anonymous Block Redux GvR S 344 Exception Chaining and Embedded Tracebacks Yee + S 345 Medatadata for Python Software Packages 1.2 Jones SR 666 Reject Foolish Indentation Creighton S 754 IEEE 754 Floating Point Special Values Warnes I 3000 Python 3.0 Plans Kuchling, Cannon @@ -445,7 +447,7 @@ Hylton, Jeremy jeremy(a)zope.com Jansen, Jack jack(a)cwi.nl Jewett, Jim jimjjewett(a)users.sourceforge.net - Jones, Richard rjones(a)ekit-inc.com + Jones, Richard richard(a)mechanicalcat.net Koltsov, Stepan yozh(a)mx1.ru Kuchling, A.M. amk(a)amk.ca Lemburg, Marc-Andre mal(a)lemburg.com

1 0

python/nondist/sandbox/setuptools/setuptools/tests test_resources.py, 1.8, 1.9
by pje＠users.sourceforge.net May 22, 2005

May 22, 2005

Update of /cvsroot/python/python/nondist/sandbox/setuptools/setuptools/tests In directory sc8-pr-cvs1.sourceforge.net:/tmp/cvs-serv21794/setuptools/tests Modified Files: test_resources.py Log Message: Added support for specifying options on requirements, so that a package's optional dependencies can be included when processing nested dependencies. Next up: tests for the resolve() algorithm. Index: test_resources.py =================================================================== RCS file: /cvsroot/python/python/nondist/sandbox/setuptools/setuptools/tests/test_resources.py,v retrieving revision 1.8 retrieving revision 1.9 diff -u -d -r1.8 -r1.9 --- test_resources.py 22 May 2005 19:40:22 -0000 1.8 +++ test_resources.py 22 May 2005 20:28:47 -0000 1.9 @@ -1,6 +1,7 @@ from unittest import TestCase, makeSuite from pkg_resources import * import pkg_resources, sys +from sets import ImmutableSet class Metadata: """Mock object to return metadata as if from an on-disk distribution""" @@ -18,7 +19,6 @@ return yield_lines(self.get_metadata(name)) - class DistroTests(TestCase): def testCollection(self): @@ -167,12 +167,13 @@ def testBasics(self): r = Requirement.parse("Twisted>=1.2") self.assertEqual(str(r),"Twisted>=1.2") - self.assertEqual(repr(r),"Requirement('Twisted', [('>=', '1.2')])") + self.assertEqual(repr(r),"Requirement('Twisted', [('>=', '1.2')], ())") self.assertEqual(r, Requirement("Twisted", [('>=','1.2')])) self.assertEqual(r, Requirement("twisTed", [('>=','1.2')])) self.assertNotEqual(r, Requirement("Twisted", [('>=','2.0')])) self.assertNotEqual(r, Requirement("Zope", [('>=','1.2')])) self.assertNotEqual(r, Requirement("Zope", [('>=','3.0')])) + self.assertNotEqual(r, Requirement.parse("Twisted[extras]>=1.2")) def testOrdering(self): r1 = Requirement("Twisted", [('==','1.2c1'),('>=','1.2')]) @@ -202,6 +203,46 @@ self.failUnless(v not in r, (v,r)) + def testOptionsAndHashing(self): + r1 = Requirement.parse("Twisted[foo,bar]>=1.2") + r2 = Requirement.parse("Twisted[bar,FOO]>=1.2") + r3 = Requirement.parse("Twisted[BAR,FOO]>=1.2.0") + self.assertEqual(r1,r2) + self.assertEqual(r1,r3) + self.assertEqual(r1.options, ("foo","bar")) + self.assertEqual(r2.options, ("bar","FOO")) + self.assertEqual(hash(r1), hash(r2)) + self.assertEqual( + hash(r1), hash(("twisted", ((">=",parse_version("1.2")),), + ImmutableSet(["foo","bar"]))) + ) + + + + + + + + + + + + + + + + + + + + + + + + + + + class ParseTests(TestCase): @@ -233,7 +274,7 @@ """ ) ), - [(None,["x"]), ("y",["z","a"]), ("b",["c"]), ("q",["v"])] + [(None,["x"]), ("y",["z","a"]), ("b",["c"]), ("d",[]), ("q",["v"])] ) self.assertRaises(ValueError,list,pkg_resources.split_sections("[foo"))

1 0

python/nondist/sandbox/setuptools pkg_resources.py, 1.12, 1.13
by pje＠users.sourceforge.net May 22, 2005

May 22, 2005

Update of /cvsroot/python/python/nondist/sandbox/setuptools In directory sc8-pr-cvs1.sourceforge.net:/tmp/cvs-serv21794 Modified Files: pkg_resources.py Log Message: Added support for specifying options on requirements, so that a package's optional dependencies can be included when processing nested dependencies. Next up: tests for the resolve() algorithm. Index: pkg_resources.py =================================================================== RCS file: /cvsroot/python/python/nondist/sandbox/setuptools/pkg_resources.py,v retrieving revision 1.12 retrieving revision 1.13 diff -u -d -r1.12 -r1.13 --- pkg_resources.py 22 May 2005 19:40:22 -0000 1.12 +++ pkg_resources.py 22 May 2005 20:28:46 -0000 1.13 @@ -14,7 +14,7 @@ method. """ __all__ = [ - 'register_loader_type', 'get_provider', 'IResourceProvider', + 'register_loader_type', 'get_provider', 'IResourceProvider', 'ResourceManager', 'AvailableDistributions', 'require', 'resource_string', 'resource_stream', 'resource_filename', 'set_extraction_path', 'cleanup_resources', 'parse_requirements', 'parse_version', @@ -25,6 +25,7 @@ ] import sys, os, zipimport, time, re +from sets import ImmutableSet class ResolutionError(Exception): """Abstract base for dependency resolution errors""" @@ -38,7 +39,6 @@ class InvalidOption(ResolutionError): """Invalid or unrecognized option name for a distribution""" - _provider_factories = {} def register_loader_type(loader_type, provider_factory): @@ -418,7 +418,6 @@ * get_distro_source() isn't implemented * Distribution.install_on() isn't implemented - * Requirement.options isn't implemented * AvailableDistributions.resolve() is untested * AvailableDistributions.scan() is untested @@ -449,6 +448,7 @@ + class DefaultProvider: """Provides access to package resources in the filesystem""" @@ -668,9 +668,11 @@ LINE_END = re.compile(r"\s*(#.*)?$").match # whitespace and comment CONTINUE = re.compile(r"\s*\\\s*(#.*)?$").match # line continuation -DISTRO = re.compile(r"\s*(\w+)").match # Distribution name +DISTRO = re.compile(r"\s*(\w+)").match # Distribution or option VERSION = re.compile(r"\s*(<=?|>=?|==|!=)\s*((\w|\.)+)").match # version info COMMA = re.compile(r"\s*,").match # comma between items +OBRACKET = re.compile(r"\s*\[").match +CBRACKET = re.compile(r"\s*\]").match EGG_NAME = re.compile( r"(?P<name>[^-]+)" @@ -693,8 +695,6 @@ yield '*final' # ensure that alpha/beta/candidate are before final - - def parse_version(s): """Convert a version string to a sortable key @@ -867,15 +867,12 @@ """ # create a steppable iterator, so we can handle \-continuations lines = iter(yield_lines(strs)) - for line in lines: - line = line.replace('-','_') - match = DISTRO(line) - if not match: - raise ValueError("Missing distribution spec", line) - distname = match.group(1) - p = match.end() - specs = [] - while not LINE_END(line,p): + + def scan_list(ITEM,TERMINATOR,line,p,groups,item_name): + + items = [] + + while not TERMINATOR(line,p): if CONTINUE(line,p): try: line = lines.next().replace('-','_'); p = 0 @@ -883,64 +880,111 @@ raise ValueError( "\\ must not appear on the last nonblank line" ) - match = VERSION(line,p) + + match = ITEM(line,p) if not match: - raise ValueError("Expected version spec in",line,"at",line[p:]) - op,val = match.group(1,2) - specs.append((op,val.replace('_','-'))) + raise ValueError("Expected "+item_name+" in",line,"at",line[p:]) + + items.append(match.group(*groups)) p = match.end() + match = COMMA(line,p) if match: p = match.end() # skip the comma - elif not LINE_END(line,p): - raise ValueError("Expected ',' or EOL in",line,"at",line[p:]) + elif not TERMINATOR(line,p): + raise ValueError( + "Expected ',' or end-of-list in",line,"at",line[p:] + ) + + match = TERMINATOR(line,p) + if match: p = match.end() # skip the terminator, if any + return line, p, items + + for line in lines: + line = line.replace('-','_') + match = DISTRO(line) + if not match: + raise ValueError("Missing distribution spec", line) + distname = match.group(1) + p = match.end() + options = [] + + match = OBRACKET(line,p) + if match: + p = match.end() + line, p, options = scan_list(DISTRO,CBRACKET,line,p,(1,),"option") + + line, p, specs = scan_list(VERSION,LINE_END,line,p,(1,2),"version spec") + specs = [(op,val.replace('_','-')) for op,val in specs] + yield Requirement(distname.replace('_','-'), specs, options) + + + + + + + + + + + + + + + + + + + - yield Requirement(distname.replace('_','-'), specs) class Requirement: - def __init__(self, distname, specs=()): + def __init__(self, distname, specs=(), options=()): self.distname = distname self.key = distname.lower() index = [(parse_version(v),state_machine[op],op,v) for op,v in specs] index.sort() self.specs = [(op,ver) for parsed,trans,op,ver in index] - self.index = index + self.index, self.options = index, tuple(options) + self.hashCmp = ( + self.key, tuple([(op,parsed) for parsed,trans,op,ver in index]), + ImmutableSet(map(str.lower,options)) + ) + self.__hash = hash(self.hashCmp) def __str__(self): return self.distname + ','.join([''.join(s) for s in self.specs]) def __repr__(self): - return "Requirement(%r, %r)" % (self.distname, self.specs) + return "Requirement(%r, %r, %r)" % \ + (self.distname,self.specs,self.options) def __eq__(self,other): - return isinstance(other,Requirement) \ - and self.key==other.key and self.specs==other.specs + return isinstance(other,Requirement) and self.hashCmp==other.hashCmp def __contains__(self,item): if isinstance(item,Distribution): - if item.key <> self.key: - return False + if item.key <> self.key: return False item = item.parsed_version elif isinstance(item,basestring): item = parse_version(item) last = True for parsed,trans,op,ver in self.index: action = trans[cmp(item,parsed)] - if action=='F': - return False - elif action=='T': - return True - elif action=='+': - last = True - elif action=='-': - last = False + if action=='F': return False + elif action=='T': return True + elif action=='+': last = True + elif action=='-': last = False return last + def __hash__(self): + return self.__hash + #@staticmethod def parse(s): reqs = list(parse_requirements(s)) @@ -948,10 +992,11 @@ if len(reqs)==1: return reqs[0] raise ValueError("Expected only one requirement", s) - raise ValueError("No requirements found", s) + raise ValueError("No requirements found", s) parse = staticmethod(parse) + state_machine = { # =>< '<' : '--T', @@ -962,6 +1007,7 @@ '!=': 'F..', } + def _get_mro(cls): """Get an mro for a type or classic class""" if not isinstance(cls,type): @@ -969,6 +1015,7 @@ return cls.__mro__[1:] return cls.__mro__ + def _find_adapter(registry, ob): """Return an adapter factory for `ob` from `registry`""" for t in _get_mro(getattr(ob, '__class__', type(ob))): @@ -995,7 +1042,7 @@ for line in yield_lines(s): if line.startswith("["): if line.endswith("]"): - if content: + if section or content: yield section, content section = line[1:-1].strip().lower() content = [] @@ -1005,8 +1052,16 @@ content.append(line) # wrap up last segment - if content: - yield section, content + yield section, content + + + + + + + + + # Set up global resource manager @@ -1023,3 +1078,30 @@ + + + + + + + + + + + + + + + + + + + + + + + + + + +

1 0

python/nondist/sandbox/setuptools pkg_resources.py, 1.11, 1.12
by pje＠users.sourceforge.net May 22, 2005

May 22, 2005

Update of /cvsroot/python/python/nondist/sandbox/setuptools In directory sc8-pr-cvs1.sourceforge.net:/tmp/cvs-serv13209 Modified Files: pkg_resources.py Log Message: Distribution metadata parsing: distribution objects can now extract their version from PKG-INFO and their dependencies from depends.txt, including optional dependencies. Index: pkg_resources.py =================================================================== RCS file: /cvsroot/python/python/nondist/sandbox/setuptools/pkg_resources.py,v retrieving revision 1.11 retrieving revision 1.12 diff -u -d -r1.11 -r1.12 --- pkg_resources.py 22 May 2005 18:16:59 -0000 1.11 +++ pkg_resources.py 22 May 2005 19:40:22 -0000 1.12 @@ -14,23 +14,19 @@ method. """ __all__ = [ - 'register_loader_type', 'get_provider', 'IResourceProvider', + 'register_loader_type', 'get_provider', 'IResourceProvider', 'ResourceManager', 'AvailableDistributions', 'require', 'resource_string', 'resource_stream', 'resource_filename', 'set_extraction_path', 'cleanup_resources', 'parse_requirements', 'parse_version', - 'compatible_platforms', 'get_platform', + 'compatible_platforms', 'get_platform', 'IMetadataProvider', 'ResolutionError', 'VersionConflict', 'DistributionNotFound', - 'Distribution', 'Requirement', # 'glob_resources' + 'InvalidOption', 'Distribution', 'Requirement', 'yield_lines', + 'split_sections', # 'glob_resources' ] import sys, os, zipimport, time, re -def _sort_dists(dists): - tmp = [(dist.version,dist) for dist in dists] - tmp.sort() - dists[::-1] = [d for v,d in tmp] - -class ResolutionError(ImportError): +class ResolutionError(Exception): """Abstract base for dependency resolution errors""" class VersionConflict(ResolutionError): @@ -39,6 +35,10 @@ class DistributionNotFound(ResolutionError): """A requested distribution was not found""" +class InvalidOption(ResolutionError): + """Invalid or unrecognized option name for a distribution""" + + _provider_factories = {} def register_loader_type(loader_type, provider_factory): @@ -80,7 +80,22 @@ return False -class IResourceProvider: +class IMetadataProvider: + + def has_metadata(name): + """Does the package's distribution contain the named metadata?""" + + def get_metadata(name): + """The named metadata resource as a string""" + + def get_metadata_lines(name): + """Yield named metadata resource as list of non-blank non-comment lines + + Leading and trailing whitespace is stripped from each line, and lines + with ``#`` as the first non-blank character are omitted. + """ + +class IResourceProvider(IMetadataProvider): """An object that provides access to package resources""" @@ -102,25 +117,10 @@ def has_resource(resource_name): """Does the package contain the named resource?""" - def has_metadata(name): - """Does the package's distribution contain the named metadata?""" - - def get_metadata(name): - """The named metadata resource as a string""" - - def get_metadata_lines(name): - """Yield named metadata resource as list of non-blank non-comment lines - - Leading and trailing whitespace is stripped from each line, and lines - with ``#`` as the first non-blank character are omitted. - """ - # XXX list_resources? glob_resources? - - class AvailableDistributions(object): """Searchable snapshot of distributions on a search path""" @@ -417,7 +417,6 @@ XXX This doesn't work yet, because: * get_distro_source() isn't implemented - * Distribution.depends() isn't implemented * Distribution.install_on() isn't implemented * Requirement.options isn't implemented * AvailableDistributions.resolve() is untested @@ -449,6 +448,7 @@ + class DefaultProvider: """Provides access to package resources in the filesystem""" @@ -746,11 +746,12 @@ if name: self.name = name.replace('_','-') if version: - self.version = version.replace('_','-') + self._version = version.replace('_','-') self.py_version = py_version self.platform = platform self.path = path_str + self.metadata = metadata def installed_on(self,path=None): """Is this distro installed on `path`? (defaults to ``sys.path``)""" @@ -776,7 +777,6 @@ - # These properties have to be lazy so that we don't have to load any # metadata until/unless it's actually needed. (i.e., some distributions # may not know their name or version without loading PKG-INFO) @@ -800,17 +800,58 @@ parsed_version = property(parsed_version) + #@property + def version(self): + try: + return self._version + except AttributeError: + for line in self.metadata.get_metadata_lines('PKG-INFO'): + if line.lower().startswith('version:'): + self._version = line.split(':',1)[1].strip() + return self._version + else: + raise AttributeError( + "Missing Version: header in PKG-INFO", self + ) + version = property(version) + #@property + def _dep_map(self): + try: + return self.__dep_map + except AttributeError: + dm = self.__dep_map = {None: []} + if self.metadata.has_metadata('depends.txt'): + for section,contents in split_sections( + self.metadata.get_metadata_lines('depends.txt') + ): + dm[section] = list(parse_requirements(contents)) + return dm + _dep_map = property(_dep_map) + def depends(self,options=()): + """List of Requirements needed for this distro if `options` are used""" + dm = self._dep_map + deps = [] + deps.extend(dm.get(None,())) + for opt in options: + try: + deps.extend(dm[opt.lower()]) + except KeyError: + raise InvalidOption("No such option", self, opt) + return deps - +def _sort_dists(dists): + tmp = [(dist.version,dist) for dist in dists] + tmp.sort() + dists[::-1] = [d for v,d in tmp] @@ -941,6 +982,33 @@ os.makedirs(dirname) +def split_sections(s): + """Split a string or iterable thereof into (section,content) pairs + + Each ``section`` is a lowercase version of the section header ("[section]") + and each ``content`` is a list of stripped lines excluding blank lines and + comment-only lines. If there are any such lines before the first section + header, they're returned in a first ``section`` of ``None``. + """ + section = None + content = [] + for line in yield_lines(s): + if line.startswith("["): + if line.endswith("]"): + if content: + yield section, content + section = line[1:-1].strip().lower() + content = [] + else: + raise ValueError("Invalid section heading", line) + else: + content.append(line) + + # wrap up last segment + if content: + yield section, content + + # Set up global resource manager _manager = ResourceManager() @@ -952,3 +1020,6 @@ _initialize(globals()) + + +

1 0