Struct PyProject

Source

pub struct PyProject { /* private fields */ }

Expand description

Partial pyproject.toml metadata.

Implementations§

Source §

impl PyProject

Source

pub const fn new() -> Self

Creates empty pyproject metadata.

Examples found in repository ?

examples/basic_usage.rs (line 8)

3fn main() -> Result<(), use_pyproject::PyProjectTextError> {
4    let project = PyProjectProjectMetadata::new()
5        .with_name("demo")?
6        .with_version("0.1.0")?
7        .with_dependency(PyProjectDependency::new("requests>=2")?);
8    let pyproject = PyProject::new().with_project(project);
9
10    assert_eq!(pyproject.project_name(), Some("demo"));
11    assert_eq!(pyproject.dependencies()[0].as_str(), "requests>=2");
12    Ok(())
13}

Source

pub fn with_build_system(self, build_system: PyProjectBuildSystem) -> Self

Adds build-system metadata.

Source

pub fn with_project(self, project: PyProjectProjectMetadata) -> Self

Adds project metadata.

Examples found in repository ?

examples/basic_usage.rs (line 8)

3fn main() -> Result<(), use_pyproject::PyProjectTextError> {
4    let project = PyProjectProjectMetadata::new()
5        .with_name("demo")?
6        .with_version("0.1.0")?
7        .with_dependency(PyProjectDependency::new("requests>=2")?);
8    let pyproject = PyProject::new().with_project(project);
9
10    assert_eq!(pyproject.project_name(), Some("demo"));
11    assert_eq!(pyproject.dependencies()[0].as_str(), "requests>=2");
12    Ok(())
13}

Source

pub fn with_tool_section(self, section: PyProjectToolSection) -> Self

Adds a tool section label.

Source

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

Returns the project name when present.

Examples found in repository ?

examples/basic_usage.rs (line 10)

3fn main() -> Result<(), use_pyproject::PyProjectTextError> {
4    let project = PyProjectProjectMetadata::new()
5        .with_name("demo")?
6        .with_version("0.1.0")?
7        .with_dependency(PyProjectDependency::new("requests>=2")?);
8    let pyproject = PyProject::new().with_project(project);
9
10    assert_eq!(pyproject.project_name(), Some("demo"));
11    assert_eq!(pyproject.dependencies()[0].as_str(), "requests>=2");
12    Ok(())
13}

Source

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

Returns the project version when present.

Source

pub fn dependencies(&self) -> &[PyProjectDependency]

Returns declared dependencies when project metadata is present.

Examples found in repository ?

examples/basic_usage.rs (line 11)

3fn main() -> Result<(), use_pyproject::PyProjectTextError> {
4    let project = PyProjectProjectMetadata::new()
5        .with_name("demo")?
6        .with_version("0.1.0")?
7        .with_dependency(PyProjectDependency::new("requests>=2")?);
8    let pyproject = PyProject::new().with_project(project);
9
10    assert_eq!(pyproject.project_name(), Some("demo"));
11    assert_eq!(pyproject.dependencies()[0].as_str(), "requests>=2");
12    Ok(())
13}