autodetect.py 2.9 KB

123456789101112131415161718192021222324252627282930313233343536373839404142434445464748495051525354555657585960616263646566676869707172737475767778798081828384858687888990919293949596
  1. import os
  2. import re
  3. import warnings
  4. from pathlib import Path
  5. from requirements_detector import find_requirements
  6. from requirements_detector.detect import RequirementsNotFound
  7. from prospector import encoding
  8. from prospector.exceptions import PermissionMissing
  9. from prospector.pathutils import is_virtualenv
  10. POSSIBLE_LIBRARIES = ("django", "celery", "flask")
  11. # see http://docs.python.org/2/reference/lexical_analysis.html#identifiers
  12. _FROM_IMPORT_REGEX = re.compile(r"^\s*from ([\._a-zA-Z0-9]+) import .*$")
  13. _IMPORT_REGEX = re.compile(r"^\s*import ([\._a-zA-Z0-9]+)$")
  14. _IMPORT_MULTIPLE_REGEX = re.compile(r"^\s*import ([\._a-zA-Z0-9]+(, ){1})+")
  15. def find_from_imports(file_contents):
  16. names = set()
  17. for line in file_contents.split("\n"):
  18. match = _IMPORT_MULTIPLE_REGEX.match(line)
  19. if match:
  20. import_names = []
  21. first = match.group(1)
  22. import_names.append(first[:-2])
  23. for name in line.split(first)[1].split(","):
  24. import_names.append(name.strip())
  25. else:
  26. match = _IMPORT_REGEX.match(line) or _FROM_IMPORT_REGEX.match(line)
  27. if match is None:
  28. continue
  29. import_names = match.group(1).split(".")
  30. for import_name in import_names:
  31. if import_name in POSSIBLE_LIBRARIES:
  32. names.add(import_name)
  33. return names
  34. def find_from_path(path: Path):
  35. names = set()
  36. try:
  37. for item in path.iterdir():
  38. if item.is_dir():
  39. if is_virtualenv(item):
  40. continue
  41. names |= find_from_path(item)
  42. elif not item.is_symlink() and item.suffix == ".py":
  43. try:
  44. contents = encoding.read_py_file(item)
  45. names |= find_from_imports(contents)
  46. except encoding.CouldNotHandleEncoding as err:
  47. # TODO: this output will break output formats such as JSON
  48. warnings.warn(f"{err.path}: {err.__cause__}", ImportWarning)
  49. if len(names) == len(POSSIBLE_LIBRARIES):
  50. # don't continue on recursing, there's no point!
  51. break
  52. except PermissionError as err:
  53. raise PermissionMissing(path) from err
  54. return names
  55. def find_from_requirements(path):
  56. reqs = find_requirements(path)
  57. names = []
  58. for requirement in reqs:
  59. if requirement.name is not None and requirement.name.lower() in POSSIBLE_LIBRARIES:
  60. names.append(requirement.name.lower())
  61. return names
  62. def autodetect_libraries(path):
  63. if os.path.isfile(path):
  64. path = os.path.dirname(path)
  65. if path == "":
  66. path = "."
  67. libraries = []
  68. try:
  69. libraries = find_from_requirements(path)
  70. except RequirementsNotFound:
  71. pass
  72. if len(libraries) < len(POSSIBLE_LIBRARIES):
  73. libraries = find_from_path(path)
  74. return libraries