Function log_once

python/ray/util/debug.py:18–55

Returns True if this is the "first" call for a given key. Various logging settings can adjust the definition of "first". Args: key: A unique identifier for the call site. Returns: True if this is the first call for ``key`` (subject to the current ``log_once`` s

(key: str)

@DeveloperAPI
def log_once(key: str) -> bool:
    """Returns True if this is the "first" call for a given key.

    Various logging settings can adjust the definition of "first".

    Args:
        key: A unique identifier for the call site.

    Returns:
        True if this is the first call for ``key`` (subject to the current
        ``log_once`` settings), False otherwise.

    Example:

        .. testcode::

            import logging
            from ray.util.debug import log_once

            logger = logging.getLogger(__name__)
            if log_once("some_key"):
                logger.info("Some verbose logging statement")
    """

    global _last_logged

    if _disabled:
        return False
    elif key not in _logged:
        _logged.add(key)
        _last_logged = time.time()
        return True
    elif _periodic_log and time.time() - _last_logged > 60.0:
        _logged.clear()
        _last_logged = time.time()
        return False
    else:
        return False


@DeveloperAPI