|
| 1 | +# coding: utf-8 |
| 2 | +""" |
| 3 | +Discover mkdocs entry points without pkg_resources (stdlib importlib.metadata). |
| 4 | +
|
| 5 | +Used when setuptools is not installed and ``import pkg_resources`` fails. |
| 6 | +""" |
| 7 | +from __future__ import unicode_literals |
| 8 | + |
| 9 | +import sys |
| 10 | + |
| 11 | +from importlib.metadata import distribution, entry_points, distributions |
| 12 | + |
| 13 | + |
| 14 | +def _dist_key_from_dist(dist): |
| 15 | + name = dist.metadata.get('Name', '') or getattr(dist, 'name', '') or '' |
| 16 | + part = name.split(';')[0].split(',')[0].strip() |
| 17 | + first = part.split()[0] if part else '' |
| 18 | + if first: |
| 19 | + return first.lower().replace('-', '_') |
| 20 | + return getattr(dist, 'name', 'unknown').lower().replace('-', '_') |
| 21 | + |
| 22 | + |
| 23 | +def _dist_key_for_ep(ep): |
| 24 | + for dist in distributions(): |
| 25 | + try: |
| 26 | + des = dist.entry_points |
| 27 | + except Exception: |
| 28 | + continue |
| 29 | + for cand in des: |
| 30 | + if cand.name == ep.name and cand.group == ep.group and cand.value == ep.value: |
| 31 | + return _dist_key_from_dist(dist) |
| 32 | + return 'unknown' |
| 33 | + |
| 34 | + |
| 35 | +class _CompatDist(object): |
| 36 | + __slots__ = ('key',) |
| 37 | + |
| 38 | + def __init__(self, key): |
| 39 | + self.key = key |
| 40 | + |
| 41 | + |
| 42 | +class _CompatEP(object): |
| 43 | + __slots__ = ('_ep', 'name', 'dist') |
| 44 | + |
| 45 | + def __init__(self, ep, dist_key): |
| 46 | + self._ep = ep |
| 47 | + self.name = ep.name |
| 48 | + self.dist = _CompatDist(dist_key) |
| 49 | + |
| 50 | + def load(self): |
| 51 | + return self._ep.load() |
| 52 | + |
| 53 | + |
| 54 | +def get_entry_map(dist=None, group=None): |
| 55 | + """Subset of pkg_resources.get_entry_map(dist=..., group=...).""" |
| 56 | + if dist is None or group is None: |
| 57 | + raise TypeError('dist and group are required') |
| 58 | + d = distribution(dist) |
| 59 | + dk = _dist_key_from_dist(d) |
| 60 | + out = {} |
| 61 | + for ep in d.entry_points: |
| 62 | + if ep.group == group: |
| 63 | + out[ep.name] = _CompatEP(ep, dk) |
| 64 | + return out |
| 65 | + |
| 66 | + |
| 67 | +def _entry_points_in_group(group): |
| 68 | + if sys.version_info >= (3, 10): |
| 69 | + return entry_points(group=group) |
| 70 | + eps = entry_points() |
| 71 | + if hasattr(eps, 'select'): |
| 72 | + return eps.select(group=group) |
| 73 | + try: |
| 74 | + return eps[group] |
| 75 | + except (KeyError, TypeError): |
| 76 | + return [] |
| 77 | + |
| 78 | + |
| 79 | +def iter_entry_points(group=None): |
| 80 | + """Subset of pkg_resources.iter_entry_points(group=...).""" |
| 81 | + if group is None: |
| 82 | + raise TypeError('group is required') |
| 83 | + for ep in _entry_points_in_group(group): |
| 84 | + yield _CompatEP(ep, _dist_key_for_ep(ep)) |
0 commit comments