Merge pull request #5 from dapper91/dev

- default namespace support added.

Author: dapper91

CHANGELOG.rst

@@ -2,14 +2,20 @@ Changelog
 =========
 
 
-0.2.0 (2021-08-19)
+0.2.1 (2022-10-06)
+------------------
+
+- default namespace support added.
+
+
+0.2.0 (2022-08-19)
 ------------------
 
 - generic models support
 - namespace inheritance bug fixed.
 
 
-0.1.0 (2021-08-17)
+0.1.0 (2022-08-17)
 ------------------
 
 - Initial release

README.md

@@ -20,6 +20,14 @@
 pydantic xml extension
 
 
+## Installation
+
+```commandline
+pip install pydantic-xml[lxml]
+```
+
+* **lxml** - use `lxml` instead of standard `xml.etree.ElementTree` library
+
 ## Quickstart
 
 `pydantic-xml` is a pydantic extension implementing model xml serialization/deserialization.
@@ -270,6 +278,26 @@ print(company)
 
 ### Namespace resolution:
 
+#### Default namespace
+
+To parse xml documents with a declared default namespace add it to `nsmap`  with an empty key.
+Look at the following example:
+
+```xml
+<headquarters xmlns="http://www.test.com/hq">
+    <country>US</country>
+    <state>California</state>
+    <city>Hawthorne</city>
+</headquarters>
+```
+
+```python
+class Headquarters(BaseXmlModel, tag='headquarters', nsmap={'': 'http://www.test.com/hq'}):
+    country: str = element()
+    state: str = element()
+    city: str = element()
+```
+
 **TBD**
 
 

pydantic_xml/utils.py

@@ -45,7 +45,7 @@ def from_alias(cls, tag: str, ns: Optional[str] = None, nsmap: Optional[NsMap] =
         :return: qualified name
         """
 
-        return QName(tag=tag, ns=nsmap.get(ns) if ns and nsmap else None)
+        return QName(tag=tag, ns=nsmap.get(ns or '') if nsmap else None)
 
     @property
     def uri(self) -> str:

pyproject.toml

@@ -1,6 +1,6 @@
 [tool.poetry]
 name = "pydantic-xml"
-version = "0.2.0"
+version = "0.2.1"
 description = "pydantic xml serialization/deserialization extension"
 authors = ["Dmitry Pershin <dapper1291@gmail.com>"]
 license = "Unlicense"

tests/test_namespaces.py

@@ -6,6 +6,37 @@
 from pydantic_xml import BaseXmlModel, attr, element, wrapped
 
 
+def test_default_namespaces():
+    class TestSubMode2(BaseXmlModel):
+        element: str = element()
+
+    class TestSubModel1(BaseXmlModel):
+        submodel2: TestSubMode2 = element(nsmap={'': 'http://test2.org'})
+
+    class TestModel(BaseXmlModel, tag='model'):
+        submodel1: TestSubModel1 = element(nsmap={'': 'http://test1.org'})
+
+    xml = '''
+    <model>
+        <submodel1 xmlns="http://test1.org">
+            <submodel2 xmlns="http://test2.org">
+                <element>value</element>
+            </submodel2>
+        </submodel1>
+    </model>
+    '''
+
+    actual_obj = TestModel.from_xml(xml)
+    expected_obj = TestModel(
+        submodel1=TestSubModel1(submodel2=TestSubMode2(element='value')),
+    )
+
+    assert actual_obj == expected_obj
+
+    actual_xml = actual_obj.to_xml()
+    assert_xml_equal(actual_xml, xml)
+
+
 @pytest.mark.parametrize(
     'model_ns, element_ns, expected_model_ns, expected_element_ns',
     [