Struct Pep723Script 

pub struct Pep723Script {
    pub path: PathBuf,
    pub metadata: Pep723Metadata,
    pub prelude: String,
    pub postlude: String,
}

A PEP 723 script, including its Pep723Metadata.

Fields

path: PathBuf

The path to the Python script.

metadata: Pep723Metadata

The parsed Pep723Metadata table from the script.

prelude: String

The content of the script before the metadata table.

postlude: String

The content of the script after the metadata table.

Implementations

impl Pep723Script

pub async fn read(file: impl AsRef<Path>) -> Result<Option<Self>, Pep723Error>

Read the PEP 723 script metadata from a Python file, if it exists.

Returns None if the file is missing a PEP 723 metadata block.

See: https://peps.python.org/pep-0723/

pub async fn init( file: impl AsRef<Path>, requires_python: &VersionSpecifiers, ) -> Result<Self, Pep723Error>

Reads a Python script and generates a default PEP 723 metadata table.

See: https://peps.python.org/pep-0723/

pub fn init_metadata( contents: &[u8], requires_python: &VersionSpecifiers, ) -> Result<(String, Pep723Metadata, String), Pep723Error>

Generates a default PEP 723 metadata table from the provided script contents.

See: https://peps.python.org/pep-0723/

pub async fn create( file: impl AsRef<Path>, requires_python: &VersionSpecifiers, existing_contents: Option<Vec<u8>>, ) -> Result<(), Pep723Error>

Create a PEP 723 script at the given path.

pub fn write(&self, metadata: &str) -> Result<(), Error>

Replace the existing metadata in the file with new metadata and write the updated content.

pub fn sources(&self) -> &BTreeMap<PackageName, Sources>

Return the Sources defined in the PEP 723 metadata.

Trait Implementations

impl Clone for Pep723Script

fn clone(&self) -> Pep723Script

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Debug for Pep723Script

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

Formats the value using the given formatter.

impl<'item> From<&'item Pep723Script> for Pep723ItemRef<'item>

fn from(script: &'item Pep723Script) -> Self

Converts to this type from the input type.