OData request/response serializer enhancements

Author: vgrem

office365/graph_client.py

@@ -49,7 +49,7 @@ def __init__(self, acquire_token_callback):
         :param () -> dict acquire_token_callback: Acquire token function
         """
         super(GraphClient, self).__init__()
-        self._pending_request = ODataRequest(self, V4JsonFormat("minimal"))
+        self._pending_request = ODataRequest(self, V4JsonFormat())
         self._pending_request.beforeExecute += self._build_specific_query
         self._resource = "https://graph.microsoft.com"
         self._authority_host_url = "https://login.microsoftonline.com"

office365/runtime/client_object.py

@@ -205,9 +205,9 @@ def to_json(self, json_format=None):
             if isinstance(v, ClientObject) or isinstance(v, ClientValue):
                 json[k] = v.to_json(json_format)
 
-        if json and self.entity_type_name is not None:
-            if isinstance(json_format, JsonLightFormat) and json_format.is_verbose:
+        if json and self.entity_type_name is not None and json_format.include_control_information():
+            if isinstance(json_format, JsonLightFormat):
                 json[json_format.metadata_type_tag_name] = {'type': self.entity_type_name}
-            elif isinstance(json_format, ODataJsonFormat) and json_format.metadata_level == "minimal":
+            elif isinstance(json_format, ODataJsonFormat):
                 json[json_format.metadata_type_tag_name] = "#" + self.entity_type_name
         return json

office365/runtime/client_value.py

@@ -33,7 +33,7 @@ def to_json(self, json_format=None):
             if isinstance(v, ClientValue):
                 json[n] = v.to_json(json_format)
 
-        if isinstance(json_format, JsonLightFormat) and json_format.is_verbose and self.entity_type_name is not None:
+        if isinstance(json_format, JsonLightFormat) and json_format.include_control_information() and self.entity_type_name is not None:
             json[json_format.metadata_type_tag_name] = {'type': self.entity_type_name}
 
         return json

office365/runtime/client_value_collection.py

@@ -41,7 +41,7 @@ def to_json(self, json_format=None):
         for i, v in enumerate(json_items):
             if isinstance(v, ClientValue):
                 json_items[i] = v.to_json(json_format)
-        if isinstance(json_format, JsonLightFormat) and json_format.is_verbose:
+        if isinstance(json_format, JsonLightFormat) and json_format.include_control_information():
             json = {json_format.collection_tag_name: json_items,
                     json_format.metadata_type_tag_name: {'type': self.entity_type_name}}
 

office365/runtime/odata/odata_json_format.py

@@ -21,3 +21,11 @@ def __init__(self, metadata_level=None):
     @abstractmethod
     def get_media_type(self):
         pass
+
+    @abstractmethod
+    def include_control_information(self):
+        """Determines whether control information that is represented as annotations should be included in payload
+
+        :rtype: bool
+        """
+        pass

office365/runtime/odata/v3/json_light_format.py

@@ -1,13 +1,13 @@
 from office365.runtime.odata.odata_json_format import ODataJsonFormat
-from office365.runtime.odata.v3.metadata_level import ODataMetadataLevel
+from office365.runtime.odata.v3.metadata_level import ODataV3MetadataLevel
 
 
 class JsonLightFormat(ODataJsonFormat):
     """JSON Light format for SharePoint Online/One Drive for Business"""
 
-    def __init__(self, metadata_level=ODataMetadataLevel.Verbose):
+    def __init__(self, metadata_level=ODataV3MetadataLevel.Verbose):
         super(JsonLightFormat, self).__init__(metadata_level)
-        if self.metadata_level == ODataMetadataLevel.Verbose:
+        if self.metadata_level == ODataV3MetadataLevel.Verbose:
             self.security_tag_name = "d"
             self.collection_tag_name = "results"
             self.collection_next_tag_name = "__next"
@@ -19,6 +19,6 @@ def __init__(self, metadata_level=ODataMetadataLevel.Verbose):
     def get_media_type(self):
         return 'application/json;odata={0}'.format(self.metadata_level)
 
-    @property
-    def is_verbose(self):
-        return self.metadata_level == ODataMetadataLevel.Verbose
+    def include_control_information(self):
+        return self.metadata_level == ODataV3MetadataLevel.Verbose \
+               or self.metadata_level == ODataV3MetadataLevel.MinimalMetadata

office365/runtime/odata/v3/metadata_level.py

@@ -1,8 +1,13 @@
-class ODataMetadataLevel:
+class ODataV3MetadataLevel:
     """The amount of metadata information to serialize in an OData response."""
     def __init__(self):
         pass
 
     Verbose = "verbose"
+    """Indicates that the service MUST include all control information explicitly in the payload."""
+
     NoMetadata = "nometadata"
+    """Indicates that the service SHOULD omit control information other than odata.nextLink and odata.count"""
+
     MinimalMetadata = "minimalmetadata"
+    """Indicates that the service SHOULD remove computable control information from the payload wherever possible"""

office365/runtime/odata/v4/json_format.py

@@ -1,10 +1,11 @@
 from office365.runtime.odata.odata_json_format import ODataJsonFormat
+from office365.runtime.odata.v4.metadata_level import ODataV4MetadataLevel
 
 
 class V4JsonFormat(ODataJsonFormat):
     """V4 JSON format"""
 
-    def __init__(self, metadata_level):
+    def __init__(self, metadata_level=ODataV4MetadataLevel.Minimal):
         super(V4JsonFormat, self).__init__(metadata_level)
         """The IEEE754Compatible format parameter indicates that the service MUST serialize Edm.Int64 and
         Edm.Decimal numbers as strings."""
@@ -17,3 +18,6 @@ def __init__(self, metadata_level):
     def get_media_type(self):
         return "application/json;odata.metadata={0};odata.streaming={1};IEEE754Compatible={2}" \
             .format(self.metadata_level, self.streaming, self.IEEE754Compatible)
+
+    def include_control_information(self):
+        return self.metadata_level == ODataV4MetadataLevel.Minimal or self.metadata_level == ODataV4MetadataLevel.Full

office365/runtime/odata/v4/metadata_level.py

@@ -0,0 +1,12 @@
+class ODataV4MetadataLevel:
+
+    Full = "full"
+    """Indicates that the service MUST include all control information explicitly in the payload."""
+
+    NoMetadata = "none"
+    """Indicates that the service SHOULD omit control information other than odata.nextLink and odata.count"""
+
+    Minimal = "minimal"
+    """Indicates that the service SHOULD remove computable control information from the payload wherever possible.
+    This is the default value for the odata.metadata parameter and will be assumed if no other value is specified in
+    the Accept header or $format query option"""

office365/runtime/types/string_collection.py

@@ -0,0 +1,11 @@
+from office365.runtime.client_value_collection import ClientValueCollection
+
+
+class StringCollection(ClientValueCollection):
+
+    def __init__(self, initial_values=None):
+        super(StringCollection, self).__init__(str, initial_values)
+
+    @property
+    def entity_type_name(self):
+        return "Collection(Edm.String)"

office365/sharepoint/client_context.py

@@ -10,7 +10,6 @@
 from office365.runtime.http.request_options import RequestOptions
 from office365.runtime.odata.v3.json_light_format import JsonLightFormat
 from office365.runtime.odata.v3.batch_request import ODataBatchRequest
-from office365.runtime.odata.v3.metadata_level import ODataMetadataLevel
 from office365.runtime.odata.odata_request import ODataRequest
 from office365.runtime.queries.batch_query import BatchQuery
 from office365.runtime.queries.client_query import ClientQuery
@@ -146,7 +145,7 @@ def pending_request(self):
         :return: ODataRequest
         """
         if self.__pending_request is None:
-            self.__pending_request = ODataRequest(self, JsonLightFormat(ODataMetadataLevel.Verbose))
+            self.__pending_request = ODataRequest(self, JsonLightFormat())
             self.__pending_request.beforeExecute += self._build_modification_query
         return self.__pending_request
 

office365/sharepoint/portal/site_linking_manager.py

@@ -24,9 +24,8 @@ def entity_type_name(self):
 class SiteLinkingManager(BaseEntity):
     """"""
 
-    def __init__(self, context):
-        super(SiteLinkingManager, self).__init__(context,
-                                                 ResourcePath("Microsoft.SharePoint.Portal.SiteLinkingManager"))
+    def __init__(self, context, resource_path=None):
+        super(SiteLinkingManager, self).__init__(context, resource_path)
 
     def get_site_links(self):
         """"""

office365/sharepoint/taxonomy/taxonomy_service.py

@@ -14,7 +14,7 @@ def __init__(self, context):
         """
         super(TaxonomyService, self).__init__()
         self._auth_context = context.authentication_context
-        self._pendingRequest = ODataRequest(self, V4JsonFormat("minimal"))
+        self._pendingRequest = ODataRequest(self, V4JsonFormat())
         self._service_root_url = "{0}/v2.1/".format(context.service_root_url())
 
     def authenticate_request(self, request):