mirrors/django
1
0
Fork 0
mirror of https://github.com/django/django.git synced 2025-07-25 14:14:13 +00:00
Code Issues Projects Releases Packages Wiki Activity Actions 4

[4.0.x] Refs #33476 -- Reformatted code with Black.

Browse source 
Backport of 9c19aff7c7 from main.
This commit is contained in:
django-bot 2022-02-08 12:09:55 +01:00 • committed by Mariusz Felisiak
parent e73ce08888
commit 6a682b38e7
1985 changed files with 137777 additions and 94571 deletions
Download patch file Download diff file Expand all files Collapse all files

200
docs/_ext/djangodocs.py
View file

@ -8,7 +8,8 @@ import re
from docutils import nodes
from docutils.parsers.rst import Directive
from docutils.statemachine import ViewList
from sphinx import addnodes, version_info as sphinx_version
from sphinx import addnodes
from sphinx import version_info as sphinx_version
from sphinx.builders.html import StandaloneHTMLBuilder
from sphinx.directives.code import CodeBlock
from sphinx.domains.std import Cmdoption
@ -19,8 +20,7 @@ from sphinx.writers.html import HTMLTranslator
logger = logging.getLogger(__name__)
# RE for option descriptions without a '--' prefix
simple_option_desc_re = re.compile(
r'([-_a-zA-Z0-9]+)(\s*.*?)(?=,\s+(?:/|-|--)|$)')
simple_option_desc_re = re.compile(r"([-_a-zA-Z0-9]+)(\s*.*?)(?=,\s+(?:/|-|--)|$)")
def setup(app):
@ -32,12 +32,12 @@ def setup(app):
app.add_crossref_type(
directivename="templatetag",
rolename="ttag",
indextemplate="pair: %s; template tag"
indextemplate="pair: %s; template tag",
)
app.add_crossref_type(
directivename="templatefilter",
rolename="tfilter",
indextemplate="pair: %s; template filter"
indextemplate="pair: %s; template filter",
)
app.add_crossref_type(
directivename="fieldlookup",
@ -50,13 +50,13 @@ def setup(app):
indextemplate="pair: %s; django-admin command",
parse_node=parse_django_admin_node,
)
app.add_directive('django-admin-option', Cmdoption)
app.add_config_value('django_next_version', '0.0', True)
app.add_directive('versionadded', VersionDirective)
app.add_directive('versionchanged', VersionDirective)
app.add_directive("django-admin-option", Cmdoption)
app.add_config_value("django_next_version", "0.0", True)
app.add_directive("versionadded", VersionDirective)
app.add_directive("versionchanged", VersionDirective)
app.add_builder(DjangoStandaloneHTMLBuilder)
app.set_translator('djangohtml', DjangoHTMLTranslator)
app.set_translator('json', DjangoHTMLTranslator)
app.set_translator("djangohtml", DjangoHTMLTranslator)
app.set_translator("json", DjangoHTMLTranslator)
app.add_node(
ConsoleNode,
html=(visit_console_html, None),
@ -65,10 +65,10 @@ def setup(app):
text=(visit_console_dummy, depart_console_dummy),
texinfo=(visit_console_dummy, depart_console_dummy),
)
app.add_directive('console', ConsoleDirective)
app.connect('html-page-context', html_page_context_hook)
app.add_role('default-role-error', default_role_error)
return {'parallel_read_safe': True}
app.add_directive("console", ConsoleDirective)
app.connect("html-page-context", html_page_context_hook)
app.add_role("default-role-error", default_role_error)
return {"parallel_read_safe": True}
class VersionDirective(Directive):
@ -82,7 +82,9 @@ class VersionDirective(Directive):
if len(self.arguments) > 1:
msg = """Only one argument accepted for directive '{directive_name}::'.
Comments should be provided as content,
not as an extra argument.""".format(directive_name=self.name)
not as an extra argument.""".format(
directive_name=self.name
)
raise self.error(msg)
env = self.state.document.settings.env
@ -91,18 +93,18 @@ class VersionDirective(Directive):
ret.append(node)
if self.arguments[0] == env.config.django_next_version:
node['version'] = "Development version"
node["version"] = "Development version"
else:
node['version'] = self.arguments[0]
node["version"] = self.arguments[0]
node['type'] = self.name
node["type"] = self.name
if self.content:
self.state.nested_parse(self.content, self.content_offset, node)
try:
env.get_domain('changeset').note_changeset(node)
env.get_domain("changeset").note_changeset(node)
except ExtensionError:
# Sphinx < 1.8: Domain 'changeset' is not registered
env.note_versionchange(node['type'], node['version'], node, self.lineno)
env.note_versionchange(node["type"], node["version"], node, self.lineno)
return ret
@ -120,23 +122,25 @@ class DjangoHTMLTranslator(HTMLTranslator):
self._table_row_indices.append(0)
else:
self._table_row_index = 0
self.body.append(self.starttag(node, 'table', CLASS='docutils'))
self.body.append(self.starttag(node, "table", CLASS="docutils"))
def depart_table(self, node):
self.compact_p = self.context.pop()
if sphinx_version >= (4, 3):
self._table_row_indices.pop()
self.body.append('</table>\n')
self.body.append("</table>\n")
def visit_desc_parameterlist(self, node):
self.body.append('(') # by default sphinx puts <big> around the "("
self.body.append("(") # by default sphinx puts <big> around the "("
self.first_param = 1
self.optional_param_level = 0
self.param_separator = node.child_text_separator
self.required_params_left = sum(isinstance(c, addnodes.desc_parameter) for c in node.children)
self.required_params_left = sum(
isinstance(c, addnodes.desc_parameter) for c in node.children
)
def depart_desc_parameterlist(self, node):
self.body.append(')')
self.body.append(")")
#
# Turn the "new in version" stuff (versionadded/versionchanged) into a
@ -148,20 +152,15 @@ class DjangoHTMLTranslator(HTMLTranslator):
# that work.
#
version_text = {
'versionchanged': 'Changed in Django %s',
'versionadded': 'New in Django %s',
"versionchanged": "Changed in Django %s",
"versionadded": "New in Django %s",
}
def visit_versionmodified(self, node):
self.body.append(
self.starttag(node, 'div', CLASS=node['type'])
)
version_text = self.version_text.get(node['type'])
self.body.append(self.starttag(node, "div", CLASS=node["type"]))
version_text = self.version_text.get(node["type"])
if version_text:
title = "%s%s" % (
version_text % node['version'],
":" if len(node) else "."
)
title = "%s%s" % (version_text % node["version"], ":" if len(node) else ".")
self.body.append('<span class="title">%s</span> ' % title)
def depart_versionmodified(self, node):
@ -169,16 +168,16 @@ class DjangoHTMLTranslator(HTMLTranslator):
# Give each section a unique ID -- nice for custom CSS hooks
def visit_section(self, node):
old_ids = node.get('ids', [])
node['ids'] = ['s-' + i for i in old_ids]
node['ids'].extend(old_ids)
old_ids = node.get("ids", [])
node["ids"] = ["s-" + i for i in old_ids]
node["ids"].extend(old_ids)
super().visit_section(node)
node['ids'] = old_ids
node["ids"] = old_ids
def parse_django_admin_node(env, sig, signode):
command = sig.split(' ')[0]
env.ref_context['std:program'] = command
command = sig.split(" ")[0]
env.ref_context["std:program"] = command
title = "django-admin %s" % sig
signode += addnodes.desc_name(title, title)
return command
@ -189,7 +188,7 @@ class DjangoStandaloneHTMLBuilder(StandaloneHTMLBuilder):
Subclass to add some extra things we need.
"""
name = 'djangohtml'
name = "djangohtml"
def finish(self):
super().finish()
@ -197,19 +196,21 @@ class DjangoStandaloneHTMLBuilder(StandaloneHTMLBuilder):
xrefs = self.env.domaindata["std"]["objects"]
templatebuiltins = {
"ttags": [
n for ((t, n), (k, a)) in xrefs.items()
n
for ((t, n), (k, a)) in xrefs.items()
if t == "templatetag" and k == "ref/templates/builtins"
],
"tfilters": [
n for ((t, n), (k, a)) in xrefs.items()
n
for ((t, n), (k, a)) in xrefs.items()
if t == "templatefilter" and k == "ref/templates/builtins"
],
}
outfilename = os.path.join(self.outdir, "templatebuiltins.js")
with open(outfilename, 'w') as fp:
fp.write('var django_template_builtins = ')
with open(outfilename, "w") as fp:
fp.write("var django_template_builtins = ")
json.dump(templatebuiltins, fp)
fp.write(';\n')
fp.write(";\n")
class ConsoleNode(nodes.literal_block):
@ -217,13 +218,14 @@ class ConsoleNode(nodes.literal_block):
Custom node to override the visit/depart event handlers at registration
time. Wrap a literal_block object and defer to it.
"""
tagname = 'ConsoleNode'
tagname = "ConsoleNode"
def __init__(self, litblk_obj):
self.wrapped = litblk_obj
def __getattr__(self, attr):
if attr == 'wrapped':
if attr == "wrapped":
return self.__dict__.wrapped
return getattr(self.wrapped, attr)
@ -240,38 +242,43 @@ def depart_console_dummy(self, node):
def visit_console_html(self, node):
"""Generate HTML for the console directive."""
if self.builder.name in ('djangohtml', 'json') and node['win_console_text']:
if self.builder.name in ("djangohtml", "json") and node["win_console_text"]:
# Put a mark on the document object signaling the fact the directive
# has been used on it.
self.document._console_directive_used_flag = True
uid = node['uid']
self.body.append('''\
uid = node["uid"]
self.body.append(
"""\
<div class="console-block" id="console-block-%(id)s">
<input class="c-tab-unix" id="c-tab-%(id)s-unix" type="radio" name="console-%(id)s" checked>
<label for="c-tab-%(id)s-unix" title="Linux/macOS">&#xf17c/&#xf179</label>
<input class="c-tab-win" id="c-tab-%(id)s-win" type="radio" name="console-%(id)s">
<label for="c-tab-%(id)s-win" title="Windows">&#xf17a</label>
<section class="c-content-unix" id="c-content-%(id)s-unix">\n''' % {'id': uid})
<section class="c-content-unix" id="c-content-%(id)s-unix">\n"""
% {"id": uid}
)
try:
self.visit_literal_block(node)
except nodes.SkipNode:
pass
self.body.append('</section>\n')
self.body.append("</section>\n")
self.body.append('<section class="c-content-win" id="c-content-%(id)s-win">\n' % {'id': uid})
win_text = node['win_console_text']
highlight_args = {'force': True}
linenos = node.get('linenos', False)
self.body.append(
'<section class="c-content-win" id="c-content-%(id)s-win">\n' % {"id": uid}
)
win_text = node["win_console_text"]
highlight_args = {"force": True}
linenos = node.get("linenos", False)
def warner(msg):
self.builder.warn(msg, (self.builder.current_docname, node.line))
highlighted = self.highlighter.highlight_block(
win_text, 'doscon', warn=warner, linenos=linenos, **highlight_args
win_text, "doscon", warn=warner, linenos=linenos, **highlight_args
)
self.body.append(highlighted)
self.body.append('</section>\n')
self.body.append('</div>\n')
self.body.append("</section>\n")
self.body.append("</div>\n")
raise nodes.SkipNode
else:
self.visit_literal_block(node)
@ -283,54 +290,54 @@ class ConsoleDirective(CodeBlock):
the second tab shows a Windows command line equivalent of the usual
Unix-oriented examples.
"""
required_arguments = 0
# The 'doscon' Pygments formatter needs a prompt like this. '>' alone
# won't do it because then it simply paints the whole command line as a
# gray comment with no highlighting at all.
WIN_PROMPT = r'...\> '
WIN_PROMPT = r"...\> "
def run(self):
def args_to_win(cmdline):
changed = False
out = []
for token in cmdline.split():
if token[:2] == './':
if token[:2] == "./":
token = token[2:]
changed = True
elif token[:2] == '~/':
token = '%HOMEPATH%\\' + token[2:]
elif token[:2] == "~/":
token = "%HOMEPATH%\\" + token[2:]
changed = True
elif token == 'make':
token = 'make.bat'
elif token == "make":
token = "make.bat"
changed = True
if '://' not in token and 'git' not in cmdline:
out.append(token.replace('/', '\\'))
if "://" not in token and "git" not in cmdline:
out.append(token.replace("/", "\\"))
changed = True
else:
out.append(token)
if changed:
return ' '.join(out)
return " ".join(out)
return cmdline
def cmdline_to_win(line):
if line.startswith('# '):
return 'REM ' + args_to_win(line[2:])
if line.startswith('$ # '):
return 'REM ' + args_to_win(line[4:])
if line.startswith('$ ./manage.py'):
return 'manage.py ' + args_to_win(line[13:])
if line.startswith('$ manage.py'):
return 'manage.py ' + args_to_win(line[11:])
if line.startswith('$ ./runtests.py'):
return 'runtests.py ' + args_to_win(line[15:])
if line.startswith('$ ./'):
if line.startswith("# "):
return "REM " + args_to_win(line[2:])
if line.startswith("$ # "):
return "REM " + args_to_win(line[4:])
if line.startswith("$ ./manage.py"):
return "manage.py " + args_to_win(line[13:])
if line.startswith("$ manage.py"):
return "manage.py " + args_to_win(line[11:])
if line.startswith("$ ./runtests.py"):
return "runtests.py " + args_to_win(line[15:])
if line.startswith("$ ./"):
return args_to_win(line[4:])
if line.startswith('$ python3'):
return 'py ' + args_to_win(line[9:])
if line.startswith('$ python'):
return 'py ' + args_to_win(line[8:])
if line.startswith('$ '):
if line.startswith("$ python3"):
return "py " + args_to_win(line[9:])
if line.startswith("$ python"):
return "py " + args_to_win(line[8:])
if line.startswith("$ "):
return args_to_win(line[2:])
return None
@ -349,23 +356,23 @@ class ConsoleDirective(CodeBlock):
return None
env = self.state.document.settings.env
self.arguments = ['console']
self.arguments = ["console"]
lit_blk_obj = super().run()[0]
# Only do work when the djangohtml HTML Sphinx builder is being used,
# invoke the default behavior for the rest.
if env.app.builder.name not in ('djangohtml', 'json'):
if env.app.builder.name not in ("djangohtml", "json"):
return [lit_blk_obj]
lit_blk_obj['uid'] = str(env.new_serialno('console'))
lit_blk_obj["uid"] = str(env.new_serialno("console"))
# Only add the tabbed UI if there is actually a Windows-specific
# version of the CLI example.
win_content = code_block_to_win(self.content)
if win_content is None:
lit_blk_obj['win_console_text'] = None
lit_blk_obj["win_console_text"] = None
else:
self.content = win_content
lit_blk_obj['win_console_text'] = super().run()[0].rawsource
lit_blk_obj["win_console_text"] = super().run()[0].rawsource
# Replace the literal_node object returned by Sphinx's CodeBlock with
# the ConsoleNode wrapper.
@ -377,7 +384,9 @@ def html_page_context_hook(app, pagename, templatename, context, doctree):
# control inclusion of console-tabs.css and activation of the JavaScript.
# This way it's include only from HTML files rendered from reST files where
# the ConsoleDirective is used.
context['include_console_assets'] = getattr(doctree, '_console_directive_used_flag', False)
context["include_console_assets"] = getattr(
doctree, "_console_directive_used_flag", False
)
def default_role_error(
@ -385,8 +394,7 @@ def default_role_error(
):
msg = (
"Default role used (`single backticks`): %s. Did you mean to use two "
"backticks for ``code``, or miss an underscore for a `link`_ ?"
% rawtext
"backticks for ``code``, or miss an underscore for a `link`_ ?" % rawtext
)
logger.warning(msg, location=(inliner.document.current_source, lineno))
return [nodes.Text(text)], []