Stuck on an issue?

Lightrun Answers was designed to reduce the constant googling that comes with debugging 3rd party libraries. It collects links to all the places you might be looking at while hunting down a tough bug.

And, if you’re still stuck at the end, we’re happy to hop on a call to see how we can help out.

Complex namespaces

See original GitHub issue

This hope that is not and issue but rather lack of documentation. I have such document:

<response
    xmlns="..."
    xmlns:c="..............."
    xmlns:xml="http://www.w3.org/XML/1998/namespace"
    xmlns:xsi="https://www.w3.org/2001/XMLSchema-instance"
    xsi:schemaLocation="xxxxxxxx"
>
    <object>
        <name xml:lang="en">Some value</name>
        <name xml:lang="fr">Some value</name>
        <c:contact>
            <c:contactName xml:lang="en">Some value</c:contact-name>
        </c:contact>
    </object>
</response>

This is code snippet that I tried to achieve it but it does not work.

_ns_map = {
    None: "...",
    "xml": "http://www.w3.org/XML/1998/namespace",
    "c": "............"
}

_serializer_config = config = SerializerConfig(
    pretty_print=True,
    schema_location="xxxxxxxx",
)


_serializer = XmlSerializer(config=_serializer_config)

@dataclass
class Contact:
    contact_name: str = field(metadata=dict(type="Attribute", name="contact"))
   
   class Meta:
        namespace = "c"


@dataclass
class Name:
    lang: str = field(metadata=dict(type="Attribute", name="lang"))
    value: str = field(default=None)

    class Meta:
        namespace = "xml"


@dataclass
class Object:
    id: str
    name: List[Name] = field(default_factory=list, metadata={"type": "Element"})
    contact: Contact = field(default=None)

    class Meta:
        namespace = None


@dataclass
class Response:
    object: Object = field(metadata=dict(namespace=None))

    class Meta:
        name = "response"
        namespace = _ns_map[None]

    def render(self) -> str:
        return _serializer.render(self, ns_map=_ns_map)


if __name__ == '__main__':
    print(
        Response(object=Object(
            id="12121",
            name=[Name(lang="en", value="Some value")],
            contact=Contact(contact_name="Some value")
        )).render()
    )

Could you help me to write code that would print proper document structure?

Issue Analytics

State:
Created 3 years ago
Comments:6 (5 by maintainers)

Top GitHub Comments

1reaction

tefracommented, Feb 2, 2021

It’s not necessary, the namespace uri http://www.w3.org/XML/1998/namespace and it’s prefix xml are both reserved and bound by the xml specification and doesn’t need to be declared in the document itself.

1reaction

tefracommented, Feb 2, 2021

Putting it all together

@dataclass
class Contact:
    contact_name: str = field(metadata=dict(type="Attribute", name="contact"))

@dataclass
class Name:
    lang: str = field(metadata=dict(type="Attribute", name="lang", namespace="http://www.w3.org/XML/1998/namespace"))
    value: str = field(default=None)

@dataclass
class Object:
    id: str = field(metadata={"type": "Element"})
    name: List[Name] = field(default_factory=list, metadata={"type": "Element"})
    contact: Contact = field(default=None, metadata={"namespace": _ns_map["c"]})

@dataclass
class Response:
    object: Object = field()

    class Meta:
        name = "response"
        namespace = _ns_map[None]

    def render(self) -> str:
        return _serializer.render(self, ns_map=_ns_map)

<response xmlns="..." xmlns:c="............" xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xsi:schemaLocation="xxxxxxxx">
  <object>
    <id>12121</id>
    <name xml:lang="en">Some value</name>
    <c:contact contact="Some value"/>
  </object>
</response>
``