Implementation of execute_batch method, refactorings, preparation for 2.2.0 release

Author: [email protected]

README.md

@@ -53,7 +53,7 @@ ctx = ClientContext(site_url).with_credentials(UserCredential(username, password
 web = ctx.web
 ctx.load(web)
 ctx.execute_query()
-print "Web title: {0}".format(web.properties['Title'])
+print("Web title: {0}".format(web.properties['Title']))
 ```
 or alternatively via method chaining (a.k.a Fluent Interface): 
 
@@ -62,7 +62,7 @@ from office365.sharepoint.client_context import ClientContext
 
 ctx = ClientContext(site_url).with_credentials(UserCredential(username, password))
 web = ctx.web.load().execute_query()
-print "Web title: {0}".format(web.properties['Title'])
+print("Web title: {0}".format(web.properties['Title']))
 ```
 
 
@@ -77,7 +77,7 @@ from office365.runtime.http.request_options import RequestOptions
 from office365.sharepoint.client_context import ClientContext
 
 ctx = ClientContext(site_url).with_credentials(UserCredential(username, password))
-request = RequestOptions("{0}/_api/web/".format(settings['url']))
+request = RequestOptions("{0}/_api/web/".format(site_url))
 response = ctx.execute_request_direct(request)
 json = json.loads(response.content)
 web_title = json['d']['Title']

office365/runtime/odata/odata_batch_request.py

@@ -115,7 +115,7 @@ def _deserialize_response(self, raw_response):
         status_result = re.match(response_status_regex, lines[0])
         status_info = status_result.groups()
 
-        if status_info[1] == "No Content":
+        if status_info[1] == "No Content" or len(lines) < 3:
             headers_raw = lines[1:]
             return {
                 "status": status_info,

office365/sharepoint/contenttypes/content_type.py

@@ -2,7 +2,7 @@
 from office365.runtime.resource_path import ResourcePath
 from office365.runtime.resource_path_service_operation import ResourcePathServiceOperation
 from office365.sharepoint.base_entity import BaseEntity
-from office365.sharepoint.contenttypes.contentTypeId import ContentTypeId
+from office365.sharepoint.contenttypes.content_type_id import ContentTypeId
 from office365.sharepoint.fields.field_collection import FieldCollection
 
 

office365/sharepoint/contenttypes/contentTypeId.py renamed to office365/sharepoint/contenttypes/content_type_id.py

@@ -3,11 +3,11 @@
 
 class ContentTypeId(ClientValue):
 
-    def __init__(self, stringValue=None):
+    def __init__(self, string_value=None):
         """
         Represents the content type identifier (ID) of a content type.
 
-        :param str stringValue: Hexadecimal string value of content type identifier. String value MUST start with "0x".
+        :param str string_value: Hexadecimal string value of content type identifier. String value MUST start with "0x".
         """
         super().__init__("SP")
-        self.StringValue = stringValue
+        self.StringValue = string_value

office365/sharepoint/files/file_collection.py

@@ -18,7 +18,7 @@ def create_upload_session(self, source_path, chunk_size, chunk_uploaded=None):
         :param str source_path: path where file to upload resides
         :param int chunk_size: upload chunk size
         :param (long)->None or None chunk_uploaded: uploaded event
-        :return: office365.sharepoint.file.File
+        :return: office365.sharepoint.files.file.File
         """
         qry = UploadSessionQuery(self, source_path, chunk_size, chunk_uploaded)
         self.context.add_query(qry)
@@ -27,8 +27,8 @@ def create_upload_session(self, source_path, chunk_size, chunk_uploaded=None):
     def add(self, file_creation_information):
         """Creates a File resource
 
-        :type file_creation_information: office365.sharepoint.file_creation_information.FileCreationInformation
-        :return File
+        :type file_creation_information: office365.sharepoint.files.file_creation_information.FileCreationInformation
+        :rtype: office365.sharepoint.files.file.File
         """
         qry = CreateFileQuery(self, file_creation_information)
         self.context.add_query(qry)

office365/sharepoint/lists/list.py

@@ -148,16 +148,16 @@ def delete_object(self):
         self.remove_from_parent_collection()
 
     @property
-    def enableFolderCreation(self):
+    def enable_folder_creation(self):
         """
         Specifies whether new list folders can be added to the list.
 
         :rtype: bool or None
         """
         return self.properties.get("EnableFolderCreation", None)
 
-    @enableFolderCreation.setter
-    def enableFolderCreation(self, value):
+    @enable_folder_creation.setter
+    def enable_folder_creation(self, value):
         self.set_property("EnableFolderCreation", value, True)
 
     @property
@@ -217,7 +217,7 @@ def forms(self):
                                    FormCollection(self.context, ResourcePath("forms", self.resource_path)))
 
     @property
-    def itemCount(self):
+    def item_count(self):
         """Gets a value that specifies the number of list items in the list.
         :rtype: int or None
         """

office365/sharepoint/views/view.py

@@ -3,7 +3,7 @@
 from office365.runtime.resource_path import ResourcePath
 from office365.runtime.resource_path_service_operation import ResourcePathServiceOperation
 from office365.sharepoint.base_entity import BaseEntity
-from office365.sharepoint.contenttypes.contentTypeId import ContentTypeId
+from office365.sharepoint.contenttypes.content_type_id import ContentTypeId
 from office365.sharepoint.listitems.caml.camlQuery import CamlQuery
 from office365.sharepoint.views.view_field_collection import ViewFieldCollection
 

setup.py

@@ -10,7 +10,7 @@
 
 setup(
     name="Office365-REST-Python-Client",
-    version="2.1.10",
+    version="2.2.0",
     author="Vadim Gremyachev",
     author_email="[email protected]",
     maintainer="Konrad Gądek",

tests/sharepoint/test_sharepoint_client.py

@@ -72,8 +72,23 @@ def test7_get_and_update_batch_request(self):
         client.execute_query()
         self.assertEqual(updated_list_item.properties['Title'], new_title)
 
-    def test8_delete_batch_request(self):
+    def test8_create_and_delete_batch_request(self):
         pass
 
     def test9_get_and_delete_batch_request(self):
-        pass
+        file_name = "TestFile{0}.txt".format(random_seed)
+        client = ClientContext(settings['url']).with_credentials(user_credentials)
+        list_pages = client.web.lists.get_by_title("Documents")
+        files = list_pages.rootFolder.files
+        client.load(files)
+        client.execute_query()
+        files_count_before = len(files)
+        new_file = list_pages.rootFolder.upload_file(file_name, "-some content goes here-")
+        client.execute_query()
+        self.assertTrue(new_file.name, file_name)
+
+        new_file.delete_object()
+        files_after = list_pages.rootFolder.files
+        client.load(files_after)
+        client.execute_batch()
+        self.assertTrue(len(files_after), files_count_before)

tests/sharepoint/test_sharepoint_listItem.py

@@ -38,11 +38,11 @@ def test1_create_list_item(self):
 
     def test2_enable_folders_in_list(self):
         def _init_list():
-            if not self.target_list.enableFolderCreation:
-                self.target_list.enableFolderCreation = True
+            if not self.target_list.enable_folder_creation:
+                self.target_list.enable_folder_creation = True
                 self.target_list.update()
                 self.client.execute_query()
-            self.assertTrue(self.target_list.enableFolderCreation, "Folder creation enabled")
+            self.assertTrue(self.target_list.enable_folder_creation, "Folder creation enabled")
 
         self.target_list.ensure_property("EnableFolderCreation", _init_list)
         self.client.execute_query()