Skip to content

typed_dict Module

NumbaTypedDict

Bases: Generic[K, V]

This is simply a type hint interface for Numba typed dictionaries

Use this as a type hint wherever you would be using numba.typed.Dict and magically all of your linters will be happy.

Example: 

my_dict = numba.typed.Dict.empty(
    key_type=numba.core.types.int64,
    value_type=numba.core.types.int64
)
is type-hinted as 
my_dict: NumbaTypedDict[int, int]

Do not attempt to instantiate this object! It won't work!

Source code in src/attpc_engine/detector/typed_dict.py 
 7
 8
 9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
class NumbaTypedDict(Generic[K, V]):
    """This is simply a type hint interface for Numba typed dictionaries

    Use this as a type hint wherever you would be using numba.typed.Dict
    and magically all of your linters will be happy.

    Example:
    ```py
    my_dict = numba.typed.Dict.empty(
        key_type=numba.core.types.int64,
        value_type=numba.core.types.int64
    )
    ```
    is type-hinted as
    ```py
    my_dict: NumbaTypedDict[int, int]
    ```

    Do not attempt to instantiate this object! It won't work!
    """

    def __getitem__(self, x: K) -> V: ...

    def __setitem__(self, x: K, v: V): ...

    def __len__(self) -> int: ...

    def items(self) -> Iterable[tuple[K, V]]: ...

    def get(self, x: K, default: V | None = None) -> V: ...