Start Adding Range Service

Author: areed1192

.gitignore

@@ -129,5 +129,4 @@ dmypy.json
 .pyre/
 
 # Alex Folder.
-.vscode/
 config/

.vscode/launch.json

@@ -0,0 +1,15 @@
+{
+  // Use IntelliSense to learn about possible attributes.
+  // Hover to view descriptions of existing attributes.
+  // For more information, visit: https://go.microsoft.com/fwlink/?linkid=830387
+  "version": "0.2.0",
+  "configurations": [
+    {
+      "name": "Python: Run Client",
+      "type": "python",
+      "request": "launch",
+      "program": "${workspaceFolder}/samples/use_client.py",
+      "console": "integratedTerminal"
+    }
+  ]
+}

README.md

@@ -139,6 +139,3 @@ pay monthly fees.
 
 **YouTube:**
 If you'd like to watch more of my content, feel free to visit my YouTube channel [Sigma Coding](https://www.youtube.com/c/SigmaCoding).
-
-<!-- **Hire Me:**
-If you have a project, you think I can help you with feel free to reach out at [[email protected]](mailto:[email protected]?subject=[GitHub]%20Project%20Proposal) or fill out the [contract request form](https://forms.office.com/Pages/ResponsePage.aspx?id=DQSIkWdsW0yxEjajBLZtrQAAAAAAAAAAAAa__aAmF1hURFg5ODdaVTg1TldFVUhDVjJHWlRWRzhZRy4u) -->

ms_graph/client.py

@@ -21,7 +21,7 @@
 from ms_graph.mail import Mail
 
 from ms_graph.workbooks_and_charts.workbook import Workbooks
-
+from ms_graph.workbooks_and_charts.range import Range
 
 class MicrosoftGraphClient:
 
@@ -477,3 +477,17 @@ def workbooks(self) -> Workbooks:
         workbook_service: Workbooks = Workbooks(session=self.graph_session)
 
         return workbook_service
+
+    def range(self) -> Range:
+        """Used to access the Range Services and metadata.
+
+        ### Returns
+        ---
+        Range:
+            The `Range` services Object.
+        """
+
+        # Grab the `Range` Object for the session.
+        range_service: Range = Range(session=self.graph_session)
+
+        return range_service

ms_graph/utils/range.py

@@ -0,0 +1,73 @@
+from dataclasses import dataclass
+
+
+@dataclass
+class RangeProperties:
+
+    """
+    ### Overview
+    ----
+    A python dataclass which is used to represent Range Properties.
+    The Microsoft Graph API allows users to update Range objects and
+    this utility makes constructing those updates in a concise way that
+    is python friendly.
+
+    ### Parameters
+    ----
+    column_hidden : bool (optional, Default=None)
+        Represents if all columns of the current range are hidden.
+
+    formulas : list (optional, Default=None)
+        Represents the formula in A1-style notation.
+
+    formulas_local : list (optional, Default=None)
+        Represents the formula in A1-style notation, in the user's
+        language and number-formatting locale. For example, the
+        English "=SUM(A1, 1.5)" formula would become
+        "=SUMME(A1; 1,5)" in German.
+
+    formulas_r1c1 : list (optional, Default=None)
+        Represents the formula in R1C1-style notation.
+
+    number_format : str (optional, Default=None)
+        Represents Excel's number format code for the given cell.
+
+    row_hidden : bool (optional, Default=None)
+        Represents if all rows of the current range are hidden.
+
+    values : list (optional, Default=None)
+        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.
+    """
+
+    column_hidden: bool
+    row_hidden: bool
+    formulas: list
+    formulas_local: list
+    formulas_r1c1: list
+    number_format: str
+    values: list
+
+    def to_dict(self) -> dict:
+        """Generates a dictionary containing all the field
+        names and values.
+
+        ### Returns
+        ----
+        dict
+            The Field Name and Values.
+        """
+
+        class_dict = {
+            "columnHidden": self.column_hidden,
+            "rowHidden": self.row_hidden,
+            "formulas": self.formulas,
+            "numberFormat": self.number_format,
+            "formulasR1C1": self.formulas_r1c1,
+            "formulasLocal": self.formulas_local,
+            "values": self.values,
+        }
+
+        return class_dict

ms_graph/workbooks_and_charts/enums.py

@@ -1,5 +1,6 @@
 from enum import Enum
 
+
 class CalculationTypes(Enum):
     """Specifies the calculation types used in the
     `WorkbookApplication` calculate method.
@@ -10,9 +11,9 @@ class CalculationTypes(Enum):
         >>> CalculationTypes.RECALCULATE.value
     """
 
-    RECALCULATE = 'Recaulcaute'
-    FULL = 'Full'
-    FULLREBUILD = 'FullRebuild'
+    RECALCULATE = "Recaulcaute"
+    FULL = "Full"
+    FULLREBUILD = "FullRebuild"
 
 
 class WorksheetVisibility(Enum):
@@ -25,6 +26,20 @@ class WorksheetVisibility(Enum):
         >>> WorksheetVisibility.VISIBLE.value
     """
 
-    VISIBLE = 'Visible'
-    HIDDEN = 'Hidden'
-    VERYHIDDEN = 'VeryHidden'
+    VISIBLE = "Visible"
+    HIDDEN = "Hidden"
+    VERYHIDDEN = "VeryHidden"
+
+
+class RangeShift(Enum):
+    """Specifies the shift directions used in the
+    `Range` `insert_range` method.
+
+    ### Usage:
+    ----
+        >>> from ms_graph.workbooks_and_charts.enums import RangeShift
+        >>> RangeShift.DOWN.value
+    """
+
+    DOWN = "Down"
+    RIGHT = "Right"