Django：urlpatternsのリストを表示するにはどうすればよいですか？

130

「リバース」が調べている現在のurlpatternsを確認するにはどうすればよいですか？

私はうまくいくはずだと思う引数を持つビューでreverseを呼び出していますが、うまくいきません。何があり、なぜ私のパターンがないのかを確認する方法はありますか？

django  django-urls  django-views 
— インタースター
ソース
— pmav99
デバッグモードをオンにして、デバッグ出力でURLのリストを確認しますか？
— ボートコーダー

回答:

181

プロジェクト内のすべてのURLのリストが必要な場合は、まずdjango-extensionsをインストールして、次のように設定に追加する必要があります。

INSTALLED_APPS = (
...
'django_extensions',
...
)

そして、あなたのターミナルでこのコマンドを実行してください

./manage.py show_urls

詳細については、ドキュメントを確認できます。

— ロバート
ソース
3
実際、私は間違っていました。結局、この機能はdjangoによって提供されていません。
— ロバート
TypeError: unsupported operand type(s) for +: 'NoneType' and 'str'
— それから
6
注意：インストール後に追加django_extensionsする必要がありますINSTALLED_APPS
— Owen
80

これを試して：

from django.urls import get_resolver
get_resolver().reverse_dict.keys()

または、まだDjango 1. *を使用している場合：

from django.core.urlresolvers import get_resolver
get_resolver(None).reverse_dict.keys()
— スマイリークリス
ソース
9
これはURLではなくビュー関数を返します
— Ronen Ness
3
それはURLを返すように、代わりにこれを行う：集合（V [1] get_resolver（なし）.reverse_dict.iteritemsにおけるk、V（）のために）
— kloddant
3
またはpython3の場合：set(v[1] for k,v in get_resolver(None).reverse_dict.items())
— プライベート
6
django.core.urlresolversジャンゴ2.0で削除された、とのインポート行を置き換えるfrom django.urls import get_resolver
— hoefling
2
これはもう私にとっては機能していません。私のプロジェクトのURLの小さなサブセットのみを返します
— J__
33

Django> = 2.0ソリューション

私はこの投稿で他の回答をテストしましたが、それらはDjango 2.Xで動作していなかったか、不完全であるか、複雑すぎました。したがって、これは私の考えです：

from django.conf import settings
from django.urls import URLPattern, URLResolver

urlconf = __import__(settings.ROOT_URLCONF, {}, {}, [''])

def list_urls(lis, acc=None):
    if acc is None:
        acc = []
    if not lis:
        return
    l = lis[0]
    if isinstance(l, URLPattern):
        yield acc + [str(l.pattern)]
    elif isinstance(l, URLResolver):
        yield from list_urls(l.url_patterns, acc + [str(l.pattern)])
    yield from list_urls(lis[1:], acc)

for p in list_urls(urlconf.urlpatterns):
    print(''.join(p))

このコードは、他のいくつかのソリューションとは異なり、すべてのURLを出力します。最後のノードだけでなく、フルパスを出力します。例えば：

admin/
admin/login/
admin/logout/
admin/password_change/
admin/password_change/done/
admin/jsi18n/
admin/r/<int:content_type_id>/<path:object_id>/
admin/auth/group/
admin/auth/group/add/
admin/auth/group/autocomplete/
admin/auth/group/<path:object_id>/history/
admin/auth/group/<path:object_id>/delete/
admin/auth/group/<path:object_id>/change/
admin/auth/group/<path:object_id>/
admin/auth/user/<id>/password/
admin/auth/user/
... etc, etc
— セザール・カナッサ
ソース
1
URLとビューの名前を取得したい場合はどうすればよいですか...結果のようなビューの名前とパターンを取得したいので、どうすればよいですか？
— Nathan Ingram
@NathanIngramビューはURLPatternオブジェクトの「callback」プロパティに格納されるため、yield acc + [str(l.pattern)]行をに変更できますyield acc + [str(l.pattern)], l.callback。名前ではなくビュー関数自体を返すことに
— 注意してください
エラーが表示されます：--- >>>> TypeError：シーケンスアイテム0：予期されるstrインスタンス、リストが見つかりました
— Nathan Ingram
@NathanIngram「print（ ''。join（p））」は、文字列のリストではなくタプルのリストになっているため機能しません。「print（ ''。join（p [0]））」を試してください。
— Cesar Canassa
22

Django 1.11、Python 2.7.6

cd to_your_django_project

python manage.pyシェル

次に、次のコードを貼り付けます。

from django.conf.urls import RegexURLPattern, RegexURLResolver
from django.core import urlresolvers
urls = urlresolvers.get_resolver()

def if_none(value):
    if value:
        return value
    return ''

def print_urls(urls, parent_pattern=None):
    for url in urls.url_patterns:
        if isinstance(url, RegexURLResolver):
            print_urls(url, if_none(parent_pattern) + url.regex.pattern)
        elif isinstance(url, RegexURLPattern):
            print(if_none(parent_pattern) + url.regex.pattern)

print_urls(urls)

出力例：

^django-admin/^$
^django-admin/^login/$
^django-admin/^logout/$
^django-admin/^password_change/$
^django-admin/^password_change/done/$
^django-admin/^jsi18n/$
^django-admin/^r/(?P<content_type_id>\d+)/(?P<object_id>.+)/$
^django-admin/^wagtailimages/image/^$
^django-admin/^wagtailimages/image/^add/$
^django-admin/^wagtailimages/image/^(.+)/history/$
^django-admin/^wagtailimages/image/^(.+)/delete/$
^django-admin/^wagtailimages/image/^(.+)/change/$
^django-admin/^wagtailimages/image/^(.+)/$
...
— 小さな哺乳類
ソース
これは私にとって有効な答えですNoneが、行に追加する必要urls = urlresolvers.get_resolver(None)があり、一部のURLの先頭に「なし」が表示されることがありました。
— Chris
17

activestateにレシピがあります

import urls

def show_urls(urllist, depth=0):
    for entry in urllist:
        print("  " * depth, entry.regex.pattern)
        if hasattr(entry, 'url_patterns'):
            show_urls(entry.url_patterns, depth + 1)

show_urls(urls.url_patterns)
— pmav99
ソース
1
最後の行はになるはずですshow_urls(urls.url_patterns)。
— Daniel Quinn
1
私はそうだModuleNotFoundError: No module named 'urls'、なぜ知りませんか？
— アレクセイ2018
1
@Alexeyこれはおそらくdjango 2に関係するものです。これを確認して、答えを更新できますか？
— pmav99
このコードをtest.pyプロジェクトのルートにあるファイルに配置したところ、import urlsこのエラーが発生しました。また、インタープリターで実行すると、このエラーも発生します。
— アレクセイ
これはDjango 1と2の問題でimport urlsはありませんfrom app_name import urls。これはローカルインポートであるため、おそらく実行する必要があります。
— アーロンクライン
16

私は次のコマンドを使用しています：

（Python3 + Django 1.10）

from django.core.management import BaseCommand
from django.conf.urls import RegexURLPattern, RegexURLResolver
from django.core import urlresolvers


class Command(BaseCommand):

    def add_arguments(self, parser):

        pass

    def handle(self, *args, **kwargs):

        urls = urlresolvers.get_resolver()
        all_urls = list()

        def func_for_sorting(i):
            if i.name is None:
                i.name = ''
            return i.name

        def show_urls(urls):
            for url in urls.url_patterns:
                if isinstance(url, RegexURLResolver):
                    show_urls(url)
                elif isinstance(url, RegexURLPattern):
                    all_urls.append(url)
        show_urls(urls)

        all_urls.sort(key=func_for_sorting, reverse=False)

        print('-' * 100)
        for url in all_urls:
            print('| {0.regex.pattern:20} | {0.name:20} | {0.lookup_str:20} | {0.default_args} |'.format(url))
        print('-' * 100)

使用法：

./manage.py showurls

出力例：

----------------------------------------------------------------------------------------------------
| ^(.+)/$              |                      | django.views.generic.base.RedirectView | {} |
| ^(.+)/$              |                      | django.views.generic.base.RedirectView | {} |
| ^(.+)/$              |                      | django.views.generic.base.RedirectView | {} |
| ^(.+)/$              |                      | django.views.generic.base.RedirectView | {} |
| ^(.+)/$              |                      | django.views.generic.base.RedirectView | {} |
| ^(.+)/$              |                      | django.views.generic.base.RedirectView | {} |
| ^static\/(?P<path>.*)$ |                      | django.contrib.staticfiles.views.serve | {} |
| ^media\/(?P<path>.*)$ |                      | django.views.static.serve | {'document_root': '/home/wlysenko/.virtualenvs/programmerHelper/project/media'} |
| ^(?P<app_label>polls|snippets|questions)/$ | app_list             | apps.core.admin.AdminSite.app_index | {} |
| ^(?P<app_label>activity|articles|badges|books|comments|flavours|forum|marks|newsletters|notifications|opinions|polls|questions|replies|snippets|solutions|tags|testing|users|utilities|visits)/reports/$ | app_reports          | apps.core.admin.AdminSite.reports_view | {} |
| ^(?P<app_label>activity|articles|badges|books|comments|flavours|forum|marks|newsletters|notifications|opinions|polls|questions|replies|snippets|solutions|tags|testing|users|utilities|visits)/statistics/$ | app_statistics       | apps.core.admin.AdminSite.statistics_view | {} |
| articles/(?P<slug>[-\w]+)/$ | article              | apps.articles.views.ArticleDetailView | {} |
| book/(?P<slug>[-_\w]+)/$ | book                 | apps.books.views.BookDetailView | {} |
| category/(?P<slug>[-_\w]+)/$ | category             | apps.utilities.views.CategoryDetailView | {} |
| create/$             | create               | apps.users.views.UserDetailView | {} |
| delete/$             | delete               | apps.users.views.UserDetailView | {} |
| detail/(?P<email>\w+@[-_\w]+.\w+)/$ | detail               | apps.users.views.UserDetailView | {} |
| snippet/(?P<slug>[-_\w]+)/$ | detail               | apps.snippets.views.SnippetDetailView | {} |
| (?P<contenttype_model_pk>\d+)/(?P<pks_separated_commas>[-,\w]*)/$ | export               | apps.export_import_models.views.ExportTemplateView | {} |
| download_preview/$   | export_preview_download | apps.export_import_models.views.ExportPreviewDownloadView | {} |
| ^$                   | import               | apps.export_import_models.views.ImportTemplateView | {} |
| result/$             | import_result        | apps.export_import_models.views.ImportResultTemplateView | {} |
| ^$                   | index                | django.contrib.admin.sites.AdminSite.index | {} |
| ^$                   | index                | apps.core.views.IndexView | {} |
| ^jsi18n/$            | javascript-catalog   | django.views.i18n.javascript_catalog | {'packages': ('your.app.package',)} |
| ^jsi18n/$            | jsi18n               | django.contrib.admin.sites.AdminSite.i18n_javascript | {} |
| level/(?P<slug>[-_\w]+)/$ | level                | apps.users.views.UserDetailView | {} |
| ^login/$             | login                | django.contrib.admin.sites.AdminSite.login | {} |
| ^logout/$            | logout               | django.contrib.admin.sites.AdminSite.logout | {} |
| newsletter/(?P<slug>[_\w]+)/$ | newsletter           | apps.newsletters.views.NewsletterDetailView | {} |
| newsletters/$        | newsletters          | apps.newsletters.views.NewslettersListView | {} |
| notification/(?P<account_email>[-\w]+@[-\w]+.\w+)/$ | notification         | apps.notifications.views.NotificationDetailView | {} |
| ^password_change/$   | password_change      | django.contrib.admin.sites.AdminSite.password_change | {} |
| ^password_change/done/$ | password_change_done | django.contrib.admin.sites.AdminSite.password_change_done | {} |
| ^image/(?P<height>\d+)x(?P<width>\d+)/$ | placeholder          | apps.core.views.PlaceholderView | {} |
| poll/(?P<pk>\w{8}-\w{4}-\w{4}-\w{4}-\w{12})/(?P<slug>[-\w]+)/$ | poll                 | apps.polls.views.PollDetailView | {} |
| ^add/$               | polls_choice_add     | django.contrib.admin.options.ModelAdmin.add_view | {} |
| ^(.+)/change/$       | polls_choice_change  | django.contrib.admin.options.ModelAdmin.change_view | {} |
| ^$                   | polls_choice_changelist | django.contrib.admin.options.ModelAdmin.changelist_view | {} |
| ^(.+)/delete/$       | polls_choice_delete  | django.contrib.admin.options.ModelAdmin.delete_view | {} |
| ^(.+)/history/$      | polls_choice_history | django.contrib.admin.options.ModelAdmin.history_view | {} |
| ^add/$               | polls_poll_add       | django.contrib.admin.options.ModelAdmin.add_view | {} |
| ^(.+)/change/$       | polls_poll_change    | django.contrib.admin.options.ModelAdmin.change_view | {} |
| ^$                   | polls_poll_changelist | django.contrib.admin.options.ModelAdmin.changelist_view | {} |
| ^(.+)/delete/$       | polls_poll_delete    | django.contrib.admin.options.ModelAdmin.delete_view | {} |
| ^(.+)/history/$      | polls_poll_history   | django.contrib.admin.options.ModelAdmin.history_view | {} |
| ^$                   | polls_vote_changelist | django.contrib.admin.options.ModelAdmin.changelist_view | {} |
| publisher/(?P<slug>[-_\w]+)/$ | publisher            | apps.books.views.PublisherDetailView | {} |
| question/(?P<slug>[-_\w]+)/$ | question             | apps.questions.views.QuestionDetailView | {} |
| ^add/$               | questions_answer_add | django.contrib.admin.options.ModelAdmin.add_view | {} |
| ^(.+)/change/$       | questions_answer_change | django.contrib.admin.options.ModelAdmin.change_view | {} |
| ^$                   | questions_answer_changelist | django.contrib.admin.options.ModelAdmin.changelist_view | {} |
| ^(.+)/delete/$       | questions_answer_delete | django.contrib.admin.options.ModelAdmin.delete_view | {} |
| ^(.+)/history/$      | questions_answer_history | django.contrib.admin.options.ModelAdmin.history_view | {} |
| ^add/$               | questions_question_add | django.contrib.admin.options.ModelAdmin.add_view | {} |
| ^(.+)/change/$       | questions_question_change | django.contrib.admin.options.ModelAdmin.change_view | {} |
| ^$                   | questions_question_changelist | django.contrib.admin.options.ModelAdmin.changelist_view | {} |
| ^(.+)/delete/$       | questions_question_delete | django.contrib.admin.options.ModelAdmin.delete_view | {} |
| ^(.+)/history/$      | questions_question_history | django.contrib.admin.options.ModelAdmin.history_view | {} |
| ^setlang/$           | set_language         | django.views.i18n.set_language | {} |
| ^add/$               | snippets_snippet_add | django.contrib.admin.options.ModelAdmin.add_view | {} |
| ^(.+)/change/$       | snippets_snippet_change | django.contrib.admin.options.ModelAdmin.change_view | {} |
| ^$                   | snippets_snippet_changelist | django.contrib.admin.options.ModelAdmin.changelist_view | {} |
| ^(.+)/delete/$       | snippets_snippet_delete | django.contrib.admin.options.ModelAdmin.delete_view | {} |
| ^(.+)/history/$      | snippets_snippet_history | django.contrib.admin.options.ModelAdmin.history_view | {} |
| solution/(?P<pk>\w{8}-\w{4}-\w{4}-\w{4}-\w{12})/(?P<slug>[-_\w]+)/$ | solution             | apps.solutions.views.SolutionDetailView | {} |
| suit/(?P<slug>[-\w]+)/$ | suit                 | apps.testing.views.SuitDetailView | {} |
| tag/(?P<name>[-_\w]+)/$ | tag                  | apps.tags.views.TagDetailView | {} |
| theme/(?P<slug>[-_\w]+)/$ | theme                | apps.forum.views.SectionDetailView | {} |
| topic/(?P<slug>[-_\w]+)/$ | topic                | apps.forum.views.TopicDetailView | {} |
| update/$             | update               | apps.users.views.UserDetailView | {} |
| ^r/(?P<content_type_id>\d+)/(?P<object_id>.+)/$ | view_on_site         | django.contrib.contenttypes.views.shortcut | {} |
| writer/(?P<slug>[-_\w]+)/$ | writer               | apps.books.views.WriterDetailView | {} |
----------------------------------------------------------------------------------------------------
— パディムコ
ソース
4
ドキュメントではを使用しないことを推奨していることに注意してくださいprint。代わりにを使用してくださいself.stdout.write。 docs.djangoproject.com/en/1.10/howto/custom-management-commands
— Dustin Wyatt
名前空間を表示/並べ替え、すべてのURLパーツも表示する必要があったため、このコマンドをstackoverflow.com/a/42388839/179581で
— Andrei
1
@Andrei、あなたがあなたの答えから出力を作成した場合、それは他のユーザーに私に対するあなたの方法の利点を見る能力を与えるでしょう
— PADYMKO
7 
def get_resolved_urls(url_patterns):
    url_patterns_resolved = []
    for entry in url_patterns:
        if hasattr(entry, 'url_patterns'):
            url_patterns_resolved += get_resolved_urls(
                entry.url_patterns)
        else:
            url_patterns_resolved.append(entry)
    return url_patterns_resolved

Pythonでmanage.pyシェル

import urls
get_resolved_urls(urls.urlpatterns)
— サンディープ
ソース
4

Django 3.0では、次のように簡単です。

from django.urls import get_resolver
print(get_resolver().url_patterns)

プリント： [<URLPattern '' [name='home']>, <URLPattern '/testing' [name='another_url']>]

— キャメロン・シマ
ソース
3

名前空間、すべてのURLパーツ、列幅の自動調整を（名前空間、名前）で並べ替えて表示するようにSetiのコマンドを拡張しました：https : //gist.github.com/andreif/263a3fa6e7c425297ffee09c25f66b20

import sys
from django.core.management import BaseCommand
from django.conf.urls import RegexURLPattern, RegexURLResolver
from django.core import urlresolvers


def collect_urls(urls=None, namespace=None, prefix=None):
    if urls is None:
        urls = urlresolvers.get_resolver()
    _collected = []
    prefix = prefix or []
    for x in urls.url_patterns:
        if isinstance(x, RegexURLResolver):
            _collected += collect_urls(x, namespace=x.namespace or namespace,
                                       prefix=prefix + [x.regex.pattern])
        elif isinstance(x, RegexURLPattern):
            _collected.append({'namespace': namespace or '',
                               'name': x.name or '',
                               'pattern': prefix + [x.regex.pattern],
                               'lookup_str': x.lookup_str,
                               'default_args': dict(x.default_args)})
        else:
            raise NotImplementedError(repr(x))
    return _collected


def show_urls():
    all_urls = collect_urls()
    all_urls.sort(key=lambda x: (x['namespace'], x['name']))

    max_lengths = {}
    for u in all_urls:
        for k in ['pattern', 'default_args']:
            u[k] = str(u[k])
        for k, v in list(u.items())[:-1]:
            # Skip app_list due to length (contains all app names)
            if (u['namespace'], u['name'], k) == \
                    ('admin', 'app_list', 'pattern'):
                continue
            max_lengths[k] = max(len(v), max_lengths.get(k, 0))

    for u in all_urls:
        sys.stdout.write(' | '.join(
            ('{:%d}' % max_lengths.get(k, len(v))).format(v)
            for k, v in u.items()) + '\n')


class Command(BaseCommand):
    def handle(self, *args, **kwargs):
        show_urls()

注：列の順序はPython 3.6で維持されOrderedDict、古いバージョンでは使用する必要があります。

更新： OrderedDictの新しいバージョンがdjango-🍌sパッケージに含まれるようになりました：https : //github.com/5monkeys/django-bananas/blob/master/bananas/management/commands/show_urls.py

— アンドレイ
ソース
1
django.conf.urlsからインポートRegexURLPattern、RegexURLResolverはdjango> 2.0では有効ではありませんが、要旨を変更して問題を修正しましたthx
— cwhisperer
最近この問題に直面し、要点を更新しました。Django <2.0で実行するには、以前のリビジョンを使用する必要があります。
— Andrei
2

django 2.0のシンプルなソリューション

たとえば、installed_appsの最初のアプリにあるURLを探している場合は、次のようにアクセスできます。

from django.urls import get_resolver
from pprint import pprint

pprint(
    get_resolver().url_patterns[0].url_patterns
)
インポート過ぎる場合ジャンゴ1.作品* get_resolverからdjango.core.urlresolvers。マルシオ、ありがとう！
— フェルナンドコスタベルトルディ
2

Django 1.8、Python 2.7+これらのコマンドをシェルで実行するだけです。Pythonのmanage.pyシェルで次のコードを実行します。

from django.conf.urls import RegexURLPattern, RegexURLResolver
from django.core import urlresolvers
urls = urlresolvers.get_resolver(None)

def if_none(value):
    if value:
        return value
    return ''

def print_urls(urls, parent_pattern=None):
    for url in urls.url_patterns:
        if isinstance(url, RegexURLResolver):
            print_urls(url, if_none(parent_pattern) + url.regex.pattern)
        elif isinstance(url, RegexURLPattern):
            print(if_none(parent_pattern) + url.regex.pattern)

print_urls(urls)
— アディティアサイニ
ソース
1
答えについて詳しく教えてください。
— toshiro92
1
私は私の答えを編集しました、あなたはあなたのシェルでこれを実行しなければなりません。
— Aditya Saini
0

次のような簡単な方法で、プロジェクト内の各アプリケーションからすべてのURLパターンを収集する動的インポートを作成できます。

def get_url_patterns():
    from django.apps import apps

    list_of_all_url_patterns = list()
    for name, app in apps.app_configs.items():
        # you have a directory structure where you should be able to build the correct path
        # my example shows that apps.[app_name].urls is where to look
        mod_to_import = f'apps.{name}.urls'
        try:
            urls = getattr(importlib.import_module(mod_to_import), "urlpatterns")
            list_of_all_url_patterns.extend(urls)
        except ImportError as ex:
            # is an app without urls
            pass

    return list_of_all_url_patterns

list_of_all_url_patterns = get_url_patterns()

最近、このようなものを使用して、アクティブなナビゲーションリンクを表示するテンプレートタグを作成しました。

— ViaTech
ソース
0 
from django.urls.resolvers import RegexPattern,RoutePattern
from your_main_app import urls

def get_urls():
    url_list = []
    for url in urls.urlpatterns:
        url_list.append(url.pattern._regex) if isinstance(url.pattern, RegexPattern) else url_list.append(url.pattern._route)

    return url_list

これyour_main_appは、settings.pyファイルが配置されているアプリの名前です

— nazmul_94_hasan
ソース
弊社のサイトを使用することにより、あなたは弊社のクッキーポリシーおよびプライバシーポリシーを読み、理解したものとみなされます。
Licensed under cc by-sa 3.0 with attribution required.