How are we supposed to use type annotations with thiis package

[acampove]

Hi,

In places like this I see:

class Vector4D(Vector, VectorProtocolLorentz):
    def to_Vector2D(self) -> VectorProtocolPlanar:
        return self._wrap_result(
            type(self),
            self.azimuthal.elements,
            [_aztype(self), None],
            1,
        )

    def to_Vector3D(self) -> VectorProtocolSpatial:
        return self._wrap_result(
            type(self),
            self.azimuthal.elements + self.longitudinal.elements,
            [_aztype(self), _ltype(self), None],
            1,
        )

which I use as in:

from vector                          import MomentumObject4D as v4d
...
        d_data[   'B_DIRA_OWNPV'] = self._calculate_dira(momentum=bp.to_Vector3D(), row=row, particle=   'B')
        d_data['Jpsi_DIRA_OWNPV'] = self._calculate_dira(momentum=jp.to_Vector3D(), row=row, particle='Jpsi')

        sr = pnd.Series(d_data)

        return sr
    # ------------------------------------------
    def _calculate_dira(
        self,
        row      : pnd.Series,
        momentum : v3d,
        particle : str) -> float:
        '''

And I see:

which tells me that I should be importing VectorProtocolSpatial. However, this class is not exposed through the __init__.py, which I suppose means that you intend this class to be internal. Then the only way we, the users, have to properly use type hinting is to cast the return value of this class as v4d.

Casting is the last thing that we should be doing in code. Is this the intended use or am I missing anything?

BTW that _methods.py is almost 4500 lines long, way way bigger than what a module should be. I strongly recommend cleaning that up.

[Saransh-cpp]

Hi @acampove, thanks for reporting this. Unfortunately, we won't be able to help unless we have an MWE that we can reproduce locally. Could you please update your comment with an MWE?

BTW that _methods.py is almost 4500 lines long, way way bigger than what a module should be. I strongly recommend cleaning that up.

The module contains base classes and protocols shared by all the backends; hence, all of it is in one place. But, if you feel like it can be better, contributions or suggestions are always welcome :)

[acampove]

Hi @Saransh-cpp

This is the MWE

import vector
from vector import MomentumObject3D

def _fun(vec : MomentumObject3D) -> None:
    print(vec)

vec = vector.obj(pt=1.0, eta=1.0, phi=1.0, mass=10)
v3d = vec.to_Vector3D()

_fun(vec=v3d)

save it, run pyright test.py and you will see:

(rx) [acampove@thinkbook vector]$ pyright test.py
WARNING: there is a new pyright version available (v1.1.404 -> v1.1.405).
Please install the new version or set PYRIGHT_PYTHON_FORCE_VERSION to `latest`

/home/acampove/Tests/vector/test.py
  /home/acampove/Tests/vector/test.py:10:10 - error: Argument of type "VectorProtocolSpatial" cannot be assigned to parameter "vec" of type "MomentumObject3D" in function "_fun"
    "VectorProtocolSpatial" is not assignable to "MomentumObject3D" (reportArgumentType)
1 error, 0 warnings, 0 informations

On another note: regarding contributions, I’m open to freelance opportunities, contract work, or similar collaborations. Let me know if you’d like to discuss, and I can share my hourly rates.

Cheers,
Angel

[Saransh-cpp]

Thanks, @acampove! This is definitely a bug. I have opened #642 to track it. It won't be possible for me to take a look anytime soon, but another maintainer might.

On another note: regarding contributions, I’m open to freelance opportunities, contract work, or similar collaborations. Let me know if you’d like to discuss, and I can share my hourly rates.

I work for free on open-source projects, so can't help with that haha