allows file exclusions

Author: Fir121

mkdocs_git_committers_plugin_2/exclude.py

@@ -0,0 +1,43 @@
+"""
+Module to assist exclude certain files being processed by plugin.
+Inspired by https://github.com/apenwarr/mkdocs-exclude
+"""
+import os
+import fnmatch
+from typing import List
+
+
+def exclude(src_path: str, globs: List[str]) -> bool:
+    """
+    Determine if a src_path should be excluded.
+    Supports globs (e.g. folder/* or *.md).
+    Credits: code adapted from
+    https://github.com/timvink/mkdocs-git-authors-plugin/blob/master/mkdocs_git_authors_plugin/exclude.py
+    Args:
+        src_path (src): Path of file
+        globs (list): list of globs
+    Returns:
+        (bool): whether src_path should be excluded
+    """
+    assert isinstance(src_path, str)
+    assert isinstance(globs, list)
+
+    for g in globs:
+        if fnmatch.fnmatchcase(src_path, g):
+            return True
+
+        # Windows reports filenames as eg.  a\\b\\c instead of a/b/c.
+        # To make the same globs/regexes match filenames on Windows and
+        # other OSes, let's try matching against converted filenames.
+        # On the other hand, Unix actually allows filenames to contain
+        # literal \\ characters (although it is rare), so we won't
+        # always convert them.  We only convert if os.sep reports
+        # something unusual.  Conversely, some future mkdocs might
+        # report Windows filenames using / separators regardless of
+        # os.sep, so we *always* test with / above.
+        if os.sep != "/":
+            src_path_fix = src_path.replace(os.sep, "/")
+            if fnmatch.fnmatchcase(src_path_fix, g):
+                return True
+
+    return False

mkdocs_git_committers_plugin_2/plugin.py

@@ -17,6 +17,8 @@
 import re
 from bs4 import BeautifulSoup as bs
 
+from mkdocs_git_committers_plugin_2.exclude import exclude
+
 LOG = logging.getLogger("mkdocs.plugins." + __name__)
 
 class GitCommittersPlugin(BasePlugin):
@@ -28,6 +30,7 @@ class GitCommittersPlugin(BasePlugin):
         ('docs_path', config_options.Type(str, default='docs/')),
         ('enabled', config_options.Type(bool, default=True)),
         ('cache_dir', config_options.Type(str, default='.cache/plugin/git-committers')),
+        ("exclude", config_options.Type(list, default=[])),
     )
 
     def __init__(self):
@@ -36,6 +39,7 @@ def __init__(self):
         self.enabled = True
         self.authors = dict()
         self.cache_page_authors = dict()
+        self.exclude = list()
         self.cache_date = ''
 
     def on_config(self, config):
@@ -55,9 +59,13 @@ def on_config(self, config):
             self.githuburl = "https://github.com/"
         self.localrepo = Repo(".")
         self.branch = self.config['branch']
+        self.excluded_pages = self.config['exclude']
         return config
 
     def list_contributors(self, path):
+        if exclude(path.lstrip(self.config['docs_path']), self.excluded_pages):
+            return None, None
+        
         last_commit_date = ""
         path = path.replace("\\", "/")
         for c in Commit.iter_items(self.localrepo, self.localrepo.head, path):