ENH: Add possibility to turn section invisible

skops/card/_model_card.py

@@ -243,16 +243,20 @@ class Section:
     empty string) or a ``Formattable``, which is simply an object with a
     ``format`` method that returns a string.
 
-    Finally, the section can contain subsections, which again are dicts of
+    The section can contain subsections, which again are dicts of
     string keys and section values (the dict can be empty). Therefore, the model
     card representation forms a tree structure, making use of the fact that dict
     order is preserved.
 
+    The section may also contain a ``visible`` flag, which determines if the
+    section will be shown when the card is rendered.
+
     """
 
     title: str
     content: Formattable | str
     subsections: dict[str, Section] = field(default_factory=dict)
+    visible: bool = True
 
     def select(self, key: str) -> Section:
         """Return a subsection or subsubsection of this section
@@ -1182,6 +1186,9 @@ def _generate_content(
 
         """
         for val in data.values():
+            if not val.visible:
+                continue
+
             title = f"{depth * '#'} {val.title}"
             yield title
 

skops/card/tests/test_card.py

@@ -1492,3 +1492,104 @@ def test_custom_template_all_sections_present(self, template, card):
         # no other top level sections as those defined in the template
         expected = ["My description", "Model", "Foo"]
         assert list(card._data.keys()) == expected
+
+
+class TestRenderedCardVisibility:
+    """Check that visibility flag works
+
+    Sections that are not visible should not be rendered, neither when calling
+    model_card.render, nor when calling model_card.save.
+
+    """
+
+    @pytest.fixture
+    def template(self):
+        return {
+            "Model": "Here goes model related stuff",
+            "Model/Metrics": "123",
+            "Model/Bar": "Baz",
+            "Authors": "Jane Doe",
+        }
+
+    @pytest.fixture
+    def card(self, template):
+        model = fit_model()
+        card = Card(model, template=template)
+        return card
+
+    def test_all_visible_by_default(self, card):
+        rendered = card.render()
+        expected = (
+            "# Model\n\n"
+            "Here goes model related stuff\n\n"
+            "## Metrics\n\n"
+            "123\n\n"
+            "## Bar\n\n"
+            "Baz\n\n"
+            "# Authors\n\n"
+            "Jane Doe"
+        )
+        assert rendered.strip() == expected
+
+    def test_section_invisible(self, card):
+        card.select("Model/Metrics").visible = False
+        rendered = card.render()
+        expected = (
+            "# Model\n\n"
+            "Here goes model related stuff\n\n"
+            "## Bar\n\n"
+            "Baz\n\n"
+            "# Authors\n\n"
+            "Jane Doe"
+        )
+        assert rendered.strip() == expected
+
+    def test_restoring_visibility_works(self, card):
+        card.select("Model/Metrics").visible = False
+        card.select("Model/Metrics").visible = True
+        expected = (
+            "# Model\n\n"
+            "Here goes model related stuff\n\n"
+            "## Metrics\n\n"
+            "123\n\n"
+            "## Bar\n\n"
+            "Baz\n\n"
+            "# Authors\n\n"
+            "Jane Doe"
+        )
+        rendered = card.render()
+        assert rendered.strip() == expected
+
+    def test_invisible_parent_section_hides_subsections(self, card):
+        # By making the parent section "Model" invisible, all of the subsections
+        # are also turned invisible
+        card.select("Model").visible = False
+        # fmt: off
+        expected = (
+            "# Authors\n\n"
+            "Jane Doe"
+        )
+        # fmt: on
+        rendered = card.render()
+        assert rendered.strip() == expected
+
+    def test_visibility_with_card_save(self, card):
+        # Since .save and .render share the same functionality, it's not
+        # necessary to repeat all the tests above with .save. Just do one test
+        # to ensure that the same functionality is indeed being used.
+        file = tempfile.mkstemp(suffix=".md", prefix="skops-model-card")[1]
+        card.select("Model/Metrics").visible = False
+        card.save(file)
+
+        with open(file, "r") as f:
+            loaded = f.read()
+
+        expected = (
+            "# Model\n\n"
+            "Here goes model related stuff\n\n"
+            "## Bar\n\n"
+            "Baz\n\n"
+            "# Authors\n\n"
+            "Jane Doe"
+        )
+        assert loaded.strip() == expected