Config Elements

Config elements for the “settings.xml” part.

This module defines classes representing configuration elements found within the settings.xml file of an ODF document, specifically those related to config:config-item-set.

Classes:

Name	Description
ConfigItem	Represents an element containing the value of an application setting,
ConfigItemMapEntry	Represents a single setting entry in a sequence of settings,
ConfigItemMapIndexed	Represents a container for ordered sequences of application settings,
ConfigItemMapNamed	Represents a container for a sequence of application setting elements,
ConfigItemSet	Represents a container element for application setting elements,

ConfigItem

Bases: Element

Represents an element containing the value of an application setting, identified by its config:name attribute. This corresponds to the “config:config-item” tag.

This element holds a single configuration value and does not have any child elements.

Attributes:

Name	Type	Description
name	str	The name of the configuration item.
config_type	str	The data type of the configuration item’s value.
value	str | int | bool	The actual value of the configuration item.

Methods:

Name	Description
__init__	Initialize a ConfigItem element.
__repr__
as_dict	Serialize the element to a dictionary.
from_dict	Create an element from a dictionary.

Source code in odfdo/config_elements.py

class ConfigItem(Element):
    """Represents an element containing the value of an application setting,
    identified by its `config:name` attribute. This corresponds to the
    "config:config-item" tag.

    This element holds a single configuration value and does not have any
    child elements.

    Attributes:
        name (str): The name of the configuration item.
        config_type (str): The data type of the configuration item's value.
        value (str | int | bool): The actual value of the configuration item.
    """

    _tag: str = "config:config-item"
    _properties: tuple[PropDef | PropDefBool, ...] = (
        PropDef("name", "config:name"),
        PropDef("config_type", "config:type"),
    )
    _properties = (PropDef("name", "config:name"),)
    TYPES: ClassVar = {
        "boolean",
        "short",
        "int",
        "long",
        "double",
        "string",
        "datetime",
        "base64Binary",
    }

    def __init__(
        self,
        name: str | None = None,
        config_type: str | None = None,
        value: str | int | bool | None = None,
        **kwargs: Any,
    ) -> None:
        """Initialize a ConfigItem element.

        This element contains the value of an application setting.

        Args:
            name: The name of the configuration item.
            config_type: The data type of the configuration item's value,
                one of "boolean", "short", "int", "long", "double", "string",
                "datetime", or "base64Binary".
            value: The actual value of the configuration item.
        """
        super().__init__(**kwargs)
        if self._do_init:
            self.name = name
            self.config_type = config_type
            self.value = value

    def __repr__(self) -> str:
        return f"<{self.__class__.__name__} tag={self.tag} name={self.name}>"

    @property
    def config_type(self) -> str:
        """Get the data type of the configuration item's value."""
        config_type = self.get_attribute_string("config:type")
        if config_type not in self.TYPES:
            return "string"
        return config_type

    @config_type.setter
    def config_type(self, config_type: str | None) -> None:
        """Set the data type of the configuration item's value."""
        if config_type not in self.TYPES:
            config_type = "string"
        self._set_attribute_str("config:type", config_type)

    @property
    def value(self) -> str | int | bool:
        """Get or set the value of the configuration item.

        When getting, the value is cast to its appropriate Python type (str,
        int, or bool) based on the `config_type` attribute.

        When setting, the provided value is converted to a string and stored
        as the element's text content, applying type-specific encoding (e.g.,
        for booleans) based on the `config_type` attribute.

        Returns:
            The value of the configuration item as a str, int, or bool.
        """
        content: str = self.text
        config_type = self.config_type
        if config_type == "boolean":
            return Boolean.decode(content)
        elif config_type in {"short", "int", "long", "double"}:
            return int(content)
        return content or ""

    @value.setter
    def value(self, value: str | int | bool | None) -> None:
        config_type = self.config_type
        if config_type == "boolean":
            self.text = Boolean.encode(value)
        elif config_type in {"short", "int", "long", "double"}:
            self.text = str(int(value))  # type: ignore[arg-type]
        else:
            self.text = str(value or "")

    def as_dict(self) -> dict[str, str | int | bool]:
        """Serialize the element to a dictionary.

        Returns:
            A dict with content of the ConfigItem serialized.
        """
        return {
            "class": self._tag,
            "config:name": self.name,  # type: ignore[dict-item]
            "config:type": self.config_type,
            "value": self.value,
        }

    @classmethod
    def from_dict(cls, data: dict[str, str | int | bool]) -> ConfigItem:
        """Create an element from a dictionary.

        Args:
            data: The  ConfigItem content serialized in a dict.

        Returns:
            A ConfigItem instance."
        """
        return cls(
            name=data["config:name"],  # type: ignore[arg-type]
            config_type=data.get("config:type"),  # type: ignore[arg-type]
            value=data.get("value"),
        )

TYPES class-attribute instance-attribute

TYPES: ClassVar = {
    "boolean",
    "short",
    "int",
    "long",
    "double",
    "string",
    "datetime",
    "base64Binary",
}

_properties class-attribute instance-attribute

_properties: tuple[PropDef | PropDefBool, ...] = (
    PropDef("name", "config:name"),
)

_tag class-attribute instance-attribute

_tag: str = 'config:config-item'

config_type property writable

config_type: str

Get the data type of the configuration item’s value.

name instance-attribute

name = name

value property writable

value: str | int | bool

Get or set the value of the configuration item.

When getting, the value is cast to its appropriate Python type (str, int, or bool) based on the config_type attribute.

When setting, the provided value is converted to a string and stored as the element’s text content, applying type-specific encoding (e.g., for booleans) based on the config_type attribute.

Returns:

Type	Description
str | int | bool	The value of the configuration item as a str, int, or bool.

__init__

__init__(
    name: str | None = None,
    config_type: str | None = None,
    value: str | int | bool | None = None,
    **kwargs: Any,
) -> None

Initialize a ConfigItem element.

This element contains the value of an application setting.

Parameters:

Name	Type	Description	Default
name	str | None	The name of the configuration item.	None
config_type	str | None	The data type of the configuration item’s value, one of “boolean”, “short”, “int”, “long”, “double”, “string”, “datetime”, or “base64Binary”.	None
value	str | int | bool | None	The actual value of the configuration item.	None

Source code in odfdo/config_elements.py

def __init__(
    self,
    name: str | None = None,
    config_type: str | None = None,
    value: str | int | bool | None = None,
    **kwargs: Any,
) -> None:
    """Initialize a ConfigItem element.

    This element contains the value of an application setting.

    Args:
        name: The name of the configuration item.
        config_type: The data type of the configuration item's value,
            one of "boolean", "short", "int", "long", "double", "string",
            "datetime", or "base64Binary".
        value: The actual value of the configuration item.
    """
    super().__init__(**kwargs)
    if self._do_init:
        self.name = name
        self.config_type = config_type
        self.value = value

__repr__

__repr__() -> str

Source code in odfdo/config_elements.py

def __repr__(self) -> str:
    return f"<{self.__class__.__name__} tag={self.tag} name={self.name}>"

as_dict

as_dict() -> dict[str, str | int | bool]

Serialize the element to a dictionary.

Returns:

Type	Description
dict[str, str | int | bool]	A dict with content of the ConfigItem serialized.

Source code in odfdo/config_elements.py

def as_dict(self) -> dict[str, str | int | bool]:
    """Serialize the element to a dictionary.

    Returns:
        A dict with content of the ConfigItem serialized.
    """
    return {
        "class": self._tag,
        "config:name": self.name,  # type: ignore[dict-item]
        "config:type": self.config_type,
        "value": self.value,
    }

from_dict classmethod

from_dict(data: dict[str, str | int | bool]) -> ConfigItem

Create an element from a dictionary.

Parameters:

Name	Type	Description	Default
data	dict[str, str | int | bool]	The ConfigItem content serialized in a dict.	required

Returns:

Type	Description
ConfigItem	A ConfigItem instance.”

Source code in odfdo/config_elements.py

@classmethod
def from_dict(cls, data: dict[str, str | int | bool]) -> ConfigItem:
    """Create an element from a dictionary.

    Args:
        data: The  ConfigItem content serialized in a dict.

    Returns:
        A ConfigItem instance."
    """
    return cls(
        name=data["config:name"],  # type: ignore[arg-type]
        config_type=data.get("config:type"),  # type: ignore[arg-type]
        value=data.get("value"),
    )

ConfigItemMapEntry

Bases: Element

Represents a single setting entry in a sequence of settings, corresponding to the “config:config-item-map-entry” tag.

The setting itself is defined by the child element of “config:config-item-map-entry”, and may be a single value, a set of settings, or a sequence of settings.

The “config:config-item-map-entry” element has the following child elements: “config:config-item”, “config:config-item-map-indexed”, “config:config-item-map-named”, and “config:config-item-set.

Attributes:

Name	Type	Description
name	str	The name of the entry.

Methods:

Name	Description
__init__	Initialize a ConfigItemMapEntry element.
__repr__
as_dict	Serialize the element to a dictionary.
from_dict	Create an element from a dictionary.

Source code in odfdo/config_elements.py

class ConfigItemMapEntry(Element):
    """Represents a single setting entry in a sequence of settings,
    corresponding to the "config:config-item-map-entry" tag.

    The setting itself is defined by the child element of "config:config-item-map-entry",
    and may be a single value, a set of settings, or a sequence of settings.

    The "config:config-item-map-entry" element has the following child elements:
    "config:config-item", "config:config-item-map-indexed", "config:config-item-map-named",
    and "config:config-item-set.

    Attributes:
        name (str): The name of the entry.
    """

    _tag: str = "config:config-item-map-entry"
    _properties: tuple[PropDef | PropDefBool, ...] = (PropDef("name", "config:name"),)

    def __init__(
        self,
        name: str | None = None,
        **kwargs: Any,
    ) -> None:
        """Initialize a ConfigItemMapEntry element.

        This represents an entry within an ordered configuration map.

        Args:
            name: The name of the entry.
        """
        super().__init__(**kwargs)
        if self._do_init:
            self.name = name

    def __repr__(self) -> str:
        return f"<{self.__class__.__name__} tag={self.tag} name={self.name}>"

    @property
    def config_item_sets(self) -> list[ConfigItemSet]:
        """Get the list of nested ConfigItemSet elements.

        Returns:
            list[ConfigItemSet]: A list of `ConfigItemSet` objects.
        """
        return cast(list[ConfigItemSet], self.get_elements("config:config-item-set"))

    @property
    def config_item_maps_indexed(self) -> list[ConfigItemMapIndexed]:
        """Get the list of indexed configuration item maps.

        Returns:
            list[ConfigItemMapIndexed]: A list of `ConfigItemMapIndexed`
                objects.
        """
        return cast(
            list[ConfigItemMapIndexed],
            self.get_elements("config:config-item-map-indexed"),
        )

    @property
    def config_item_maps_named(self) -> list[ConfigItemMapNamed]:
        """Get the list of named configuration item maps.

        Returns:
            list[ConfigItemMapNamed]: A list of `ConfigItemMapNamed` objects.
        """
        return cast(
            list[ConfigItemMapNamed], self.get_elements("config:config-item-map-named")
        )

    @property
    def config_items(self) -> list[ConfigItem]:
        """Get the list of individual configuration items.

        Returns:
            list[ConfigItem]: A list of `ConfigItem` objects.
        """
        return cast(list[ConfigItem], self.get_elements("config:config-item"))

    def as_dict(self) -> dict[str, str | int | bool | list[Any] | dict[str, Any]]:
        """Serialize the element to a dictionary.

        Returns:
            A dict with content of the ConfigItemMapEntry serialized."""
        return _as_dict(self)

    @classmethod
    def from_dict(
        cls, data: dict[str, str | int | bool | dict[str, Any]]
    ) -> ConfigItemMapEntry:
        """Create an element from a dictionary.

        Args:
            data: The ConfigItemMapEntry content serialized as a dict.

        Returns:
            A ConfigItemMapEntry.
        """
        return cast(ConfigItemMapEntry, _from_dict(data))

_properties class-attribute instance-attribute

_properties: tuple[PropDef | PropDefBool, ...] = (
    PropDef("name", "config:name"),
)

_tag class-attribute instance-attribute

_tag: str = 'config:config-item-map-entry'

config_item_maps_indexed property

config_item_maps_indexed: list[ConfigItemMapIndexed]

Get the list of indexed configuration item maps.

Returns:

Type	Description
list[ConfigItemMapIndexed]	list[ConfigItemMapIndexed]: A list of ConfigItemMapIndexed objects.

config_item_maps_named property

config_item_maps_named: list[ConfigItemMapNamed]

Get the list of named configuration item maps.

Returns:

Type	Description
list[ConfigItemMapNamed]	list[ConfigItemMapNamed]: A list of ConfigItemMapNamed objects.

config_item_sets property

config_item_sets: list[ConfigItemSet]

Get the list of nested ConfigItemSet elements.

Returns:

Type	Description
list[ConfigItemSet]	list[ConfigItemSet]: A list of ConfigItemSet objects.

config_items property

config_items: list[ConfigItem]

Get the list of individual configuration items.

Returns:

Type	Description
list[ConfigItem]	list[ConfigItem]: A list of ConfigItem objects.

name instance-attribute

name = name

__init__

__init__(name: str | None = None, **kwargs: Any) -> None

Initialize a ConfigItemMapEntry element.

This represents an entry within an ordered configuration map.

Parameters:

Name	Type	Description	Default
name	str | None	The name of the entry.	None

Source code in odfdo/config_elements.py

def __init__(
    self,
    name: str | None = None,
    **kwargs: Any,
) -> None:
    """Initialize a ConfigItemMapEntry element.

    This represents an entry within an ordered configuration map.

    Args:
        name: The name of the entry.
    """
    super().__init__(**kwargs)
    if self._do_init:
        self.name = name

__repr__

__repr__() -> str

Source code in odfdo/config_elements.py

def __repr__(self) -> str:
    return f"<{self.__class__.__name__} tag={self.tag} name={self.name}>"

as_dict

as_dict() -> dict[
    str, str | int | bool | list[Any] | dict[str, Any]
]

Serialize the element to a dictionary.

Returns:

Type	Description
dict[str, str | int | bool | list[Any] | dict[str, Any]]	A dict with content of the ConfigItemMapEntry serialized.

Source code in odfdo/config_elements.py

def as_dict(self) -> dict[str, str | int | bool | list[Any] | dict[str, Any]]:
    """Serialize the element to a dictionary.

    Returns:
        A dict with content of the ConfigItemMapEntry serialized."""
    return _as_dict(self)

from_dict classmethod

from_dict(
    data: dict[str, str | int | bool | dict[str, Any]],
) -> ConfigItemMapEntry

Create an element from a dictionary.

Parameters:

Name	Type	Description	Default
data	dict[str, str | int | bool | dict[str, Any]]	The ConfigItemMapEntry content serialized as a dict.	required

Returns:

Type	Description
ConfigItemMapEntry	A ConfigItemMapEntry.

Source code in odfdo/config_elements.py

@classmethod
def from_dict(
    cls, data: dict[str, str | int | bool | dict[str, Any]]
) -> ConfigItemMapEntry:
    """Create an element from a dictionary.

    Args:
        data: The ConfigItemMapEntry content serialized as a dict.

    Returns:
        A ConfigItemMapEntry.
    """
    return cast(ConfigItemMapEntry, _from_dict(data))

ConfigItemMapIndexed

Bases: Element

Represents a container for ordered sequences of application settings, corresponding to the “config:config-item-map-indexed” tag.

This element is used to store a collection of configuration items that are ordered and can be accessed by index.

Attributes:

Name	Type	Description
name	str	The name of the indexed configuration item map.

Methods:

Name	Description
__init__	Initialize a ConfigItemMapIndexed element.
__repr__
as_dict	Serialize the element to a dictionary.
from_dict	Create an element from a dictionary.

Source code in odfdo/config_elements.py

class ConfigItemMapIndexed(Element):
    """Represents a container for ordered sequences of application settings,
    corresponding to the "config:config-item-map-indexed" tag.

    This element is used to store a collection of configuration items that are
    ordered and can be accessed by index.

    Attributes:
        name (str): The name of the indexed configuration item map.
    """

    _tag: str = "config:config-item-map-indexed"
    _properties: tuple[PropDef | PropDefBool, ...] = (PropDef("name", "config:name"),)

    def __init__(
        self,
        name: str | None = None,
        **kwargs: Any,
    ) -> None:
        """Initialize a ConfigItemMapIndexed element.

        This container holds ordered sequences of application settings.

        The "config:config-item-map-indexed" element has the following child
        element: "config:config-item-map-entry".

        Args:
            name: The name of the indexed configuration item map.
        """
        super().__init__(**kwargs)
        if self._do_init:
            self.name = name

    def __repr__(self) -> str:
        return f"<{self.__class__.__name__} tag={self.tag} name={self.name}>"

    @property
    def config_item_maps_entries(self) -> list[ConfigItemMapEntry]:
        """Get the list of configuration item map entries.

        Returns:
            list[ConfigItemMapEntry]: A list of `ConfigItemMapEntry` objects.
        """
        return cast(
            list[ConfigItemMapEntry], self.get_elements("config:config-item-map-entry")
        )

    def as_dict(self) -> dict[str, str | int | bool | list[Any] | dict[str, Any]]:
        """Serialize the element to a dictionary.

        Returns:
            A dict with content of the ConfigItemMapIndexed serialized.
        """
        return _as_dict(self)

    @classmethod
    def from_dict(
        cls, data: dict[str, str | int | bool | dict[str, Any]]
    ) -> ConfigItemMapIndexed:
        """Create an element from a dictionary.

        Args:
            data: The ConfigItemMapIndexed content serialized as a dict.

        Returns:
            A ConfigItemMapIndexed.
        """
        return cast(ConfigItemMapIndexed, _from_dict(data))

_properties class-attribute instance-attribute

_properties: tuple[PropDef | PropDefBool, ...] = (
    PropDef("name", "config:name"),
)

_tag class-attribute instance-attribute

_tag: str = 'config:config-item-map-indexed'

config_item_maps_entries property

config_item_maps_entries: list[ConfigItemMapEntry]

Get the list of configuration item map entries.

Returns:

Type	Description
list[ConfigItemMapEntry]	list[ConfigItemMapEntry]: A list of ConfigItemMapEntry objects.

name instance-attribute

name = name

__init__

__init__(name: str | None = None, **kwargs: Any) -> None

Initialize a ConfigItemMapIndexed element.

This container holds ordered sequences of application settings.

The “config:config-item-map-indexed” element has the following child element: “config:config-item-map-entry”.

Parameters:

Name	Type	Description	Default
name	str | None	The name of the indexed configuration item map.	None

Source code in odfdo/config_elements.py

def __init__(
    self,
    name: str | None = None,
    **kwargs: Any,
) -> None:
    """Initialize a ConfigItemMapIndexed element.

    This container holds ordered sequences of application settings.

    The "config:config-item-map-indexed" element has the following child
    element: "config:config-item-map-entry".

    Args:
        name: The name of the indexed configuration item map.
    """
    super().__init__(**kwargs)
    if self._do_init:
        self.name = name

__repr__

__repr__() -> str

Source code in odfdo/config_elements.py

def __repr__(self) -> str:
    return f"<{self.__class__.__name__} tag={self.tag} name={self.name}>"

as_dict

as_dict() -> dict[
    str, str | int | bool | list[Any] | dict[str, Any]
]

Serialize the element to a dictionary.

Returns:

Type	Description
dict[str, str | int | bool | list[Any] | dict[str, Any]]	A dict with content of the ConfigItemMapIndexed serialized.

Source code in odfdo/config_elements.py

def as_dict(self) -> dict[str, str | int | bool | list[Any] | dict[str, Any]]:
    """Serialize the element to a dictionary.

    Returns:
        A dict with content of the ConfigItemMapIndexed serialized.
    """
    return _as_dict(self)

from_dict classmethod

from_dict(
    data: dict[str, str | int | bool | dict[str, Any]],
) -> ConfigItemMapIndexed

Create an element from a dictionary.

Parameters:

Name	Type	Description	Default
data	dict[str, str | int | bool | dict[str, Any]]	The ConfigItemMapIndexed content serialized as a dict.	required

Returns:

Type	Description
ConfigItemMapIndexed	A ConfigItemMapIndexed.

Source code in odfdo/config_elements.py

@classmethod
def from_dict(
    cls, data: dict[str, str | int | bool | dict[str, Any]]
) -> ConfigItemMapIndexed:
    """Create an element from a dictionary.

    Args:
        data: The ConfigItemMapIndexed content serialized as a dict.

    Returns:
        A ConfigItemMapIndexed.
    """
    return cast(ConfigItemMapIndexed, _from_dict(data))

ConfigItemMapNamed

Bases: Element

Represents a container for a sequence of application setting elements, where each sequence is identified by the value of its config:name attribute. This corresponds to the “config:config-item-map-named” tag.

This element is used to store a collection of configuration items that can be accessed by a descriptive name rather than an index.

The “config:config-item-map-named” element has the following child element: “config:config-item-map-entry”.

Attributes:

Name	Type	Description
name	str	The name of the named configuration item map.

Methods:

Name	Description
__init__	Initialize a ConfigItemMapNamed element.
__repr__
as_dict	Serialize the element to a dictionary.
from_dict	Create an element from a dictionary.

Source code in odfdo/config_elements.py

class ConfigItemMapNamed(Element):
    """Represents a container for a sequence of application setting elements,
    where each sequence is identified by the value of its `config:name`
    attribute. This corresponds to the "config:config-item-map-named" tag.

    This element is used to store a collection of configuration items that
    can be accessed by a descriptive name rather than an index.

    The "config:config-item-map-named" element has the following child
    element: "config:config-item-map-entry".

    Attributes:
        name (str): The name of the named configuration item map.
    """

    _tag: str = "config:config-item-map-named"
    _properties: tuple[PropDef | PropDefBool, ...] = (PropDef("name", "config:name"),)

    def __init__(
        self,
        name: str | None = None,
        **kwargs: Any,
    ) -> None:
        """Initialize a ConfigItemMapNamed element.

        This container holds named sequences of application setting elements.

        Args:
            name: The name of the named configuration item map.
        """
        super().__init__(**kwargs)
        if self._do_init:
            self.name = name

    def __repr__(self) -> str:
        return f"<{self.__class__.__name__} tag={self.tag} name={self.name}>"

    @property
    def config_item_maps_entries(self) -> list[ConfigItemMapEntry]:
        """Get the list of configuration item map entries.

        Returns:
            list[ConfigItemMapEntry]: A list of `ConfigItemMapEntry` objects.
        """
        return cast(
            list[ConfigItemMapEntry], self.get_elements("config:config-item-map-entry")
        )

    def as_dict(self) -> dict[str, str | int | bool | list[Any] | dict[str, Any]]:
        """Serialize the element to a dictionary.

        Returns:
            A dict with content of the ConfigItemMapNamed serialized.
        """
        return _as_dict(self)

    @classmethod
    def from_dict(
        cls, data: dict[str, str | int | bool | dict[str, Any]]
    ) -> ConfigItemMapNamed:
        """Create an element from a dictionary.

        Args:
            data: The ConfigItemMapNamed content serialized as a dict.

        Returns:
            A ConfigItemMapNamed.
        """
        return cast(ConfigItemMapNamed, _from_dict(data))

_properties class-attribute instance-attribute

_properties: tuple[PropDef | PropDefBool, ...] = (
    PropDef("name", "config:name"),
)

_tag class-attribute instance-attribute

_tag: str = 'config:config-item-map-named'

config_item_maps_entries property

config_item_maps_entries: list[ConfigItemMapEntry]

Get the list of configuration item map entries.

Returns:

Type	Description
list[ConfigItemMapEntry]	list[ConfigItemMapEntry]: A list of ConfigItemMapEntry objects.

name instance-attribute

name = name

__init__

__init__(name: str | None = None, **kwargs: Any) -> None

Initialize a ConfigItemMapNamed element.

This container holds named sequences of application setting elements.

Parameters:

Name	Type	Description	Default
name	str | None	The name of the named configuration item map.	None

Source code in odfdo/config_elements.py

def __init__(
    self,
    name: str | None = None,
    **kwargs: Any,
) -> None:
    """Initialize a ConfigItemMapNamed element.

    This container holds named sequences of application setting elements.

    Args:
        name: The name of the named configuration item map.
    """
    super().__init__(**kwargs)
    if self._do_init:
        self.name = name

__repr__

__repr__() -> str

Source code in odfdo/config_elements.py

def __repr__(self) -> str:
    return f"<{self.__class__.__name__} tag={self.tag} name={self.name}>"

as_dict

as_dict() -> dict[
    str, str | int | bool | list[Any] | dict[str, Any]
]

Serialize the element to a dictionary.

Returns:

Type	Description
dict[str, str | int | bool | list[Any] | dict[str, Any]]	A dict with content of the ConfigItemMapNamed serialized.

Source code in odfdo/config_elements.py

def as_dict(self) -> dict[str, str | int | bool | list[Any] | dict[str, Any]]:
    """Serialize the element to a dictionary.

    Returns:
        A dict with content of the ConfigItemMapNamed serialized.
    """
    return _as_dict(self)

from_dict classmethod

from_dict(
    data: dict[str, str | int | bool | dict[str, Any]],
) -> ConfigItemMapNamed

Create an element from a dictionary.

Parameters:

Name	Type	Description	Default
data	dict[str, str | int | bool | dict[str, Any]]	The ConfigItemMapNamed content serialized as a dict.	required

Returns:

Type	Description
ConfigItemMapNamed	A ConfigItemMapNamed.

Source code in odfdo/config_elements.py

@classmethod
def from_dict(
    cls, data: dict[str, str | int | bool | dict[str, Any]]
) -> ConfigItemMapNamed:
    """Create an element from a dictionary.

    Args:
        data: The ConfigItemMapNamed content serialized as a dict.

    Returns:
        A ConfigItemMapNamed.
    """
    return cast(ConfigItemMapNamed, _from_dict(data))

ConfigItemSet

Bases: Element

Represents a container element for application setting elements, “config:config-item-set” tag.

This element can contain other configuration items, item maps, or item sets, forming a hierarchical structure for document settings.

Attributes:

Name	Type	Description
name	str	The name of the configuration item set.

Methods:

Name	Description
__init__	Initialize a ConfigItemSet element.
__repr__
as_dict	Serialize the element to a dictionary.
from_dict	Create an element from a dictionary.

Source code in odfdo/config_elements.py

class ConfigItemSet(Element):
    """Represents a container element for application setting elements,
    "config:config-item-set" tag.

    This element can contain other configuration items, item maps, or item
    sets, forming a hierarchical structure for document settings.

    Attributes:
        name (str): The name of the configuration item set.
    """

    _tag: str = "config:config-item-set"
    _properties: tuple[PropDef | PropDefBool, ...] = (PropDef("name", "config:name"),)

    def __init__(
        self,
        name: str | None = None,
        **kwargs: Any,
    ) -> None:
        """Initialize a ConfigItemSet element.

        This element acts as a container for various application setting
        elements, including `config:config-item`,
        `config:config-item-map-indexed`, `config:config-item-map-named`,
        and nested `config:config-item-set`.

        The "config:config-item-set" element has the following child elements:
        "config:config-item", "config:config-item-map-indexed",
        "config:config-item-map-named" and "config:config-item-set"

        Args:
            name: The name of the configuration item set.
        """
        super().__init__(**kwargs)
        if self._do_init:
            self.name = name

    def __repr__(self) -> str:
        return f"<{self.__class__.__name__} tag={self.tag} name={self.name}>"

    @property
    def config_item_sets(self) -> list[ConfigItemSet]:
        """Get the list of nested ConfigItemSet elements.

        Returns:
            list[ConfigItemSet]: A list of `ConfigItemSet` objects.
        """
        return cast(list[ConfigItemSet], self.get_elements("config:config-item-set"))

    @property
    def config_item_maps_indexed(self) -> list[ConfigItemMapIndexed]:
        """Get the list of indexed configuration item maps.

        Returns:
            list[ConfigItemMapIndexed]: A list of `ConfigItemMapIndexed`
                objects.
        """
        return cast(
            list[ConfigItemMapIndexed],
            self.get_elements("config:config-item-map-indexed"),
        )

    @property
    def config_item_maps_named(self) -> list[ConfigItemMapNamed]:
        """Get the list of named configuration item maps.

        Returns:
            list[ConfigItemMapNamed]: A list of `ConfigItemMapNamed` objects.
        """
        return cast(
            list[ConfigItemMapNamed], self.get_elements("config:config-item-map-named")
        )

    @property
    def config_items(self) -> list[ConfigItem]:
        """Get the list of individual configuration items.

        Returns:
            list[ConfigItem]: A list of `ConfigItem` objects.
        """
        return cast(list[ConfigItem], self.get_elements("config:config-item"))

    def as_dict(self) -> dict[str, str | int | bool | list[Any] | dict[str, Any]]:
        """Serialize the element to a dictionary.

        Returns:
            A dict with content of the ConfigItemSet serialized.
        """
        return _as_dict(self)

    @classmethod
    def from_dict(
        cls, data: dict[str, str | int | bool | dict[str, Any]]
    ) -> ConfigItemSet:
        """Create an element from a dictionary.

        Args:
            data: The ConfigItemSet content serialized as a dict.

        Returns:
            A ConfigItemSet.
        """
        return cast(ConfigItemSet, _from_dict(data))

_properties class-attribute instance-attribute

_properties: tuple[PropDef | PropDefBool, ...] = (
    PropDef("name", "config:name"),
)

_tag class-attribute instance-attribute

_tag: str = 'config:config-item-set'

config_item_maps_indexed property

config_item_maps_indexed: list[ConfigItemMapIndexed]

Get the list of indexed configuration item maps.

Returns:

Type	Description
list[ConfigItemMapIndexed]	list[ConfigItemMapIndexed]: A list of ConfigItemMapIndexed objects.

config_item_maps_named property

config_item_maps_named: list[ConfigItemMapNamed]

Get the list of named configuration item maps.

Returns:

Type	Description
list[ConfigItemMapNamed]	list[ConfigItemMapNamed]: A list of ConfigItemMapNamed objects.

config_item_sets property

config_item_sets: list[ConfigItemSet]

Get the list of nested ConfigItemSet elements.

Returns:

Type	Description
list[ConfigItemSet]	list[ConfigItemSet]: A list of ConfigItemSet objects.

config_items property

config_items: list[ConfigItem]

Get the list of individual configuration items.

Returns:

Type	Description
list[ConfigItem]	list[ConfigItem]: A list of ConfigItem objects.

name instance-attribute

name = name

__init__

__init__(name: str | None = None, **kwargs: Any) -> None

Initialize a ConfigItemSet element.

This element acts as a container for various application setting elements, including config:config-item, config:config-item-map-indexed, config:config-item-map-named, and nested config:config-item-set.

The “config:config-item-set” element has the following child elements: “config:config-item”, “config:config-item-map-indexed”, “config:config-item-map-named” and “config:config-item-set”

Parameters:

Name	Type	Description	Default
name	str | None	The name of the configuration item set.	None

Source code in odfdo/config_elements.py

def __init__(
    self,
    name: str | None = None,
    **kwargs: Any,
) -> None:
    """Initialize a ConfigItemSet element.

    This element acts as a container for various application setting
    elements, including `config:config-item`,
    `config:config-item-map-indexed`, `config:config-item-map-named`,
    and nested `config:config-item-set`.

    The "config:config-item-set" element has the following child elements:
    "config:config-item", "config:config-item-map-indexed",
    "config:config-item-map-named" and "config:config-item-set"

    Args:
        name: The name of the configuration item set.
    """
    super().__init__(**kwargs)
    if self._do_init:
        self.name = name

__repr__

__repr__() -> str

Source code in odfdo/config_elements.py

def __repr__(self) -> str:
    return f"<{self.__class__.__name__} tag={self.tag} name={self.name}>"

as_dict

as_dict() -> dict[
    str, str | int | bool | list[Any] | dict[str, Any]
]

Serialize the element to a dictionary.

Returns:

Type	Description
dict[str, str | int | bool | list[Any] | dict[str, Any]]	A dict with content of the ConfigItemSet serialized.

Source code in odfdo/config_elements.py

def as_dict(self) -> dict[str, str | int | bool | list[Any] | dict[str, Any]]:
    """Serialize the element to a dictionary.

    Returns:
        A dict with content of the ConfigItemSet serialized.
    """
    return _as_dict(self)

from_dict classmethod

from_dict(
    data: dict[str, str | int | bool | dict[str, Any]],
) -> ConfigItemSet

Create an element from a dictionary.

Parameters:

Name	Type	Description	Default
data	dict[str, str | int | bool | dict[str, Any]]	The ConfigItemSet content serialized as a dict.	required

Returns:

Type	Description
ConfigItemSet	A ConfigItemSet.

Source code in odfdo/config_elements.py

@classmethod
def from_dict(
    cls, data: dict[str, str | int | bool | dict[str, Any]]
) -> ConfigItemSet:
    """Create an element from a dictionary.

    Args:
        data: The ConfigItemSet content serialized as a dict.

    Returns:
        A ConfigItemSet.
    """
    return cast(ConfigItemSet, _from_dict(data))

_as_dict

_as_dict(
    element: ConfigItemMapEntry
    | ConfigItemMapIndexed
    | ConfigItemMapNamed
    | ConfigItemSet,
) -> dict[
    str, str | int | bool | list[Any] | dict[str, Any]
]

Internal helper to serialize a configuration element to a dictionary.

Source code in odfdo/config_elements.py

def _as_dict(
    element: ConfigItemMapEntry
    | ConfigItemMapIndexed
    | ConfigItemMapNamed
    | ConfigItemSet,
) -> dict[str, str | int | bool | list[Any] | dict[str, Any]]:
    """Internal helper to serialize a configuration element to a dictionary."""
    conf: dict[str, str | int | bool | list[Any] | dict[str, Any]] = {
        "class": element._tag
    }
    if element.name:
        conf["config:name"] = element.name
    # all children are known to be classes with as_dict()
    children = [child.as_dict() for child in element.children]  # type: ignore[attr-defined]
    if children:
        conf["children"] = children
    return conf

_from_dict

_from_dict(
    data: dict[str, str | int | bool | dict[str, Any]],
) -> Element

Internal helper to deserialize a dictionary into a configuration element.

Source code in odfdo/config_elements.py

def _from_dict(data: dict[str, str | int | bool | dict[str, Any]]) -> Element:
    """Internal helper to deserialize a dictionary into a configuration
    element.
    """
    class_tag: str = data.pop("class")  # type: ignore[assignment]
    if class_tag == "config:config-item":
        return ConfigItem.from_dict(data)  # type: ignore[arg-type]
    kwargs: dict[str, str | int | bool] = {}
    if "config:name" in data:
        kwargs["name"] = data.pop("config:name")  # type: ignore[assignment]
    children: list[Any] = data.pop("children", [])  # type: ignore[assignment]
    klass = class_from_tag(class_tag)
    result = klass(**kwargs)
    for child in children:
        result.append(_from_dict(child))
    return result