Changes between Version 2 and Version 3 of SoapToPython

Timestamp:

Jun 29, 2010 2:41:39 AM (14 years ago)

Author:

faber

Comment:

--

SoapToPython

@@ -17 +17 @@
 Each of these is encoded into python in the obvious ways.  Doubles, floats and integers are python numbers; strings and base64Binaries are python strings; booleans are python variables set to True or False; and dateTimes are integers.
 
-As simple element is encoded as a dictionary mapping between name and value.  All the elements in the same sequence (an xsd grouping) are in the same dictionary.  So, for example, the {{{vtopolanType}}} complex type (from [source:wsdl/trunk/fedd_types.xsd]) is described in xsd as:
+As simple element is encoded as a dictionary mapping between name and value.  All the elements in the same sequence (an xsd grouping) are in the same dictionary.  So, for example, the {{{vtopolanType}}} and {{{vtoponodeType}}} complex types (from [source:wsdl/trunk/fedd_types.xsd]) are described in xsd as:
 {{{
-<xsd:complexType name="vtopolanType">
+  <xsd:complexType name="visnodeType">
+    <xsd:annotation>
+      <xsd:documentation>
+        Node in the visualization of a federated experiment (Emulab
+        legacy).  Fields include the local hostname of the node, x,y
+        coordinates in a 2-dimensional representation, and whether the
+        node in the visualization is a host or a LAN.
+      </xsd:documentation>
+    </xsd:annotation>
+    <xsd:sequence>
+      <xsd:element name="name" type="xsd:string"/>
+      <xsd:element name="x" type="xsd:int"/>
+      <xsd:element name="y" type="xsd:int"/>
+      <xsd:element name="type" type="xsd:string"/>
+    </xsd:sequence>
+  </xsd:complexType>
+
+  <xsd:complexType name="vtopolanType">
     <xsd:annotation>
       <xsd:documentation>
@@ -37 +54 @@
     </xsd:sequence>
   </xsd:complexType>
+
 }}}
 
-translates into a python dict like:
+translate into python dicts like:
 
 {{{
-vlantopoType = {
+vtoponodeType = {
+  'vnode': 'name',
+  'ips': '10.1.1.1,10.1.2.1',
+}
+
+vtopolanType = {
   'vname': 'string',
   'vnode': 'string2',
@@ -52 +75 @@
 }}}
 
+A complex type that includes another element that is a sequence simply includes a dict keyed by the element name.
 
+Some elements are repeated multiple times in a type, or are optional, as noted by the {{{maxOccurs}}} and {{{minOccurs}}} attributes.  Elements that have {{{maxOccurs="1"}}} and {{{minOccurs="0"}}} defined in the XSD are optional fields and may either occur in the sequence/dict or not.  Elements with {{{maxOccurs="unbounded"}}} and {{{minOccurs="0"}}} defined in the XSD are repeated elements.  If none appear, the key is missing from the dict, if one or more are present the value mapped to the element name in the dict is a list of hashes, one for each copy of the repeatable element present.
+
+For example, the {{{vtopoType}}} from [source:wsdl/trunk/fedd_types.xsd fedd_types.xsd] includes a pair of repeated elements.  It is defined in XSD as:
+
+{{{
+  <xsd:complexType name="vtopoType">
+    <xsd:annotation>
+      <xsd:documentation>
+        The virtual topology of a federated experiment (Emulab legacy).
+      </xsd:documentation>
+    </xsd:annotation>
+    <xsd:sequence>
+      <xsd:element name="node" type="tns:vtoponodeType" minOccurs="0" 
+        maxOccurs="unbounded" />
+      <xsd:element name="lan" type="tns:vtopolanType" minOccurs="0"
+        maxOccurs="unbounded"/>
+    </xsd:sequence>
+  </xsd:complexType>
+}}}
+
+An example of that datatype that only