perf: add nox command to generate pyi stubs (#89)

* perf: add nox command to generate pyi stubs Signed-off-by: l.feng <[email protected]> * Sync template Signed-off-by: l.feng <[email protected]> --------- Signed-off-by: l.feng <[email protected]>
serious-scaffold · Dec 30, 2024 · 678b574 · 678b574
1 parent 413c6ff
commit 678b574
Show file tree

Hide file tree

Showing 8 changed files with 54 additions and 14 deletions.
diff --git a/noxfile.py b/noxfile.py
@@ -11,7 +11,7 @@
 nox.options.sessions = ["lint", "pylint", "tests"]
 
 
-@nox.session
+@nox.session(reuse_venv=True)
 def lint(session: nox.Session) -> None:
     """
     Run the linter.
@@ -92,6 +92,16 @@ def build(session: nox.Session) -> None:
     session.run("python", "-m", "build")
 
 
+@nox.session(reuse_venv=True)
+def pyi(session: nox.Session) -> None:
+    """
+    Generate the Pyi type stubs.
+    """
+    session.install("pybind11-stubgen")
+    session.install(".[test]")
+    session.run("pybind11-stubgen", "ss_pybind11._core", "-o", "src")
+
+
 @nox.session(reuse_venv=True)
 def template(session: nox.Session) -> None:
     """

diff --git a/pyproject.toml b/pyproject.toml
@@ -158,7 +158,7 @@ isort.required-imports = ["from __future__ import annotations"]
 
 [tool.pylint]
 py-version = "3.8"
-ignore-paths = [".*/_version.py"]
+ignore-paths = [".*/_version.py", ".*/*.pyi"]
 extension-pkg-allow-list = ["ss_pybind11._core"]
 reports.output-format = "colorized"
 similarities.ignore-imports = "yes"

diff --git a/src/_core/src/pybind.cpp b/src/_core/src/pybind.cpp
@@ -8,9 +8,9 @@ PYBIND11_MODULE(_core, m) {
       Pybind11 _core plugin
       -----------------------
       .. currentmodule:: _core
-  )pbdoc";
+    )pbdoc";
 
     m.def("version", []() { return _core::ProjectVersion(); }, R"pbdoc(
-      The _core plugin version.
-  )pbdoc");
+        The _core plugin version.
+    )pbdoc");
 }
diff --git a/src/ss_pybind11/_core.pyi b/src/ss_pybind11/_core.pyi
@@ -1,6 +1,16 @@
-"""Pybind11 _core plugin interfaces"""
+"""
+
+Pybind11 _core plugin
+-----------------------
+.. currentmodule:: _core
+
+"""
 
 from __future__ import annotations
 
+__all__ = ["version"]
+
 def version() -> str:
-    """_core plugin version."""
+    """
+    The _core plugin version.
+    """
diff --git a/template/noxfile.py.jinja b/template/noxfile.py.jinja
@@ -11,7 +11,7 @@ DIR = Path(__file__).parent.resolve()
 nox.options.sessions = ["lint", "pylint", "tests"]
 
 
-@nox.session
+@nox.session(reuse_venv=True)
 def lint(session: nox.Session) -> None:
     """
     Run the linter.
@@ -110,6 +110,16 @@ def build(session: nox.Session) -> None:
 
     session.install("build")
     session.run("python", "-m", "build")
+
+
+@nox.session(reuse_venv=True)
+def pyi(session: nox.Session) -> None:
+    """
+    Generate the Pyi type stubs.
+    """
+    session.install("pybind11-stubgen")
+    session.install(".[test]")
+    session.run("pybind11-stubgen", "{{ module_name }}._core", "-o", "src")
 [%- if repo_name == 'ss-pybind11' %]
 
 

diff --git a/template/pyproject.toml.jinja b/template/pyproject.toml.jinja
@@ -211,7 +211,7 @@ isort.required-imports = ["from __future__ import annotations"]
 
 [tool.pylint]
 py-version = "{{ min_py }}"
-ignore-paths = [".*/_version.py"]
+ignore-paths = [".*/_version.py", ".*/*.pyi"]
 [%- if compiled == true %]
 extension-pkg-allow-list = ["{{ module_name }}._core"]
 [%- endif %]

diff --git a/template/src/[% if compiled == true %]_core[% endif %]/src/pybind.cpp b/template/src/[% if compiled == true %]_core[% endif %]/src/pybind.cpp
@@ -8,9 +8,9 @@ PYBIND11_MODULE(_core, m) {
       Pybind11 _core plugin
       -----------------------
       .. currentmodule:: _core
-  )pbdoc";
+    )pbdoc";
 
     m.def("version", []() { return _core::ProjectVersion(); }, R"pbdoc(
-      The _core plugin version.
-  )pbdoc");
+        The _core plugin version.
+    )pbdoc");
 }
diff --git a/template/src/{{ module_name }}/[% if compiled == true %]_core.pyi[% endif %] b/template/src/{{ module_name }}/[% if compiled == true %]_core.pyi[% endif %]
@@ -1,6 +1,16 @@
-"""Pybind11 _core plugin interfaces"""
+"""
+
+Pybind11 _core plugin
+-----------------------
+.. currentmodule:: _core
+
+"""
 
 from __future__ import annotations
 
+__all__ = ["version"]
+
 def version() -> str:
-    """_core plugin version."""
+    """
+    The _core plugin version.
+    """