ED/EDMarketConnector
1
0
Fork 0
mirror of https://github.com/EDCD/EDMarketConnector.git synced 2025-04-14 16:27:13 +03:00
Code Issues Projects Releases Wiki Activity

Contributing.md: Update logging docs for auto qualname and proper import

Browse Source
This commit is contained in:
Athanasius 2020-07-24 22:41:30 +01:00
parent 2e58d106bd
commit a82824c0e9
1 changed files with 23 additions and 8 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

31
Contributing.md
View File

@ -225,9 +225,12 @@ No:
types. types.
* Use `logging` not `print()`, and definitely not `sys.stdout.write()`! * Use `logging` not `print()`, and definitely not `sys.stdout.write()`!
`EDMarketConnector.py` sets up `logger` for this, so: `EDMarketConnector.py` sets up a `logging.Logger` for this under the
`appname`, so:
from EDMarketConnector import logger import logging
from config import appname
logger = logging.getLogger(appname)
logger.info(f'Some message with a {variable}') logger.info(f'Some message with a {variable}')
@ -235,14 +238,26 @@ No:
something something
except Exception as e: # Try to be more specific except Exception as e: # Try to be more specific
logger.error(f'Error in ... with ...', exc_info=e) logger.error(f'Error in ... with ...', exc_info=e)
Also if the code is within a class definition at all then please use: **DO NOT** use the following, as you might cause a circular import:
logger.info(f'{__class__}: ...) from EDMarketConnector import logger
so that the class name is included in the output. No `logger.Formatter` We have implemented a `logging.Filter` that adds support for the following
does not support this (probably because there's no way to get at the in `logging.Formatter()` strings:
information for a calling function).
1. `%(qualname)s` which gets the full `ClassA(.ClassB...).func` of the
calling function.
1. `%(class)s` which gets just the immediately encloding class name
of the calling function.
So don't worry about adding anything about the class or function you're
logging from, it's taken care of.
*Do use a pertinent message, even when using `exc_info=...` to log an
exception*. e.g. Logging will know you were in your `get_foo()` function
but you should still tell it what actually (failed to have) happened
in there.
* In general, please follow [PEP8](https://www.python.org/dev/peps/pep-0008/). * In general, please follow [PEP8](https://www.python.org/dev/peps/pep-0008/).