From c8ad9c52c5ffb1f8183998a0e66d7e52f7018291 Mon Sep 17 00:00:00 2001
From: Denis Averin <denis.averin@aspose.com>
Date: Sun, 12 May 2024 16:06:45 +0700
Subject: [PATCH] Format code

---
 Makefile                      |  2 +-
 scripts/check-urls.py         | 13 ++++---------
 scripts/github_job_summary.py | 20 ++++++++++++--------
 3 files changed, 17 insertions(+), 18 deletions(-)

diff --git a/Makefile b/Makefile
index 13111b5..4221fff 100644
--- a/Makefile
+++ b/Makefile
@@ -6,7 +6,7 @@ format: format-black
 
 .PHONY: format-black
 format-black:
-	python -m black --line-length=120 -v .
+	python -m black --line-length=120 --exclude submodules -v .
 
 .PHONY: swagger
 swagger:
diff --git a/scripts/check-urls.py b/scripts/check-urls.py
index f0ac1cd..8f86080 100644
--- a/scripts/check-urls.py
+++ b/scripts/check-urls.py
@@ -22,9 +22,7 @@ class Curl:
     See: https://curl.se/libcurl/c/libcurl-errors.html
     """
 
-    CURL_STDERR_HTTP_RE = re.compile(
-        r"^curl: \(22\) The requested URL returned error: (?P<http_code>\d+)"
-    )
+    CURL_STDERR_HTTP_RE = re.compile(r"^curl: \(22\) The requested URL returned error: (?P<http_code>\d+)")
     OK = 0
     COULDNT_RESOLVE_HOST = 6
     HTTP_RETURNED_ERROR = 22
@@ -162,9 +160,7 @@ def create_new_task(url) -> Task:
 
 def process_finished_task(task) -> None:
     # print("Finish task:", task.url)
-    expected_ret_code, expected_http_code = CURL_EXIT_CODES_AND_HTTP_CODES.get(
-        task.url, (0, None)
-    )
+    expected_ret_code, expected_http_code = CURL_EXIT_CODES_AND_HTTP_CODES.get(task.url, (0, None))
     if task.ret_code == expected_ret_code:
         print("OK:", "'%s' %.2fs" % (task.url, task.age))
         JOB_SUMMARY.add_success(task.url)
@@ -181,8 +177,7 @@ def process_finished_task(task) -> None:
             return
 
     print(
-        "Expected %d got %d for '%s': %s"
-        % (expected_ret_code, task.ret_code, task.url, task.stderr),
+        "Expected %d got %d for '%s': %s" % (expected_ret_code, task.ret_code, task.url, task.stderr),
         file=sys.stderr,
     )
     JOB_SUMMARY.add_error(f"Broken URL '{task.url}': {task.stderr}Files: {EXTRACTED_URLS_WITH_FILES[task.url]}")
@@ -221,7 +216,7 @@ def url_checker(num_workers=8):
     print("Worker finished")
 
 
-JOB_SUMMARY = JobSummary(os.environ.get('GITHUB_STEP_SUMMARY', "step_summary.md"))
+JOB_SUMMARY = JobSummary(os.environ.get("GITHUB_STEP_SUMMARY", "step_summary.md"))
 JOB_SUMMARY.add_header("Test all URLs")
 
 
diff --git a/scripts/github_job_summary.py b/scripts/github_job_summary.py
index 6b7c366..47d976d 100644
--- a/scripts/github_job_summary.py
+++ b/scripts/github_job_summary.py
@@ -4,13 +4,16 @@
 
 
 class JobSummary:
+    """
+    See https://docs.github.com/en/actions/using-workflows/workflow-commands-for-github-actions#adding-a-job-summary
+    """
 
     def __init__(self, filename: str):
         """
 
         :param filename: Use $GITHUB_STEP_SUMMARY inside GitHub
         """
-        self.__file: TextIO = open(filename, mode='wt')
+        self.__file: TextIO = open(filename, mode="wt")
         self._errors = []
         self._success = []
         self._lock = Lock()
@@ -23,7 +26,7 @@ def __str__(self) -> str:
         if not self.has_errors:
             return "OK"
         lines = ["Errors:"] + self._errors
-        return '\n\n'.join(lines)
+        return "\n\n".join(lines)
 
     def _write_line(self, line):
         with self._lock:
@@ -37,6 +40,9 @@ def add_header(self, text: str, level: int = 3):
         self._write_line(f"{'#' * level} {text}\n\n")
 
     def add_error(self, text: str):
+        """
+        See https://github.com/markdown-templates/markdown-emojis
+        """
         if not self._errors:
             self._write_line("Errors:\n")
         self._errors.append(text)
@@ -47,11 +53,9 @@ def add_success(self, text: str):
 
     def finalize(self, format_str: str):
         total = len(self._success) + len(self._errors)
-        self._write_line('\n' + format_str.format(
-            total=total,
-            success=len(self._success),
-            failed=len(self._errors)
-        ) + '\n')
+        self._write_line(
+            "\n" + format_str.format(total=total, success=len(self._success), failed=len(self._errors)) + "\n"
+        )
 
 
 def test():
@@ -64,5 +68,5 @@ def test():
         summary.finalize("Total={total}, success={success}, failed={failed}")
 
 
-if __name__ == '__main__':
+if __name__ == "__main__":
     test()