标签：return get self args request 视图 Django 源码 kwargs
django源码解读之 View View、 ContextMixin、TemplateResponseMixin、TemplateView、RedirectView
View
class View(object):
"""
所有视图的基类
1 简答的请求方啊过滤 所有的请求都应该在被允许的 请求列表 http_method_names 中
2 实现请求的分发，即按照请求的方法，调用对应的视图函数。<eg: get请求 执行self.get()>
"""
# "被允许的请求方式列表"
http_method_names = ['get', 'post', 'put', 'patch', 'delete', 'head', 'options', 'trace']
def __init__(self, **kwargs):
"""
视图的构造函数,kwargs 接受所有的额外的参数
"""
# 遍历所有的关键字参数,并将键作为实例的属性,值作为实例对象的值
for key, value in six.iteritems(kwargs):
setattr(self, key, value)
@classonlymethod # 限制该方法只允许类本身调用 不允许实例对象调用
def as_view(cls, **initkwargs):
"""
返回一个接受请求并返回响应的可调用视图
流程：1 过滤传入的参数是否在http_method_names
2 查看传入的参数是否是self 本身拥有的属性，只允许传入本身拥有的属性，例如:query_set对象
eg: View.as_view(query_set=User.object.all())
在URLconf中指定查询数据集为 User的所有实例
"""
for key in initkwargs: # 遍历所有的传入字段
if key in cls.http_method_names:
# 不允许传入的参数名为 http请求方法名 即http_method_names中定义的
raise TypeError("You tried to pass in the %s method name as a "
"keyword argument to %s(). Don't do that."
% (key, cls.__name__))
if not hasattr(cls, key):
# 不允许传入的参数名为Response/Request没有的属性
raise TypeError("%s() received an invalid keyword %r. as_view "
"only accepts arguments that are already "
"attributes of the class." % (cls.__name__, key))
def view(request, *args, **kwargs):
""" 创建视图函数 初始化视图信息 """
self = cls(**initkwargs) # 实例化视图对象 initkwargs 为as_view()方法传入的参数字典
if hasattr(self, 'get') and not hasattr(self, 'head'):
self.head = self.get # 绑定了get方法的请求对象
self.request = request # WSGI请求对象 <django.core.handlers.wsgi.WSGIRequest>
self.args = args # 位置参数 URL传入的
self.kwargs = kwargs # 关键字参数 URL传入的关键字参数
return self.dispatch(request, *args, **kwargs) # 调用dispatch方法 分发
# 为视图函数添加 view_class 属性 和 view_initkwargs 属性
view.view_class = cls
view.view_initkwargs = initkwargs # <as_view()接收的参数>
# take name and docstring from class
update_wrapper(view, cls, updated=())
# and possible attributes set by decorators
# like csrf_exempt from dispatch
update_wrapper(view, cls.dispatch, assigned=())
return view
def dispatch(self, request, *args, **kwargs):
# Try to dispatch to the right method; if a method doesn't exist,
# defer to the error handler. Also defer to the error handler if the
# request method isn't on the approved list.
# 如果方法被允许
if request.method.lower() in self.http_method_names: # 判断请求WSGIRequest方法是否在允许的方法中。
# 查看实例化对象是否拥有get/post... 或 被 http_method_names 包含的同名属性(方法)。（也就 是说如果继承 View 则需要实现 http_method_names 方法中的一个或多个）
handler = getattr(self, request.method.lower(), self.http_method_not_allowed)
else:
# 否则 抛出警告信息 `Method Not Allowed...`<self.http_method_not_allowed 方法中定义>
handler = self.http_method_not_allowed
# 返回结果
return handler(request, *args, **kwargs)
def http_method_not_allowed(self, request, *args, **kwargs):
# 抛出 警告
logger.warning(
'Method Not Allowed (%s): %s', request.method, request.path,
extra={'status_code': 405, 'request': request}
)
return http.HttpResponseNotAllowed(self._allowed_methods())
def options(self, request, *args, **kwargs):
"""
options（request，* args，** kwargs）¶
处理对OPTIONS HTTP动词的请求的响应。返回一个响应，该响应的Allow标头包含视图的允许的HTTP方法名称的列表。
Handles responding to requests for the OPTIONS HTTP verb.
"""
response = http.HttpResponse()
response['Allow'] = ', '.join(self._allowed_methods())
response['Content-Length'] = '0'
return response
def _allowed_methods(self):
# 列表生成式 如果继承View的类 实现了 http_method_names 中的方法，则会返回大写的方法名列表
# 没有 在 hasattr 不成立。不会反回。
# 也就是说返回的应该是一个 全部被允许的<均实现的>大写的方法列表
return [m.upper() for m in self.http_method_names if hasattr(self, m)]
ContextMixin
class ContextMixin(object):
"""
将接收到的关键字参数 放入上下文中
通常来说继承该类，会重写该方法，更新或添加一些其他的信息，用于模版的渲染
返回 字典类型对象，包含上下文需要的信息。
"""
def get_context_data(self, **kwargs):
# 所有基于类的通用视图的模板上下文都包含一个 view 它是View的实例。
if 'view' not in kwargs:
kwargs['view'] = self
return kwargs
# demo
def get_context_data(**kwargs)
context = super().get_context_data(**kwargs)
context.update({"name": "monkey",
"gender": "male"})
return context
TemplateResponseMixin
class TemplateResponseMixin(object):
"""
为视通指定模板，使得它成为一种可配置的选项，并且可以由子类进一步自定义。
我觉得这是 django 非常高明的设计
"""
template_name = None # 使用的模版名称 HTML文档名 需要写明路径 如果是None django.core.exceptions.ImproperlyConfigured异常。它没有被明确的定义出来在 1.18 版本中
template_engine = None # 渲染模版的引擎 可以指定，在settings中设置的
# 一般是Django自己的或者jinja2
# 1 'django.template.backends.django.DjangoTemplates'
# 2 'django.template.backends.jinja2.Jinja2'
response_class = TemplateResponse # 响应类 通常是默认的TemplateResponse 或其子类 它由
# render_to_response 方法返回 如果需要自定义响应类，可以创建子类，然后指定给 respone_class
content_type = None # 用于响应的MIME。content_type作为关键字参数传递给response_class。默认值为None-表示Django使用'text/html'
def render_to_response(self, context, **response_kwargs):
"""
这个方法的作用是将 HTML 模版和传入的上下文字典 response_kwargs 渲染成为期望的响应对象。最终形成(响应字节流数据) 这一步在HttpRespone中完成。<参看HttpResponseBase 源码解析>
任何额外的参数都将传递给响应类的构造函数。
注意：修改 上下文的 context
因为这需要传入上下文参数字典 context 因此也可以在此时操作 context 来管理上下文中的信息
重写get_context_data()方法和重写此方法都可以，但是重写此方法可定制的东西会更多更灵活也更直接，并且一定不会被覆盖掉。
"""
response_kwargs.setdefault('content_type', self.content_type)
return self.response_class(
request=self.request,
template=self.get_template_names(),
context=context,
using=self.template_engine,
**response_kwargs
)
def get_template_names(self):
"""
返回用于请求的模板名称的列表，必须返回一个列表。
因为此方法在 render_to_response 中 实例化response_class时调用，因此
如果render_to_response被覆盖，则可能不会被调用。
"""
if self.template_name is None: # 如果没有值 报错～
raise ImproperlyConfigured(
"TemplateResponseMixin requires either a definition of "
"'template_name' or an implementation of 'get_template_names()'")
else:
return [self.template_name] # 必须返回列表
TemplateView
# 推荐用户继承的类
# 遵从 View中 对方法的约束，实现了get方法 它接受URLconf中所有的关键字参数 更新到上下文模版中
# 继承该类需要显示的指定 TemplateResponseMixin 定义的 template_name 的值 否则报错
# 其他属性或方法根据实际需求覆盖
class TemplateView(TemplateResponseMixin, ContextMixin, View):
"""
主要的功能都在父类中实现，自己实现get方法 <View中要求需要实现http_method_names 方法中的一种>。
"""
def get(self, request, *args, **kwargs):
context = self.get_context_data(**kwargs)
return self.render_to_response(context)
RedirectView
# 继承自 View 实现了 get方法， 其他所有的方法来 都会调用get <:感觉调用 写的好繁琐的样子 ～ ～ >
class RedirectView(View):
"""
重定向的类视图，要求是一个GET请求 其他请求都会调用get 来处理
"""
permanent = False # 重定向是否应该是永久的。唯一的区别是返回的HTTP状态代码。如果为True，则重定向将使用状态代码301。如果为False，则重定向将使用状态代码302。默认情况下permanent为False。
url = None # 重定向到的URL
pattern_name = None # 用于反向解析 url别名
query_string = False # 是否将URL携带的查询参数 传递给重定向的 URL True 则传递 否则 丢弃 默认是丢弃的
def get_redirect_url(self, *args, **kwargs):
"""
返回重定向到的URL (会按照query_string来选择是否拼接参数在URL后面)
"""
if self.url: # 如果写了url 拼接参数后直接赋值
url = self.url % kwargs
elif self.pattern_name: # 如果没有 但是写了URL别名 则反向解析路径并填充参数
try:
url = reverse(self.pattern_name, args=args, kwargs=kwargs)
except NoReverseMatch:
return None
else:
return None # 当 url 和 pattern_name 都显示的指定 则返回None
args = self.request.META.get('QUERY_STRING', '') # 去请求中提取get方法的 'QUERY_STRING'字段，没有则为 ''
if args and self.query_string: # 如果拿到了 并且 query_string 为真 则拼接查询字符串 否则 直接返回上一步 拼接好的url 不带查询参数
url = "%s?%s" % (url, args)
return url
def get(self, request, *args, **kwargs):
# get 方法 拿到url 调用 get_redirect_url
url = self.get_redirect_url(*args, **kwargs)
if url: # 如果拿到了URL
if self.permanent: # 永久重定向为 True 则返回 301 False 返回 302
return http.HttpResponsePermanentRedirect(url) # <父类添加 status_code = 301 其父类是 HttpResponse 的子类 本质上是一个 重定向的 响应对象>
else:
return http.HttpResponseRedirect(url) # < 父类添加 status_code = 302 >
else: # 没拿到URL 警告！410 <被请求的资源在服务器上已经不再可用，而且没有任何已知的转发地址。这样的状况应当被认为是永久性的>
logger.warning(
'Gone: %s', request.path,
extra={'status_code': 410, 'request': request}
)
return http.HttpResponseGone() # 返回410
# 所有的请求方式都 调用get方法来处理 <感觉这里的源码好别扭 ， 3.x版本还是这样子～ 查阅文档中和资料也没有人提到 大胆的改了改源码 重写了 disptch 方法能 发现 没什么毛病 ～ 一切都很完美 不晓得框架这样写的目的 可能为了后期维护和扩展吧>
def head(self, request, *args, **kwargs):
return self.get(request, *args, **kwargs)
def post(self, request, *args, **kwargs):
return self.get(request, *args, **kwargs)
def options(self, request, *args, **kwargs):
return self.get(request, *args, **kwargs)
def delete(self, request, *args, **kwargs):
return self.get(request, *args, **kwargs)
def put(self, request, *args, **kwargs):
return self.get(request, *args, **kwargs)
def patch(self, request, *args, **kwargs):
return self.get(request, *args, **kwargs)
标签：return,get,self,args,request,视图,Django,源码,kwargs 来源： https://www.cnblogs.com/monkey-code/p/13129994.html
本站声明： 1. iCode9 技术分享网（下文简称本站）提供的所有内容，仅供技术学习、探讨和分享； 2. 关于本站的所有留言、评论、转载及引用，纯属内容发起人的个人观点，与本站观点和立场无关； 3. 关于本站的所有言论和文字，纯属内容发起人的个人观点，与本站观点和立场无关； 4. 本站文章均是网友提供，不完全保证技术分享内容的完整性、准确性、时效性、风险性和版权归属；如您发现该文章侵犯了您的权益，可联系我们第一时间进行删除； 5. 本站为非盈利性的个人网站，所有内容不会用来进行牟利，也不会利用任何形式的广告来间接获益，纯粹是为了广大技术爱好者提供技术内容和技术思想的分享性交流网站。