CODEWITHSUNDEEP
pythonlogging
user1051870
user1051870

Reputation: 913

Python logging done/fail messages

When using Python logging library, standard approach is just to write some message like this:

logging.info("All right")

But sometimes it necessary to show result status of some (long) task (after a while after output of main part of the message). For example:

Some long computing...    [done]

or

Some long computing...    [fail]

How can I solve this problem?

TOTAL:

Ok. It is possible, but only in the next line. For output success message in the same line you must use other tool (probably, custom), not logging Python library.

Upvotes: 3

Views: 6939

Answers (5)

supermitch
supermitch

Reputation: 2952

While you can do this with printing (see Print in one line dynamically) you can't do it with logging, as others have said.

However, my solution is a very simple context manager:

import contextlib

@contextlib.contextmanager
def log_context(logger, message):
    try:
        yield
        logger.log(logging.INFO, f'{message} [done]')
    except Exception:
        logger.log(logging.WARNING, f'{message} [fail]')
        raise

You can use this as follows:

log = logging.getLogger(__name__)
with log_context(log, 'Slow function...'):
   very_slow_function(42)

and this will log something like either

[INFO] Slow function... [done]

or

[WARNING] Slow function... [fail]

if very_slow_function raises any exception.

Upvotes: 0

gsmaker
gsmaker

Reputation: 593

Could you please try as below? Actually I could not understand your exactly problem.

#!/usr/bin/python

status_success = "Done"
status_fail = "Fail"

import logging
logging.basicConfig(format='%(levelname)s:%(message)s', level=logging.DEBUG)
"""
Do some computation here and based on that result display the below message
"""
logging.info('Some long computation [%s]' % status_success)

Or

logging.info('Some long computation [%s]' % status_fail)

Upvotes: 1

Vinay Sajip
Vinay Sajip

Reputation: 99315

Logging isn't meant to be used as a progress UI ... your program should work the same way whether or not logging is configured and even when the verbosity is set to minimum. If you want to print something to the console, use print rather than logging.

Upvotes: 2

kll
kll

Reputation: 111

The obvious solution would be to only log the line after you know if your process succeeded or not. I take it by your question though that you want to provide the user with some output to make it apparent that your computing process is working.

As far I know, it is not possible to do what you want using the python logging module as it is in its very nature line oriented. Imagine you would be sending this to a syslog server, how would the server understand that these two text messages belong together? The server would, in addition, need to keep state, which in general is something we don't want.

Either abandon the logging module in preference of simple print statements or log after the computing is done.

print "Some long computation...",
res = compute()
print "res"

Upvotes: 1

Michael David Watson
Michael David Watson

Reputation: 3071

It sounds like this might help you out.

import logging

logging.basicConfig(format = "%(asctime)s - %(levelname)s - %(message)s", 
                    level = logging.DEBUG)

logging.info("Long Task is starting")
try:
    StartLongTaskFunction()
    logging.info("Long task finished")
except:
    logging.exception("Long task failed")

Note that logging.exception() is slightly different from logging.error(). After the log entry is added for logging.exception(), the entire Python error message is included as well.

If you want to log critical events in StartLongTaskFunction, you can insert log entries inside this function as well. Even if you import this function from a separate module, you can still reference the same log file.

Upvotes: 2

Related Questions