Add support for newsemanal and django plugin 1.0.0 (#25)

* add support for newsemanal and django plugin 1.0.0

* add new linters to CI, fix setup.py

* fix mypy errors

* fix lint errors

* isort fixes

Author: mkurnikov

.gitignore

@@ -6,6 +6,4 @@ out/
 /django
 .idea/
 .mypy_cache
-drf-sources/
-pip-wheel-metadata/
-
+pip-wheel-metadata/

.gitmodules

@@ -0,0 +1,3 @@
+[submodule "drf-sources"]
+	path = drf-sources
+	url = https://github.com/encode/django-rest-framework.git

.travis.yml

@@ -7,22 +7,34 @@ sudo: required
 
 jobs:
   include:
-  - name: "run test suite with python 3.7"
-    python: 3.7
-    script: |
-      set -e
-      pytest
-
-  - name: "run test suite with python 3.6"
-    python: 3.6
-    script: |
-      set -e
-      pytest
-
-  - name: "Lint with black"
-    python: 3.7
-    script: |
-      black --check --line-length=120 rest_framework-stubs/
+    - name: Run plugin test suite with python 3.7
+      python: 3.7
+      script: |
+        set -e
+        pytest
+
+    - name: Run plugin test suite with python 3.6
+      python: 3.6
+      script: |
+        set -e
+        pytest
+
+    - name: Mypy for plugin code
+      python: 3.7
+      script: 'mypy ./mypy_drf_plugin'
+
+    - name: Lint plugin code with flake8
+      python: 3.7
+      script: 'flake8'
+
+    - name: Lint with black
+      python: 3.7
+      script: |
+        black --check --line-length=120 rest_framework-stubs/
+
+    - name: Lint plugin code with isort
+      python: 3.7
+      script: 'isort --check'
 
 before_install: |
   # Upgrade pip, setuptools, and wheel

dev-requirements.txt

@@ -1,3 +1,5 @@
 black
--e git+https://github.com/mkurnikov/pytest-mypy-plugins.git#egg=pytest-mypy-plugins
+pytest-mypy-plugins==1.0.3
+flake8==3.7.8
+isort==4.3.4
 -e .

drf-sources

@@ -0,0 +1,2 @@
+[mypy]
+ignore_missing_imports = True

mypy.ini

@@ -0,0 +1,18 @@
+FIELD_FULLNAME = 'rest_framework.fields.Field'
+BASE_SERIALIZER_FULLNAME = 'rest_framework.serializers.BaseSerializer'
+SERIALIZER_FULLNAME = 'rest_framework.serializers.Serializer'
+LIST_SERIALIZER_FULLNAME = 'rest_framework.serializers.ListSerializer'
+MODEL_SERIALIZER_FULLNAME = 'rest_framework.serializers.ModelSerializer'
+
+# TODO: finish mapping
+SERIALIZER_FIELD_MAPPING = {
+    'django.db.models.fields.AutoField': 'rest_framework.serializers.IntegerField',
+    'django.db.models.fields.BigIntegerField': 'rest_framework.serializers.IntegerField',
+    'django.db.models.fields.BooleanField': 'rest_framework.serializers.BooleanField',
+    'django.db.models.fields.CharField': 'rest_framework.serializers.CharField',
+    'django.db.models.fields.CommaSeparatedIntegerField': 'rest_framework.serializers.CharField',
+    'django.db.models.fields.DateField': 'rest_framework.serializers.DateField',
+    'django.db.models.fields.DateTimeField': 'rest_framework.serializers.DateTimeField',
+    'django.db.models.fields.DecimalField': 'rest_framework.serializers.DecimalField',
+}
+ID_TYPE = 'builtins.object'

mypy_drf_plugin/helpers.py

@@ -0,0 +1,7 @@
+from typing import Any, Dict
+
+from mypy.nodes import TypeInfo
+
+
+def get_drf_metadata(info: TypeInfo) -> Dict[str, Any]:
+    return info.metadata.setdefault('drf', {})

mypy_drf_plugin/lib/__init__.py

@@ -1,117 +1,45 @@
-from typing import Callable, Dict, Optional, Sequence
+from typing import Callable, Dict, Optional
 
 from mypy.nodes import TypeInfo
 from mypy.options import Options
-from mypy.plugin import AttributeContext, ClassDefContext, FunctionContext, MethodContext, Plugin
-from mypy.types import Instance, Type
+from mypy.plugin import ClassDefContext, Plugin
+from mypy_django_plugin import main as mypy_django_main
+from mypy_django_plugin.django.context import DjangoContext
 
-from mypy_drf_plugin import helpers, monkeypatch
-from mypy_drf_plugin.transformers import fields, serializers, validation
+from mypy_drf_plugin.lib import fullnames, helpers
+from mypy_drf_plugin.transformers import serializers
 
 
-def extract_base_model_fullname(serializer_type: Type) -> Optional[str]:
-    if not isinstance(serializer_type, Instance):
-        return None
-
-    base_model_fullname = helpers.get_drf_metadata(serializer_type.type).get('base_model')
-    if not base_model_fullname:
-        return None
-
-    return base_model_fullname
-
-
-def get_instance_of_model_bound_to_serializer(ctx: MethodContext) -> Type:
-    base_model_fullname = extract_base_model_fullname(ctx.type)
-    if not base_model_fullname:
-        return ctx.default_return_type
-
-    try:
-        return ctx.api.named_generic_type(base_model_fullname, [])
-    except AssertionError:  # cannot find a model with name
-        return ctx.default_return_type
+def transform_serializer_class(ctx: ClassDefContext) -> None:
+    sym = ctx.api.lookup_fully_qualified_or_none(fullnames.BASE_SERIALIZER_FULLNAME)
+    if sym is not None and isinstance(sym.node, TypeInfo):
+        helpers.get_drf_metadata(sym.node)['serializer_bases'][ctx.cls.fullname] = 1
 
+    serializers.make_meta_nested_class_inherit_from_any(ctx)
 
-class BaseClassTransformers:
-    def __init__(self, hooks: Sequence[Callable]):
-        self.hooks = hooks
 
-    def __call__(self, ctx: ClassDefContext) -> None:
-        for hook in self.hooks:
-            hook(ctx)
-
-
-class DRFPlugin(Plugin):
+class NewSemanalDRFPlugin(Plugin):
     def __init__(self, options: Options) -> None:
         super().__init__(options)
-        monkeypatch.make_field_repr_not_return_any_generics()
+
+        django_settings_module = mypy_django_main.extract_django_settings_module(options.config_file)
+        self.django_context = DjangoContext(django_settings_module)
 
     def _get_currently_defined_serializers(self) -> Dict[str, int]:
-        base_serializer_sym = self.lookup_fully_qualified(helpers.BASE_SERIALIZER_FULLNAME)
+        base_serializer_sym = self.lookup_fully_qualified(fullnames.BASE_SERIALIZER_FULLNAME)
         if base_serializer_sym is not None and isinstance(base_serializer_sym.node, TypeInfo):
             return (base_serializer_sym.node.metadata
                     .setdefault('drf', {})
-                    .setdefault('serializer_bases', {helpers.BASE_SERIALIZER_FULLNAME: 1,
-                                                     helpers.MODEL_SERIALIZER_FULLNAME: 1,
-                                                     helpers.SERIALIZER_FULLNAME: 1}))
-        else:
-            return {}
-
-    def _get_currently_defined_list_serializers(self) -> Dict[str, int]:
-        list_serializer_sym = self.lookup_fully_qualified(helpers.LIST_SERIALIZER_FULLNAME)
-        if list_serializer_sym is not None and isinstance(list_serializer_sym.node, TypeInfo):
-            return (helpers.get_drf_metadata(list_serializer_sym.node)
-                    .setdefault('list_serializer_bases', {helpers.LIST_SERIALIZER_FULLNAME: 1}))
+                    .setdefault('serializer_bases', {fullnames.BASE_SERIALIZER_FULLNAME: 1}))
         else:
             return {}
 
-    def _get_defined_serializer_base_classes(self) -> Dict[str, int]:
-        return {**self._get_currently_defined_serializers(), **self._get_currently_defined_list_serializers()}
-
-    def _get_defined_field_base_classes(self) -> Dict[str, int]:
-        base_field_sym = self.lookup_fully_qualified(helpers.FIELD_FULLNAME)
-        if base_field_sym is not None and isinstance(base_field_sym.node, TypeInfo):
-            return (helpers.get_drf_metadata(base_field_sym.node)
-                    .setdefault('field_bases', {helpers.FIELD_FULLNAME: 1}))
-        else:
-            return {}
-
-    def get_function_hook(self, fullname: str
-                          ) -> Optional[Callable[[FunctionContext], Type]]:
-        sym = self.lookup_fully_qualified(fullname)
-        if sym is not None and isinstance(sym.node, TypeInfo):
-            if sym.node.has_base(helpers.FIELD_FULLNAME):
-                return fields.set_generic_parameters_for_field
-
-    def get_method_hook(self, fullname: str
-                        ) -> Optional[Callable[[MethodContext], Type]]:
-        class_name, _, method_name = fullname.rpartition('.')
-        if method_name == 'to_representation':
-            if class_name in self._get_currently_defined_serializers():
-                return validation.return_typeddict_from_to_representation
-
-            if class_name in self._get_currently_defined_list_serializers():
-                return validation.return_list_of_typeddict_for_list_serializer_from_to_representation
-
-        if method_name in {'to_internal_value', 'run_validation'}:
-            if class_name in self._get_currently_defined_serializers():
-                return validation.return_typeddict_from_to_internal_value
-
-            if class_name in self._get_currently_defined_list_serializers():
-                return validation.return_list_of_typeddict_for_list_serializer_from_to_internal_value
-
-        if method_name in {'create', 'save'}:
-            if class_name in self._get_currently_defined_serializers():
-                return get_instance_of_model_bound_to_serializer
-
     def get_base_class_hook(self, fullname: str
                             ) -> Optional[Callable[[ClassDefContext], None]]:
-        if fullname in self._get_defined_serializer_base_classes():
-            return BaseClassTransformers([serializers.transform_serializer_class,
-                                          fields.set_types_metadata])
-
-        if fullname in self._get_defined_field_base_classes():
-            return fields.set_types_metadata
+        if fullname in self._get_currently_defined_serializers():
+            return transform_serializer_class
+        return None
 
 
 def plugin(version):
-    return DRFPlugin
+    return NewSemanalDRFPlugin