Standard: Classes: Mitigate Pyright false positives for subclasses.

emcd · emcd · commit 482b87f280e9 · 2025-06-03T16:59:06.000-07:00
Thread about better mitigation, which includes base classes too: microsoft/pyright#10537 Also, * Exceptions: Remove Pyright ignores since subclasses case has been mitigated with unfortunate '__init_subclass__' hack. * Internals: Centralize definition of 'type'-constrained type variable. * Standard: Nomina: Add type alias for Dynadoc configuration.
diff --git a/sources/classcore/__/__init__.py b/sources/classcore/__/__init__.py
@@ -26,6 +26,9 @@
 from .nomina import *
 
 
+T = typx.TypeVar( 'T', bound = type )
+
+
 dictproxy_empty: cabc.Mapping[ str, str ] = types.MappingProxyType( { } )
 
 
diff --git a/sources/classcore/decorators.py b/sources/classcore/decorators.py
@@ -26,9 +26,6 @@
 from . import utilities as _utilities
 
 
-_T = __.typx.TypeVar( '_T', bound = type )
-
-
 def apply_decorators( cls: type, decorators: _nomina.Decorators ) -> type:
     ''' Applies sequence of decorators to class.
 
@@ -75,14 +72,14 @@ def produce_class_construction_decorator(
 
         Decorator overrides ``__new__`` on metaclass.
     '''
-    def decorate( clscls: type[ _T ] ) -> type[ _T ]:
+    def decorate( clscls: type[ __.T ] ) -> type[ __.T ]:
         constructor_name = attributes_namer( 'classes', 'constructor' )
         extant = getattr( clscls, constructor_name, None )
         original = getattr( clscls, '__new__' )
         if extant is original: return clscls
 
         def construct(
-            clscls_: type[ _T ],
+            clscls_: type[ __.T ],
             name: str,
             bases: tuple[ type, ... ],
             namespace: dict[ str, __.typx.Any ], *,
@@ -108,7 +105,7 @@ def produce_class_initialization_decorator(
 
         Decorator overrides ``__init__`` on metaclass.
     '''
-    def decorate( clscls: type[ _T ] ) -> type[ _T ]:
+    def decorate( clscls: type[ __.T ] ) -> type[ __.T ]:
         initializer_name = attributes_namer( 'classes', 'initializer' )
         extant = getattr( clscls, initializer_name, None )
         original = getattr( clscls, '__init__' )
diff --git a/sources/classcore/exceptions.py b/sources/classcore/exceptions.py
@@ -29,12 +29,11 @@
     # Exception classes are immutable. Exclude from docstring updates.
     __.dynadoc.IntrospectionLimit(
         targets_exclusions = __.dynadoc.IntrospectionTargets.Class ) )
-# TODO: Mix 'with_docstring' decorator into standard sequence.
 
 
-class Omniexception( # pyright: ignore[reportGeneralTypeIssues]
+class Omniexception(
     BaseException, _standard.Object,
-    instances_visibles = ( '__cause__', '__context__' ), # pyright: ignore[reportCallIssue]
+    instances_visibles = ( '__cause__', '__context__' ),
 ):
     ''' Base exception for package. '''
 
diff --git a/sources/classcore/factories.py b/sources/classcore/factories.py
@@ -27,9 +27,6 @@
 from . import utilities as _utilities
 
 
-_T = __.typx.TypeVar( '_T', bound = type )
-
-
 def produce_class_constructor(
     attributes_namer: _nomina.AttributesNamer,
     preprocessors: _nomina.ProduceConstructorPreprocsArgument = ( ),
@@ -38,7 +35,7 @@ def produce_class_constructor(
     ''' Produces constructors for classes. '''
 
     def construct( # noqa: PLR0913
-        clscls: type[ _T ],
+        clscls: type[ __.T ],
         superf: _nomina.ClassConstructorLigation,
         name: str,
         bases: tuple[ type, ... ],
diff --git a/sources/classcore/standard/behaviors.py b/sources/classcore/standard/behaviors.py
@@ -295,7 +295,6 @@ def produce_dynadoc_configuration(
     preserve: _nomina.DynadocPreserveArgument = True,
     table: _nomina.DynadocTableArgument = __.dictproxy_empty,
 ) -> _nomina.ProduceDynadocConfigurationReturn:
-    # TODO: Move to Dynadoc package.
     return __.types.MappingProxyType( dict(
         context = _dynadoc_context,
         introspection = _dynadoc_introspection,
diff --git a/sources/classcore/standard/classes.py b/sources/classcore/standard/classes.py
@@ -19,22 +19,47 @@
 
 
 ''' Standard classes and class factories. '''
+# TODO: Mitigate issue with decoration obscuring signature of '__new__'
+#       to typecheckers:
+#       https://github.com/microsoft/pyright/discussions/10537.
+#       Get rid of '__init_subclass__' hack which only addresses problem
+#       for subclasses but not base classes.
 
 
 from . import __
 from . import decorators as _decorators
+# from . import nomina as _nomina
 
 
 _dynadoc_introspection_limit_ = (
     # Standard classes are immutable. Exclude from docstring updates.
     __.dynadoc.IntrospectionLimit(
         targets_exclusions = __.dynadoc.IntrospectionTargets.Class ) )
-# TODO: Mix 'with_docstring' decorator into standard sequence.
+
+
+# class _CfcExtraArguments( __.typx.TypedDict, total = False ):
+#
+#     class_mutables: _nomina.BehaviorExclusionVerifiersOmni
+#     class_visibles: _nomina.BehaviorExclusionVerifiersOmni
+#     decorators: _nomina.Decorators
+#     dynadoc_configuration: _nomina.DynadocConfiguration
+#     instances_mutables: _nomina.BehaviorExclusionVerifiersOmni
+#     instances_visibles: _nomina.BehaviorExclusionVerifiersOmni
 
 
 @_decorators.decoration_by( *_decorators.class_factory_decorators )
 class Class( type ): pass
 
+    # def __new__(
+    #     clscls: type[ __.T ],
+    #     name: str,
+    #     bases: tuple[ type, ... ],
+    #     namespace: dict[ str, __.typx.Any ],
+    #     *,
+    #     instances_mutables: _nomina.BehaviorExclusionVerifiersOmni = ( ),
+    # ) -> __.T:
+    #     return super( ).__new__( clscls, name, bases, namespace )
+
 
 @_decorators.decoration_by( *_decorators.class_factory_decorators )
 @__.typx.dataclass_transform( frozen_default = True, kw_only_default = True )
@@ -60,36 +85,68 @@ class ProtocolDataclass( type( __.typx.Protocol ) ): pass
 class ProtocolDataclassMutable( type( __.typx.Protocol ) ): pass
 
 
-class Object( metaclass = Class ): pass
+class Object( metaclass = Class ):
+
+    def __init_subclass__( # Typechecker appeasement.
+        cls: type, /, **arguments: __.typx.Any
+    ) -> None: super( ).__init_subclass__( **arguments )
 
 
 class ObjectMutable( # pyright: ignore[reportGeneralTypeIssues]
     metaclass = Class,
     instances_mutables = '*', # pyright: ignore[reportCallIssue]
-): pass
+):
+
+    def __init_subclass__( # Typechecker appeasement.
+        cls: type, /, **arguments: __.typx.Any
+    ) -> None: super( ).__init_subclass__( **arguments )
+
 
+class DataclassObject( metaclass = Dataclass ):
 
-class DataclassObject( metaclass = Dataclass ): pass
+    def __init_subclass__( # Typechecker appeasement.
+        cls: type, /, **arguments: __.typx.Any
+    ) -> None: super( ).__init_subclass__( **arguments )
 
 
-class DataclassObjectMutable( metaclass = DataclassMutable ): pass
+class DataclassObjectMutable( metaclass = DataclassMutable ):
 
+    def __init_subclass__( # Typechecker appeasement.
+        cls: type, /, **arguments: __.typx.Any
+    ) -> None: super( ).__init_subclass__( **arguments )
 
-class Protocol( __.typx.Protocol, metaclass = ProtocolClass ): pass
+
+class Protocol( __.typx.Protocol, metaclass = ProtocolClass ):
+
+    def __init_subclass__( # Typechecker appeasement.
+        cls: type, /, **arguments: __.typx.Any
+    ) -> None: super( ).__init_subclass__( **arguments )
 
 
 class ProtocolMutable( # pyright: ignore[reportGeneralTypeIssues]
     __.typx.Protocol,
     metaclass = ProtocolClass,
     instances_mutables = '*', # pyright: ignore[reportCallIssue]
-): pass
+):
+
+    def __init_subclass__( # Typechecker appeasement.
+        cls: type, /, **arguments: __.typx.Any
+    ) -> None: super( ).__init_subclass__( **arguments )
 
 
 class DataclassProtocol(
     __.typx.Protocol, metaclass = ProtocolDataclass,
-): pass
+):
+
+    def __init_subclass__( # Typechecker appeasement.
+        cls: type, /, **arguments: __.typx.Any
+    ) -> None: super( ).__init_subclass__( **arguments )
 
 
 class DataclassProtocolMutable(
     __.typx.Protocol, metaclass = ProtocolDataclassMutable,
-): pass
+):
+
+    def __init_subclass__( # Typechecker appeasement.
+        cls: type, /, **arguments: __.typx.Any
+    ) -> None: super( ).__init_subclass__( **arguments )
diff --git a/sources/classcore/standard/modules.py b/sources/classcore/standard/modules.py
@@ -32,7 +32,6 @@
     # Standard classes are immutable. Exclude from docstring updates.
     __.dynadoc.IntrospectionLimit(
         targets_exclusions = __.dynadoc.IntrospectionTargets.Class ) )
-# TODO: Mix 'with_docstring' decorator into standard sequence.
 
 
 class Module( __.types.ModuleType, _classes.Object ):
diff --git a/sources/classcore/standard/nomina.py b/sources/classcore/standard/nomina.py
@@ -98,8 +98,7 @@ def __call__( # pragma: no branch
     ) -> None: raise NotImplementedError
 
 
-# TODO: Remove Dynadoc-related argument aliases after
-#       'produce_dynadoc_configuration' is moved to Dynadoc package.
+DynadocConfiguration: __.typx.TypeAlias = __.cabc.Mapping[ str, __.typx.Any ]
 DynadocContextArgument: __.typx.TypeAlias = __.typx.Annotated[
     __.dynadoc.Context,
     __.dynadoc.Doc(
@@ -128,7 +127,7 @@ def __call__( # pragma: no branch
     __.dynadoc.Doc( ''' Table of documentation fragments. ''' ),
 ]
 ProduceDynadocConfigurationReturn: __.typx.TypeAlias = __.typx.Annotated[
-    __.cabc.Mapping[ str, __.typx.Any ],
+    DynadocConfiguration,
     __.dynadoc.Doc(
         ''' Dynadoc configuration dictionary.
 
