Replies: 19 comments 39 replies
-
|
should be... |
Beta Was this translation helpful? Give feedback.
-
|
Meybe |
Beta Was this translation helpful? Give feedback.
-
|
That’s the one! I have to write them all by hand, so it’s going to take a minute. |
Beta Was this translation helpful? Give feedback.
-
|
I don't know how boost::python works, but I see that many methods have stubs - were they generated automatically by the docstrings do not provide the names of the method parameters, I assume it is not arg1, arg2, arg3 etc., that's why I used positional-only parameters |
Beta Was this translation helpful? Give feedback.
-
|
I have a stub generator, what you posted generated from boost’s docstring, without modification I just learned about the @overload, so I’m doing exactly what you suggest, parsing that docstring I’ll go through and do all the constructors first. this is the output of Db.Text.... getting close : ) class Text:
@overload
def __init__ (self, /)-> None :
...
@overload
def __init__ (self, position: PyGe.Point3d, text: str)-> None :
...
@overload
def __init__ (self, position: PyGe.Point3d, text: str, height: float, rotation: float)-> None :
...
@overload
def __init__ (self, id: PyDb.ObjectId)-> None :
...
@overload
def __init__ (self, id: PyDb.ObjectId, mode: PyDb.OpenMode)-> None :
...
@overload
def __init__ (self, id: PyDb.ObjectId, mode: PyDb.OpenMode, erased: bool)-> None :
...
def __init__ (self)-> None :
'''Overloads:
- None: Any
- position: PyGe.Point3d, text: str
- position: PyGe.Point3d, text: str, height: float, rotation: float
- id: PyDb.ObjectId
- id: PyDb.ObjectId, mode: PyDb.OpenMode
- id: PyDb.ObjectId, mode: PyDb.OpenMode, erased: bool
'''
... |
Beta Was this translation helpful? Give feedback.
-
|
I see that in each class you define all methods, including inherited ones: class Entity(DbObject):
def addReactor (self, reactor: PyDb.EntityReactor)-> None :
...
class Curve(Entity):
def addReactor (self, reactor: PyDb.EntityReactor)-> None :
...
class Line(Curve):
def addReactor (self, reactor: PyDb.EntityReactor)-> None :
...it is enough only in the first class: class Entity(DbObject):
def addReactor (self, reactor: PyDb.EntityReactor)-> None :
...
class Curve(Entity):
...
class Line(Curve):
...
|
Beta Was this translation helpful? Give feedback.
-
|
Yes, but not on purpose. The doc string generator is a total hack, I started rolling it when I knew zero python and now it’s morphed onto a mess lol Using inspect Gives every method. A small number are actually virtual overrides from a C++ perspective. is it causing an issue? |
Beta Was this translation helpful? Give feedback.
-
|
It does not cause problems, but it is good to know where a given method is defined - whether it is the same for all |
Beta Was this translation helpful? Give feedback.
-
|
I figured it was a side affect of boost Boost generates a docstring like” I inject stuff from the C++ side, I.e.
and parse it BTW, someone on the boost::python team is supposedly working on compliant stubs. |
Beta Was this translation helpful? Give feedback.
-
|
If a given function doesn't have a docstring id assigned ( |
Beta Was this translation helpful? Give feedback.
-
|
-1 means I have not assigned it yet, eventually they will all have IDs assigned. Exporting to JSON is a workaround because SQLite wont load into BricsCAD due to a binary conflict and I need to be able to generate stubs from that platform. I’m considering changing to duckdb and removing the need for the JSON, just make the query For now, the process is, if an item does not have a docstring, add it to the database, export the table to Jason (SQLiteStudio) I.e. from .def("blockScaling", &PyDbBlockTableRecord::blockScaling, DS.ARGS())
.def("setBlockScaling", &PyDbBlockTableRecord::setBlockScaling, DS.ARGS({ "val : PyDb.BlockScaling" }))To: .def("blockScaling", &PyDbBlockTableRecord::blockScaling, DS.ARGS(XXXX))
.def("setBlockScaling", &PyDbBlockTableRecord::setBlockScaling, DS.ARGS({ "val : PyDb.BlockScaling" },XXXX))If it’s in the JSON file, it’s already in the database, so it just needs the number assigned. |
Beta Was this translation helpful? Give feedback.
-
|
Hi, I worked a bit on the stubs. |
Beta Was this translation helpful? Give feedback.
-
|
https://github.com/CEXT-Dan/PyRx/blob/main/PyRxCore%2FPyGsView.cpp#L97 argument name is missing |
Beta Was this translation helpful? Give feedback.
-
|
thanks, I had missed a couple of enums, I've added them |
Beta Was this translation helpful? Give feedback.
-
|
https://github.com/CEXT-Dan/PyRx/blob/main/PyRxCore%2FPyGsView.cpp#L97 PyGs.ViewProjection = PyGs.ViewProjection.kParallel type hints and default value provided, but argument name missing |
Beta Was this translation helpful? Give feedback.
-
|
I noticed there's some activity with boost::python's signatures and doc strings. I'll have a look when I get back |
Beta Was this translation helpful? Give feedback.
-
|
Any news? |
Beta Was this translation helpful? Give feedback.
-
|
No real changes with respect to docstrings, unfortunately. Most projects seem to be using Sphinx , or Doxygen (hand writing the python signatures), and extracting that from the C++ source. I had tried Sphinx but didn’t get anywhere. I actually think what we have is okay, it’s at least as good or better than PyGrx (gstarcad). BTW, they’re (gstarcad) using PyBind11, which I had seriously considered, but seems to have the same docstring issues. |
Beta Was this translation helpful? Give feedback.
-
|
If I understand correctly, Lines 868 to 884 in fe06413 |
Beta Was this translation helpful? Give feedback.
-
it also says
this is where I got the <> from |
Beta Was this translation helpful? Give feedback.
-
|
So it’s clear, I only had explicitly added repr in a few places, Scale, Point, Vector, Matrix, ObjectId, handle. I have not added it to enums.
outputs is not clear to me how this works |
Beta Was this translation helpful? Give feedback.
-
|
I want the angle brackets to be removed where the call to Expected result: >>> repr(PyDb.Line())
<PyDb.Line object at 0x00000294BBA831F0>
>>> obj1 = PyGe.Point3d()
>>> repr(obj1)
PyGe.Point3d(0.00000000000000,0.00000000000000,0.00000000000000)
>>> obj2 = eval(repr(obj1))
>>> obj3 = PyGe.Point3d(0.00000000000000,0.00000000000000,0.00000000000000)
>>> obj1 == obj2 == obj3
True |
Beta Was this translation helpful? Give feedback.
-
|
|
Beta Was this translation helpful? Give feedback.
-
|
Ok, I published a new test build. with the angle brackets removed |
Beta Was this translation helpful? Give feedback.
-
|
I'm almost done with improving stubs. Please fix these bugs.
|
Beta Was this translation helpful? Give feedback.
-
|
Commit 771363d |
Beta Was this translation helpful? Give feedback.
-
|
Excellent work! Way better than the hack I had! |
Beta Was this translation helpful? Give feedback.
-
|
You're like a next level coder, an artist! looking at PyDb.ErrorStatusException. I see I also have a bug, I'll try to fix this morning |
Beta Was this translation helpful? Give feedback.
-
|
Are all stubs generated on one host? on BRX? |
Beta Was this translation helpful? Give feedback.
-
|
oh yeah, I forgot about BrxBim |
Beta Was this translation helpful? Give feedback.
-
|
So no? :D I'm asking because we can make a simple launcher (like for testing) that will launch AutoCAD, generate everything available, then launch BricsCad and generate PyBr* |
Beta Was this translation helpful? Give feedback.
-
|
That would be cool! |
Beta Was this translation helpful? Give feedback.
-
|
Originally, I had thought about letting the user generate stubs to account for API differences, but then decided not to. Stubs generated from ARX, GRX, ZRX are very close and I can probably do some of the implementation to resolve differences, I.e. AcCmColor it could still be an option someday |
Beta Was this translation helpful? Give feedback.
-
|
Is it possible to generate html docs, like in pydoc, but from the .pyi files instead of the main modules? |
Beta Was this translation helpful? Give feedback.
-
|
The old generator would warn me if the return type was not fully resolved (I.e. a list or a tuple) and not in return_types.json. |
Beta Was this translation helpful? Give feedback.
-
|
or it could be written to gen_pyi.log |
Beta Was this translation helpful? Give feedback.
-
|
I'll add it. |
Beta Was this translation helpful? Give feedback.
-
|
Pylance failed to parse docstring #6951 I guess this could be us? |
Beta Was this translation helpful? Give feedback.
-
|
I thought about creating |
Beta Was this translation helpful? Give feedback.
-
|
@rdesparbes Do you have any idea how to implement this, or better idea how to combine stubs written directly in pyi files and generated ones? |
Beta Was this translation helpful? Give feedback.
-
|
We could look into templating, with jinja for example. We could write partial .pyi files with
I'm not sure if I understood everything about your use case, but it could look like:
class AcadBlock(PyAx.AcadObject):
{{ add3DFace }} # Inserts the signature of the method
"""This is the python docstring of the `add3DFace` method""" |
Beta Was this translation helpful? Give feedback.
-
|
I would like to manually create pyi files with definitions of selected classes, methods. I assume that a given function, if defined manually, must be complete (signature + formatted docstring). When generating pyi files from c++ source (as it is now) these functions would be detected and replace the generated ones. |
Beta Was this translation helpful? Give feedback.
-
|
Maybe we could extract the Abstract Syntax Tree (AST) from the generated .pyi files, browse the symbols, and replace the ones that are defined in the "overwriting" .pyi files ? One library that does that and that supports .pyi files is libcst. I have never used it, and there are probably other candidates, but it looks promising. |
Beta Was this translation helpful? Give feedback.
-
Beta Was this translation helpful? Give feedback.
-
|
For example
|
Beta Was this translation helpful? Give feedback.
-
|
Yeah, it should behave like
|
Beta Was this translation helpful? Give feedback.
-
Beta Was this translation helpful? Give feedback.
Uh oh!
There was an error while loading. Please reload this page.
-
I made a prototype of function overloading. Need to implement it.
Beta Was this translation helpful? Give feedback.
All reactions