SharePoint API: improved support for fields namespace, fixes for 3.8

Author: vvgrem@gmail.com

office365/runtime/auth/providers/acs_token_provider.py

@@ -46,7 +46,7 @@ def get_app_only_access_token(self, target_host, target_realm):
         oauth2_request = self.create_access_token_request(principal_id, self.client_secret, resource)
         response = requests.post(url=sts_url, headers={'Content-Type': 'application/x-www-form-urlencoded'},
                                  data=oauth2_request)
-        return TokenResponse.from_json(response.content)
+        return TokenResponse.from_json(response.json())
 
     def _get_realm_from_target_url(self):
         response = requests.head(url=self.url, headers={'Authorization': 'Bearer'})

office365/runtime/auth/providers/oauth_token_provider.py

@@ -19,7 +19,7 @@ def acquire_token(self, parameters):
             response = requests.post(url=token_url,
                                      headers={'Content-Type': 'application/x-www-form-urlencoded'},
                                      data=parameters)
-            self.token = TokenResponse.from_json(response.content)
+            self.token = TokenResponse.from_json(response.json())
             return self.token.is_valid
         except requests.exceptions.RequestException as e:
             self.error = "Error: {0}".format(e)

office365/runtime/auth/tokenResponse.py

@@ -1,16 +1,3 @@
-import json
-
-
-def _normalize_token_response(json_data):
-    for key in json_data.keys():
-        key_parts = key.split("_")
-        if len(key_parts) == 2:
-            new_key = "".join([key_parts[0], key_parts[1].title()])
-            json_data[new_key] = json_data[key]
-            del json_data[key]
-    return json_data
-
-
 class TokenResponse(object):
 
     def __init__(self, accessToken=None, tokenType=None, **kwargs):
@@ -24,6 +11,14 @@ def is_valid(self):
         return self.accessToken is not None and self.tokenType == 'Bearer'
 
     @staticmethod
-    def from_json(json_str):
-        json_object = json.loads(json_str, object_hook=_normalize_token_response)
-        return TokenResponse(**json_object)
+    def from_json(value):
+
+        def _normalize_key(name):
+            key_parts = name.split("_")
+            if len(key_parts) >= 2:
+                names = [n.title() for n in key_parts[1:]]
+                return key_parts[0] + "".join(names)
+            return name
+
+        token_json = {_normalize_key(k): v for k, v in value.items()}
+        return TokenResponse(**token_json)

office365/runtime/clientValueCollection.py

@@ -3,13 +3,26 @@
 
 class ClientValueCollection(ClientValue):
 
-    def __init__(self):
+    def __init__(self, item_type):
         super().__init__()
         self._data = []
+        self._item_type = item_type
 
     def add(self, value):
         self._data.append(value)
 
     def __iter__(self):
         for item in self._data:
             yield item
+
+    def to_json(self):
+        return self._data
+
+    @property
+    def entity_type_name(self):
+        edm_primitive_types = {
+            int: "Edm.Int32",
+            str: "Edm.String",
+        }
+        item_type_name = edm_primitive_types.get(self._item_type, "Edm.Int32")
+        return "Collection({0})".format(item_type_name)

office365/runtime/odata/odata_request.py

@@ -1,3 +1,4 @@
+from office365.runtime.clientValueCollection import ClientValueCollection
 from office365.runtime.client_object import ClientObject
 from office365.runtime.client_object_collection import ClientObjectCollection
 from office365.runtime.client_query import CreateEntityQuery, UpdateEntityQuery, DeleteEntityQuery
@@ -54,7 +55,8 @@ def build_request(self):
         if isinstance(qry, ServiceOperationQuery):
             self.json_format.function_tag_name = qry.method_name
             if qry.static:
-                request_url = self.context.service_root_url + '.'.join([qry.binding_type.entity_type_name, qry.method_url])
+                request_url = self.context.service_root_url + '.'.join(
+                    [qry.binding_type.entity_type_name, qry.method_url])
             else:
                 request_url = '/'.join([qry.binding_type.resource_url, qry.method_url])
         else:
@@ -126,7 +128,11 @@ def _get_property(self, json, data_format):
                         yield name, value
 
     def _normalize_payload(self, value):
-        if isinstance(value, ClientObject) or isinstance(value, ClientValue):
+        if isinstance(value, ClientValueCollection):
+            if isinstance(self._json_format,
+                          JsonLightFormat) and self._json_format.metadata == ODataMetadataLevel.Verbose:
+                value = {"results": value.to_json()}
+        elif isinstance(value, ClientObject) or isinstance(value, ClientValue):
             json = value.to_json()
             for k, v in json.items():
                 json[k] = self._normalize_payload(v)
@@ -135,7 +141,8 @@ def _normalize_payload(self, value):
                           JsonLightFormat) and self._json_format.metadata == ODataMetadataLevel.Verbose:
                 json[self._json_format.metadata_type_tag_name] = {'type': value.entity_type_name}
 
-            if isinstance(self._current_query, ServiceOperationQuery) and self._current_query.parameter_name is not None:
+            if isinstance(self._current_query,
+                          ServiceOperationQuery) and self._current_query.parameter_name is not None:
                 json = {self._current_query.parameter_name: json}
             return json
         elif isinstance(value, dict):

office365/sharepoint/fields/field.py

@@ -10,6 +10,9 @@ class Field(BaseEntity):
 
     def __init__(self, context, resource_path=None):
         super().__init__(context, resource_path)
+
+    @staticmethod
+    def get_field_type(type_id):
         from office365.sharepoint.fields.fieldText import FieldText
         from office365.sharepoint.fields.fieldCalculated import FieldCalculated
         from office365.sharepoint.fields.fieldChoice import FieldChoice
@@ -21,7 +24,7 @@ def __init__(self, context, resource_path=None):
         from office365.sharepoint.fields.fieldGuid import FieldGuid
         from office365.sharepoint.fields.fieldCurrency import FieldCurrency
         from office365.sharepoint.fields.fieldMultiLineText import FieldMultiLineText
-        self._field_types = {
+        field_types = {
             FieldType.Text: FieldText,
             FieldType.Calculated: FieldCalculated,
             FieldType.Choice: FieldChoice,
@@ -34,14 +37,25 @@ def __init__(self, context, resource_path=None):
             FieldType.Currency: FieldCurrency,
             FieldType.Note: FieldMultiLineText
         }
+        return field_types.get(type_id, Field)
+
+    @staticmethod
+    def create_field_from_type(context, field_type):
+        field_type = Field.get_field_type(field_type)
+        return field_type(context)
 
     def set_show_in_display_form(self, flag):
-        """Sets the value of the ShowInDisplayForm property for this fields."""
+        """Sets the value of the ShowInDisplayForm property for this fields.
+
+        :type flag: bool
+        """
         qry = ServiceOperationQuery(self, "setShowInDisplayForm", [flag])
         self.context.add_query(qry)
 
     def set_show_in_edit_form(self, flag):
-        """Sets the value of the ShowInEditForm property for this fields."""
+        """Sets the value of the ShowInEditForm property for this fields.
+        :type flag: bool
+        """
         qry = ServiceOperationQuery(self, "setShowInEditForm", [flag])
         self.context.add_query(qry)
 
@@ -59,7 +73,7 @@ def delete_object(self):
     @property
     def internal_name(self):
         """Gets a value that specifies the field internal name."""
-        return self.properties['InternalName']
+        return self.properties.get('InternalName', None)
 
     def set_property(self, name, value, persist_changes=True):
         super(Field, self).set_property(name, value, persist_changes)
@@ -68,4 +82,4 @@ def set_property(self, name, value, persist_changes=True):
             self._resource_path = ResourcePathServiceOperation(
                 "getById", [value], self._parent_collection.resource_path)
         if name == "FieldTypeKind":
-            self.__class__ = self._field_types.get(value, Field)
+            self.__class__ = self.get_field_type(value)

office365/sharepoint/fields/fieldMultiChoiceValue.py

@@ -5,12 +5,7 @@
 class FieldMultiChoiceValue(ClientValueCollection):
 
     def __init__(self, choices):
-        super().__init__()
-        [self.add(c) for c in choices]
+        super().__init__(str)
+        [self.add(choice) for choice in choices]
 
-    def to_json(self):
-        return {"results": self._data}
 
-    @property
-    def entity_type_name(self):
-        return "Collection(Edm.String)"

office365/sharepoint/fields/fieldMultiLookupValue.py

@@ -5,18 +5,4 @@
 class FieldMultiLookupValue(ClientValueCollection):
 
     def __init__(self):
-        super().__init__()
-
-    @staticmethod
-    def from_lookup(ids):
-        val = FieldMultiLookupValue()
-        [val.add(FieldLookupValue(lookup_id)) for lookup_id in ids]
-        return val
-
-    def to_json(self):
-        lookup_ids = [v.LookupId for v in self]
-        return {"results": lookup_ids}
-
-    @property
-    def entity_type_name(self):
-        return "Collection(Edm.Int32)"
+        super().__init__(FieldLookupValue)

office365/sharepoint/fields/fieldMultiUserValue.py

@@ -6,3 +6,4 @@ class FieldMultiUserValue(FieldMultiLookupValue):
 
     def __init__(self):
         super().__init__()
+        self._item_type = FieldUserValue

office365/sharepoint/fields/field_collection.py

@@ -2,6 +2,7 @@
 from office365.runtime.client_query import CreateEntityQuery
 from office365.runtime.resource_path_service_operation import ResourcePathServiceOperation
 from office365.sharepoint.fields.field import Field
+from office365.sharepoint.fields.field_creation_information import FieldCreationInformation
 
 
 class FieldCollection(ClientObjectCollection):
@@ -19,7 +20,7 @@ def add(self, field_creation_information):
 
         :type field_creation_information: FieldCreationInformation
         """
-        field = Field(self.context)
+        field = Field.create_field_from_type(self.context, field_creation_information.FieldTypeKind)
         self.add_child(field)
         qry = CreateEntityQuery(self, field_creation_information, field)
         self.context.add_query(qry)
@@ -31,13 +32,15 @@ def get_by_id(self, _id):
 
     def get_by_internal_name_or_title(self, name_title):
         """Returns the first Field object with the specified internal name or title from the collection.
+
         :type name_title: str
         """
         return Field(self.context,
                      ResourcePathServiceOperation("getByInternalNameOrTitle", [name_title], self.resource_path))
 
     def get_by_title(self, title):
         """Returns the first fields object in the collection based on the title of the specified fields.
+
         :type title: str
         """
         return Field(self.context,

office365/sharepoint/fields/field_creation_information.py

@@ -1,4 +1,7 @@
 from office365.runtime.clientValue import ClientValue
+from office365.runtime.clientValueCollection import ClientValueCollection
+from office365.sharepoint.fields.field import Field
+from office365.sharepoint.fields.fieldType import FieldType
 
 
 class FieldCreationInformation(ClientValue):
@@ -13,12 +16,14 @@ def __init__(self, title, field_type_kind, description=None):
         self.Title = title
         self.FieldTypeKind = field_type_kind
         self.Description = description
-        self.Choices = None
+        self.Choices = field_type_kind == FieldType.MultiChoice and ClientValueCollection(str) or None
         self.LookupListId = None
         self.LookupFieldName = None
         self.LookupWebId = None
         self.Required = None
 
     @property
     def entity_type_name(self):
-        return "SP.Field"
+        type_name = Field.get_field_type(self.FieldTypeKind).__name__
+        return "SP.{0}".format(type_name)
+

office365/sharepoint/listitems/listitem.py

@@ -1,3 +1,4 @@
+from office365.runtime.clientValueCollection import ClientValueCollection
 from office365.runtime.client_query import UpdateEntityQuery, DeleteEntityQuery
 from office365.runtime.resource_path import ResourcePath
 from office365.runtime.resource_path_service_operation import ResourcePathServiceOperation
@@ -10,20 +11,6 @@
 class ListItem(SecurableObject):
     """ListItem resource"""
 
-    def set_field_value(self, name, value):
-        """
-        Sets fields value
-
-        :param str name: Field name
-        :param str or FieldLookupValue or FieldUserValue value: field value
-        """
-        if isinstance(value, FieldMultiLookupValue):
-            self.set_property("{name}Id".format(name=name), value, True)
-        elif isinstance(value, FieldLookupValue):
-            self.set_property("{name}Id".format(name=name), value, True)
-        else:
-            self.set_property(name, value, True)
-
     def update(self):
         """Update the list item."""
         self.ensure_type_name(self.parentList)
@@ -110,8 +97,23 @@ def ensure_type_name(self, target_list):
         :param office365.sharepoint.lists.list.List target_list: List entity
         :return:
         """
+
         def _init_item_type(result):
             self._entity_type_name = result.properties['ListItemEntityTypeFullName']
+
         if not self._entity_type_name:
             target_list.ensure_property("ListItemEntityTypeFullName", _init_item_type)
 
+    def to_json(self):
+        payload_orig = super(ListItem, self).to_json()
+        payload = {}
+        for k, v in payload_orig.items():
+            if isinstance(v, FieldMultiLookupValue):
+                collection = ClientValueCollection(int)
+                [collection.add(lv.LookupId) for lv in v]
+                payload["{name}Id".format(name=k)] = collection
+            elif isinstance(v, FieldLookupValue):
+                payload["{name}Id".format(name=k)] = v
+            else:
+                payload[k] = v
+        return payload

office365/sharepoint/tenantadministration/__init__.py renamed to office365/sharepoint/tenant/__init__.py

@@ -1,6 +1,6 @@
 from office365.runtime.client_object_collection import ClientObjectCollection
 from office365.runtime.queries.serviceOperationQuery import ServiceOperationQuery
-from office365.sharepoint.tenantadministration.siteProperties import SiteProperties
+from office365.sharepoint.tenant.administration.siteProperties import SiteProperties
 
 
 class SitePropertiesCollection(ClientObjectCollection):
@@ -9,7 +9,7 @@ def __init__(self, context, resource_path=None):
         super(SitePropertiesCollection, self).__init__(context, SiteProperties, resource_path)
 
     def get_by_id(self, site_id):
-        site_props = SiteProperties(self.context, None)
+        site_props = SiteProperties(self.context)
         qry = ServiceOperationQuery(self, "GetById", [site_id], None, None, site_props)
         self.context.add_query(qry)
         return site_props

office365/sharepoint/tenant/administration/__init__.py

@@ -1,12 +1,10 @@
 from office365.runtime.resource_path import ResourcePath
 from office365.runtime.queries.serviceOperationQuery import ServiceOperationQuery
 from office365.sharepoint.base_entity import BaseEntity
-from office365.sharepoint.tenantadministration.siteProperties import SiteProperties
-from office365.sharepoint.tenantadministration.sitePropertiesCollection import SitePropertiesCollection
-from office365.sharepoint.tenantadministration.sitePropertiesEnumerableFilter import SitePropertiesEnumerableFilter
-from office365.sharepoint.tenantadministration.spoOperation import SpoOperation
-from office365.sharepoint.tenantadministration.siteCreationProperties import SiteCreationProperties
-from office365.sharepoint.tenantadministration.secondaryAdministratorsFieldsData import SecondaryAdministratorsFieldsData
+from office365.sharepoint.tenant.administration.siteProperties import SiteProperties
+from office365.sharepoint.tenant.administration.sitePropertiesCollection import SitePropertiesCollection
+from office365.sharepoint.tenant.administration.sitePropertiesEnumerableFilter import SitePropertiesEnumerableFilter
+from office365.sharepoint.tenant.administration.spoOperation import SpoOperation
 
 
 class Tenant(BaseEntity):