Flaskで作成したExcelファイルをクライアントにダウンロードしたときにファイルが破損していて開けない

Question

現在、Flaskを使ったWebアプリを作成しています。

サーバーでExcelフィアルを作成してそのExcelファイルをクライアントにダウンロードして開きたいのですが、Excelファイルをダウンロードすると毎回Excelファイルが破損して開けません。
Excelファイルの作成はopenpyxlを使っています。

サーバーで作成されたExcelファイルをサーバーから直接WinSCP経由で取得すると問題なくファイルを開くことができます。

Excelファイルに挿入するデータが原因なのかと思いExcelファイルに何も書き込まない状態でExcelファイルを生成しクライアントにダウンロードするように変更し動作させました。しかし、ファイルが破損してひらけません。なので書き込むデータが原因ではないと思われます。

また、VSCodeの拡張機能を使ってVSCode内で破損していると表示がでてくるExcelファイルを開くとデータを挿入したExcelファイルでも正常に見ることができます。

以下が該当部分のソースコードになります

@app.route('/write_log',methods=["GET","POST"])
@login_required
def write_log():

   ・・・データを取得する処理・・・

    # Excelファイルの作成
    XLSX_MIMETYPE = 'application/vnd.openxmlformats-officedocument.spreadsheetml.sheet'
    wb = openpyxl.Workbook()
    worksheet = wb.active
    worksheet.title = "ログの出力"
    
    ・・・ 取得データの挿入・・・
    
     # 列幅自動調整
     for col in worksheet.columns:
         max_length = 0
         column = col[0].column_letter
         for cell in col:
             if len(str(cell.value)) > max_length:
                 max_length = len(str(cell.value))

         adjusted_width = (max_length + 2) * 2.5
         worksheet.column_dimensions[column].width = adjusted_width
     # フィルターの調整
     worksheet.auto_filter.ref = 'A1:F1'
     # 書き込みファイル名とその設定
     now = datetime.datetime.now()
     d = now.strftime('%Y%m%d%H%M%S')
     downloadFileName = f"{d}.xlsx"
     # 出力先ストリームの設定
     output = BytesIO()
     # ワークブックをメモリ上に保存
     wb.save(output)
     wb.close()
     output.seek(0)

     # バイトでファイルをDLする
     return send_file(
           BytesIO(output.getvalue()),
           download_name=downloadFileName,
           as_attachment=True,
           mimetype = XLSX_MIMETYPE)

〇動作環境
サーバー：さくらサーバー（CGIを使用）
Python：3.8.12
モジュール情報
a2wsgi 1.10.7
alembic 1.13.1
anyio 4.5.0
blinker 1.8.2
certifi 2021.10.8
cffi 1.15.0
chardet 4.0.0
click 8.1.7
cryptography 2.9.2
et-xmlfile 1.1.0
exceptiongroup 1.2.2
fail2ban 0.11.2
fastapi 0.115.0
Flask 3.0.3
Flask-Login 0.6.3
Flask-Migrate 4.0.7
Flask-SQLAlchemy 3.1.1
Flask-WTF 1.2.1
greenlet 3.0.3
idna 2.10
importlib_metadata 7.1.0
importlib_resources 6.4.0
itsdangerous 2.2.0
Jinja2 3.1.4
Mako 1.3.5
MarkupSafe 2.1.5
openpyxl 3.1.4
pip 24.2
pycparser 2.21
pydantic 1.10.18
pyinotify 0.9.6
PyMySQL 1.0.2
pyOpenSSL 20.0.1
PySocks 1.7.1
requests 2.25.1
setuptools 57.0.0
six 1.16.0
sniffio 1.3.1
SQLAlchemy 2.0.30
sqlite3 0.0.0
starlette 0.38.5
typing_extensions 4.12.2
urllib3 1.26.7
Werkzeug 3.0.3
wheel 0.43.0
WTForms 3.1.2
zipp 3.19.2

Excelに挿入するデータに関して公開できないものなので省略させていただきました。申し訳ございません。

こちらに質問を掲載することに慣れてなく拙い文章でうまく伝わっているか分かりませんがよろしくお願いいたします。

Excelではこういった画面が表示されて「はい」を押すとExcelでファイルは開かれずフリーズします。

Comments

[bsdfan]

mime-type の文字列に typo があるようですが、それが原因だったりしませんか？
それと、seek(0) するのは close() のあとの方がいいのではないでしょうか。

[violet]

ご確認していただきありがとうございます。

bsdfan様のおっしゃる「mime-type の文字列に typo がある」とはどういった意味でしょうか。教えていただけると幸いです。

また、「seek(0) するのは close() のあとの方がいいのではないでしょうか。」に関してはコードを
ーーーーーーーーーーーーーー
wb.save(output)
wb.close()
output.seek(0)
ーーーーーーーーーーーーーー
に変えて動かしてみましたが、現状動作は変わっていません。
質問のコードは上記のように変更しました。

よろしくお願いいたします。

[bsdfan]

typo とはタイプミスのことです。officedocument となるべきところの o が抜けています。

[violet]

申し訳ございませんでした。
そちらは私がこちらのサイトに転記する際のミスタイプでした。
コードを修正しました。申し訳ございませんでした。

よろしくお願いいたします。

[quickquip]

> サーバーでExcelフィアルを作成してそのExcelファイルをクライアントにダウンロードして開きたいのですが、Excelファイルをダウンロードすると毎回Excelファイルが破損して開けません。
> また、VSCodeの拡張機能を使ってVSCode内で破損していると表示がでてくるExcelファイルを開くと

このあたりを見るといかにもサーバにファイルを作成しているように読めますが、"該当のソースコード"はこんな動作をしていませんよね。このコードはいったい何だと思って読んだらいいのでしょう?

[quickquip]

あとダウンロードしたファイルはzipファイルの形式になっているのでしょうか? (xlsxはzipファイルです)
「zipだけど中が壊れている」のか「zipになってない」のか、後者なら実際中身はなんなのか、はバイナリエディタなどを使って見てみるべきだと思います。

[violet]

確認していただきありがとうございます。
＞サーバにファイルを作成しているように読めます
私の文書の書き方が悪かったです。申し訳ございません。
正確にはこのwebアプリの「~/write_log」パスにアクセスするとサーバー内に一時ファイルを作成して、その作成したファイルをクライアントにダウンロードするというプログラムと理解しております。

＞ダウンロードしたファイルはzipファイルの形式になっているのでしょうか? (xlsxはzipファイルです)
Excelのファイルがzipファイルなのはなんとなく知っているという程度で、正直そこまで詳しくは理解しておりません。
クライアントにダウンロードしたExcelファイルを以下のサイト
https://www.arktran.com/BackNumber001.html
の手順で「手動によるofficeファイルの更新手順」を行ったところ正常にExcelファイルを開くことが確認できました。

私の理解と知識不足と思っております。
よろしくお願いいたします。

[violet]

Excelファイルをzipにして解凍したあとにその解凍したフォルダー内の「xl/workbook.xml」のシート名が文字化けしていたのを発見したので本日、Excelのシート名を全角文字を含めず
----------------------------------------------
# Excelファイルの作成
XLSX_MIMETYPE = 'application/vnd.openxmlformats-officedocument.spreadsheetml.sheet'
wb = openpyxl.Workbook()
worksheet = wb.active
worksheet.title = "ログの出力"　　←この部分
----------------------------------------------

の部分を

----------------------------------------------
# Excelファイルの作成
XLSX_MIMETYPE = 'application/vnd.openxmlformats-officedocument.spreadsheetml.sheet'
wb = openpyxl.Workbook()
worksheet = wb.active
worksheet.title = "log"　　←この部分
----------------------------------------------
に変更しました。
クライアントにダウンロードした後にクライアント側で開こうとするとファイルは破損しているとダイアログ表示されますが、修復をすると正常にファイルは表示されました。
よろしくお願いいたします。

[bsdfan]

> サーバー内に一時ファイルを作成して、その作成したファイルをクライアントにダウンロードする
質問に書かれているプログラムでは、一時ファイルは作成せず、(BytesIOを使って)メモリ上だけで完結しています。

> サーバーで作成されたExcelファイルをサーバーから直接WinSCP経由で取得すると問題なく
これで取得したファイルはどれのことでしょうか、という質問がでてきます。
(一時ファイルを作成するようなプログラムに変更して試されたのかなと思っていたのですが、上記のようなコメントがでてくるということは違っているのでしょうか？)

xlsx を作る部分に問題があるのか、Flaskでの転送に問題があるのか、切り分けれるようなことを試す必要があります。

[violet]

ご確認ありがとうございます。
＞サーバーで作成されたExcelファイルをサーバーから直接WinSCP経由で取得すると問題なく
これで取得したファイルはどれのことでしょうか
私の説明不足でした。申し訳ございません。bsdfan様のおっしゃる通りで一時ファイルを作成するようなプログラムに変更して実施しました。
私の書き方が悪かったのが原因です。申し訳ございません。

以下に私の行った作業をまとめました。
（１）BytesIOを使ってメモリ上で完結したかったので質問に張り付けたコードを作成して動作させた
→クライアントにExcelファイルをダウンロードし開いたところファイルが破損して開けなった

（２）Excelファイルの生成に問題があるのかと思いBytesIOではなくサーバ内にExcelファイルを生成するようにプログラムを以下に変更
ーーーーーー変更前コードーーーーーーー
# 書き込みファイル名とその設定
now = datetime.datetime.now()
d = now.strftime('%Y%m%d%H%M%S')
downloadFileName = f"{d}.xlsx"
# 出力先ストリームの設定
output = BytesIO()
# ワークブックをメモリ上に保存
wb.save(output)
wb.close()
output.seek(0)
# バイトでファイルをDLする
return send_file(
BytesIO(output.getvalue()),
download_name=downloadFileName,
as_attachment=True,
mimetype = XLSX_MIMETYPE)
ーーーーーーーーーーーーーーーーーーー

ーーーーーー変更後コードーーーーーーー
# 書き込みファイル名とその設定
now = datetime.datetime.now()
d = now.strftime('%Y%m%d%H%M%S')
downloadFileName = f"{d}.xlsx"
# ワークブックを保存
wb.save(downloadFileName)
wb.close()
# ファイルをDLする
return send_file(
downloadFileName,
download_name=downloadFileName,
as_attachment=True,
mimetype = XLSX_MIMETYPE)
ーーーーーーーーーーーーーーーーーーー
→生成したExcelファイルをWinSCP経由で取得してファイルを開いたところ問題なく開けた

（３）（２）の変更前コードにコードを戻してシート名を半角文字に変更
---------------変更前-------------------------
# Excelファイルの作成
XLSX_MIMETYPE = 'application/vnd.openxmlformats-officedocument.spreadsheetml.sheet'
wb = openpyxl.Workbook()
worksheet = wb.active
worksheet.title = "ログの出力"　　←この部分
----------------------------------------------

----------------変更後------------------------
# Excelファイルの作成
XLSX_MIMETYPE = 'application/vnd.openxmlformats-officedocument.spreadsheetml.sheet'
wb = openpyxl.Workbook()
worksheet = wb.active
worksheet.title = "log"　　←この部分
----------------------------------------------
→クライアントにダウンロードした後にクライアント側で開こうとするとファイルは破損しているとダイアログ表示されますが、修復をすると正常にファイルは表示されました。

現状をまとめるとこのような感じです。
不慣れで拙い文章で申し訳ございません。よろしくお願いいたします。

Answer 1

Excelファイルをゼロから生成していいましたが、もともと何もデータを挿入していないブックをテンプレートとしてサーバー内に保存しておき、そのファイルにデータを挿入→メモリ上に保存という風にプログラムを変更したらExcelのファイルが破損することは無くなりました。
以下がコードです

・・・省略・・・

# Excelファイルの読み込み
XLSX_MIMETYPE = 'application/vnd.openxmlformats-officedocument.spreadsheetml.sheet'
wb=openpyxl.load_workbook('temp_log.xlsx')
worksheet=wb.active

・・・データの挿入・・・
                
# 出力先ストリームの設定
output = BytesIO()
# ワークブックをメモリ上に保存
wb.save(output)
output.seek(0)
wb.close()

# 書き込みファイル名とその設定
now = datetime.datetime.now()
d = now.strftime('%Y%m%d%H%M%S')
downloadFileName = f"{current_user.class_name}_{d}.xlsx"

return send_file(
        BytesIO(output.getvalue()),
        download_name=downloadFileName,
        as_attachment=True,
        mimetype = XLSX_MIMETYPE,
        conditional=True
        )

ご意見を下さったbsdfan様ありがとうございました。