Skip to content

Commit d3ec911

Browse files
iliapolomrgrain
authored andcommitted
fix(python): user defined __jsii_proxy_class attributes are not preserved (#4625)
In #4611, we added the `_jsii_proxy_class__` attributes to the `@jsii.interface` implementations. This was required in order to comply with `typeguard` protocol checking. We didn't implement it correctly, accidentally overriding user defined proxy classes. ## Note I have been wrecking my brain trying to understand if this bug has any runtime implications, and I couldn't find any. #### How so? At runtime, from what I could gather, the `__jsii_proxy_class__` attribute is only used when we try to instantiate a subclass of an abstract class: https://github.com/aws/jsii/blob/dc77d6c7016bcb7531f6e374243410f969ea1fbf/packages/%40jsii/python-runtime/src/jsii/_reference_map.py#L65-L70 However, for abstract classes, we assign an explicit value to `__jsii_proxy_class__`: https://github.com/aws/jsii/blob/dc77d6c7016bcb7531f6e374243410f969ea1fbf/packages/jsii-pacmak/lib/targets/python.ts#L1496-L1501 Luckily, this happens **AFTER** the `@jsii.implements` decorator has finished, thus overriding the mistake in the decorator. Presumably, this would still be a problem for user defined abstract classes (since they don't have this assignment). However, reference resolving for user defined classes is done via native reference lookup: https://github.com/aws/jsii/blob/dc77d6c7016bcb7531f6e374243410f969ea1fbf/packages/%40jsii/python-runtime/src/jsii/_reference_map.py#L48-L54 This is also why I couldn't come up with a real life test case, and had to resort to an artificial one. --- By submitting this pull request, I confirm that my contribution is made under the terms of the [Apache 2.0 license]. [Apache 2.0 license]: https://www.apache.org/licenses/LICENSE-2.0
1 parent 3b9adc4 commit d3ec911

File tree

2 files changed

+32
-1
lines changed

2 files changed

+32
-1
lines changed

packages/@jsii/python-runtime/src/jsii/_runtime.py

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -168,7 +168,7 @@ def implements(*interfaces: Type[Any]) -> Callable[[T], T]:
168168
def deco(cls):
169169
cls.__jsii_type__ = getattr(cls, "__jsii_type__", None)
170170
cls.__jsii_ifaces__ = getattr(cls, "__jsii_ifaces__", []) + list(interfaces)
171-
cls.__jsii_proxy_class__ = lambda: getattr(cls, "__jsii_proxy_class__", None)
171+
cls.__jsii_proxy_class__ = getattr(cls, "__jsii_proxy_class__", lambda: None)
172172

173173
# https://github.com/agronholm/typeguard/issues/479
174174
cls.__protocol_attrs__ = getattr(cls, "__protocol_attrs__", [])

packages/@jsii/python-runtime/tests/test_python.py

Lines changed: 31 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -27,6 +27,37 @@ def test_inheritance_maintained(self):
2727

2828
assert base_names == ["DerivedStruct", "MyFirstStruct"]
2929

30+
31+
class TestImplementsInterface:
32+
33+
def test_jsii_proxy_class_defaults_to_none(self) -> None:
34+
@jsii.implements(IBaz)
35+
class MyBaz:
36+
pass
37+
38+
klass = getattr(MyBaz, "__jsii_proxy_class__")()
39+
assert klass == None
40+
41+
def test_jsii_proxy_class_preserves_user_defined_attribute(self) -> None:
42+
43+
class _MyBazProxy:
44+
def baz_method(self) -> str:
45+
return "_MyBazProxy"
46+
47+
@jsii.implements(IBaz)
48+
class MyBaz:
49+
50+
@staticmethod
51+
def __jsii_proxy_class__():
52+
return _MyBazProxy
53+
54+
def baz_method(self) -> str:
55+
return "MyBaz"
56+
57+
klass = getattr(MyBaz, "__jsii_proxy_class__")()
58+
instance = klass()
59+
assert instance.baz_method() == "_MyBazProxy"
60+
3061
def test_implements_interface(self) -> None:
3162
"""Checks that jsii-generated classes correctly implement the relevant jsii-generated interfaces."""
3263

0 commit comments

Comments
 (0)