#645: fix for addressing file/folder by path

Author: vgrem

examples/sharepoint/folders/get_by_path.py

@@ -3,5 +3,5 @@
 
 ctx = ClientContext(test_team_site_url).with_credentials(test_client_credentials)
 folder = ctx.web.folders.get_by_path('Shared Documents')
-ctx.load(folder, ["Folders"]).execute_query()
+ctx.load(folder, ["ServerRelativeUrl", "Folders"]).execute_query()
 print(folder.serverRelativeUrl)

examples/sharepoint/webs/get_from_abs_url.py

@@ -0,0 +1,11 @@
+"""
+Resolves web from absolute resource (e.g. page) url
+"""
+
+from office365.sharepoint.client_context import ClientContext
+from tests import test_team_site_url, test_user_credentials
+
+page_abs_url = "{site_url}/SitePages/Home.aspx".format(site_url=test_team_site_url)
+ctx = ClientContext.from_url(page_abs_url).with_credentials(test_user_credentials)
+web = ctx.web.get().execute_query()
+print(web.url)

office365/runtime/odata/path_builder.py

@@ -22,45 +22,3 @@ def parse(path_str):
         for segment in segments:
             path = ResourcePath(segment, path)
         return path
-
-    @staticmethod
-    def build(name, parameters=None):
-        """
-        Constructs path segment from operation name and parameters
-
-        :type parameters: list or dict or ClientValue
-        :type name: str
-        """
-        url = name or ""
-        if isinstance(parameters, ClientValue):
-            url += "(@v)?@v={0}".format(json.dumps(parameters.to_json()))
-        elif parameters is not None:
-            url += "("
-            if isinstance(parameters, dict):
-                url += ','.join(['%s=%s' % (key, ODataPathBuilder.encode_method_value(value)) for (key, value) in
-                                 parameters.items() if value is not None])
-            else:
-                url += ','.join(['%s' % (ODataPathBuilder.encode_method_value(value)) for (i, value) in
-                                 enumerate(parameters) if value is not None])
-            url += ")"
-        return url
-
-    @staticmethod
-    def encode_method_value(value):
-        if is_string_type(value):
-            value = value.replace("'", "''")
-
-            # Same replacements as SQL Server
-            # https://web.archive.org/web/20150101222238/http://msdn.microsoft.com/en-us/library/aa226544(SQL.80).aspx
-            # https://stackoverflow.com/questions/4229054/how-are-special-characters-handled-in-an-odata-query#answer-45883747
-            value = value.replace('%', '%25')
-            value = value.replace('+', '%2B')
-            value = value.replace('/', '%2F')
-            value = value.replace('?', '%3F')
-            value = value.replace('#', '%23')
-            value = value.replace('&', '%26')
-
-            value = "'{0}'".format(value)
-        elif isinstance(value, bool):
-            value = str(value).lower()
-        return value

office365/runtime/odata/url_builder.py

@@ -0,0 +1,48 @@
+import json
+
+from office365.runtime.client_value import ClientValue
+from office365.runtime.compat import is_string_type
+
+
+class ODataUrlBuilder(object):
+
+    @staticmethod
+    def build_segment(path):
+        """
+        Constructs url for path segment
+
+        :type path: office365.runtime.paths.service_operation.ServiceOperationPath
+        """
+        url = path.key or ""
+        if isinstance(path.parameters, ClientValue):
+            url += "(@v)?@v={0}".format(json.dumps(path.parameters.to_json()))
+        elif path.parameters is not None:
+            url += "("
+            if isinstance(path.parameters, dict):
+                url += ','.join(['%s=%s' % (key, ODataUrlBuilder._encode_method_value(value)) for (key, value) in
+                                 path.parameters.items() if value is not None])
+            else:
+                url += ','.join(['%s' % (ODataUrlBuilder._encode_method_value(value)) for (i, value) in
+                                 enumerate(path.parameters) if value is not None])
+            url += ")"
+        return url
+
+    @staticmethod
+    def _encode_method_value(value):
+        if is_string_type(value):
+            value = value.replace("'", "''")
+
+            # Same replacements as SQL Server
+            # https://web.archive.org/web/20150101222238/http://msdn.microsoft.com/en-us/library/aa226544(SQL.80).aspx
+            # https://stackoverflow.com/questions/4229054/how-are-special-characters-handled-in-an-odata-query#answer-45883747
+            value = value.replace('%', '%25')
+            value = value.replace('+', '%2B')
+            value = value.replace('/', '%2F')
+            value = value.replace('?', '%3F')
+            value = value.replace('#', '%23')
+            value = value.replace('&', '%26')
+
+            value = "'{0}'".format(value)
+        elif isinstance(value, bool):
+            value = str(value).lower()
+        return value

office365/runtime/paths/service_operation.py

@@ -1,5 +1,5 @@
+from office365.runtime.odata.url_builder import ODataUrlBuilder
 from office365.runtime.paths.resource_path import ResourcePath
-from office365.runtime.odata.path_builder import ODataPathBuilder
 
 
 class ServiceOperationPath(ResourcePath):
@@ -16,4 +16,8 @@ def __init__(self, name, parameters=None, parent=None):
 
     @property
     def segment(self):
-        return ODataPathBuilder.build(self._key, self._parameters)
+        return ODataUrlBuilder.build_segment(self)
+
+    @property
+    def parameters(self):
+        return self._parameters

office365/runtime/queries/client_query.py

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

office365/runtime/queries/read_entity.py

@@ -19,5 +19,13 @@ def query_options(self):
 
     @property
     def url(self):
-        orig_url = super(ReadEntityQuery, self).url
-        return orig_url if self._query_options.is_empty else orig_url + "?" + str(self._query_options)
+        if not self.query_options.is_empty:
+            delimiter = "?"
+            from office365.runtime.paths.service_operation import ServiceOperationPath
+            from office365.runtime.client_value import ClientValue
+            if isinstance(self.path, ServiceOperationPath) and isinstance(self.path.parameters, ClientValue):
+                delimiter = "&"
+            return self.binding_type.resource_url + delimiter + str(self.query_options)
+        else:
+            return self.binding_type.resource_url
+