serialization gallery

gallery.py

# Works with Spyne 2.11 from https://github.com/arskom/spyne
# It's not yet released at the time this script is written.

from spyne.model import *


class SubtypeColumn(ComplexModel):
    col_name = XmlAttribute(Unicode)
    required = XmlAttribute(Boolean)

class DisplayName(ComplexModel):
    col_name = XmlAttribute(Unicode)
    separator = XmlAttribute(Boolean)

class Choice(ComplexModel):
    code = XmlAttribute(Unicode)
    descr = XmlAttribute(Unicode)
    subtype_columns = Array(SubtypeColumn)
    displaynames = Array(DisplayName)

class Choices(ComplexModel):
    use_subtypes = XmlAttribute(Boolean)
    use_displaynames = XmlAttribute(Boolean)

    choice = Choice.customize(max_occurs="unbounded")


choices = Choices(
  use_subtypes=True,
  use_displaynames=True,
  choice=[
    Choice(
      code=u'admin',
      descr=u'System administrator',
      displaynames=[
      ],
      subtype_columns=[
      ],
    ),
    Choice(
      code=u'ind',
      descr=u'Individual',
      displaynames=[
        DisplayName(
          col_name=u'first_name',
          separator=False,
        ),
        DisplayName(
          col_name=u'surname',
          separator=False,
        ),
      ],
      subtype_columns=[
        SubtypeColumn(
          required=True,
          col_name=u'first_name',
        ),
        SubtypeColumn(
          required=True,
          col_name=u'surname',
        ),
      ],
    ),
    Choice(
      code=u'comp',
      descr=u'Company',
      displaynames=[
        DisplayName(
          col_name=u'comp_name',
          separator=False,
        ),
      ],
      subtype_columns=[
        SubtypeColumn(
          required=True,
          col_name=u'comp_name',
        ),
        SubtypeColumn(
          required=True,
          col_name=u'reg_no',
        ),
        SubtypeColumn(
          required=False,
          col_name=u'vat_no',
        ),
      ],
    ),
  ],
)

from spyne.util.dictdoc import get_object_as_json
print get_object_as_json(choices, Choices, complex_as=dict)
print get_object_as_json(choices, Choices, complex_as=list)

from spyne.util.dictdoc import get_object_as_yaml
print get_object_as_yaml(choices, Choices)
print get_object_as_yaml(choices, Choices, ignore_wrappers=True)
print get_object_as_yaml(choices, Choices, complex_as=list)

from lxml import etree
from spyne.util.xml import get_object_as_xml
elt = get_object_as_xml(choices, Choices)
print etree.tostring(elt, pretty_print=True)

from spyne.util.xml import get_xml_as_object
choices = get_xml_as_object(elt, Choices)
from spyne.interface.xml_schema.parser import Thier_repr
hier_repr = Thier_repr()
print hier_repr(choices)

# Xml validation example
class C(ComplexModel):
    title = Unicode(values=['Mr', 'Mrs', 'Ms'])

from lxml import etree
from spyne.util.xml import get_validation_schema
schema = get_validation_schema([C], 'some_ns')
doc1 = etree.fromstring('<C xmlns="some_ns"><title>Mr</title></C>')
print schema.validate(doc1)
doc2 = etree.fromstring('<C xmlns="some_ns"><title>xyz</title></C>')
print schema.validate(doc2)
print schema.error_log

output.txt

{"use_subtypes": true, "use_displaynames": true, "choice": [{"subtype_columns": [], "displaynames": [], "code": "admin", "descr": "System administrator"}, {"subtype_columns": [{"required": true, "col_name": "first_name"}, {"required": true, "col_name": "surname"}], "displaynames": [{"separator": false, "col_name": "first_name"}, {"separator": false, "col_name": "surname"}], "code": "ind", "descr": "Individual"}, {"subtype_columns": [{"required": true, "col_name": "comp_name"}, {"required": true, "col_name": "reg_no"}, {"required": false, "col_name": "vat_no"}], "displaynames": [{"separator": false, "col_name": "comp_name"}], "code": "comp", "descr": "Company"}]}
[true, true, [["admin", "System administrator", [], []], ["ind", "Individual", [["first_name", false], ["surname", false]], [[true, "first_name"], [true, "surname"]]], ["comp", "Company", [["comp_name", false]], [[true, "comp_name"], [true, "reg_no"], [false, "vat_no"]]]]]
Choices:
    choice:
    -   Choice:
            code: admin
            descr: System administrator
            displaynames: []
            subtype_columns: []
    -   Choice:
            code: ind
            descr: Individual
            displaynames:
            -   DisplayName:
                    col_name: first_name
                    separator: false
            -   DisplayName:
                    col_name: surname
                    separator: false
            subtype_columns:
            -   SubtypeColumn:
                    col_name: first_name
                    required: true
            -   SubtypeColumn:
                    col_name: surname
                    required: true
    -   Choice:
            code: comp
            descr: Company
            displaynames:
            -   DisplayName:
                    col_name: comp_name
                    separator: false
            subtype_columns:
            -   SubtypeColumn:
                    col_name: comp_name
                    required: true
            -   SubtypeColumn:
                    col_name: reg_no
                    required: true
            -   SubtypeColumn:
                    col_name: vat_no
                    required: false
    use_displaynames: true
    use_subtypes: true

choice:
-   code: admin
    descr: System administrator
    displaynames: []
    subtype_columns: []
-   code: ind
    descr: Individual
    displaynames:
    -   col_name: first_name
        separator: false
    -   col_name: surname
        separator: false
    subtype_columns:
    -   col_name: first_name
        required: true
    -   col_name: surname
        required: true
-   code: comp
    descr: Company
    displaynames:
    -   col_name: comp_name
        separator: false
    subtype_columns:
    -   col_name: comp_name
        required: true
    -   col_name: reg_no
        required: true
    -   col_name: vat_no
        required: false
use_displaynames: true
use_subtypes: true

- true
- true
-   -   - admin
        - System administrator
        - []
        - []
    -   - ind
        - Individual
        -   -   - first_name
                - false
            -   - surname
                - false
        -   -   - true
                - first_name
            -   - true
                - surname
    -   - comp
        - Company
        -   -   - comp_name
                - false
        -   -   - true
                - comp_name
            -   - true
                - reg_no
            -   - false
                - vat_no

<Choices use_subtypes="true" use_displaynames="true">
  <choice code="admin" descr="System administrator">
    <displaynames/>
    <subtype_columns/>
  </choice>
  <choice code="ind" descr="Individual">
    <displaynames>
      <DisplayName col_name="first_name" separator="false"/>
      <DisplayName col_name="surname" separator="false"/>
    </displaynames>
    <subtype_columns>
      <SubtypeColumn required="true" col_name="first_name"/>
      <SubtypeColumn required="true" col_name="surname"/>
    </subtype_columns>
  </choice>
  <choice code="comp" descr="Company">
    <displaynames>
      <DisplayName col_name="comp_name" separator="false"/>
    </displaynames>
    <subtype_columns>
      <SubtypeColumn required="true" col_name="comp_name"/>
      <SubtypeColumn required="true" col_name="reg_no"/>
      <SubtypeColumn required="false" col_name="vat_no"/>
    </subtype_columns>
  </choice>
</Choices>

Choices(
  use_subtypes=True,
  use_displaynames=True,
  choice=[
    Choice(
      code=u'admin',
      descr=u'System administrator',
      displaynames=[
      ],
      subtype_columns=[
      ],
    ),
    Choice(
      code=u'ind',
      descr=u'Individual',
      displaynames=[
        DisplayName(
          col_name=u'first_name',
          separator=False,
        ),
        DisplayName(
          col_name=u'surname',
          separator=False,
        ),
      ],
      subtype_columns=[
        SubtypeColumn(
          required=True,
          col_name=u'first_name',
        ),
        SubtypeColumn(
          required=True,
          col_name=u'surname',
        ),
      ],
    ),
    Choice(
      code=u'comp',
      descr=u'Company',
      displaynames=[
        DisplayName(
          col_name=u'comp_name',
          separator=False,
        ),
      ],
      subtype_columns=[
        SubtypeColumn(
          required=True,
          col_name=u'comp_name',
        ),
        SubtypeColumn(
          required=True,
          col_name=u'reg_no',
        ),
        SubtypeColumn(
          required=False,
          col_name=u'vat_no',
        ),
      ],
    ),
  ],
)
True
False
<string>:1:0:ERROR:SCHEMASV:SCHEMAV_CVC_ENUMERATION_VALID: Element '{some_ns}title': [facet 'enumeration'] The value 'xyz' is not an element of the set {'Mr', 'Mrs', 'Ms'}.
<string>:1:0:ERROR:SCHEMASV:SCHEMAV_CVC_DATATYPE_VALID_1_2_1: Element '{some_ns}title': 'xyz' is not a valid value of the atomic type '{some_ns}C_titleType'.