Add django.contrib.gis.db.models and django.contrib.gis.db.models.fields (#177)

* add django.contrib.gis.db.models and django.contrib.gis.db.models.fields

* install gdal in ci

* add sudo to apt

* add apt update

.travis.yml

@@ -33,6 +33,8 @@ jobs:
       script: 'isort --check'
 
 before_install: |
+  sudo apt update
+  sudo apt install binutils libproj-dev gdal-bin
   pip install -U pip setuptools wheel
 install: |
   pip install -r ./dev-requirements.txt

django-stubs/contrib/gis/db/models/__init__.pyi

@@ -0,0 +1,13 @@
+from django.db.models import *
+
+from .fields import (
+    GeometryField as GeometryField,
+    LineStringField as LineStringField,
+    MultiLineStringField as MultiLineStringField,
+    MultiPointField as MultiPointField,
+    MultiPolygonField as MultiPolygonField,
+    PointField as PointField,
+    PolygonField as PolygonField,
+    GeometryCollectionField as GeometryCollectionField,
+    RasterField as RasterField,
+)

django-stubs/contrib/gis/db/models/fields.pyi

@@ -0,0 +1,91 @@
+from typing import Any, Iterable, NamedTuple, Optional, TypeVar, Union, Tuple
+
+from django.db.models.fields import Field, _ErrorMessagesToOverride, _FieldChoices, _ValidatorCallable
+
+_Connection = Any
+
+# __set__ value type
+_ST = TypeVar("_ST")
+# __get__ return type
+_GT = TypeVar("_GT")
+
+class SRIDCacheEntry(NamedTuple):
+    units: Any
+    units_name: str
+    geodetic: bool
+    spheroid: str
+
+def get_srid_info(srid: int, connection: _Connection) -> SRIDCacheEntry: ...
+
+class BaseSpatialField(Field[_ST, _GT]):
+    def __init__(
+        self,
+        verbose_name: Optional[Union[str, bytes]] = ...,
+        srid: int = ...,
+        spatial_index: bool = ...,
+        name: Optional[str] = ...,
+        primary_key: bool = ...,
+        max_length: Optional[int] = ...,
+        unique: bool = ...,
+        blank: bool = ...,
+        null: bool = ...,
+        db_index: bool = ...,
+        default: Any = ...,
+        editable: bool = ...,
+        auto_created: bool = ...,
+        serialize: bool = ...,
+        unique_for_date: Optional[str] = ...,
+        unique_for_month: Optional[str] = ...,
+        unique_for_year: Optional[str] = ...,
+        choices: Optional[_FieldChoices] = ...,
+        help_text: str = ...,
+        db_column: Optional[str] = ...,
+        db_tablespace: Optional[str] = ...,
+        validators: Iterable[_ValidatorCallable] = ...,
+        error_messages: Optional[_ErrorMessagesToOverride] = ...,
+    ): ...
+    def spheroid(self, connection: _Connection) -> str: ...
+    def units(self, connection: _Connection) -> Any: ...
+    def units_name(self, connection: _Connection) -> str: ...
+    def geodetic(self, connection: _Connection) -> bool: ...
+
+class GeometryField(BaseSpatialField):
+    def __init__(
+        self,
+        verbose_name: Optional[Union[str, bytes]] = ...,
+        dim: int = ...,
+        geography: bool = ...,
+        extent: Tuple[float, float, float, float] = ...,
+        tolerance: float = ...,
+        srid: int = ...,
+        spatial_index: bool = ...,
+        name: Optional[str] = ...,
+        primary_key: bool = ...,
+        max_length: Optional[int] = ...,
+        unique: bool = ...,
+        blank: bool = ...,
+        null: bool = ...,
+        db_index: bool = ...,
+        default: Any = ...,
+        editable: bool = ...,
+        auto_created: bool = ...,
+        serialize: bool = ...,
+        unique_for_date: Optional[str] = ...,
+        unique_for_month: Optional[str] = ...,
+        unique_for_year: Optional[str] = ...,
+        choices: Optional[_FieldChoices] = ...,
+        help_text: str = ...,
+        db_column: Optional[str] = ...,
+        db_tablespace: Optional[str] = ...,
+        validators: Iterable[_ValidatorCallable] = ...,
+        error_messages: Optional[_ErrorMessagesToOverride] = ...,
+    ): ...
+
+class PointField(GeometryField): ...
+class LineStringField(GeometryField): ...
+class PolygonField(GeometryField): ...
+class MultiPointField(GeometryField): ...
+class MultiLineStringField(GeometryField): ...
+class MultiPolygonField(GeometryField): ...
+class GeometryCollectionField(GeometryField): ...
+class RasterField(BaseSpatialField): ...

django-stubs/db/models/fields/__init__.pyi

@@ -55,9 +55,11 @@ class Field(RegisterLookupMixin, Generic[_ST, _GT]):
     model: Type[Model]
     name: str
     verbose_name: str
+    description: str
     blank: bool = ...
     null: bool = ...
     editable: bool = ...
+    empty_strings_allowed: bool = ...
     choices: Optional[_FieldChoices] = ...
     db_column: Optional[str]
     column: str

test-data/typecheck/models/test_inheritance.yml

@@ -68,3 +68,48 @@
                 class B(models.Model):
                     b_attr = 1
                     pass
+
+
+-   case: fields_recognized_if_base_model_is_subclass_of_models_model
+    main: |
+        from myapp.models import User
+        reveal_type(User().username)  # N: Revealed type is 'builtins.str*'
+    installed_apps:
+        - myapp
+    files:
+        -   path: myapp/__init__.py
+        -   path: myapp/models.py
+            content: |
+                from django.db import models
+                from myapp.utils import MyBaseModel
+                class User(MyBaseModel):
+                    username = models.CharField(max_length=100)
+        -   path: myapp/utils.py
+            content: |
+                from django.db.models import Model
+                class MyBaseModel(Model):
+                    pass
+
+
+-   case: django_contrib_gis_base_model_mixin_inheritance
+    main: |
+        from myapp.models import User
+        reveal_type(User().name)  # N: Revealed type is 'builtins.str*'
+        reveal_type(User().updated_at)  # N: Revealed type is 'datetime.datetime*'
+    installed_apps:
+        - myapp
+    files:
+        -   path: myapp/__init__.py
+        -   path: myapp/models.py
+            content: |
+                from django.db import models
+                from django.contrib.gis.db import models as gis_models
+                class Mixin1(gis_models.Model):
+                    class Meta:
+                        abstract = True
+                class Mixin2(gis_models.Model):
+                    updated_at = models.DateTimeField(auto_now=True)
+                    class Meta:
+                        abstract = True
+                class User(Mixin1, Mixin2):
+                    name = models.TextField()