r"""
crate_anon/common/logfunc.py
===============================================================================
Copyright (C) 2015, University of Cambridge, Department of Psychiatry.
Created by Rudolf Cardinal (rnc1001@cam.ac.uk).
This file is part of CRATE.
CRATE is free software: you can redistribute it and/or modify
it under the terms of the GNU General Public License as published by
the Free Software Foundation, either version 3 of the License, or
(at your option) any later version.
CRATE is distributed in the hope that it will be useful,
but WITHOUT ANY WARRANTY; without even the implied warranty of
MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
GNU General Public License for more details.
You should have received a copy of the GNU General Public License
along with CRATE. If not, see <https://www.gnu.org/licenses/>.
===============================================================================
**Log functions.**
"""
# =============================================================================
# Imports
# =============================================================================
import logging
from typing import Set
log = logging.getLogger(__name__)
# =============================================================================
# Output
# =============================================================================
_warned = set() # type: Set[str]
[docs]def warn_once(
msg: str, logger: logging.Logger = None, level: int = logging.WARN
) -> None:
"""
Warns the user once only.
"""
global _warned
logger = logger or log
if msg not in _warned:
logger.log(level, msg)
_warned.add(msg)