support conditional fields on TypedDict and NamedTuple

Author: carljm

conformance/results/mypy/namedtuples_define_class.toml

@@ -1,29 +1,34 @@
 conformant = "Partial"
 notes = """
 Does not reject override of named tuple attribute in child class.
+Does not support version-conditional fields.
 """
 output = """
-namedtuples_define_class.py:32: error: Tuple index out of range  [misc]
 namedtuples_define_class.py:33: error: Tuple index out of range  [misc]
-namedtuples_define_class.py:44: error: Missing positional argument "y" in call to "Point"  [call-arg]
+namedtuples_define_class.py:34: error: Tuple index out of range  [misc]
 namedtuples_define_class.py:45: error: Missing positional argument "y" in call to "Point"  [call-arg]
-namedtuples_define_class.py:46: error: Argument 2 to "Point" has incompatible type "str"; expected "int"  [arg-type]
-namedtuples_define_class.py:47: error: Argument "units" to "Point" has incompatible type "int"; expected "str"  [arg-type]
-namedtuples_define_class.py:48: error: Too many arguments for "Point"  [call-arg]
-namedtuples_define_class.py:49: error: Unexpected keyword argument "other" for "Point"  [call-arg]
-namedtuples_define_class.py:59: error: Invalid statement in NamedTuple definition; expected "field_name: field_type [= default]"  [misc]
-namedtuples_define_class.py:65: error: Missing positional argument "units" in call to "Point2"  [call-arg]
-namedtuples_define_class.py:67: error: Too many values to unpack (2 expected, 3 provided)  [misc]
-namedtuples_define_class.py:76: error: NamedTuple field name cannot start with an underscore: _y  [misc]
-namedtuples_define_class.py:86: error: Non-default NamedTuple fields cannot follow default fields  [misc]
-namedtuples_define_class.py:125: error: Argument 2 to "Property" has incompatible type "float"; expected "str"  [arg-type]
-namedtuples_define_class.py:132: error: NamedTuple should be a single base  [misc]
+namedtuples_define_class.py:46: error: Missing positional argument "y" in call to "Point"  [call-arg]
+namedtuples_define_class.py:47: error: Argument 2 to "Point" has incompatible type "str"; expected "int"  [arg-type]
+namedtuples_define_class.py:48: error: Argument "units" to "Point" has incompatible type "int"; expected "str"  [arg-type]
+namedtuples_define_class.py:49: error: Too many arguments for "Point"  [call-arg]
+namedtuples_define_class.py:50: error: Unexpected keyword argument "other" for "Point"  [call-arg]
+namedtuples_define_class.py:60: error: Invalid statement in NamedTuple definition; expected "field_name: field_type [= default]"  [misc]
+namedtuples_define_class.py:66: error: Missing positional argument "units" in call to "Point2"  [call-arg]
+namedtuples_define_class.py:68: error: Too many values to unpack (2 expected, 3 provided)  [misc]
+namedtuples_define_class.py:77: error: NamedTuple field name cannot start with an underscore: _y  [misc]
+namedtuples_define_class.py:87: error: Non-default NamedTuple fields cannot follow default fields  [misc]
+namedtuples_define_class.py:114: error: Invalid statement in NamedTuple definition; expected "field_name: field_type [= default]"  [misc]
+namedtuples_define_class.py:118: error: Too many arguments for "ConditionalField"  [call-arg]
+namedtuples_define_class.py:137: error: Argument 2 to "Property" has incompatible type "float"; expected "str"  [arg-type]
+namedtuples_define_class.py:144: error: NamedTuple should be a single base  [misc]
 """
 conformance_automated = "Fail"
 errors_diff = """
-Line 69: Expected 1 errors
-Line 106: Expected 1 errors
-Line 59: Unexpected errors ['namedtuples_define_class.py:59: error: Invalid statement in NamedTuple definition; expected "field_name: field_type [= default]"  [misc]']
-Line 65: Unexpected errors ['namedtuples_define_class.py:65: error: Missing positional argument "units" in call to "Point2"  [call-arg]']
-Line 67: Unexpected errors ['namedtuples_define_class.py:67: error: Too many values to unpack (2 expected, 3 provided)  [misc]']
+Line 70: Expected 1 errors
+Line 107: Expected 1 errors
+Line 60: Unexpected errors ['namedtuples_define_class.py:60: error: Invalid statement in NamedTuple definition; expected "field_name: field_type [= default]"  [misc]']
+Line 66: Unexpected errors ['namedtuples_define_class.py:66: error: Missing positional argument "units" in call to "Point2"  [call-arg]']
+Line 68: Unexpected errors ['namedtuples_define_class.py:68: error: Too many values to unpack (2 expected, 3 provided)  [misc]']
+Line 114: Unexpected errors ['namedtuples_define_class.py:114: error: Invalid statement in NamedTuple definition; expected "field_name: field_type [= default]"  [misc]']
+Line 118: Unexpected errors ['namedtuples_define_class.py:118: error: Too many arguments for "ConditionalField"  [call-arg]']
 """

conformance/results/mypy/typeddicts_class_syntax.toml

@@ -1,11 +1,18 @@
-conformant = "Pass"
+conformant = "Partial"
+notes = """
+Does not support version-conditional items in TypedDict definitions.
+"""
 output = """
-typeddicts_class_syntax.py:29: error: Invalid statement in TypedDict definition; expected "field_name: field_type"  [misc]
-typeddicts_class_syntax.py:33: error: Invalid statement in TypedDict definition; expected "field_name: field_type"  [misc]
-typeddicts_class_syntax.py:38: error: Invalid statement in TypedDict definition; expected "field_name: field_type"  [misc]
-typeddicts_class_syntax.py:44: error: Unexpected keyword argument "metaclass" for "__init_subclass__" of "TypedDict"  [call-arg]
-typeddicts_class_syntax.py:49: error: Unexpected keyword argument "other" for "__init_subclass__" of "TypedDict"  [call-arg]
+typeddicts_class_syntax.py:30: error: Invalid statement in TypedDict definition; expected "field_name: field_type"  [misc]
+typeddicts_class_syntax.py:34: error: Invalid statement in TypedDict definition; expected "field_name: field_type"  [misc]
+typeddicts_class_syntax.py:39: error: Invalid statement in TypedDict definition; expected "field_name: field_type"  [misc]
+typeddicts_class_syntax.py:45: error: Unexpected keyword argument "metaclass" for "__init_subclass__" of "TypedDict"  [call-arg]
+typeddicts_class_syntax.py:50: error: Unexpected keyword argument "other" for "__init_subclass__" of "TypedDict"  [call-arg]
+typeddicts_class_syntax.py:58: error: Invalid statement in TypedDict definition; expected "field_name: field_type"  [misc]
+typeddicts_class_syntax.py:62: error: Extra key "y" for TypedDict "ConditionalField"  [typeddict-unknown-key]
 """
-conformance_automated = "Pass"
+conformance_automated = "Fail"
 errors_diff = """
+Line 58: Unexpected errors ['typeddicts_class_syntax.py:58: error: Invalid statement in TypedDict definition; expected "field_name: field_type"  [misc]']
+Line 62: Unexpected errors ['typeddicts_class_syntax.py:62: error: Extra key "y" for TypedDict "ConditionalField"  [typeddict-unknown-key]']
 """

conformance/results/pyrefly/namedtuples_define_class.toml

@@ -3,18 +3,18 @@ conformance_automated = "Pass"
 errors_diff = """
 """
 output = """
-ERROR namedtuples_define_class.py:32:10-11: Index 3 out of range for tuple with 3 elements [bad-index]
-ERROR namedtuples_define_class.py:33:10-12: Index -4 out of range for tuple with 3 elements [bad-index]
-ERROR namedtuples_define_class.py:44:11-14: Missing argument `y` in function `Point.__new__` [missing-argument]
-ERROR namedtuples_define_class.py:45:11-16: Missing argument `y` in function `Point.__new__` [missing-argument]
-ERROR namedtuples_define_class.py:46:15-17: Argument `Literal['']` is not assignable to parameter `y` with type `int` in function `Point.__new__` [bad-argument-type]
-ERROR namedtuples_define_class.py:47:24-25: Argument `Literal[3]` is not assignable to parameter `units` with type `str` in function `Point.__new__` [bad-argument-type]
-ERROR namedtuples_define_class.py:48:22-24: Expected 3 positional arguments, got 4 in function `Point.__new__` [bad-argument-count]
-ERROR namedtuples_define_class.py:49:23-28: Unexpected keyword argument `other` in function `Point.__new__` [unexpected-keyword]
-ERROR namedtuples_define_class.py:69:20-22: Expected 2 positional arguments, got 3 in function `Point2.__new__` [bad-argument-count]
-ERROR namedtuples_define_class.py:76:5-7: NamedTuple field name may not start with an underscore: `_y` [bad-class-definition]
-ERROR namedtuples_define_class.py:86:5-13: NamedTuple field 'latitude' without a default may not follow NamedTuple field with a default [bad-class-definition]
-ERROR namedtuples_define_class.py:106:5-6: Cannot override named tuple element `x` [bad-override]
-ERROR namedtuples_define_class.py:125:19-22: Argument `float` is not assignable to parameter `value` with type `str` in function `Property.__new__` [bad-argument-type]
-ERROR namedtuples_define_class.py:132:7-11: Named tuples do not support multiple inheritance [invalid-inheritance]
+ERROR namedtuples_define_class.py:33:10-11: Index 3 out of range for tuple with 3 elements [bad-index]
+ERROR namedtuples_define_class.py:34:10-12: Index -4 out of range for tuple with 3 elements [bad-index]
+ERROR namedtuples_define_class.py:45:11-14: Missing argument `y` in function `Point.__new__` [missing-argument]
+ERROR namedtuples_define_class.py:46:11-16: Missing argument `y` in function `Point.__new__` [missing-argument]
+ERROR namedtuples_define_class.py:47:15-17: Argument `Literal['']` is not assignable to parameter `y` with type `int` in function `Point.__new__` [bad-argument-type]
+ERROR namedtuples_define_class.py:48:24-25: Argument `Literal[3]` is not assignable to parameter `units` with type `str` in function `Point.__new__` [bad-argument-type]
+ERROR namedtuples_define_class.py:49:22-24: Expected 3 positional arguments, got 4 in function `Point.__new__` [bad-argument-count]
+ERROR namedtuples_define_class.py:50:23-28: Unexpected keyword argument `other` in function `Point.__new__` [unexpected-keyword]
+ERROR namedtuples_define_class.py:70:20-22: Expected 2 positional arguments, got 3 in function `Point2.__new__` [bad-argument-count]
+ERROR namedtuples_define_class.py:77:5-7: NamedTuple field name may not start with an underscore: `_y` [bad-class-definition]
+ERROR namedtuples_define_class.py:87:5-13: NamedTuple field 'latitude' without a default may not follow NamedTuple field with a default [bad-class-definition]
+ERROR namedtuples_define_class.py:107:5-6: Cannot override named tuple element `x` [bad-override]
+ERROR namedtuples_define_class.py:137:19-22: Argument `float` is not assignable to parameter `value` with type `str` in function `Property.__new__` [bad-argument-type]
+ERROR namedtuples_define_class.py:144:7-11: Named tuples do not support multiple inheritance [invalid-inheritance]
 """

conformance/results/pyrefly/typeddicts_class_syntax.toml

@@ -3,9 +3,9 @@ conformance_automated = "Pass"
 errors_diff = """
 """
 output = """
-ERROR typeddicts_class_syntax.py:29:9-16: TypedDict members must be declared in the form `field: Annotation` with no assignment [bad-class-definition]
-ERROR typeddicts_class_syntax.py:34:9-16: TypedDict members must be declared in the form `field: Annotation` with no assignment [bad-class-definition]
-ERROR typeddicts_class_syntax.py:39:9-16: TypedDict members must be declared in the form `field: Annotation` with no assignment [bad-class-definition]
-ERROR typeddicts_class_syntax.py:44:7-20: Metaclass of `BadTypedDict2` has type `type[Any]` that is not a simple class type [invalid-inheritance]
-ERROR typeddicts_class_syntax.py:49:7-20: TypedDict does not support keyword argument `other` [bad-typed-dict]
+ERROR typeddicts_class_syntax.py:30:9-16: TypedDict members must be declared in the form `field: Annotation` with no assignment [bad-class-definition]
+ERROR typeddicts_class_syntax.py:35:9-16: TypedDict members must be declared in the form `field: Annotation` with no assignment [bad-class-definition]
+ERROR typeddicts_class_syntax.py:40:9-16: TypedDict members must be declared in the form `field: Annotation` with no assignment [bad-class-definition]
+ERROR typeddicts_class_syntax.py:45:7-20: Metaclass of `BadTypedDict2` has type `type[Any]` that is not a simple class type [invalid-inheritance]
+ERROR typeddicts_class_syntax.py:50:7-20: TypedDict does not support keyword argument `other` [bad-typed-dict]
 """

conformance/results/pyright/namedtuples_define_class.toml

@@ -1,22 +1,22 @@
 conformant = "Pass"
 output = """
-namedtuples_define_class.py:32:7 - error: Index 3 is out of range for type Point (reportGeneralTypeIssues)
-namedtuples_define_class.py:33:7 - error: Index -4 is out of range for type Point (reportGeneralTypeIssues)
-namedtuples_define_class.py:44:6 - error: Argument missing for parameter "y" (reportCallIssue)
+namedtuples_define_class.py:33:7 - error: Index 3 is out of range for type Point (reportGeneralTypeIssues)
+namedtuples_define_class.py:34:7 - error: Index -4 is out of range for type Point (reportGeneralTypeIssues)
 namedtuples_define_class.py:45:6 - error: Argument missing for parameter "y" (reportCallIssue)
-namedtuples_define_class.py:46:15 - error: Argument of type "Literal['']" cannot be assigned to parameter "y" of type "int" in function "__new__"
+namedtuples_define_class.py:46:6 - error: Argument missing for parameter "y" (reportCallIssue)
+namedtuples_define_class.py:47:15 - error: Argument of type "Literal['']" cannot be assigned to parameter "y" of type "int" in function "__new__"
   "Literal['']" is not assignable to "int" (reportArgumentType)
-namedtuples_define_class.py:47:24 - error: Argument of type "Literal[3]" cannot be assigned to parameter "units" of type "str" in function "__new__"
+namedtuples_define_class.py:48:24 - error: Argument of type "Literal[3]" cannot be assigned to parameter "units" of type "str" in function "__new__"
   "Literal[3]" is not assignable to "str" (reportArgumentType)
-namedtuples_define_class.py:48:22 - error: Expected 3 positional arguments (reportCallIssue)
-namedtuples_define_class.py:49:23 - error: No parameter named "other" (reportCallIssue)
-namedtuples_define_class.py:69:20 - error: Expected 2 positional arguments (reportCallIssue)
-namedtuples_define_class.py:76:5 - error: Named tuple field names cannot start with an underscore (reportGeneralTypeIssues)
-namedtuples_define_class.py:86:5 - error: Fields without default values cannot appear after fields with default values (reportGeneralTypeIssues)
-namedtuples_define_class.py:106:5 - error: Cannot override "x" because parent class "Point" is a named tuple (reportIncompatibleVariableOverride)
-namedtuples_define_class.py:125:19 - error: Argument of type "float" cannot be assigned to parameter "value" of type "str" in function "__new__"
+namedtuples_define_class.py:49:22 - error: Expected 3 positional arguments (reportCallIssue)
+namedtuples_define_class.py:50:23 - error: No parameter named "other" (reportCallIssue)
+namedtuples_define_class.py:70:20 - error: Expected 2 positional arguments (reportCallIssue)
+namedtuples_define_class.py:77:5 - error: Named tuple field names cannot start with an underscore (reportGeneralTypeIssues)
+namedtuples_define_class.py:87:5 - error: Fields without default values cannot appear after fields with default values (reportGeneralTypeIssues)
+namedtuples_define_class.py:107:5 - error: Cannot override "x" because parent class "Point" is a named tuple (reportIncompatibleVariableOverride)
+namedtuples_define_class.py:137:19 - error: Argument of type "float" cannot be assigned to parameter "value" of type "str" in function "__new__"
   "float" is not assignable to "str" (reportArgumentType)
-namedtuples_define_class.py:132:7 - error: Multiple inheritance with NamedTuple is not supported (reportGeneralTypeIssues)
+namedtuples_define_class.py:144:7 - error: Multiple inheritance with NamedTuple is not supported (reportGeneralTypeIssues)
 """
 conformance_automated = "Pass"
 errors_diff = """

conformance/results/pyright/typeddicts_class_syntax.toml

@@ -1,11 +1,16 @@
-conformant = "Pass"
+conformant = "Partial"
+notes = """
+Does not support version-conditional items in TypedDict definitions.
+"""
 output = """
-typeddicts_class_syntax.py:29:5 - error: TypedDict classes can contain only type annotations (reportGeneralTypeIssues)
-typeddicts_class_syntax.py:33:5 - error: TypedDict classes can contain only type annotations (reportGeneralTypeIssues)
-typeddicts_class_syntax.py:38:5 - error: TypedDict classes can contain only type annotations (reportGeneralTypeIssues)
-typeddicts_class_syntax.py:44:32 - error: TypedDict does not support __init_subclass__ parameter "metaclass" (reportGeneralTypeIssues)
-typeddicts_class_syntax.py:49:32 - error: TypedDict does not support __init_subclass__ parameter "other" (reportGeneralTypeIssues)
+typeddicts_class_syntax.py:30:5 - error: TypedDict classes can contain only type annotations (reportGeneralTypeIssues)
+typeddicts_class_syntax.py:34:5 - error: TypedDict classes can contain only type annotations (reportGeneralTypeIssues)
+typeddicts_class_syntax.py:39:5 - error: TypedDict classes can contain only type annotations (reportGeneralTypeIssues)
+typeddicts_class_syntax.py:45:32 - error: TypedDict does not support __init_subclass__ parameter "metaclass" (reportGeneralTypeIssues)
+typeddicts_class_syntax.py:50:32 - error: TypedDict does not support __init_subclass__ parameter "other" (reportGeneralTypeIssues)
+typeddicts_class_syntax.py:58:5 - error: TypedDict classes can contain only type annotations (reportGeneralTypeIssues)
 """
-conformance_automated = "Pass"
+conformance_automated = "Fail"
 errors_diff = """
+Line 58: Unexpected errors ['typeddicts_class_syntax.py:58:5 - error: TypedDict classes can contain only type annotations (reportGeneralTypeIssues)']
 """

conformance/results/results.html

@@ -936,11 +936,11 @@ <h3>Python Type System Conformance Test Results</h3>
 <th class="column col2 conformant">Pass</th>
 </tr>
 <tr><th class="column col1">&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;typeddicts_class_syntax</th>
+<th class="column col2 partially-conformant"><div class="hover-text">Partial<span class="tooltip-text" id="bottom"><p>Does not support version-conditional items in TypedDict definitions.</p></span></div></th>
+<th class="column col2 partially-conformant"><div class="hover-text">Partial<span class="tooltip-text" id="bottom"><p>Does not support version-conditional items in TypedDict definitions.</p></span></div></th>
+<th class="column col2 partially-conformant"><div class="hover-text">Partial<span class="tooltip-text" id="bottom"><p>Does not support version-conditional items in TypedDict definitions.</p></span></div></th>
 <th class="column col2 conformant">Pass</th>
-<th class="column col2 conformant">Pass</th>
-<th class="column col2 conformant">Pass</th>
-<th class="column col2 conformant">Pass</th>
-<th class="column col2 conformant">Pass</th>
+<th class="column col2 partially-conformant"><div class="hover-text">Partial<span class="tooltip-text" id="bottom"><p>Errors on version-conditional items in TypedDict definitions.</p></span></div></th>
 </tr>
 <tr><th class="column col1">&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;typeddicts_extra_items</th>
 <th class="column col2 not-conformant"><div class="hover-text">Unsupported<span class="tooltip-text" id="bottom"><p>Not supported.</p></span></div></th>
@@ -1054,9 +1054,9 @@ <h3>Python Type System Conformance Test Results</h3>
 <a class="test_group" href="https://typing.readthedocs.io/en/latest/spec/namedtuples.html">Named tuples</a>
 </th></tr>
 <tr><th class="column col1">&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;namedtuples_define_class</th>
-<th class="column col2 partially-conformant"><div class="hover-text">Partial<span class="tooltip-text" id="bottom"><p>Does not reject override of named tuple attribute in child class.</p></span></div></th>
-<th class="column col2 conformant">Pass</th>
+<th class="column col2 partially-conformant"><div class="hover-text">Partial<span class="tooltip-text" id="bottom"><p>Does not reject override of named tuple attribute in child class.</p><p>Does not support version-conditional fields.</p></span></div></th>
 <th class="column col2 conformant">Pass</th>
+<th class="column col2 partially-conformant"><div class="hover-text">Partial<span class="tooltip-text" id="bottom"><p>Does not support version-conditional fields in NamedTuple definitions.</p></span></div></th>
 <th class="column col2 conformant">Pass</th>
 <th class="column col2 conformant">Pass</th>
 </tr>