Add basic stubs for some class attributes

.gitignore

@@ -0,0 +1 @@
+.mypy_cache

.travis.yml

@@ -0,0 +1,17 @@
+language: python
+python: 3.6
+
+notifications:
+  email: false
+
+install:
+- pip install -r test-requirements.txt
+- if [[ $TRAVIS_PYTHON_VERSION == '3.6' ]]; then pip install flake8-pyi==17.3.0; fi
+
+script:
+- flake8
+- MYPYPATH="." mypy tests/test_simple.py
+
+cache:
+  directories:
+  - "$HOME/.cache/pip"

README.md

@@ -1,5 +1,7 @@
 # numpy_stubs: experimental typing stubs for NumPy
 
+[![Build Status](https://travis-ci.org/numpy/numpy_stubs.svg?branch=master)](https://travis-ci.org/numpy/numpy_stubs)
+
 This repository exists for developing [PEP 484](https://www.python.org/dev/peps/pep-0484/)
 compatible typing annotations for [NumPy](https://github.com/numpy/numpy).
 

numpy/__init__.pyi

@@ -1,8 +1,188 @@
 # very simple, just enough to start running tests
+#
+import builtins
+from typing import Any, Mapping, List, Optional, Tuple, Union
 
-class ndarray: pass
+from numpy.core._internal import _ctypes
+
+_Shape = Tuple[int, ...]
+
+class dtype:
+    names: Optional[Tuple[str, ...]]
+
+    @property
+    def alignment(self) -> int: ...
+
+    @property
+    def base(self) -> dtype: ...
+
+    @property
+    def byteorder(self) -> str: ...
+
+    @property
+    def char(self) -> str: ...
+
+    @property
+    def descr(self) -> List[Union[
+        Tuple[str, str],
+        Tuple[str, str, _Shape]]]: ...
+
+    @property
+    def fields(self) -> Optional[Mapping[
+        str,
+        Union[Tuple[dtype, int],
+              Tuple[dtype, int, Any]]]]: ...
+
+    @property
+    def flags(self) -> int: ...
+
+    @property
+    def hasobject(self) -> bool: ...
+
+    @property
+    def isbuiltin(self) -> int: ...
+
+    @property
+    def isnative(self) -> bool: ...
+
+    @property
+    def isalignedstruct(self) -> bool: ...
+
+    @property
+    def itemsize(self) -> int: ...
+
+    @property
+    def kind(self) -> str: ...
+
+    @property
+    def metadata(self) -> Optional[Mapping[str, Any]]: ...
+
+    @property
+    def name(self) -> str: ...
+
+    @property
+    def num(self) -> int: ...
+
+    @property
+    def shape(self) -> _Shape: ...
+
+    @property
+    def ndim(self) -> int: ...
+
+    @property
+    def subdtype(self) -> Optional[Tuple[dtype, _Shape]]: ...
+
+    def newbyteorder(self, new_order: str = ...) -> dtype: ...
+
+    # Leave str and type for end to avoid having to use `builtins.str`
+    # everywhere. See https://github.com/python/mypy/issues/3775
+    @property
+    def str(self) -> builtins.str: ...
+
+    @property
+    def type(self) -> builtins.type: ...
+
+
+_dtype_class = dtype      # for ndarray type
+
+
+class _flagsobj:
+    aligned: bool
+    updateifcopy: bool
+    writeable: bool
+    writebackifcopy: bool
+
+    @property
+    def behaved(self) -> bool: ...
+
+    @property
+    def c_contiguous(self) -> bool: ...
+
+    @property
+    def carray(self) -> bool: ...
+
+    @property
+    def contiguous(self) -> bool: ...
+
+    @property
+    def f_contiguous(self) -> bool: ...
+
+    @property
+    def farray(self) -> bool: ...
+
+    @property
+    def fnc(self) -> bool: ...
+
+    @property
+    def forc(self) -> bool: ...
+
+    @property
+    def fortran(self) -> bool: ...
+
+    @property
+    def num(self) -> int: ...
+
+    @property
+    def owndata(self) -> bool: ...
+
+    def __getitem__(self, key: str) -> bool: ...
+    def __setitem__(self, key: str, value: bool) -> None: ...
+
+
+class flatiter:
+    @property
+    def base(self) -> ndarray: ...
+
+    @property
+    def coords(self) -> _Shape: ...
+
+    @property
+    def index(self) -> int: ...
+
+    def copy(self) -> ndarray: ...
+    def __iter__(self) -> flatiter: ...
+    def __next__(self) -> Any: ...
+
+
+class ndarray:
+    dtype: _dtype_class
+    imag: ndarray
+    real: ndarray
+    shape: _Shape
+    strides: Tuple[int, ...]
+
+    @property
+    def T(self) -> ndarray: ...
+
+    @property
+    def base(self) -> Optional[ndarray]: ...
+
+    @property
+    def ctypes(self) -> _ctypes: ...
+
+    @property
+    def data(self) -> memoryview: ...
+
+    @property
+    def flags(self) -> _flagsobj: ...
+
+    @property
+    def flat(self) -> flatiter: ...
+
+    @property
+    def size(self) -> int: ...
+
+    @property
+    def itemsize(self) -> int: ...
+
+    @property
+    def nbytes(self) -> int: ...
+
+    @property
+    def ndim(self) -> int: ...
+
+    def __getattr__(self, name) -> Any: ...
 
-class dtype: pass
 
 def array(
     object: object,

numpy/core/_internal.pyi

@@ -0,0 +1,21 @@
+from typing import Any
+
+# TODO: add better annotations when ctypes is stubbed out
+
+class _ctypes:
+    @property
+    def data(self) -> int: ...
+
+    @property
+    def shape(self) -> Any: ...
+
+    @property
+    def strides(self) -> Any: ...
+
+    def data_as(self, obj: Any) -> Any: ...
+    def shape_as(self, obj: Any) -> Any: ...
+    def strides_as(self, obj: Any) -> Any: ...
+    def get_data(self) -> int: ...
+    def get_shape(self) -> Any: ...
+    def get_strides(self) -> Any: ...
+    def get_as_parameter(self) -> Any: ...

setup.cfg

@@ -0,0 +1,9 @@
+# Ignore the following errors (for stubs):
+#   E301 expected 1 blank line, found 0
+#   E302 expected 2 blank lines, found 1
+#   E305 expected 2 blank lines after class or function definition, found 1
+#   E701 multiple statements on one line (colon)
+#   E704 multiple statements on one line (def)
+
+[flake8]
+ignore = E301, E302, E305, E701, E704

setup.py

@@ -1,7 +1,7 @@
 from setuptools import setup, find_packages
 
 setup(
-    name='numpy_stubs',
+    name='numpy-stubs',
     maintainer="NumPy Developers",
     maintainer_email="numpy-discussion@python.org",
     description="PEP 561 type stubs for numpy",
@@ -11,8 +11,8 @@
     packages=find_packages(),
 
     # PEP 561 requires these
-    install_requires=['numpy~=1.13.0'],
+    install_requires=['numpy~=1.14.0'],
     package_data={
-    	'numpy': 'py.typed'
+        'numpy': 'py.typed'
     },
 )

test-requirements.txt

@@ -0,0 +1,3 @@
+flake8==3.3.0
+
+mypy==0.560.0