Djangoで主キーを自作することは非推奨なのでしょうか

Question

DjangoではModelのフィールドとして

abc_id = models.AutoField(primary_key=True)

と指定することで、自作の主キーを設定できます。

しかしこの場合に、以下ドキュメントの'主キーの自動インクリメント'に記載ある主キーの取得をおこなった場合、
Django Ver.1公式ドキュメント　※余談【Question.0.5】　Version1の古いドキュメントにしか本機能の説明はないように思われました。　こういった場合は仕方なく古いバージョンを参考にするほかないのでしょうか　皆さんはどのように仕様確認をされていますか。

以下のように取得を試みましたが、主キーの取得が適いませんでした。

form.save()
print(form.id)#以下のエラーが発生します。
print(form.abc_id)#このようにしても以下のようなエラーが発生します。
print(form.pk)#このようにしても以下のようなエラーが発生します。

AttributeError　'Form' object has no attribute 'id'

**【Question.1】**これはsaveメソッドの戻り値を返す仕様（戻り値のオブジェクト）にオリジナルの主キーを返す仕様になっていないためかと思っているのですが、認識の誤りはありませんでしょうか。
※abc_idを設定せず、print(form.id)と呼び出せば問題なく主キーが返ってくる

saveメソッド呼び出し時の主キーを確認したいといった意向は
「登録時のログにレコードの主キーを表示させたい」や
「リレーションされた複数のテーブルに同時に登録する」などといった機能を作るうえで、とても一般的なものだと思います。

**【Question.2】**主キーを自作するたびに、saveメソッドをオーバーライドする必要があるのでは無駄に手間がかかってしまいます。
つまりDjangoでは自前の主キーを設定させることは推奨されないといったことでしょうか
どのテーブルの主キーも一律に'id'であると、リレーションテーブル間のやりとりなど、わかりにくくなりそうですが、皆さんはどのように試行錯誤されていますか。

Comments

[hoshi-takanori]

Django 詳しくないのですが、とりあえず 3.1 のドキュメントにも記述はありますね。
https://docs.djangoproject.com/en/3.1/topics/db/models/#automatic-primary-key-fields

> どのテーブルの主キーも一律に'id'であると、リレーションテーブル間のやりとりなど、わかりにくくなりそう
そんなことはないと思いますが…。

[Madai]

確認までして頂いて、ありがとうございます。
説明がわかりづらいですね。　すみません。

最新公式ドキュメントで見当たらなかった内容は”自動主キーフィールドの設定方法”ではなく、”自動主キーフィールドを持つレコードの登録時に、自動で設定された主キーを参照する方法”でした。
この機能について、再度公式ドキュメントを確認してみましたが、記載が見当たりませんでした。
（version1の記述では　”>>> b2.id # 新たに保存されたオブジェクトの ID を返します。”の部分です　）

異なるテーブルごとに同じ命名のフィールドが解りやすいか否かは、感覚の問題になってきますかね。。

Answer 1

非推奨ではありません。
UUIDFieldをモデルの主キーフィールドとしてよく使用しています。
ModelとFormを混同しているように思われます。

AutoField系のフィールドをモデルの主キーとした場合、登録時にモデルの主キーが採番されます。

質問のformがModelFormであれば、下記の様にすることで、登録（更新）したモデルインスタンスを取得できます。

instance = form.save()

また、ModelFormの場合、モデルのどのフィールドをフォームで表示するか指定する必要があります。

ModelForm

主キーを自作するたびに、saveメソッドをオーバーライドする必要がある

AutoField系のモデルフィールド以外を主キーにしても、特にsaveメソッドをオーバーライドする必要はありません。

Comments

[Madai]

主キーの自作が非推奨なんて、勝手の悪い仕様ではなくて、安心しました。
ご教示いただいた内容にて、登録時の主キー取得が適いました。
〇
instance = form.save()
print(instance.id)

×
form.save()
print(form.id)

Version1からは仕様が少し変わっているようですね。　　ありがとうございました！