SQLAlchemy のカラム名に全角英数字がある場合のTypeError

Question

実現したいこと

SQLiteに全角英数字を含むカラム名があるとき、エラーを出さずにデータを追加したい
（カラム名には「明細ＩＤ」や「詳細１」のように全角英数字が含まれている）

元のカラム名を変更せずに対処する方法を教えてください。
SQLAlchemyで問題解決できなければ、他のORMライブラリでも構いません。

発生している問題・分からないこと

TypeError: '明細ID' is an invalid keyword argument for mydata
のエラーが出ます。
全角英数字で指定しているカラム名が半角英数字に変換されてしまっているもよう（変換されないようにするためにはどうすればよいか）

エラーメッセージ

Traceback (most recent call last):
...
  File "/opt/homebrew/Caskroom/miniconda/base/envs/3_10_6/lib/python3.10/site-packages/sqlalchemy/orm/state.py", line 481, in _initialize_instance
    with util.safe_reraise():
  File "/opt/homebrew/Caskroom/miniconda/base/envs/3_10_6/lib/python3.10/site-packages/sqlalchemy/util/langhelpers.py", line 70, in __exit__
    compat.raise_(
  File "/opt/homebrew/Caskroom/miniconda/base/envs/3_10_6/lib/python3.10/site-packages/sqlalchemy/util/compat.py", line 208, in raise_
    raise exception
  File "/opt/homebrew/Caskroom/miniconda/base/envs/3_10_6/lib/python3.10/site-packages/sqlalchemy/orm/state.py", line 479, in _initialize_instance
    return manager.original_init(*mixed[1:], **kwargs)
  File "/opt/homebrew/Caskroom/miniconda/base/envs/3_10_6/lib/python3.10/site-packages/sqlalchemy/orm/decl_base.py", line 1163, in _declarative_constructor
    raise TypeError(
TypeError: '明細ID' is an invalid keyword argument for mydata

該当のソースコード

DATABASE = os.path.expanduser('mydata.sqlite')
Base = automap_base()
engine = sqlalchemy.create_engine(f'sqlite:///{DATABASE}', echo=False)
Base.prepare(engine, reflect=True)
Mydata = Base.classes.mydata
session = Session(bind = engine)
records = []
for record in csv_dict:
    records.append(Mydata(
        明細ＩＤ = record['明細ＩＤ'], #<- 全角英字のカラム名、ここでエラーになる
        金額 = record['金額'],
        詳細１ = record['詳細１'], #<- 全角数字のカラム名、ここでエラーになる
        詳細２ = record['詳細２'])), #<- 全角数字のカラム名、ここでエラーになる
session.add_all(records)
session.commit()

# csv_dictは次のようなdictのlistです
# {'明細ＩＤ': '20001205002', '金額': 165, '詳細１': '手数料', '詳細２': ''}

試したこと・調べたこと

• teratailやGoogle等で検索した
• ソースコードを自分なりに変更した
• 知人に聞いた
• その他

上記の詳細・結果

「python sqlalchemy カラム名に全角英数字」で検索しても同様の問題が見つかりません
「明細ＩＤ」をシングルクウォート、ダブルクウォート、バッククウォートで囲ってみたり、全角英数字の前にバックスラッシュ（エスケープ）を入れたりしたけど、だめでした。

補足

python 3.10.6
SQLAlchemy 1.4.39

Answer 1

https://zenn.dev/alcnaka/articles/1eca6622f121ed

ここの記述を参考にして、以下のようなの追加すると私の所では上手くいきました。

engine = sqlalchemy.create_engine(f'sqlite:///{DATABASE}', echo=False)

import unicodedata
@sqlalchemy.event.listens_for(Base.metadata, "column_reflect")
def column_reflect(inspector, table, column_info):
    column_info['key']=unicodedata.normalize('NFKC', column_info['name'])

Base.prepare(engine, reflect=True)

如何でしょうか。

検証補足

normalizeの内容は
https://note.nkmk.me/python-str-convert-full-half-width/
のようなので

全角数字、半角数字、全角英字、半角英字、全角カタカナ、半角カタカナ、漢字
で確認してみましたが、問題なく登録できました。

また、元々のコードのままだと半角カタカナもエラーで登録できませんでした。

Comments

[NCC1701]

ありがとうございました。うまくいきました。
正規化には思いつかずよい勉強になりました。