__meta__.py 6.7 KB

123456789101112131415161718192021222324252627282930313233343536373839404142434445464748495051525354555657585960616263646566676869707172737475767778798081828384858687888990919293949596979899100101102103104105106107108109110111112113114115116117118119120121122123124125126127128129130131132133134135136137138139140141142143144145146147148149150151152153154155156157158159160161162163164165166167168169170171172173174175176177178179180181182183184185186187188189190191192193194195196
  1. """Meta related things."""
  2. from collections import namedtuple
  3. import re
  4. RE_VER = re.compile(
  5. r'''(?x)
  6. (?P<major>\d+)(?:\.(?P<minor>\d+))?(?:\.(?P<micro>\d+))?
  7. (?:(?P<type>a|b|rc)(?P<pre>\d+))?
  8. (?:\.post(?P<post>\d+))?
  9. (?:\.dev(?P<dev>\d+))?
  10. '''
  11. )
  12. REL_MAP = {
  13. ".dev": "",
  14. ".dev-alpha": "a",
  15. ".dev-beta": "b",
  16. ".dev-candidate": "rc",
  17. "alpha": "a",
  18. "beta": "b",
  19. "candidate": "rc",
  20. "final": ""
  21. }
  22. DEV_STATUS = {
  23. ".dev": "2 - Pre-Alpha",
  24. ".dev-alpha": "2 - Pre-Alpha",
  25. ".dev-beta": "2 - Pre-Alpha",
  26. ".dev-candidate": "2 - Pre-Alpha",
  27. "alpha": "3 - Alpha",
  28. "beta": "4 - Beta",
  29. "candidate": "4 - Beta",
  30. "final": "5 - Production/Stable"
  31. }
  32. PRE_REL_MAP = {"a": 'alpha', "b": 'beta', "rc": 'candidate'}
  33. class Version(namedtuple("Version", ["major", "minor", "micro", "release", "pre", "post", "dev"])):
  34. """
  35. Get the version (PEP 440).
  36. A biased approach to the PEP 440 semantic version.
  37. Provides a tuple structure which is sorted for comparisons `v1 > v2` etc.
  38. (major, minor, micro, release type, pre-release build, post-release build, development release build)
  39. Release types are named in is such a way they are comparable with ease.
  40. Accessors to check if a development, pre-release, or post-release build. Also provides accessor to get
  41. development status for setup files.
  42. How it works (currently):
  43. - You must specify a release type as either `final`, `alpha`, `beta`, or `candidate`.
  44. - To define a development release, you can use either `.dev`, `.dev-alpha`, `.dev-beta`, or `.dev-candidate`.
  45. The dot is used to ensure all development specifiers are sorted before `alpha`.
  46. You can specify a `dev` number for development builds, but do not have to as implicit development releases
  47. are allowed.
  48. - You must specify a `pre` value greater than zero if using a prerelease as this project (not PEP 440) does not
  49. allow implicit prereleases.
  50. - You can optionally set `post` to a value greater than zero to make the build a post release. While post releases
  51. are technically allowed in prereleases, it is strongly discouraged, so we are rejecting them. It should be
  52. noted that we do not allow `post0` even though PEP 440 does not restrict this. This project specifically
  53. does not allow implicit post releases.
  54. - It should be noted that we do not support epochs `1!` or local versions `+some-custom.version-1`.
  55. Acceptable version releases:
  56. ```
  57. Version(1, 0, 0, "final") 1.0
  58. Version(1, 2, 0, "final") 1.2
  59. Version(1, 2, 3, "final") 1.2.3
  60. Version(1, 2, 0, ".dev-alpha", pre=4) 1.2a4
  61. Version(1, 2, 0, ".dev-beta", pre=4) 1.2b4
  62. Version(1, 2, 0, ".dev-candidate", pre=4) 1.2rc4
  63. Version(1, 2, 0, "final", post=1) 1.2.post1
  64. Version(1, 2, 3, ".dev") 1.2.3.dev0
  65. Version(1, 2, 3, ".dev", dev=1) 1.2.3.dev1
  66. ```
  67. """
  68. def __new__(
  69. cls,
  70. major: int, minor: int, micro: int, release: str = "final",
  71. pre: int = 0, post: int = 0, dev: int = 0
  72. ) -> "Version":
  73. """Validate version info."""
  74. # Ensure all parts are positive integers.
  75. for value in (major, minor, micro, pre, post):
  76. if not (isinstance(value, int) and value >= 0):
  77. raise ValueError("All version parts except 'release' should be integers.")
  78. if release not in REL_MAP:
  79. raise ValueError("'{}' is not a valid release type.".format(release))
  80. # Ensure valid pre-release (we do not allow implicit pre-releases).
  81. if ".dev-candidate" < release < "final":
  82. if pre == 0:
  83. raise ValueError("Implicit pre-releases not allowed.")
  84. elif dev:
  85. raise ValueError("Version is not a development release.")
  86. elif post:
  87. raise ValueError("Post-releases are not allowed with pre-releases.")
  88. # Ensure valid development or development/pre release
  89. elif release < "alpha":
  90. if release > ".dev" and pre == 0:
  91. raise ValueError("Implicit pre-release not allowed.")
  92. elif post:
  93. raise ValueError("Post-releases are not allowed with pre-releases.")
  94. # Ensure a valid normal release
  95. else:
  96. if pre:
  97. raise ValueError("Version is not a pre-release.")
  98. elif dev:
  99. raise ValueError("Version is not a development release.")
  100. return super(Version, cls).__new__(cls, major, minor, micro, release, pre, post, dev)
  101. def _is_pre(self) -> bool:
  102. """Is prerelease."""
  103. return bool(self.pre > 0)
  104. def _is_dev(self) -> bool:
  105. """Is development."""
  106. return bool(self.release < "alpha")
  107. def _is_post(self) -> bool:
  108. """Is post."""
  109. return bool(self.post > 0)
  110. def _get_dev_status(self) -> str: # pragma: no cover
  111. """Get development status string."""
  112. return DEV_STATUS[self.release]
  113. def _get_canonical(self) -> str:
  114. """Get the canonical output string."""
  115. # Assemble major, minor, micro version and append `pre`, `post`, or `dev` if needed..
  116. if self.micro == 0:
  117. ver = "{}.{}".format(self.major, self.minor)
  118. else:
  119. ver = "{}.{}.{}".format(self.major, self.minor, self.micro)
  120. if self._is_pre():
  121. ver += '{}{}'.format(REL_MAP[self.release], self.pre)
  122. if self._is_post():
  123. ver += ".post{}".format(self.post)
  124. if self._is_dev():
  125. ver += ".dev{}".format(self.dev)
  126. return ver
  127. def parse_version(ver: str) -> Version:
  128. """Parse version into a comparable Version tuple."""
  129. m = RE_VER.match(ver)
  130. if m is None:
  131. raise ValueError("'{}' is not a valid version".format(ver))
  132. # Handle major, minor, micro
  133. major = int(m.group('major'))
  134. minor = int(m.group('minor')) if m.group('minor') else 0
  135. micro = int(m.group('micro')) if m.group('micro') else 0
  136. # Handle pre releases
  137. if m.group('type'):
  138. release = PRE_REL_MAP[m.group('type')]
  139. pre = int(m.group('pre'))
  140. else:
  141. release = "final"
  142. pre = 0
  143. # Handle development releases
  144. dev = m.group('dev') if m.group('dev') else 0
  145. if m.group('dev'):
  146. dev = int(m.group('dev'))
  147. release = '.dev-' + release if pre else '.dev'
  148. else:
  149. dev = 0
  150. # Handle post
  151. post = int(m.group('post')) if m.group('post') else 0
  152. return Version(major, minor, micro, release, pre, post, dev)
  153. __version_info__ = Version(2, 3, 2, "final", post=1)
  154. __version__ = __version_info__._get_canonical()