Use f-string

Author: twsl

mkdocs_git_authors_plugin/git/command.py

@@ -69,8 +69,8 @@ def run(self) -> int:
             p.check_returncode()
         except subprocess.CalledProcessError:
             msg = ["GitCommand error:"]
-            msg.append('Command "%s" failed' % " ".join(args))
-            msg.append("Return code: %s" % p.returncode)
+            msg.append(f'Command "{' '.join(args)}" failed')
+            msg.append(f"Return code: {p.returncode}")
             msg.append("Output:")
             msg.append(p.stdout.decode("utf-8"))
             msg.append("Error messages:")

mkdocs_git_authors_plugin/git/page.py

@@ -38,13 +38,11 @@ def __init__(self, repo: Repo, path: Path, strict: bool) -> None:
         except GitCommandError:
             if self._strict:
                 logger.warning(
-                    "[git-authors-plugin] %s has not been committed yet. Lines are not counted"
-                    % path
+                    f"[git-authors-plugin] {path} has not been committed yet. Lines are not counted"
                 )
             else:
                 logger.info(
-                    "[git-authors-plugin] %s has not been committed yet. Lines are not counted"
-                    % path
+                    f"[git-authors-plugin] {path} has not been committed yet. Lines are not counted"
                 )
 
     def add_total_lines(self, cnt: int = 1) -> None:

mkdocs_git_authors_plugin/util.py

@@ -57,7 +57,7 @@ def page_authors_summary(page, config: dict) -> str:
 
     for author in authors:
         contrib = (
-            " (%s)" % author.contribution(page.path(), str)
+            f" ({author.contribution(page.path(), str)})"
             if page.repo().config("show_contribution") and len(page.get_authors()) > 1
             else ""
         )
@@ -67,13 +67,13 @@ def page_authors_summary(page, config: dict) -> str:
                 .config("href")
                 .format(email=author.email(), name=author.name())
             )
-            author_name = "<a href='%s'>%s</a>" % (href, author.name())
+            author_name = f"<a href='{href}'>{author.name()}</a>"
         else:
             author_name = author.name()
-        authors_summary.append("%s%s" % (author_name, contrib))
+        authors_summary.append(f"{author_name}{contrib}")
 
     authors_summary_str = ", ".join(authors_summary)
-    return "<span class='git-page-authors git-authors'>%s</span>" % authors_summary_str
+    return f"<span class='git-page-authors git-authors'>{authors_summary_str}</span>"
 
 
 def site_authors_summary(authors, config: GitAuthorsPluginConfig) -> str:
@@ -104,13 +104,13 @@ def site_authors_summary(authors, config: GitAuthorsPluginConfig) -> str:
         """
     for author in authors:
         contribution = (
-            " (%s)" % author.contribution(None, str) if config.show_contribution else ""
+            f" ({author.contribution(None, str)})" if config.show_contribution else ""
         )
-        lines = ": %s lines" % author.lines() if config.show_line_count else ""
+        lines = f": {author.lines()} lines" if config.show_line_count else ""
         author_name = ""
         if config.show_email_address:
             href = config["href"].format(email=author.email(), name=author.name())
-            author_name = '<a href="%s">%s</a>' % (href, author.name())
+            author_name = f'<a href="{href}">{author.name()}</a>'
         else:
             author_name = author.name()
         result += """

tests/test_basic.py

@@ -81,12 +81,12 @@ def test_basic_working(tmp_path, mkdocs_file: str) -> None:
     See https://github.com/timvink/mkdocs-git-authors-plugin/issues/60
     """
     result = build_docs_setup(f"tests/basic_setup/{mkdocs_file}", tmp_path)
-    assert result.exit_code == 0, (
-        "'mkdocs build' command failed. Error: %s" % result.stdout
-    )
+    assert (
+        result.exit_code == 0
+    ), f"'mkdocs build' command failed. Error: {result.stdout}"
 
     index_file = tmp_path / "index.html"
-    assert index_file.exists(), "%s does not exist" % index_file
+    assert index_file.exists(), f"{index_file} does not exist"
 
     contents = index_file.read_text()
     assert re.search("<span class='git-page-authors", contents)
@@ -96,12 +96,12 @@ def test_basic_working(tmp_path, mkdocs_file: str) -> None:
 def test_custom_href(tmp_path) -> None:
     """ """
     result = build_docs_setup("tests/basic_setup/mkdocs_custom_href.yml", tmp_path)
-    assert result.exit_code == 0, (
-        "'mkdocs build' command failed. Error: %s" % result.stdout
-    )
+    assert (
+        result.exit_code == 0
+    ), f"'mkdocs build' command failed. Error: {result.stdout}"
 
     index_file = tmp_path / "index.html"
-    assert index_file.exists(), "%s does not exist" % index_file
+    assert index_file.exists(), f"{index_file} does not exist"
 
     contents = index_file.read_text()
     assert re.search("<span class='git-page-authors", contents)
@@ -121,12 +121,12 @@ def test_custom_href(tmp_path) -> None:
 
 def test_no_email(tmp_path) -> None:
     result = build_docs_setup("tests/basic_setup/mkdocs_no_email.yml", tmp_path)
-    assert result.exit_code == 0, (
-        "'mkdocs build' command failed. Error: %s" % result.stdout
-    )
+    assert (
+        result.exit_code == 0
+    ), f"'mkdocs build' command failed. Error: {result.stdout}"
 
     index_file = tmp_path / "index.html"
-    assert index_file.exists(), "%s does not exist" % index_file
+    assert index_file.exists(), f"{index_file} does not exist"
 
     contents = index_file.read_text()
     assert re.search("<span class='git-page-authors", contents)
@@ -135,25 +135,25 @@ def test_no_email(tmp_path) -> None:
 
 def test_exclude_working(tmp_path) -> None:
     result = build_docs_setup("tests/basic_setup/mkdocs_exclude.yml", tmp_path)
-    assert result.exit_code == 0, (
-        "'mkdocs build' command failed. Error: %s" % result.stdout
-    )
+    assert (
+        result.exit_code == 0
+    ), f"'mkdocs build' command failed. Error: {result.stdout}"
 
     page_file = tmp_path / "page_with_tag/index.html"
-    assert page_file.exists(), "%s does not exist" % page_file
+    assert page_file.exists(), f"{page_file} does not exist"
 
     contents = page_file.read_text()
     assert not re.search("<span class='git-page-authors", contents)
 
 
 def test_ignore_authors_working(tmp_path) -> None:
     result = build_docs_setup("tests/basic_setup/mkdocs_ignore_authors.yml", tmp_path)
-    assert result.exit_code == 0, (
-        "'mkdocs build' command failed. Error: %s" % result.stdout
-    )
+    assert (
+        result.exit_code == 0
+    ), f"'mkdocs build' command failed. Error: {result.stdout}"
 
     page_file = tmp_path / "page_with_tag/index.html"
-    assert page_file.exists(), "%s does not exist" % page_file
+    assert page_file.exists(), f"{page_file} does not exist"
 
     contents = page_file.read_text()
     assert re.search("<span class='git-page-authors", contents)
@@ -197,9 +197,9 @@ def test_exclude_working_with_genfiles(tmp_path) -> None:
         result = build_docs_setup(
             str(testproject_path / "mkdocs.yml"), str(testproject_path / "site")
         )
-        assert result.exit_code == 0, (
-            "'mkdocs build' command failed. Error: %s" % result.stdout
-        )
+        assert (
+            result.exit_code == 0
+        ), f"'mkdocs build' command failed. Error: { result.stdout}"
 
         # files generated ourselves right before build but not committed, should not generate warnings
         assert "manually_created.md has not been committed yet." not in result.stdout
@@ -213,12 +213,12 @@ def test_enabled_working(tmp_path) -> None:
     result = build_docs_setup(
         "tests/basic_setup/mkdocs_complete_material_disabled.yml", tmp_path
     )
-    assert result.exit_code == 0, (
-        "'mkdocs build' command failed. Error: %s" % result.stdout
-    )
+    assert (
+        result.exit_code == 0
+    ), f"'mkdocs build' command failed. Error: {result.stdout}"
 
     page_file = tmp_path / "page_with_tag/index.html"
-    assert page_file.exists(), "%s does not exist" % page_file
+    assert page_file.exists(), f"{page_file} does not exist"
 
     contents = page_file.read_text()
     assert not re.search("<span class='git-page-authors", contents)
@@ -249,9 +249,9 @@ def test_project_with_no_commits(tmp_path) -> None:
         result = build_docs_setup(
             str(testproject_path / "website/mkdocs.yml"), str(testproject_path / "site")
         )
-        assert result.exit_code == 0, (
-            "'mkdocs build' command failed. Error: %s" % result.stdout
-        )
+        assert (
+            result.exit_code == 0
+        ), f"'mkdocs build' command failed. Error: {result.stdout}"
 
 
 def test_building_empty_site(tmp_path) -> None:
@@ -282,9 +282,9 @@ def test_building_empty_site(tmp_path) -> None:
         result = build_docs_setup(
             str(testproject_path / "website/mkdocs.yml"), str(testproject_path / "site")
         )
-        assert result.exit_code == 0, (
-            "'mkdocs build' command failed. Error: %s" % result.stdout
-        )
+        assert (
+            result.exit_code == 0
+        ), f"'mkdocs build' command failed. Error: {result.stdout}"
 
 
 def test_fallback(tmp_path) -> None:
@@ -313,6 +313,6 @@ def test_fallback(tmp_path) -> None:
             str(testproject_path / "website/mkdocs.yml"), str(testproject_path / "site")
         )
         # import pdb; pdb.set_trace()
-        assert result.exit_code == 0, (
-            "'mkdocs build' command failed. Error: %s" % result.stdout
-        )
+        assert (
+            result.exit_code == 0
+        ), f"'mkdocs build' command failed. Error: {result.stdout}"