モデルのフィールド名に数字と記号を使用しても良いかどうか

Question

Djangoでモデルのフィールドを定義する際に、「10%の税込価格」をフィールド名にしたかった場合は、10%_tax_includedと、数字と記号を使用するよりかten_percent_tax_includedとした方が良いでしょうか?
あまり数字と記号を使用したフィールド名は目にしたことがなかった為、使用して良いのかどうか疑問であり質問させて頂きました。

Comments

[otn]

素朴な疑問として、税率が変わったらフィールド名はどうするんでしょう？

[ruuuu]

今回の場合、djangoのカスタムコマンドを作成し、csvへ吐き出す前段階として、一時的にクローリングをしDBへの追加を考えています為、仮に税率が変わった際はフィールド名を変更し、再度クローリングし、データを追加することを考えています

Answer 1

Djangoのモデルで使うフィールド名はpythonの変数の命名ルールに依存します。

こちらのページの「Variable Names」より、
・A variable name must start with a letter or the underscore character
→変数名は文字かアンダースコアから始まっていなければならない
・A variable name cannot start with a number
→変数名は数字から始まってはならない
・A variable name can only contain alpha-numeric characters and underscores (A-z, 0-9, and _ )
→変数名は英数字かアンダースコアのみ含むことができる
・Variable names are case-sensitive (age, Age and AGE are three different variables)
→変数名は大文字と小文字を違う文字として区別する（「age」、「Age」、「AGE」はすべて違う変数）

以上より、数字から始まり、「%」を含む10%_tax_includedは適切なフィールド名ではありません。
質問にあるように、ten_percent_tax_includedなどを使うのがよいと思います。

また、蛇足かもしれませんが質問のコメントで言っている方がいるように、税率は変わることもあるため、税込価格などはフィールドではなくプロパティなどで柔軟に定義するのがよいと思います。

Comments

[ruuuu]

ご回答ありがとうございます。
Djangoのフィールド名専用の命名ルールではなく、Pythonの変数の命名ルールにより、決まってくるという訳ですね。

>また、蛇足かもしれませんが質問のコメントで言っている方がいるように、税率は変わることもあるため、税込価格などはフィールドではなくプロパティなどで柔軟に定義するのがよいと思います。
こちらですが、今回の場合、djangoのカスタムコマンドを作成し、csvへ吐き出す前段階として、一時的にクローリングをしDBへの追加を考えています為、仮に税率が変わった際はフィールド名を変更し、再度クローリングし、データを追加しようと考えています