namespaces.py 3.0 KB

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