npt-promote
Mypy plugin to add type promotions between NumPy and builtin data types.
The main use case for this plugin is to enable generic use of bool, int and float
type annotations with NumPy arrays, e.g.
import numpy as np
import numpy.typing as npt
x: npt.NDArray[float] = np.array((42.0))
Installation
Dependencies:
Install it with:
python -m pip install npt-promote
Alternatively, add npt-promote as a project dependency wherever mypy is used,
e.g. as an optional dev requirement in pyproject.toml:
[project.optional-dependencies]
dev = ["mypy", "npt-promote"]
Usage
To enable the plugin, it must be added to your project's mypy configuration file
along with NumPy's mypy plugin. E.g. add the following to pyproject.toml:
[tool.mypy]
plugins = [
'numpy.typing.mypy_plugin',
'npt_promote',
]
pre-commit
To use the plugin with mypy as a pre-commit hook, it must be added as a
dependency, e.g. add the following to .pre-commit-config.yaml:
- repo: https://github.com/pre-commit/mirrors-mypy
hooks:
- id: mypy
additional_dependencies: [
"npt-promote"
]
Testing
First, install npt-promote with dev requirements:
python -m pip install npt-promote[dev]
To run the tests, execute:
pytest
Metadata
Release files for npt-promote 0.2
For a detailed explanation of source distributions (sdists) and built distributions (wheels), please see the package formats documentation.
Built distribution (wheel)
| File | Interpreter | ABI | Platform | Actions Reset |
|---|---|---|---|---|
| npt_promote-0.2-py3-none-any.whl | Python 3 | none | any | Details for npt_promote-0.2-py3-none-any.whl |
Release files / npt_promote-0.2-py3-none-any.whl
| Download URL | npt_promote-0.2-py3-none-any.whl |
|---|---|
| Size | 4.1 kB |
| Tags | Python 3 |
|
SHA-256 checksum How to use checksums |
f501cdcebf5fd98980dfa7da318300fcbef1024cd2728d416380fe43dc7f2e88
|
|
BLAKE2b-256 checksum How to use checksums |
0e79b6c4b8021e60b5a2927a9109350b19a88eb006111a6739af92e5f56c7a96
|
| Upload date | |
|
Uploaded using Trusted Publishing? What is trusted publishing? |
No |
| Uploaded via |
twine/6.0.1 CPython/3.12.2
|
Security for npt-promote 0.2
Provenance
Provenance describes where a file came from. On PyPI, provenance is shared via attestations, which provide a verifiable record of the build or publishing details. View details, limitations and caveats.
No provenance found
None of the files in this release were uploaded with provenance metadata.
A note on package security
PyPI is a repository for distributing packages, not a service for auditing them. While third-party security researchers and our staff do their best to detect and remove malicious packages, PyPI cannot guarantee the quality, security or suitability of any given package.
To learn more about protecting yourself from malicious actors, visit our package security documentation.