xsdata 21.1__tar.gz → 21.2__tar.gz

{xsdata-21.1 → xsdata-21.2}/CHANGES.rst

@@ -1,3 +1,29 @@
+21.2 (2021-02-02)
+-----------------
+
+- Added class name context for user naming schemes `#348 <https://github.com/tefra/xsdata/issues/348>`_
+- Added mixed pascal naming scheme `#348 <https://github.com/tefra/xsdata/issues/348>`_
+- Added access to element/attribute name generators `#381 <https://github.com/tefra/xsdata/issues/381>`_
+- Added XmlHexBinary/XmlBase64Binary builtin data types `#387 <https://github.com/tefra/xsdata/issues/387>`_
+- Added support for xs:anyType root elements `#399 <https://github.com/tefra/xsdata/issues/399>`_
+- Updated JSON binding modules to use the fields local name `#389 <https://github.com/tefra/xsdata/issues/389>`_
+- Updated enum classes generation
+   - Promote all inner enums to root `#383 <https://github.com/tefra/xsdata/issues/383>`_
+   - Fixed issues with producing invalid members `#385 <https://github.com/tefra/xsdata/issues/385>`_
+   - Added support for list/tuple member values
+- Updated parsers accuracy for Union types
+- Updated dependency resolution accuracy
+- Update base classes generation strategies
+- Updated builtin data types with helper constructors/methods
+- Fixed inner class names conflicts `#375 <https://github.com/tefra/xsdata/issues/375>`_
+- Fixed issue not generating fields derived from xs:alternative elements `#393 <https://github.com/tefra/xsdata/issues/393>`_
+- Fixed duplicate root class name regression from v20.12
+- Fixed issue adding unused lib imports
+- Fixed issue adding unused name properties to choice elements
+
+This is a sleeper release ✨✨✨ so many code generation improvements and finally the
+JSON binding is aligned with XML.
+
 21.1 (2021-01-08)
 -----------------
 - Fixed XmlWriter converting attribute keys to QName. `#346 <https://github.com/tefra/xsdata/issues/346>`_

{xsdata-21.1/xsdata.egg-info → xsdata-21.2}/PKG-INFO

@@ -1,6 +1,6 @@
 Metadata-Version: 2.1
 Name: xsdata
-Version: 21.1
+Version: 21.2
 Summary: Python XML Binding
 Home-page: https://github.com/tefra/xsdata
 Author: Christodoulos Tsoulloftas
@@ -70,26 +70,28 @@ Description: .. image:: https://github.com/tefra/xsdata/raw/master/docs/_static/
         - Pluggable code writer that supports python dataclasses and PlantUML class diagrams.
         
         
-        Changelog: 21.1 (2021-01-08)
+        Changelog: 21.2 (2021-02-02)
         ----------------------------
-        - Fixed XmlWriter converting attribute keys to QName. `#346 <https://github.com/tefra/xsdata/issues/346>`_
-        - Set empty complexType base to anySimpleType `#349 <https://github.com/tefra/xsdata/issues/349>`_
-        - Improve duplicate attr names detection `#351 <https://github.com/tefra/xsdata/issues/351>`_
-        - Add SerializerConfig::xml_declaration option `#357 <https://github.com/tefra/xsdata/issues/357>`_
-        - Generate default value/factory for compound fields `#359 <https://github.com/tefra/xsdata/issues/359>`_
-        - Fixed default value for token fields `#360 <https://github.com/tefra/xsdata/issues/360>`_
-        - Add doc metadata for compound fields `#362 <https://github.com/tefra/xsdata/issues/362>`_
-        - JsonParser: handle class and primitive unions `#369 <https://github.com/tefra/xsdata/issues/369>`_
-        - Update python mappings `#366 <https://github.com/tefra/xsdata/issues/366>`_
-           - Map xs:hexBinary and xs:base64Binary to bytes
-           - Map xs:date/time types to builtin types XmlDate/Time
-           - Map xs:duration to builtin type XmlDuration
-           - Map xs:g[Year[Month[Day]]] to builtin type XmlPeriod
-           - Map xs:Notation to QName
-           - Add converter adapters for datetime.date/time
-           - Add fields metadata key 'format' for time/date/binary types
-           - Fixed issues with default literal values
-           - Fixed issue with random field types order
+        
+        - Added class name context for user naming schemes `#348 <https://github.com/tefra/xsdata/issues/348>`_
+        - Added mixed pascal naming scheme `#348 <https://github.com/tefra/xsdata/issues/348>`_
+        - Added access to element/attribute name generators `#381 <https://github.com/tefra/xsdata/issues/381>`_
+        - Added XmlHexBinary/XmlBase64Binary builtin data types `#387 <https://github.com/tefra/xsdata/issues/387>`_
+        - Added support for xs:anyType root elements `#399 <https://github.com/tefra/xsdata/issues/399>`_
+        - Updated JSON binding modules to use the fields local name `#389 <https://github.com/tefra/xsdata/issues/389>`_
+        - Updated enum classes generation
+           - Promote all inner enums to root `#383 <https://github.com/tefra/xsdata/issues/383>`_
+           - Fixed issues with producing invalid members `#385 <https://github.com/tefra/xsdata/issues/385>`_
+           - Added support for list/tuple member values
+        - Updated parsers accuracy for Union types
+        - Updated dependency resolution accuracy
+        - Update base classes generation strategies
+        - Updated builtin data types with helper constructors/methods
+        - Fixed inner class names conflicts `#375 <https://github.com/tefra/xsdata/issues/375>`_
+        - Fixed issue not generating fields derived from xs:alternative elements `#393 <https://github.com/tefra/xsdata/issues/393>`_
+        - Fixed duplicate root class name regression from v20.12
+        - Fixed issue adding unused lib imports
+        - Fixed issue adding unused name properties to choice elements
         
 Keywords: xsd,wsdl,schema,binding,xml,json,dataclasses,generator,cli
 Platform: UNKNOWN

{xsdata-21.1 → xsdata-21.2}/README.rst

@@ -59,23 +59,25 @@ Features
 - Pluggable code writer that supports python dataclasses and PlantUML class diagrams.
 
 
-Changelog: 21.1 (2021-01-08)
+Changelog: 21.2 (2021-02-02)
 ----------------------------
-- Fixed XmlWriter converting attribute keys to QName. `#346 <https://github.com/tefra/xsdata/issues/346>`_
-- Set empty complexType base to anySimpleType `#349 <https://github.com/tefra/xsdata/issues/349>`_
-- Improve duplicate attr names detection `#351 <https://github.com/tefra/xsdata/issues/351>`_
-- Add SerializerConfig::xml_declaration option `#357 <https://github.com/tefra/xsdata/issues/357>`_
-- Generate default value/factory for compound fields `#359 <https://github.com/tefra/xsdata/issues/359>`_
-- Fixed default value for token fields `#360 <https://github.com/tefra/xsdata/issues/360>`_
-- Add doc metadata for compound fields `#362 <https://github.com/tefra/xsdata/issues/362>`_
-- JsonParser: handle class and primitive unions `#369 <https://github.com/tefra/xsdata/issues/369>`_
-- Update python mappings `#366 <https://github.com/tefra/xsdata/issues/366>`_
-   - Map xs:hexBinary and xs:base64Binary to bytes
-   - Map xs:date/time types to builtin types XmlDate/Time
-   - Map xs:duration to builtin type XmlDuration
-   - Map xs:g[Year[Month[Day]]] to builtin type XmlPeriod
-   - Map xs:Notation to QName
-   - Add converter adapters for datetime.date/time
-   - Add fields metadata key 'format' for time/date/binary types
-   - Fixed issues with default literal values
-   - Fixed issue with random field types order
+
+- Added class name context for user naming schemes `#348 <https://github.com/tefra/xsdata/issues/348>`_
+- Added mixed pascal naming scheme `#348 <https://github.com/tefra/xsdata/issues/348>`_
+- Added access to element/attribute name generators `#381 <https://github.com/tefra/xsdata/issues/381>`_
+- Added XmlHexBinary/XmlBase64Binary builtin data types `#387 <https://github.com/tefra/xsdata/issues/387>`_
+- Added support for xs:anyType root elements `#399 <https://github.com/tefra/xsdata/issues/399>`_
+- Updated JSON binding modules to use the fields local name `#389 <https://github.com/tefra/xsdata/issues/389>`_
+- Updated enum classes generation
+   - Promote all inner enums to root `#383 <https://github.com/tefra/xsdata/issues/383>`_
+   - Fixed issues with producing invalid members `#385 <https://github.com/tefra/xsdata/issues/385>`_
+   - Added support for list/tuple member values
+- Updated parsers accuracy for Union types
+- Updated dependency resolution accuracy
+- Update base classes generation strategies
+- Updated builtin data types with helper constructors/methods
+- Fixed inner class names conflicts `#375 <https://github.com/tefra/xsdata/issues/375>`_
+- Fixed issue not generating fields derived from xs:alternative elements `#393 <https://github.com/tefra/xsdata/issues/393>`_
+- Fixed duplicate root class name regression from v20.12
+- Fixed issue adding unused lib imports
+- Fixed issue adding unused name properties to choice elements

xsdata-21.2/docs/api/reference/xsdata.models.datatype.XmlBase64Binary.rst

@@ -0,0 +1,7 @@
+XmlBase64Binary
+===============
+
+.. currentmodule:: xsdata.models.datatype
+
+.. autoclass:: XmlBase64Binary
+    :members:

xsdata-21.2/docs/api/reference/xsdata.models.datatype.XmlHexBinary.rst

@@ -0,0 +1,7 @@
+XmlHexBinary
+============
+
+.. currentmodule:: xsdata.models.datatype
+
+.. autoclass:: XmlHexBinary
+    :members:

xsdata-21.2/docs/api/reference/xsdata.utils.text.camel_case.rst

@@ -0,0 +1,6 @@
+xsdata.utils.text.camel\_case
+=============================
+
+.. currentmodule:: xsdata.utils.text
+
+.. autofunction:: camel_case

xsdata-21.2/docs/api/reference/xsdata.utils.text.capitalize.rst

@@ -0,0 +1,6 @@
+xsdata.utils.text.capitalize
+============================
+
+.. currentmodule:: xsdata.utils.text
+
+.. autofunction:: capitalize

xsdata-21.2/docs/api/reference/xsdata.utils.text.kebab_case.rst

@@ -0,0 +1,6 @@
+xsdata.utils.text.kebab\_case
+=============================
+
+.. currentmodule:: xsdata.utils.text
+
+.. autofunction:: kebab_case

xsdata-21.2/docs/api/reference/xsdata.utils.text.mixed_case.rst

@@ -0,0 +1,6 @@
+xsdata.utils.text.mixed\_case
+=============================
+
+.. currentmodule:: xsdata.utils.text
+
+.. autofunction:: mixed_case

xsdata-21.2/docs/api/reference/xsdata.utils.text.mixed_pascal_case.rst

@@ -0,0 +1,6 @@
+xsdata.utils.text.mixed\_pascal\_case
+=====================================
+
+.. currentmodule:: xsdata.utils.text
+
+.. autofunction:: mixed_pascal_case

xsdata-21.2/docs/api/reference/xsdata.utils.text.mixed_snake_case.rst

@@ -0,0 +1,6 @@
+xsdata.utils.text.mixed\_snake\_case
+====================================
+
+.. currentmodule:: xsdata.utils.text
+
+.. autofunction:: mixed_snake_case

xsdata-21.2/docs/api/reference/xsdata.utils.text.pascal_case.rst

@@ -0,0 +1,6 @@
+xsdata.utils.text.pascal\_case
+==============================
+
+.. currentmodule:: xsdata.utils.text
+
+.. autofunction:: pascal_case

xsdata-21.2/docs/api/reference/xsdata.utils.text.snake_case.rst

@@ -0,0 +1,6 @@
+xsdata.utils.text.snake\_case
+=============================
+
+.. currentmodule:: xsdata.utils.text
+
+.. autofunction:: snake_case

xsdata-21.2/docs/api/utils.rst

@@ -0,0 +1,19 @@
+=========
+Utilities
+=========
+
+
+.. currentmodule:: xsdata.utils
+
+.. autosummary::
+    :toctree: reference
+    :nosignatures:
+
+    text.capitalize
+    text.pascal_case
+    text.camel_case
+    text.mixed_case
+    text.mixed_pascal_case
+    text.mixed_snake_case
+    text.snake_case
+    text.kebab_case

{xsdata-21.1 → xsdata-21.2}/docs/api/xml-datatypes.rst

@@ -16,3 +16,5 @@ XML Datatypes
     XmlDateTime
     XmlDuration
     XmlPeriod
+    XmlHexBinary
+    XmlBase64Binary

{xsdata-21.1 → xsdata-21.2}/docs/data-types-table.rst

@@ -16,77 +16,77 @@
       -
       -
     * - :class:`bytes`
-      - base64Binary
       - hexBinary
+      - base64Binary
       -
       -
       -
     * - :class:`~decimal.Decimal`
       - decimal
-      - double
+      -
       -
       -
       -
     * - :class:`float`
       - float
-      -
+      - double
       -
       -
       -
     * - :class:`int`
-      - byte
-      - int
       - integer
-      - long
+      - nonPositiveInteger
       - negativeInteger
+      - long
+      - int
     * -
-      - nonNegativeInteger
-      - nonPositiveInteger
-      - positiveInteger
       - short
-      - unsignedByte
-    * -
-      - unsignedInt
+      - byte
+      - nonNegativeInteger
       - unsignedLong
+      - unsignedInt
+    * -
       - unsignedShort
+      - unsignedByte
+      - positiveInteger
       -
       -
     * - :class:`object`
-      - anySimpleType
       - anyType
+      - anySimpleType
       -
       -
       -
     * - :class:`~xml.etree.ElementTree.QName`
-      - NOTATION
       - QName
+      - NOTATION
       -
       -
       -
     * - :class:`str`
-      - anyAtomicType
+      - string
       - anyURI
-      - base
-      - derivationControl
-      - ENTITIES
+      - normalizedString
+      - token
+      - language
     * -
-      - ENTITY
-      - error
+      - NMTOKEN
+      - NMTOKENS
+      - Name
+      - NCName
       - ID
+    * -
       - IDREF
       - IDREFS
+      - ENTITIES
+      - ENTITY
+      - anyAtomicType
     * -
-      - lang
-      - language
-      - Name
-      - NCName
-      - NMTOKEN
-    * -
-      - NMTOKENS
-      - normalizedString
-      - simpleDerivationSet
-      - string
-      - token
+      - error
+      -
+      -
+      -
+      -
     * - :class:`~xsdata.models.datatype.XmlDate`
       - date
       -
@@ -100,17 +100,17 @@
       -
       -
     * - :class:`~xsdata.models.datatype.XmlDuration`
+      - duration
       - dayTimeDuration
       - yearMonthDuration
-      - duration
       -
       -
     * - :class:`~xsdata.models.datatype.XmlPeriod`
-      - gDay
-      - gMonth
-      - gMonthDay
-      - gYear
       - gYearMonth
+      - gYear
+      - gMonthDay
+      - gMonth
+      - gDay
     * - :class:`~xsdata.models.datatype.XmlTime`
       - time
       -

{xsdata-21.1 → xsdata-21.2}/docs/models.rst

@@ -27,6 +27,9 @@ Basic Model
 Class Meta
 ==========
 
+Through the Meta class you can control the model's behaviour during data binding
+procedures.
+
 .. list-table::
    :widths: 20 10 300
    :header-rows: 1
@@ -36,13 +39,19 @@ Class Meta
      - Description
    * - name
      - str
-     - The real name of the element this class represents.
+     - The real/local name of the element this class represents.
    * - nillable
      - bool
      - Specifies whether an explicit empty value can be assigned, default: False
    * - namespace
      - str
      - The element xml namespace.
+   * - element_name_generator
+     - Callable
+     - Element name generator
+   * - attribute_name_generator
+     - Callable
+     - Attribute name generator
 
 
 Field Typing
@@ -55,6 +64,9 @@ Simply follow the Python lib
 Field Metadata
 ==============
 
+Through the metadata properties you can control the field's behaviour during data
+binding procedures.
+
 .. list-table::
    :widths: 20 10 250
    :header-rows: 1
@@ -64,7 +76,7 @@ Field Metadata
      - Description
    * - name
      - str
-     - The real name of the element or attribute this field represents.
+     - The real/local name of the element or attribute this field represents.
    * - type
      - str
      - The field xml type:
@@ -328,3 +340,142 @@ is directly assigned as text to elements.
 .. code-block:: xml
 
     <root>2020</root>
+
+
+Advance Topics
+==============
+
+Customize element and attribute names
+~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
+
+Through the model and field metadata you can explicitly specify the serialized
+names. You can also provide callables to set the real/local names per model or
+for the entire binding context.
+
+
+**Ordered by priority**
+
+.. tab:: Explicit names
+
+    Explicit model and field names is the most straight forward way to customize
+    the real/local names for elements and attributes. It can become tedious though
+    when you have to do this for models with a lot of fields.
+
+    .. doctest::
+
+        >>> from dataclasses import dataclass, field
+        >>> from datetime import date
+        >>> from xsdata.formats.dataclass.serializers import XmlSerializer
+        >>> from xsdata.formats.dataclass.serializers.config import SerializerConfig
+        ...
+        >>> config = SerializerConfig(pretty_print=True, xml_declaration=False)
+        >>> serializer = XmlSerializer(config=config)
+        ...
+        >>> @dataclass
+        ... class Person:
+        ...
+        ...     class Meta:
+        ...         name = "Person"  # Explicit name
+        ...
+        ...     first_name: str = field(metadata=dict(name="firstName"))
+        ...     last_name: str = field(metadata=dict(name="lastName"))
+        ...     birth_date: date = field(
+        ...         metadata=dict(
+        ...             type="Attribute",
+        ...             format="%Y-%m-%d",
+        ...             name="dob"  # Explicit name
+        ...         )
+        ...     )
+        ...
+        >>> obj = Person(
+        ...     first_name="Chris",
+        ...     last_name="T",
+        ...     birth_date=date(1986, 9, 25),
+        ... )
+        >>> print(serializer.render(obj))
+        <Person dob="1986-09-25">
+          <firstName>Chris</firstName>
+          <lastName>T</lastName>
+        </Person>
+        <BLANKLINE>
+
+
+.. tab:: Model name generators
+
+    Through the Meta class you can provide callables to apply a naming scheme for all
+    the model fields. The :mod:`xsdata.utils.text` has various helpers that you can
+    reuse.
+
+    .. doctest::
+
+        >>> from xsdata.utils import text
+        ...
+        >>> @dataclass
+        ... class person:
+        ...
+        ...     class Meta:
+        ...         element_name_generator = text.pascal_case
+        ...         attribute_name_generator = text.camel_case
+        ...
+        ...     first_name: str
+        ...     last_name: str
+        ...     birth_date: date = field(
+        ...         metadata=dict(
+        ...             type="Attribute",
+        ...             format="%Y-%m-%d"
+        ...         )
+        ...     )
+        ...
+        >>> obj = person(
+        ...     first_name="Chris",
+        ...     last_name="T",
+        ...     birth_date=date(1986, 9, 25),
+        ... )
+        >>> print(serializer.render(obj))
+        <Person birthDate="1986-09-25">
+          <FirstName>Chris</FirstName>
+          <LastName>T</LastName>
+        </Person>
+        <BLANKLINE>
+
+
+.. tab:: Context name generators
+
+    Through the :class:`~xsdata.formats.dataclass.context.XmlContext` instance you can
+    provide callables to apply a naming scheme for all models and their fields. This way
+    you can avoid declaring them for every model but you have to use the same context
+    whenever you want to use a parser/serializer.
+
+    .. doctest::
+
+        >>> from xsdata.formats.dataclass.context import XmlContext
+        ...
+        >>> @dataclass
+        ... class Person:
+        ...
+        ...     first_name: str
+        ...     last_name: str
+        ...     birth_date: date = field(
+        ...         metadata=dict(
+        ...             type="Attribute",
+        ...             format="%Y-%m-%d"
+        ...         )
+        ...     )
+        ...
+        >>> obj = Person(
+        ...     first_name="Chris",
+        ...     last_name="T",
+        ...     birth_date=date(1986, 9, 25),
+        ... )
+        ...
+        >>> context = XmlContext(
+        ...     element_name_generator=text.camel_case,
+        ...     attribute_name_generator=text.kebab_case
+        ... )
+        >>> serializer = XmlSerializer(context=context, config=config)
+        >>> print(serializer.render(obj))
+        <person birth-date="1986-09-25">
+          <firstName>Chris</firstName>
+          <lastName>T</lastName>
+        </person>
+        <BLANKLINE>

{xsdata-21.1 → xsdata-21.2}/setup.cfg

@@ -1,6 +1,6 @@
 [metadata]
 name = xsdata
-version = 21.1
+version = 21.2
 description = Python XML Binding
 long_description = file: README.rst
 long_description_content_type = text/x-rst

{xsdata-21.1 → xsdata-21.2}/tests/codegen/handlers/test_attribute_group.py

@@ -9,9 +9,7 @@ from xsdata.codegen.models import Attr
 from xsdata.codegen.models import Status
 from xsdata.codegen.utils import ClassUtils
 from xsdata.exceptions import AnalyzerValueError
-from xsdata.models.xsd import AttributeGroup
-from xsdata.models.xsd import ComplexType
-from xsdata.models.xsd import Group
+from xsdata.models.enums import Tag
 
 
 class AttributeGroupHandlerTests(FactoryTestCase):
@@ -47,8 +45,8 @@ class AttributeGroupHandlerTests(FactoryTestCase):
 
     @mock.patch.object(ClassUtils, "copy_group_attributes")
     def test_process_attribute_with_group(self, mock_copy_group_attributes):
-        complex_bar = ClassFactory.create(qname="bar", type=ComplexType)
-        group_bar = ClassFactory.create(qname="bar", type=Group)
+        complex_bar = ClassFactory.create(qname="bar", tag=Tag.COMPLEX_TYPE)
+        group_bar = ClassFactory.create(qname="bar", tag=Tag.GROUP)
         group_attr = AttrFactory.attribute_group(name="bar")
         target = ClassFactory.create()
         target.attrs.append(group_attr)
@@ -64,8 +62,8 @@ class AttributeGroupHandlerTests(FactoryTestCase):
 
     @mock.patch.object(ClassUtils, "copy_group_attributes")
     def test_process_attribute_with_attribute_group(self, mock_copy_group_attributes):
-        complex_bar = ClassFactory.create(qname="bar", type=ComplexType)
-        group_bar = ClassFactory.create(qname="bar", type=AttributeGroup)
+        complex_bar = ClassFactory.create(qname="bar", tag=Tag.COMPLEX_TYPE)
+        group_bar = ClassFactory.create(qname="bar", tag=Tag.ATTRIBUTE_GROUP)
         group_attr = AttrFactory.attribute_group(name="bar")
         target = ClassFactory.create()
         target.attrs.append(group_attr)
@@ -81,7 +79,7 @@ class AttributeGroupHandlerTests(FactoryTestCase):
 
     def test_process_attribute_with_circular_reference(self):
         group_attr = AttrFactory.attribute_group(name="bar")
-        target = ClassFactory.create(qname="bar", type=Group)
+        target = ClassFactory.create(qname="bar", tag=Tag.GROUP)
         target.attrs.append(group_attr)
 
         target.status = Status.PROCESSING