Fix - handling in package name (#242)

Resolve #109

Author: termoshtt

Cargo.lock

@@ -6,6 +6,7 @@ members = [
   "examples/mixed",
   "examples/mixed_sub",
   "examples/mixed_sub_multiple",
+  "examples/test-dash-package",
 ]
 resolver = "2"
 

Cargo.toml

@@ -0,0 +1,16 @@
+[package]
+name = "test-dash-package"
+version = "0.1.0"
+edition = "2021"
+
+[lib]
+name = "test_dash_package"
+crate-type = ["cdylib", "rlib"]
+
+[dependencies]
+pyo3 = { workspace = true }
+pyo3-stub-gen = { path = "../../pyo3-stub-gen" }
+
+[[bin]]
+name = "stub_gen"
+path = "src/bin/stub_gen.rs"

examples/test-dash-package/Cargo.toml

@@ -0,0 +1,16 @@
+# https://taskfile.dev
+# yaml-language-server: $schema=https://taskfile.dev/schema.json
+version: "3"
+
+tasks:
+  stub-gen:
+    desc: Generate stub file
+    cmds:
+      - cargo run --bin stub_gen
+
+  test:
+    desc: Run tests
+    cmds:
+      - uv run pytest
+      - uv run pyright
+      - uvx ruff check

examples/test-dash-package/Taskfile.yml

@@ -0,0 +1,12 @@
+[project]
+# maturin will convert `-` to `_` in the package name automatically
+# This module tests pyo3-stub-gen correctly handles package names with dashes
+name = "test-dash-package"
+version = "0.1.0"
+
+[build-system]
+requires = ["maturin>=1"]
+build-backend = "maturin"
+
+[tool.maturin]
+# For cases where we define `module-name` explicitly here are tested in other examples.

examples/test-dash-package/pyproject.toml

@@ -0,0 +1,7 @@
+use pyo3_stub_gen::Result;
+
+fn main() -> Result<()> {
+    let stub = test_dash_package::stub_info()?;
+    stub.generate()?;
+    Ok(())
+}

examples/test-dash-package/src/bin/stub_gen.rs

@@ -0,0 +1,16 @@
+use pyo3::prelude::*;
+use pyo3_stub_gen::{define_stub_info_gatherer, derive::gen_stub_pyfunction};
+
+#[gen_stub_pyfunction]
+#[pyfunction]
+fn test_function() -> i32 {
+    42
+}
+
+#[pymodule]
+fn test_dash_package(_py: Python, m: &Bound<PyModule>) -> PyResult<()> {
+    m.add_function(wrap_pyfunction!(test_function, m)?)?;
+    Ok(())
+}
+
+define_stub_info_gatherer!(stub_info);

examples/test-dash-package/src/lib.rs

@@ -0,0 +1,19 @@
+"""Test that the module can be imported correctly despite having a dash in the package name."""
+
+import test_dash_package
+import pathlib
+
+
+def test_test_function():
+    assert test_dash_package.test_function() == 42
+
+
+def test_stub_file_naming():
+    """Test that the stub file was generated with underscores instead of dashes."""
+    # The stub file should have underscores, not dashes
+    stub_file = pathlib.Path(__file__).parent.parent / "test_dash_package.pyi"
+    assert stub_file.exists(), "Stub file with underscores should exist"
+
+    # The old dash version should not exist
+    dash_stub_file = pathlib.Path(__file__).parent.parent / "test-dash-package.pyi"
+    assert not dash_stub_file.exists(), "Stub file with dashes should not exist"

examples/test-dash-package/tests/test_import.py

@@ -30,7 +30,9 @@ impl StubInfo {
 
     pub fn generate(&self) -> Result<()> {
         for (name, module) in self.modules.iter() {
-            let path = name.replace(".", "/");
+            // Convert dashes to underscores for Python compatibility
+            let normalized_name = name.replace("-", "_");
+            let path = normalized_name.replace(".", "/");
             let dest = if module.submodules.is_empty() {
                 self.python_root.join(format!("{path}.pyi"))
             } else {

pyo3-stub-gen/src/generate/stub_info.rs

@@ -4,6 +4,7 @@ members = [
     "examples/mixed",
     "examples/mixed_sub",
     "examples/mixed_sub_multiple",
+    "examples/test-dash-package",
 ]
 
 [dependency-groups]