Static type checking or IDE intelligence support for a numpy array/matrix shape possible?

Is it possible to have static type checking or IDE intelligence support for a numpy array/matrix shape?

For example, if I imagine something like this:

A_MxN: NDArray(3,2) = ...
B_NxM: NDArray(2,3) = ...

Even better would be:

N = 3
M = 2   
A_MxN: NDArray(M,N) = ...
B_NxM: NDArray(N,M) = ...

And if I assign A to B, I would like to have an IDE hint during development time (not runtime), that the shapes are different.

Something like:

A_MxN = B_NxM
Hint/Error: Declared shape 3,2 is not compatible with assigned shape 2,3

As mentioned by @simon, this seems to be possible:

M = Literal[3]
N = Literal[2]
A_MxN: np.ndarray[tuple[M,N], np.dtype[np.int32]]

But if I assign an array which does not fulfill the shape requirement, the linter does not throw an error. Does someone know if there is a typechecker like mypy or pyright which supports the feature?

9

It’s possible to type the shape of an array, like was mentioned before.
But at the moment (numpy 2.1.1), the shape-type of the ndarray is lost in most of numpys own functions.

But the shape-typing support is gradually improving, and I’m actually personally involved in this.

But that doesn’t mean that you can’t use shape-typing yet. If you write a function yourself, you can add shape-typing support to it without too much hassle.
For instance, in Python 3.12 (with PEP 695 syntax) you can e.g. do:

from typing import Any
import numpy as np

def get_shape[ShapeT: tuple[int, ...]](a: np.ndarray[ShapeT, Any]) -> ShapeT:
    return a.shape

This will be valid in all static type-checkers with numpy>=2.1.

If this current syntax is too verbose for you, you could use the lightweight optype (of which I’m the author) to make it more readable:

from optype.numpy import Array, AtLeast0D

def get_shape[ShapeT: AtLeast0D](a: Array[ShapeT]) -> ShapeT:
    return a.shape

Array is a handy alias for ndarray, that uses (PEP 696) type parameter defaults. See the docs if you want to know the details.

It seems to be not possible right now since the constructor of an nd.array procues an NDArray[any]: https://github.com/microsoft/pyright/issues/8921

Think this thread is intersting for the topic: https://github.com/numpy/numpy/issues/16544

1

Trang chủ Giới thiệu Sinh nhật bé trai Sinh nhật bé gái Tổ chức sự kiện Biểu diễn giải trí Dịch vụ khác Trang trí tiệc cưới Tổ chức khai trương Tư vấn dịch vụ Thư viện ảnh Tin tức - sự kiện Liên hệ Chú hề sinh nhật Trang trí YEAR END PARTY công ty Trang trí tất niên cuối năm Trang trí tất niên xu hướng mới nhất Trang trí sinh nhật bé trai Hải Đăng Trang trí sinh nhật bé Khánh Vân Trang trí sinh nhật Bích Ngân Trang trí sinh nhật bé Thanh Trang Thuê ông già Noel phát quà Biểu diễn xiếc khỉ Xiếc quay đĩa Dịch vụ tổ chức sự kiện 5 sao Thông tin về chúng tôi Dịch vụ sinh nhật bé trai Dịch vụ sinh nhật bé gái Sự kiện trọn gói Các tiết mục giải trí Dịch vụ bổ trợ Tiệc cưới sang trọng Dịch vụ khai trương Tư vấn tổ chức sự kiện Hình ảnh sự kiện Cập nhật tin tức Liên hệ ngay Thuê chú hề chuyên nghiệp Tiệc tất niên cho công ty Trang trí tiệc cuối năm Tiệc tất niên độc đáo Sinh nhật bé Hải Đăng Sinh nhật đáng yêu bé Khánh Vân Sinh nhật sang trọng Bích Ngân Tiệc sinh nhật bé Thanh Trang Dịch vụ ông già Noel Xiếc thú vui nhộn Biểu diễn xiếc quay đĩa Dịch vụ tổ chức tiệc uy tín Khám phá dịch vụ của chúng tôi Tiệc sinh nhật cho bé trai Trang trí tiệc cho bé gái Gói sự kiện chuyên nghiệp Chương trình giải trí hấp dẫn Dịch vụ hỗ trợ sự kiện Trang trí tiệc cưới đẹp Khởi đầu thành công với khai trương Chuyên gia tư vấn sự kiện Xem ảnh các sự kiện đẹp Tin mới về sự kiện Kết nối với đội ngũ chuyên gia Chú hề vui nhộn cho tiệc sinh nhật Ý tưởng tiệc cuối năm Tất niên độc đáo Trang trí tiệc hiện đại Tổ chức sinh nhật cho Hải Đăng Sinh nhật độc quyền Khánh Vân Phong cách tiệc Bích Ngân Trang trí tiệc bé Thanh Trang Thuê dịch vụ ông già Noel chuyên nghiệp Xem xiếc khỉ đặc sắc Xiếc quay đĩa thú vị
Trang chủ Giới thiệu Sinh nhật bé trai Sinh nhật bé gái Tổ chức sự kiện Biểu diễn giải trí Dịch vụ khác Trang trí tiệc cưới Tổ chức khai trương Tư vấn dịch vụ Thư viện ảnh Tin tức - sự kiện Liên hệ Chú hề sinh nhật Trang trí YEAR END PARTY công ty Trang trí tất niên cuối năm Trang trí tất niên xu hướng mới nhất Trang trí sinh nhật bé trai Hải Đăng Trang trí sinh nhật bé Khánh Vân Trang trí sinh nhật Bích Ngân Trang trí sinh nhật bé Thanh Trang Thuê ông già Noel phát quà Biểu diễn xiếc khỉ Xiếc quay đĩa
Thiết kế website Thiết kế website Thiết kế website Cách kháng tài khoản quảng cáo Mua bán Fanpage Facebook Dịch vụ SEO Tổ chức sinh nhật