function-valued default parameters are now represented as jut <function foo>

Author: patrick-kidger

.pre-commit-config.yaml

@@ -1,13 +1,13 @@
 repos:
   - repo: https://github.com/ambv/black
-    rev: stable
+    rev: 22.3.0
     hooks:
     - id: black
   - repo: https://github.com/PyCQA/isort
-    rev: 5.9.3
+    rev: 5.10.1
     hooks:
     - id: isort
   - repo: https://github.com/pycqa/flake8
-    rev: 3.9.2
+    rev: 4.0.1
     hooks:
     - id: flake8

README.md

@@ -12,6 +12,7 @@ _For use as part of the documentation-generation-for-Python stack that comprises
 - Adds an `abstractmethod`/`abstractproperty` property to appear in the documentation instead. (Useful when specifying abstract base classes.)
 - Removed the `dataclass` and `special` properties that appear in the documentation. (I find that these just add visual noise.)
 - Removed the `-> None` return annotation on `__init__` methods.
+- Function-valued defaults now display as just `<function foo>` rather than `<function foo at 0x7f5428d27a60>`.
 
 Note that you must run the `mkdocs` command twice, as these custom tweaks write a cache to disk -- listing all the public objects -- that are then used on the second run. If you see a `.all_objects.cache` file appear -- this is why. (You may wish to add the file to your `.gitignore`.)
 

pytkdocs_tweaks/__init__.py

@@ -11,9 +11,10 @@
 
 import pytkdocs
 import pytkdocs.cli
+import pytkdocs.serializer
 
 
-__version__ = "0.0.4"
+__version__ = "0.0.5"
 
 
 _cachefile = pathlib.Path(".all_objects.cache")
@@ -230,8 +231,20 @@ def process_config(config):
     if not _cachefile.exists():
         with _cachefile.open("w") as f:
             json.dump({}, f)
+
     pytkdocs.cli.process_config = process_config
 
+    _serialize_signature_parameter = pytkdocs.serializer.serialize_signature_parameter
+
+    def serialize_signature_parameter(parameter):
+        out = _serialize_signature_parameter(parameter)
+        if inspect.isfunction(parameter.default):
+            assert "default" in out
+            out["default"] = f"<function {parameter.default.__name__}>"
+        return out
+
+    pytkdocs.serializer.serialize_signature_parameter = serialize_signature_parameter
+
     # By default pytkdocs has some really weird behaviour in which the docstring for
     # inherited magic methods are removed. This removes that behaviour.
     pytkdocs.loader.RE_SPECIAL = argparse.Namespace(match=lambda _: False)