René's URL Explorer Experiment

{"@context":"https://schema.org","@type":"DiscussionForumPosting","headline":"On the way to [pybind11-mypy-demo]","articleBody":"## Pybind demo module\r\n\r\n### Basics \r\n - Functions\r\n   - :heavy_check_mark: w/o args \r\n   - :heavy_check_mark: anonymous args \r\n   - :heavy_check_mark: named args \r\n   - :heavy_check_mark: defaulted args\r\n   - *args / **kwargs\r\n - Classes\r\n   - :heavy_check_mark: overloaded init\r\n   - :heavy_check_mark: instance property ro/rw\r\n   - :heavy_check_mark: class property ro/rw\r\n   - :heavy_check_mark: instance attribute\r\n   - :heavy_check_mark: class attribute\r\n\r\n## Stubgen features\r\n\r\n#### Render values:\r\n- defaulted function argument values\r\n- \"builtin-valued\" attributes as is\r\n- custom type valued attributes as comments\r\n- pybind11-enum-valued attributes/arg default values\r\n- module-valued class attributes\r\n\r\n#### Render class/static members\r\n- class function \r\n- static function\r\n- :heavy_check_mark: class property -\u003e ClassVar\r\n\r\n#### Correct order of module elements\r\n- Sort classes in topo-alpha order (`ZBase` class would go before `ADerived` but `Cat` goes before `Dog`)\r\n\r\n#### Render docstrings\r\n- Add CLI option\r\n- :question: Add docstring preprocessing hooks\r\n- Strip overloads annotations \r\n\r\n#### Proper imports\r\n- Import modules as underscored aliases\r\n\r\n#### Corner cases\r\n- Skip `__hash__ = None` for non-hashable types\r\n- don't render `__init__` for non-constructable classes\r\n- [conditionally] strip `numpy.ndarray` shape info\r\n- [conditionally] strip `std::array` shape info\r\n \r\n#### Robustness to bad docstrings \r\n- [conditionally] Render C++ types in signatures as strings (arguments or/and return type)\r\n- [conditionally] Render Invalid python expression as argument default value as strings\r\n- [conditionally] Produce error/warnings on above \r\n\r\n\r\n\u003cdetails\u003e\u003csummary\u003eMisc things to test (unordered)\u003c/summary\u003e\r\n\r\n- exclude umbrella `(*args, **kwargs)` overload header from overload list\r\n- static/class functions and ro/rw properties\r\n- regular ro/rw properties\r\n- kw-only function arguments\r\n- positional-only function arguments\r\n- non-constructable types (with missing `__init__`)\r\n- numpy arrays (how to handle shape?)\r\n- don't produce import statement for nested classes\r\n- (?) exclude `__hash__ = None` line for non-hashable types that have `__eq__`\r\n- (?) test nested class argument defined in submodule\r\n- import names that not defined in module as underscored aliases\r\n- test copy/opaque pybind types (including `pybind11/stl.h` and `pybind11/stl_bind.h`)\r\n- test registered exception render\r\n- render classes in alpha-topological order (so `ZBase` class would go before `ADerived` but `Cat` goes before `Dog`)\r\n- render functions after classes\r\n- render module attributes that depend on the following classes with string types annotation (e.g. `x: 'Foo' = ...`)\r\n- fix pybind versions (e.g. replace `iterator` with `Iterator`)\r\n- skip pybind11-internal attributes\r\n- render pybind-overloaded \"magic\" python methods (e.g. `__add__`)\r\n- [optional] render docstrings\r\n\r\n\r\n\u003c/details\u003e","author":{"url":"https://github.com/sizmailov","@type":"Person","name":"sizmailov"},"datePublished":"2021-01-08T09:57:17.000Z","interactionStatistic":{"@type":"InteractionCounter","interactionType":"https://schema.org/CommentAction","userInteractionCount":3},"url":"https://github.com/1/python_example/issues/1"}