#
"""timer - Function timing support."""
# Copyright © 2014-2020 James Rowe <jnrowe@gmail.com>
#
# SPDX-License-Identifier: GPL-3.0-or-later
#
# This file is part of jnrbase.
#
# jnrbase 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.
#
# jnrbase 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
# jnrbase. If not, see <http://www.gnu.org/licenses/>.
from datetime import datetime
from .human_time import human_timestamp
[docs]class Timing: # pylint: disable=too-few-public-methods
"""Timing context manager.
.. versionchanged:: 0.3.0
Renamed from ``Timer``.
Attributes:
verbose (bool): Print elapsed time
elapsed (datetime.timedelta): Duration of execution
"""
def __init__(self, *, verbose: bool = False) -> None:
"""Configure the timing Timing context manager.
Args:
verbose: Print elapsed time
"""
self.verbose = verbose
self._start = None
self.elapsed = None
def __enter__(self) -> 'Timing':
"""Enable the timer."""
self._start = datetime.utcnow()
return self
def __exit__(self, *args) -> None:
"""Output elapsed time."""
now = datetime.utcnow()
self.elapsed = now - self._start
if self.verbose:
print(f'Started {human_timestamp(self._start)}')