OneDrive: workspace namespace enhancements: new types & methods

Author: vgrem

office365/onedrive/workbooks/comments/comment.py

@@ -1,5 +1,15 @@
 from office365.entity import Entity
+from office365.entity_collection import EntityCollection
+from office365.onedrive.workbooks.comments.reply import WorkbookCommentReply
+from office365.runtime.paths.resource_path import ResourcePath
 
 
 class WorkbookComment(Entity):
     """Represents a comment in workbook."""
+
+    @property
+    def replies(self):
+        """"""
+        return self.properties.get('replies',
+                                   EntityCollection(self.context, WorkbookCommentReply,
+                                                    ResourcePath("replies", self.resource_path)))

office365/onedrive/workbooks/comments/reply.py

@@ -0,0 +1,5 @@
+from office365.entity import Entity
+
+
+class WorkbookCommentReply(Entity):
+    """Represents a reply to an Excel comment."""

office365/onedrive/workbooks/filter.py

@@ -0,0 +1,5 @@
+from office365.entity import Entity
+
+
+class WorkbookFilter(Entity):
+    """Manages the filtering of a table's column."""

office365/onedrive/workbooks/functions/functions.py

@@ -6,6 +6,16 @@
 class WorkbookFunctions(Entity):
     """Used as a container for Microsoft Excel worksheet function"""
 
+    def abs(self, number):
+        """"""
+        return_type = WorkbookFunctionResult(self.context)
+        payload = {
+            "number": number,
+        }
+        qry = ServiceOperationQuery(self, "abs", None, payload, None, return_type)
+        self.context.add_query(qry)
+        return return_type
+
     def days(self, start_date, end_date):
         """Returns the number of days between two dates.
 

office365/onedrive/workbooks/ranges/range.py

@@ -1,10 +1,19 @@
 from office365.entity import Entity
+from office365.onedrive.workbooks.ranges.view import WorkbookRangeView
 from office365.runtime.paths.resource_path import ResourcePath
+from office365.runtime.queries.function import FunctionQuery
 
 
 class WorkbookRange(Entity):
     """Range represents a set of one or more contiguous cells such as a cell, a row, a column, block of cells, etc."""
 
+    def visible_view(self):
+        """"""
+        return_type = WorkbookRangeView(self.context)
+        qry = FunctionQuery(self, "visibleView", return_type=return_type)
+        self.context.add_query(qry)
+        return return_type
+
     @property
     def address(self):
         """

office365/onedrive/workbooks/ranges/view.py

@@ -0,0 +1,14 @@
+from office365.entity import Entity
+from office365.entity_collection import EntityCollection
+from office365.runtime.paths.resource_path import ResourcePath
+
+
+class WorkbookRangeView(Entity):
+    """Represents a set of visible cells of the parent range."""
+
+    @property
+    def rows(self):
+        """Represents a collection of range views associated with the range."""
+        return self.properties.get('rows',
+                                   EntityCollection(self.context, WorkbookRangeView,
+                                                    ResourcePath("rows", self.resource_path)))

office365/onedrive/workbooks/tables/columns/collection.py

@@ -1,10 +1,29 @@
 from office365.entity_collection import EntityCollection
 from office365.onedrive.workbooks.tables.columns.column import WorkbookTableColumn
+from office365.runtime.client_result import ClientResult
+from office365.runtime.queries.function import FunctionQuery
 
 
 class WorkbookTableColumnCollection(EntityCollection):
 
     def __init__(self, context, resource_path=None):
         super(WorkbookTableColumnCollection, self).__init__(context, WorkbookTableColumn, resource_path)
 
+    def add(self, index, name, values=None):
+        """
+        Adds a new column to the table.
 
+        :param int index: Specifies the relative position of the new column. The previous column at this position
+            is shifted to the right. The index value should be equal to or less than the last column's index value,
+            so it cannot be used to append a column at the end of the table. Zero-indexed.
+        :param list values: A 2-dimensional array of unformatted values of the table column.
+        :param str name: Name
+        """
+        return super(WorkbookTableColumnCollection, self).add(index=index, values=values, name=name)
+
+    def count(self):
+        """"""
+        return_type = ClientResult(self.context, int())
+        qry = FunctionQuery(self, "count", None, return_type)
+        self.context.add_query(qry)
+        return return_type

office365/onedrive/workbooks/tables/columns/column.py

@@ -1,6 +1,41 @@
 from office365.entity import Entity
+from office365.onedrive.workbooks.filter import WorkbookFilter
+from office365.onedrive.workbooks.ranges.range import WorkbookRange
+from office365.runtime.paths.resource_path import ResourcePath
+from office365.runtime.queries.function import FunctionQuery
 
 
 class WorkbookTableColumn(Entity):
     """Represents a column in a table."""
-    pass
+
+    def header_row_range(self):
+        """
+        Gets the range object associated with the header row of the column.
+        """
+        return_type = WorkbookRange(self.context)
+        qry = FunctionQuery(self, "headerRowRange", return_type=return_type)
+        self.context.add_query(qry)
+        return return_type
+
+    def range(self):
+        """
+        Gets the range object associated with the entire column.
+        """
+        return_type = WorkbookRange(self.context)
+        qry = FunctionQuery(self, "range", return_type=return_type)
+        self.context.add_query(qry)
+        return return_type
+
+    @property
+    def values(self):
+        """
+        Represents the raw values of the specified range. The data returned could be of type string, number,
+        or a boolean. Cell that contain an error will return the error string.
+        """
+        return self.properties.get("values", None)
+
+    @property
+    def filter(self):
+        """Retrieve the filter applied to the column."""
+        return self.properties.get('filter',
+                                   WorkbookFilter(self.context, ResourcePath("filter", self.resource_path)))

office365/onedrive/workbooks/tables/table.py

@@ -2,8 +2,8 @@
 from office365.onedrive.workbooks.ranges.range import WorkbookRange
 from office365.onedrive.workbooks.tables.columns.collection import WorkbookTableColumnCollection
 from office365.onedrive.workbooks.tables.rows.collection import WorkbookTableRowCollection
-from office365.runtime.http.http_method import HttpMethod
 from office365.runtime.paths.resource_path import ResourcePath
+from office365.runtime.queries.function import FunctionQuery
 from office365.runtime.queries.service_operation import ServiceOperationQuery
 
 
@@ -13,24 +13,22 @@ class WorkbookTable(Entity):
     def data_body_range(self):
         """Gets the range object associated with the data body of the table."""
         return_type = WorkbookRange(self.context)
-        qry = ServiceOperationQuery(self, "dataBodyRange", return_type=return_type)
+        qry = FunctionQuery(self, "dataBodyRange", return_type=return_type)
         self.context.add_query(qry)
+        return return_type
 
-        def _construct_request(request):
-            request.method = HttpMethod.Get
-        self.context.before_execute(_construct_request)
+    def range(self):
+        """Get the range object associated with the entire table."""
+        return_type = WorkbookRange(self.context)
+        qry = FunctionQuery(self, "range", return_type=return_type)
+        self.context.add_query(qry)
         return return_type
 
     def total_row_range(self):
         """Gets the range object associated with totals row of the table."""
         return_type = WorkbookRange(self.context)
-        qry = ServiceOperationQuery(self, "totalRowRange", return_type=return_type)
+        qry = FunctionQuery(self, "totalRowRange", return_type=return_type)
         self.context.add_query(qry)
-
-        def _construct_request(request):
-            request.method = HttpMethod.Get
-
-        self.context.before_execute(_construct_request)
         return return_type
 
     def clear_filters(self):

office365/outlook/calendar/group.py

@@ -12,13 +12,17 @@ class CalendarGroup(Entity):
     @property
     def name(self):
         """
+        The group name.
+
         :rtype: str
         """
         return self.properties.get("name", None)
 
     @property
     def class_id(self):
         """
+        The class identifier
+
         :rtype: str
         """
         return self.properties.get("classId", None)

office365/outlook/contacts/folder.py

@@ -1,3 +1,5 @@
+from office365.directory.extensions.extended_property import MultiValueLegacyExtendedProperty, \
+    SingleValueLegacyExtendedProperty
 from office365.entity import Entity
 from office365.entity_collection import EntityCollection
 from office365.runtime.paths.resource_path import ResourcePath
@@ -21,10 +23,26 @@ def child_folders(self):
                                    EntityCollection(self.context, ContactFolder,
                                                     ResourcePath("childFolders", self.resource_path)))
 
+    @property
+    def multi_value_extended_properties(self):
+        """The collection of multi-value extended properties defined for the Contact folder."""
+        return self.properties.get('multiValueExtendedProperties',
+                                   EntityCollection(self.context, MultiValueLegacyExtendedProperty,
+                                                    ResourcePath("multiValueExtendedProperties", self.resource_path)))
+
+    @property
+    def single_value_extended_properties(self):
+        """The collection of single-value extended properties defined for the Contact folder."""
+        return self.properties.get('singleValueExtendedProperties',
+                                   EntityCollection(self.context, SingleValueLegacyExtendedProperty,
+                                                    ResourcePath("singleValueExtendedProperties", self.resource_path)))
+
     def get_property(self, name, default_value=None):
         if default_value is None:
             property_mapping = {
-                "childFolders": self.child_folders
+                "childFolders": self.child_folders,
+                "multiValueExtendedProperties": self.multi_value_extended_properties,
+                "singleValueExtendedProperties": self.single_value_extended_properties
             }
             default_value = property_mapping.get(name, None)
         return super(ContactFolder, self).get_property(name, default_value)

tests/onedrive/test_excel.py

@@ -50,22 +50,34 @@ def test4_data_body_range(self):
         result = self.__class__.table.data_body_range().execute_query()
         self.assertIsNotNone(result.address)
 
-    def test5_get_table_rows(self):
+    def test5_create_table_column(self):
+        column = self.__class__.table.columns.add(3, "Column4").execute_query()
+        self.assertIsNotNone(column.resource_path)
+
+    def test6_list_table_columns(self):
+        columns = self.__class__.table.columns.get().execute_query()
+        self.assertIsNotNone(columns.resource_path)
+
+    def test7_list_table_rows(self):
         rows = self.__class__.table.rows.get().execute_query()
         self.assertIsNotNone(rows.resource_path)
 
-    def test6_create_table_rows(self):
-        rows = self.__class__.table.rows.add([["a", "b", "c"]]).execute_query()
+    def test8_create_table_rows(self):
+        rows = self.__class__.table.rows.add([["Val11", "Val12", "Val13", "Val14"]]).execute_query()
         self.assertIsNotNone(rows.resource_path)
 
-    def test7_delete_workbook_table(self):
+    def test9_table_range(self):
+        result = self.__class__.table.range().execute_query()
+        self.assertIsNotNone(result.address)
+
+    def test_10_delete_workbook_table(self):
         self.__class__.table.delete_object().execute_query()
 
-    #def test8_workbook_create_session(self):
+    #def test_11_workbook_create_session(self):
     #    result = self.__class__.target_item.workbook.create_session().execute_query()
     #    self.assertIsNotNone(result.value)
 
-    #def test9_workbook_close_session(self):
+    #def test_12_workbook_close_session(self):
     #    self.__class__.target_item.workbook.close_session().execute_query()