test bkp

.documentation/lib/python3.12/site-packages/material/utilities/__init__.py

@@ -0,0 +1,19 @@
+# Copyright (c) 2016-2025 Martin Donath <martin.donath@squidfunk.com>
+
+# Permission is hereby granted, free of charge, to any person obtaining a copy
+# of this software and associated documentation files (the "Software"), to
+# deal in the Software without restriction, including without limitation the
+# rights to use, copy, modify, merge, publish, distribute, sublicense, and/or
+# sell copies of the Software, and to permit persons to whom the Software is
+# furnished to do so, subject to the following conditions:
+
+# The above copyright notice and this permission notice shall be included in
+# all copies or substantial portions of the Software.
+
+# THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+# IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+# FITNESS FOR A PARTICULAR PURPOSE AND NON-INFRINGEMENT. IN NO EVENT SHALL THE
+# AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+# LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING
+# FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS
+# IN THE SOFTWARE.

.documentation/lib/python3.12/site-packages/material/utilities/filter/__init__.py

@@ -0,0 +1,124 @@
+# Copyright (c) 2016-2025 Martin Donath <martin.donath@squidfunk.com>
+
+# Permission is hereby granted, free of charge, to any person obtaining a copy
+# of this software and associated documentation files (the "Software"), to
+# deal in the Software without restriction, including without limitation the
+# rights to use, copy, modify, merge, publish, distribute, sublicense, and/or
+# sell copies of the Software, and to permit persons to whom the Software is
+# furnished to do so, subject to the following conditions:
+
+# The above copyright notice and this permission notice shall be included in
+# all copies or substantial portions of the Software.
+
+# THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+# IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+# FITNESS FOR A PARTICULAR PURPOSE AND NON-INFRINGEMENT. IN NO EVENT SHALL THE
+# AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+# LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING
+# FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS
+# IN THE SOFTWARE.
+
+from __future__ import annotations
+
+import logging
+
+from fnmatch import fnmatch
+from mkdocs.structure.files import File
+
+from .config import FilterConfig
+
+# -----------------------------------------------------------------------------
+# Classes
+# -----------------------------------------------------------------------------
+
+class Filter:
+    """
+    A filter.
+    """
+
+    def __init__(self, config: FilterConfig):
+        """
+        Initialize the filter.
+
+        Arguments:
+            config: The filter configuration.
+        """
+        self.config = config
+
+    def __call__(self, value: str, ref: str | None = None) -> bool:
+        """
+        Filter a value.
+
+        First, the inclusion patterns are checked. Regardless of whether they
+        are present, the exclusion patterns are checked afterwards. This allows
+        to exclude values that are included by the inclusion patterns, so that
+        exclusion patterns can be used to refine inclusion patterns.
+
+        Arguments:
+            value: The value to filter.
+            ref: The value used for logging.
+
+        Returns:
+            Whether the value should be included.
+        """
+        ref = ref or value
+
+        # Check if value matches one of the inclusion patterns
+        if self.config.include:
+            for pattern in self.config.include:
+                if fnmatch(value, pattern):
+                    break
+
+            # Value is not included
+            else:
+                log.debug(f"Excluding '{ref}' due to inclusion patterns")
+                return False
+
+        # Check if value matches one of the exclusion patterns
+        for pattern in self.config.exclude:
+            if fnmatch(value, pattern):
+                log.debug(f"Excluding '{ref}' due to exclusion patterns")
+                return False
+
+        # Value is not excluded
+        return True
+
+    # -------------------------------------------------------------------------
+
+    config: FilterConfig
+    """
+    The filter configuration.
+    """
+
+# -----------------------------------------------------------------------------
+
+class FileFilter(Filter):
+    """
+    A file filter.
+    """
+
+    def __call__(self, file: File) -> bool:
+        """
+        Filter a file by its source path.
+
+        Arguments:
+            file: The file to filter.
+
+        Returns:
+            Whether the file should be included.
+        """
+        if file.inclusion.is_excluded():
+            return False
+
+        # Filter file by source path
+        return super().__call__(
+            file.src_uri,
+            file.src_path
+        )
+
+# -----------------------------------------------------------------------------
+# Data
+# -----------------------------------------------------------------------------
+
+# Set up logging
+log = logging.getLogger("mkdocs.material.utilities")

.documentation/lib/python3.12/site-packages/material/utilities/filter/config.py

@@ -0,0 +1,47 @@
+# Copyright (c) 2016-2025 Martin Donath <martin.donath@squidfunk.com>
+
+# Permission is hereby granted, free of charge, to any person obtaining a copy
+# of this software and associated documentation files (the "Software"), to
+# deal in the Software without restriction, including without limitation the
+# rights to use, copy, modify, merge, publish, distribute, sublicense, and/or
+# sell copies of the Software, and to permit persons to whom the Software is
+# furnished to do so, subject to the following conditions:
+
+# The above copyright notice and this permission notice shall be included in
+# all copies or substantial portions of the Software.
+
+# THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+# IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+# FITNESS FOR A PARTICULAR PURPOSE AND NON-INFRINGEMENT. IN NO EVENT SHALL THE
+# AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+# LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING
+# FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS
+# IN THE SOFTWARE.
+
+from mkdocs.config.base import Config
+from mkdocs.config.config_options import ListOfItems, Type
+
+# -----------------------------------------------------------------------------
+# Classes
+# -----------------------------------------------------------------------------
+
+class FilterConfig(Config):
+    """
+    A filter configuration.
+    """
+
+    include = ListOfItems(Type(str), default = [])
+    """
+    Patterns to include.
+
+    This list contains patterns that are matched against the value to filter.
+    If the value matches at least one pattern, it will be included.
+    """
+
+    exclude = ListOfItems(Type(str), default = [])
+    """
+    Patterns to exclude.
+
+    This list contains patterns that are matched against the value to filter.
+    If the value matches at least one pattern, it will be excluded.
+    """