Use custom typehint formatter #124
Conversation
It gets rendered in a bad way (my function does not apply to this case, so this is the default): This uses type Filename = str;
"""The name of a file."""
Mode = NewType("Mode", str)
"""File open mode"""
Flags: TypeAlias = int
""""File flags"""Interestingly, the link to I'll try and improve the rendering. |
|
I added handling of |
| {% endfor %}], | ||
| {% endfor %}], |
There was a problem hiding this comment.
Yes, black changed the corresponding line in the rendered conf.py.
| def _link(ty: type, kind: str, type_params: Optional[tuple[type, ...]] = None) -> str: | ||
| if ty.__module__ == 'builtins': | ||
| target = ty.__name__ | ||
| else: | ||
| target = f'{ty.__module__}.{ty.__name__}' | ||
| label = _typehint_aliases.get(target, target) | ||
| if type_params: | ||
| label += f'[{", ".join(ty.__name__ for ty in type_params)}]' | ||
| return f':{kind}:`{label} <{target}>`' |
There was a problem hiding this comment.
If I get this correctly we get working links now?
There was a problem hiding this comment.
We do for uses of NewType. It seems that either with the latest Python or latest Sphinx, they are shown in the docs and then we also get links. It doesn't work with type Filename = str as the example shows, though.
Fixes #61
The docs don't show type aliases, so the refs that this generates don't work. I added them regardless for when we (hopefully) find a way to show aliases. I added the underlying type so that users can find out what types are actually required.
The result is still quite verbose. It could be made more compact by removing the module name. But then it is harder to find the definitions of the types.
With this change, this:
becomes this:
But it does not handle
TypeVar. So this:becomes this:
