Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Jump to bottom

ENH: Add a mypy plugin for inferring platform-specific np.number precisions #17843

Merged
merged 13 commits into from Dec 22, 2020
Merged

ENH: Add a mypy plugin for inferring platform-specific np.number precisions #17843

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
13 commits
Select commit Hold shift + click to select a range
a528534
ENH: Added a mypy plugin for handling platform-specific `np.number` p…
Nov 16, 2020
edacfda
ENH: Centralize all `DTypeLike` string aliases in `numpy.typing`
Nov 16, 2020
0daed87
ENH: Use `intp` as return type for all appropiate functions
Nov 24, 2020
133cf30
ENH: Take the precision of `np.int_` into account arithmetic operations
Nov 24, 2020
dd7e9ad
DOC,STY: Fixed a few typos and the likes
Nov 25, 2020
0917df2
DOC: Add a docstring to the mypy plugin entry-point
Nov 25, 2020
fd17d1e
TST: Add `numpy.typing.mypy_plugin` to the list of public modules
Nov 25, 2020
8685cf3
MAINT,TST: Fixed a failure due platform-dependent precisions
Nov 25, 2020
92e549f
MAINT: Import `mypy` via a try/except approach
Nov 25, 2020
9fa57fd
ENH: Add unit support to the `datetime64`/`timedelta64` character codes
Nov 27, 2020
ba4ad04
DOC: Add a comment about truncating and sub-string matching
Nov 30, 2020
4b27d3a
Update mypy_plugin.py
Dec 11, 2020
75c532d
REL: Added a release note
Dec 11, 2020
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Jump to
Jump to file
Failed to load files.
Diff view
Diff view
22 changes: 22 additions & 0 deletions doc/release/upcoming_changes/17843.new_feature.rst
View file
Open in desktop
@@ -0,0 +1,22 @@
Added a mypy plugin for handling platform-specific `numpy.number` precisions
----------------------------------------------------------------------------

A mypy_ plugin is now available for automatically assigning the (platform-dependent)
precisions of certain `~numpy.number` subclasses, including the likes of
`~numpy.int_`, `~numpy.intp` and `~numpy.longlong`. See the documentation on
:ref:`scalar types <arrays.scalars.built-in>` for a comprehensive overview
of the affected classes.

Note that while usage of the plugin is completely optional, without it the
precision of above-mentioned classes will be inferred as `~typing.Any`.

To enable the plugin, one must add it to their mypy `configuration file`_:

.. code-block:: ini

[mypy]
plugins = numpy.typing.mypy_plugin


.. _mypy: http://mypy-lang.org/
.. _configuration file: https://mypy.readthedocs.io/en/stable/config_file.html