From 11eeb095dc8fe09eef934b8c8bd6af22e1aa5854 Mon Sep 17 00:00:00 2001 From: iabdalkader Date: Tue, 27 Apr 2021 01:15:43 +0200 Subject: [PATCH] tools/gen-cpydiff.py: Fix formatting of doc strings for new Black. Since version 21.4b0, Black now processes one-line docstrings by stripping leading and trailing spaces, and adding a padding space when needed to break up """"; see https://github.com/psf/black/pull/1740 This commit makes the Python code in this repository conform to this rule. --- tools/gen-cpydiff.py | 14 +++++++------- 1 file changed, 7 insertions(+), 7 deletions(-) diff --git a/tools/gen-cpydiff.py b/tools/gen-cpydiff.py index 4ba46d2a6e..127c41ce1c 100644 --- a/tools/gen-cpydiff.py +++ b/tools/gen-cpydiff.py @@ -74,7 +74,7 @@ def readfiles(): - """ Reads test files """ + """Reads test files""" tests = list(filter(lambda x: x.endswith(".py"), os.listdir(TESTPATH))) tests.sort() files = [] @@ -95,7 +95,7 @@ def readfiles(): def uimports(code): - """ converts CPython module names into MicroPython equivalents """ + """converts CPython module names into MicroPython equivalents""" for uimport in UIMPORTLIST: uimport = bytes(uimport, "utf8") code = code.replace(b"import " + uimport, b"import u" + uimport + b" as " + uimport) @@ -108,7 +108,7 @@ def clean_output(output): def run_tests(tests): - """ executes all tests """ + """executes all tests""" results = [] for test in tests: with open(TESTPATH + test.name, "rb") as f: @@ -157,7 +157,7 @@ def run_tests(tests): def indent(block, spaces): - """ indents paragraphs of text for rst formatting """ + """indents paragraphs of text for rst formatting""" new_block = "" for line in block.split("\n"): new_block += spaces + line + "\n" @@ -165,7 +165,7 @@ def indent(block, spaces): def gen_table(contents): - """ creates a table given any set of columns """ + """creates a table given any set of columns""" xlengths = [] ylengths = [] for column in contents: @@ -199,7 +199,7 @@ def gen_table(contents): def gen_rst(results): - """ creates restructured text documents to display tests """ + """creates restructured text documents to display tests""" # make sure the destination directory exists try: @@ -258,7 +258,7 @@ def gen_rst(results): def main(): - """ Main function """ + """Main function""" # set search path so that test scripts find the test modules (and no other ones) os.environ["PYTHONPATH"] = TESTPATH