🐍 Add a `.pyi` file for integration with type checking, documentation, and IDE auto-completion #604

marcelwa · 2024-12-04T14:38:58Z

Description

This PR adds a .pyi file that defines a type interface for all pyfiction classes and functions. This helps with integration with type checking, documentation, and IDE auto-completion.

Checklist:

The pull request only contains commits that are related to it.
I have added appropriate tests and documentation.
I have added a changelog entry.
I have created/adjusted the Python bindings for any new or updated functionality.
I have made sure that all CI jobs on GitHub pass.
The pull request introduces no new warnings and follows the project's style guidelines.

…hon typing interface

…r consistency. Analogously for `volume`.

Signed-off-by: GitHub Actions <[email protected]>

…terface

codecov · 2024-12-04T16:10:58Z

Codecov Report

All modified and coverable lines are covered by tests ✅

Project coverage is 98.12%. Comparing base (a30097d) to head (b500068).
Report is 6 commits behind head on main.

Additional details and impacted files

@@           Coverage Diff           @@
##             main     #604   +/-   ##
=======================================
  Coverage   98.11%   98.12%           
=======================================
  Files         232      232           
  Lines       35410    35411    +1     
  Branches     1691     1691           
=======================================
+ Hits        34744    34747    +3     
+ Misses        664      662    -2     
  Partials        2        2

Files with missing lines	Coverage Δ
...ction/algorithms/physical_design/color_routing.hpp	`97.82% <ø> (ø)`
...clude/fiction/algorithms/physical_design/exact.hpp	`89.42% <100.00%> (-0.09%)`	⬇️
...n/algorithms/verification/equivalence_checking.hpp	`86.27% <ø> (ø)`

... and 2 files with indirect coverage changes

Continue to review full report in Codecov by Sentry.

Legend - Click here to learn more
Δ = absolute <relative> (impact), ø = not affected, ? = missing data
Powered by Codecov. Last update a30097d...b500068. Read the comment docs.

# Conflicts: # bindings/mnt/pyfiction/__init__.py # bindings/mnt/pyfiction/test/layouts/test_coordinates.py

github-actions

clang-tidy made some suggestions

github-actions · 2024-12-04T22:04:29Z

bindings/mnt/pyfiction/include/pyfiction/algorithms/physical_design/hexagonalization.hpp

@@ -12,28 +12,29 @@

 #include <pybind11/pybind11.h>

-namespace pyfiction
-{
+#include <sstream>



warning: included header sstream is not used directly [misc-include-cleaner]

Suggested change

github-actions · 2024-12-04T22:04:29Z

bindings/mnt/pyfiction/include/pyfiction/algorithms/simulation/logic_simulation.hpp

@@ -5,7 +5,6 @@
 #ifndef PYFICTION_LOGIC_SIMULATION_HPP
 #define PYFICTION_LOGIC_SIMULATION_HPP

-#include "pyfiction/documentation.hpp"
 #include "pyfiction/types.hpp"


warning: 'pyfiction/types.hpp' file not found [clang-diagnostic-error]

#include "pyfiction/types.hpp" ^

github-actions · 2024-12-04T22:04:29Z

bindings/mnt/pyfiction/include/pyfiction/networks/truth_tables.hpp

@@ -8,7 +8,8 @@
 #include "pyfiction/types.hpp"


warning: 'pyfiction/types.hpp' file not found [clang-diagnostic-error]

#include "pyfiction/types.hpp" ^

github-actions · 2024-12-04T22:04:30Z

bindings/mnt/pyfiction/include/pyfiction/networks/truth_tables.hpp

@@ -8,7 +8,8 @@
 #include "pyfiction/types.hpp"

 #include <pybind11/pybind11.h>
-#include <pybind11/stl.h>
+
+#include <cstdint>



warning: included header cstdint is not used directly [misc-include-cleaner]

Suggested change

github-actions

clang-tidy made some suggestions

github-actions · 2024-12-10T08:15:52Z

...ction/include/pyfiction/algorithms/simulation/sidb/determine_physically_valid_parameters.hpp

@@ -14,12 +14,18 @@
 #include <pybind11/pybind11.h>
 #include <pybind11/stl.h>

+#include <cstdint>
+


warning: included header cstdint is not used directly [misc-include-cleaner]

Suggested change

github-actions · 2024-12-10T08:15:53Z

...ction/include/pyfiction/algorithms/simulation/sidb/determine_physically_valid_parameters.hpp

+#include <cstdint>
+
+#include << stdexcept>
+


warning: included header stdexcept is not used directly [misc-include-cleaner]

Suggested change

github-actions · 2024-12-10T08:15:53Z

...on/include/pyfiction/algorithms/simulation/sidb/occupation_probability_of_excited_states.hpp

@@ -6,7 +6,6 @@
 #define PYFICTION_OCCUPATION_PROBABILITY_OF_EXCITED_STATES_HPP

 #include "pyfiction/documentation.hpp"


warning: 'pyfiction/documentation.hpp' file not found [clang-diagnostic-error]

#include "pyfiction/documentation.hpp" ^

github-actions · 2024-12-10T08:15:53Z

bindings/mnt/pyfiction/include/pyfiction/utils/layout_utils.hpp

-#include "pyfiction/types.hpp"
-
-#include <fiction/utils/layout_utils.hpp>
+#include <fiction/utils/version_info.hpp.in>

 #include <pybind11/pybind11.h>


warning: 'pybind11/pybind11.h' file not found [clang-diagnostic-error]

#include <pybind11/pybind11.h> ^

Signed-off-by: GitHub Actions <[email protected]>

github-actions

clang-tidy made some suggestions

github-actions · 2024-12-10T10:10:55Z

...ction/include/pyfiction/algorithms/simulation/sidb/determine_physically_valid_parameters.hpp

@@ -14,12 +14,17 @@
 #include <pybind11/pybind11.h>
 #include <pybind11/stl.h>

+#include <cstdint>
+#include <stdexcept>


warning: included header cstdint is not used directly [misc-include-cleaner]

Suggested change

#include <stdexcept>

#include <stdexcept>

github-actions · 2024-12-10T10:10:55Z

bindings/mnt/pyfiction/include/pyfiction/utils/layout_utils.hpp

@@ -8,12 +8,10 @@
 #include "pyfiction/documentation.hpp"


warning: 'pyfiction/documentation.hpp' file not found [clang-diagnostic-error]

#include "pyfiction/documentation.hpp" ^

github-actions · 2024-12-10T10:10:55Z

bindings/mnt/pyfiction/include/pyfiction/utils/layout_utils.hpp

@@ -8,12 +8,10 @@
 #include "pyfiction/documentation.hpp"
 #include "pyfiction/types.hpp"

+#include <fiction/traits.hpp>
 #include <fiction/utils/layout_utils.hpp>


warning: included header traits.hpp is not used directly [misc-include-cleaner]

Suggested change

#include <fiction/utils/layout_utils.hpp>

#include <fiction/utils/layout_utils.hpp>

…ng interface (still a long way to go)

…terface

github-actions

clang-tidy made some suggestions

github-actions · 2024-12-10T13:41:12Z

bindings/mnt/pyfiction/include/pyfiction/algorithms/simulation/sidb/detect_bdl_pairs.hpp

 #include <pybind11/pybind11.h>
 #include <pybind11/stl.h>

-#include <string>
+#include <optional>



warning: included header optional is not used directly [misc-include-cleaner]

Suggested change

github-actions · 2024-12-10T13:41:12Z

bindings/mnt/pyfiction/include/pyfiction/algorithms/simulation/sidb/time_to_solution.hpp

@@ -11,7 +11,8 @@
 #include <fiction/algorithms/simulation/sidb/time_to_solution.hpp>

 #include <pybind11/pybind11.h>
-#include <pybind11/stl.h>
+
+#include <sstream>



warning: included header sstream is not used directly [misc-include-cleaner]

Suggested change

github-actions

clang-tidy made some suggestions

github-actions · 2024-12-12T10:28:25Z

bindings/mnt/pyfiction/include/pyfiction/technology/sidb_lattice.hpp

@@ -8,7 +8,6 @@
 #include "pyfiction/documentation.hpp"


warning: 'pyfiction/documentation.hpp' file not found [clang-diagnostic-error]

#include "pyfiction/documentation.hpp" ^

marcelwa and others added 28 commits December 2, 2024 15:46

🐍 Added a pyfiction.pyi file with an example for setting up the Pyt…

8afbc7e

…hon typing interface

🎨 Replace offset_area, cube_area, and siqad_area with area fo…

6b04f4d

…r consistency. Analogously for `volume`.

🎨 Fix duplicated namespace py = pybind11;

9458338

🏷️ Complete type interface for coordinates

d421796

🏷️ Type interface for all coordinate layouts

0ad8c54

🏷️ Type interface for all clocked layouts

b468f54

🏷️ Type interface for all gate-level layouts

edf4b03

🏷️ Type interface for all cell-level layouts

7f82138

✏️ Fix copy-paste error

559237d

🏷️ Type interface for all obstruction layouts

6113fd5

🏷️ Type interface for technology_network

5641f9f

🏷️ Type interface for dynamic_truth_table

7d19916

🏷️ Type interface for a_star

189a135

🏷️ Adjusted type interface for a_star

6fbfef9

🏷️ Type interface for distance functions

4e06684

🏷️ Type interface for enumerate_all_paths

73bf524

🏷️ Type interface for yen_k_shortest_paths

e35e38a

🏷️ Type interface for all network transformations

fb8d3d7

🐛 Fixed copy-paste errors

ee344bf

🏷️ Type interface for nm² area computations

236f63c

🏷️ Type interface for gate library application and CP/TP calculation

086ec43

🏷️ Type interface for color_routing

3bf6811

🏷️ Type interface for exact and orthogonal

5528c98

📝 Update pyfiction docstrings

f5bc1fb

Signed-off-by: GitHub Actions <[email protected]>

🏷️ Type interface for logic simulation

c27082f

Merge remote-tracking branch 'origin/python-interface' into python-in…

9acb053

…terface

🏷️ Type interface for verification

e9fa1af

🏷️ Type interface for most I/O functionality

7f6b767

marcelwa added python Pull requests that update Python code tooling Introduced or configured tools labels Dec 4, 2024

marcelwa self-assigned this Dec 4, 2024

marcelwa marked this pull request as draft December 4, 2024 14:39

Drewniok and others added 4 commits December 4, 2024 18:15

🎨 first test.

d4e2aea

🎨 first test.

ac2039e

Merge branch 'main' into python-interface

06ec97a

# Conflicts: # bindings/mnt/pyfiction/__init__.py # bindings/mnt/pyfiction/test/layouts/test_coordinates.py

🎨 Incorporated pre-commit fixes

d38011d

Drewniok force-pushed the python-interface branch from d38011d to ac2039e Compare December 4, 2024 18:15

simon1hofmann and others added 3 commits December 4, 2024 21:00

🐍 expose hexagonalization stats

55e1d81

🏷️ Type interface for more physical design algorithms

1946f06

🎨 Incorporated pre-commit fixes

1064ba7

github-actions bot reviewed Dec 4, 2024

View reviewed changes

Drewniok and others added 4 commits December 5, 2024 18:19

🎨 add SiDB functionality to pyi.

919d72f

🎨 Incorporated pre-commit fixes

3c0fbd2

🎨 add more functions to pyi.

7ebf04b

🎨 Incorporated pre-commit fixes

da13edd

github-actions bot reviewed Dec 10, 2024

View reviewed changes

marcelwa and others added 3 commits December 10, 2024 10:05

🐛 Fix compilation issue due to broken include

c493ced

🐛 Restore file that was mysteriously overwritten with a different one

b8609e7

📝 Update pyfiction docstrings

3814730

Signed-off-by: GitHub Actions <[email protected]>

github-actions bot reviewed Dec 10, 2024

View reviewed changes

marcelwa added 2 commits December 10, 2024 12:11

🐛 Fixed many errors, warnings, and inconsistencies in the Python typi…

d04cd5d

…ng interface (still a long way to go)

Merge remote-tracking branch 'origin/python-interface' into python-in…

b500068

…terface

github-actions bot reviewed Dec 10, 2024

View reviewed changes

🚨 Fixed a bunch more warnings and errors (still a long way to go)

e670dc3

github-actions bot reviewed Dec 12, 2024

View reviewed changes

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

🐍 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 #604

marcelwa commented Dec 4, 2024

codecov bot commented Dec 4, 2024 •

edited

Loading

github-actions bot left a comment

github-actions bot Dec 4, 2024

github-actions bot Dec 4, 2024

github-actions bot Dec 4, 2024

github-actions bot Dec 4, 2024

github-actions bot left a comment

github-actions bot Dec 10, 2024

github-actions bot Dec 10, 2024

github-actions bot Dec 10, 2024

github-actions bot Dec 10, 2024

github-actions bot left a comment

github-actions bot Dec 10, 2024

github-actions bot Dec 10, 2024

github-actions bot Dec 10, 2024

github-actions bot left a comment

github-actions bot Dec 10, 2024

github-actions bot Dec 10, 2024

github-actions bot left a comment

github-actions bot Dec 12, 2024

		@@ -6,7 +6,6 @@
		#define PYFICTION_OCCUPATION_PROBABILITY_OF_EXCITED_STATES_HPP

		#include "pyfiction/documentation.hpp"

	#include <fiction/utils/layout_utils.hpp>
	#include <fiction/utils/layout_utils.hpp>

🐍 Add a .pyi file for integration with type checking, documentation, and IDE auto-completion #604

Are you sure you want to change the base?

🐍 Add a .pyi file for integration with type checking, documentation, and IDE auto-completion #604

Conversation

marcelwa commented Dec 4, 2024

Description

Checklist:

codecov bot commented Dec 4, 2024 • edited Loading

Codecov Report

github-actions bot left a comment

Choose a reason for hiding this comment

github-actions bot Dec 4, 2024

Choose a reason for hiding this comment

github-actions bot Dec 4, 2024

Choose a reason for hiding this comment

github-actions bot Dec 4, 2024

Choose a reason for hiding this comment

github-actions bot Dec 4, 2024

Choose a reason for hiding this comment

github-actions bot left a comment

Choose a reason for hiding this comment

github-actions bot Dec 10, 2024

Choose a reason for hiding this comment

github-actions bot Dec 10, 2024

Choose a reason for hiding this comment

github-actions bot Dec 10, 2024

Choose a reason for hiding this comment

github-actions bot Dec 10, 2024

Choose a reason for hiding this comment

github-actions bot left a comment

Choose a reason for hiding this comment

github-actions bot Dec 10, 2024

Choose a reason for hiding this comment

github-actions bot Dec 10, 2024

Choose a reason for hiding this comment

github-actions bot Dec 10, 2024

Choose a reason for hiding this comment

github-actions bot left a comment

Choose a reason for hiding this comment

github-actions bot Dec 10, 2024

Choose a reason for hiding this comment

github-actions bot Dec 10, 2024

Choose a reason for hiding this comment

github-actions bot left a comment

Choose a reason for hiding this comment

github-actions bot Dec 12, 2024

Choose a reason for hiding this comment

🐍 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 #604

codecov bot commented Dec 4, 2024 •

edited

Loading