runtime query enhancements

Author: vgrem

examples/sharepoint/files/exists.py

@@ -18,7 +18,7 @@ def try_get_file(web, url):
 
 
 ctx = ClientContext(test_team_site_url).with_credentials(test_client_credentials)
-file_url = '/sites/team/Shared Documents/big_buck_bunny111.mp4'
+file_url = 'Shared Documents/Financial Sample.xlsx'
 file = try_get_file(ctx.web, file_url)
 if file is None:
     print("File not found")

examples/sharepoint/files/get_permissions.py

@@ -1,12 +1,14 @@
+"""
+Retrieves the permissions on the file that are assigned to the current user.
+"""
 from pprint import pprint
 
 from office365.sharepoint.client_context import ClientContext
-from office365.sharepoint.listitems.listitem import ListItem
 from tests import test_team_site_url, test_client_credentials
 
 ctx = ClientContext(test_team_site_url).with_credentials(test_client_credentials)
-file_url = '/sites/team/Shared Documents/big_buck_bunny.mp4'
+file_url = 'Shared Documents/big_buck_bunny.mp4'
 file = ctx.web.get_file_by_server_relative_url(file_url)
-file_item = file.listItemAllFields.select(["EffectiveBasePermissions"]).get().execute_query()  # type: ListItem
-print(file_item.effective_base_permissions.permission_levels)
+file_item = file.listItemAllFields.select(["EffectiveBasePermissions"]).get().execute_query()
+pprint(file_item.effective_base_permissions.permission_levels)
 

examples/sharepoint/files/get_version.py

@@ -1,7 +1,13 @@
+"""
+Retrieves versions of the file
+"""
+
 from office365.sharepoint.client_context import ClientContext
+from office365.sharepoint.files.versions.version import FileVersion
 from tests import test_team_site_url, test_client_credentials
 
 ctx = ClientContext(test_team_site_url).with_credentials(test_client_credentials)
-file_url = "/sites/team/Shared Documents/SharePoint User Guide.docx"
-version = ctx.web.get_file_by_server_relative_path(file_url).versions.get_by_id(1).expand(["CreatedBy"]).get().execute_query()
-print(version.created_by.login_name)
+file_url = "Shared Documents/SharePoint User Guide.docx"
+versions = ctx.web.get_file_by_server_relative_path(file_url).versions.expand(["CreatedBy"]).get().execute_query()
+for version in versions:  # type: FileVersion
+    print(version.created_by.login_name)

examples/sharepoint/files/upload.py

@@ -1,5 +1,5 @@
 """
-Demonstrates how to upload 'small' files (up to 4MB in size)
+Demonstrates how to upload a small files (up to 4MB in size)
 """
 
 from office365.sharepoint.client_context import ClientContext
@@ -9,7 +9,7 @@
 
 list_title = "Documents"
 folder = ctx.web.lists.get_by_title(list_title).root_folder
-path = "../../data/report #123.csv"
+path = "../../data/SharePoint User Guide.docx"
 with open(path, 'rb') as f:
     file = folder.files.upload(f).execute_query()
 print("File has been uploaded into: {0}".format(file.serverRelativeUrl))

examples/sharepoint/sites/create_comm_site.py

@@ -8,3 +8,6 @@
 title = "Communication Site"
 site = ctx.create_communication_site(alias, title).execute_query()
 print(site.url)
+
+print("Cleaning up resources...")
+site.delete_object().execute_query()

examples/sharepoint/sites/create_comm_site_with_owner.py

@@ -1,3 +1,6 @@
+"""
+Creates a modern site
+"""
 import uuid
 
 from office365.sharepoint.client_context import ClientContext
@@ -8,3 +11,6 @@
 site_alias = "commsite_{0}".format(uuid.uuid4().hex)
 site = client.create_modern_site("Comm Site", site_alias, owner).execute_query()
 print("Site has been created at url: {0}".format(site.url))
+
+print("Cleaning up resources...")
+site.delete_object().execute_query()

examples/sharepoint/sites/create_team_site.py

@@ -1,9 +1,11 @@
-from random import randint
+"""
+Creates Team site
+"""
 
 from office365.sharepoint.client_context import ClientContext
-from tests import test_site_url, test_user_credentials
+from tests import test_site_url, test_user_credentials, create_unique_name
 
-alias = str(randint(0, 10000))
+alias = create_unique_name("teamsite")
 title = "Team Site"
 ctx = ClientContext(test_site_url).with_credentials(test_user_credentials)
 

office365/runtime/odata/request.py

@@ -32,10 +32,11 @@ def default_json_format(self):
 
     def build_request(self, query):
         """
+        Builds a request
+
         :type query: office365.runtime.queries.client_query.ClientQuery
         """
         request = RequestOptions(query.url)
-        # set method
         request.method = HttpMethod.Get
         if isinstance(query, DeleteEntityQuery):
             request.method = HttpMethod.Post
@@ -64,7 +65,7 @@ def process_response(self, response, query):
         else:
             if isinstance(json_format, JsonLightFormat):
                 if isinstance(query, ServiceOperationQuery) or isinstance(query, FunctionQuery):
-                    json_format.function = query.method_name
+                    json_format.function = query.name
 
             self.map_json(response.json(), return_type, json_format)
 

office365/runtime/queries/client_query.py

@@ -36,6 +36,13 @@ def url(self):
         else:
             return self.context.service_root_url()
 
+    @property
+    def path(self):
+        if self.binding_type is not None:
+            return self.binding_type.resource_path
+        else:
+            return None
+
     @property
     def context(self):
         return self._context

office365/runtime/queries/function.py

@@ -1,4 +1,4 @@
-from office365.runtime.odata.path_builder import ODataPathBuilder
+from office365.runtime.paths.service_operation import ServiceOperationPath
 from office365.runtime.queries.client_query import ClientQuery
 
 
@@ -23,11 +23,15 @@ def __init__(self, binding_type,
         self._method_name = method_name
         self._method_params = method_params
 
+    @property
+    def path(self):
+        return ServiceOperationPath(self._method_name, self._method_params, self.binding_type.resource_path)
+
     @property
     def url(self):
         orig_url = super(FunctionQuery, self).url
-        return "/".join([orig_url, ODataPathBuilder.build(self._method_name, self._method_params)])
+        return "/".join([orig_url, self.path.segment])
 
     @property
-    def method_name(self):
+    def name(self):
         return self._method_name