gspreadダウンロード - gspreadソースコードのダウンロード

Google スプレッドシート Python API v4

Google スプレッドシートを操作するためのシンプルなインターフェース。

特徴：

タイトル、キー、またはURLでスプレッドシートを開きます。
セル範囲の読み取り、書き込み、書式設定を行います。
共有とアクセス制御。
バッチ更新。

インストール

pip install gspread

要件: Python 3.8 以降。

基本的な使い方

Google APIコンソールで認証情報を作成する
gspread の使用を開始する

 import gspread

gc = gspread . service_account ()

# Open a sheet from a spreadsheet in one go
wks = gc . open ( "Where is the money Lebowski?" ). sheet1

# Update a range of cells using the top left corner address
wks . update ([[ 1 , 2 ], [ 3 , 4 ]], "A1" )

# Or update a single cell
wks . update_acell ( "B42" , "it's down there somewhere, let me take another look." )

# Format the header
wks . format ( 'A1:B1' , { 'textFormat' : { 'bold' : True }})

v5.12 から v6.0 への移行ガイド

Python 3.7 からのアップグレード

Python 3.7 はサポートが終了しました。 gspread v6 には、少なくとも Python 3.8 が必要です。

`Worksheet.update`引数を変更する

最初の 2 つの引数 ( valuesとrange_name ) が ( range_nameとvaluesに) 交換されました。それらを交換するか (v6 でのみ機能します)、名前付き引数を使用します (v5 と v6 で機能します)。

同様に、 valuesリストであってはならず、2D 配列でなければなりません。

 - file.sheet1.update([["new", "values"]])
+ file.sheet1.update([["new", "values"]]) # unchanged

- file.sheet1.update("B2:C2", [["54", "55"]])
+ file.sheet1.update([["54", "55"]], "B2:C2")
# or
+ file.sheet1.update(range_name="B2:C2", values=[["54", "55"]])

もっと

移行ガイドをもっと見る

辞書からテキストに色を変更する

v6 では 16 進数の色表現が使用されます。すべての色を 16 進数に変更します。互換性関数gspread.utils.convert_colors_to_hex_value()を使用して、辞書を 16 進文字列に変換できます。

 - tab_color = {"red": 1, "green": 0.5, "blue": 1}
+ tab_color = "#FF7FFF"
file.sheet1.update_tab_color(tab_color)

lastUpdateTime をプロパティからメソッドに切り替えます

 - age = spreadsheet.lastUpdateTime
+ age = spreadsheet.get_lastUpdateTime()

`Worksheet.get_records`メソッドを置き換えます

v6 では、 Worksheet.get_all_records()を使用してすべてのシートレコードのみを取得できるようになりました。 Worksheet.get_records()メソッドは削除されました。独自のフェッチを使用していくつかのレコードを取得し、それらをgspread.utils.to_records()と組み合わせることができます。

 + from gspread import utils
  all_records = spreadsheet.get_all_records(head=1)
- some_records = spreadsheet.get_all_records(head=1, first_index=6, last_index=9)
- some_records = spreadsheet.get_records(head=1, first_index=6, last_index=9)
+ header = spreadsheet.get("1:1")[0]
+ cells = spreadsheet.get("6:9")
+ some_records = utils.to_records(header, cells)

警告を沈黙させる

バージョン 5 には、非推奨の機能/関数/メソッドをマークする警告が多数あります。 GSPREAD_SILENCE_WARNINGS環境変数を1に設定することで、これらをサイレントにできます。

`gspread.Worksheet.init`にデータを追加します。

  gc = gspread.service_account(filename="google_credentials.json")
  spreadsheet = gc.open_by_key("{{key}}")
  properties = spreadsheet.fetch_sheet_metadata()["sheets"][0]["properties"]
- worksheet = gspread.Worksheet(spreadsheet, properties)
+ worksheet = gspread.Worksheet(spreadsheet, properties, spreadsheet.id, gc.http_client)

他の例

スプレッドシートを開く

 # You can open a spreadsheet by its title as it appears in Google Docs
sh = gc . open ( 'My poor gym results' ) # <-- Look ma, no keys!

# If you want to be specific, use a key (which can be extracted from
# the spreadsheet's url)
sht1 = gc . open_by_key ( '0BmgG6nO_6dprdS1MN3d3MkdPa142WFRrdnRRUWl1UFE' )

# Or, if you feel really lazy to extract that key, paste the entire url
sht2 = gc . open_by_url ( 'https://docs.google.com/spreadsheet/ccc?key=0Bm...FE&hl' )

スプレッドシートの作成

 sh = gc . create ( 'A new spreadsheet' )

# But that new spreadsheet will be visible only to your script's account.
# To be able to access newly created spreadsheet you *must* share it
# with your email. Which brings us to…

スプレッドシートの共有

 sh . share ( '[email protected]' , perm_type = 'user' , role = 'writer' )

ワークシートの選択

 # Select worksheet by index. Worksheet indexes start from zero
worksheet = sh . get_worksheet ( 0 )

# By title
worksheet = sh . worksheet ( "January" )

# Most common case: Sheet1
worksheet = sh . sheet1

# Get a list of all worksheets
worksheet_list = sh . worksheets ()

ワークシートの作成

 worksheet = sh . add_worksheet ( title = "A worksheet" , rows = "100" , cols = "20" )

ワークシートの削除

 sh . del_worksheet ( worksheet )

セル値の取得

 # With label
val = worksheet . get ( 'B1' ). first ()

# With coords
val = worksheet . cell ( 1 , 2 ). value

行または列からすべての値を取得する

 # Get all values from the first row
values_list = worksheet . row_values ( 1 )

# Get all values from the first column
values_list = worksheet . col_values ( 1 )

ワークシートからすべての値をリストのリストとして取得する

 from gspread . utils import GridRangeType
list_of_lists = worksheet . get ( return_type = GridRangeType . ListOfLists )

値の範囲を取得する

値が入っているセルのみを受信します。

 >> > worksheet . get ( "A1:B4" )
[[ 'A1' , 'B1' ], [ 'A2' ]]

値が含まれるセルの周囲の長方形配列を受け取ります。

 >> > worksheet . get ( "A1:B4" , pad_values = True )
[[ 'A1' , 'B1' ], [ 'A2' , '' ]]

値が空かどうかに関係なく、リクエストのサイズに一致する配列を受け取ります。

 >> > worksheet . get ( "A1:B4" , maintain_size = True )
[[ 'A1' , 'B1' ], [ 'A2' , '' ], [ '' , '' ], [ '' , '' ]]

細胞を見つける

 # Find a cell with exact string value
cell = worksheet . find ( "Dough" )

print ( "Found something at R%sC%s" % ( cell . row , cell . col ))

# Find a cell matching a regular expression
amount_re = re . compile ( r'(Big|Enormous) dough' )
cell = worksheet . find ( amount_re )

一致するすべてのセルの検索

 # Find all cells with string value
cell_list = worksheet . findall ( "Rug store" )

# Find all cells with regexp
criteria_re = re . compile ( r'(Small|Room-tiering) rug' )
cell_list = worksheet . findall ( criteria_re )

セルの更新

 # Update a single cell
worksheet . update_acell ( 'B1' , 'Bingo!' )

# Update a range
worksheet . update ([[ 1 , 2 ], [ 3 , 4 ]], 'A1:B2' )

# Update multiple ranges at once
worksheet . batch_update ([{
    'range' : 'A1:B2' ,
    'values' : [[ 'A1' , 'B1' ], [ 'A2' , 'B2' ]],
}, {
    'range' : 'J42:K43' ,
    'values' : [[ 1 , 2 ], [ 3 , 4 ]],
}])

書式設定されていないセル値または数式を取得する

 from gspread . utils import ValueRenderOption

# Get formatted cell value as displayed in the UI
>> > worksheet . get ( "A1:B2" )
[[ '$12.00' ]]

# Get unformatted value from the same cell range
>> > worksheet . get ( "A1:B2" , value_render_option = ValueRenderOption . unformatted )
[[ 12 ]]

# Get formula from a cell
>> > worksheet . get ( "C2:D2" , value_render_option = ValueRenderOption . formula )
[[ '=1/1024' ]]

範囲にデータ検証を追加する

 import gspread
from gspread . utils import ValidationConditionType

# Restrict the input to greater than 10 in a single cell
worksheet . add_validation (
  'A1' ,
  ValidationConditionType . number_greater ,
  [ 10 ],
  strict = True ,
  inputMessage = 'Value must be greater than 10' ,
)

# Restrict the input to Yes/No for a specific range with dropdown
worksheet . add_validation (
  'C2:C7' ,
   ValidationConditionType . one_of_list ,
   [ 'Yes' ,
   'No' ,]
   showCustomUi = True
)

ドキュメント

ドキュメント: https://gspread.readthedocs.io/

質問する

質問に対する答えを得る最良の方法は、gspread タグを使用して Stack Overflow で質問することです。

貢献者

寄稿者のリスト

貢献方法

行動規範を必ずお読みください。

問題を報告する

GitHub の問題を通じてバグを報告し、機能を提案してください。

問題を開く前に、トラッカーで重複の可能性を検索してください。重複を見つけた場合は、同じ問題が発生したことをコメントに追加してください。

ドキュメントの改善

ドキュメントはコードと同じくらい重要です。より一貫性があり、読みやすく、明確にする方法をご存知の場合は、プルリクエストを送信してください。ドキュメントファイルはdocsフォルダーにあり、reStructuredText マークアップを使用し、Sphinx によってレンダリングされます。

コードを提供する

プルリクエストを行う前に、コントリビュートガイドを必ずお読みください。

拡大する

gspread