tenacity/after.py

# Copyright 2016 Julien Danjou
# Copyright 2016 Joshua Harlow
# Copyright 2013-2014 Ray Holder
#
# Licensed under the Apache License, Version 2.0 (the "License");
# you may not use this file except in compliance with the License.
# You may obtain a copy of the License at
#
# http://www.apache.org/licenses/LICENSE-2.0
#
# Unless required by applicable law or agreed to in writing, software
# distributed under the License is distributed on an "AS IS" BASIS,
# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
# See the License for the specific language governing permissions and
# limitations under the License.

from tenacity import _utils


def after_nothing(func, trial_number, trial_time_taken):
    """After call strategy that does nothing."""


def after_log(logger, log_level, sec_format="%0.3f"):
    """After call strategy that logs to some logger the finished attempt."""
    log_tpl = ("Finished call to '%s' after " + str(sec_format) + "(s), "
               "this was the %s time calling it.")

    def log_it(func, trial_number, trial_time_taken):
        logger.log(log_level, log_tpl,
                   _utils.get_callback_name(func), trial_time_taken,
                   _utils.to_ordinal(trial_number))

    return log_it