fix: Fix Sphinx inventory generation

pawamoy · web-flow · commit bbd85a92fa70 · 2021-04-21T20:57:19.000+02:00
Issue #265: #265 PR #267: #267
diff --git a/src/mkdocstrings/inventory.py b/src/mkdocstrings/inventory.py
@@ -90,5 +90,4 @@ def format_sphinx(self) -> bytes:
         )
 
         lines = [item.format_sphinx().encode("utf8") for item in self.values()]
-        # we use compression level 0 to make the file readable by humans
-        return header + zlib.compress(b"\n".join(lines), 0)
+        return header + zlib.compress(b"\n".join(lines) + b"\n", 9)
diff --git a/src/mkdocstrings/templates/python/material/function.html b/src/mkdocstrings/templates/python/material/function.html
@@ -17,7 +17,7 @@
       {% endif %}
 
       {% filter heading(heading_level,
-          role="func",
+          role="function",
           id=html_id,
           class="doc doc-heading",
           toc_label=function.name ~ "()") %}
@@ -36,7 +36,7 @@
     {% else %}
       {% if config.show_root_toc_entry %}
         {% filter heading(heading_level,
-            role="func",
+            role="function",
             id=html_id,
             toc_label=function.path,
             hidden=True) %}
diff --git a/src/mkdocstrings/templates/python/material/method.html b/src/mkdocstrings/templates/python/material/method.html
@@ -17,7 +17,7 @@
       {% endif %}
 
       {% filter heading(heading_level,
-          role="meth",
+          role="method",
           id=html_id,
           class="doc doc-heading",
           toc_label=method.name ~ "()") %}
@@ -36,7 +36,7 @@
     {% else %}
       {% if config.show_root_toc_entry %}
         {% filter heading(heading_level,
-            role="meth",
+            role="method",
             id=html_id,
             toc_label=method.path,
             hidden=True) %}
diff --git a/src/mkdocstrings/templates/python/material/module.html b/src/mkdocstrings/templates/python/material/module.html
@@ -17,7 +17,7 @@
       {% endif %}
 
       {% filter heading(heading_level,
-          role="mod",
+          role="module",
           id=html_id,
           class="doc doc-heading",
           toc_label=module.name) %}
@@ -33,7 +33,7 @@
     {% else %}
       {% if config.show_root_toc_entry %}
         {% filter heading(heading_level,
-            role="mod",
+            role="module",
             id=html_id,
             toc_label=module.path,
             hidden=True) %}
diff --git a/tests/test_inventory.py b/tests/test_inventory.py
@@ -1,34 +1,51 @@
 """Tests for the inventory module."""
 
+import sys
 from io import BytesIO
 from os.path import join
-from pathlib import Path
 
 import pytest
+from mkdocs.commands.build import build
+from mkdocs.config import load_config
 
 from mkdocstrings.inventory import Inventory, InventoryItem
 
-sphinx_inventory = pytest.importorskip("sphinx.util.inventory", reason="Sphinx is not installed")
-MKDOCSTRINGS_OBJECTS_INV = Path("site/objects.inv")
+sphinx = pytest.importorskip("sphinx.util.inventory", reason="Sphinx is not installed")
 
 
 @pytest.mark.parametrize(
-    "inventory",
+    "our_inv",
     [
         Inventory(),
         Inventory([InventoryItem(name="object_path", domain="py", role="obj", uri="page_url")]),
         Inventory([InventoryItem(name="object_path", domain="py", role="obj", uri="page_url#object_path")]),
         Inventory([InventoryItem(name="object_path", domain="py", role="obj", uri="page_url#other_anchor")]),
     ],
 )
-def test_sphinx_load_inventory_file(inventory):
+def test_sphinx_load_inventory_file(our_inv):
     """Perform the 'live' inventory load test."""
-    buffer = BytesIO(inventory.format_sphinx())
-    sphinx_inventory.InventoryFile.load(buffer, "", join)
+    buffer = BytesIO(our_inv.format_sphinx())
+    sphinx_inv = sphinx.InventoryFile.load(buffer, "", join)
 
+    sphinx_inv_length = sum(len(sphinx_inv[key]) for key in sphinx_inv)
+    assert sphinx_inv_length == len(our_inv.values())
 
-@pytest.mark.skipif(not MKDOCSTRINGS_OBJECTS_INV.exists(), reason="site/objects.inv does not exist")
+    for item in our_inv.values():
+        assert item.name in sphinx_inv[f"{item.domain}:{item.role}"]
+
+
+@pytest.mark.skipif(sys.version_info < (3, 7), reason="using plugins that require Python 3.7")
 def test_sphinx_load_mkdocstrings_inventory_file():
     """Perform the 'live' inventory load test on mkdocstrings own inventory."""
-    with MKDOCSTRINGS_OBJECTS_INV.open("rb") as fp:
-        sphinx_inventory.InventoryFile.load(fp, "", join)
+    mkdocs_config = load_config()
+    build(mkdocs_config)
+    own_inv = mkdocs_config["plugins"]["mkdocstrings"].handlers.inventory
+
+    with open("site/objects.inv", "rb") as fp:
+        sphinx_inv = sphinx.InventoryFile.load(fp, "", join)
+
+    sphinx_inv_length = sum(len(sphinx_inv[key]) for key in sphinx_inv)
+    assert sphinx_inv_length == len(own_inv.values())
+
+    for item in own_inv.values():
+        assert item.name in sphinx_inv[f"{item.domain}:{item.role}"]
diff --git a/tests/test_plugin.py b/tests/test_plugin.py

Original file line number	Diff line number	Diff line change
`@@ -90,5 +90,4 @@ def format_sphinx(self) -> bytes:`
`90`	`90`	`)`
`91`	`91`
`92`	`92`	`lines = [item.format_sphinx().encode("utf8") for item in self.values()]`
`93`		`- # we use compression level 0 to make the file readable by humans`
`94`		`- return header + zlib.compress(b"\n".join(lines), 0)`
	`93`	`+ return header + zlib.compress(b"\n".join(lines) + b"\n", 9)`