Coverage for /pythoncovmergedfiles/medio/medio/usr/local/lib/python3.8/site-packages/packaging/utils.py: 20%

1# This file is dual licensed under the terms of the Apache License, Version 

2# 2.0, and the BSD License. See the LICENSE file in the root of this repository 

3# for complete details. 

4 

5import re 

6from typing import FrozenSet, NewType, Tuple, Union, cast 

7 

8from .tags import Tag, parse_tag 

9from .version import InvalidVersion, Version 

10 

11BuildTag = Union[Tuple[()], Tuple[int, str]] 

12NormalizedName = NewType("NormalizedName", str) 

13 

14 

15class InvalidWheelFilename(ValueError): 

16 """ 

17 An invalid wheel filename was found, users should refer to PEP 427. 

18 """ 

19 

20 

21class InvalidSdistFilename(ValueError): 

22 """ 

23 An invalid sdist filename was found, users should refer to the packaging user guide. 

24 """ 

25 

26 

27_canonicalize_regex = re.compile(r"[-_.]+") 

28# PEP 427: The build number must start with a digit. 

29_build_tag_regex = re.compile(r"(\d+)(.*)") 

30 

31 

32def canonicalize_name(name: str) -> NormalizedName: 

33 # This is taken from PEP 503. 

34 value = _canonicalize_regex.sub("-", name).lower() 

35 return cast(NormalizedName, value) 

36 

37 

38def canonicalize_version( 

39 version: Union[Version, str], *, strip_trailing_zero: bool = True 

40) -> str: 

41 """ 

42 This is very similar to Version.__str__, but has one subtle difference 

43 with the way it handles the release segment. 

44 """ 

45 if isinstance(version, str): 

46 try: 

47 parsed = Version(version) 

48 except InvalidVersion: 

49 # Legacy versions cannot be normalized 

50 return version 

51 else: 

52 parsed = version 

53 

54 parts = [] 

55 

56 # Epoch 

57 if parsed.epoch != 0: 

58 parts.append(f"{parsed.epoch}!") 

59 

60 # Release segment 

61 release_segment = ".".join(str(x) for x in parsed.release) 

62 if strip_trailing_zero: 

63 # NB: This strips trailing '.0's to normalize 

64 release_segment = re.sub(r"(\.0)+$", "", release_segment) 

65 parts.append(release_segment) 

66 

67 # Pre-release 

68 if parsed.pre is not None: 

69 parts.append("".join(str(x) for x in parsed.pre)) 

70 

71 # Post-release 

72 if parsed.post is not None: 

73 parts.append(f".post{parsed.post}") 

74 

75 # Development release 

76 if parsed.dev is not None: 

77 parts.append(f".dev{parsed.dev}") 

78 

79 # Local version segment 

80 if parsed.local is not None: 

81 parts.append(f"+{parsed.local}") 

82 

83 return "".join(parts) 

84 

85 

86def parse_wheel_filename( 

87 filename: str, 

88) -> Tuple[NormalizedName, Version, BuildTag, FrozenSet[Tag]]: 

89 if not filename.endswith(".whl"): 

90 raise InvalidWheelFilename( 

91 f"Invalid wheel filename (extension must be '.whl'): {filename}" 

92 ) 

93 

94 filename = filename[:-4] 

95 dashes = filename.count("-") 

96 if dashes not in (4, 5): 

97 raise InvalidWheelFilename( 

98 f"Invalid wheel filename (wrong number of parts): {filename}" 

99 ) 

100 

101 parts = filename.split("-", dashes - 2) 

102 name_part = parts[0] 

103 # See PEP 427 for the rules on escaping the project name 

104 if "__" in name_part or re.match(r"^[\w\d._]*$", name_part, re.UNICODE) is None: 

105 raise InvalidWheelFilename(f"Invalid project name: {filename}") 

106 name = canonicalize_name(name_part) 

107 version = Version(parts[1]) 

108 if dashes == 5: 

109 build_part = parts[2] 

110 build_match = _build_tag_regex.match(build_part) 

111 if build_match is None: 

112 raise InvalidWheelFilename( 

113 f"Invalid build number: {build_part} in '{filename}'" 

114 ) 

115 build = cast(BuildTag, (int(build_match.group(1)), build_match.group(2))) 

116 else: 

117 build = () 

118 tags = parse_tag(parts[-1]) 

119 return (name, version, build, tags) 

120 

121 

122def parse_sdist_filename(filename: str) -> Tuple[NormalizedName, Version]: 

123 if filename.endswith(".tar.gz"): 

124 file_stem = filename[: -len(".tar.gz")] 

125 elif filename.endswith(".zip"): 

126 file_stem = filename[: -len(".zip")] 

127 else: 

128 raise InvalidSdistFilename( 

129 f"Invalid sdist filename (extension must be '.tar.gz' or '.zip'):" 

130 f" {filename}" 

131 ) 

132 

133 # We are requiring a PEP 440 version, which cannot contain dashes, 

134 # so we split on the last dash. 

135 name_part, sep, version_part = file_stem.rpartition("-") 

136 if not sep: 

137 raise InvalidSdistFilename(f"Invalid sdist filename: {filename}") 

138 

139 name = canonicalize_name(name_part) 

140 version = Version(version_part) 

141 return (name, version)