namespaces.py 3.0 KB

123456789101112131415161718192021222324252627282930313233343536373839404142434445464748495051525354555657585960616263646566676869707172737475767778798081828384858687888990919293949596979899100101
  1. import itertools
  2. import os
  3. from .compat import py312
  4. from distutils import log
  5. flatten = itertools.chain.from_iterable
  6. class Installer:
  7. nspkg_ext = '-nspkg.pth'
  8. def install_namespaces(self) -> None:
  9. nsp = self._get_all_ns_packages()
  10. if not nsp:
  11. return
  12. filename = self._get_nspkg_file()
  13. self.outputs.append(filename)
  14. log.info("Installing %s", filename)
  15. lines = map(self._gen_nspkg_line, nsp)
  16. with open(filename, 'wt', encoding=py312.PTH_ENCODING) as f:
  17. # Python<3.13 requires encoding="locale" instead of "utf-8"
  18. # See: python/cpython#77102
  19. f.writelines(lines)
  20. def uninstall_namespaces(self) -> None:
  21. filename = self._get_nspkg_file()
  22. if not os.path.exists(filename):
  23. return
  24. log.info("Removing %s", filename)
  25. os.remove(filename)
  26. def _get_nspkg_file(self):
  27. filename, _ = os.path.splitext(self._get_target())
  28. return filename + self.nspkg_ext
  29. def _get_target(self):
  30. return self.target
  31. _nspkg_tmpl = (
  32. "import sys, types, os",
  33. "p = os.path.join(%(root)s, *%(pth)r)",
  34. "importlib = __import__('importlib.util')",
  35. "__import__('importlib.machinery')",
  36. (
  37. "m = "
  38. "sys.modules.setdefault(%(pkg)r, "
  39. "importlib.util.module_from_spec("
  40. "importlib.machinery.PathFinder.find_spec(%(pkg)r, "
  41. "[os.path.dirname(p)])))"
  42. ),
  43. ("m = m or sys.modules.setdefault(%(pkg)r, types.ModuleType(%(pkg)r))"),
  44. "mp = (m or []) and m.__dict__.setdefault('__path__',[])",
  45. "(p not in mp) and mp.append(p)",
  46. )
  47. "lines for the namespace installer"
  48. _nspkg_tmpl_multi = ('m and setattr(sys.modules[%(parent)r], %(child)r, m)',)
  49. "additional line(s) when a parent package is indicated"
  50. def _get_root(self):
  51. return "sys._getframe(1).f_locals['sitedir']"
  52. def _gen_nspkg_line(self, pkg):
  53. pth = tuple(pkg.split('.'))
  54. root = self._get_root()
  55. tmpl_lines = self._nspkg_tmpl
  56. parent, sep, child = pkg.rpartition('.')
  57. if parent:
  58. tmpl_lines += self._nspkg_tmpl_multi
  59. return ';'.join(tmpl_lines) % locals() + '\n'
  60. def _get_all_ns_packages(self):
  61. """Return sorted list of all package namespaces"""
  62. pkgs = self.distribution.namespace_packages or []
  63. return sorted(set(flatten(map(self._pkg_names, pkgs))))
  64. @staticmethod
  65. def _pkg_names(pkg):
  66. """
  67. Given a namespace package, yield the components of that
  68. package.
  69. >>> names = Installer._pkg_names('a.b.c')
  70. >>> set(names) == set(['a', 'a.b', 'a.b.c'])
  71. True
  72. """
  73. parts = pkg.split('.')
  74. while parts:
  75. yield '.'.join(parts)
  76. parts.pop()
  77. class DevelopInstaller(Installer):
  78. def _get_root(self):
  79. return repr(str(self.egg_path))
  80. def _get_target(self):
  81. return self.egg_link