sphinxnotes-project 1.0a47__tar.gz → 1.0a49__tar.gz

{sphinxnotes_project-1.0a47/src/sphinxnotes_project.egg-info → sphinxnotes_project-1.0a49}/PKG-INFO

@@ -1,6 +1,6 @@
 Metadata-Version: 2.4
 Name: sphinxnotes-project
-Version: 1.0a47
+Version: 1.0a49
 Summary: A Sphinx extension that provides useful directives for creating project documentation
 Author: Shengyu Zhang
 Maintainer: Shengyu Zhang
@@ -25,6 +25,7 @@ Description-Content-Type: text/x-rst
 License-File: LICENSE
 Requires-Dist: Sphinx>=7.0
 Requires-Dist: sphinxnotes-any>=3.0b0
+Requires-Dist: sphinxnotes-render
 Requires-Dist: sphinx_design
 Provides-Extra: dev
 Requires-Dist: build; extra == "dev"

{sphinxnotes_project-1.0a47 → sphinxnotes_project-1.0a49}/pyproject.toml

@@ -43,6 +43,7 @@ dependencies = [
 
     # CUSTOM DEPENDENCIES START
     "sphinxnotes-any >= 3.0b0",
+    "sphinxnotes-render",
     "sphinx_design",
     # CUSTOM DEPENDENCIES END
 ]

{sphinxnotes_project-1.0a47 → sphinxnotes_project-1.0a49}/src/sphinxnotes/project/sphinxnotes_render_ext.py

@@ -11,7 +11,8 @@ See also https://sphinx.silverrainz.me/render/.
 """
 
 from __future__ import annotations
-from typing import TYPE_CHECKING
+from typing import TYPE_CHECKING, get_args, get_origin
+import types as pytypes
 
 from sphinx.config import ENUM
 from sphinxnotes.render import filter
@@ -25,10 +26,23 @@ if TYPE_CHECKING:
     from sphinx.environment import BuildEnvironment
 
 
+def _fmt_type(t) -> str:
+    origin = get_origin(t)
+    args = get_args(t)
+    if origin is pytypes.UnionType:
+        return ' | '.join(_fmt_type(a) for a in args)
+    if t is type(None):
+        return 'None'
+    if origin is not None:
+        args_str = ', '.join(_fmt_type(a) for a in args)
+        return f'{_fmt_type(origin)}[{args_str}]'
+    return t.__name__
+
+
 def _format_autoconfval_types(valid_types) -> list[str]:
     if isinstance(valid_types, ENUM):
         return [f'``{c!r}``' for c in sorted(valid_types._candidates)]  # pyright: ignore[reportPrivateUsage]
-    return [f':py:`{t.__name__}`' for t in valid_types]
+    return [f':py:`{_fmt_type(t)}`' for t in valid_types]
 
 
 @filter('autoconfval_types')

{sphinxnotes_project-1.0a47 → sphinxnotes_project-1.0a49/src/sphinxnotes_project.egg-info}/PKG-INFO

@@ -1,6 +1,6 @@
 Metadata-Version: 2.4
 Name: sphinxnotes-project
-Version: 1.0a47
+Version: 1.0a49
 Summary: A Sphinx extension that provides useful directives for creating project documentation
 Author: Shengyu Zhang
 Maintainer: Shengyu Zhang
@@ -25,6 +25,7 @@ Description-Content-Type: text/x-rst
 License-File: LICENSE
 Requires-Dist: Sphinx>=7.0
 Requires-Dist: sphinxnotes-any>=3.0b0
+Requires-Dist: sphinxnotes-render
 Requires-Dist: sphinx_design
 Provides-Extra: dev
 Requires-Dist: build; extra == "dev"

{sphinxnotes_project-1.0a47 → sphinxnotes_project-1.0a49}/src/sphinxnotes_project.egg-info/SOURCES.txt

@@ -43,4 +43,5 @@ src/sphinxnotes_project.egg-info/dependency_links.txt
 src/sphinxnotes_project.egg-info/requires.txt
 src/sphinxnotes_project.egg-info/top_level.txt
 tests/__init__.py
-tests/test_always_pass.py
+tests/test_always_pass.py
+tests/test_render_ext.py

{sphinxnotes_project-1.0a47 → sphinxnotes_project-1.0a49}/src/sphinxnotes_project.egg-info/requires.txt

@@ -1,5 +1,6 @@
 Sphinx>=7.0
 sphinxnotes-any>=3.0b0
+sphinxnotes-render
 sphinx_design
 
 [dev]

sphinxnotes_project-1.0a49/tests/test_render_ext.py

@@ -0,0 +1,49 @@
+"""Tests for sphinxnotes_render_ext."""
+
+from sphinxnotes.project.sphinxnotes_render_ext import _fmt_type, _format_autoconfval_types
+from sphinx.config import ENUM
+
+
+class TestFmtType:
+    def test_simple_type(self):
+        assert _fmt_type(str) == 'str'
+        assert _fmt_type(int) == 'int'
+        assert _fmt_type(float) == 'float'
+        assert _fmt_type(bool) == 'bool'
+
+    def test_none_type(self):
+        assert _fmt_type(type(None)) == 'None'
+
+    def test_bare_generic(self):
+        assert _fmt_type(list) == 'list'
+        assert _fmt_type(dict) == 'dict'
+
+    def test_generic_alias(self):
+        assert _fmt_type(list[str]) == 'list[str]'
+        assert _fmt_type(dict[str, int]) == 'dict[str, int]'
+        assert _fmt_type(set[int]) == 'set[int]'
+
+    def test_nested_generic(self):
+        assert _fmt_type(dict[str, list[int]]) == 'dict[str, list[int]]'
+
+    def test_union_type(self):
+        assert _fmt_type(str | None) == 'str | None'
+        assert _fmt_type(int | str) == 'int | str'
+
+
+class TestFormatAutoconfvalTypes:
+    def test_enum(self):
+        result = _format_autoconfval_types(ENUM('tab', 'grid'))
+        assert result == ["``'grid'``", "``'tab'``"]
+
+    def test_simple_types(self):
+        result = _format_autoconfval_types(frozenset({str, int}))
+        assert set(result) == {':py:`str`', ':py:`int`'}
+
+    def test_generic_alias(self):
+        result = _format_autoconfval_types(frozenset({list[str]}))
+        assert result == [':py:`list[str]`']
+
+    def test_mixed_types(self):
+        result = _format_autoconfval_types(frozenset({list[str], str}))
+        assert set(result) == {':py:`list[str]`', ':py:`str`'}