質問をすることでしか得られない、回答やアドバイスがある。

15分調べてもわからないことは、質問しよう!

ただいまの
回答率

88.04%

Djangoソースの「admin.site.urls」の構成について

解決済

回答 1

投稿 編集

  • 評価
  • クリップ 0
  • VIEW 609

score 75

質問

Djangoのソース構造と、importなどでのモジュール指定の仕方を勉強しています。

その中で、「admin.site.urls」という表記の"パーツ"のフォルダ階層が、Djangoソースコードには見当たらず、代わりにadmin.sitesというモジュール内にurls()メソッドがあるように見えました。

文字列の並びから、表面的に「admin.site」というパッケージ/フォルダ内に「urls」というモジュールがあるのかな、と予想していたのですが、その予想とのズレ(

  • 「site」というフォルダはなく、なぜ「sites」というフォルダがあるのか
  • 「urls」はメソッドなのに、なぜ「urls()」じゃないのか
    )などの疑問が湧いてきました。

もちろん何かしらの意味合いがあってのことだとは思いますが、その背景が私だけではつかめませんでした。

素っ頓狂な質問かとは存じますが、ご不明な点などは、適宜追記してまいりますので、ご解説のほどどうぞよろしくお願い申し上げます。

経緯

当質問のきっかけは、以下のコードを理解しようとしていたときです。

https://docs.djangoproject.com/en/3.1/ref/contrib/admin/

# urls.py
from django.contrib import admin
from django.urls import path

# hook your AdminSite instance into your URLconf. Do this by pointing a given URL at the AdminSite.urls method. It is not necessary to use include().
urlpatterns = [
    path('admin/', admin.site.urls),
]
  • 気になる質問をクリップする

    クリップした質問は、後からいつでもマイページで確認できます。

    またクリップした質問に回答があった際、通知やメールを受け取ることができます。

    クリップを取り消します

  • 良い質問の評価を上げる

    以下のような質問は評価を上げましょう

    • 質問内容が明確
    • 自分も答えを知りたい
    • 質問者以外のユーザにも役立つ

    評価が高い質問は、TOPページの「注目」タブのフィードに表示されやすくなります。

    質問の評価を上げたことを取り消します

  • 評価を下げられる数の上限に達しました

    評価を下げることができません

    • 1日5回まで評価を下げられます
    • 1日に1ユーザに対して2回まで評価を下げられます

    質問の評価を下げる

    teratailでは下記のような質問を「具体的に困っていることがない質問」、「サイトポリシーに違反する質問」と定義し、推奨していません。

    • プログラミングに関係のない質問
    • やってほしいことだけを記載した丸投げの質問
    • 問題・課題が含まれていない質問
    • 意図的に内容が抹消された質問
    • 過去に投稿した質問と同じ内容の質問
    • 広告と受け取られるような投稿

    評価が下がると、TOPページの「アクティブ」「注目」タブのフィードに表示されにくくなります。

    質問の評価を下げたことを取り消します

    この機能は開放されていません

    評価を下げる条件を満たしてません

    評価を下げる理由を選択してください

    詳細な説明はこちら

    上記に当てはまらず、質問内容が明確になっていない質問には「情報の追加・修正依頼」機能からコメントをしてください。

    質問の評価を下げる機能の利用条件

    この機能を利用するためには、以下の事項を行う必要があります。

回答 1

checkベストアンサー

+3

admin.site
https://github.com/django/django/blob/3.1.1/django/contrib/admin/init.py#L10

from django.contrib.admin.sites import AdminSite, site


で、django.contrib.admin.sites.siteを束縛しているオブジェクトに、パッケージadminのグローバルな名前siteを束縛しています。

https://docs.python.org/ja/3/tutorial/modules.html#packages
の下の方

ファイルを含むディレクトリをパッケージをとしてPython に扱わせるには、ファイル __init__.py が必要です。(略) 最も簡単なケースでは __init__.py はただの空ファイルで構いませんが、 __init__.py ではパッケージのための初期化コードを実行したり、後述の __all__ 変数を設定してもかまいません。

このインポート機構が理解できれば追えると思いますが、いかがでしょう?


django.contrib.admin.sites.site
https://github.com/django/django/blob/3.1.1/django/contrib/admin/sites.py#L548

site = DefaultAdminSite()


で名前siteを束縛しているものです。

https://github.com/django/django/blob/3.1.1/django/contrib/admin/sites.py#L540
で「AppConfigから取得したクラス名をインスタンス化したもの」のラッパーの様なので、そのインスタンスがurlsという名前のメソッドを持つことを期待していますね。

(ここからは詳細に見てないので間違っているかもしれません)

クラス名のデフォルト値は、
https://github.com/django/django/blob/3.1.1/django/contrib/admin/apps.py#L10 でしょうか。

そうするとクラス定義が
https://github.com/django/django/blob/3.1.1/django/contrib/admin/sites.py#L32
でurlsの定義は
https://github.com/django/django/blob/3.1.1/django/contrib/admin/sites.py#L294
でしょう。


「urls」はメソッドなのに、なぜ「urls()」じゃないのか

プロパティという機能です。
https://docs.python.org/ja/3/library/functions.html#property のParrotの例を見てください。

実行例

>>> class Parrot:
...     def __init__(self):
...         self._voltage = 100000
...
...     @property
...     def voltage(self):
...         """Get the current voltage."""
...         return self._voltage

>>> p = Parrot()

>>> print(p.voltage)
100000

(以下残しておきますが無視してください)

u = 'abab'.upper

print(u())  # => ABAB


が分かれば問題なく理解できると思います。

投稿

編集

  • 回答の評価を上げる

    以下のような回答は評価を上げましょう

    • 正しい回答
    • わかりやすい回答
    • ためになる回答

    評価が高い回答ほどページの上位に表示されます。

  • 回答の評価を下げる

    下記のような回答は推奨されていません。

    • 間違っている回答
    • 質問の回答になっていない投稿
    • スパムや攻撃的な表現を用いた投稿

    評価を下げる際はその理由を明確に伝え、適切な回答に修正してもらいましょう。

  • 2020/09/11 20:41

    詳細なご回答をいただき、誠にありがとうございます!こちらを今晩じっくりと読み、理解を深めたいと思います。理解がすぐには追いつかず心苦しいですが、ひとまず当質問をクローズするまでどうぞよろしくお願い申しあげます!

    キャンセル

  • 2020/09/12 21:26

    quickquipさまへ
    考え方の着目点、順序まで丁寧にご解説くださいまして誠にありがとうございました!

    単にフォルダ構造ではなく、パッケージの__init__.py内のimport構造とimport対象のクラス等を読み進めることによりパッケージ構成を理解していく手法、更にはurlsは@propertyデコレータによるプロパティであったということも大変に勉強になりました。改めまして深く御礼申し上げますm(__)m

    キャンセル

  • 2020/09/12 21:26 編集

    attakeiさまへ
    質問をお読みいただき、さらにはコメントをいただき、どうもありがとうございました!

    キャンセル

15分調べてもわからないことは、teratailで質問しよう!

  • ただいまの回答率 88.04%
  • 質問をまとめることで、思考を整理して素早く解決
  • テンプレート機能で、簡単に質問をまとめられる

関連した質問

同じタグがついた質問を見る