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

Question

##質問

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),
]

Answer 1

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

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

Comments

[attakei]

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

こっちに関しては、urls()には @property デコレータがついているので、urlsのままで文字列が返るためかと思います。

[quickquip]

確かにその通りですね。

[fukazume]

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

[fukazume]

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

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

[fukazume]

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