Something error in loguru stub file

loguru.Logger is imported as _Logger, Logger class cannot accessed from loguru top level module actually.

This will cause static type checking failed or ImportError like "loguru.Logger" is incompatible with "loguru._logger.Logger"

https://github.com/Delgan/loguru/blob/5e754dd4239f4703eec007c4efaefbbfe272132b/loguru/__init__.pyi#L226

https://github.com/Delgan/loguru/blob/5e754dd4239f4703eec007c4efaefbbfe272132b/loguru/__init__.py#L11

[yanyongyu]

Add safe_getattr when AttributeError to get_type_hints could be fine. I will make a pull request to sphinx and close this later.

[yanyongyu]

About Sphinx autodoc:

autodoc do not check the annotation in module level function: https://github.com/sphinx-doc/sphinx/blob/f59026865a8c658acbc6d5690c146f4be0851854/sphinx/ext/autodoc/__init__.py#L1313-L1318

but checks the annotation for module level data using typing.get_type_hints: https://github.com/sphinx-doc/sphinx/blob/f59026865a8c658acbc6d5690c146f4be0851854/sphinx/ext/autodoc/__init__.py#L1981-L2005

and i find a monkey patch:

Solution

from typing import TYPE_CHECKING

import loguru

if TYPE_CHECKING:
	from loguru import Logger

my_logger: "Logger" = loguru.logger

both static type checking and sphinx autodoc report 0 errors!

Explain:

• sphinx handled NameError caused by eval ForwardRef
• "loguru.Logger" not work and raise AttributeError instead of NameError when eval
• giving a nonexist annotation value will be fine
• using typing.TYPE_CHECKING to keep the static type checking working