ruff format codebase

Author: timvink

.pre-commit-config.yaml

@@ -1,13 +1,4 @@
 repos:
-  - repo: local
-    hooks:
-    - id: black
-      name: black
-      entry: black
-      language: python
-      types: [python]
-      language_version: python3.8
-      args: [--line-length=120]
   - repo: local
     hooks:
     - id: mypy
@@ -16,14 +7,7 @@ repos:
       language: system
       types: [python]
       args: [--ignore-missing-imports, --namespace-packages, --show-error-codes, --pretty]
-  - repo: local
-    hooks:
-    - id: flake8
-      name: flake8
-      entry: flake8
-      language: system
-      types: [python]
-      args: [--max-line-length=120, --docstring-convention=google, "--ignore=D100,D104,D212,D200,E203,W293,D412,W503,W605,E722"]
+
 # D100 requires all Python files (modules) to have a "public" docstring even if all functions within have a docstring.
 # D104 requires __init__ files to have a docstring
 # D212

docs/contributing.md

@@ -9,31 +9,26 @@ Thanks for considering to contribute to this project! Some guidelines:
 
 ## Unit Tests
 
-Make sure to install an editable version before running tests:
+We use [uv](https://docs.astral.sh/uv/getting-started/installation/) to manage python:
 
 ```bash
-pip install -r tests/test_requirements.txt
-pip install -e .
-pytest --cov=mkdocs_print_site_plugin --cov-report term-missing tests/
+uv run pytest --cov=mkdocs_print_site_plugin --cov-report term-missing tests/
 ```
 
 If it makes sense, writing tests for your PRs is always appreciated and will help get them merged.
 
-In addition, this project uses [pyflakes](https://pypi.org/project/pyflakes/) for static code checking:
+You can also apply formatting using:
 
 ```bash
-pip install pyflakes
-pyflakes tests/ mkdocs_print_site_plugin/
+uv run --with ruff ruff format src/
 ```
 
 ## Manual testing
 
 To quickly serve a website with your latest changes to the plugin use the sites in our tests suite. For example:
 
 ```bash
-pip install -r tests/test_requirements.txt
-pip install -e .
-mkdocs serve -f tests/fixutures/basic/mkdocs.yml
+uv run mkdocs serve -f tests/fixutures/basic/mkdocs.yml
 ```
 
 Tip: If you use google chrome, you can also view the print version of a page inside the browser [by setting the renderer](https://www.smashingmagazine.com/2018/05/print-stylesheets-in-2018/).
@@ -49,7 +44,7 @@ We use google-style docstrings.
 Is in `docs/`. To [deploy the docs](https://www.mkdocs.org/user-guide/deploying-your-docs/), run:
 
 ```bash
-mkdocs gh-deploy
+uv run mkdocs gh-deploy
 ```
 
 Note: there is no automated github action for this currently.

pyproject.toml

@@ -119,6 +119,7 @@ dev = [
     "mkdocs-img2fig-plugin>=0.9.3",
     "mkdocs-material>=9.6.7",
     "mkdocs-windmill>=1.0.5",
+    "mypy>=1.14.1",
     "pytest>=8.3.5",
     "pytest-cov>=5.0.0",
     "ruff>=0.9.10",

src/mkdocs_print_site_plugin/__init__.py

@@ -1 +1 @@
-__version__ = "2.7.0"
+__version__ = "2.7.0"

src/mkdocs_print_site_plugin/exclude.py

@@ -3,6 +3,7 @@
 
 Inspired by https://github.com/apenwarr/mkdocs-exclude
 """
+
 import os
 import fnmatch
 from typing import List

src/mkdocs_print_site_plugin/plugin.py

@@ -71,27 +71,23 @@ def on_config(self, config, **kwargs):
         # Check if 'hooks' is defined in the 'plugins' section
         if isinstance(config.get("hooks"), dict):
             position_offset += len(config.get("hooks"))
-            
+
         if print_site_position != len(plugins) - position_offset:
             msg = "[mkdocs-print-site] 'print-site' should be defined as the *last* plugin,"
             msg += "to ensure the print page has any changes other plugins make."
             msg += "Please update the 'plugins:' section in your mkdocs.yml"
             logger.warning(msg)
 
         if "--dirtyreload" in sys.argv:
-            msg = (
-                "[mkdocs-print-site] Note the 'print-site' page does render all pages "
-            )
+            msg = "[mkdocs-print-site] Note the 'print-site' page does render all pages "
             msg += "when using the --dirtyreload option."
             logger.warning(msg)
 
         # Get abs path to cover_page_template
         self.cover_page_template_path = ""
         if self.config.get("add_cover_page"):
             if self.config.get("cover_page_template") == "":
-                self.cover_page_template_path = os.path.join(
-                    HERE, "templates", "cover_page.tpl"
-                )
+                self.cover_page_template_path = os.path.join(HERE, "templates", "cover_page.tpl")
             else:
                 self.cover_page_template_path = os.path.join(
                     os.path.dirname(config.get("config_file_path")),
@@ -101,17 +97,13 @@ def on_config(self, config, **kwargs):
                 msg = "[print-site-plugin]: Path specified in 'cover_page_template' not found."
                 msg += "\nMake sure to use the URL relative to your mkdocs.yml file."
                 logger.warning(msg)
-                raise FileNotFoundError(
-                    "File not found: %s" % self.cover_page_template_path
-                )
+                raise FileNotFoundError("File not found: %s" % self.cover_page_template_path)
 
         # Get abs path to print_site_banner_template
         self.banner_template_path = ""
         if self.config.get("add_print_site_banner"):
             if self.config.get("print_site_banner_template") == "":
-                self.banner_template_path = os.path.join(
-                    HERE, "templates", "print_site_banner.tpl"
-                )
+                self.banner_template_path = os.path.join(HERE, "templates", "print_site_banner.tpl")
             else:
                 self.banner_template_path = os.path.join(
                     os.path.dirname(config.get("config_file_path")),
@@ -121,9 +113,7 @@ def on_config(self, config, **kwargs):
                 msg = "[print-site-plugin]: Path specified in 'print_site_banner_template' not found."
                 msg += "\nMake sure to use the URL relative to your mkdocs.yml file."
                 logger.warning(msg)
-                raise FileNotFoundError(
-                    "File not found: %s" % self.banner_template_path
-                )
+                raise FileNotFoundError("File not found: %s" % self.banner_template_path)
 
         # Add pointer to print-site javascript
         config["extra_javascript"] = ["js/print-site.js"] + config["extra_javascript"]
@@ -146,7 +136,6 @@ def on_config(self, config, **kwargs):
 
             config["extra_css"] = self.enum_css_files + config["extra_css"]
 
-
         # Create MkDocs Page and File instances
         self.print_file = File(
             path=self.config.get("print_page_basename") + ".md",
@@ -217,9 +206,7 @@ def on_page_content(self, html, page, config, files, **kwargs):
             if is_external(pdf_url):
                 page.url_to_pdf = pdf_url
             else:
-                page.url_to_pdf = get_relative_url(
-                    pdf_url, page.file.url
-                )
+                page.url_to_pdf = get_relative_url(pdf_url, page.file.url)
 
         return html
 
@@ -262,11 +249,14 @@ def on_template_context(self, context, template_name, config, **kwargs):
         if template_name == "404.html":
             self.context = context
             # Make sure paths are OK
-            if config.get('extra_css'):
-                self.context['extra_css'] = [get_relative_url(f, self.print_page.file.url) for f in config.get('extra_css')]
-            if config.get('extra_javascript'):
-                self.context['extra_javascript'] = [get_relative_url(str(f), self.print_page.file.url) for f in config.get('extra_javascript')]
-
+            if config.get("extra_css"):
+                self.context["extra_css"] = [
+                    get_relative_url(f, self.print_page.file.url) for f in config.get("extra_css")
+                ]
+            if config.get("extra_javascript"):
+                self.context["extra_javascript"] = [
+                    get_relative_url(str(f), self.print_page.file.url) for f in config.get("extra_javascript")
+                ]
 
     def on_post_build(self, config, **kwargs):
         """
@@ -292,25 +282,19 @@ def on_post_build(self, config, **kwargs):
             # Add print-site.css
             css_output_base_path = os.path.join(config["site_dir"], "css")
             css_file_path = os.path.join(css_output_base_path, "print-site.css")
-            copy_file(
-                os.path.join(os.path.join(HERE, "css"), "print-site.css"), css_file_path
-            )
+            copy_file(os.path.join(os.path.join(HERE, "css"), "print-site.css"), css_file_path)
 
             # Add enumeration css
             for f in self.enum_css_files:
                 f = f.replace("/", os.sep)
                 css_file_path = os.path.join(config["site_dir"], f)
-                copy_file(
-                    os.path.join(HERE, f), css_file_path
-                )
+                copy_file(os.path.join(HERE, f), css_file_path)
 
             # Add theme CSS file
             css_file = "print-site-%s.css" % get_theme_name(config)
             if css_file in os.listdir(os.path.join(HERE, "css")):
                 css_file_path = os.path.join(css_output_base_path, css_file)
-                copy_file(
-                    os.path.join(os.path.join(HERE, "css"), css_file), css_file_path
-                )
+                copy_file(os.path.join(os.path.join(HERE, "css"), css_file), css_file_path)
 
         # Combine the HTML of all pages present in the navigation
         self.print_page.content, self.print_page.toc = self.renderer.write_combined()
@@ -325,38 +309,30 @@ def on_post_build(self, config, **kwargs):
 
         # Remove lazy loading attributes from images
         # https://regex101.com/r/HVpKPs/1
-        html = re.sub(r"(\<img.+)(loading=\"lazy\")", r"\1", html)        
+        html = re.sub(r"(\<img.+)(loading=\"lazy\")", r"\1", html)
 
         # Compatiblity with mkdocs-chart-plugin
         # As this plugin adds some javascript to every page
         # It should be included in the print site also
         if config.get("plugins", {}).get("charts"):
-            html = (
-                config.get("plugins", {})
-                .get("charts")
-                .add_javascript_variables(html, self.print_page, config)
-            )
+            html = config.get("plugins", {}).get("charts").add_javascript_variables(html, self.print_page, config)
 
         # Compatibility with mkdocs-drawio
         # As this plugin adds renderer html for every drawio diagram
         # referenced in your markdown files. This rendering happens
         # in the on_post_page event, which is skipped by this plugin
-        # therefore we need to manual execute the drawio plugin renderer here. 
+        # therefore we need to manual execute the drawio plugin renderer here.
         if config.get("plugins", {}).get("drawio"):
-            html = (
-                config.get("plugins", {})
-                    .get("drawio")
-                    .render_drawio_diagrams(html, self.print_page)
-            )
+            html = config.get("plugins", {}).get("drawio").render_drawio_diagrams(html, self.print_page)
 
         # Compatibility with https://github.com/g-provost/lightgallery-markdown
         # This plugin insert link hrefs with double dashes, f.e.
         # <link href="//assets/css/somecss.css">
         # Details https://github.com/timvink/mkdocs-print-site-plugin/issues/68
         htmls = html.split("</head>")
         base_url = "../" if config.get("use_directory_urls") else ""
-        htmls[0] = htmls[0].replace("href=\"//", f"href=\"{base_url}")
-        htmls[0] = htmls[0].replace("src=\"//", f"src=\"{base_url}")
+        htmls[0] = htmls[0].replace('href="//', f'href="{base_url}')
+        htmls[0] = htmls[0].replace('src="//', f'src="{base_url}')
         html = "</head>".join(htmls)
 
         # Determine calls to required javascript functions
@@ -379,7 +355,4 @@ def on_post_build(self, config, **kwargs):
         html = html.replace("</head>", print_site_js + "</head>")
 
         # Write the print_page file to the output folder
-        write_file(
-            html.encode("utf-8", errors="xmlcharrefreplace"),
-            self.print_page.file.abs_dest_path
-        )
+        write_file(html.encode("utf-8", errors="xmlcharrefreplace"), self.print_page.file.abs_dest_path)

src/mkdocs_print_site_plugin/renderer.py

@@ -82,7 +82,7 @@ def get_html_and_anchor_links_from_items(
             heading_styles: List[str] = [],
         ) -> Tuple[str, List[AnchorLink]]:
             """
-        Get all the HTML and anchor links from the pages.
+            Get all the HTML and anchor links from the pages.
             """
             items_html = ""
             anchor_links = []
@@ -163,7 +163,7 @@ def get_html_and_anchor_links_from_items(
 
             return items_html, anchor_links
 
-        heading_styles = []
+        heading_styles: List[str] = []
         items_html, anchor_links = get_html_and_anchor_links_from_items(
             self._get_items(),
             dir_urls=self.mkdocs_config.get("use_directory_urls"),

src/mkdocs_print_site_plugin/urls.py

@@ -41,11 +41,12 @@ def is_external(url):
     prefixes = ("http", "www", "mailto:", "tel:", "skype:", "ftp:")
     return url.startswith(prefixes)
 
+
 def is_base64_image(url):
     """
     Test if a url is a base64 data image.
     """
-    prefixes = ("data:image")
+    prefixes = "data:image"
     return url.startswith(prefixes)
 
 
@@ -76,14 +77,7 @@ def get_page_key(page_url):
     Args:
         page_url (str): The MkDocs url of the page
     """
-    page_key = (
-        page_url.lower()
-        .strip()
-        .rstrip("/")
-        .replace(".html", "")
-        .replace("/", "-")
-        .lstrip("-")
-    )
+    page_key = page_url.lower().strip().rstrip("/").replace(".html", "").replace("/", "-").lstrip("-")
     if len(page_key) > 0:
         return page_key
     else:
@@ -190,13 +184,13 @@ def fix_tabbed_content(page_html, page_key):
     <label for="{page_key}__tabbed_1_1">C</label>
     """
     regex = re.compile(r"(\<input.*?name=\")([^\"]*?)(\".*?\>)", re.I)
-    page_html = re.sub(regex, fr"\g<1>{page_key}-\g<2>\g<3>", page_html)
+    page_html = re.sub(regex, rf"\g<1>{page_key}-\g<2>\g<3>", page_html)
 
     regex = re.compile(r"(\<input.*?id=\")([^\"]*?)(\".*?\>)", re.I)
-    page_html = re.sub(regex, fr"\g<1>{page_key}-\g<2>\g<3>", page_html)
+    page_html = re.sub(regex, rf"\g<1>{page_key}-\g<2>\g<3>", page_html)
 
     regex = re.compile(r"(\<label.*?for=\")([^\"]*?)(\".*?\>)", re.I)
-    page_html = re.sub(regex, fr"\g<1>{page_key}-\g<2>\g<3>", page_html)
+    page_html = re.sub(regex, rf"\g<1>{page_key}-\g<2>\g<3>", page_html)
 
     return page_html
 
@@ -209,9 +203,7 @@ def fix_image_src(page_html, page_url, directory_urls):
     """
     # Loop over all images src attributes
     # Example regex https://regex101.com/r/PLUmZ7/2
-    img_regex = re.compile(
-        r"<img[^>]+src=\"([^\">]+)\"", flags=re.IGNORECASE
-    )
+    img_regex = re.compile(r"<img[^>]+src=\"([^\">]+)\"", flags=re.IGNORECASE)
     matches = re.finditer(img_regex, page_html)
 
     for m in matches:
@@ -220,7 +212,7 @@ def fix_image_src(page_html, page_url, directory_urls):
             continue
         elif is_base64_image(img_src):
             continue
-        
+
         img_text = m.group()
 
         new_url = get_url_from_root(img_src, page_url)
@@ -283,7 +275,9 @@ def fix_internal_links(page_html, page_url, directory_urls, heading_number):
 
     # Finally, wrap the entire page in a section with an anchor ID
     page_html = (
-        ('<section class="print-page" id="%s" heading-number="%s">' % (page_key, heading_number)) + page_html + "</section>"
+        ('<section class="print-page" id="%s" heading-number="%s">' % (page_key, heading_number))
+        + page_html
+        + "</section>"
     )
 
     return page_html

src/mkdocs_print_site_plugin/utils.py

@@ -27,4 +27,4 @@ def get_theme_name(config) -> str:
 
 
 def get_section_id(section_number: str) -> str:
-    return f"section-{section_number.replace('.', '-')}"
+    return f"section-{section_number.replace('.', '-')}"