Merge pull request #798 from sanders41/pyo3-version

Pull __version__ from the Cargo.toml in pyoo3 projects

Author: sanders41

src/python_files.rs

@@ -7,7 +7,7 @@ use crate::project_info::{ProjectInfo, ProjectManager};
 use crate::utils::is_python_312_or_greater;
 
 fn create_dunder_main_file(module: &str, is_async_project: bool) -> String {
-    let mut file = "from __future__ import annotations\n\n".to_string();
+    let mut file = "from __future__ import annotations  # pragma: no cover\n\n".to_string();
 
     if is_async_project {
         file.push_str("import asyncio\n\n");
@@ -139,44 +139,12 @@ fn save_pyo3_test_file(project_info: &ProjectInfo) -> Result<()> {
 fn create_project_init_file(module: &str, project_manager: &ProjectManager) -> String {
     match project_manager {
         ProjectManager::Maturin => {
-            // 118 = the letter v
-            let v_ascii: u8 = 118;
-            if let Some(first_char) = module.chars().next() {
-                if (first_char as u8) < v_ascii {
-                    format!(
-                        r#"from {module}._{module} import sum_as_string
-from {module}._version import VERSION
-
-__version__ = VERSION
-
-
-__all__ = ["sum_as_string"]
-"#
-                    )
-                } else {
-                    format!(
-                        r#"from {module}._version import VERSION
-from {module}._{module} import sum_as_string
-
-__version__ = VERSION
-
-
-__all__ = ["sum_as_string"]
-"#
-                    )
-                }
-            } else {
-                format!(
-                    r#"from {module}._{module} import sum_as_string
-r#"from {module}._version import VERSION
-
-__version__ = VERSION
-
+            format!(
+                r#"from {module}._{module} import __version__, sum_as_string
 
-__all__ = ["sum_as_string"]
+__all__ = ["__version__", "sum_as_string"]
 "#
-                )
-            }
+            )
         }
         _ => {
             format!(
@@ -211,6 +179,8 @@ fn save_project_init_file(project_info: &ProjectInfo) -> Result<()> {
 fn create_pyi_file() -> String {
     r#"from __future__ import annotations
 
+__version__: str
+
 def sum_as_string(a: int, b: int) -> str: ...
 "#
     .to_string()
@@ -250,15 +220,6 @@ fn create_version_test_file(
     min_python_version: &str,
 ) -> Result<Option<String>> {
     let version_test: Option<&str> = match project_manager {
-        ProjectManager::Maturin => Some(
-            r#"def test_versions_match():
-    cargo = Path().absolute() / "Cargo.toml"
-    with open(cargo, "rb") as f:
-        data = tomllib.load(f)
-        cargo_version = data["package"]["version"]
-
-    assert VERSION == cargo_version"#,
-        ),
         ProjectManager::Poetry => Some(
             r#"def test_versions_match():
     pyproject = Path().absolute() / "pyproject.toml"
@@ -340,7 +301,9 @@ pub fn generate_python_files(project_info: &ProjectInfo) -> Result<()> {
         }
     }
 
-    if save_version_file(project_info).is_err() {
+    if project_info.project_manager != ProjectManager::Maturin
+        && save_version_file(project_info).is_err()
+    {
         bail!("Error creating version file");
     }
 
@@ -627,22 +590,6 @@ mod tests {
         assert_yaml_snapshot!(content);
     }
 
-    #[test]
-    fn test_save_version_test_file_pyo3() {
-        let mut project_info = project_info_dummy();
-        project_info.project_manager = ProjectManager::Maturin;
-        let base = project_info.base_dir();
-        create_dir_all(base.join("tests")).unwrap();
-        let expected_file = base.join("tests/test_version.py");
-        save_version_test_file(&project_info).unwrap();
-
-        assert!(expected_file.is_file());
-
-        let content = std::fs::read_to_string(expected_file).unwrap();
-
-        assert_yaml_snapshot!(content);
-    }
-
     #[test]
     fn test_save_version_test_file_setuptools() {
         let mut project_info = project_info_dummy();

src/rust_files.rs

@@ -110,6 +110,7 @@ fn sum_as_string(a: usize, b: usize) -> PyResult<String> {{
 #[pymodule]
 fn _{module}(_py: Python, m: &Bound<'_, PyModule>) -> PyResult<()> {{
     m.add_function(wrap_pyfunction!(sum_as_string, m)?)?;
+    m.add("__version__", env!("CARGO_PKG_VERSION"))?;
     Ok(())
 }}
 "#

src/snapshots/python_project__python_files__tests__save_main_files.snap

@@ -2,4 +2,4 @@
 source: src/python_files.rs
 expression: dunder_main_content
 ---
-"from __future__ import annotations\n\nfrom my_project.main import main  #  pragma: no cover\n\nif __name__ == \"__main__\":\n    raise SystemExit(main())\n"
+"from __future__ import annotations  # pragma: no cover\n\nfrom my_project.main import main  #  pragma: no cover\n\nif __name__ == \"__main__\":\n    raise SystemExit(main())\n"

src/snapshots/python_project__python_files__tests__save_main_files_is_async_project.snap

@@ -2,4 +2,4 @@
 source: src/python_files.rs
 expression: dunder_main_content
 ---
-"from __future__ import annotations\n\nimport asyncio\n\nfrom my_project.main import main  #  pragma: no cover\n\nif __name__ == \"__main__\":\n    raise SystemExit(asyncio.run(main()))\n"
+"from __future__ import annotations  # pragma: no cover\n\nimport asyncio\n\nfrom my_project.main import main  #  pragma: no cover\n\nif __name__ == \"__main__\":\n    raise SystemExit(asyncio.run(main()))\n"

src/snapshots/python_project__python_files__tests__save_project_init_file_pyo3_first.snap

@@ -2,4 +2,4 @@
 source: src/python_files.rs
 expression: content
 ---
-"from my_project._my_project import sum_as_string\nfrom my_project._version import VERSION\n\n__version__ = VERSION\n\n\n__all__ = [\"sum_as_string\"]\n"
+"from my_project._my_project import __version__, sum_as_string\n\n__all__ = [\"__version__\", \"sum_as_string\"]\n"

src/snapshots/python_project__python_files__tests__save_project_init_file_pyo3_last.snap

@@ -2,4 +2,4 @@
 source: src/python_files.rs
 expression: content
 ---
-"from z_my_project._version import VERSION\nfrom z_my_project._z_my_project import sum_as_string\n\n__version__ = VERSION\n\n\n__all__ = [\"sum_as_string\"]\n"
+"from z_my_project._z_my_project import __version__, sum_as_string\n\n__all__ = [\"__version__\", \"sum_as_string\"]\n"

src/snapshots/python_project__python_files__tests__save_pyi_file.snap

@@ -2,4 +2,4 @@
 source: src/python_files.rs
 expression: content
 ---
-"from __future__ import annotations\n\ndef sum_as_string(a: int, b: int) -> str: ...\n"
+"from __future__ import annotations\n\n__version__: str\n\ndef sum_as_string(a: int, b: int) -> str: ...\n"

src/snapshots/python_project__rust_files__tests__save_lib_file.snap

@@ -2,4 +2,4 @@
 source: src/rust_files.rs
 expression: content
 ---
-"use pyo3::prelude::*;\n\n#[pyfunction]\nfn sum_as_string(a: usize, b: usize) -> PyResult<String> {\n    Ok((a + b).to_string())\n}\n\n#[pymodule]\nfn _my_project(_py: Python, m: &Bound<'_, PyModule>) -> PyResult<()> {\n    m.add_function(wrap_pyfunction!(sum_as_string, m)?)?;\n    Ok(())\n}\n"
+"use pyo3::prelude::*;\n\n#[pyfunction]\nfn sum_as_string(a: usize, b: usize) -> PyResult<String> {\n    Ok((a + b).to_string())\n}\n\n#[pymodule]\nfn _my_project(_py: Python, m: &Bound<'_, PyModule>) -> PyResult<()> {\n    m.add_function(wrap_pyfunction!(sum_as_string, m)?)?;\n    m.add(\"__version__\", env!(\"CARGO_PKG_VERSION\"))?;\n    Ok(())\n}\n"