blacken code

Author: timvink

mkdocs_git_authors_plugin/ci.py

@@ -12,6 +12,7 @@
 
 from mkdocs_git_authors_plugin.git.command import GitCommand
 
+
 @contextmanager
 def working_directory(path):
     """
@@ -47,7 +48,6 @@ def raise_ci_warnings(path: str) -> None:
 
         n_commits = commit_count()
 
-
     # Gitlab Runners
     if os.getenv("GITLAB_CI") is not None and n_commits < 50:
         # Default is GIT_DEPTH of 50 for gitlab
@@ -109,9 +109,9 @@ def commit_count() -> int:
     Returns:
         count (int): Number of commits.
     """
-    gc = GitCommand('rev-list',['--count','HEAD'])
+    gc = GitCommand("rev-list", ["--count", "HEAD"])
     gc.run()
-    n_commits = int(gc._stdout[0]) # type: ignore
+    n_commits = int(gc._stdout[0])  # type: ignore
     assert n_commits >= 0
     return n_commits
 

mkdocs_git_authors_plugin/git/commit.py

@@ -36,7 +36,7 @@ def __init__(
 
         # Replace <>
         # from '<[email protected]>'
-        # to   '[email protected]'        
+        # to   '[email protected]'
         author_email = re.sub(r"\<|\>", "", author_email)
         # Lowercase, as emails are not case sensitive.
         # See https://github.com/timvink/mkdocs-git-authors-plugin/issues/59

mkdocs_git_authors_plugin/git/page.py

@@ -62,12 +62,20 @@ def get_authors(self):
         """
         if not self._sorted:
             repo = self.repo()
-            reverse = repo.config("show_line_count") or repo.config("show_contribution") or repo.config("sort_authors_by") == "contribution"
+            reverse = (
+                repo.config("show_line_count")
+                or repo.config("show_contribution")
+                or repo.config("sort_authors_by") == "contribution"
+            )
             self._authors = sorted(self._authors, key=repo._sort_key, reverse=reverse)
             self._sorted = True
             author_threshold = repo.config("authorship_threshold_percent")
             if author_threshold > 0 and len(self._authors) > 1:
-                self._authors = [a for a in self._authors if a.contribution()*100 > author_threshold]
+                self._authors = [
+                    a
+                    for a in self._authors
+                    if a.contribution() * 100 > author_threshold
+                ]
         return self._authors
 
     def _process_git_blame(self):

mkdocs_git_authors_plugin/git/repo.py

@@ -51,7 +51,7 @@ def get_authors(self):
         """
         Sorted list of authors in the repository.
 
-        Default sort order is by ascending names, 
+        Default sort order is by ascending names,
         and decending when contribution or line count is shown
 
         Args:
@@ -152,7 +152,11 @@ def _sort_key(self, author):
         Returns:
             comparison key for the sorted() function,
         """
-        if self.config("show_line_count") or self.config("show_contribution") or self.config("sort_authors_by") == "contribution":
+        if (
+            self.config("show_line_count")
+            or self.config("show_contribution")
+            or self.config("sort_authors_by") == "contribution"
+        ):
             key = "contribution"
         else:
             key = "name"

mkdocs_git_authors_plugin/plugin.py

@@ -11,6 +11,7 @@
 
 logger = logging.getLogger("mkdocs.plugins")
 
+
 class GitAuthorsPlugin(BasePlugin):
     config_scheme = (
         ("show_contribution", config_options.Type(bool, default=False)),
@@ -49,17 +50,17 @@ def on_config(self, config, **kwargs):
         Returns:
             (updated) configuration object
         """
-        if not self.config.get('enabled'):
+        if not self.config.get("enabled"):
             return config
-        
-        assert self.config['authorship_threshold_percent'] >= 0
-        assert self.config['authorship_threshold_percent'] <= 100
+
+        assert self.config["authorship_threshold_percent"] >= 0
+        assert self.config["authorship_threshold_percent"] <= 100
 
         try:
             self._repo = Repo()
             self._fallback = False
             self.repo().set_config(self.config)
-            raise_ci_warnings(path = self.repo()._root)
+            raise_ci_warnings(path=self.repo()._root)
         except GitCommandError:
             if self.config["fallback_to_empty"]:
                 self._fallback = True
@@ -97,18 +98,18 @@ def on_files(self, files, config, **kwargs):
         Returns:
             global files collection
         """
-        if not self.config.get('enabled'):
+        if not self.config.get("enabled"):
             return
         if self._fallback:
             return
-        
+
         for file in files:
 
             # Exclude pages specified in config
             excluded_pages = self.config.get("exclude", [])
             if exclude(file.src_path, excluded_pages):
                 continue
-            
+
             path = file.abs_src_path
             if path.endswith(".md"):
                 _ = self.repo().page(path)
@@ -136,9 +137,9 @@ def on_page_content(self, html, page, config, files, **kwargs):
         Returns:
             str: HTML text of page as string
         """
-        if not self.config.get('enabled'):
+        if not self.config.get("enabled"):
             return html
-        
+
         # Exclude pages specified in config
         excluded_pages = self.config.get("exclude", [])
         if exclude(page.file.src_path, excluded_pages):
@@ -150,8 +151,10 @@ def on_page_content(self, html, page, config, files, **kwargs):
         )
         if list_pattern.search(html):
             html = list_pattern.sub(
-                "" if self._fallback else
-                util.site_authors_summary(self.repo().get_authors(), self.config), html
+                ""
+                if self._fallback
+                else util.site_authors_summary(self.repo().get_authors(), self.config),
+                html,
             )
 
         # Replace {{ git_page_authors }}
@@ -191,7 +194,7 @@ def on_page_context(self, context, page, config, nav, **kwargs):
         Returns:
             dict: template context variables
         """
-        if not self.config.get('enabled'):
+        if not self.config.get("enabled"):
             return context
         if self._fallback:
             return context

mkdocs_git_authors_plugin/util.py

@@ -39,11 +39,11 @@ def commit_datetime_string(dt: datetime):
 def page_authors_summary(page, config: dict):
     """
     A summary of the authors' contributions on a page level
-    
+
     Args:
         page (Page): Page class
         config (dict): plugin's config dict
-    
+
     Returns:
         str: HTML text with authors
     """
@@ -124,7 +124,7 @@ def site_authors_summary(authors, config: dict):
 
 def page_authors(authors, path):
     """List of dicts with info on page authors
-    # TODO: rename to something more representative like 'authors_to_dict()' 
+    # TODO: rename to something more representative like 'authors_to_dict()'
     Args:
         authors (list): list with Author classes
         path (str): path to page