Struct StubInfo 

pub struct StubInfo {
    pub modules: BTreeMap<String, Module>,
    pub python_root: PathBuf,
    pub is_mixed_layout: bool,
    pub config: StubGenConfig,
    pub pyproject_dir: Option<PathBuf>,
    pub default_module_name: String,
    pub project_name: String,
}

Fields

modules: BTreeMap<String, Module>

python_root: PathBuf

is_mixed_layout: bool

Whether this is a mixed Python/Rust layout (has python-source in pyproject.toml)

config: StubGenConfig

Configuration options for stub generation

pyproject_dir: Option<PathBuf>

Directory containing pyproject.toml (for relative path calculations)

default_module_name: String

The default module name (from module-name in pyproject.toml or #[pymodule])

project_name: String

The project name (from project.name in pyproject.toml) Used for documentation generation as the package display name

Implementations

impl StubInfo

pub fn from_pyproject_toml(path: impl AsRef<Path>) -> Result<Self>

Initialize StubInfo from a pyproject.toml file in CARGO_MANIFEST_DIR. This is automatically set up by the crate::define_stub_info_gatherer macro.

pub fn from_project_root( default_module_name: String, project_root: PathBuf, is_mixed_layout: bool, config: StubGenConfig, ) -> Result<Self>

Initialize StubInfo with a specific module name, project root, and configuration. This must be placed in your PyO3 library crate, i.e. the same crate where inventory::submitted, not in the gen_stub executables due to inventory’s mechanism.

pub fn generate(&self) -> Result<()>

fn write_stub_file(&self, dest: &Path, module: &Module) -> Result<()>

fn is_pyo3_generated(&self, module: &str) -> bool

Check if a module is part of the PyO3 shared library.

In mixed layout, modules at or below module-name are considered part of the PyO3 shared library. Modules above module-name are Pure Python modules.

fn generate_docs(&self, config: &DocGenConfig) -> Result<()>

Trait Implementations

impl Clone for StubInfo

fn clone(&self) -> StubInfo

Returns a duplicate of the value.

fn clone_from(&mut self, source: &Self)

Performs copy-assignment from source.

impl Debug for StubInfo

fn fmt(&self, f: &mut Formatter<'_>) -> Result

Formats the value using the given formatter.

impl PartialEq for StubInfo

fn eq(&self, other: &StubInfo) -> bool

Tests for self and other values to be equal, and is used by ==.

fn ne(&self, other: &Rhs) -> bool

Tests for !=. The default implementation is almost always sufficient, and should not be overridden without very good reason.

impl StructuralPartialEq for StubInfo