[Bf-docboard-svn] bf-manual: [9512] trunk/blender_docs: Cleanup: use raw strings, autopep8 formatting for Python scripts
Campbell Barton
noreply at blender.org
Sat Aug 27 13:42:19 CEST 2022
Revision: 9512
https://developer.blender.org/rBM9512
Author: campbellbarton
Date: 2022-08-27 13:42:18 +0200 (Sat, 27 Aug 2022)
Log Message:
-----------
Cleanup: use raw strings, autopep8 formatting for Python scripts
Modified Paths:
--------------
trunk/blender_docs/exts/peertube.py
trunk/blender_docs/exts/reference.py
trunk/blender_docs/tools_maintenance/blender_help_extract.py
trunk/blender_docs/tools_maintenance/po_shortcuts.py
trunk/blender_docs/tools_maintenance/update_screenshots.py
trunk/blender_docs/tools_rst/rst_check_image_names.py
trunk/blender_docs/tools_rst/rst_check_images.py
trunk/blender_docs/tools_rst/rst_check_spelling.py
trunk/blender_docs/tools_rst/rst_check_syntax.py
trunk/blender_docs/tools_rst/rst_lint.py
Modified: trunk/blender_docs/exts/peertube.py
===================================================================
--- trunk/blender_docs/exts/peertube.py 2022-08-24 15:37:08 UTC (rev 9511)
+++ trunk/blender_docs/exts/peertube.py 2022-08-27 11:42:18 UTC (rev 9512)
@@ -10,19 +10,24 @@
logger = logging.getLogger(__name__)
+
def get_size(d, key):
if key not in d:
return None
- m = re.match("(\d+)(|%|px)$", d[key])
+ m = re.match(r"(\d+)(|%|px)$", d[key])
if not m:
raise ValueError("invalid size %r" % d[key])
return int(m.group(1)), m.group(2) or "px"
+
def css(d):
return "; ".join(sorted("%s: %s" % kv for kv in d.items()))
-class peertube(nodes.General, nodes.Element): pass
+class peertube(nodes.General, nodes.Element):
+ pass
+
+
def visit_peertube_node(self, node):
instance = node["instance"]
aspect = node["aspect"]
@@ -82,9 +87,11 @@
self.body.append(self.starttag(node, "iframe", **attrs))
self.body.append("</iframe></div>")
+
def depart_peertube_node(self, node):
pass
+
def visit_peertube_node_latex(self, node):
instance = node["instance"]
@@ -95,7 +102,11 @@
if instance is None:
instance = self.config.peertube_instance
- self.body.append(r'\begin{quote}\begin{center}\fbox{\url{' + instance + r'videos/watch/%s}}\end{center}\end{quote}'%node['id'])
+ self.body.append(
+ r'\begin{quote}\begin{center}\fbox{\url{' +
+ instance +
+ r'videos/watch/%s}}\end{center}\end{quote}' %
+ node['id'])
class PeerTube(Directive):
@@ -114,7 +125,7 @@
instance = self.options.get("instance")
if "aspect" in self.options:
aspect = self.options.get("aspect")
- m = re.match("(\d+):(\d+)", aspect)
+ m = re.match(r"(\d+):(\d+)", aspect)
if m is None:
raise ValueError("invalid aspect ratio %r" % aspect)
aspect = tuple(int(x) for x in m.groups())
Modified: trunk/blender_docs/exts/reference.py
===================================================================
--- trunk/blender_docs/exts/reference.py 2022-08-24 15:37:08 UTC (rev 9511)
+++ trunk/blender_docs/exts/reference.py 2022-08-27 11:42:18 UTC (rev 9512)
@@ -7,6 +7,7 @@
from sphinx.locale import _
from sphinx.util.docutils import SphinxDirective
+
class refbox(nodes.Admonition, nodes.Element):
pass
@@ -49,12 +50,14 @@
def setup(app):
- app.add_node(refbox,
- html=(visit_refbox_node, depart_refbox_node),
- latex=(visit_refbox_node, depart_refbox_node),
- text=(visit_refbox_node, depart_refbox_node),
- man=(visit_refbox_node, depart_refbox_node),
- texinfo=(visit_refbox_node, depart_refbox_node))
+ app.add_node(
+ refbox,
+ html=(visit_refbox_node, depart_refbox_node),
+ latex=(visit_refbox_node, depart_refbox_node),
+ text=(visit_refbox_node, depart_refbox_node),
+ man=(visit_refbox_node, depart_refbox_node),
+ texinfo=(visit_refbox_node, depart_refbox_node),
+ )
app.add_directive('reference', ReferenceDirective)
Modified: trunk/blender_docs/tools_maintenance/blender_help_extract.py
===================================================================
--- trunk/blender_docs/tools_maintenance/blender_help_extract.py 2022-08-24 15:37:08 UTC (rev 9511)
+++ trunk/blender_docs/tools_maintenance/blender_help_extract.py 2022-08-27 11:42:18 UTC (rev 9512)
@@ -9,7 +9,9 @@
# using primitive regex parsing.
#
# e.g:
-# python tools_maintenance/blender_help_extract.py ../blender/source/creator/creator_args.c manual/advanced/command_line/arguments.rst
+# python tools_maintenance/blender_help_extract.py \
+# ../blender/source/creator/creator_args.c \
+# manual/advanced/command_line/arguments.rst
def text_remove_comments(text):
Modified: trunk/blender_docs/tools_maintenance/po_shortcuts.py
===================================================================
--- trunk/blender_docs/tools_maintenance/po_shortcuts.py 2022-08-24 15:37:08 UTC (rev 9511)
+++ trunk/blender_docs/tools_maintenance/po_shortcuts.py 2022-08-27 11:42:18 UTC (rev 9512)
@@ -145,7 +145,7 @@
with open(filename, 'w', encoding="utf-8") as f:
f.write("".join(text_dst))
- print(filename[filename.find('LC_MESSAGES')+11:] + ':', n_total, 'change(s).')
+ print(filename[filename.find('LC_MESSAGES') + 11:] + ':', n_total, 'change(s).')
if __name__ == "__main__":
Modified: trunk/blender_docs/tools_maintenance/update_screenshots.py
===================================================================
--- trunk/blender_docs/tools_maintenance/update_screenshots.py 2022-08-24 15:37:08 UTC (rev 9511)
+++ trunk/blender_docs/tools_maintenance/update_screenshots.py 2022-08-27 11:42:18 UTC (rev 9512)
@@ -98,6 +98,7 @@
# it's important to postpone so this script can run outside of Blender.
import bpy
+
# ----------------------------------------------------------------------
# Blender Timer Wrapper
Modified: trunk/blender_docs/tools_rst/rst_check_image_names.py
===================================================================
--- trunk/blender_docs/tools_rst/rst_check_image_names.py 2022-08-24 15:37:08 UTC (rev 9511)
+++ trunk/blender_docs/tools_rst/rst_check_image_names.py 2022-08-27 11:42:18 UTC (rev 9512)
@@ -52,11 +52,11 @@
image_regex = re.compile(
r"\.\.\s+"
# |SomeID| (optional)
- "(?:\|([a-zA-Z0-9\-_]+)\|\s+)?"
+ r"(?:\|([a-zA-Z0-9\-_]+)\|\s+)?"
# figure/image::
- "(?:figure|image)\:\:\s+"
+ r"(?:figure|image)\:\:\s+"
# image path
- "/images/(.*?)(\.(?:png|gif|jpg|jpeg|svg))",
+ r"/images/(.*?)(\.(?:png|gif|jpg|jpeg|svg))",
re.MULTILINE
)
Modified: trunk/blender_docs/tools_rst/rst_check_images.py
===================================================================
--- trunk/blender_docs/tools_rst/rst_check_images.py 2022-08-24 15:37:08 UTC (rev 9511)
+++ trunk/blender_docs/tools_rst/rst_check_images.py 2022-08-27 11:42:18 UTC (rev 9512)
@@ -53,11 +53,11 @@
image_regex = re.compile(
r"\.\.\s+"
# |SomeID| (optional)
- "(?:\|([a-zA-Z0-9\-_]+)\|\s+)?"
+ r"(?:\|([a-zA-Z0-9\-_]+)\|\s+)?"
# figure/image::
- "(?:figure|image)\:\:\s+"
+ r"(?:figure|image)\:\:\s+"
# image path
- "/images/(.*?\.(?:png|gif|jpg|jpeg|svg|webp))",
+ r"/images/(.*?\.(?:png|gif|jpg|jpeg|svg|webp))",
re.MULTILINE
)
Modified: trunk/blender_docs/tools_rst/rst_check_spelling.py
===================================================================
--- trunk/blender_docs/tools_rst/rst_check_spelling.py 2022-08-24 15:37:08 UTC (rev 9511)
+++ trunk/blender_docs/tools_rst/rst_check_spelling.py 2022-08-27 11:42:18 UTC (rev 9512)
@@ -133,7 +133,7 @@
Note this doesn't ignore child nodes.
"""
text = '\n'.join(content)
- '''
+ r'''
if re.match(r'.*\n\s*\n', block_text):
warning('doctest-ignore on line %d will not be ignored, '
'because there is\na blank line between ".. doctest-ignore::"'
Modified: trunk/blender_docs/tools_rst/rst_check_syntax.py
===================================================================
--- trunk/blender_docs/tools_rst/rst_check_syntax.py 2022-08-24 15:37:08 UTC (rev 9511)
+++ trunk/blender_docs/tools_rst/rst_check_syntax.py 2022-08-27 11:42:18 UTC (rev 9512)
@@ -78,7 +78,7 @@
def warn_role_kbd(fn, data_src):
- """
+ r"""
Report non-conforming uses of the :kbd: role.
kbd editing regex:
Modified: trunk/blender_docs/tools_rst/rst_lint.py
===================================================================
--- trunk/blender_docs/tools_rst/rst_lint.py 2022-08-24 15:37:08 UTC (rev 9511)
+++ trunk/blender_docs/tools_rst/rst_lint.py 2022-08-27 11:42:18 UTC (rev 9512)
@@ -39,7 +39,7 @@
'moduleauthor', 'opcode', 'pdbcommand', 'productionlist',
'program', 'role', 'sectionauthor', 'seealso', 'sourcecode', 'staticmethod',
'tabularcolumns', 'testcode', 'testoutput', 'testsetup', 'toctree', 'todo',
- 'todolist', 'versionadded', 'versionchanged'
+ 'todolist', 'versionadded', 'versionchanged',
]
all_directives = '(' + '|'.join(directives) + ')'
More information about the Bf-docboard-svn
mailing list