Include new function yaml_support() from super_collections (#258)

  - The purpose is to prevent failures of yaml dumps

Author: fralau

mkdocs_macros/plugin.py

@@ -17,7 +17,8 @@
 from jinja2 import (
     Environment, FileSystemLoader, Undefined, DebugUndefined, StrictUndefined,
 )
-from super_collections import SuperDict
+from super_collections import SuperDict, yaml_support
+yaml_support()
 
 from mkdocs.config import config_options
 from mkdocs.config.config_options import Type as PluginType
@@ -29,7 +30,7 @@
 from mkdocs_macros.util import (
     install_package, parse_package, trace, debug,
     update, import_local_module, format_chatter, LOG, get_log_level,
-    setup_directory, CustomEncoder,
+    setup_directory
     # SuperDict, 
 )
 
@@ -881,16 +882,13 @@ def on_pre_build(self, *, config):
         after the execution of the `on_config()` of this plugin.
         """
         trace("Config variables:", list(self.variables.keys()))
-        debug("Config variables:\n", payload=json.dumps(self.variables, 
-                                                    cls=CustomEncoder))
+        debug("Config variables:\n", payload=SuperDict(self.variables).to_json())
         if self.macros:
             trace("Config macros:", list(self.macros.keys()))
-            debug("Config macros:", payload=json.dumps(self.macros,
-                                                    cls=CustomEncoder))
+            debug("Config macros:", payload=SuperDict(self.macros).to_json())
         if self.filters:
             trace("Config filters:", list(self.filters.keys()))
-            debug("Config filters:", payload=json.dumps(self.filters,
-                                                    cls=CustomEncoder))
+            debug("Config filters:", payload=SuperDict(self.filters).to_json())
 
 
     def on_nav(self, nav, config, files):

mkdocs_macros/util.py

@@ -9,6 +9,7 @@
 import os, sys, importlib.util, shutil
 from typing import Literal
 from packaging.version import Version
+import pkg_resources
 import json
 import inspect
 from datetime import datetime
@@ -116,32 +117,7 @@ def format_chatter(*args, prefix:str, color:str=TRACE_COLOR):
 
 
 
-from collections import UserDict
 
-class CustomEncoder(json.JSONEncoder):
-    """
-    Custom encoder for JSON serialization.
-    Used for debugging purposes.
-    """
-    def default(self, obj: Any) -> Any:
-        if isinstance(obj, datetime):
-            return obj.isoformat()
-        if isinstance(obj, UserDict):
-            # for objects used by MkDocs (config, plugin, etc.s)
-            return dict(obj)
-
-        elif inspect.isfunction(obj):
-            return f"Function: %s %s" % (inspect.signature(obj),
-                                        obj.__doc__)
-        try:
-            return super().default(obj)
-        except TypeError:
-            debug(f"json: cannot encode {obj.__class__}")
-            try:
-                return str(obj)
-            except Exception:
-                # in case something happens along the line
-                return f"!Non printable object: {obj.__class__}"
 
 
 
@@ -167,6 +143,20 @@ def parse_package(package:str):
         source_name, package_name = l[:2]
     return source_name, package_name
 
+
+
+def is_package_installed(source_name: str) -> bool:
+    """
+    Check if a package is installed, with its source name
+    (not it is Python import name).
+    """
+    try:
+        pkg_resources.get_distribution(source_name)
+        return True
+    except pkg_resources.DistributionNotFound:
+        return False
+
+
 def install_package(package:str):
     """
     Install a package from pip

pyproject.toml

@@ -9,15 +9,8 @@ description = "Unleash the power of MkDocs with macros and variables"
 readme = "README.md"
 license = { text = "MIT" }
 requires-python = ">=3.8"
-authors = [
-    { name = "Laurent Franceschetti"},
-]
-keywords = [
-    "macros",
-    "markdown",
-    "mkdocs",
-    "python",
-]
+authors = [{ name = "Laurent Franceschetti" }]
+keywords = ["macros", "markdown", "mkdocs", "python"]
 classifiers = [
     "Development Status :: 5 - Production/Stable",
     "Intended Audience :: Developers",
@@ -35,7 +28,7 @@ dependencies = [
     "pathspec",
     "python-dateutil",
     "pyyaml",
-    "super-collections",
+    "super-collections >= 0.5.0",
     "termcolor",
 ]
 
@@ -48,12 +41,11 @@ test = [
     "mkdocs-macros-test",
     "mkdocs-material>=6.2",
     "mkdocs-test",
-    "mkdocs-d2-plugin"
+    "mkdocs-d2-plugin",
 ]
 
 [project.entry-points."mkdocs.plugins"]
 macros = "mkdocs_macros.plugin:MacrosPlugin"
 
 [project.urls]
 Homepage = "https://github.com/fralau/mkdocs_macros_plugin"
-