show.py 5.9 KB

123456789101112131415161718192021222324252627282930313233343536373839404142434445464748495051525354555657585960616263646566676869707172737475767778798081828384858687888990919293949596979899100101102103104105106107108109110111112113114115116117118119120121122123124125126127128129130131132133134135136137138139140141142143144145146147148149150151152153154
  1. from __future__ import absolute_import
  2. from email.parser import FeedParser
  3. import logging
  4. import os
  5. from pip.basecommand import Command
  6. from pip.status_codes import SUCCESS, ERROR
  7. from pip._vendor import pkg_resources
  8. from pip._vendor.packaging.utils import canonicalize_name
  9. logger = logging.getLogger(__name__)
  10. class ShowCommand(Command):
  11. """Show information about one or more installed packages."""
  12. name = 'show'
  13. usage = """
  14. %prog [options] <package> ..."""
  15. summary = 'Show information about installed packages.'
  16. def __init__(self, *args, **kw):
  17. super(ShowCommand, self).__init__(*args, **kw)
  18. self.cmd_opts.add_option(
  19. '-f', '--files',
  20. dest='files',
  21. action='store_true',
  22. default=False,
  23. help='Show the full list of installed files for each package.')
  24. self.parser.insert_option_group(0, self.cmd_opts)
  25. def run(self, options, args):
  26. if not args:
  27. logger.warning('ERROR: Please provide a package name or names.')
  28. return ERROR
  29. query = args
  30. results = search_packages_info(query)
  31. if not print_results(
  32. results, list_files=options.files, verbose=options.verbose):
  33. return ERROR
  34. return SUCCESS
  35. def search_packages_info(query):
  36. """
  37. Gather details from installed distributions. Print distribution name,
  38. version, location, and installed files. Installed files requires a
  39. pip generated 'installed-files.txt' in the distributions '.egg-info'
  40. directory.
  41. """
  42. installed = {}
  43. for p in pkg_resources.working_set:
  44. installed[canonicalize_name(p.project_name)] = p
  45. query_names = [canonicalize_name(name) for name in query]
  46. for dist in [installed[pkg] for pkg in query_names if pkg in installed]:
  47. package = {
  48. 'name': dist.project_name,
  49. 'version': dist.version,
  50. 'location': dist.location,
  51. 'requires': [dep.project_name for dep in dist.requires()],
  52. }
  53. file_list = None
  54. metadata = None
  55. if isinstance(dist, pkg_resources.DistInfoDistribution):
  56. # RECORDs should be part of .dist-info metadatas
  57. if dist.has_metadata('RECORD'):
  58. lines = dist.get_metadata_lines('RECORD')
  59. paths = [l.split(',')[0] for l in lines]
  60. paths = [os.path.join(dist.location, p) for p in paths]
  61. file_list = [os.path.relpath(p, dist.location) for p in paths]
  62. if dist.has_metadata('METADATA'):
  63. metadata = dist.get_metadata('METADATA')
  64. else:
  65. # Otherwise use pip's log for .egg-info's
  66. if dist.has_metadata('installed-files.txt'):
  67. paths = dist.get_metadata_lines('installed-files.txt')
  68. paths = [os.path.join(dist.egg_info, p) for p in paths]
  69. file_list = [os.path.relpath(p, dist.location) for p in paths]
  70. if dist.has_metadata('PKG-INFO'):
  71. metadata = dist.get_metadata('PKG-INFO')
  72. if dist.has_metadata('entry_points.txt'):
  73. entry_points = dist.get_metadata_lines('entry_points.txt')
  74. package['entry_points'] = entry_points
  75. if dist.has_metadata('INSTALLER'):
  76. for line in dist.get_metadata_lines('INSTALLER'):
  77. if line.strip():
  78. package['installer'] = line.strip()
  79. break
  80. # @todo: Should pkg_resources.Distribution have a
  81. # `get_pkg_info` method?
  82. feed_parser = FeedParser()
  83. feed_parser.feed(metadata)
  84. pkg_info_dict = feed_parser.close()
  85. for key in ('metadata-version', 'summary',
  86. 'home-page', 'author', 'author-email', 'license'):
  87. package[key] = pkg_info_dict.get(key)
  88. # It looks like FeedParser cannot deal with repeated headers
  89. classifiers = []
  90. for line in metadata.splitlines():
  91. if line.startswith('Classifier: '):
  92. classifiers.append(line[len('Classifier: '):])
  93. package['classifiers'] = classifiers
  94. if file_list:
  95. package['files'] = sorted(file_list)
  96. yield package
  97. def print_results(distributions, list_files=False, verbose=False):
  98. """
  99. Print the informations from installed distributions found.
  100. """
  101. results_printed = False
  102. for i, dist in enumerate(distributions):
  103. results_printed = True
  104. if i > 0:
  105. logger.info("---")
  106. logger.info("Name: %s", dist.get('name', ''))
  107. logger.info("Version: %s", dist.get('version', ''))
  108. logger.info("Summary: %s", dist.get('summary', ''))
  109. logger.info("Home-page: %s", dist.get('home-page', ''))
  110. logger.info("Author: %s", dist.get('author', ''))
  111. logger.info("Author-email: %s", dist.get('author-email', ''))
  112. logger.info("License: %s", dist.get('license', ''))
  113. logger.info("Location: %s", dist.get('location', ''))
  114. logger.info("Requires: %s", ', '.join(dist.get('requires', [])))
  115. if verbose:
  116. logger.info("Metadata-Version: %s",
  117. dist.get('metadata-version', ''))
  118. logger.info("Installer: %s", dist.get('installer', ''))
  119. logger.info("Classifiers:")
  120. for classifier in dist.get('classifiers', []):
  121. logger.info(" %s", classifier)
  122. logger.info("Entry-points:")
  123. for entry in dist.get('entry_points', []):
  124. logger.info(" %s", entry.strip())
  125. if list_files:
  126. logger.info("Files:")
  127. for line in dist.get('files', []):
  128. logger.info(" %s", line.strip())
  129. if "files" not in dist:
  130. logger.info("Cannot locate installed-files.txt")
  131. return results_printed