fold long variable default values, fix mitmproxy#507

mhils · Feb 19, 2023 · 77d5081 · 77d5081
1 parent dd3637d
commit 77d5081
Show file tree

Hide file tree

Showing 23 changed files with 106 additions and 50 deletions.
diff --git a/CHANGELOG.md b/CHANGELOG.md
@@ -7,6 +7,8 @@
  - pdoc now skips constructors if they neither have a docstring nor any parameters. This improves display
    of classes that are not meant to be instantiated manually, for example when using PyO3.
    ([#510](https://github.com/mitmproxy/pdoc/pull/510), @mhils)
+ - Automatically fold a variable's default value if it exceeds 100 characters.
+   Feedback on this cutoff is welcome!
  - Add a workaround to support inherited TypedDicts.
    ([#504](https://github.com/mitmproxy/pdoc/issues/504), @mhils)
  - `Variable.default_value_str` does not include the ` = ` prefix anymore. It will now emit a warning and return

diff --git a/pdoc/templates/content.css b/pdoc/templates/content.css
@@ -16,6 +16,7 @@ This makes sure that the pdoc styling doesn't leak to the rest of the page when
 }
 
 .pdoc .pdoc-button {
+    cursor: pointer;
     display: inline-block;
     border: solid black 1px;
     border-radius: 2px;
@@ -332,6 +333,33 @@ This makes sure that the pdoc styling doesn't leak to the rest of the page when
     color: var(--annotation);
 }
 
+/* Show/Hide buttons for long default values */
+.pdoc .view-value-toggle-state,
+.pdoc .view-value-toggle-state ~ .default_value {
+    display: none;
+}
+.pdoc .view-value-toggle-state:checked ~ .default_value {
+    display: inherit;
+}
+.pdoc .view-value-button {
+    font-size: .5rem;
+    vertical-align: middle;
+    border-style: dashed;
+    margin-top: -0.1rem;
+}
+.pdoc .view-value-button:hover {
+    background: white;
+}
+.pdoc .view-value-button::before {
+    content: "show";
+    text-align: center;
+    width: 2.2em;
+    display: inline-block;
+}
+.pdoc .view-value-toggle-state:checked ~ .view-value-button::before {
+    content: "hide";
+}
+
 /* Inherited Members */
 .pdoc .inherited {
     margin-left: 2rem;

diff --git a/pdoc/templates/default/module.html.jinja2 b/pdoc/templates/default/module.html.jinja2
@@ -140,8 +140,13 @@ See https://pdoc.dev/docs/pdoc/render_helpers.html#DefaultMacroExtension for an
     {%- endif -%}
 {% enddefaultmacro %}
 {% defaultmacro default_value(var) -%}
-    {%- if var.default_value_str -%}
-        <span class="default_value"> = {{ var.default_value_str | escape | linkify }}</span>
+    {%- if var.default_value_str %}
+        =
+        {% if var.default_value_str | length > 100 -%}
+            <input id="{{ var.qualname }}-view-value" class="view-value-toggle-state" type="checkbox" aria-hidden="true" tabindex="-1">
+            <label class="view-value-button pdoc-button" for="{{ var.qualname }}-view-value"></label>
+        {%- endif -%}
+        <span class="default_value">{{ var.default_value_str | escape | linkify }}</span>
     {%- endif -%}
 {% enddefaultmacro %}
 {% defaultmacro annotation(var) %}

diff --git a/test/testdata/demo.html b/test/testdata/demo.html
diff --git a/test/testdata/demo_eager.html b/test/testdata/demo_eager.html
diff --git a/test/testdata/demo_long.html b/test/testdata/demo_long.html
diff --git a/test/testdata/demopackage.html b/test/testdata/demopackage.html
diff --git a/test/testdata/demopackage_dir.html b/test/testdata/demopackage_dir.html
diff --git a/test/testdata/example_customtemplate.html b/test/testdata/example_customtemplate.html
diff --git a/test/testdata/example_darkmode.html b/test/testdata/example_darkmode.html
diff --git a/test/testdata/example_mkdocs.html b/test/testdata/example_mkdocs.html
diff --git a/test/testdata/flavors_google.html b/test/testdata/flavors_google.html
diff --git a/test/testdata/flavors_numpy.html b/test/testdata/flavors_numpy.html
diff --git a/test/testdata/flavors_rst.html b/test/testdata/flavors_rst.html
diff --git a/test/testdata/math_demo.html b/test/testdata/math_demo.html
diff --git a/test/testdata/misc.html b/test/testdata/misc.html
diff --git a/test/testdata/misc_py310.html b/test/testdata/misc_py310.html
diff --git a/test/testdata/misc_py311.html b/test/testdata/misc_py311.html
diff --git a/test/testdata/misc_py39.html b/test/testdata/misc_py39.html
diff --git a/test/testdata/render_options.html b/test/testdata/render_options.html
diff --git a/test/testdata/top_level_reimports.html b/test/testdata/top_level_reimports.html
diff --git a/test/testdata/type_checking_imports.html b/test/testdata/type_checking_imports.html
diff --git a/test/testdata/type_stub.html b/test/testdata/type_stub.html