can now retrieve full sheet range as pandas.DataFrame

condad · condad · commit 1006bfccfe63 · 2017-10-30T18:20:40.000-04:00
diff --git a/.gitignore b/.gitignore
@@ -11,3 +11,4 @@ build/
 .cache/
 .env
 env.sh
+.vscode/
diff --git a/google_objects/sheets/core.py b/google_objects/sheets/core.py
@@ -10,6 +10,8 @@
 import logging
 from datetime import datetime
 
+import pandas
+
 from .. import GoogleClient, GoogleObject
 
 log = logging.getLogger(__name__)
@@ -227,6 +229,10 @@ def yield_sheets(self):
         for sheet in self.data['sheets']:
             yield Sheet.from_existing(sheet, self)
 
+    def yield_values(self, arg1):
+        for sheet in self.yield_sheets():
+            yield sheet.values()
+
     def get_range(self, sheet_range):
         """Takes a sheet range and initializes a block object
         with the raw data and the spreadsheet for update
@@ -392,7 +398,9 @@ def values(self, start=None, end=None):
         block.spreadsheet = self.spreadsheet
 
         return block
-
+    
+    def frame(self):
+        return self.values().as_df()
 
 class Block(GoogleObject):
 
@@ -438,6 +446,12 @@ def yield_rows(self):
     def rows(self):
         return [row for row in self.yield_rows()]
 
+    def as_df(self, header=True):
+        df = pandas.DataFrame(self.rows())
+        if header:
+            return df.rename(columns=df.iloc[0])
+        return df
+
     @property
     def values(self):
         return self.data['values']
diff --git a/tests/sheets_test.py b/tests/sheets_test.py
@@ -1,6 +1,8 @@
 import unittest
 from unittest import mock
 
+import pandas
+
 from tests.utils import get_data
 from google_objects.sheets.core import SheetsClient
 from google_objects.sheets.core import Spreadsheet
@@ -52,3 +54,9 @@ def test_values(self):
 
         for row in values:
             self.assertIsInstance(row, list)
+
+    def test_frame(self):
+        spreadsheet = self.client.get_spreadsheet('abc123')
+        sheets = spreadsheet.sheets()
+        values = sheets[0].frame()
+        self.assertIsInstance(values, pandas.DataFrame)

-Original file line number
+Diff line change
 .cache/
 .env
 env.sh
 +.vscode/