Struct ScriptTag 

pub struct ScriptTag { /* private fields */ }

PEP 723 metadata as parsed from a script comment block.

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

Vendored from: https://github.com/astral-sh/uv/blob/debe67ffdb0cd7835734100e909b2d8f79613743/crates/uv-scripts/src/lib.rs#L283

Implementations

impl ScriptTag

pub fn metadata(&self) -> &str

Returns the TOML contents of the metadata block.

pub fn source_map(&self) -> &ScriptSourceMap

Returns the map from extracted TOML offsets to their original script offsets.

pub fn parse(contents: &[u8]) -> Option<Self>

Given the contents of a Python file, extract the script metadata block with leading comment hashes removed and map its offsets to the original Python script.

Given the following input string representing the contents of a Python script:

#!/usr/bin/env python3
# /// script
# requires-python = '>=3.11'
# dependencies = [
#   'requests<3',
#   'rich',
# ]
# ///

import requests

print("Hello, World!")

This function extracts the metadata:

requires-python = '>=3.11'
dependencies = [
  'requests<3',
  'rich',
]

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

Trait Implementations

impl Clone for ScriptTag

fn clone(&self) -> ScriptTag

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Debug for ScriptTag

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

Formats the value using the given formatter.

impl Eq for ScriptTag

impl PartialEq for ScriptTag

fn eq(&self, other: &ScriptTag) -> bool

Equality operator ==.

fn ne(&self, other: &Rhs) -> bool

Inequality operator !=.

impl Ranged for ScriptTag

fn range(&self) -> TextRange

The range of this item in the source text.

fn start(&self) -> TextSize

The start offset of this item in the source text.

fn end(&self) -> TextSize

The end offset of this item in the source text.

impl StructuralPartialEq for ScriptTag