Add basic stubs for some class attributes #9

alanhdu · 2018-02-18T01:22:43Z

No description provided.

alanhdu · 2018-02-18T01:24:08Z

numpy/__init__.pyi

+
+    def newbyteoder(self, new_order:str = ...): dtype
+
+    str: builtins.str


I've segregated this here so that the other strs don't need to have builtins.str here (see python/mypy#3775).

Please add this as a comment in the code

shoyer

This is a great start, thanks!

shoyer · 2018-02-18T02:27:08Z

numpy/__init__.pyi

+    alignment: int
+    byteorder: str
+    char: str
+    descr: List[Tuple[str, str]]


Entries in descr can only be three element tuples, with the last item indicating a shape, e.g.,

>>> np.dtype([('x', 'f4'), ('y', np.float32), ('z', 'f4', (2,2))]).descr [('x', '<f4'), ('y', '<f4'), ('z', '<f4', (2, 2))]

shoyer · 2018-02-18T02:33:36Z

numpy/__init__.pyi

+    byteorder: str
+    char: str
+    descr: List[Tuple[str, str]]
+    fields: Optional[Mapping[str, Union[Tuple[dtype, int], Tuple[dtype, int, str]]]]


It looks like the final title field can have any type, so it should probably be keyed as Any instead of str: https://docs.scipy.org/doc/numpy-1.13.0/reference/generated/numpy.dtype.fields.html#numpy.dtype.fields

shoyer · 2018-02-18T02:42:01Z

numpy/__init__.pyi

+
+    def newbyteoder(self, new_order:str = ...): dtype
+
+    str: builtins.str


Please add this as a comment in the code

shoyer · 2018-02-18T02:42:37Z

numpy/__init__.pyi

+    subdtype: Optional[Tuple[dtype, Tuple[int, ...]]]
+
+
+    def newbyteoder(self, new_order:str = ...): dtype


please keep the space after : per pep8. This should be new_order: str = ...

shoyer · 2018-02-18T02:42:55Z

numpy/__init__.pyi

+    subdtype: Optional[Tuple[dtype, Tuple[int, ...]]]
+
+
+    def newbyteoder(self, new_order:str = ...): dtype


please keep the space after : per pep8. This should be:

new_order: str = ...

shoyer · 2018-02-18T02:48:03Z

numpy/__init__.pyi

+    type: builtins.type
+
+    @property
+    def base(self) -> dtype: ...


Is there a reason why this is a property vs. an attribute for everything else? Does mypy care about the difference?

Properties can't be assigned to unless they have a setter. With this stub, if you had x: dtype, mypy would allow x.type = some_type but not x.base = some_dtype.

OK, in that case we should also convert most of the other attributes into readonly properties.

shoyer · 2018-02-18T02:49:11Z

numpy/__init__.pyi

+_dtype = dtype      # for ndarray type
+
+
+class flagsobj:


flagsobj is not exposed by NumPy's public API, so let's give it a private name (_flagsobj?)

shoyer · 2018-02-18T02:54:26Z

numpy/__init__.pyi

+    def base(self) -> dtype: ...
+
+
+_dtype = dtype      # for ndarray type


Give this a name like _dtype_class to make it a little clearer what it is?

shoyer · 2018-02-18T02:54:53Z

numpy/__init__.pyi

+    data: memoryview
+    dtype: _dtype
+    flags: flagsobj
+    flat: Any


This is a flatiter object

shoyer · 2018-02-18T02:56:48Z

numpy/__init__.pyi

+    shape: Tuple[int, ...]
+    strides: Tuple[int, ...]
+    ctypes: _ctypes
+    base: Optional[ndarray]



This list is incomplete for now, so let's add def __getattr__(self, name) -> Any: ....

JelleZijlstra · 2018-02-18T03:01:22Z

numpy/__init__.pyi

+    subdtype: Optional[Tuple[dtype, Tuple[int, ...]]]
+
+
+    def newbyteoder(self, new_order:str = ...): dtype


I assume this should be newbyteorder, not newbyteoder?

* Replace tab in setup.py with spaces * Add Travis * Add flake8 config to pass tests * Use `-` instead of `_` See python/peps#568 * Add Travis badge to README * Use numpy 1.14.0

alanhdu · 2018-02-18T14:24:51Z

This should be ready for another round of review!

shoyer · 2018-02-18T19:12:09Z

numpy/__init__.pyi

+    @property
+    def descr(self) -> List[Union[
+        Tuple[str, str],
+        Tuple[str, str, Tuple[int, ...]]]]: ...


optional: it might be convenient to define an alias _Shape = Tuple[int, ...]

shoyer · 2018-02-18T19:14:26Z

numpy/__init__.pyi

+    names: Optional[Tuple[str, ...]]
+    updateifcopy: bool
+    writeable: bool
+    writebackifcopy: bool


I'm not quite sure where these attributes came from -- I can't find any of updateifcopy, writeable and writebackifcopy on dtype.

Actually, these are missing down below on flagsobj.

shoyer · 2018-02-19T01:35:03Z

numpy/__init__.pyi

+    def str(self) -> builtins.str: ...
+
+    @property
+    def type(self) -> builtins.type: ...


More specifically, we could define the np.generic class and switch this to Type[generic] (but this is also fine for now -- certainly let's save defining the full NumPy scalar type hierarchy for later).

shoyer · 2018-02-19T19:12:32Z

Thanks @alanhdu !

eric-wieser · 2018-03-06T00:26:09Z

numpy/__init__.pyi

+    def type(self) -> builtins.type: ...
+
+
+_dtype_class = dtype      # for ndarray type


Why does this have a duplicate name?

Otherwise mypy gets confused when you to type the dtype ndarray attribute, e.g., def dtype(self) -> dtype refers to ndarray.dtype for the return value, not the dtype class.

Can you fix it with an import numpy as np, and then using np.dtype?

I don't know exactly how mypy handles circular imports, but I suspect that importing a module from itself would not work.

alanhdu added 3 commits February 15, 2018 18:59

Add some typehints

d9063b9

Add ctypes typehints

f6efbfd

Add stubs for dtype

cf16064

alanhdu commented Feb 18, 2018

View reviewed changes

shoyer reviewed Feb 18, 2018

View reviewed changes

JelleZijlstra reviewed Feb 18, 2018

View reviewed changes

Alan Du and others added 3 commits February 18, 2018 08:57

Setup Travis and correct setup.py (numpy#8)

b814fac

* Replace tab in setup.py with spaces * Add Travis * Add flake8 config to pass tests * Use `-` instead of `_` See python/peps#568 * Add Travis badge to README * Use numpy 1.14.0

Fix some type annotations

59bd6bc

Make attributes read-only properties

5bffb72

alanhdu force-pushed the stubs branch from 50900a2 to 5bffb72 Compare February 18, 2018 14:18

Add metadata property

eac85ff

shoyer reviewed Feb 18, 2018

View reviewed changes

shoyer reviewed Feb 19, 2018

View reviewed changes

alanhdu added 3 commits February 19, 2018 12:28

Move flags into flagobj

d6c586c

Add _Shape type alias

3cc8475

Alphabetize properties

c84c9bc

shoyer merged commit 6166b30 into numpy:master Feb 19, 2018

alanhdu deleted the stubs branch February 19, 2018 20:13

eric-wieser reviewed Mar 6, 2018

View reviewed changes


		def newbyteoder(self, new_order:str = ...): dtype

		str: builtins.str

		subdtype: Optional[Tuple[dtype, Tuple[int, ...]]]


		def newbyteoder(self, new_order:str = ...): dtype

		def base(self) -> dtype: ...


		_dtype = dtype # for ndarray type

		def type(self) -> builtins.type: ...


		_dtype_class = dtype # for ndarray type

Uh oh!

Add basic stubs for some class attributes #9

Add basic stubs for some class attributes #9

Uh oh!

Conversation

alanhdu commented Feb 18, 2018

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

shoyer left a comment

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

alanhdu commented Feb 18, 2018

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

shoyer Feb 19, 2018 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Choose a reason for hiding this comment

Uh oh!

shoyer commented Feb 19, 2018

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Uh oh!

shoyer Feb 19, 2018 •

edited

Loading