gspreadでrow_countの値が更新されない

Question

環境

Python 3.10.2でgspread 5.3.2を利用しています。

問題

シートの行数を取得する際に、row_countの値が更新されません。
以下のコードを実行したときに、スプレッドシート上では正しく書き込み出来ているのですが、row1とrow2の値が同じになってしまいます。

# 該当部分の抜粋
ws = wb.worksheet("Main")

row1 = ws.row_count
ws.append_row(save_list)
row2 = ws.row_count

試したこと

以下のようにシートを読み込みなおすと、row1とrow2の値がきちんと1つ増えるようになりましたが、スプレッドシートへのアクセス数が増えてしまうので可能であれば避けたいです。

# 該当部分の抜粋
ws = wb.worksheet("Main")
row1 = ws.row_count
ws.append_row(save_list)

ws = wb.worksheet("Main")
row2 = ws.row_count

少し調べたのですが、この挙動が仕様なのか、私の検討違いなのかが分かりませんでした。問題点・解決策をご教授いただければ幸いです。よろしくお願いします。

念のため、以下にコード全文（汚くてすみません）を記載しておきます。

import os
from os.path import dirname, join

import client
import gspread
from dotenv import load_dotenv
from flask import Flask, render_template, request
from flask_sitemap import Sitemap
from google.oauth2.service_account import Credentials
from werkzeug.utils import secure_filename

# ローカル環境で環境編集を取得
dotenv_path = join(dirname(__file__), '.env')
load_dotenv(dotenv_path)

# Googleスプレッドシートからデータベースを取得
scope = ['https://www.googleapis.com/auth/spreadsheets','https://www.googleapis.com/auth/drive']

credential = {
    "type": "service_account",
    "project_id": os.environ['SHEET_PROJECT_ID'],
    "private_key_id": os.environ['SHEET_PRIVATE_KEY_ID'],
    "private_key": os.environ['SHEET_PRIVATE_KEY'].replace('\\n', '\n'),
    "client_email": os.environ['SHEET_CLIENT_EMAIL'],
    "client_id": os.environ['SHEET_CLIENT_ID'],
    "auth_uri": "https://accounts.google.com/o/oauth2/auth",
    "token_uri": "https://oauth2.googleapis.com/token",
    "auth_provider_x509_cert_url": "https://www.googleapis.com/oauth2/v1/certs",
    "client_x509_cert_url":  os.environ['SHEET_CLIENT_X509_CERT_URL']
    }
credentials = Credentials.from_service_account_info(credential,scopes=scope)
# ログイン
gc = gspread.authorize(credentials)
# シートを開く
wb = gc.open_by_key(os.environ['SHEET_DATABASE_KEY'])
ws = wb.worksheet("Main")

file_send = client.file_send(os.environ['DB_URL'],os.environ['DB_TOKEN'])

app = Flask(__name__)
ext = Sitemap(app=app)

ALLOWED_EXTENSIONS = {'png','jfif','pjpeg','jpeg','pjp','jpg'}
def allowed_file(filename):
    return '.' in filename and \
           filename.rsplit('.', 1)[1].lower() in ALLOWED_EXTENSIONS

@app.get('/')
def index():
    return render_template('index.html')
@ext.register_generator
def index():
    yield 'index', {}

@app.get('/about/')
def about():
    return render_template('about.html')
@ext.register_generator
def about():
    yield 'about', {}

@app.get('/contact/')
def contact():
    return render_template('contact.html')
@ext.register_generator
def contact():
    yield 'contact', {}

@app.get('/record/')
def record():
    return render_template('record.html')
@ext.register_generator
def record():
    yield 'record', {}

@app.post('/record/thanks/')
def record_thanks():
    # fileがない場合
    if 'image' not in request.files:
        return render_template(
            'record_thanks.html',
            status='登録できませんでした。ファイルを送信してください。'
            )
    file = request.files['image']

    # filenameが空の場合
    if file.filename == '':
        return render_template(
            'record_thanks.html',
            status='登録できませんでした。ファイルの名前を指定してください。'
            )

    if file and allowed_file(file.filename):
        fileext = os.path.splitext(secure_filename(file.filename))[1]
    else:
        return render_template(
            'record_thanks.html',
            status='登録できませんでした。PNG,JPEGのみ送信できます。'
            )

    id = str(ws.row_count + 1).zfill(5)
    filename = id + fileext
    answer = request.form
    save_data = [
        id,
        answer["email"],
        answer["name"],
        answer["title"],
        filename,
        answer["date"],
        answer["note"],
        answer["no_seven"],
        answer["no_family"]
    ]
    
    ws.append_row(save_data)
    file_send.write(filename,file)
    return render_template(
            'record_thanks.html',
            status='ご登録ありがとうございます。'
            )

@app.get('/privacy-policy/')
def privacy():
    return render_template('privacy-policy.html')
@ext.register_generator
def privacy():
    yield 'privacy', {}

if __name__ == "__main__":
    app.run(port=8000,debug=True)

追記（2022年6月12日）

自分は @TakaiY 様のアドバイスを参考に、ゴリ押しで解決しましたが、それらしきものを見つけたので、後からこの質問を見た方のために残しておきます。
spreadsheet.pyのSpreadsheetクラスの__init__関数内のself._properties.update(metadata["properties"])を叩ければ更新できそうですね。
あとはご自身でお調べいただければと思います。ヒントにでもなれば幸いです。

Answer 1

この動作、2018年にissue(問題のある動作報告)として本家サイトに上ってますが、未解決のようですね。

ということで、これは、現状そういう動作だということです。

ちらっと読んでみると、

シートを読み込みなおすと、row1とrow2の値がきちんと1つ増えるようになりましたが、スプレッドシートへのアクセス数が増えてしまう

とあるように、解決するにはいずれにしてもアクセス数が増えてしまうということにねっているみたいです。
これは、google spreadsheetが複数人で同時に編集できるところを同するかというところにもつながっているようで、一筋縄ではいかないみたいですね。

Comments

[glyzinieh]

回答ありがとうございます。リンク先大変参考になりました。

自分の理解が正しいか分からないのですが、row_countはプロパティを読み出しているだけで、スプレッドシートへのアクセスは発生していないということでしょうか？

[TakaiY]

wsはメモリに読み込まれているはずなので、行の追加はそこになされているでしょう。しかし、row_countの値は更新されないということですね。
updateすることでスプレッドシートへの反映が行なわれて、row_count等の更新もされるのでしょうね。

[glyzinieh]

公式ドキュメント（ https://docs.gspread.org/en/latest/index.html ）を読んだのですが、updateの方法が分かりません。
update()のrange_nameだけ指定して、valuesを指定しないということでしょうか？

[TakaiY]

updateと書いたのは、参照したissueに書いてあったからなのですがupdadeメソッドなどでそれができるかどうかは、詳しいわけではないのでわかりません。
質問にあるように、wsを読込み直すことで更新できるのであれば、それでいいのではないかと思います。スプレッドシードにアクセスせずにやるほうほうは無いんじゃないかと思います。

[glyzinieh]

ありがとうございます。
issueにbatch_update()を使うのように書かれていたと思うのですが、ドキュメントを読んでも、そのようなことが書かれていなかったんですよね…

[TakaiY]

Issueへのコメントとかって、読んでもよくわからないこと多いですよね。的外れなものもあったりするし、文章のうまい人が書いているとも限らないというのもあるでしょうし。(人のこと言えませんが)