primitive

xsdata.formats.dataclass.parsers.nodes.primitive

PrimitiveNode

Bases: XmlNode

XmlNode for text elements with simple type values.

Parameters:

Name	Type	Description	Default
meta	XmlMeta	The parent xml meta instance	required
var	XmlVar	The xml var instance	required
ns_map	dict	The element namespace prefix-URI map	required
config	ParserConfig	The parser config instance	required

Source code in xsdata/formats/dataclass/parsers/nodes/primitive.py

class PrimitiveNode(XmlNode):
    """XmlNode for text elements with simple type values.

    Args:
        meta: The parent xml meta instance
        var: The xml var instance
        ns_map: The element namespace prefix-URI map
        config: The parser config instance
    """

    __slots__ = "config", "meta", "ns_map", "var"

    def __init__(self, meta: XmlMeta, var: XmlVar, ns_map: dict, config: ParserConfig):
        """Initialize the xml node."""
        self.meta = meta
        self.var = var
        self.ns_map = ns_map
        self.config = config

    def bind(
        self,
        qname: str,
        text: str | None,
        tail: str | None,
        objects: list,
    ) -> bool:
        """Bind the parsed data into an object for the ending element.

        This entry point is called when a xml element ends and is
        responsible to parse the current element attributes/text/tail
        content.

        Args:
            qname: The element qualified name
            text: The element text content
            tail: The element tail content
            objects: The list of intermediate parsed objects

        Returns:
            Whether the binding process was successful or not.
        """
        obj = ParserUtils.parse_var(
            meta=self.meta,
            var=self.var,
            config=self.config,
            value=text,
            ns_map=self.ns_map,
        )

        if obj is None and not self.var.nillable:
            obj = b"" if bytes in self.var.types else ""

        objects.append((qname, obj))

        if self.meta.mixed_content:
            tail = ParserUtils.normalize_content(tail)
            if tail:
                objects.append((None, tail))

        return True

    def child(self, qname: str, attrs: dict, ns_map: dict, position: int) -> XmlNode:
        """Raise an exception if there is a child element inside this node."""
        raise XmlContextError("Primitive node doesn't support child nodes!")

__init__(meta, var, ns_map, config)

Initialize the xml node.

Source code in xsdata/formats/dataclass/parsers/nodes/primitive.py

def __init__(self, meta: XmlMeta, var: XmlVar, ns_map: dict, config: ParserConfig):
    """Initialize the xml node."""
    self.meta = meta
    self.var = var
    self.ns_map = ns_map
    self.config = config

bind(qname, text, tail, objects)

Bind the parsed data into an object for the ending element.

This entry point is called when a xml element ends and is responsible to parse the current element attributes/text/tail content.

Parameters:

Name	Type	Description	Default
qname	str	The element qualified name	required
text	str | None	The element text content	required
tail	str | None	The element tail content	required
objects	list	The list of intermediate parsed objects	required

Returns:

Type	Description
bool	Whether the binding process was successful or not.

Source code in xsdata/formats/dataclass/parsers/nodes/primitive.py

def bind(
    self,
    qname: str,
    text: str | None,
    tail: str | None,
    objects: list,
) -> bool:
    """Bind the parsed data into an object for the ending element.

    This entry point is called when a xml element ends and is
    responsible to parse the current element attributes/text/tail
    content.

    Args:
        qname: The element qualified name
        text: The element text content
        tail: The element tail content
        objects: The list of intermediate parsed objects

    Returns:
        Whether the binding process was successful or not.
    """
    obj = ParserUtils.parse_var(
        meta=self.meta,
        var=self.var,
        config=self.config,
        value=text,
        ns_map=self.ns_map,
    )

    if obj is None and not self.var.nillable:
        obj = b"" if bytes in self.var.types else ""

    objects.append((qname, obj))

    if self.meta.mixed_content:
        tail = ParserUtils.normalize_content(tail)
        if tail:
            objects.append((None, tail))

    return True

child(qname, attrs, ns_map, position)

Raise an exception if there is a child element inside this node.

Source code in xsdata/formats/dataclass/parsers/nodes/primitive.py

def child(self, qname: str, attrs: dict, ns_map: dict, position: int) -> XmlNode:
    """Raise an exception if there is a child element inside this node."""
    raise XmlContextError("Primitive node doesn't support child nodes!")