CODEWITHSUNDEEP
pythonlogging
user2883071
user2883071

Reputation: 980

Best practices for logging in python

I have written a simple python package which has a set of functions that perform simple operations (data manipulation). I am trying to enhance the package and add more functionality for logging, which leads me to this question.

Should I expect the user of the package to pass in a file descriptor or a file handler of the python logging module into the methods of the package, or should the package itself have its own logging module which the methods within the package employ.

I can see benefits (user controls logging and can maintain a flow of function calls based on the same handler) and cons (users logger is not good enough) in both, however what is / are best practices in this case.

Upvotes: 0

Views: 2888

Answers (1)

John Gordon
John Gordon

Reputation: 33335

In your module, create a logger object:

import logging
LOGGER = logging.getLogger(__name__)

And then call the appropriate functions on that object:

LOGGER.debug('you probably dont care about this')
LOGGER.info('some info message')
LOGGER.error('whoops, something went wrong')

If the user has configured the logging subsystem correctly, then the messages will automatically go where the user wants them to go (a file, stderr, syslog, etc.)

Upvotes: 4

Related Questions