mirror of
https://github.com/django/django.git
synced 2025-10-24 22:26:08 +00:00
Started attackign the next flake8 violation
This commit is contained in:
@@ -1,6 +1,7 @@
|
||||
from django.conf import settings
|
||||
from django import http
|
||||
|
||||
|
||||
class XViewMiddleware(object):
|
||||
"""
|
||||
Adds an X-View header to internal HEAD requests -- used by the documentation system.
|
||||
|
||||
@@ -11,6 +11,7 @@ from django.utils.translation import ugettext as _
|
||||
class CustomField(models.Field):
|
||||
description = "A custom field type"
|
||||
|
||||
|
||||
class DescriptionLackingField(models.Field):
|
||||
pass
|
||||
|
||||
|
||||
@@ -16,6 +16,7 @@ except ImportError:
|
||||
else:
|
||||
docutils_is_available = True
|
||||
|
||||
|
||||
def trim_docstring(docstring):
|
||||
"""
|
||||
Uniformly trims leading/trailing whitespace from docstrings.
|
||||
@@ -30,6 +31,7 @@ def trim_docstring(docstring):
|
||||
trimmed = [lines[0].lstrip()] + [line[indent:].rstrip() for line in lines[1:]]
|
||||
return "\n".join(trimmed).strip()
|
||||
|
||||
|
||||
def parse_docstring(docstring):
|
||||
"""
|
||||
Parse out the parts of a docstring. Returns (title, body, metadata).
|
||||
@@ -55,6 +57,7 @@ def parse_docstring(docstring):
|
||||
body = "\n\n".join(parts[1:])
|
||||
return title, body, metadata
|
||||
|
||||
|
||||
def parse_rst(text, default_reference_context, thing_being_parsed=None):
|
||||
"""
|
||||
Convert the string from reST to an XHTML fragment.
|
||||
@@ -92,6 +95,7 @@ ROLES = {
|
||||
'tag': '%s/tags/#%s',
|
||||
}
|
||||
|
||||
|
||||
def create_reference_role(rolename, urlbase):
|
||||
def _role(name, rawtext, text, lineno, inliner, options=None, content=None):
|
||||
if options is None:
|
||||
@@ -102,6 +106,7 @@ def create_reference_role(rolename, urlbase):
|
||||
return [node], []
|
||||
docutils.parsers.rst.roles.register_canonical_role(rolename, _role)
|
||||
|
||||
|
||||
def default_reference_role(name, rawtext, text, lineno, inliner, options=None, content=None):
|
||||
if options is None:
|
||||
options = {}
|
||||
|
||||
@@ -21,10 +21,12 @@ from django.utils.translation import ugettext as _
|
||||
# Exclude methods starting with these strings from documentation
|
||||
MODEL_METHODS_EXCLUDE = ('_', 'add_', 'delete', 'save', 'set_')
|
||||
|
||||
|
||||
class GenericSite(object):
|
||||
domain = 'example.com'
|
||||
name = 'my site'
|
||||
|
||||
|
||||
@staff_member_required
|
||||
def doc_index(request):
|
||||
if not utils.docutils_is_available:
|
||||
@@ -33,6 +35,7 @@ def doc_index(request):
|
||||
'root_path': urlresolvers.reverse('admin:index'),
|
||||
}, context_instance=RequestContext(request))
|
||||
|
||||
|
||||
@staff_member_required
|
||||
def bookmarklets(request):
|
||||
admin_root = urlresolvers.reverse('admin:index')
|
||||
@@ -41,6 +44,7 @@ def bookmarklets(request):
|
||||
'admin_url': "%s://%s%s" % (request.scheme, request.get_host(), admin_root),
|
||||
}, context_instance=RequestContext(request))
|
||||
|
||||
|
||||
@staff_member_required
|
||||
def template_tag_index(request):
|
||||
if not utils.docutils_is_available:
|
||||
@@ -76,6 +80,7 @@ def template_tag_index(request):
|
||||
'tags': tags
|
||||
}, context_instance=RequestContext(request))
|
||||
|
||||
|
||||
@staff_member_required
|
||||
def template_filter_index(request):
|
||||
if not utils.docutils_is_available:
|
||||
@@ -111,6 +116,7 @@ def template_filter_index(request):
|
||||
'filters': filters
|
||||
}, context_instance=RequestContext(request))
|
||||
|
||||
|
||||
@staff_member_required
|
||||
def view_index(request):
|
||||
if not utils.docutils_is_available:
|
||||
@@ -141,6 +147,7 @@ def view_index(request):
|
||||
'views': views
|
||||
}, context_instance=RequestContext(request))
|
||||
|
||||
|
||||
@staff_member_required
|
||||
def view_detail(request, view):
|
||||
if not utils.docutils_is_available:
|
||||
@@ -166,6 +173,7 @@ def view_detail(request, view):
|
||||
'meta': metadata,
|
||||
}, context_instance=RequestContext(request))
|
||||
|
||||
|
||||
@staff_member_required
|
||||
def model_index(request):
|
||||
if not utils.docutils_is_available:
|
||||
@@ -176,6 +184,7 @@ def model_index(request):
|
||||
'models': m_list
|
||||
}, context_instance=RequestContext(request))
|
||||
|
||||
|
||||
@staff_member_required
|
||||
def model_detail(request, app_label, model_name):
|
||||
if not utils.docutils_is_available:
|
||||
@@ -278,6 +287,7 @@ def model_detail(request, app_label, model_name):
|
||||
'fields': fields,
|
||||
}, context_instance=RequestContext(request))
|
||||
|
||||
|
||||
@staff_member_required
|
||||
def template_detail(request, template):
|
||||
templates = []
|
||||
@@ -307,10 +317,12 @@ def template_detail(request, template):
|
||||
# Helper functions #
|
||||
####################
|
||||
|
||||
|
||||
def missing_docutils_page(request):
|
||||
"""Display an error message for people without docutils"""
|
||||
return render_to_response('admin_doc/missing_docutils.html')
|
||||
|
||||
|
||||
def load_all_installed_template_libraries():
|
||||
# Load/register all template tag libraries from installed apps.
|
||||
for module_name in template.get_templatetags_modules():
|
||||
@@ -329,6 +341,7 @@ def load_all_installed_template_libraries():
|
||||
except template.InvalidTemplateLibrary:
|
||||
pass
|
||||
|
||||
|
||||
def get_return_data_type(func_name):
|
||||
"""Return a somewhat-helpful data type given a function name"""
|
||||
if func_name.startswith('get_'):
|
||||
@@ -338,6 +351,7 @@ def get_return_data_type(func_name):
|
||||
return 'Integer'
|
||||
return ''
|
||||
|
||||
|
||||
def get_readable_field_data_type(field):
|
||||
"""Returns the description for a given field type, if it exists,
|
||||
Fields' descriptions can contain format strings, which will be interpolated
|
||||
@@ -345,6 +359,7 @@ def get_readable_field_data_type(field):
|
||||
|
||||
return field.description % field.__dict__
|
||||
|
||||
|
||||
def extract_views_from_urlpatterns(urlpatterns, base=''):
|
||||
"""
|
||||
Return a list of views from a list of urlpatterns.
|
||||
@@ -371,6 +386,7 @@ def extract_views_from_urlpatterns(urlpatterns, base=''):
|
||||
named_group_matcher = re.compile(r'\(\?P(<\w+>).+?\)')
|
||||
non_named_group_matcher = re.compile(r'\(.*?\)')
|
||||
|
||||
|
||||
def simplify_regex(pattern):
|
||||
"""
|
||||
Clean up urlpattern regexes into something somewhat readable by Mere Humans:
|
||||
|
||||
Reference in New Issue
Block a user