python
add vtk stub files
These are the stub files generated by the vtk script generate_pyi.py Should fix #10442
I am cleaning them and test them to be sure that it works TODO:
Cleaning:
- [ ] vtkmodules
Generating
- [ ] gtk/
- [ ] numpy_interface/
- [ ] qt/
- [ ] tk/
- [ ] util/
- [ ] web/
- [ ] wx/
- [ ] tests
![github-actions[bot] avatar](https://avatars.githubusercontent.com/in/15368?v=4 "Published by a pub.dev verified publisher"){kind=small}
I may need some help for this because the stub file generated doesn't seem to match valid python code and this generate an error I have this piece of code in the generated stub file (the comment is the error generated by mypy):
class vtkTransform(vtkLinearTransform):
@overload # Overload does not consistently use the "@staticmethod" decorator on all function signatures.
def GetOrientation(self, orient: MutableSequence[float]) -> None: ...
@overload
def GetOrientation(self) -> tuple[float, float, float]: ...
@overload
@staticmethod
def GetOrientation(orient: MutableSequence[float], matrix: vtkmodules.vtkCommonMath.vtkMatrix4x4) -> None: ...
Which, I guess, should correspond to the following python code
class vtkTransform(vtkLinearTransform):
def GetOrientation(self, orient = None):
pass
@staticmethod
def GetOrientation(orient, matrix) -> None:
pass
But this isn't valid python code, I have made this piece of code to test the behavior of the python interpreter (the comment is the error generated by my python interpreter):
class Foo:
def bar(self) -> int:
return 1
@staticmethod
def bar(i: str) -> None:
pass
print(type(Foo.bar("abc")))
print(type(Foo().bar())) # TypeError: Foo.bar() missing 1 required positional argument: 'i'
So I don't understand how they manage to do this since both methods works as expected in the case of vtk (comment correspond to the output of the script):
import vtk.vtkCommonTransforms
import vtk.vtkCommonMath
transform = vtk.vtkCommonTransforms.vtkTransform()
print(transform.GetOrientation()) # (0.0, -0.0, 0.0)
print(vtk.vtkCommonTransforms.vtkTransform.GetOrientation([0, 0, 0], vtk.vtkCommonMath.vtkMatrix4x4())) # None
Can the behavior of python be different between .py scripts and generated c++ libraries ? Or did I wrongly assume the python code behind this ? and if so what could I do to fix the mypy error ?
I started looking at this with an eye towards getting CI to pass, since this is one of the oldest open PRs. Unfortunately, there is a really huge amount of stubtest errors, more than I can deal with. This probably needs someone with deeper familiarity with the library.
Thanks for contributing! I'm closing this PR for now, because it still fails some tests after more than a year of inactivity. If you are still interested, please feel free to open a new PR (or ping us to reopen this one).