AppConfig

Struct AppConfig 

Source
pub struct AppConfig {
    pub backend: Backend,
    pub python_exe: String,
    pub include: Vec<PathBuf>,
    pub inputs: Vec<String>,
    pub out: PathBuf,
    pub generate_mypy: bool,
    pub generate_mypy_grpc: bool,
    pub postprocess: PostProcess,
    pub verify: Option<Verify>,
}
Expand description

Main application configuration parsed from pyproject.toml.

Contains all settings needed to run the proto-to-Python code generation pipeline, including backend selection, file paths, and processing options.

Fields§

§backend: Backend

Backend to use for code generation (protoc or buf).

§python_exe: String

Python executable to use for generation and verification. Can be “python3”, “python”, “uv”, or a custom path.

§include: Vec<PathBuf>

Proto import paths (passed as –proto_path to protoc). These directories are searched for proto files and their dependencies.

§inputs: Vec<String>

Glob patterns for proto files to compile. Only files matching these patterns will be processed.

§out: PathBuf

Output directory for generated Python files.

§generate_mypy: bool

Whether to generate mypy type stubs (.pyi files) using mypy-protobuf.

§generate_mypy_grpc: bool

Whether to generate gRPC mypy stubs (_grpc.pyi files) using mypy-grpc.

§postprocess: PostProcess

Post-processing configuration options.

§verify: Option<Verify>

Optional verification configuration (type checking commands).

Implementations§

Source§

impl AppConfig

Source

pub fn load(pyproject_path: Option<&Path>) -> Result<Self>

Load configuration from a pyproject.toml file.

Parses the TOML configuration file and validates the settings, applying defaults where values are not specified.

§Arguments
  • pyproject_path - Optional path to the pyproject.toml file. If None, looks for “pyproject.toml” in the current directory.
§Returns

Returns the parsed and validated configuration, or an error if:

  • The file cannot be read
  • The TOML is malformed
  • Required configuration sections are missing
  • Configuration values are invalid
§Example
use python_proto_importer::config::AppConfig;
use std::path::Path;

// Load from default location
let config = AppConfig::load(None)?;

// Load from custom path
let config = AppConfig::load(Some(Path::new("custom.toml")))?;

Trait Implementations§

Source§

impl Clone for AppConfig

Source§

fn clone(&self) -> AppConfig

Returns a duplicate of the value. Read more
1.0.0 · Source§

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

Performs copy-assignment from source. Read more
Source§

impl Debug for AppConfig

Source§

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

Formats the value using the given formatter. Read more

Auto Trait Implementations§

Blanket Implementations§

Source§

impl<T> Any for T
where T: 'static + ?Sized,

Source§

fn type_id(&self) -> TypeId

Gets the TypeId of self. Read more
Source§

impl<T> Borrow<T> for T
where T: ?Sized,

Source§

fn borrow(&self) -> &T

Immutably borrows from an owned value. Read more
Source§

impl<T> BorrowMut<T> for T
where T: ?Sized,

Source§

fn borrow_mut(&mut self) -> &mut T

Mutably borrows from an owned value. Read more
Source§

impl<T> CloneToUninit for T
where T: Clone,

Source§

unsafe fn clone_to_uninit(&self, dest: *mut u8)

🔬This is a nightly-only experimental API. (clone_to_uninit)
Performs copy-assignment from self to dest. Read more
Source§

impl<T> From<T> for T

Source§

fn from(t: T) -> T

Returns the argument unchanged.

Source§

impl<T> Instrument for T

Source§

fn instrument(self, span: Span) -> Instrumented<Self>

Instruments this type with the provided Span, returning an Instrumented wrapper. Read more
Source§

fn in_current_span(self) -> Instrumented<Self>

Instruments this type with the current Span, returning an Instrumented wrapper. Read more
Source§

impl<T, U> Into<U> for T
where U: From<T>,

Source§

fn into(self) -> U

Calls U::from(self).

That is, this conversion is whatever the implementation of From<T> for U chooses to do.

Source§

impl<T> ToOwned for T
where T: Clone,

Source§

type Owned = T

The resulting type after obtaining ownership.
Source§

fn to_owned(&self) -> T

Creates owned data from borrowed data, usually by cloning. Read more
Source§

fn clone_into(&self, target: &mut T)

Uses borrowed data to replace owned data, usually by cloning. Read more
Source§

impl<T, U> TryFrom<U> for T
where U: Into<T>,

Source§

type Error = Infallible

The type returned in the event of a conversion error.
Source§

fn try_from(value: U) -> Result<T, <T as TryFrom<U>>::Error>

Performs the conversion.
Source§

impl<T, U> TryInto<U> for T
where U: TryFrom<T>,

Source§

type Error = <U as TryFrom<T>>::Error

The type returned in the event of a conversion error.
Source§

fn try_into(self) -> Result<U, <U as TryFrom<T>>::Error>

Performs the conversion.
Source§

impl<T> WithSubscriber for T

Source§

fn with_subscriber<S>(self, subscriber: S) -> WithDispatch<Self>
where S: Into<Dispatch>,

Attaches the provided Subscriber to this type, returning a WithDispatch wrapper. Read more
Source§

fn with_current_subscriber(self) -> WithDispatch<Self>

Attaches the current default Subscriber to this type, returning a WithDispatch wrapper. Read more