Add windows support and glob patterns in exclude parameter

Author: timvink

README.md

@@ -154,7 +154,7 @@ Default is `false`. If set to `true` the plugin will use the time at `mkdocs bui
 
 ### `exclude`
 
-Default is empty. Specify a list of page source paths (one per line) that should not have a revision date included. This can be useful for example to remove the revision date from the front page. The source page is relative to your `docs/` folder. To exclude `docs/subfolder/page.md` specify in your `mkdocs.yml` a line under `exclude:` with `- subfolder/page.md`. Example:
+Default is empty. Specify a list of page source paths (one per line) that should not have a revision date included (excluded from processing by this plugin). This can be useful for example to remove the revision date from the front page. The source path of a page is relative to your `docs/` folder. You can also use [globs](https://docs.python.org/3/library/glob.html) instead of full source paths. To exclude `docs/subfolder/page.md` specify in your `mkdocs.yml` a line under `exclude:` with `- subfolder/page.md`. Some examples:
 
 ```yaml
 # mkdocs.yml
@@ -164,6 +164,7 @@ plugins:
         - index.md
         - subfolder/page.md
         - another_page.md
+        - folder/*
 ```
 
 ## Contributing

mkdocs_git_revision_date_localized_plugin/exclude.py

@@ -0,0 +1,46 @@
+"""
+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 inspired by / adapted from
+    https://github.com/apenwarr/mkdocs-exclude/blob/master/mkdocs_exclude/plugin.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_revision_date_localized_plugin/plugin.py

@@ -17,6 +17,7 @@
 
 # package modules
 from mkdocs_git_revision_date_localized_plugin.util import Util
+from mkdocs_git_revision_date_localized_plugin.exclude import exclude
 
 from typing import Any, Dict
 
@@ -142,7 +143,7 @@ def on_page_markdown(
         """
         # Exclude pages specified in config
         excluded_pages = self.config.get("exclude", [])
-        if page.file.src_path in excluded_pages:
+        if exclude(page.file.src_path, excluded_pages):
             logging.debug("Excluding page " + page.file.src_path)
             return markdown
 

tests/test_exclude.py

@@ -0,0 +1,19 @@
+from mkdocs_git_revision_date_localized_plugin.exclude import exclude
+import pytest
+
+def test_exclude():
+
+    with pytest.raises(AssertionError):
+        exclude("fsdfs", "not a list")
+
+    globs = ["index.md"]
+    assert exclude("index.md", globs)
+
+    globs = ["*.md"]
+    assert exclude("index.md", globs)
+    assert exclude("folder/index.md", globs)
+    assert exclude("folder\\index.md", globs)
+
+    globs = ["folder/*"]
+    assert exclude("folder/index.md", globs)
+    assert not exclude("subfolder/index.md", globs)