Improved support to handle large collections, type hints

Author: [email protected]

examples/sharepoint/read_large_list.py

@@ -2,29 +2,22 @@
 from office365.sharepoint.client_context import ClientContext
 from settings import settings
 
-ctx = ClientContext.connect_with_credentials("https://mediadev8.sharepoint.com/sites/team",
-                                             ClientCredential(settings['client_credentials']['client_id'],
-                                                              settings['client_credentials']['client_secret']))
-
 
-def get_all_list_items():
-    # 1st approach: get all list items
-    list_source = ctx.web.lists.get_by_title("Contacts_Large")
-    items = list_source.items
-    ctx.load(items)
-    ctx.execute_query()
-    return items
+def print_progress(items_read):
+    print("Items read: {0}".format(items_read))
 
 
-def get_list_items_paged():
-    list_source = ctx.web.lists.get_by_title("Contacts_Large")
-    items = list_source.get_items()
-    ctx.load(items)
-    ctx.execute_query()
-    return items
+ctx = ClientContext.connect_with_credentials("https://mediadev8.sharepoint.com/sites/team",
+                                             ClientCredential(settings['client_credentials']['client_id'],
+                                                              settings['client_credentials']['client_secret']))
 
+list_source = ctx.web.lists.get_by_title("Contacts_Large")
+items = list_source.items
+items.page_loaded += print_progress  # page load event
+items.page_size = 400  # specify custom page size (default is 100)
+ctx.load(items)
+ctx.execute_query()
 
-all_items = get_list_items_paged()
-print("Items count: {0}".format(len(all_items)))
-for idx, item in enumerate(all_items):
-    print("{0}: {1}".format(idx, item.properties['Title']))
+#print("Items count: {0}".format(len(items)))
+for item in items:
+    print("{0}".format(item.properties['Title']))

office365/graph/directory/directoryObject.py

@@ -1,5 +1,5 @@
 from office365.graph.entity import Entity
-from office365.runtime.client_query import DeleteEntityQuery
+from office365.runtime.client_query import DeleteEntityQuery, UpdateEntityQuery
 from office365.runtime.client_result import ClientResult
 from office365.runtime.serviceOperationQuery import ServiceOperationQuery
 
@@ -10,7 +10,9 @@ class DirectoryObject(Entity):
 
     def get_member_groups(self, security_enabled_only=True):
         """Return all the groups that the specified user, group, or directory object is a member of. This function is
-        transitive. """
+        transitive.
+
+        :type security_enabled_only: bool"""
         result = ClientResult(None)
         payload = {
             "securityEnabledOnly": security_enabled_only
@@ -19,6 +21,11 @@ def get_member_groups(self, security_enabled_only=True):
         self.context.add_query(qry)
         return result
 
+    def update(self):
+        """Updates the directory object."""
+        qry = UpdateEntityQuery(self)
+        self.context.add_query(qry)
+
     def delete_object(self):
         """Deletes the directory object."""
         qry = DeleteEntityQuery(self)

office365/graph/directory/group.py

@@ -16,6 +16,7 @@ class Group(DirectoryObject):
     def add_team(self):
         """Create a new team under a group."""
         team = Team(self.context)
+        team._parent_collection = self.parent_collection
         qry = ServiceOperationQuery(self, "team", None, team, None, team)
         self.context.add_query(qry)
         self.context.get_pending_request().beforeExecute += self._construct_create_team_request

office365/graph/directory/user.py

@@ -8,9 +8,29 @@
 from office365.runtime.serviceOperationQuery import ServiceOperationQuery
 
 
+def _delete_user_from_directory(target_user):
+    """
+    Deletes the user from directory
+
+    :type target_user: User
+    """
+    deleted_user = target_user.context.directory.deletedUsers[target_user.id]
+    deleted_user.delete_object()
+
+
 class User(DirectoryObject):
     """Represents an Azure AD user account. Inherits from directoryObject."""
 
+    def delete_object(self, permanent_delete=False):
+        """
+        :param permanent_delete: Permanently deletes the user from directory
+        :type permanent_delete: bool
+
+        """
+        super(User, self).delete_object()
+        if permanent_delete:
+            self.ensure_property("id", _delete_user_from_directory)
+
     @property
     def drive(self):
         """Retrieve the properties and relationships of a Drive resource."""

office365/graph/directory/userCollection.py

@@ -17,7 +17,10 @@ def __getitem__(self, key):
         return User(self.context, ResourcePath(key, self.resource_path))
 
     def add(self, user_properties):
-        """Create a new user."""
+        """Create a new user.
+
+        :type user_properties: UserCreationProperties
+        """
         usr = User(self.context)
         qry = CreateEntityQuery(self, user_properties, usr)
         self.context.add_query(qry)

office365/graph/directory/userCreationProperties.py

@@ -0,0 +1,20 @@
+from office365.graph.directory.passwordProfile import PasswordProfile
+from office365.runtime.client_value_object import ClientValueObject
+
+
+class UserProfile(ClientValueObject):
+    def __init__(self, principal_name, password, display_name=None, account_enabled=False):
+        """
+        User profile
+
+        :type principal_name: str
+        :type password: str
+        :type display_name: str
+        :type account_enabled: bool
+        """
+        super(UserProfile, self).__init__()
+        self.userPrincipalName = principal_name
+        self.passwordProfile = PasswordProfile(password)
+        self.mailNickname = principal_name.split("@")[0]
+        self.displayName = display_name or principal_name.split("@")[0]
+        self.accountEnabled = account_enabled

office365/graph/directory/userProfile.py

@@ -9,6 +9,14 @@ class Drive(BaseItem):
     """The drive resource is the top level object representing a user's OneDrive or a document library in
     SharePoint. """
 
+    @property
+    def sharedWithMe(self):
+        """Retrieve a collection of DriveItem resources that have been shared with the owner of the Drive."""
+        if self.is_property_available("sharedWithMe"):
+            return self.properties['sharedWithMe']
+        else:
+            return DriveItemCollection(self.context, ResourcePath("sharedWithMe", self.resource_path))
+
     @property
     def root(self):
         """The root folder of the drive."""

office365/graph/onedrive/drive.py

@@ -0,0 +1,6 @@
+from office365.runtime.client_value_object import ClientValueObject
+
+
+class Photo(ClientValueObject):
+    """The photo resource provides photo and camera properties, for example, EXIF metadata, on a driveItem."""
+    pass

office365/graph/onedrive/photo.py

@@ -0,0 +1,6 @@
+from office365.runtime.client_value_object import ClientValueObject
+
+
+class Video(ClientValueObject):
+    """The Video resource groups video-related data items into a single structure."""
+    pass

office365/graph/onedrive/video.py

@@ -1,7 +1,7 @@
-from office365.runtime.client_object import ClientObject
+from office365.graph.entity import Entity
 
 
-class Channel(ClientObject):
+class Channel(Entity):
     """Teams are made up of channels, which are the conversations you have with your teammates"""
 
     @property

office365/graph/teams/channel.py

@@ -0,0 +1,5 @@
+from office365.graph.entity import Entity
+
+
+class ChatMessage(Entity):
+    pass

office365/graph/teams/chatMessage.py

@@ -1,4 +1,4 @@
-from office365.runtime.client_object import ClientObject
+from office365.graph.entity import Entity
 from office365.runtime.client_query import UpdateEntityQuery
 from office365.runtime.resource_path import ResourcePath
 from office365.runtime.serviceOperationQuery import ServiceOperationQuery
@@ -10,7 +10,7 @@
 from office365.graph.teams.teamMessagingSettings import TeamMessagingSettings
 
 
-class Team(ClientObject):
+class Team(Entity):
     """A team in Microsoft Teams is a collection of channel objects. A channel represents a topic, and therefore a
     logical isolation of discussion, within a team. """
 
@@ -24,12 +24,18 @@ def __init__(self, context, resource_path=None):
     @property
     def channels(self):
         """The collection of channels & messages associated with the team."""
-        return ChannelCollection(self, ResourcePath("channels"))
+        if self.is_property_available("channels"):
+            return self.properties['channels']
+        else:
+            return ChannelCollection(self.context, ResourcePath("channels", self.resource_path))
 
     @property
     def primaryChannel(self):
         """The general channel for the team."""
-        return Channel(self, ResourcePath("primaryChannel"))
+        if self.is_property_available("primaryChannel"):
+            return self.properties['primaryChannel']
+        else:
+            return Channel(self.context, ResourcePath("primaryChannel"))
 
     def update(self):
         """Updates team."""

office365/graph/teams/team.py

@@ -5,5 +5,6 @@ class TeamFunSettings(ClientValueObject):
     """Settings to configure use of Giphy, memes, and stickers in the team."""
 
     def __init__(self):
+        super().__init__()
         self.allowGiphy = True
 

office365/graph/teams/teamFunSettings.py

@@ -4,4 +4,4 @@
 class TeamGuestSettings(ClientValueObject):
 
     def __init__(self):
-        pass
+        super().__init__()

office365/graph/teams/teamGuestSettings.py

@@ -6,6 +6,7 @@ class TeamMemberSettings(ClientValueObject):
     in the team. """
 
     def __init__(self):
+        super().__init__()
         self.allowCreateUpdateChannels = True
         self.allowDeleteChannels = True
         self.allowAddRemoveApps = True

office365/graph/teams/teamMemberSettings.py

@@ -4,4 +4,5 @@
 class TeamMessagingSettings(ClientValueObject):
 
     def __init__(self):
+        super().__init__()
         self.allowUserEditMessages = True

office365/graph/teams/teamMessagingSettings.py

@@ -0,0 +1,5 @@
+from office365.graph.entity import Entity
+
+
+class TeamsAsyncOperation(Entity):
+    pass

office365/graph/teams/teamsAsyncOperation.py

@@ -0,0 +1,9 @@
+from office365.graph.teams.teamsAsyncOperation import TeamsAsyncOperation
+from office365.runtime.client_object_collection import ClientObjectCollection
+
+
+class TeamsAsyncOperationCollection(ClientObjectCollection):
+    """TeamsAsyncOperation's collection"""
+
+    def __init__(self, context, resource_path=None):
+        super(TeamsAsyncOperationCollection, self).__init__(context, TeamsAsyncOperation, resource_path)

office365/graph/teams/teamsAsyncOperationCollection.py

@@ -0,0 +1,4 @@
+class TeamsAsyncOperationStatus:
+
+    def __init__(self):
+        pass

office365/graph/teams/teamsAsyncOperationStatus.py

@@ -6,6 +6,13 @@ class ClientObject(object):
     """Base client object"""
 
     def __init__(self, context, resource_path=None, properties=None, parent_collection=None):
+        """
+
+        :type parent_collection: office365.runtime.client_object_collection.ClientObjectCollection
+        :type properties: dict
+        :type resource_path: office365.runtime.resource_path.ResourcePath
+        :type context: office365.runtime.client_runtime_context.ClientRuntimeContext
+        """
         self._properties = {}
         self._changes = []
         self._entity_type_name = None
@@ -55,12 +62,18 @@ def set_property(self, name, value, persist_changes=True):
     def to_json(self):
         return dict((k, v) for k, v in self.properties.items() if k in self._changes)
 
-    def ensure_property(self, name, loaded):
+    def ensure_property(self, name, action):
+        """
+        Ensures property is loaded
+
+        :type action: any
+        :type name: str
+        """
         if not self.is_property_available(name):
             self.context.load(self, [name])
-            self.context.afterExecuteOnce += loaded
+            self.context.afterExecuteOnce += action
         else:
-            loaded(self)
+            action(self)
 
     @property
     def entity_type_name(self):