AttachmentCollection.download method introduced, model updates

Author: vgrem

.github/workflows/python-app.yml

@@ -67,10 +67,3 @@ jobs:
         run: |
           echo "${{env.office365_python_sdk_securevars}}"
           pytest
-
-# - name: Lint with flake8
-#   run: |
-#     # stop the build if there are Python syntax errors or undefined names
-#     flake8 office365 --count --select=E9,F63,F7,F82 --show-source --statistics
-#     # exit-zero treats all errors as warnings. The GitHub editor is 127 chars wide
-#     flake8 office365 --count --exit-zero --max-complexity=10 --max-line-length=127 --statistics

examples/sharepoint/listitems/attachments/download.py

@@ -1,31 +1,28 @@
+"""
+Demonstrates how to download list item attachments
+"""
 import os
 import tempfile
 
+from office365.sharepoint.attachments.attachment import Attachment
 from office365.sharepoint.client_context import ClientContext
 from tests import test_client_credentials, test_team_site_url
 
-ctx = ClientContext(test_team_site_url).with_credentials(test_client_credentials)
 
-download_path = tempfile.mkdtemp()
+def print_progress(attachment_file):
+    # type: (Attachment) -> None
+    print(
+        "{0} has been downloaded".format(attachment_file.server_relative_url)
+    )
+
+
+ctx = ClientContext(test_team_site_url).with_credentials(test_client_credentials)
 
 list_title = "Company Tasks"
 source_list = ctx.web.lists.get_by_title(list_title)
-items = source_list.items
-ctx.load(items, ["ID", "UniqueId", "FileRef", "LinkFilename", "Title", "Attachments"])
-ctx.execute_query()
+items = source_list.items.get().execute_query()
 for item in items:
-    if item.properties[
-        "Attachments"
-    ]:  # 1. determine whether ListItem contains attachments
-        # 2. Explicitly load attachments for ListItem
-        attachment_files = item.attachment_files.get().execute_query()
-        # 3. Enumerate and save attachments
-        for attachment_file in attachment_files:
-            download_file_name = os.path.join(
-                download_path, os.path.basename(attachment_file.file_name)
-            )
-            with open(download_file_name, "wb") as fh:
-                attachment_file.download(fh).execute_query()
-            print(
-                f"{attachment_file.server_relative_url} has been downloaded into {download_file_name}"
-            )
+    zip_path = os.path.join(tempfile.mkdtemp(), "attachments_{0}.zip".format(item.id))
+    with open(zip_path, "wb") as f:
+        item.attachment_files.download(f, print_progress).execute_query()
+    print("{0} attachments has been downloaded...".format(zip_path))

examples/sharepoint/listitems/attachments/download_per_attachment.py

@@ -0,0 +1,27 @@
+"""
+Demonstrates how to download list item attachments
+"""
+import os
+import tempfile
+
+from office365.sharepoint.client_context import ClientContext
+from tests import test_client_credentials, test_team_site_url
+
+download_path = tempfile.mkdtemp()
+list_title = "Company Tasks"
+
+ctx = ClientContext(test_team_site_url).with_credentials(test_client_credentials)
+source_list = ctx.web.lists.get_by_title(list_title)
+items = source_list.items.get().execute_query()
+for item in items:
+    attachment_files = item.attachment_files.get().execute_query()
+    for attachment_file in attachment_files:
+        download_file_name = os.path.join(
+            download_path, os.path.basename(attachment_file.file_name)
+        )
+        with open(download_file_name, "wb") as fh:
+            attachment_file.download(fh).execute_query()
+        print(
+            f"{attachment_file.server_relative_url} has been downloaded into {download_file_name}"
+        )
+

office365/directory/identitygovernance/appconsent/request.py

@@ -1,7 +1,13 @@
+from typing import Optional
+
+from office365.directory.identitygovernance.appconsent.request_scope import (
+    AppConsentRequestScope,
+)
 from office365.directory.identitygovernance.userconsent.request_collection import (
     UserConsentRequestCollection,
 )
 from office365.entity import Entity
+from office365.runtime.client_value_collection import ClientValueCollection
 from office365.runtime.paths.resource_path import ResourcePath
 
 
@@ -15,6 +21,32 @@ class AppConsentRequest(Entity):
     the admin consent workflow is enabled.
     """
 
+    def __str__(self):
+        return self.app_display_name or self.entity_type_name
+
+    def __repr__(self):
+        return self.app_id or self.entity_type_name
+
+    @property
+    def app_display_name(self):
+        # type: () -> Optional[str]
+        """Display name of the application object on which this extension property is defined. Read-only"""
+        return self.properties.get("appDisplayName", None)
+
+    @property
+    def app_id(self):
+        # type: () -> Optional[str]
+        """The identifier of the application"""
+        return self.properties.get("appId", None)
+
+    @property
+    def pending_scopes(self):
+        # type: () -> ClientValueCollection[AppConsentRequestScope]
+        """A list of pending scopes waiting for approval. Required."""
+        return self.properties.get(
+            "pendingScopes", ClientValueCollection(AppConsentRequestScope)
+        )
+
     @property
     def user_consent_requests(self):
         """A list of pending user consent requests."""

office365/directory/identitygovernance/appconsent/request_scope.py

@@ -0,0 +1,5 @@
+from office365.runtime.client_value import ClientValue
+
+
+class AppConsentRequestScope(ClientValue):
+    """The appConsentRequestScope details the dynamic permission scopes for which access is being requested."""

office365/directory/identitygovernance/privilegedaccess/group.py

@@ -0,0 +1,5 @@
+from office365.entity import Entity
+
+
+class PrivilegedAccessGroup(Entity):
+    """The entry point for all resources related to Privileged Identity Management (PIM) for groups."""

office365/directory/identitygovernance/privilegedaccess/root.py

@@ -1,5 +1,19 @@
+from office365.directory.identitygovernance.privilegedaccess.group import (
+    PrivilegedAccessGroup,
+)
 from office365.entity import Entity
+from office365.runtime.paths.resource_path import ResourcePath
 
 
 class PrivilegedAccessRoot(Entity):
     """Represents the entry point for resources related to Privileged Identity Management (PIM)."""
+
+    @property
+    def group(self):
+        """A list of pending user consent requests."""
+        return self.properties.get(
+            "group",
+            PrivilegedAccessGroup(
+                self.context, ResourcePath("group", self.resource_path)
+            ),
+        )

office365/directory/identitygovernance/privilegedaccess/schedule_instance.py

@@ -0,0 +1,6 @@
+from office365.entity import Entity
+
+
+class PrivilegedAccessScheduleInstance(Entity):
+    """An abstract type that exposes properties relating to the instances of membership and ownership assignments
+    and eligibilities to groups that are governed by PIM"""

office365/directory/policies/admin_consent_request.py

@@ -0,0 +1,10 @@
+from office365.entity import Entity
+
+
+class AdminConsentRequestPolicy(Entity):
+    """
+    Represents the policy for enabling or disabling the Microsoft Entra admin consent workflow.
+    The admin consent workflow allows users to request access for apps that they wish to use and that require admin
+    authorization before users can use the apps to access organizational data.
+    There is a single adminConsentRequestPolicy per tenant.
+    """

office365/directory/policies/root.py

@@ -1,3 +1,4 @@
+from office365.directory.policies.admin_consent_request import AdminConsentRequestPolicy
 from office365.directory.policies.app_management import AppManagementPolicy
 from office365.directory.policies.authentication_flows import AuthenticationFlowsPolicy
 from office365.directory.policies.authentication_methods import (
@@ -20,6 +21,19 @@
 class PolicyRoot(Entity):
     """Resource type exposing navigation properties for the policies singleton."""
 
+    @property
+    def admin_consent_request_policy(self):
+        """
+        The policy by which consent requests are created and managed for the entire tenant.
+        """
+        return self.properties.get(
+            "adminConsentRequestPolicy",
+            AdminConsentRequestPolicy(
+                self.context,
+                ResourcePath("adminConsentRequestPolicy", self.resource_path),
+            ),
+        )
+
     @property
     def authentication_methods_policy(self):
         """
@@ -151,6 +165,7 @@ def conditional_access_policies(self):
     def get_property(self, name, default_value=None):
         if default_value is None:
             property_mapping = {
+                "adminConsentRequestPolicy": self.admin_consent_request_policy,
                 "authenticationStrengthPolicies": self.authentication_strength_policies,
                 "authenticationFlowsPolicy": self.authentication_flows_policy,
                 "appManagementPolicies": self.app_management_policies,

office365/directory/synchronization/status.py

@@ -1,17 +1,23 @@
 from office365.directory.synchronization.progress import SynchronizationProgress
 from office365.directory.synchronization.quarantine import SynchronizationQuarantine
-from office365.directory.synchronization.task_execution import SynchronizationTaskExecution
+from office365.directory.synchronization.task_execution import (
+    SynchronizationTaskExecution,
+)
 from office365.runtime.client_value import ClientValue
 from office365.runtime.client_value_collection import ClientValueCollection
 
 
 class SynchronizationStatus(ClientValue):
     """Represents the current status of the synchronizationJob."""
 
-    def __init__(self, progress=None, quarantine=SynchronizationQuarantine(),
-                 last_execution=SynchronizationTaskExecution(),
-                 last_successful_execution=SynchronizationTaskExecution(),
-                 last_successful_execution_with_exports=SynchronizationTaskExecution()):
+    def __init__(
+        self,
+        progress=None,
+        quarantine=SynchronizationQuarantine(),
+        last_execution=SynchronizationTaskExecution(),
+        last_successful_execution=SynchronizationTaskExecution(),
+        last_successful_execution_with_exports=SynchronizationTaskExecution(),
+    ):
         """
         :param list[SynchronizationProgress] progress: Details of the progress of a job toward completion.
         :param SynchronizationQuarantine quarantine:

office365/graph_client.py

@@ -127,7 +127,7 @@ def with_certificate(
                 "thumbprint": thumbprint,
                 "private_key": private_key,
             },
-            token_cache=token_cache  # Default cache is in memory only.
+            token_cache=token_cache,  # Default cache is in memory only.
             # You can learn how to use SerializableTokenCache from
             # https://msal-python.readthedocs.io/en/latest/#msal.SerializableTokenCache
         )

office365/onedrive/driveitems/driveItem.py

@@ -618,9 +618,9 @@ def invite(
                 DriveRecipient, [DriveRecipient.from_email(r) for r in recipients]
             ),
             "message": message,
-            "expirationDateTime": expiration_datetime.isoformat() + "Z"
-            if expiration_datetime
-            else None,
+            "expirationDateTime": (
+                expiration_datetime.isoformat() + "Z" if expiration_datetime else None
+            ),
             "password": password,
             "retainInheritedPermissions": retain_inherited_permissions,
         }

office365/runtime/auth/providers/saml_token_provider.py

@@ -281,9 +281,9 @@ def _get_authentication_cookie(self, security_token, federated=False):
         if not federated or self._browser_mode:
             headers = {"Content-Type": "application/x-www-form-urlencoded"}
             if self._browser_mode:
-                headers[
-                    "User-Agent"
-                ] = "Mozilla/5.0 (compatible; MSIE 9.0; Windows NT 6.1; WOW64; Trident/5.0)"
+                headers["User-Agent"] = (
+                    "Mozilla/5.0 (compatible; MSIE 9.0; Windows NT 6.1; WOW64; Trident/5.0)"
+                )
             session.post(
                 self._sts_profile.signin_page_url, data=security_token, headers=headers
             )

office365/sharepoint/attachments/attachment.py

@@ -1,6 +1,7 @@
 from typing import AnyStr, Optional
 
 from office365.runtime.client_result import ClientResult
+from office365.runtime.queries.function import FunctionQuery
 from office365.runtime.queries.service_operation import ServiceOperationQuery
 from office365.sharepoint.entity import Entity
 from office365.sharepoint.internal.queries.upload_file import create_upload_file_query
@@ -42,6 +43,14 @@ def _download_file_by_url():
             self.ensure_property("ServerRelativeUrl", _download_file_by_url)
         return self
 
+    def get_content(self):
+        # type: () -> ClientResult[AnyStr]
+        """Gets the raw contents of attachment"""
+        return_type = ClientResult(self.context)
+        qry = FunctionQuery(self, "$value", None, return_type)
+        self.context.add_query(qry)
+        return return_type
+
     def recycle_object(self):
         """Move this attachment to site recycle bin."""
         qry = ServiceOperationQuery(self, "RecycleObject")

office365/sharepoint/attachments/collection.py

@@ -1,6 +1,10 @@
 import os
-from typing import IO, AnyStr
+from functools import partial
+from typing import IO, AnyStr, Optional, Callable
 
+from typing_extensions import Self
+
+from office365.runtime.client_result import ClientResult
 from office365.runtime.paths.service_operation import ServiceOperationPath
 from office365.runtime.queries.service_operation import ServiceOperationQuery
 from office365.sharepoint.attachments.attachment import Attachment
@@ -74,6 +78,27 @@ def _delete_all(return_type):
         self.get().after_execute(_delete_all)
         return self
 
+    def download(self, download_file, file_downloaded=None):
+        # type: (IO, Optional[Callable[[], None]]) -> Self
+        """Downloads attachments as a zip file"""
+        import zipfile
+
+        def _file_downloaded(attachment_file, result):
+            # type: (Attachment, ClientResult[AnyStr]) -> None
+            with zipfile.ZipFile(download_file.name, "a", zipfile.ZIP_DEFLATED) as zf:
+                zf.writestr(attachment_file.file_name, result.value)
+                if callable(file_downloaded):
+                    file_downloaded(attachment_file)
+
+        def _download(return_type):
+            for attachment_file in return_type:
+                attachment_file.get_content().after_execute(
+                    partial(_file_downloaded, attachment_file)
+                )
+
+        self.get().after_execute(_download)
+        return self
+
     def upload(self, file, use_path=True):
         # type: (IO, bool) -> Attachment
         """

office365/sharepoint/request.py

@@ -30,13 +30,10 @@ def with_credentials(self, credentials, environment="commercial"):
         :param str environment: The Office 365 Cloud Environment endpoint used for authentication
             defaults to 'commercial'.
         """
-        self._auth_context.with_credentials(
-            credentials, environment=environment
-        )
+        self._auth_context.with_credentials(credentials, environment=environment)
         return self
 
     def _authenticate_request(self, request):
         # type: (RequestOptions) -> None
         """Authenticate request"""
         self._auth_context.authenticate_request(request)
-

office365/sharepoint/sharing/permission_collection.py

@@ -29,7 +29,9 @@ def __init__(
             only if the caller is an Auditor.
         :param int total_number_of_principals:
         """
-        self.appConsentPrincipals = ClientValueCollection(PrincipalInfo, app_consent_principals)
+        self.appConsentPrincipals = ClientValueCollection(
+            PrincipalInfo, app_consent_principals
+        )
         self.hasInheritedLinks = has_inherited_links
         self.links = ClientValueCollection(LinkInfo, links)
         self.principals = ClientValueCollection(PrincipalInfo, principals)