feat: Support hiding attribute values

Issue-292: #292
PR-293: #293

Author: bswck

docs/usage/configuration/members.md

@@ -519,6 +519,50 @@ def function_d():
 ////
 ///
 
+
+[](){#option-show_attribute_values}
+## `show_attribute_values`
+
+- **:octicons-package-24: Type [`bool`][] :material-equal: `True`{ title="default value" }**
+<!-- - **:octicons-project-template-24: Template :material-null:** (contained in [`class.html`][class template]) -->
+
+Show initial values of attributes in classes.
+
+```yaml title="in mkdocs.yml (global configuration)"
+plugins:
+- mkdocstrings:
+    handlers:
+      python:
+        options:
+          show_attribute_values: true
+```
+
+```md title="or in docs/some_page.md (local configuration)"
+::: path.to.object
+    options:
+      show_attribute_values: true
+```
+
+```python title="package/module.py"
+class SomeClass:
+  def __init__(self):
+      self.some_attr = 1
+```
+
+/// admonition | Preview
+    type: preview
+
+//// tab | With attribute values visible
+<h2><code>SomeClass</code></h2>
+<p>some_attr = 1</p>
+////
+
+//// tab | With attribute values hidden
+<h2><code>SomeClass</code></h2>
+<p>some_attr</p>
+////
+///
+
 [](){#option-show_submodules}
 ## `show_submodules`
 

src/mkdocstrings_handlers/python/_internal/config.py

@@ -622,6 +622,14 @@ class PythonInputOptions:
         ),
     ] = False
 
+    show_attribute_values: Annotated[
+        bool,
+        _Field(
+            group="members",
+            description="Show initial values of attributes in classes.",
+        ),
+    ] = True
+
     show_bases: Annotated[
         bool,
         _Field(

src/mkdocstrings_handlers/python/_internal/rendering.py

@@ -208,6 +208,7 @@ def do_format_attribute(
     line_length: int,
     *,
     crossrefs: bool = False,  # noqa: ARG001
+    show_value: bool = True,
 ) -> str:
     """Format an attribute.
 
@@ -235,7 +236,7 @@ def do_format_attribute(
             backlink_type="returned-by",
         )
         signature += f": {annotation}"
-    if attribute.value:
+    if show_value and attribute.value:
         value = template.render(context.parent, expression=attribute.value, signature=True, backlink_type="used-by")
         signature += f" = {value}"
 

src/mkdocstrings_handlers/python/templates/material/_base/attribute.html.jinja

@@ -55,7 +55,7 @@ Context:
           {% else %}
             {%+ filter highlight(language="python", inline=True) %}
               {{ attribute_name }}{% if attribute.annotation and config.show_signature_annotations %}: {{ attribute.annotation }}{% endif %}
-              {% if attribute.value %} = {{ attribute.value }}{% endif %}
+              {% if config.show_attribute_values and attribute.value %} = {{ attribute.value }}{% endif %}
             {% endfilter %}
           {% endif %}
         {% endblock heading %}
@@ -79,7 +79,7 @@ Context:
         This block renders the signature for the attribute.
         -#}
         {% if config.separate_signature %}
-          {% filter format_attribute(attribute, config.line_length, crossrefs=config.signature_crossrefs) %}
+          {% filter format_attribute(attribute, config.line_length, crossrefs=config.signature_crossrefs, show_value=config.show_attribute_values) %}
             {{ attribute.name }}
           {% endfilter %}
         {% endif %}