Rename NullableAttribute to NullableAttributeWrapper (#1)

Author: ikonst

pynamodb_mypy/__init__.py

@@ -9,7 +9,7 @@
 from mypy.plugin import Plugin
 
 ATTR_FULL_NAME = 'pynamodb.attributes.Attribute'
-NULL_ATTR_FULL_NAME = 'pynamodb.attributes._NullableAttribute'
+NULL_ATTR_WRAPPER_FULL_NAME = 'pynamodb.attributes._NullableAttributeWrapper'
 
 
 class PynamodbPlugin(Plugin):
@@ -58,7 +58,7 @@ def _attribute_instantiation_hook(ctx: FunctionContext,
             return ctx.default_return_type
 
         if null_arg_expr.fullname == 'builtins.True':
-            return ctx.api.named_generic_type(NULL_ATTR_FULL_NAME, [
+            return ctx.api.named_generic_type(NULL_ATTR_WRAPPER_FULL_NAME, [
                 ctx.default_return_type,
                 underlying_type,
             ])

requirements.txt

@@ -1,6 +1,8 @@
 -e .
-# Remove this line after mypy-0.660 is released
--e git+git://github.com/ikonst/mypy.git@5a8dffb5bd94bda615703f6994d39ea1c7c02ef5#egg=mypy
+# TODO: Remove this line after mypy-0.660 is released
+-e git+git://github.com/python/mypy.git@2b8691d8a485fbb91f28e6d570b147a629213118#egg=mypy
+# TODO: Remove this line after https://github.com/pynamodb/PynamoDB/pull/579 is released
+-e git+git://github.com/ikonst/pynamodb.git@1efc2abd42afc5c759655a0abde8b823aeb18a1c#egg=pynamodb
 pre-commit
 pytest
 pytest-cov

setup.py

@@ -11,6 +11,8 @@
     packages=find_packages(exclude=['tests/*']),
     install_requires=[
         'mypy>=0.660',
+        # TODO: update version after https://github.com/pynamodb/PynamoDB/pull/579 is released
+        'pynamodb',
     ],
     python_requires='>=3',
 )

tests/test_plugin.py

@@ -24,27 +24,41 @@ def test_unicode_attribute():
     from pynamodb.models import Model
 
     class MyModel(Model):
-        my_attr = UnicodeAttribute(null=True)
+        my_attr = UnicodeAttribute()
+        my_nullable_attr = UnicodeAttribute(null=True)
 
-    reveal_type(MyModel.my_attr)  # E: Revealed type is 'pynamodb.attributes._NullableAttribute[pynamodb.attributes.UnicodeAttribute, builtins.str]'
-    reveal_type(MyModel().my_attr)  # E: Revealed type is 'Union[builtins.str*, None]'
-    MyModel().my_attr.lower()  # E: Item "None" of "Optional[str]" has no attribute "lower"
-    """)  # noqa: E501
+    reveal_type(MyModel.my_attr)  # E: Revealed type is 'pynamodb.attributes.UnicodeAttribute'
+    reveal_type(MyModel.my_nullable_attr)  # E: Revealed type is 'pynamodb.attributes.UnicodeAttribute*'
+    reveal_type(MyModel().my_attr)  # E: Revealed type is 'builtins.str*'
+    reveal_type(MyModel().my_nullable_attr)  # E: Revealed type is 'Union[builtins.str*, None]'
+
+    MyModel().my_attr.lower()
+    MyModel().my_nullable_attr.lower()  # E: Item "None" of "Optional[str]" has no attribute "lower"
+    """)
 
 
-def test_custom_type():
+def test_custom_attribute():
     assert_mypy_output("""
     from pynamodb.attributes import Attribute
     from pynamodb.models import Model
 
     class BinaryAttribute(Attribute[bytes]):
-        pass
+        def do_something(self) -> None: ...
 
     class MyModel(Model):
-        my_attr = BinaryAttribute(null=True)
-
-    reveal_type(MyModel().my_attr)  # E: Revealed type is 'Union[builtins.bytes*, None]'
-    """)
+        my_attr = BinaryAttribute()
+        my_nullable_attr = BinaryAttribute(null=True)
+
+    reveal_type(MyModel.my_attr)  # E: Revealed type is '__main__.BinaryAttribute'
+    reveal_type(MyModel.my_attr.exists)  # E: Revealed type is 'def () -> pynamodb.expressions.condition.Exists'
+    reveal_type(MyModel.my_attr.do_something)  # E: Revealed type is 'def ()'
+    reveal_type(MyModel().my_attr)  # E: Revealed type is 'builtins.bytes*'
+
+    reveal_type(MyModel.my_nullable_attr)  # E: Revealed type is '__main__.BinaryAttribute*'
+    reveal_type(MyModel.my_nullable_attr.exists)  # E: Revealed type is 'def () -> pynamodb.expressions.condition.Exists'
+    reveal_type(MyModel.my_nullable_attr.do_something)  # E: Revealed type is 'def ()'
+    reveal_type(MyModel().my_nullable_attr)  # E: Revealed type is 'Union[builtins.bytes*, None]'
+    """)  # noqa: E501
 
 
 def test_unexpected_number_of_nulls():