Struct maturin::pyproject_toml::PyProjectToml

pub struct PyProjectToml {
    pub tool: Option<Tool>,
    /* private fields */
}

A pyproject.toml as specified in PEP 517

Fields

tool: Option<Tool>

PEP 518: The [tool] table is where any tool related to your Python project, not just build tools, can have users specify configuration data as long as they use a sub-table within [tool], e.g. the flit tool would store its configuration in [tool.flit].

We use it for [tool.maturin]

Implementations

impl PyProjectToml

pub fn new(pyproject_file: impl AsRef<Path>) -> Result<PyProjectToml>

Returns the contents of a pyproject.toml with a [build-system] entry or an error

Does no specific error handling because it’s only used to check whether or not to build source distributions

pub fn project_name(&self) -> Option<&str>

Returns the value of [project.name] in pyproject.toml

pub fn maturin(&self) -> Option<&ToolMaturin>

Returns the values of [tool.maturin] in pyproject.toml

pub fn sdist_include(&self) -> Option<&Vec<String>>

👎Deprecated since 0.14.0: please use PyProjectToml::include (https://github.com/PyO3/maturin/pulls/1255)

Returns the value of [tool.maturin.sdist-include] in pyproject.toml

pub fn include(&self) -> Option<&[GlobPattern]>

Returns the value of [tool.maturin.include] in pyproject.toml

pub fn exclude(&self) -> Option<&[GlobPattern]>

Returns the value of [tool.maturin.exclude] in pyproject.toml

pub fn bindings(&self) -> Option<&str>

Returns the value of [tool.maturin.bindings] in pyproject.toml

pub fn compatibility(&self) -> Option<PlatformTag>

Returns the value of [tool.maturin.compatibility] in pyproject.toml

pub fn skip_auditwheel(&self) -> bool

Returns the value of [tool.maturin.skip-auditwheel] in pyproject.toml

pub fn strip(&self) -> bool

Returns the value of [tool.maturin.strip] in pyproject.toml

pub fn python_source(&self) -> Option<&Path>

Returns the value of [tool.maturin.python-source] in pyproject.toml

pub fn data(&self) -> Option<&Path>

Returns the value of [tool.maturin.data] in pyproject.toml

pub fn manifest_path(&self) -> Option<&Path>

Returns the value of [tool.maturin.manifest-path] in pyproject.toml

pub fn warn_missing_maturin_version(&self) -> bool

Having a pyproject.toml without a version constraint is a bad idea because at some point we’ll have to do breaking changes and then source distributions would break

Returns true if the pyproject.toml has the constraint

pub fn warn_missing_build_backend(&self) -> bool

Having a pyproject.toml without build-backend set to maturin may result in build errors when build from source distribution

Returns true if the pyproject.toml has build-backend set to maturin

Trait Implementations

impl Clone for PyProjectToml

fn clone(&self) -> PyProjectToml

Returns a copy of the value.

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

Performs copy-assignment from source.

impl Debug for PyProjectToml

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

Formats the value using the given formatter.

impl Deref for PyProjectToml

type Target = PyProjectToml

The resulting type after dereferencing.

fn deref(&self) -> &Self::Target

Dereferences the value.

impl<'de> Deserialize<'de> for PyProjectToml

fn deserialize<__D>(__deserializer: __D) -> Result<Self, __D::Error>where
    __D: Deserializer<'de>,

Deserialize this value from the given Serde deserializer.

impl Serialize for PyProjectToml

fn serialize<__S>(&self, __serializer: __S) -> Result<__S::Ok, __S::Error>where
    __S: Serializer,

Serialize this value into the given Serde serializer.