Development towards 0.1.1 (#1)

* Simplify documentation Signed-off-by: Andrej Orsula <[email protected]> * Update badges Signed-off-by: Andrej Orsula <[email protected]> * Suggest using `#[allow(clippy::all)]` for bindings Signed-off-by: Andrej Orsula <[email protected]> * Make reexports unambiguous Signed-off-by: Andrej Orsula <[email protected]> * Bump to 0.1.1 Signed-off-by: Andrej Orsula <[email protected]> --------- Signed-off-by: Andrej Orsula <[email protected]>
AndrejOrsula · Jan 20, 2024 · 1286e28 · 1286e28
1 parent 399262e
commit 1286e28
Show file tree

Hide file tree

Showing 7 changed files with 64 additions and 23 deletions.
diff --git a/Cargo.lock b/Cargo.lock
diff --git a/Cargo.toml b/Cargo.toml
@@ -20,12 +20,12 @@ license = "MIT OR Apache-2.0"
 readme = "README.md"
 repository = "https://github.com/AndrejOrsula/pyo3_bindgen"
 rust-version = "1.70"
-version = "0.1.0"
+version = "0.1.1"
 
 [workspace.dependencies]
-pyo3_bindgen = { path = "pyo3_bindgen", version = "0.1.0" }
-pyo3_bindgen_engine = { path = "pyo3_bindgen_engine", version = "0.1.0" }
-pyo3_bindgen_macros = { path = "pyo3_bindgen_macros", version = "0.1.0" }
+pyo3_bindgen = { path = "pyo3_bindgen", version = "0.1.1" }
+pyo3_bindgen_engine = { path = "pyo3_bindgen_engine", version = "0.1.1" }
+pyo3_bindgen_macros = { path = "pyo3_bindgen_macros", version = "0.1.1" }
 
 assert_cmd = { version = "2" }
 clap = { version = "4.4", features = ["derive"] }

diff --git a/README.md b/README.md
@@ -1,9 +1,11 @@
 # pyo3_bindgen
 
 <p align="left">
-  <a href="https://crates.io/crates/pyo3_bindgen">                                   <img alt="crates.io" src="https://img.shields.io/crates/v/pyo3_bindgen.svg"></a>
-  <a href="https://github.com/AndrejOrsula/pyo3_bindgen/actions/workflows/rust.yml"> <img alt="Rust"      src="https://github.com/AndrejOrsula/pyo3_bindgen/actions/workflows/rust.yml/badge.svg"></a>
-  <a href="https://codecov.io/gh/AndrejOrsula/pyo3_bindgen">                         <img alt="codecov"   src="https://codecov.io/gh/AndrejOrsula/pyo3_bindgen/branch/main/graph/badge.svg"></a>
+  <a href="https://crates.io/crates/pyo3_bindgen">                                   <img alt="crates.io"  src="https://img.shields.io/crates/v/pyo3_bindgen.svg"></a>
+  <a href="https://docs.rs/pyo3_bindgen">                                            <img alt="docs.rs"    src="https://docs.rs/pyo3_bindgen/badge.svg"></a>
+  <a href="https://github.com/AndrejOrsula/pyo3_bindgen/actions/workflows/rust.yml"> <img alt="Rust"       src="https://github.com/AndrejOrsula/pyo3_bindgen/actions/workflows/rust.yml/badge.svg"></a>
+  <a href="https://deps.rs/repo/github/AndrejOrsula/pyo3_bindgen">                   <img alt="deps.rs"    src="https://deps.rs/repo/github/AndrejOrsula/pyo3_bindgen/status.svg"></a>
+  <a href="https://codecov.io/gh/AndrejOrsula/pyo3_bindgen">                         <img alt="codecov.io" src="https://codecov.io/gh/AndrejOrsula/pyo3_bindgen/branch/main/graph/badge.svg"></a>
 </p>
 
 Automatic generation of Rust FFI bindings to Python modules via [PyO3](https://pyo3.rs). Python modules are analyzed recursively to generate Rust bindings with an identical structure for all public classes, functions, properties, and constants. Any available docstrings and type annotations are also preserved in their Rust equivalents.
@@ -76,7 +78,7 @@ On its own, the generated Rust code does not provide any performance benefits ov
 
 The workspace contains these packages:
 
-- **[pyo3_bindgen](pyo3_bindgen):** Public API for generation of bindings (in `build.rs` scripts or via procedural macros if enabled)
+- **[pyo3_bindgen](pyo3_bindgen):** Public API for generation of bindings (in `build.rs` or via procedural macros)
 - **[pyo3_bindgen_cli](pyo3_bindgen_cli):** CLI tool for generation of bindings via `pyo3_bindgen` executable
 - **[pyo3_bindgen_engine](pyo3_bindgen_engine):** The underlying engine for generation of bindings
 - **[pyo3_bindgen_macros](pyo3_bindgen_macros):** \[Experimental\] Procedural macros for in-place generation
@@ -113,7 +115,12 @@ fn main() {
 Afterwards, include the generated bindings anywhere in your crate.
 
 ```rs
-#[allow(non_camel_case_types, non_snake_case, non_upper_case_globals)]
+#[allow(
+    clippy::all,
+    non_camel_case_types,
+    non_snake_case,
+    non_upper_case_globals
+)]
 pub mod target_module {
     include!(concat!(env!("OUT_DIR"), "/bindings.rs"));
 }
@@ -148,8 +155,13 @@ pyo3_bindgen = { version = "0.1", features = ["macros"] }
 Then, you can call the `import_python!` macro anywhere in your crate.
 
 ```rs
-#[allow(non_camel_case_types, non_snake_case, non_upper_case_globals)]
-pub(crate) mod target_module {
+#[allow(
+    clippy::all,
+    non_camel_case_types,
+    non_snake_case,
+    non_upper_case_globals
+)]
+pub mod target_module {
     pyo3_bindgen::import_python!("target_module");
 }
 ```

diff --git a/pyo3_bindgen/src/lib.rs b/pyo3_bindgen/src/lib.rs
@@ -32,7 +32,12 @@
 //! Afterwards, include the generated bindings anywhere in your crate.
 //!
 //! ```rs
-//! #[allow(non_camel_case_types, non_snake_case, non_upper_case_globals)]
+//! #[allow(
+//!     clippy::all,
+//!     non_camel_case_types,
+//!     non_snake_case,
+//!     non_upper_case_globals
+//! )]
 //! pub mod target_module {
 //!     include!(concat!(env!("OUT_DIR"), "/bindings.rs"));
 //! }
@@ -67,8 +72,13 @@
 //! Then, you can call the `import_python!` macro anywhere in your crate.
 //!
 //! ```rs
-//! #[allow(non_camel_case_types, non_snake_case, non_upper_case_globals)]
-//! pub(crate) mod target_module {
+//! #[allow(
+//!     clippy::all,
+//!     non_camel_case_types,
+//!     non_snake_case,
+//!     non_upper_case_globals
+//! )]
+//! pub mod target_module {
 //!     pyo3_bindgen::import_python!("target_module");
 //! }
 //! ```

diff --git a/pyo3_bindgen_engine/src/bindgen/module.rs b/pyo3_bindgen_engine/src/bindgen/module.rs
@@ -242,8 +242,12 @@ pub fn bind_reexport(
         .take_while(|(a, b)| a == b)
         .count();
     let current_module_depth = module_name.split('.').count();
-    let reexport_path: String = std::iter::repeat("super".to_string())
-        .take(current_module_depth - n_common_ancestors)
+    let reexport_path = if (current_module_depth - n_common_ancestors) > 0 {
+        std::iter::repeat("super".to_string()).take(current_module_depth - n_common_ancestors)
+    } else {
+        std::iter::repeat("self".to_string()).take(1)
+    };
+    let reexport_path: String = reexport_path
         .chain(
             attr_origin_module
                 .split('.')

diff --git a/pyo3_bindgen_engine/src/build_utils.rs b/pyo3_bindgen_engine/src/build_utils.rs
@@ -36,7 +36,12 @@
 /// ```ignore
 /// // src/lib.rs
 ///
-/// #[allow(non_camel_case_types, non_snake_case, non_upper_case_globals)]
+/// #[allow(
+///     clippy::all,
+///     non_camel_case_types,
+///     non_snake_case,
+///     non_upper_case_globals
+/// )]
 /// pub mod os {
 ///     include!(concat!(env!("OUT_DIR"), "/bindings.rs"));
 /// }

diff --git a/pyo3_bindgen_macros/src/lib.rs b/pyo3_bindgen_macros/src/lib.rs
@@ -14,12 +14,22 @@ mod parser;
 /// // use pyo3_bindgen::import_python;
 /// use pyo3_bindgen_macros::import_python;
 ///
-/// #[allow(non_camel_case_types, non_snake_case, non_upper_case_globals)]
+/// #[allow(
+///     clippy::all,
+///     non_camel_case_types,
+///     non_snake_case,
+///     non_upper_case_globals
+/// )]
 /// pub mod sys {
 ///    import_python!("sys");
 /// }
 ///
-/// #[allow(non_camel_case_types, non_snake_case, non_upper_case_globals)]
+/// #[allow(
+///     clippy::all,
+///     non_camel_case_types,
+///     non_snake_case,
+///     non_upper_case_globals
+/// )]
 /// pub(crate) mod os_path {
 ///    import_python!("os.path");
 /// }