Office365-REST-Python-Client 2.5.4__py3-none-any.whl → 2.5.6__py3-none-any.whl

office365/sharepoint/fields/field.py

@@ -69,7 +69,6 @@ class Field(Entity):
 
         :type context: office365.sharepoint.client_context.ClientContext
         :type field_parameters: office365.sharepoint.fields.creation_information.FieldCreationInformation
-        :return: Field
         """
         field_type = Field.resolve_field_type(field_parameters.FieldTypeKind)
         field = field_type(context)
@@ -124,19 +123,14 @@ class Field(Entity):
 
     @property
     def id(self):
-        """
-        Gets a value that specifies the field identifier.
-
-        :rtype: str or None
-        """
+        # type: () -> Optional[str]
+        """Gets a value that specifies the field identifier."""
         return self.properties.get("Id", None)
 
     @property
     def auto_indexed(self):
-        """
-        Gets a Boolean value that specifies whether the field is auto-indexed.
-        :rtype: str or None
-        """
+        # type: () -> Optional[bool]
+        """Gets a Boolean value that specifies whether the field is auto-indexed."""
         return self.properties.get("AutoIndexed", None)
 
     @property
@@ -200,17 +194,13 @@ class Field(Entity):
     @property
     def internal_name(self):
         # type: () -> Optional[str]
-        """
-        Gets a value that specifies the field internal name.
-        """
+        """Gets a value that specifies the field internal name."""
         return self.properties.get("InternalName", None)
 
     @property
     def can_be_deleted(self):
         # type: () -> Optional[bool]
-        """
-        Gets a value that specifies whether the field can be deleted
-        """
+        """Gets a value that specifies whether the field can be deleted"""
         return self.properties.get("CanBeDeleted", None)
 
     @property

office365/sharepoint/fields/lookup.py

@@ -1,3 +1,5 @@
+from typing import Optional
+
 from office365.sharepoint.fields.field import Field
 
 
@@ -6,38 +8,38 @@ class FieldLookup(Field):
 
     @property
     def allow_multiple_values(self):
-        """Gets a value that specifies whether the lookup field allows multiple values.
-        :rtype: bool or None
-        """
+        # type: () -> Optional[bool]
+        """Gets a value that specifies whether the lookup field allows multiple values."""
         return self.properties.get("AllowMultipleValues", None)
 
     @allow_multiple_values.setter
     def allow_multiple_values(self, value):
+        # type: (bool) -> None
         """Sets a value that specifies whether the lookup field allows multiple values."""
         self.set_property("AllowMultipleValues", value)
 
     @property
     def lookup_web_id(self):
-        """Gets the ID of the Web site that contains the list that is the source of this field's value.
-        :rtype: str or None
-        """
+        # type: () -> Optional[str]
+        """Gets the ID of the Web site that contains the list that is the source of this field's value."""
         return self.properties.get("LookupWebId", None)
 
     @lookup_web_id.setter
     def lookup_web_id(self, val):
-        """Sets the ID of the Web site that contains the list that is the source of this field's value.
-        :rtype: str or None
-        """
+        # type: (str) -> None
+        """Sets the ID of the Web site that contains the list that is the source of this field's value."""
         self.set_property("LookupWebId", val, True)
 
     @property
     def lookup_list(self):
+        # type: () -> Optional[str]
         """Gets value that specifies the list identifier of the list that contains the field to use as the lookup
         values."""
         return self.properties.get("LookupList", None)
 
     @lookup_list.setter
     def lookup_list(self, val):
+        # type: (str) -> None
         """Sets a value that specifies the list identifier of the list that contains the field to use as
         the lookup values."""
         self.set_property("LookupList", val, True)

office365/sharepoint/fields/multi_choice.py

@@ -1,32 +1,28 @@
+from typing import Optional
+
 from office365.runtime.types.collections import StringCollection
 from office365.sharepoint.fields.field import Field
 
 
 class FieldMultiChoice(Field):
-    """Specifies a field (2) that contains one or more values from a set of specified values."""
+    """Specifies a field that contains one or more values from a set of specified values."""
 
     @property
     def fill_in_choice(self):
+        # type: () -> Optional[bool]
         """
-        Specifies whether the field (2) can accept values other than those specified in
+        Specifies whether the field can accept values other than those specified in
         Microsoft.Sharepoint.Client.FieldMultiChoice.Choices, as specified in section 3.2.5.51.1.1.2.
-
-        :rtype: bool or None
         """
         return self.properties.get("FillInChoice", None)
 
     @property
     def mappings(self):
-        """
-        Specifies the internal values corresponding to Choices.
-
-        :rtype: str or None
-        """
+        # type: () -> Optional[str]
+        """Specifies the internal values corresponding to Choices."""
         return self.properties.get("Mappings", None)
 
     @property
     def choices(self):
-        """
-        Specifies values that are available for selection in the field
-        """
+        """Specifies values that are available for selection in the field"""
         return self.properties.get("Choices", StringCollection())

office365/sharepoint/fields/multi_line_text.py

@@ -1,3 +1,5 @@
+from typing import Optional
+
 from office365.sharepoint.fields.field import Field
 
 
@@ -8,30 +10,24 @@ class FieldMultiLineText(Field):
 
     @property
     def allow_hyperlink(self):
-        """
-        Gets a value that specifies whether a hyperlink is allowed as a value of the field.
-        :rtype: bool or None
-        """
+        # type: () -> Optional[bool]
+        """Gets a value that specifies whether a hyperlink is allowed as a value of the field."""
         return self.properties.get("AllowHyperlink", None)
 
     @allow_hyperlink.setter
     def allow_hyperlink(self, val):
-        """
-        Sets a value that specifies whether a hyperlink is allowed as a value of the field.
-        """
+        # type: (bool) -> None
+        """Sets a value that specifies whether a hyperlink is allowed as a value of the field."""
         self.set_property("AllowHyperlink", val)
 
     @property
     def number_of_lines(self):
-        """
-        Gets the number of lines to display in the field.
-        :return:
-        """
+        # type: () -> Optional[int]
+        """Gets the number of lines to display in the field."""
         return self.properties.get("NumberOfLines", None)
 
     @number_of_lines.setter
     def number_of_lines(self, val):
-        """
-        Set the number of lines to display in the field.
-        """
+        # type: (int) -> None
+        """Set the number of lines to display in the field."""
         self.set_property("NumberOfLines", val)

office365/sharepoint/fields/number.py

@@ -1,51 +1,38 @@
+from typing import Optional
+
 from office365.sharepoint.fields.field import Field
 
 
 class FieldNumber(Field):
-    """Specifies a field (2) that contains number values. To set properties, call the Update method
+    """Specifies a field that contains number values. To set properties, call the Update method
     (section 3.2.5.53.2.1.5)."""
 
     @property
     def display_format(self):
-        """
-        Gets the number of decimal places to be used when displaying the field.
-
-        :rtype: int or None
-        """
+        # type: () -> Optional[int]
+        """Gets the number of decimal places to be used when displaying the field."""
         return self.properties.get("DisplayFormat", None)
 
     @property
     def comma_separator(self):
-        """
-        Gets the separator used to format the value of the field.
-
-        :rtype: str or None
-        """
+        # type: () -> Optional[str]
+        """Gets the separator used to format the value of the field."""
         return self.properties.get("CommaSeparator", None)
 
     @comma_separator.setter
     def comma_separator(self, value):
-        """
-        Sets the separator used to format the value of the field.
-
-        :type value: str
-        """
+        # type: (str) -> None
+        """Sets the separator used to format the value of the field."""
         self.set_property("CommaSeparator", value)
 
     @property
     def show_as_percentage(self):
-        """
-        Gets a Boolean value that specifies whether to render the field as a percentage.
-
-        :rtype: int or None
-        """
+        # type: () -> Optional[bool]
+        """Gets a Boolean value that specifies whether to render the field as a percentage."""
         return self.properties.get("ShowAsPercentage", None)
 
     @show_as_percentage.setter
     def show_as_percentage(self, value):
-        """
-        Sets a Boolean value that specifies whether to render the field as a percentage.
-
-        :type value: str
-        """
+        # type: (bool) -> None
+        """Sets a Boolean value that specifies whether to render the field as a percentage."""
         self.set_property("ShowAsPercentage", value)

office365/sharepoint/fields/rating_scale.py

@@ -1,3 +1,5 @@
+from typing import Optional
+
 from office365.sharepoint.fields.multi_choice import FieldMultiChoice
 
 
@@ -7,11 +9,8 @@ class FieldRatingScale(FieldMultiChoice):
 
     @property
     def grid_start_number(self):
-        """
-        Gets the start number for the rating scale.
-
-        :rtype: int or None
-        """
+        # type: () -> Optional[int]
+        """Gets the start number for the rating scale."""
         return self.properties.get("GridStartNumber", None)
 
     @grid_start_number.setter
@@ -25,9 +24,6 @@ class FieldRatingScale(FieldMultiChoice):
 
     @property
     def range_count(self):
-        """
-        Specifies the number of options in the rating scale.
-
-        :rtype: int or None
-        """
+        # type: () -> Optional[int]
+        """Specifies the number of options in the rating scale."""
         return self.properties.get("RangeCount", None)

office365/sharepoint/fields/related_field.py

@@ -1,3 +1,5 @@
+from typing import Optional
+
 from office365.runtime.paths.resource_path import ResourcePath
 from office365.sharepoint.entity import Entity
 
@@ -7,35 +9,26 @@ class RelatedField(Entity):
 
     @property
     def field_id(self):
-        """
-        Gets the field id of the corresponding Lookup Field.
-        :rtype: str or None
-        """
+        # type: () -> Optional[str]
+        """Gets the field id of the corresponding Lookup Field."""
         return self.properties.get("FieldId", None)
 
     @property
     def list_id(self):
-        """
-        Gets the ID of the List containing the corresponding Lookup Field.
-        :rtype: str or None
-        """
+        # type: () -> Optional[str]
+        """Gets the ID of the List containing the corresponding Lookup Field."""
         return self.properties.get("ListId", None)
 
     @property
     def web_id(self):
-        """
-        Gets the ID of the Web containing the corresponding Lookup Field.
-        :rtype: str or None
-        """
+        # type: () -> Optional[str]
+        """Gets the ID of the Web containing the corresponding Lookup Field."""
         return self.properties.get("WebId", None)
 
     @property
     def relationship_delete_behavior(self):
-        """
-        Gets delete behavior of the corresponding Lookup Field.
-
-        :rtype: int or None
-        """
+        # type: () -> Optional[int]
+        """Gets delete behavior of the corresponding Lookup Field."""
         return self.properties.get("RelationshipDeleteBehavior", None)
 
     @property

office365/sharepoint/fields/url.py

@@ -1,3 +1,5 @@
+from typing import Optional
+
 from office365.sharepoint.fields.field import Field
 
 
@@ -6,9 +8,6 @@ class FieldUrl(Field):
 
     @property
     def display_format(self):
-        """
-        Gets the number of decimal places to be used when displaying the field.
-
-        :rtype: int or None
-        """
+        # type: () -> Optional[int]
+        """Gets the number of decimal places to be used when displaying the field."""
         return self.properties.get("DisplayFormat", None)

office365/sharepoint/fields/user.py

@@ -1,3 +1,5 @@
+from typing import Optional
+
 from office365.sharepoint.fields.lookup import FieldLookup
 
 
@@ -6,41 +8,40 @@ class FieldUser(FieldLookup):
 
     @property
     def presence(self):
-        """Gets a value that specifies whether presence is enabled on the field.
-
-        :rtype: bool or None
-        """
+        # type: () -> Optional[bool]
+        """Gets a value that specifies whether presence is enabled on the field."""
         return self.properties.get("Presence", None)
 
     @presence.setter
     def presence(self, val):
+        # type: (bool) -> None
         """Sets a value that specifies whether presence is enabled on the field."""
         self.properties.get("Presence", val)
 
     @property
     def allow_display(self):
-        """Gets a value that specifies whether to display the name of the user in a survey list.
-
-        :rtype: bool or None
-        """
+        # type: () -> Optional[bool]
+        """Gets a value that specifies whether to display the name of the user in a survey list."""
         return self.properties.get("AllowDisplay", None)
 
     @allow_display.setter
     def allow_display(self, val):
+        # type: (bool) -> None
         """Sets a value that specifies whether to display the name of the user in a survey list."""
         self.properties.get("AllowDisplay", val)
 
     @property
     def selection_group(self):
+        # type: () -> Optional[int]
         """
         Gets a value that specifies the identifier of the SharePoint group whose members can be selected
         as values of the field.
-        :rtype: int or None
         """
         return self.properties.get("SelectionGroup", None)
 
     @selection_group.setter
     def selection_group(self, val):
+        # type: (int) -> None
         """Sets a value that specifies the identifier of the SharePoint group whose members can be selected as
         values of the field.
         """

office365/sharepoint/files/checked_out_file.py

@@ -1,3 +1,5 @@
+from typing import Optional
+
 from office365.runtime.paths.resource_path import ResourcePath
 from office365.runtime.paths.v3.entity import EntityPath
 from office365.runtime.queries.service_operation import ServiceOperationQuery
@@ -16,9 +18,8 @@ class CheckedOutFile(Entity):
 
     @property
     def checked_out_by_id(self):
-        """Returns the user ID of the account used to check out the file.
-        :rtype: int or None
-        """
+        # type: () -> Optional[int]
+        """Returns the user ID of the account used to check out the file."""
         return self.properties.get("CheckedOutById", None)
 
     @property

office365/sharepoint/files/collection.py

@@ -45,7 +45,7 @@ class FileCollection(EntityCollection[File]):
     def upload_with_checksum(self, file_object, chunk_size=1024):
         # type: (IO, int) -> File
         """ """
-        h = hashlib.sha1()  # hashlib.md5()
+        h = hashlib.md5()
         file_name = os.path.basename(file_object.name)
         upload_id = str(uuid.uuid4())
 
@@ -53,9 +53,10 @@ class FileCollection(EntityCollection[File]):
             # type: (File) -> None
             content = file_object.read(chunk_size)
             h.update(content)
+
             return_type.upload_with_checksum(
                 upload_id, h.hexdigest(), content
-            ).after_execute(_upload_session)
+            )  # .after_execute(_upload_session)
 
         return self.add(file_name, None, True).after_execute(_upload_session)
 
@@ -80,37 +81,38 @@ class FileCollection(EntityCollection[File]):
         file_name = file_name if file_name else os.path.basename(file.name)
         upload_id = str(uuid.uuid4())
 
-        def _upload_session(return_type, return_file):
-            # type: (File|ClientResult, File) -> None
-            if return_file is None:
-                return_file = return_type
+        def _upload(return_type):
+            # type: (File) -> None
+
+            def _after_uploaded(result):
+                # type: (ClientResult) -> None
+                _upload(return_type)
 
             uploaded_bytes = file.tell()
             if callable(chunk_uploaded):
                 chunk_uploaded(uploaded_bytes, **kwargs)
 
+            content = file.read(chunk_size)
             if uploaded_bytes == file_size:
                 if auto_close and not file.closed:
                     file.close()
                 return
 
-            content = file.read(chunk_size)
-
             if uploaded_bytes == 0:
-                return_file.start_upload(upload_id, content).after_execute(
-                    _upload_session, return_file
+                return_type.start_upload(upload_id, content).after_execute(
+                    _after_uploaded
                 )
             elif uploaded_bytes + len(content) < file_size:
-                return_file.continue_upload(
+                return_type.continue_upload(
                     upload_id, uploaded_bytes, content
-                ).after_execute(_upload_session, return_file)
+                ).after_execute(_after_uploaded)
             else:
-                return_file.finish_upload(
+                return_type.finish_upload(
                     upload_id, uploaded_bytes, content
-                ).after_execute(_upload_session, return_file)
+                ).after_execute(_upload)
 
         if file_size > chunk_size:
-            return self.add(file_name, None, True).after_execute(_upload_session, None)
+            return self.add(file_name, None, True).after_execute(_upload)
         else:
             return self.add(file_name, file.read(), True)
 

office365/sharepoint/files/file.py

@@ -59,10 +59,7 @@ class File(AbstractFile):
     or a file in a folder."""
 
     def __repr__(self):
-        if self.server_relative_path:
-            return repr(self.server_relative_path)
-        else:
-            return self.serverRelativeUrl or self.unique_id or self.entity_type_name
+        return self.serverRelativeUrl or self.unique_id or self.entity_type_name
 
     def __str__(self):
         return self.name or self.entity_type_name
@@ -132,6 +129,19 @@ class File(AbstractFile):
         self.context.add_query(qry)
         return return_type
 
+    def get_pre_authorized_access_url(self, expiration_hours):
+        # type: (int) -> ClientResult[str]
+        """Returns a link for downloading the file without authentication.
+        :param int expiration_hours: The number of hours until the link expires. If the maximum expiration time
+        defined in the web application is less than the specified expiration time, the maximum expiration time
+        takes precedence.
+        """
+        return_type = ClientResult(self.context, str())
+        params = {"expirationHours": expiration_hours}
+        qry = FunctionQuery(self, "GetPreAuthorizedAccessUrl", params, return_type)
+        self.context.add_query(qry)
+        return return_type
+
     def get_absolute_url(self):
         # type: () -> ClientResult[str]
         """Gets absolute url of a File"""
@@ -332,19 +342,18 @@ class File(AbstractFile):
         :param int flag: Specifies the kind of move operation.
         """
 
-        def _update_file(return_type, new_file_url):
-            return_type.set_property("ServerRelativeUrl", new_file_url)
-
         def _moveto(destination_folder):
-            """
-            :type destination_folder: Folder
-            """
-            file_path = "/".join([str(destination_folder.serverRelativeUrl), self.name])
+            # type: (Folder) -> None
+            file_url = "/".join([str(destination_folder.serverRelativeUrl), self.name])
 
-            params = {"newurl": file_path, "flags": flag}
+            params = {"newurl": file_url, "flags": flag}
             qry = ServiceOperationQuery(self, "moveto", params)
             self.context.add_query(qry)
-            self.context.after_query_execute(_update_file, self, file_path)
+
+            def _update_file(return_type):
+                self.set_property("ServerRelativeUrl", file_url)
+
+            self.context.after_query_execute(_update_file)
 
         def _source_file_resolved():
             if isinstance(destination, Folder):
@@ -366,10 +375,6 @@ class File(AbstractFile):
         :param int flag: Specifies the kind of move operation.
         """
 
-        def _update_file(return_type, new_file_url):
-            # type: (File, str) -> None
-            return_type.set_property("ServerRelativePath", new_file_url)
-
         def _move_to_using_path(destination_folder):
             # type: (Folder) -> None
             file_path = "/".join(
@@ -377,9 +382,12 @@ class File(AbstractFile):
             )
             params = {"DecodedUrl": file_path, "moveOperations": flag}
             qry = ServiceOperationQuery(self, "MoveToUsingPath", params)
-            self.context.add_query(qry).after_query_execute(
-                _update_file, self, file_path
-            )
+
+            def _update_file(return_type):
+                # type: (File) -> None
+                self.set_property("ServerRelativePath", file_path)
+
+            self.context.add_query(qry).after_query_execute(_update_file)
 
         def _source_file_resolved():
             if isinstance(destination, Folder):
@@ -493,6 +501,7 @@ class File(AbstractFile):
         return return_type
 
     def upload_with_checksum(self, upload_id, checksum, stream):
+        # type: (str, str, bytes) -> File
         """
         :param str upload_id: The upload session ID.
         :param str checksum:
@@ -665,8 +674,6 @@ class File(AbstractFile):
                 request.stream = True
                 request.method = HttpMethod.Get
 
-            self.context.before_execute(_construct_request)
-
             def _process_response(response):
                 # type: (requests.Response) -> None
                 response.raise_for_status()
@@ -677,8 +684,9 @@ class File(AbstractFile):
                         chunk_downloaded(bytes_read)
                     file_object.write(chunk)
 
-            self.context.after_execute(_process_response)
-            self.context.add_query(qry)
+            self.context.add_query(qry).before_execute(
+                _construct_request
+            ).after_execute(_process_response)
 
         if use_path:
             self.ensure_property("ServerRelativePath", _download_as_stream)
@@ -925,9 +933,7 @@ class File(AbstractFile):
 
     @property
     def parent_folder(self):
-        """
-        :rtype: office365.sharepoint.folders.folder.Folder
-        """
+        # type: () -> Optional[Folder]
         if self.parent_collection is None:
             return None
         return self.parent_collection.parent