version.py 3.5 KB

123456789101112131415161718192021222324252627282930313233343536373839404142434445464748495051525354555657585960616263646566676869707172737475767778798081828384858687888990919293949596979899100101102103104105106107108109110111112113114115116117118119120121
  1. import datetime
  2. import functools
  3. import os
  4. import subprocess
  5. import sys
  6. from django.utils.regex_helper import _lazy_re_compile
  7. # Private, stable API for detecting the Python version. PYXY means "Python X.Y
  8. # or later". So that third-party apps can use these values, each constant
  9. # should remain as long as the oldest supported Django version supports that
  10. # Python version.
  11. PY36 = sys.version_info >= (3, 6)
  12. PY37 = sys.version_info >= (3, 7)
  13. PY38 = sys.version_info >= (3, 8)
  14. PY39 = sys.version_info >= (3, 9)
  15. PY310 = sys.version_info >= (3, 10)
  16. PY311 = sys.version_info >= (3, 11)
  17. PY312 = sys.version_info >= (3, 12)
  18. def get_version(version=None):
  19. """Return a PEP 440-compliant version number from VERSION."""
  20. version = get_complete_version(version)
  21. # Now build the two parts of the version number:
  22. # main = X.Y[.Z]
  23. # sub = .devN - for pre-alpha releases
  24. # | {a|b|rc}N - for alpha, beta, and rc releases
  25. main = get_main_version(version)
  26. sub = ""
  27. if version[3] == "alpha" and version[4] == 0:
  28. git_changeset = get_git_changeset()
  29. if git_changeset:
  30. sub = ".dev%s" % git_changeset
  31. elif version[3] != "final":
  32. mapping = {"alpha": "a", "beta": "b", "rc": "rc"}
  33. sub = mapping[version[3]] + str(version[4])
  34. return main + sub
  35. def get_main_version(version=None):
  36. """Return main version (X.Y[.Z]) from VERSION."""
  37. version = get_complete_version(version)
  38. parts = 2 if version[2] == 0 else 3
  39. return ".".join(str(x) for x in version[:parts])
  40. def get_complete_version(version=None):
  41. """
  42. Return a tuple of the django version. If version argument is non-empty,
  43. check for correctness of the tuple provided.
  44. """
  45. if version is None:
  46. from django import VERSION as version
  47. else:
  48. assert len(version) == 5
  49. assert version[3] in ("alpha", "beta", "rc", "final")
  50. return version
  51. def get_docs_version(version=None):
  52. version = get_complete_version(version)
  53. if version[3] != "final":
  54. return "dev"
  55. else:
  56. return "%d.%d" % version[:2]
  57. @functools.lru_cache
  58. def get_git_changeset():
  59. """Return a numeric identifier of the latest git changeset.
  60. The result is the UTC timestamp of the changeset in YYYYMMDDHHMMSS format.
  61. This value isn't guaranteed to be unique, but collisions are very unlikely,
  62. so it's sufficient for generating the development version numbers.
  63. """
  64. # Repository may not be found if __file__ is undefined, e.g. in a frozen
  65. # module.
  66. if "__file__" not in globals():
  67. return None
  68. repo_dir = os.path.dirname(os.path.dirname(os.path.abspath(__file__)))
  69. git_log = subprocess.run(
  70. "git log --pretty=format:%ct --quiet -1 HEAD",
  71. capture_output=True,
  72. shell=True,
  73. cwd=repo_dir,
  74. text=True,
  75. )
  76. timestamp = git_log.stdout
  77. tz = datetime.timezone.utc
  78. try:
  79. timestamp = datetime.datetime.fromtimestamp(int(timestamp), tz=tz)
  80. except ValueError:
  81. return None
  82. return timestamp.strftime("%Y%m%d%H%M%S")
  83. version_component_re = _lazy_re_compile(r"(\d+|[a-z]+|\.)")
  84. def get_version_tuple(version):
  85. """
  86. Return a tuple of version numbers (e.g. (1, 2, 3)) from the version
  87. string (e.g. '1.2.3').
  88. """
  89. version_numbers = []
  90. for item in version_component_re.split(version):
  91. if item and item != ".":
  92. try:
  93. component = int(item)
  94. except ValueError:
  95. break
  96. else:
  97. version_numbers.append(component)
  98. return tuple(version_numbers)