Getting error trying to use Axis as a param to Hub initialization

[IronManion]

Hi all -

When I try to initialize the Spike Prime Hub, it won't accept Axis.Z as a parameter in VSCode.

        self.hub = PrimeHub(top_side=Axis.X, front_side=Axis.Z, broadcast_channel=None, observe_channels=[])

I get this error:

Argument of type "Matrix" cannot be assigned to parameter "front_side" of type "Axis" in function "__init__"
  "Matrix" is not assignable to "Axis"Pylance[reportArgumentType](https://github.com/microsoft/pyright/blob/main/docs/configuration.md#reportArgumentType)

I searched and found this answer: https://github.com/orgs/pybricks/discussions/1396

But that isn't working...

Here are all my imports:

from pybricks.tools import wait
from pybricks.pupdevices import Motor, ColorSensor
from pybricks.robotics import DriveBase
from pybricks.hubs import PrimeHub
from pybricks.tools import wait
from pybricks.parameters import (
    Port,
    Direction,
    Axis,
    Side,
    Stop,
    Color,
    Button,
    Icon,
)

I feel like I am missing something simple. I'm relatively new to Python, so it is probably something easy....

[dlech]

This is just a bug in the type hints. It should still work if you actually run the program.

X, Y, and Z should probably have type Axis, not Matrix here: https://github.com/pybricks/pybricks-api/blob/04fb7e3e19d81c10c3d79c8a78a66a62402a950f/src/pybricks/parameters.py#L69-L71

And the parameters should accept any Matrix, not just Axis. So the type hint should be Union[Axis, Matrix] or just Matrix, e.g here: https://github.com/pybricks/pybricks-api/blob/04fb7e3e19d81c10c3d79c8a78a66a62402a950f/src/pybricks/hubs.py#L213C16-L213C17

[IronManion]

So a Pybricks fix?

[dlech]

Yes, the type hints in the pybricks-api repo I linked need to be fixed.

[MrGibbage]

As a possible workaround, can we use the @no_type_check decorator, which requires us to use from typing import no_type_check? I'm not sure we can import typing though, because I don't think it is part of a standard micropython firmware. I'm on travel and I don't have access to a hub to test for myself. I'm just looking for anything we can do to suppress the warnings/errors, short of disabling type checking entirely (which is an option, but I'd rather not do that)

[dlech]

That will throw an exception at runtime. If you really wanted to you could probably do something like:

try:
    from typing import no_type_check
except ImportError:
    def no_type_check(x):
        return x

But simpler would be to use special comments that do the same thing - and works in more places, i.e. # type: ignore. (And doesn't waste any memory either)

[MrGibbage]

Well, there you go. I learned something new about python today! Thanks :)