Struct Pyo3ComposeFile 

pub struct Pyo3ComposeFile {
    pub version: Option<String>,
    pub services: HashMap<String, ComposeService>,
    pub networks: HashMap<String, Option<ComposeNetwork>>,
    pub volumes: HashMap<String, Option<ComposeVolume>>,
    pub configs: HashMap<String, Option<ComposeConfig>>,
    pub secrets: HashMap<String, Option<ComposeSecret>>,
    pub name: Option<String>,
}

Represents a parsed Docker Compose file.

Use parse_compose_file() or parse_compose_string() to create instances.

Fields

version: Option<String>

Compose file format version (e.g., “3.8”, “3”, “2.1”)

services: HashMap<String, ComposeService>

Service definitions

networks: HashMap<String, Option<ComposeNetwork>>

Network definitions

volumes: HashMap<String, Option<ComposeVolume>>

Volume definitions

configs: HashMap<String, Option<ComposeConfig>>

Config definitions (Swarm mode)

secrets: HashMap<String, Option<ComposeSecret>>

Secret definitions (Swarm mode)

name: Option<String>

Top-level name for the project

Implementations

impl Pyo3ComposeFile

pub fn get_version(&self) -> Option<String>

Get the compose file version.

Returns: str | None: Version string if specified

pub fn get_name(&self) -> Option<String>

Get the project name.

Returns: str | None: Project name if specified

pub fn service_names(&self) -> Vec<String>

Get list of service names.

Returns: liststr: List of service names

pub fn network_names(&self) -> Vec<String>

Get list of network names.

Returns: liststr: List of network names

pub fn volume_names(&self) -> Vec<String>

Get list of volume names.

Returns: liststr: List of volume names

pub fn config_names(&self) -> Vec<String>

Get list of config names (Swarm mode).

Returns: liststr: List of config names

pub fn secret_names(&self) -> Vec<String>

Get list of secret names (Swarm mode).

Returns: liststr: List of secret names

pub fn to_dict(&self, py: Python<'_>) -> PyResult<Py<PyAny>>

Get the full compose file as a dictionary.

Returns: dict: Complete compose file structure as nested dict

pub fn get_service( &self, py: Python<'_>, name: &str, ) -> PyResult<Option<Py<PyAny>>>

Get a specific service configuration.

Args: name: Service name

Returns: dict | None: Service configuration if found

pub fn to_yaml(&self) -> PyResult<String>

Convert back to YAML string.

Returns: str: YAML representation of the compose file

Raises: ValueError: If serialization fails

Trait Implementations

impl Clone for Pyo3ComposeFile

fn clone(&self) -> Pyo3ComposeFile

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Debug for Pyo3ComposeFile

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

Formats the value using the given formatter.

impl<'de> Deserialize<'de> for Pyo3ComposeFile

fn deserialize<__D>(__deserializer: __D) -> Result<Self, __D::Error>

where __D: Deserializer<'de>,

Deserialize this value from the given Serde deserializer.

impl<'py> IntoPyObject<'py> for Pyo3ComposeFile

type Target = Pyo3ComposeFile

The Python output type

type Output = Bound<'py, <Pyo3ComposeFile as IntoPyObject<'py>>::Target>

The smart pointer type to use.

type Error = PyErr

The type returned in the event of a conversion error.

fn into_pyobject( self, py: Python<'py>, ) -> Result<<Self as IntoPyObject<'_>>::Output, <Self as IntoPyObject<'_>>::Error>

Performs the conversion.

impl PyClass for Pyo3ComposeFile

type Frozen = False

Whether the pyclass is frozen.

impl PyClassImpl for Pyo3ComposeFile

const IS_BASETYPE: bool = false

#[pyclass(subclass)]

const IS_SUBCLASS: bool = false

#[pyclass(extends=…)]

const IS_MAPPING: bool = false

#[pyclass(mapping)]

const IS_SEQUENCE: bool = false

#[pyclass(sequence)]

const IS_IMMUTABLE_TYPE: bool = false

#[pyclass(immutable_type)]

const RAW_DOC: &'static CStr = /// Represents a parsed Docker Compose file. /// /// Use `parse_compose_file()` or `parse_compose_string()` to create instances.

Docstring for the class provided on the struct or enum.

const DOC: &'static CStr

Fully rendered class doc, including the text_signature if a constructor is defined.

type BaseType = PyAny

Base class

type ThreadChecker = SendablePyClass<Pyo3ComposeFile>

This handles following two situations:

type PyClassMutability = <<PyAny as PyClassBaseType>::PyClassMutability as PyClassMutability>::MutableChild

Immutable or mutable

type Dict = PyClassDummySlot

Specify this class has #[pyclass(dict)] or not.

type WeakRef = PyClassDummySlot

Specify this class has #[pyclass(weakref)] or not.

type BaseNativeType = PyAny

The closest native ancestor. This is PyAny by default, and when you declare #[pyclass(extends=PyDict)], it’s PyDict.

fn items_iter() -> PyClassItemsIter

fn lazy_type_object() -> &'static LazyTypeObject<Self>

fn dict_offset() -> Option<isize>

fn weaklist_offset() -> Option<isize>

impl PyMethods<Pyo3ComposeFile> for PyClassImplCollector<Pyo3ComposeFile>

fn py_methods(self) -> &'static PyClassItems

impl PyTypeInfo for Pyo3ComposeFile

const NAME: &'static str = "ComposeFile"

Class name.

const MODULE: Option<&'static str> = ::core::option::Option::None

Module name, if any.

fn type_object_raw(py: Python<'_>) -> *mut PyTypeObject

Returns the PyTypeObject instance for this type.

fn type_object(py: Python<'_>) -> Bound<'_, PyType>

Returns the safe abstraction over the type object.

fn is_type_of(object: &Bound<'_, PyAny>) -> bool

Checks if object is an instance of this type or a subclass of this type.

fn is_exact_type_of(object: &Bound<'_, PyAny>) -> bool

Checks if object is an instance of this type.

impl Serialize for Pyo3ComposeFile

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

where __S: Serializer,

Serialize this value into the given Serde serializer.

impl DerefToPyAny for Pyo3ComposeFile

impl ExtractPyClassWithClone for Pyo3ComposeFile