获取 Django 项目下全部 URL,一个函数轻松搞定

简介: 获取 Django 项目下全部 URL,一个函数轻松搞定

废话不多说,直接上代码。


from django.urls import get_resolver, URLPattern, URLResolver
def get_all_url(resolver=None, pre='/'):
    if resolver is None:
        resolver = get_resolver()
    for r in resolver.url_patterns:
        if isinstance(r, URLPattern):
            if '<pk>' in str(r.pattern):
                continue
            yield pre + str(r.pattern).replace('^', '').replace('$', ''), r.name
        if isinstance(r, URLResolver):
            yield from get_all_url(r, pre + str(r.pattern))
if __name__ == '__main__':
    # 获取项目全部 url
    for url, name in get_all_url():
        print("url='{}'  name='{}'".format(url, name))
    # 获取某个 app 下的全部 url
    # 假设有一个 app 叫 dashboard
    # 通过 pre 参数传入相应前缀
    for url, name in get_all_url(get_resolver('dashboard.urls')):
        print("url='{}'  name='{}'".format(url, name))
复制代码


其中用到的函数就是 get_resolver,让我们看看源码,这个函数应该怎么用。


# django/urls/resolvers.py
def get_resolver(urlconf=None):
    if urlconf is None:
        urlconf = settings.ROOT_URLCONF
    return _get_cached_resolver(urlconf)
@functools.lru_cache(maxsize=None)
def _get_cached_resolver(urlconf=None):
    return URLResolver(RegexPattern(r'^/'), urlconf)
复制代码


传入参数 urlconf,参数有个默认值 settings.ROOT_URLCONF,打印出来是 myproject.urls,其实就是项目全局下的路由文件。


返回值是 URLResolver 类,这个类就比较复杂了,看了源码也不是很明白应该怎么处理这个类。


# django/urls/resolvers.py
class URLResolver:
    # 省略了一堆代码
    @cached_property
    def urlconf_module(self):
        if isinstance(self.urlconf_name, str):
            return import_module(self.urlconf_name)
        else:
            return self.urlconf_name
    @cached_property
    def url_patterns(self):
        # urlconf_module might be a valid set of patterns, so we default to it
        patterns = getattr(self.urlconf_module, "urlpatterns", self.urlconf_module)
        try:
            iter(patterns)
        except TypeError as e:
            msg = (
                "The included URLconf '{name}' does not appear to have any "
                "patterns in it. If you see valid patterns in the file then "
                "the issue is probably caused by a circular import."
            )
            raise ImproperlyConfigured(msg.format(name=self.urlconf_name)) from e
        return patterns
复制代码


不过还是有一个方法引起了我的注意,毕竟我们要取 url,那跟 url 相关的函数还是要特殊关照一下。


打印一下这个结果,看看有没有发现。


print(get_resolver('myproject.urls').url_patterns)
# 输出
# [
# ...
# <URLPattern 'api/v1/api-doc' [name='api-doc']>, 
# <URLResolver <URLPattern list> (api-docs:api-docs) # 'api/v1/drf-api-doc'>]
复制代码


结果是一个列表,元素有两种,分别是 URLPattern 类和 URLResolver 类。


# django/urls/resolvers.py
class URLPattern:
    def __init__(self, pattern, callback, default_args=None, name=None):
        self.pattern = pattern
        self.callback = callback  # the view
        self.default_args = default_args or {}
        self.name = name
复制代码


前者可以直接就拿 self.pattern 就是对应 url,而后者再递归调用也同样可以拿到结果。


到这里就可以宣布大功告成了。


目录
相关文章
|
3月前
|
搜索推荐 算法 前端开发
美食物管理与推荐系统Python+Django网站开发+协同过滤推荐算法应用【计算机课设项目推荐】
美食物管理与推荐系统Python+Django网站开发+协同过滤推荐算法应用【计算机课设项目推荐】
101 4
美食物管理与推荐系统Python+Django网站开发+协同过滤推荐算法应用【计算机课设项目推荐】
|
1月前
|
数据采集 存储 数据处理
Python爬虫在Django项目中的数据处理与展示实例
Python爬虫在Django项目中的数据处理与展示实例
|
3月前
|
JavaScript
vue项目中统一管理多个后端URL的方法
vue项目中统一管理多个后端URL的方法
43 0
|
3月前
|
iOS开发
iOS App Store 上传项目报错 缺少隐私政策网址 (URL) 解决方法
iOS App Store 上传项目报错 缺少隐私政策网址 (URL) 解决方法
iOS App Store 上传项目报错 缺少隐私政策网址 (URL) 解决方法
|
3月前
|
安全 JavaScript 搜索推荐
【实测】记一次用windows11家庭中文版部署django+vue项目的踩坑之旅
【实测】记一次用windows11家庭中文版部署django+vue项目的踩坑之旅
|
4月前
|
算法 Docker Python
Python【算法中心 03】Docker部署Django搭建的Python应用流程实例(Docker离线安装配置+Django项目Docker部署)
Python【算法中心 03】Docker部署Django搭建的Python应用流程实例(Docker离线安装配置+Django项目Docker部署)
59 0
|
4月前
|
算法 Java Python
Python【算法中心 01】Web框架Django入门(安装+项目创建+应用创建+服务启动)Python搭建算法中心后台实例分享
Python【算法中心 01】Web框架Django入门(安装+项目创建+应用创建+服务启动)Python搭建算法中心后台实例分享
47 0
|
4月前
|
Shell 数据库 Python
删除视图——基于函数的视图 Django
删除视图——基于函数的视图 Django
22 0
|
4月前
|
Shell 数据库 Python
更新视图——基于函数的视图 Django
更新视图——基于函数的视图 Django
24 0
|
4月前
|
Shell 数据库 Python
详细视图——基于函数的视图 Django
详细视图——基于函数的视图 Django
18 0