Commit1c55e8d

AlexWaygood

and

erlend-aasland

authored

gh-104050: Improve some typing arounddefaults and sentinel values (#104626)

- Convert `unspecified` and `unknown` to be members of a `Sentinels` enum, rather than instances of bespoke classes. - An enum feels more idiomatic here, and works better with type checkers. - Convert some `==` and `!=` checks for these values to identity checks, which are more idiomatic with sentinels. - _Don't_ do the same for `Null`, as this needs to be a distinct type due to its usage in `clinic.py`.- Use `object` as the annotation for `default` across `clinic.py`. `default` can be literally any object, so `object` is the correct annotation here.---Co-authored-by: Erlend E. Aasland <erlend.aasland@protonmail.com>

1 parent61027c0 commit1c55e8dCopy full SHA for 1c55e8d

File tree

1 file changed

+23

-18

lines changed

Tools/clinic
- clinic.py

1 file changed

+23

-18

lines changed

`‎Tools/clinic/clinic.py‎`

Lines changed: 23 additions & 18 deletions

Original file line number	Diff line number	Diff line change
`@@ -12,6 +12,7 @@`
`12`	`12`	`importcontextlib`
`13`	`13`	`importcopy`
`14`	`14`	`importcpp`
	`15`	`+importenum`
`15`	`16`	`importfunctools`
`16`	`17`	`importhashlib`
`17`	`18`	`importinspect`
`@@ -28,7 +29,7 @@`
`28`	`29`
`29`	`30`	`fromcollections.abcimportCallable`
`30`	`31`	`fromtypesimportFunctionType,NoneType`
`31`		`-fromtypingimportAny,NamedTuple,NoReturn,Literal,overload`
	`32`	`+fromtypingimportAny,Final,NamedTuple,NoReturn,Literal,overload`
`32`	`33`
`33`	`34`	`# TODO:`
`34`	`35`	`#`
`@@ -58,25 +59,26 @@`
`58`	`59`	`"return_value",`
`59`	`60`	`}`
`60`	`61`
`61`		`-classUnspecified:`
	`62`	`+`
	`63`	`+classSentinels(enum.Enum):`
	`64`	`+unspecified="unspecified"`
	`65`	`+unknown="unknown"`
	`66`	`+`
`62`	`67`	`def__repr__(self)->str:`
`63`		`-return'<Unspecified>'`
	`68`	`+returnf"<{self.value.capitalize()}>"`
	`69`	`+`
`64`	`70`
`65`		`-unspecified=Unspecified()`
	`71`	`+unspecified:Final=Sentinels.unspecified`
	`72`	`+unknown:Final=Sentinels.unknown`
`66`	`73`
`67`	`74`
	`75`	`+# This one needs to be a distinct class, unlike the other two`
`68`	`76`	`classNull:`
`69`	`77`	`def__repr__(self)->str:`
`70`	`78`	`return'<Null>'`
`71`	`79`
`72`		`-NULL=Null()`
`73`		`-`
`74`	`80`
`75`		`-classUnknown:`
`76`		`-def__repr__(self)->str:`
`77`		`-return'<Unknown>'`
`78`		`-`
`79`		`-unknown=Unknown()`
	`81`	`+NULL=Null()`
`80`	`82`
`81`	`83`	`sig_end_marker='--'`
`82`	`84`
`@@ -2600,7 +2602,7 @@ class CConverter(metaclass=CConverterAutoRegister):`
`2600`	`2602`	`# Or the magic value "unknown" if this value is a cannot be evaluated`
`2601`	`2603`	`# at Argument-Clinic-preprocessing time (but is presumed to be valid`
`2602`	`2604`	`# at runtime).`
`2603`		`-default:bool\|Unspecified=unspecified`
	`2605`	`+default:object=unspecified`
`2604`	`2606`
`2605`	`2607`	`# If not None, default must be isinstance() of this type.`
`2606`	`2608`	`# (You can also specify a tuple of types.)`
`@@ -2686,11 +2688,11 @@ def __init__(self,`
`2686`	`2688`	`name:str,`
`2687`	`2689`	`py_name:str,`
`2688`	`2690`	`function,`
`2689`		`-default=unspecified,`
	`2691`	`+default:object=unspecified,`
`2690`	`2692`	`*,# Keyword only args:`
`2691`	`2693`	`c_default:str\|None=None,`
`2692`	`2694`	`py_default:str\|None=None,`
`2693`		`-annotation:str\|Unspecified=unspecified,`
	`2695`	`+annotation:str\|Literal[Sentinels.unspecified]=unspecified,`
`2694`	`2696`	`unused:bool=False,`
`2695`	`2697`	`**kwargs`
`2696`	`2698`	`):`
`@@ -2699,7 +2701,10 @@ def __init__(self,`
`2699`	`2701`	`self.unused=unused`
`2700`	`2702`
`2701`	`2703`	`ifdefaultisnotunspecified:`
`2702`		`-ifself.default_typeandnotisinstance(default, (self.default_type,Unknown)):`
	`2704`	`+if (self.default_type`
	`2705`	`+anddefaultisnotunknown`
	`2706`	`+andnotisinstance(default,self.default_type)`
	`2707`	`+ ):`
`2703`	`2708`	`ifisinstance(self.default_type,type):`
`2704`	`2709`	`types_str=self.default_type.__name__`
`2705`	`2710`	`else:`
`@@ -2713,7 +2718,7 @@ def __init__(self,`
`2713`	`2718`	`ifpy_default:`
`2714`	`2719`	`self.py_default=py_default`
`2715`	`2720`
`2716`		`-ifannotation!=unspecified:`
	`2721`	`+ifannotationisnotunspecified:`
`2717`	`2722`	`fail("The 'annotation' parameter is not currently permitted.")`
`2718`	`2723`
`2719`	`2724`	`# this is deliberate, to prevent you from caching information`
`@@ -3967,7 +3972,7 @@ class CReturnConverter(metaclass=CReturnConverterAutoRegister):`
`3967`	`3972`
`3968`	`3973`	`# The Python default value for this parameter, as a Python value.`
`3969`	`3974`	`# Or the magic value "unspecified" if there is no default.`
`3970`		`-default=None`
	`3975`	`+default:object=None`
`3971`	`3976`
`3972`	`3977`	`def__init__(self,,py_default=None,*kwargs):`
`3973`	`3978`	`self.py_default=py_default`
`@@ -4767,7 +4772,7 @@ def bad_node(self, node):`
`4767`	`4772`	`# but at least make an attempt at ensuring it's a valid expression.`
`4768`	`4773`	`try:`
`4769`	`4774`	`value=eval(default)`
`4770`		`-ifvalue==unspecified:`
	`4775`	`+ifvalueisunspecified:`
`4771`	`4776`	`fail("'unspecified' is not a legal default value!")`
`4772`	`4777`	`exceptNameError:`
`4773`	`4778`	`pass# probably a named constant`

0 commit comments

Comments

(0)

Movatterモバイル変換

Navigation Menu

Search code, repositories, users, issues, pull requests...

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

Uh oh!

Uh oh!

Commit1c55e8d

File tree

1 file changed

1 file changed

`‎Tools/clinic/clinic.py‎`

0 commit comments