from typing import Any
__debug_flag__ = {'enabled': False}
[docs]def is_debug_enabled() -> bool:
r"""Returns :obj:`True` if the debug mode is enabled."""
return __debug_flag__['enabled']
def set_debug_enabled(mode: bool) -> None:
__debug_flag__['enabled'] = mode
[docs]class debug:
r"""Context-manager that enables the debug mode to help track down errors
and separate usage errors from real bugs.
.. code-block:: python
with torch_geometric.debug():
out = model(data.x, data.edge_index)
"""
def __init__(self) -> None:
self.prev = is_debug_enabled()
def __enter__(self) -> None:
set_debug_enabled(True)
def __exit__(self, *args: Any) -> None:
set_debug_enabled(self.prev)
[docs]class set_debug:
r"""Context-manager that sets the debug mode on or off.
:class:`set_debug` will enable or disable the debug mode based on its
argument :attr:`mode`.
It can be used as a context-manager or as a function.
See :class:`debug` above for more details.
"""
def __init__(self, mode: bool) -> None:
self.prev = is_debug_enabled()
set_debug_enabled(mode)
def __enter__(self) -> None:
pass
def __exit__(self, *args: Any) -> None:
set_debug_enabled(self.prev)