Skip to content
Open
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
15 changes: 14 additions & 1 deletion pdoc/doc.py
Original file line number Diff line number Diff line change
Expand Up @@ -1143,7 +1143,20 @@ def default_value_str(self) -> str:
if self.default_value is empty:
return ""
if isinstance(self.default_value, TypeAliasType):
formatted = formatannotation(self.default_value.__value__)
try:
value = self.default_value.__value__
except NameError:
module_name = self.default_value.__module__
module = sys.modules.get(module_name) if module_name else None
if module is None:
return self.default_value.__name__
expression = f"{self.default_value.__name__}.__value__"
value = safe_eval_type(
expression, module.__dict__, None, module, self.fullname
)
if isinstance(value, str) and value == expression:
return self.default_value.__name__
formatted = formatannotation(value)
return _remove_collections_abc(formatted)
elif self.annotation == TypeAlias:
formatted = formatannotation(self.default_value)
Expand Down
39 changes: 39 additions & 0 deletions test/test_doc.py
Original file line number Diff line number Diff line change
@@ -1,11 +1,13 @@
import builtins
import dataclasses
from pathlib import Path
import sys
import types
from unittest.mock import patch

import pytest

import pdoc
from pdoc import extract
from pdoc.doc import Class
from pdoc.doc import Module
Expand All @@ -16,6 +18,43 @@
here = Path(__file__).parent


@pytest.mark.skipif(sys.version_info < (3, 12), reason="requires type statements")
def test_type_alias_with_type_checking_import(tmp_path):
module_file = tmp_path / "alias_with_type_checking.py"
module_file.write_text(
"from __future__ import annotations\n"
"import typing\n"
"if typing.TYPE_CHECKING:\n"
" from collections.abc import Sequence\n"
"type Values = Sequence[int]\n"
)
mod = extract.load_module(extract.parse_spec(module_file))
alias = Module(mod).members["Values"]
assert isinstance(alias, Variable)
assert alias.default_value_str == "Sequence[int]"
assert "Sequence[int]" in pdoc.pdoc(str(module_file))


@pytest.mark.skipif(sys.version_info < (3, 12), reason="requires type statements")
def test_type_alias_with_unresolvable_value(tmp_path):
module_file = tmp_path / "unresolvable_alias.py"
module_file.write_text("type Missing = DoesNotExist\n")
mod = extract.load_module(extract.parse_spec(module_file))
with pytest.warns(UserWarning, match="Error parsing type annotation"):
assert Module(mod).members["Missing"].default_value_str == "Missing"

namespace = {"__name__": "unregistered_module"}
exec("type Hidden = DoesNotExist", namespace)
alias = Variable(
"unregistered_module",
"Hidden",
taken_from=("unregistered_module", "Hidden"),
docstring="",
default_value=namespace["Hidden"],
)
assert alias.default_value_str == "Hidden"


def test_repr_tb(monkeypatch):
m = Module(dataclasses)
with patch("pdoc.doc._docstr", side_effect=ValueError):
Expand Down
Loading