Blacken code and fix flake8 issues

Author: timvink

.flake8

@@ -1,2 +1,2 @@
 [flake8]
-ignore = E501,E722
+ignore = E501,E722,D104

mkdocs_git_revision_date_localized_plugin/ci.py

@@ -1,16 +1,20 @@
+"""
+Helper functions related to continuous integration (CI).
+
+This is because often CI runners do not have access to full git history.
+"""
+
 import os
 import logging
 
 
 def raise_ci_warnings(repo) -> None:
     """
-    Raise warnings when users use mkdocs-git-revision-date-localized-plugin
-    on CI build runners.
+    Raise warnings when users use plugin on CI build runners.
 
     Args:
         repo (GitPython.git.repo): The Git repo object.
     """
-
     if not is_shallow_clone(repo):
         return None
 
@@ -72,7 +76,7 @@ def raise_ci_warnings(repo) -> None:
 
 def commit_count(repo) -> int:
     """
-    Helper function to determine the number of commits in a repository.
+    Determine the number of commits in a repository.
 
     Args:
         repo (GitPython.Repo.git): Repository.
@@ -89,8 +93,7 @@ def commit_count(repo) -> int:
 
 def is_shallow_clone(repo) -> bool:
     """
-    Helper function to determine if repository
-    is a shallow clone.
+    Determine if repository is a shallow clone.
 
     References & Context:
     https://github.com/timvink/mkdocs-git-revision-date-localized-plugin/issues/10

mkdocs_git_revision_date_localized_plugin/plugin.py

@@ -1,3 +1,9 @@
+"""
+MkDocs Plugin.
+
+https://www.mkdocs.org/
+https://github.com/timvink/mkdocs-git-revision-date-localized-plugin/
+"""
 # standard lib
 import logging
 import re
@@ -18,12 +24,18 @@
 
 
 class GitRevisionDateLocalizedPlugin(BasePlugin):
+    """
+    Mkdocs plugin to add revision date from Git.
+
+    See https://www.mkdocs.org/user-guide/plugins
+    """
+
     config_scheme = (
         ("fallback_to_build_date", config_options.Type(bool, default=False)),
         ("locale", config_options.Type(str, default=None)),
         ("type", config_options.Type(str, default="date")),
         ("timezone", config_options.Type(str, default="UTC")),
-        ("excluded_page_titles", config_options.Type(list, default=[]))
+        ("excluded_page_titles", config_options.Type(list, default=[])),
     )
 
     def on_config(self, config: config_options.Config, **kwargs) -> Dict[str, Any]:
@@ -96,8 +108,12 @@ def on_config(self, config: config_options.Config, **kwargs) -> Dict[str, Any]:
 
         # Add pointers to support files for timeago.js
         if self.config.get("type") == "timeago":
-            config["extra_javascript"] = ["js/timeago_mkdocs_material.js"] + config["extra_javascript"]
-            config["extra_javascript"] = ["js/timeago.min.js"] + config["extra_javascript"]
+            config["extra_javascript"] = ["js/timeago_mkdocs_material.js"] + config[
+                "extra_javascript"
+            ]
+            config["extra_javascript"] = ["js/timeago.min.js"] + config[
+                "extra_javascript"
+            ]
             config["extra_css"] = ["css/timeago.css"] + config["extra_css"]
 
         return config
@@ -106,7 +122,7 @@ def on_page_markdown(
         self, markdown: str, page: Page, config: config_options.Config, files, **kwargs
     ) -> str:
         """
-        Replace jinja2 tags in markdown and templates with the localized dates
+        Replace jinja2 tags in markdown and templates with the localized dates.
 
         The page_markdown event is called after the page's markdown is loaded
         from file and can be used to alter the Markdown source text.
@@ -124,7 +140,6 @@ def on_page_markdown(
         Returns:
             str: Markdown source text of page as string
         """
-
         excluded_titles = self.config.get("excluded_page_titles", [])
         if page.title in excluded_titles:
             logging.debug("Excluding page " + page.url)
@@ -156,11 +171,16 @@ def on_page_markdown(
     def on_post_build(self, config: Dict[str, Any], **kwargs) -> None:
         """
         Run on post build.
+
         Adds the timeago assets to the build.
         """
         # Add timeago files:
         if self.config.get("type") == "timeago":
-            files = ["js/timeago.min.js", "js/timeago_mkdocs_material.js", "css/timeago.css"]
+            files = [
+                "js/timeago.min.js",
+                "js/timeago_mkdocs_material.js",
+                "css/timeago.css",
+            ]
             for file in files:
                 dest_file_path = os.path.join(config["site_dir"], file)
                 src_file_path = os.path.join(HERE, file)

mkdocs_git_revision_date_localized_plugin/util.py

@@ -1,3 +1,4 @@
+"""Utility class for mkdocs plugin."""
 import logging
 import os
 import time
@@ -6,16 +7,27 @@
 from mkdocs_git_revision_date_localized_plugin.ci import raise_ci_warnings
 
 from babel.dates import format_date, get_timezone
-from git import Repo, GitCommandError, GitCommandNotFound, InvalidGitRepositoryError, NoSuchPathError
+from git import (
+    Repo,
+    GitCommandError,
+    GitCommandNotFound,
+    InvalidGitRepositoryError,
+    NoSuchPathError,
+)
 
 from typing import Any, Dict
 
 logger = logging.getLogger("mkdocs.plugins")
 
 
 class Util:
-    def __init__(self, config={}):
+    """Utility class.
+
+    This helps find git and calculate relevant dates.
+    """
 
+    def __init__(self, config={}):
+        """Initialize utility class."""
         self.fallback_enabled = False
         self.config = config
         self.repo_cache = {}
@@ -37,7 +49,7 @@ def _date_formats(
         unix_timestamp: float, locale: str = "en", time_zone: str = "UTC"
     ) -> Dict[str, Any]:
         """
-        Returns different date formats / types.
+        Calculate different date formats / types.
 
         Args:
             unix_timestamp (float): A timestamp in seconds since 1970.
@@ -54,10 +66,12 @@ def _date_formats(
 
         return {
             "date": format_date(loc_revision_date, format="long", locale=locale),
-            "datetime": " ".join([
-                format_date(loc_revision_date, format="long", locale=locale),
-                loc_revision_date.strftime("%H:%M:%S"),
-            ]),
+            "datetime": " ".join(
+                [
+                    format_date(loc_revision_date, format="long", locale=locale),
+                    loc_revision_date.strftime("%H:%M:%S"),
+                ]
+            ),
             "iso_date": loc_revision_date.strftime("%Y-%m-%d"),
             "iso_datetime": loc_revision_date.strftime("%Y-%m-%d %H:%M:%S"),
             "timeago": '<span class="timeago" datetime="%s" locale="%s"></span>'
@@ -72,7 +86,7 @@ def get_revision_date_for_file(
         fallback_to_build_date: bool = False,
     ) -> Dict[str, str]:
         """
-        Determine localized date variants for a given file
+        Determine localized date variants for a given file.
 
         Args:
             path (str): Location of a markdown file that is part of a Git repository.
@@ -82,7 +96,6 @@ def get_revision_date_for_file(
         Returns:
             dict: Localized date variants.
         """
-
         unix_timestamp = None
 
         # perform git log operation
@@ -91,7 +104,9 @@ def get_revision_date_for_file(
                 # Retrieve author date in UNIX format (%at)
                 # https://git-scm.com/docs/git-log#Documentation/git-log.txt-ematem
                 realpath = os.path.realpath(path)
-                unix_timestamp = self._get_repo(realpath).log(realpath, n=1, date="short", format="%at")
+                unix_timestamp = self._get_repo(realpath).log(
+                    realpath, n=1, date="short", format="%at"
+                )
         except (InvalidGitRepositoryError, NoSuchPathError) as err:
             if fallback_to_build_date:
                 logger.warning(

tests/fixtures/basic_project/docs/subfolder/page_in_subfolder.md

@@ -0,0 +1,3 @@
+# page
+
+in subfolder