🐍 Add a .pyi file for integration with type checking, documentation, and IDE auto-completion#604
🐍 Add a .pyi file for integration with type checking, documentation, and IDE auto-completion#604marcelwa wants to merge 52 commits into
.pyi file for integration with type checking, documentation, and IDE auto-completion#604Conversation
…hon typing interface
…r consistency. Analogously for `volume`.
Signed-off-by: GitHub Actions <actions@github.com>
marcelwa
added
python
# Conflicts: # bindings/mnt/pyfiction/__init__.py # bindings/mnt/pyfiction/test/layouts/test_coordinates.py
Drewniok
force-pushed
the
python-interface
branch
from
d38011d to
ac2039e
Compare
![github-actions[bot]](https://avatars.githubusercontent.com/in/15368?s=60&v=4){kind=small}
| namespace pyfiction | ||
| { | ||
| #include <sstream> | ||
|
|
There was a problem hiding this comment.
warning: included header sstream is not used directly [misc-include-cleaner]
| #define PYFICTION_LOGIC_SIMULATION_HPP | ||
|
|
||
| #include "pyfiction/documentation.hpp" | ||
| #include "pyfiction/types.hpp" |
There was a problem hiding this comment.
warning: 'pyfiction/types.hpp' file not found [clang-diagnostic-error]
#include "pyfiction/types.hpp"
^| @@ -8,7 +8,8 @@ | |||
| #include "pyfiction/types.hpp" | |||
There was a problem hiding this comment.
warning: 'pyfiction/types.hpp' file not found [clang-diagnostic-error]
#include "pyfiction/types.hpp"
^| #include <pybind11/stl.h> | ||
|
|
||
| #include <cstdint> | ||
|
|
There was a problem hiding this comment.
warning: included header cstdint is not used directly [misc-include-cleaner]
| #include <pybind11/stl.h> | ||
|
|
||
| #include <cstdint> | ||
|
|
There was a problem hiding this comment.
warning: included header cstdint is not used directly [misc-include-cleaner]
| #include <cstdint> | ||
|
|
||
| #include << stdexcept> | ||
|
|
There was a problem hiding this comment.
warning: included header stdexcept is not used directly [misc-include-cleaner]
| @@ -6,7 +6,6 @@ | |||
| #define PYFICTION_OCCUPATION_PROBABILITY_OF_EXCITED_STATES_HPP | |||
|
|
|||
| #include "pyfiction/documentation.hpp" | |||
There was a problem hiding this comment.
warning: 'pyfiction/documentation.hpp' file not found [clang-diagnostic-error]
#include "pyfiction/documentation.hpp"
^| #include <fiction/utils/layout_utils.hpp> | ||
| #include <fiction/utils/version_info.hpp.in> | ||
|
|
||
| #include <pybind11/pybind11.h> |
There was a problem hiding this comment.
warning: 'pybind11/pybind11.h' file not found [clang-diagnostic-error]
#include <pybind11/pybind11.h>
^Signed-off-by: GitHub Actions <actions@github.com>
| #include <pybind11/stl.h> | ||
|
|
||
| #include <cstdint> | ||
| #include <stdexcept> |
There was a problem hiding this comment.
warning: included header cstdint is not used directly [misc-include-cleaner]
| #include <stdexcept> | |
| #include <stdexcept> |
| @@ -8,12 +8,10 @@ | |||
| #include "pyfiction/documentation.hpp" | |||
There was a problem hiding this comment.
warning: 'pyfiction/documentation.hpp' file not found [clang-diagnostic-error]
#include "pyfiction/documentation.hpp"
^| #include "pyfiction/types.hpp" | ||
|
|
||
| #include <fiction/traits.hpp> | ||
| #include <fiction/utils/layout_utils.hpp> |
There was a problem hiding this comment.
warning: included header traits.hpp is not used directly [misc-include-cleaner]
| #include <fiction/utils/layout_utils.hpp> | |
| #include <fiction/utils/layout_utils.hpp> |
…ng interface (still a long way to go)
|
|
||
| #include <string> | ||
| #include <optional> | ||
|
|
There was a problem hiding this comment.
warning: included header optional is not used directly [misc-include-cleaner]
| #include <pybind11/stl.h> | ||
|
|
||
| #include <sstream> | ||
|
|
There was a problem hiding this comment.
warning: included header sstream is not used directly [misc-include-cleaner]
| @@ -8,7 +8,6 @@ | |||
| #include "pyfiction/documentation.hpp" | |||
There was a problem hiding this comment.
warning: 'pyfiction/documentation.hpp' file not found [clang-diagnostic-error]
#include "pyfiction/documentation.hpp"
^Signed-off-by: GitHub Actions <actions@github.com>
…l errors remaining...
4 participants
Description
This PR adds a
.pyifile that defines a type interface for all pyfiction classes and functions. This helps with integration with type checking, documentation, and IDE auto-completion.Checklist: