Spreadsheet Handler
googleSheetsLib.core.Spreadsheet
Interface to handle Google Spreadsheets operations via API.
This class serves as a wrapper to interface with Google Sheets. It can handle operations at the Spreadsheet level (metadata, batch updates) and acts as a factory for Sheet objects.
It handles authentication internally using the ClientWrapper class.
For more information on the API, visit: https://developers.google.com/workspace/sheets/api/quickstart/python
Attributes:
| Name | Type | Description |
|---|---|---|
spreadsheet_id |
str
|
The unique ID of the Spreadsheet (found in the URL). |
name |
str
|
The Spreadsheet's title. |
locale |
str
|
The locale of the spreadsheet (e.g., 'en_US', 'pt_BR'). |
timezone |
str
|
The timezone of the spreadsheet. |
client |
ClientWrapper
|
Handler for API requests, authentication, and retry logic. |
service |
SpreadsheetResource
|
The authenticated Google Sheets API resource. |
batch_requests |
list[dict]
|
Pending requests for the |
batch_value_requests |
list[dict]
|
Pending requests for the |
last_refreshed |
datetime
|
Timestamp of the last metadata update. |
metadata |
dict
|
Raw dictionary containing the full Spreadsheet metadata. |
sheets_info |
dict
|
Metadata for individual tabs (id, name, grid size), indexed by tab name. |
Parameters:
| Name | Type | Description | Default |
|---|---|---|---|
spreadsheet_id
|
str
|
The ID found in the Google Sheets URL. |
required |
token_fp
|
str
|
File path to the auth token. Defaults to auth/token.json. |
TOKEN_PATH
|
cred_fp
|
str
|
File path to the credentials JSON. Defaults to auth/cred.json. |
CRED_PATH
|
scopes
|
list[str]
|
List of API scopes required. Defaults to SCOPES. |
SCOPES
|
Notes
You can setup the environment variables GOOGLE_SERVICE_CREDS and GOOGLE_SERVICE_TOKEN instead of directing to the credentials path. Just insert the JSON in plain text in them and the ClientWrapper will take care of the rest.
Raises:
| Type | Description |
|---|---|
ConnectionError
|
If the Google Client cannot be created or authenticated. |
Example
Source code in src/googleSheetsLib/core.py
17 18 19 20 21 22 23 24 25 26 27 28 29 30 31 32 33 34 35 36 37 38 39 40 41 42 43 44 45 46 47 48 49 50 51 52 53 54 55 56 57 58 59 60 61 62 63 64 65 66 67 68 69 70 71 72 73 74 75 76 77 78 79 80 81 82 83 84 85 86 87 88 89 90 91 92 93 94 95 96 97 98 99 100 101 102 103 104 105 106 107 108 109 110 111 112 113 114 115 116 117 118 119 120 121 122 123 124 125 126 127 128 129 130 131 132 133 134 135 136 137 138 139 140 141 142 143 144 145 146 147 148 149 150 151 152 153 154 155 156 157 158 159 160 161 162 163 164 165 166 167 168 169 170 171 172 173 174 175 176 177 178 179 180 181 182 183 184 185 186 187 188 189 190 191 192 193 194 195 196 197 198 199 200 201 202 203 204 205 206 207 208 209 210 211 212 213 214 215 216 217 218 219 220 221 222 223 224 225 226 227 228 229 230 231 232 233 234 235 236 237 238 239 240 241 242 243 244 245 246 247 248 249 250 251 252 253 254 255 256 257 258 259 260 261 262 263 264 265 266 267 268 269 270 271 272 273 274 275 276 277 278 279 280 281 282 283 284 285 286 287 288 289 290 291 292 293 294 295 296 297 298 299 300 301 302 303 304 305 306 307 308 309 310 311 312 313 314 315 316 317 318 319 320 321 322 323 324 325 326 327 328 329 330 331 332 333 334 335 336 337 338 339 340 341 342 343 344 345 346 347 348 349 350 351 352 353 354 355 356 357 358 359 360 361 362 363 364 365 366 367 368 369 370 371 372 373 374 375 376 377 378 379 380 381 382 383 384 385 386 387 388 389 390 391 392 393 394 | |
build_metadata(metadata)
Method to parse metadata dict and update the object's metadata attributes.
It builds both the Spreadsheet's and the individual Tab's metadata.
Parameters:
| Name | Type | Description | Default |
|---|---|---|---|
metadata
|
dict
|
Dictionary containing the Spreadsheet's metadata, as structured by the .get() request on the Spreadsheet resource. |
required |
Returns:
| Name | Type | Description |
|---|---|---|
bool |
bool
|
If the build succeded or failed. False if the metadata is empty or it generated a KeyError, True otherwise. |
Source code in src/googleSheetsLib/core.py
refresh_metadata()
Method to refresh metadata. It only requests the metadata to the API and sends it to the build_metadata method.
Returns:
| Name | Type | Description |
|---|---|---|
bool |
bool
|
if the refresh failed or succeded. |
Source code in src/googleSheetsLib/core.py
get_sheet(sheet_name)
Retrieves a Sheet object by its name using cached metadata.
This method acts as a factory, returning a Sheet object initialized
with the data currently stored in self.sheets_info.
If the sheet exists in the Google Spreadsheet but not in the local metadata
(e.g., created recently), you must call refresh_metadata() first.
This method supports the subscript syntax (e.g., spreadsheet['Tab Name']).
Parameters:
| Name | Type | Description | Default |
|---|---|---|---|
sheet_name
|
str
|
The exact name of the tab as it appears in Google Sheets. |
required |
Returns:
| Name | Type | Description |
|---|---|---|
Sheet |
Sheet | None
|
A Sheet object initialized with the tab's ID and dimensions. |
None |
Sheet | None
|
If the sheet name is not found in the local metadata. |
Example
Source code in src/googleSheetsLib/core.py
get_sheet_by_id(id)
Retrieves a Sheet object by its id using cached metadata.
It's useful if you rename a tab, but maintain the id in a varibable.
To access a tab's id, get the Sheet's metadata in self.sheets_info and check the sheet_id value.
This method acts as a factory, returning a Sheet object initialized
with the data currently stored in self.sheets_info.
If the sheet exists in the Google Spreadsheet but not in the local metadata
(e.g., created recently), you must call refresh_metadata() first.
This method supports the subscript syntax (e.g., spreadsheet[id]).
Parameters:
| Name | Type | Description | Default |
|---|---|---|---|
id
|
int
|
The tab's id. This is an internal id that has to be accessed by the Spreadsheet's metadata. |
required |
Returns:
| Name | Type | Description |
|---|---|---|
Sheet |
Sheet | None
|
A Sheet object initialized with the tab's ID and dimensions. |
None |
Sheet | None
|
If the sheet name is not found in the local metadata. |
Example
# Direct method call
inventory = ss.get_sheet_by_id(49203)
# Using subscript syntax (sugar)
sales = ss[2384]
# Using the sheets_info metadata:
sheet_metadata = ss.sheets_info['Sales']
sheet_id = sheet_metadata['sheet_id']
sales = ss.get_sheet_by_id(sheet_id)
# Handling non-existent sheets
if not ss.get_sheet_by_id(3232):
print("Tab not found or metadata outdated.")
Source code in src/googleSheetsLib/core.py
execute_batch()
Executes all pending requests in the batch queue via the batchUpdate endpoint.
This method compiles all operations stored in self.batch_requests, wraps them
into a single API call, and passes it to the client handler.
If the execution is successful, the method should ideally clear the pending requests queue.
Returns:
| Name | Type | Description |
|---|---|---|
Response |
Response
|
A custom response object.
- If successful ( |
Example
Source code in src/googleSheetsLib/core.py
get_info()
Returns a simple dictionary containing the Spreadsheet's info.
Useful for serialization.
Returns:
| Name | Type | Description |
|---|---|---|
dict |
dict
|
Dictionary with spreadsheet_id, name, last refreshed and tabs info. |