Struct Module 

pub struct Module {
    pub doc: String,
    pub class: BTreeMap<TypeId, ClassDef>,
    pub enum_: BTreeMap<TypeId, EnumDef>,
    pub function: BTreeMap<&'static str, Vec<FunctionDef>>,
    pub variables: BTreeMap<&'static str, VariableDef>,
    pub type_aliases: BTreeMap<&'static str, TypeAliasDef>,
    pub name: String,
    pub default_module_name: String,
    pub submodules: BTreeSet<String>,
    pub module_re_exports: Vec<ModuleReExport>,
    pub verbatim_all_entries: BTreeSet<String>,
    pub excluded_all_entries: BTreeSet<String>,
}

Type info for a Python (sub-)module. This corresponds to a single *.pyi file.

Fields

doc: String

class: BTreeMap<TypeId, ClassDef>

enum_: BTreeMap<TypeId, EnumDef>

function: BTreeMap<&'static str, Vec<FunctionDef>>

variables: BTreeMap<&'static str, VariableDef>

type_aliases: BTreeMap<&'static str, TypeAliasDef>

name: String

default_module_name: String

submodules: BTreeSet<String>

Direct submodules of this module.

module_re_exports: Vec<ModuleReExport>

Module re-exports for all

verbatim_all_entries: BTreeSet<String>

Verbatim entries to add to all

excluded_all_entries: BTreeSet<String>

Explicitly excluded entries from all

Implementations

impl Module

pub fn is_empty(&self) -> bool

Check if this module has no content to generate.

Returns true if the module has no classes, enums, functions, variables, type aliases, submodules, re-exports, docstrings, or verbatim entries. Modules that are empty should be skipped during generation.

pub fn is_init_py_compatible(&self) -> bool

Check if this module can have __init__.py generated.

Returns true if the module has no PyO3-generated items (classes, enums, functions, variables, type aliases). Such modules can only contain re-exports and docstrings, which can be represented in __init__.py.

pub fn declared_item_names(&self) -> Vec<String>

Get the names of all declared items in this module.

Returns a list of item names that were declared via gen_stub_* macros.

pub fn format_with_config(&self, use_type_statement: bool) -> String

Format module with configuration for type alias syntax, returning a String

fn collect_all_items(&self) -> BTreeSet<String>

Collect all items for the __all__ list in .pyi stub files.

This collects public items from classes, enums, functions, variables, type aliases, submodules, re-exports, and verbatim entries. Items starting with _ are excluded unless added via export_verbatim!.

pub fn format_init_py(&self) -> String

Format module as __init__.py content.

This generates a Python __init__.py file with re-exports and __all__ list. Unlike format_with_config() which generates .pyi stub files, this generates actual Python code for runtime use.

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

Trait Implementations

impl Clone for Module

fn clone(&self) -> Module

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Debug for Module

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

Formats the value using the given formatter.

impl Default for Module

fn default() -> Module

Returns the “default value” for a type.

impl Display for Module

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

Formats the value using the given formatter.

impl Import for Module

fn import(&self) -> HashSet<ImportRef>

impl PartialEq for Module

fn eq(&self, other: &Module) -> 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 Module