Coverage for /pythoncovmergedfiles/medio/medio/usr/local/lib/python3.11/site-packages/black/mode.py: 78%

1"""Data structures configuring Black behavior. 

2 

3Mostly around Python language feature support per version and Black configuration 

4chosen by the user. 

5""" 

6 

7from dataclasses import dataclass, field 

8from enum import Enum, auto 

9from hashlib import sha256 

10from operator import attrgetter 

11from typing import Final 

12 

13from black.const import DEFAULT_LINE_LENGTH 

14 

15 

16class TargetVersion(Enum): 

17 PY33 = 3 

18 PY34 = 4 

19 PY35 = 5 

20 PY36 = 6 

21 PY37 = 7 

22 PY38 = 8 

23 PY39 = 9 

24 PY310 = 10 

25 PY311 = 11 

26 PY312 = 12 

27 PY313 = 13 

28 PY314 = 14 

29 

30 def pretty(self) -> str: 

31 assert self.name[:2] == "PY" 

32 return f"Python {self.name[2]}.{self.name[3:]}" 

33 

34 

35class Feature(Enum): 

36 F_STRINGS = 2 

37 NUMERIC_UNDERSCORES = 3 

38 TRAILING_COMMA_IN_CALL = 4 

39 TRAILING_COMMA_IN_DEF = 5 

40 # The following two feature-flags are mutually exclusive, and exactly one should be 

41 # set for every version of python. 

42 ASYNC_IDENTIFIERS = 6 

43 ASYNC_KEYWORDS = 7 

44 ASSIGNMENT_EXPRESSIONS = 8 

45 POS_ONLY_ARGUMENTS = 9 

46 RELAXED_DECORATORS = 10 

47 PATTERN_MATCHING = 11 

48 UNPACKING_ON_FLOW = 12 

49 ANN_ASSIGN_EXTENDED_RHS = 13 

50 EXCEPT_STAR = 14 

51 VARIADIC_GENERICS = 15 

52 DEBUG_F_STRINGS = 16 

53 PARENTHESIZED_CONTEXT_MANAGERS = 17 

54 TYPE_PARAMS = 18 

55 FSTRING_PARSING = 19 

56 TYPE_PARAM_DEFAULTS = 20 

57 UNPARENTHESIZED_EXCEPT_TYPES = 21 

58 FORCE_OPTIONAL_PARENTHESES = 50 

59 

60 # __future__ flags 

61 FUTURE_ANNOTATIONS = 51 

62 

63 

64FUTURE_FLAG_TO_FEATURE: Final = { 

65 "annotations": Feature.FUTURE_ANNOTATIONS, 

66} 

67 

68 

69VERSION_TO_FEATURES: dict[TargetVersion, set[Feature]] = { 

70 TargetVersion.PY33: {Feature.ASYNC_IDENTIFIERS}, 

71 TargetVersion.PY34: {Feature.ASYNC_IDENTIFIERS}, 

72 TargetVersion.PY35: {Feature.TRAILING_COMMA_IN_CALL, Feature.ASYNC_IDENTIFIERS}, 

73 TargetVersion.PY36: { 

74 Feature.F_STRINGS, 

75 Feature.NUMERIC_UNDERSCORES, 

76 Feature.TRAILING_COMMA_IN_CALL, 

77 Feature.TRAILING_COMMA_IN_DEF, 

78 Feature.ASYNC_IDENTIFIERS, 

79 }, 

80 TargetVersion.PY37: { 

81 Feature.F_STRINGS, 

82 Feature.NUMERIC_UNDERSCORES, 

83 Feature.TRAILING_COMMA_IN_CALL, 

84 Feature.TRAILING_COMMA_IN_DEF, 

85 Feature.ASYNC_KEYWORDS, 

86 Feature.FUTURE_ANNOTATIONS, 

87 }, 

88 TargetVersion.PY38: { 

89 Feature.F_STRINGS, 

90 Feature.DEBUG_F_STRINGS, 

91 Feature.NUMERIC_UNDERSCORES, 

92 Feature.TRAILING_COMMA_IN_CALL, 

93 Feature.TRAILING_COMMA_IN_DEF, 

94 Feature.ASYNC_KEYWORDS, 

95 Feature.FUTURE_ANNOTATIONS, 

96 Feature.ASSIGNMENT_EXPRESSIONS, 

97 Feature.POS_ONLY_ARGUMENTS, 

98 Feature.UNPACKING_ON_FLOW, 

99 Feature.ANN_ASSIGN_EXTENDED_RHS, 

100 }, 

101 TargetVersion.PY39: { 

102 Feature.F_STRINGS, 

103 Feature.DEBUG_F_STRINGS, 

104 Feature.NUMERIC_UNDERSCORES, 

105 Feature.TRAILING_COMMA_IN_CALL, 

106 Feature.TRAILING_COMMA_IN_DEF, 

107 Feature.ASYNC_KEYWORDS, 

108 Feature.FUTURE_ANNOTATIONS, 

109 Feature.ASSIGNMENT_EXPRESSIONS, 

110 Feature.RELAXED_DECORATORS, 

111 Feature.POS_ONLY_ARGUMENTS, 

112 Feature.UNPACKING_ON_FLOW, 

113 Feature.ANN_ASSIGN_EXTENDED_RHS, 

114 Feature.PARENTHESIZED_CONTEXT_MANAGERS, 

115 }, 

116 TargetVersion.PY310: { 

117 Feature.F_STRINGS, 

118 Feature.DEBUG_F_STRINGS, 

119 Feature.NUMERIC_UNDERSCORES, 

120 Feature.TRAILING_COMMA_IN_CALL, 

121 Feature.TRAILING_COMMA_IN_DEF, 

122 Feature.ASYNC_KEYWORDS, 

123 Feature.FUTURE_ANNOTATIONS, 

124 Feature.ASSIGNMENT_EXPRESSIONS, 

125 Feature.RELAXED_DECORATORS, 

126 Feature.POS_ONLY_ARGUMENTS, 

127 Feature.UNPACKING_ON_FLOW, 

128 Feature.ANN_ASSIGN_EXTENDED_RHS, 

129 Feature.PARENTHESIZED_CONTEXT_MANAGERS, 

130 Feature.PATTERN_MATCHING, 

131 }, 

132 TargetVersion.PY311: { 

133 Feature.F_STRINGS, 

134 Feature.DEBUG_F_STRINGS, 

135 Feature.NUMERIC_UNDERSCORES, 

136 Feature.TRAILING_COMMA_IN_CALL, 

137 Feature.TRAILING_COMMA_IN_DEF, 

138 Feature.ASYNC_KEYWORDS, 

139 Feature.FUTURE_ANNOTATIONS, 

140 Feature.ASSIGNMENT_EXPRESSIONS, 

141 Feature.RELAXED_DECORATORS, 

142 Feature.POS_ONLY_ARGUMENTS, 

143 Feature.UNPACKING_ON_FLOW, 

144 Feature.ANN_ASSIGN_EXTENDED_RHS, 

145 Feature.PARENTHESIZED_CONTEXT_MANAGERS, 

146 Feature.PATTERN_MATCHING, 

147 Feature.EXCEPT_STAR, 

148 Feature.VARIADIC_GENERICS, 

149 }, 

150 TargetVersion.PY312: { 

151 Feature.F_STRINGS, 

152 Feature.DEBUG_F_STRINGS, 

153 Feature.NUMERIC_UNDERSCORES, 

154 Feature.TRAILING_COMMA_IN_CALL, 

155 Feature.TRAILING_COMMA_IN_DEF, 

156 Feature.ASYNC_KEYWORDS, 

157 Feature.FUTURE_ANNOTATIONS, 

158 Feature.ASSIGNMENT_EXPRESSIONS, 

159 Feature.RELAXED_DECORATORS, 

160 Feature.POS_ONLY_ARGUMENTS, 

161 Feature.UNPACKING_ON_FLOW, 

162 Feature.ANN_ASSIGN_EXTENDED_RHS, 

163 Feature.PARENTHESIZED_CONTEXT_MANAGERS, 

164 Feature.PATTERN_MATCHING, 

165 Feature.EXCEPT_STAR, 

166 Feature.VARIADIC_GENERICS, 

167 Feature.TYPE_PARAMS, 

168 Feature.FSTRING_PARSING, 

169 }, 

170 TargetVersion.PY313: { 

171 Feature.F_STRINGS, 

172 Feature.DEBUG_F_STRINGS, 

173 Feature.NUMERIC_UNDERSCORES, 

174 Feature.TRAILING_COMMA_IN_CALL, 

175 Feature.TRAILING_COMMA_IN_DEF, 

176 Feature.ASYNC_KEYWORDS, 

177 Feature.FUTURE_ANNOTATIONS, 

178 Feature.ASSIGNMENT_EXPRESSIONS, 

179 Feature.RELAXED_DECORATORS, 

180 Feature.POS_ONLY_ARGUMENTS, 

181 Feature.UNPACKING_ON_FLOW, 

182 Feature.ANN_ASSIGN_EXTENDED_RHS, 

183 Feature.PARENTHESIZED_CONTEXT_MANAGERS, 

184 Feature.PATTERN_MATCHING, 

185 Feature.EXCEPT_STAR, 

186 Feature.VARIADIC_GENERICS, 

187 Feature.TYPE_PARAMS, 

188 Feature.FSTRING_PARSING, 

189 Feature.TYPE_PARAM_DEFAULTS, 

190 }, 

191 TargetVersion.PY314: { 

192 Feature.F_STRINGS, 

193 Feature.DEBUG_F_STRINGS, 

194 Feature.NUMERIC_UNDERSCORES, 

195 Feature.TRAILING_COMMA_IN_CALL, 

196 Feature.TRAILING_COMMA_IN_DEF, 

197 Feature.ASYNC_KEYWORDS, 

198 Feature.FUTURE_ANNOTATIONS, 

199 Feature.ASSIGNMENT_EXPRESSIONS, 

200 Feature.RELAXED_DECORATORS, 

201 Feature.POS_ONLY_ARGUMENTS, 

202 Feature.UNPACKING_ON_FLOW, 

203 Feature.ANN_ASSIGN_EXTENDED_RHS, 

204 Feature.PARENTHESIZED_CONTEXT_MANAGERS, 

205 Feature.PATTERN_MATCHING, 

206 Feature.EXCEPT_STAR, 

207 Feature.VARIADIC_GENERICS, 

208 Feature.TYPE_PARAMS, 

209 Feature.FSTRING_PARSING, 

210 Feature.TYPE_PARAM_DEFAULTS, 

211 Feature.UNPARENTHESIZED_EXCEPT_TYPES, 

212 }, 

213} 

214 

215 

216def supports_feature(target_versions: set[TargetVersion], feature: Feature) -> bool: 

217 if not target_versions: 

218 raise ValueError("target_versions must not be empty") 

219 

220 return all(feature in VERSION_TO_FEATURES[version] for version in target_versions) 

221 

222 

223class Preview(Enum): 

224 """Individual preview style features.""" 

225 

226 # NOTE: string_processing requires wrap_long_dict_values_in_parens 

227 # for https://github.com/psf/black/issues/3117 to be fixed. 

228 string_processing = auto() 

229 hug_parens_with_braces_and_square_brackets = auto() 

230 wrap_long_dict_values_in_parens = auto() 

231 multiline_string_handling = auto() 

232 always_one_newline_after_import = auto() 

233 fix_fmt_skip_in_one_liners = auto() 

234 # Remove parentheses around multiple exception types in except and 

235 # except* without as. See PEP 758 for details. 

236 remove_parens_around_except_types = auto() 

237 

238 

239UNSTABLE_FEATURES: set[Preview] = { 

240 # Many issues, see summary in https://github.com/psf/black/issues/4042 

241 Preview.string_processing, 

242 # See issue #4159 

243 Preview.multiline_string_handling, 

244 # See issue #4036 (crash), #4098, #4099 (proposed tweaks) 

245 Preview.hug_parens_with_braces_and_square_brackets, 

246} 

247 

248 

249class Deprecated(UserWarning): 

250 """Visible deprecation warning.""" 

251 

252 

253_MAX_CACHE_KEY_PART_LENGTH: Final = 32 

254 

255 

256@dataclass 

257class Mode: 

258 target_versions: set[TargetVersion] = field(default_factory=set) 

259 line_length: int = DEFAULT_LINE_LENGTH 

260 string_normalization: bool = True 

261 is_pyi: bool = False 

262 is_ipynb: bool = False 

263 skip_source_first_line: bool = False 

264 magic_trailing_comma: bool = True 

265 python_cell_magics: set[str] = field(default_factory=set) 

266 preview: bool = False 

267 unstable: bool = False 

268 enabled_features: set[Preview] = field(default_factory=set) 

269 

270 def __contains__(self, feature: Preview) -> bool: 

271 """ 

272 Provide `Preview.FEATURE in Mode` syntax that mirrors the ``preview`` flag. 

273 

274 In unstable mode, all features are enabled. In preview mode, all features 

275 except those in UNSTABLE_FEATURES are enabled. Any features in 

276 `self.enabled_features` are also enabled. 

277 """ 

278 if self.unstable: 

279 return True 

280 if feature in self.enabled_features: 

281 return True 

282 return self.preview and feature not in UNSTABLE_FEATURES 

283 

284 def get_cache_key(self) -> str: 

285 if self.target_versions: 

286 version_str = ",".join( 

287 str(version.value) 

288 for version in sorted(self.target_versions, key=attrgetter("value")) 

289 ) 

290 else: 

291 version_str = "-" 

292 if len(version_str) > _MAX_CACHE_KEY_PART_LENGTH: 

293 version_str = sha256(version_str.encode()).hexdigest()[ 

294 :_MAX_CACHE_KEY_PART_LENGTH 

295 ] 

296 features_and_magics = ( 

297 ",".join(sorted(f.name for f in self.enabled_features)) 

298 + "@" 

299 + ",".join(sorted(self.python_cell_magics)) 

300 ) 

301 if len(features_and_magics) > _MAX_CACHE_KEY_PART_LENGTH: 

302 features_and_magics = sha256(features_and_magics.encode()).hexdigest()[ 

303 :_MAX_CACHE_KEY_PART_LENGTH 

304 ] 

305 parts = [ 

306 version_str, 

307 str(self.line_length), 

308 str(int(self.string_normalization)), 

309 str(int(self.is_pyi)), 

310 str(int(self.is_ipynb)), 

311 str(int(self.skip_source_first_line)), 

312 str(int(self.magic_trailing_comma)), 

313 str(int(self.preview)), 

314 str(int(self.unstable)), 

315 features_and_magics, 

316 ] 

317 return ".".join(parts)