Python: information around struct base classes is lost

[rix0rrr]

Structs are implemented in Python using mypy_extensions.TypedDict.

Unfortunately, this class uses a metaclass that completely destroys class inheritance information:

    def test_inheritance_maintained(self):
        """Check that for JSII struct types the inheritance relationship is maintained."""
        bases = inspect.getmro(jsii_calc.DerivedStruct)
        print(jsii_calc.DerivedStruct.__annotations__)
        print(bases)

The __annotations__ contain all annotations from base classes, but the getmro() returns:

(<class 'importlib._bootstrap.DerivedStruct'>, <class 'dict'>, <class 'object'>)

Even though the actual declaration of DerivedStruct looks like this:

class _DerivedStruct(scope.jsii_calc_lib.MyFirstStruct, jsii.compat.TypedDict, total=False):
    anotherOptional: typing.Mapping[str,scope.jsii_calc_lib.Value]
    """This is optional."""
    optionalAny: typing.Any
    optionalArray: typing.List[str]

@jsii.data_type(jsii_type="jsii-calc.DerivedStruct")
class DerivedStruct(_DerivedStruct):

So we are missing the bases _DerivedStruct and MyFirstStruct (and everything above).

Without these bases, we can't generate docs for those members.

[rix0rrr]

The way I've fixed this now is actually not great, because it's not going to be useful to IDEs.

We should just generate a complete "Attributes" block in the class docstring instead. This can be done later.

[github-actions]

This issue has not received any attention in 2 years. If you want to keep this issue open, please leave a comment below and auto-close will be canceled.