Skip to content

Add type overload for __getitem__ #105

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

Closed
wants to merge 1 commit into from
Closed

Add type overload for __getitem__ #105

Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
9 changes: 7 additions & 2 deletions src/power_grid_model_ds/_core/model/arrays/base/array.py
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -6,7 +6,7 @@
from collections import namedtuple
from copy import copy
from functools import lru_cache
from typing import Any, Iterable, Literal, Type, TypeVar
from typing import Any, Iterable, Literal, Type, TypeVar, overload

import numpy as np
from numpy.typing import ArrayLike, NDArray
Expand Down Expand Up @@ -152,7 +152,12 @@ def __setattr__(self: Self, attr: str, value: object) -> None:
except (AttributeError, ValueError) as error:
raise AttributeError(f"Cannot set attribute {attr} on {self.__class__.__name__}") from error

def __getitem__(self: Self, item):
@overload
def __getitem__(self: Self, item: str | list | tuple) -> NDArray[Any]: ...
@overload
def __getitem__(self: Self, item: Any) -> Self: ...

def __getitem__(self, item):
"""Used by for-loops, slicing [0:3], column-access ['id'], row-access [0], multi-column access.
Note: If a single item is requested, return a named tuple instead of a np.void object.
"""
Expand Down