gspread，一个超强的 Python 库！

Sitin涛哥

已于 2024-02-18 09:51:48 修改

阅读量1.4k

点赞数 24

分类专栏： Python 文章标签： python 数据库开发语言

于 2024-02-17 20:00:00 首次发布

本文链接：https://blog.csdn.net/wuShiJingZuo/article/details/136144550

版权

Python 专栏收录该内容

1435 篇文章

订阅专栏

更多Python学习内容：ipengtao.com

大家好，今天为大家分享一个超强的 Python 库 - gspread。

Github地址：https://github.com/burnash/gspread

Google Sheets是一款强大的在线电子表格工具，而gspread是一个Python库，可以让您通过编程方式轻松地与Google Sheets进行交互。本文将详细介绍gspread库的使用方法和功能，帮助大家更好地利用Google Sheets进行数据管理和分析。

安装与基本使用

要开始使用gspread，首先需要安装它：

pip install gspread

然后，需要创建一个Google API项目并获取API密钥，以便访问Google Sheets API。

接下来，使用这些凭据，可以通过gspread库连接到Google Sheets账户。

以下是一个简单的示例代码：

import gspread
from oauth2client.service_account import ServiceAccountCredentials

# 定义Google Sheets API凭据
scope = ['https://spreadsheets.google.com/feeds',
         'https://www.googleapis.com/auth/drive']
credentials = ServiceAccountCredentials.from_json_keyfile_name('credentials.json', scope)

# 连接到Google Sheets
gc = gspread.authorize(credentials)

连接 Google Sheets

连接到 Google Sheets 是使用 gspread 库的第一步。可以通过几种不同的方式进行连接，最常见的是使用 OAuth2 认证和服务账号认证。

1 OAuth2 认证

OAuth2 认证是一种安全的方式，允许通过授权访问 Google Sheets API。需要创建一个 Google API 项目并获取客户端 ID 和客户端密钥，然后使用这些凭据授权访问 Google Sheets API。

以下是使用 OAuth2 认证连接到 Google Sheets 的示例代码：

import gspread
from oauth2client.service_account import ServiceAccountCredentials

# 定义 OAuth2 认证的作用域
scope = ['https://spreadsheets.google.com/feeds',
         'https://www.googleapis.com/auth/drive']

# 从 JSON 文件加载 OAuth2 凭据
credentials = ServiceAccountCredentials.from_json_keyfile_name('credentials.json', scope)

# 使用凭据授权访问 Google Sheets
gc = gspread.authorize(credentials)

在此示例中，credentials.json 是从 Google API 控制台下载的包含 OAuth2 凭据的 JSON 文件。通过加载此文件并使用 ServiceAccountCredentials.from_json_keyfile_name() 方法，可以创建一个凭据对象，然后使用 gspread.authorize() 方法授权访问 Google Sheets。

2 服务账号认证

服务账号认证是另一种常见的连接到 Google Sheets 的方法，特别适用于服务器端应用程序。需要为项目创建一个服务账号，并将其与 Google Sheets 文件共享。

以下是使用服务账号认证连接到 Google Sheets 的示例代码：

import gspread

# 使用服务账号认证连接到 Google Sheets
gc = gspread.service_account(filename='service_account.json')

在此示例中，service_account.json 是包含服务账号凭据的 JSON 文件。通过使用 gspread.service_account() 方法并传递文件名，可以创建一个授权访问 Google Sheets 的客户端对象。

读取和写入数据

gspread使得从Google Sheets读取数据和向Google Sheets写入数据变得非常简单。可以使用open方法打开工作表，并使用它的方法读取和写入数据。

# 打开工作表
worksheet = gc.open('Sheet1').sheet1

# 读取数据
data = worksheet.get_all_values()

# 写入数据
worksheet.update('A1', 'Hello, gspread!')

高级功能与扩展

除了基本的数据操作和管理功能外，gspread还提供了一些高级功能和扩展，能够更灵活地使用Google Sheets进行数据管理和分析。

1 共享与权限

共享工作表

可以使用gspread库来共享您的工作表，并控制谁可以查看或编辑它。

# 共享工作表给指定的用户或电子邮件列表
worksheet.share(email='user@example.com', role='reader')

权限管理

可以使用gspread库来管理工作表的权限，包括修改和删除用户的访问权限。

# 修改用户权限为编辑者
worksheet.batch_update({'requests': [{'updateSheetProperties': {'properties': {'sheetId': worksheet.id, 'sheetType': 'GRID', 'gridProperties': {'frozenRowCount': 1}}, 'fields': 'gridProperties.frozenRowCount'}}]})

2 图表生成

gspread库还提供了生成图表并将其插入到工作表中的功能，能够轻松地将数据可视化。

# 创建一个柱状图并插入到工作表中
chart = worksheet.add_chart({'type': 'bar'}, {'title': 'Sales Data'})
chart.add_series({'values': '=Sheet1!$A$2:$A$5'})
worksheet.insert_chart('B1', chart)

3 自动化任务

可以使用gspread结合其他Python库（如定时任务库schedule）来实现自动化任务，如数据同步和报告生成等。

import schedule
import time

def sync_data():
    # 同步数据的代码
    pass

# 每天定时执行数据同步任务
schedule.every().day.at("00:00").do(sync_data)

while True:
    schedule.run_pending()
    time.sleep(1)

实战案例与示例代码

场景描述： 假设你是一家小型公司的数据分析师，每周都需要收集销售数据并生成销售报告，以便管理层做出决策。现在希望使用 gspread 库自动化这个过程，从而节省时间并提高工作效率。

示例代码：

import gspread
from oauth2client.service_account import ServiceAccountCredentials
import pandas as pd

# 定义 Google Sheets API 的作用域
scope = ['https://spreadsheets.google.com/feeds', 'https://www.googleapis.com/auth/drive']

# 加载 OAuth2 凭据
credentials = ServiceAccountCredentials.from_json_keyfile_name('credentials.json', scope)

# 使用凭据授权访问 Google Sheets
gc = gspread.authorize(credentials)

# 打开工作表
worksheet = gc.open('Sales Data').sheet1

# 将工作表数据加载到 DataFrame
df = pd.DataFrame(worksheet.get_all_records())

# 按日期筛选最近一周的数据
recent_data = df[df['Date'] >= '2024-01-01']

# 计算每个产品的总销售额
sales_by_product = recent_data.groupby('Product')['Revenue'].sum().reset_index()

# 创建新的工作表以存储报告数据
report_worksheet = gc.open('Weekly Sales Report').add_worksheet(title='Sales Summary', rows='10', cols='3')

# 将报告数据写入新工作表
for i, row in sales_by_product.iterrows():
    report_worksheet.update_cell(i+2, 1, row['Product'])
    report_worksheet.update_cell(i+2, 2, row['Revenue'])

# 添加报告标题和标签
report_worksheet.update_cell(1, 1, 'Product')
report_worksheet.update_cell(1, 2, 'Total Revenue')

print("Weekly sales report has been generated successfully!")

在这个示例中，首先连接到 Google Sheets，然后打开了名为 "Sales Data" 的工作表，并将其数据加载到 Pandas DataFrame 中。然后，筛选出最近一周的数据，并计算了每个产品的总销售额。最后，创建了一个新的工作表 "Weekly Sales Report"，并将报告数据写入其中。

总结

Python的gspread库为与Google Sheets的集成提供了简单而强大的解决方案。通过gspread，用户可以轻松地连接到Google Sheets，并对其进行读取、写入和管理操作，实现数据的自动化处理和分析。从基本的数据操作到高级功能和扩展，gspread提供了丰富的功能和灵活的工具，使用户能够更加高效地利用Google Sheets进行工作和协作。总之，gspread是一个值得信赖的工具，为Python用户提供了方便、快捷的方式来处理和管理数据，并为工作带来便利和效率提升。

如果你觉得文章还不错，请大家点赞、分享、留言下，因为这将是我持续输出更多优质文章的最强动力！

如果想要系统学习Python、Python问题咨询，或者考虑做一些工作以外的副业，都可以扫描二维码添加微信，围观朋友圈一起交流学习。