pax_global_header00006660000000000000000000000064131162262750014517gustar00rootroot0000000000000052 comment=0ad36ae634d3f31ee42a7ca5992409a1c534216e entrypoints-0.2.3/000077500000000000000000000000001311622627500141175ustar00rootroot00000000000000entrypoints-0.2.3/.gitignore000066400000000000000000000000571311622627500161110ustar00rootroot00000000000000__pycache__/ *.pyc /build/ /dist/ /doc/_build/ entrypoints-0.2.3/.travis.yml000066400000000000000000000002671311622627500162350ustar00rootroot00000000000000language: python python: - "3.4" - "3.3" - "2.7" install: - if [[ $TRAVIS_PYTHON_VERSION == '2.7' ]]; then pip install configparser; fi # command to run tests script: py.test entrypoints-0.2.3/LICENSE000066400000000000000000000021121311622627500151200ustar00rootroot00000000000000The MIT License (MIT) Copyright (c) 2015 Thomas Kluyver and contributors Permission is hereby granted, free of charge, to any person obtaining a copy of this software and associated documentation files (the "Software"), to deal in the Software without restriction, including without limitation the rights to use, copy, modify, merge, publish, distribute, sublicense, and/or sell copies of the Software, and to permit persons to whom the Software is furnished to do so, subject to the following conditions: The above copyright notice and this permission notice shall be included in all copies or substantial portions of the Software. THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE. entrypoints-0.2.3/doc/000077500000000000000000000000001311622627500146645ustar00rootroot00000000000000entrypoints-0.2.3/doc/Makefile000066400000000000000000000164051311622627500163320ustar00rootroot00000000000000# Makefile for Sphinx documentation # # You can set these variables from the command line. SPHINXOPTS = SPHINXBUILD = sphinx-build PAPER = BUILDDIR = _build # User-friendly check for sphinx-build ifeq ($(shell which $(SPHINXBUILD) >/dev/null 2>&1; echo $$?), 1) $(error The '$(SPHINXBUILD)' command was not found. Make sure you have Sphinx installed, then set the SPHINXBUILD environment variable to point to the full path of the '$(SPHINXBUILD)' executable. Alternatively you can add the directory with the executable to your PATH. If you don't have Sphinx installed, grab it from http://sphinx-doc.org/) endif # Internal variables. PAPEROPT_a4 = -D latex_paper_size=a4 PAPEROPT_letter = -D latex_paper_size=letter ALLSPHINXOPTS = -d $(BUILDDIR)/doctrees $(PAPEROPT_$(PAPER)) $(SPHINXOPTS) . # the i18n builder cannot share the environment and doctrees with the others I18NSPHINXOPTS = $(PAPEROPT_$(PAPER)) $(SPHINXOPTS) . .PHONY: help clean html dirhtml singlehtml pickle json htmlhelp qthelp devhelp epub latex latexpdf text man changes linkcheck doctest coverage gettext help: @echo "Please use \`make ' where is one of" @echo " html to make standalone HTML files" @echo " dirhtml to make HTML files named index.html in directories" @echo " singlehtml to make a single large HTML file" @echo " pickle to make pickle files" @echo " json to make JSON files" @echo " htmlhelp to make HTML files and a HTML help project" @echo " qthelp to make HTML files and a qthelp project" @echo " applehelp to make an Apple Help Book" @echo " devhelp to make HTML files and a Devhelp project" @echo " epub to make an epub" @echo " latex to make LaTeX files, you can set PAPER=a4 or PAPER=letter" @echo " latexpdf to make LaTeX files and run them through pdflatex" @echo " latexpdfja to make LaTeX files and run them through platex/dvipdfmx" @echo " text to make text files" @echo " man to make manual pages" @echo " texinfo to make Texinfo files" @echo " info to make Texinfo files and run them through makeinfo" @echo " gettext to make PO message catalogs" @echo " changes to make an overview of all changed/added/deprecated items" @echo " xml to make Docutils-native XML files" @echo " pseudoxml to make pseudoxml-XML files for display purposes" @echo " linkcheck to check all external links for integrity" @echo " doctest to run all doctests embedded in the documentation (if enabled)" @echo " coverage to run coverage check of the documentation (if enabled)" clean: rm -rf $(BUILDDIR)/* html: $(SPHINXBUILD) -b html $(ALLSPHINXOPTS) $(BUILDDIR)/html @echo @echo "Build finished. The HTML pages are in $(BUILDDIR)/html." dirhtml: $(SPHINXBUILD) -b dirhtml $(ALLSPHINXOPTS) $(BUILDDIR)/dirhtml @echo @echo "Build finished. The HTML pages are in $(BUILDDIR)/dirhtml." singlehtml: $(SPHINXBUILD) -b singlehtml $(ALLSPHINXOPTS) $(BUILDDIR)/singlehtml @echo @echo "Build finished. The HTML page is in $(BUILDDIR)/singlehtml." pickle: $(SPHINXBUILD) -b pickle $(ALLSPHINXOPTS) $(BUILDDIR)/pickle @echo @echo "Build finished; now you can process the pickle files." json: $(SPHINXBUILD) -b json $(ALLSPHINXOPTS) $(BUILDDIR)/json @echo @echo "Build finished; now you can process the JSON files." htmlhelp: $(SPHINXBUILD) -b htmlhelp $(ALLSPHINXOPTS) $(BUILDDIR)/htmlhelp @echo @echo "Build finished; now you can run HTML Help Workshop with the" \ ".hhp project file in $(BUILDDIR)/htmlhelp." qthelp: $(SPHINXBUILD) -b qthelp $(ALLSPHINXOPTS) $(BUILDDIR)/qthelp @echo @echo "Build finished; now you can run "qcollectiongenerator" with the" \ ".qhcp project file in $(BUILDDIR)/qthelp, like this:" @echo "# qcollectiongenerator $(BUILDDIR)/qthelp/entrypoints.qhcp" @echo "To view the help file:" @echo "# assistant -collectionFile $(BUILDDIR)/qthelp/entrypoints.qhc" applehelp: $(SPHINXBUILD) -b applehelp $(ALLSPHINXOPTS) $(BUILDDIR)/applehelp @echo @echo "Build finished. The help book is in $(BUILDDIR)/applehelp." @echo "N.B. You won't be able to view it unless you put it in" \ "~/Library/Documentation/Help or install it in your application" \ "bundle." devhelp: $(SPHINXBUILD) -b devhelp $(ALLSPHINXOPTS) $(BUILDDIR)/devhelp @echo @echo "Build finished." @echo "To view the help file:" @echo "# mkdir -p $$HOME/.local/share/devhelp/entrypoints" @echo "# ln -s $(BUILDDIR)/devhelp $$HOME/.local/share/devhelp/entrypoints" @echo "# devhelp" epub: $(SPHINXBUILD) -b epub $(ALLSPHINXOPTS) $(BUILDDIR)/epub @echo @echo "Build finished. The epub file is in $(BUILDDIR)/epub." latex: $(SPHINXBUILD) -b latex $(ALLSPHINXOPTS) $(BUILDDIR)/latex @echo @echo "Build finished; the LaTeX files are in $(BUILDDIR)/latex." @echo "Run \`make' in that directory to run these through (pdf)latex" \ "(use \`make latexpdf' here to do that automatically)." latexpdf: $(SPHINXBUILD) -b latex $(ALLSPHINXOPTS) $(BUILDDIR)/latex @echo "Running LaTeX files through pdflatex..." $(MAKE) -C $(BUILDDIR)/latex all-pdf @echo "pdflatex finished; the PDF files are in $(BUILDDIR)/latex." latexpdfja: $(SPHINXBUILD) -b latex $(ALLSPHINXOPTS) $(BUILDDIR)/latex @echo "Running LaTeX files through platex and dvipdfmx..." $(MAKE) -C $(BUILDDIR)/latex all-pdf-ja @echo "pdflatex finished; the PDF files are in $(BUILDDIR)/latex." text: $(SPHINXBUILD) -b text $(ALLSPHINXOPTS) $(BUILDDIR)/text @echo @echo "Build finished. The text files are in $(BUILDDIR)/text." man: $(SPHINXBUILD) -b man $(ALLSPHINXOPTS) $(BUILDDIR)/man @echo @echo "Build finished. The manual pages are in $(BUILDDIR)/man." texinfo: $(SPHINXBUILD) -b texinfo $(ALLSPHINXOPTS) $(BUILDDIR)/texinfo @echo @echo "Build finished. The Texinfo files are in $(BUILDDIR)/texinfo." @echo "Run \`make' in that directory to run these through makeinfo" \ "(use \`make info' here to do that automatically)." info: $(SPHINXBUILD) -b texinfo $(ALLSPHINXOPTS) $(BUILDDIR)/texinfo @echo "Running Texinfo files through makeinfo..." make -C $(BUILDDIR)/texinfo info @echo "makeinfo finished; the Info files are in $(BUILDDIR)/texinfo." gettext: $(SPHINXBUILD) -b gettext $(I18NSPHINXOPTS) $(BUILDDIR)/locale @echo @echo "Build finished. The message catalogs are in $(BUILDDIR)/locale." changes: $(SPHINXBUILD) -b changes $(ALLSPHINXOPTS) $(BUILDDIR)/changes @echo @echo "The overview file is in $(BUILDDIR)/changes." linkcheck: $(SPHINXBUILD) -b linkcheck $(ALLSPHINXOPTS) $(BUILDDIR)/linkcheck @echo @echo "Link check complete; look for any errors in the above output " \ "or in $(BUILDDIR)/linkcheck/output.txt." doctest: $(SPHINXBUILD) -b doctest $(ALLSPHINXOPTS) $(BUILDDIR)/doctest @echo "Testing of doctests in the sources finished, look at the " \ "results in $(BUILDDIR)/doctest/output.txt." coverage: $(SPHINXBUILD) -b coverage $(ALLSPHINXOPTS) $(BUILDDIR)/coverage @echo "Testing of coverage in the sources finished, look at the " \ "results in $(BUILDDIR)/coverage/python.txt." xml: $(SPHINXBUILD) -b xml $(ALLSPHINXOPTS) $(BUILDDIR)/xml @echo @echo "Build finished. The XML files are in $(BUILDDIR)/xml." pseudoxml: $(SPHINXBUILD) -b pseudoxml $(ALLSPHINXOPTS) $(BUILDDIR)/pseudoxml @echo @echo "Build finished. The pseudo-XML files are in $(BUILDDIR)/pseudoxml." entrypoints-0.2.3/doc/api.rst000066400000000000000000000024111311622627500161650ustar00rootroot00000000000000entrypoints API =============== .. module:: entrypoints High-level API -------------- .. autofunction:: get_single .. autofunction:: get_group_named .. autofunction:: get_group_all These functions will all use ``sys.path`` by default if you don't specify the *path* parameter. This is normally what you want, so you shouldn't need to pass *path*. EntryPoint objects ------------------ .. autoclass:: EntryPoint .. attribute:: name The name identifying this entry point .. attribute:: module_name The name of an importable module to which it refers .. attribute:: object_name The dotted object name within the module, or *None* if the entry point refers to a module itselfs. .. attribute:: extras Extra setuptools features related to this entry point as a list, or *None* .. attribute:: distribution The distribution which advertised this entry point - a :class:`Distribution` instance or None .. automethod:: load .. automethod:: from_string .. autoclass:: Distribution .. attribute:: name The name of this distribution .. attribute:: version The version of this distribution, as a string Exceptions ---------- .. autoexception:: BadEntryPoint .. autoexception:: NoSuchEntryPoint entrypoints-0.2.3/doc/conf.py000066400000000000000000000223241311622627500161660ustar00rootroot00000000000000#!/usr/bin/env python3 # -*- coding: utf-8 -*- # # entrypoints documentation build configuration file, created by # sphinx-quickstart on Fri May 8 11:50:43 2015. # # This file is execfile()d with the current directory set to its # containing dir. # # Note that not all possible configuration values are present in this # autogenerated file. # # All configuration values have a default; values that are commented out # serve to show the default. import sys import os import shlex # If extensions (or modules to document with autodoc) are in another directory, # add these directories to sys.path here. If the directory is relative to the # documentation root, use os.path.abspath to make it absolute, like shown here. sys.path.insert(0, os.path.abspath('..')) # -- General configuration ------------------------------------------------ # If your documentation needs a minimal Sphinx version, state it here. #needs_sphinx = '1.0' # Add any Sphinx extension module names here, as strings. They can be # extensions coming with Sphinx (named 'sphinx.ext.*') or your custom # ones. extensions = [ 'sphinx.ext.autodoc', 'sphinx.ext.intersphinx', ] # Add any paths that contain templates here, relative to this directory. templates_path = ['_templates'] # The suffix(es) of source filenames. # You can specify multiple suffix as a list of string: # source_suffix = ['.rst', '.md'] source_suffix = '.rst' # The encoding of source files. #source_encoding = 'utf-8-sig' # The master toctree document. master_doc = 'index' # General information about the project. project = 'entrypoints' copyright = '2015, Thomas Kluyver' author = 'Thomas Kluyver' # The version info for the project you're documenting, acts as replacement for # |version| and |release|, also used in various other places throughout the # built documents. # # The short X.Y version. version = '0.2' # The full version, including alpha/beta/rc tags. release = version + '.3' # The language for content autogenerated by Sphinx. Refer to documentation # for a list of supported languages. # # This is also used if you do content translation via gettext catalogs. # Usually you set "language" from the command line for these cases. language = None # There are two options for replacing |today|: either, you set today to some # non-false value, then it is used: #today = '' # Else, today_fmt is used as the format for a strftime call. #today_fmt = '%B %d, %Y' # List of patterns, relative to source directory, that match files and # directories to ignore when looking for source files. exclude_patterns = ['_build'] # The reST default role (used for this markup: `text`) to use for all # documents. #default_role = None # If true, '()' will be appended to :func: etc. cross-reference text. #add_function_parentheses = True # If true, the current module name will be prepended to all description # unit titles (such as .. function::). #add_module_names = True # If true, sectionauthor and moduleauthor directives will be shown in the # output. They are ignored by default. #show_authors = False # The name of the Pygments (syntax highlighting) style to use. pygments_style = 'sphinx' # A list of ignored prefixes for module index sorting. #modindex_common_prefix = [] # If true, keep warnings as "system message" paragraphs in the built documents. #keep_warnings = False # If true, `todo` and `todoList` produce output, else they produce nothing. todo_include_todos = False # -- Options for HTML output ---------------------------------------------- # The theme to use for HTML and HTML Help pages. See the documentation for # a list of builtin themes. # html_theme = 'alabaster' # Theme options are theme-specific and customize the look and feel of a theme # further. For a list of options available for each theme, see the # documentation. #html_theme_options = {} # Add any paths that contain custom themes here, relative to this directory. #html_theme_path = [] # The name for this set of Sphinx documents. If None, it defaults to # " v documentation". #html_title = None # A shorter title for the navigation bar. Default is the same as html_title. #html_short_title = None # The name of an image file (relative to this directory) to place at the top # of the sidebar. #html_logo = None # The name of an image file (within the static path) to use as favicon of the # docs. This file should be a Windows icon file (.ico) being 16x16 or 32x32 # pixels large. #html_favicon = None # Add any paths that contain custom static files (such as style sheets) here, # relative to this directory. They are copied after the builtin static files, # so a file named "default.css" will overwrite the builtin "default.css". html_static_path = ['_static'] # Add any extra paths that contain custom files (such as robots.txt or # .htaccess) here, relative to this directory. These files are copied # directly to the root of the documentation. #html_extra_path = [] # If not '', a 'Last updated on:' timestamp is inserted at every page bottom, # using the given strftime format. #html_last_updated_fmt = '%b %d, %Y' # If true, SmartyPants will be used to convert quotes and dashes to # typographically correct entities. #html_use_smartypants = True # Custom sidebar templates, maps document names to template names. #html_sidebars = {} # Additional templates that should be rendered to pages, maps page names to # template names. #html_additional_pages = {} # If false, no module index is generated. #html_domain_indices = True # If false, no index is generated. #html_use_index = True # If true, the index is split into individual pages for each letter. #html_split_index = False # If true, links to the reST sources are added to the pages. #html_show_sourcelink = True # If true, "Created using Sphinx" is shown in the HTML footer. Default is True. #html_show_sphinx = True # If true, "(C) Copyright ..." is shown in the HTML footer. Default is True. #html_show_copyright = True # If true, an OpenSearch description file will be output, and all pages will # contain a tag referring to it. The value of this option must be the # base URL from which the finished HTML is served. #html_use_opensearch = '' # This is the file name suffix for HTML files (e.g. ".xhtml"). #html_file_suffix = None # Language to be used for generating the HTML full-text search index. # Sphinx supports the following languages: # 'da', 'de', 'en', 'es', 'fi', 'fr', 'h', 'it', 'ja' # 'nl', 'no', 'pt', 'ro', 'r', 'sv', 'tr' #html_search_language = 'en' # A dictionary with options for the search language support, empty by default. # Now only 'ja' uses this config value #html_search_options = {'type': 'default'} # The name of a javascript file (relative to the configuration directory) that # implements a search results scorer. If empty, the default will be used. #html_search_scorer = 'scorer.js' # Output file base name for HTML help builder. htmlhelp_basename = 'entrypointsdoc' # -- Options for LaTeX output --------------------------------------------- latex_elements = { # The paper size ('letterpaper' or 'a4paper'). #'papersize': 'letterpaper', # The font size ('10pt', '11pt' or '12pt'). #'pointsize': '10pt', # Additional stuff for the LaTeX preamble. #'preamble': '', # Latex figure (float) alignment #'figure_align': 'htbp', } # Grouping the document tree into LaTeX files. List of tuples # (source start file, target name, title, # author, documentclass [howto, manual, or own class]). latex_documents = [ (master_doc, 'entrypoints.tex', 'entrypoints Documentation', 'Thomas Kluyver', 'manual'), ] # The name of an image file (relative to this directory) to place at the top of # the title page. #latex_logo = None # For "manual" documents, if this is true, then toplevel headings are parts, # not chapters. #latex_use_parts = False # If true, show page references after internal links. #latex_show_pagerefs = False # If true, show URL addresses after external links. #latex_show_urls = False # Documents to append as an appendix to all manuals. #latex_appendices = [] # If false, no module index is generated. #latex_domain_indices = True # -- Options for manual page output --------------------------------------- # One entry per manual page. List of tuples # (source start file, name, description, authors, manual section). man_pages = [ (master_doc, 'entrypoints', 'entrypoints Documentation', [author], 1) ] # If true, show URL addresses after external links. #man_show_urls = False # -- Options for Texinfo output ------------------------------------------- # Grouping the document tree into Texinfo files. List of tuples # (source start file, target name, title, author, # dir menu entry, description, category) texinfo_documents = [ (master_doc, 'entrypoints', 'entrypoints Documentation', author, 'entrypoints', 'One line description of project.', 'Miscellaneous'), ] # Documents to append as an appendix to all manuals. #texinfo_appendices = [] # If false, no module index is generated. #texinfo_domain_indices = True # How to display URL addresses: 'footnote', 'no', or 'inline'. #texinfo_show_urls = 'footnote' # If true, do not generate a @detailmenu in the "Top" node's menu. #texinfo_no_detailmenu = False # Example configuration for intersphinx: refer to the Python standard library. intersphinx_mapping = {'https://docs.python.org/': None} entrypoints-0.2.3/doc/index.rst000066400000000000000000000016611311622627500165310ustar00rootroot00000000000000entrypoints |version| ===================== Entry points are a way for Python packages to advertise objects with some common interface. The most common examples are ``console_scripts`` entry points, which define shell commands by identifying a Python function to run. *Groups* of entry points, such as ``console_scripts``, point to objects with similar interfaces. An application might use a group to find its plugins, or multiple groups if it has different kinds of plugins. The **entrypoints** module contains functions to find and load entry points. You can install it from PyPI with ``pip install entrypoints``. To advertise entry points when distributing a package, see `entry_points in the Python Packaging User Guide `_. Contents: .. toctree:: :maxdepth: 2 api Indices and tables ================== * :ref:`genindex` * :ref:`modindex` * :ref:`search` entrypoints-0.2.3/entrypoints.py000066400000000000000000000155251311622627500170770ustar00rootroot00000000000000"""Discover and load entry points from installed packages.""" # Copyright (c) Thomas Kluyver and contributors # Distributed under the terms of the MIT license; see LICENSE file. from contextlib import contextmanager import glob from importlib import import_module import io import itertools import os.path as osp import re import sys import warnings import zipfile if sys.version_info[0] >= 3: import configparser else: from backports import configparser entry_point_pattern = re.compile(r""" (?P\w+(\.\w+)*) (:(?P\w+(\.\w+)*))? \s* (\[(?P.+)\])? $ """, re.VERBOSE) __version__ = '0.2.3' class BadEntryPoint(Exception): """Raised when an entry point can't be parsed. """ def __init__(self, epstr): self.epstr = epstr def __str__(self): return "Couldn't parse entry point spec: %r" % self.epstr @staticmethod @contextmanager def err_to_warnings(): try: yield except BadEntryPoint as e: warnings.warn(str(e)) class NoSuchEntryPoint(Exception): """Raised by :func:`get_single` when no matching entry point is found.""" def __init__(self, group, name): self.group = group self.name = name def __str__(self): return "No {!r} entry point found in group {!r}".format(self.name, self.group) class CaseSensitiveConfigParser(configparser.ConfigParser): optionxform = staticmethod(str) class EntryPoint(object): def __init__(self, name, module_name, object_name, extras=None, distro=None): self.name = name self.module_name = module_name self.object_name = object_name self.extras = extras self.distro = distro def __repr__(self): return "EntryPoint(%r, %r, %r, %r)" % \ (self.name, self.module_name, self.object_name, self.distro) def load(self): """Load the object to which this entry point refers. """ mod = import_module(self.module_name) obj = mod if self.object_name: for attr in self.object_name.split('.'): obj = getattr(obj, attr) return obj @classmethod def from_string(cls, epstr, name, distro=None): """Parse an entry point from the syntax in entry_points.txt :param str epstr: The entry point string (not including 'name =') :param str name: The name of this entry point :param Distribution distro: The distribution in which the entry point was found :rtype: EntryPoint :raises BadEntryPoint: if *epstr* can't be parsed as an entry point. """ m = entry_point_pattern.match(epstr) if m: mod, obj, extras = m.group('modulename', 'objectname', 'extras') if extras is not None: extras = re.split(',\s*', extras) return cls(name, mod, obj, extras, distro) else: raise BadEntryPoint(epstr) class Distribution(object): def __init__(self, name, version): self.name = name self.version = version def __repr__(self): return "Distribution(%r, %r)" % (self.name, self.version) def iter_files_distros(path=None, repeated_distro='first'): if path is None: path = sys.path # Distributions found earlier in path will shadow those with the same name # found later. If these distributions used different module names, it may # actually be possible to import both, but in most cases this shadowing # will be correct. distro_names_seen = set() for folder in path: if folder.rstrip('/\\').endswith('.egg'): # Gah, eggs egg_name = osp.basename(folder) if '-' in egg_name: distro = Distribution(*egg_name.split('-')[:2]) if (repeated_distro == 'first') \ and (distro.name in distro_names_seen): continue distro_names_seen.add(distro.name) else: distro = None if osp.isdir(folder): ep_path = osp.join(folder, 'EGG-INFO', 'entry_points.txt') if osp.isfile(ep_path): cp = CaseSensitiveConfigParser() cp.read(ep_path) yield cp, distro elif zipfile.is_zipfile(folder): z = zipfile.ZipFile(folder) try: info = z.getinfo('EGG-INFO/entry_points.txt') except KeyError: continue cp = CaseSensitiveConfigParser() with z.open(info) as f: fu = io.TextIOWrapper(f) cp.read_file(fu, source=osp.join(folder, 'EGG-INFO', 'entry_points.txt')) yield cp, distro for path in itertools.chain( glob.iglob(osp.join(folder, '*.dist-info', 'entry_points.txt')), glob.iglob(osp.join(folder, '*.egg-info', 'entry_points.txt')) ): distro_name_version = osp.splitext(osp.basename(osp.dirname(path)))[0] if '-' in distro_name_version: distro = Distribution(*distro_name_version.split('-', 1)) if (repeated_distro == 'first') \ and (distro.name in distro_names_seen): continue distro_names_seen.add(distro.name) else: distro = None cp = CaseSensitiveConfigParser() cp.read(path) yield cp, distro def get_single(group, name, path=None): """Find a single entry point. Returns an :class:`EntryPoint` object, or raises :exc:`NoSuchEntryPoint` if no match is found. """ for config, distro in iter_files_distros(path=path): if (group in config) and (name in config[group]): epstr = config[group][name] with BadEntryPoint.err_to_warnings(): return EntryPoint.from_string(epstr, name, distro) raise NoSuchEntryPoint(group, name) def get_group_named(group, path=None): """Find a group of entry points with unique names. Returns a dictionary of names to :class:`EntryPoint` objects. """ result = {} for ep in get_group_all(group, path=path): if ep.name not in result: result[ep.name] = ep return result def get_group_all(group, path=None): """Find all entry points in a group. Returns a list of :class:`EntryPoint` objects. """ result = [] for config, distro in iter_files_distros(path=path): if group in config: for name, epstr in config[group].items(): with BadEntryPoint.err_to_warnings(): result.append(EntryPoint.from_string(epstr, name, distro)) return result if __name__ == '__main__': import pprint pprint.pprint(get_group_all('console_scripts')) entrypoints-0.2.3/flit.ini000066400000000000000000000004271311622627500155610ustar00rootroot00000000000000[metadata] module = entrypoints author = Thomas Kluyver author-email = thomas@kluyver.me.uk home-page = https://github.com/takluyver/entrypoints classifiers = License :: OSI Approved :: MIT License requires-python = >=2.7 requires = configparser (>=3.5); python_version == '2.7' entrypoints-0.2.3/tests/000077500000000000000000000000001311622627500152615ustar00rootroot00000000000000entrypoints-0.2.3/tests/__init__.py000066400000000000000000000000001311622627500173600ustar00rootroot00000000000000entrypoints-0.2.3/tests/samples/000077500000000000000000000000001311622627500167255ustar00rootroot00000000000000entrypoints-0.2.3/tests/samples/packages1/000077500000000000000000000000001311622627500205645ustar00rootroot00000000000000entrypoints-0.2.3/tests/samples/packages1/baz-0.3.egg/000077500000000000000000000000001311622627500223775ustar00rootroot00000000000000entrypoints-0.2.3/tests/samples/packages1/baz-0.3.egg/EGG-INFO/000077500000000000000000000000001311622627500235325ustar00rootroot00000000000000entrypoints-0.2.3/tests/samples/packages1/baz-0.3.egg/EGG-INFO/entry_points.txt000066400000000000000000000000431311622627500270250ustar00rootroot00000000000000[entrypoints.test1] rew = baz:init entrypoints-0.2.3/tests/samples/packages1/foo-0.1.dist-info/000077500000000000000000000000001311622627500235365ustar00rootroot00000000000000entrypoints-0.2.3/tests/samples/packages1/foo-0.1.dist-info/entry_points.txt000066400000000000000000000003111311622627500270270ustar00rootroot00000000000000[entrypoints.test1] abc = foo:abc [blogtool.parsers] .rst = some.nested.module:SomeClass.some_classmethod [reST] [test.case_sensitive] Ptangle = pweave.scripts:tangle ptangle = pweave.scripts:tangle entrypoints-0.2.3/tests/samples/packages2/000077500000000000000000000000001311622627500205655ustar00rootroot00000000000000entrypoints-0.2.3/tests/samples/packages2/bar-0.2.egg-info/000077500000000000000000000000001311622627500233205ustar00rootroot00000000000000entrypoints-0.2.3/tests/samples/packages2/bar-0.2.egg-info/entry_points.txt000066400000000000000000000000611311622627500266130ustar00rootroot00000000000000[entrypoints.test1] opo = bar:main abc = bar:abc entrypoints-0.2.3/tests/samples/packages2/foo-0.1.1.dist-info/000077500000000000000000000000001311622627500236765ustar00rootroot00000000000000entrypoints-0.2.3/tests/samples/packages2/foo-0.1.1.dist-info/entry_points.txt000066400000000000000000000002411311622627500271710ustar00rootroot00000000000000[entrypoints.test1] dontseeme = invisible # This shouldn't be seen, because another foo distribution is found # in packages1, which is before this on the path. entrypoints-0.2.3/tests/samples/packages2/qux-0.4.egg000066400000000000000000000006061311622627500223670ustar00rootroot00000000000000PK ZF EGG-INFO/UT REUEUux PK ZF,,EGG-INFO/entry_points.txtUT QEUEUux [entrypoints.test1] njn = qux.extn:Njn.load PK ZF AEGG-INFO/UTREUux PK ZF,,CEGG-INFO/entry_points.txtUTQEUux PKentrypoints-0.2.3/tests/samples/packages2/qux-0.4.egg.unpacked/000077500000000000000000000000001311622627500242335ustar00rootroot00000000000000entrypoints-0.2.3/tests/samples/packages2/qux-0.4.egg.unpacked/EGG-INFO/000077500000000000000000000000001311622627500253665ustar00rootroot00000000000000entrypoints-0.2.3/tests/samples/packages2/qux-0.4.egg.unpacked/EGG-INFO/entry_points.txt000066400000000000000000000000541311622627500306630ustar00rootroot00000000000000[entrypoints.test1] njn = qux.extn:Njn.load entrypoints-0.2.3/tests/samples/packages3/000077500000000000000000000000001311622627500205665ustar00rootroot00000000000000entrypoints-0.2.3/tests/samples/packages3/foo-0.1.dist-info/000077500000000000000000000000001311622627500235405ustar00rootroot00000000000000entrypoints-0.2.3/tests/samples/packages3/foo-0.1.dist-info/entry_points.txt000066400000000000000000000000701311622627500270330ustar00rootroot00000000000000[entrypoints.test1] abc = foo:abc bad = this won't work entrypoints-0.2.3/tests/test_entrypoints.py000066400000000000000000000060661311622627500213000ustar00rootroot00000000000000# Copyright (c) Thomas Kluyver and contributors # Distributed under the terms of the MIT license; see LICENSE file. import os.path as osp import pytest import warnings import entrypoints samples_dir = osp.join(osp.dirname(__file__), 'samples') sample_path = [ osp.join(samples_dir, 'packages1'), osp.join(samples_dir, 'packages1', 'baz-0.3.egg'), osp.join(samples_dir, 'packages2'), osp.join(samples_dir, 'packages2', 'qux-0.4.egg'), ] def test_get_group_all(): group = entrypoints.get_group_all('entrypoints.test1', sample_path) print(group) assert len(group) == 5 assert set(ep.name for ep in group) == {'abc', 'rew', 'opo', 'njn'} def test_get_group_named(): group = entrypoints.get_group_named('entrypoints.test1', sample_path) print(group) assert len(group) == 4 assert group['abc'].module_name == 'foo' assert group['abc'].object_name == 'abc' def test_get_single(): ep = entrypoints.get_single('entrypoints.test1', 'abc', sample_path) assert ep.module_name == 'foo' assert ep.object_name == 'abc' ep2 = entrypoints.get_single('entrypoints.test1', 'njn', sample_path) assert ep.module_name == 'foo' assert ep.object_name == 'abc' def test_dot_prefix(): ep = entrypoints.get_single('blogtool.parsers', '.rst', sample_path) assert ep.object_name == 'SomeClass.some_classmethod' assert ep.extras == ['reST'] group = entrypoints.get_group_named('blogtool.parsers', sample_path) assert set(group.keys()) == {'.rst'} def test_case_sensitive(): group = entrypoints.get_group_named('test.case_sensitive', sample_path) assert set(group.keys()) == {'Ptangle', 'ptangle'} def test_load(): ep = entrypoints.EntryPoint('get_ep', 'entrypoints', 'get_single', None) obj = ep.load() assert obj is entrypoints.get_single # The object part is optional (e.g. pytest plugins use just a module ref) ep = entrypoints.EntryPoint('ep_mod', 'entrypoints', None) obj = ep.load() assert obj is entrypoints def test_bad(): bad_path = [osp.join(samples_dir, 'packages3')] with warnings.catch_warnings(record=True) as w: group = entrypoints.get_group_named('entrypoints.test1', bad_path) assert 'bad' not in group assert len(w) == 1 with warnings.catch_warnings(record=True) as w2, \ pytest.raises(entrypoints.NoSuchEntryPoint): ep = entrypoints.get_single('entrypoints.test1', 'bad') assert len(w) == 1 def test_missing(): with pytest.raises(entrypoints.NoSuchEntryPoint) as ec: entrypoints.get_single('no.such.group', 'no_such_name', sample_path) assert ec.value.group == 'no.such.group' assert ec.value.name == 'no_such_name' def test_parse(): ep = entrypoints.EntryPoint.from_string( 'some.module:some.attr [extra1,extra2]', 'foo' ) assert ep.module_name == 'some.module' assert ep.object_name == 'some.attr' assert ep.extras == ['extra1', 'extra2'] def test_parse_bad(): with pytest.raises(entrypoints.BadEntryPoint): entrypoints.EntryPoint.from_string("this won't work", 'foo')