Logging

[Aldriana]

It would probably be good to have some manner of logging framework in place to help us debug this when it inevitably breaks (or even just if it starts to give people questionable results). As I recall the python logging framework is pretty good - so it's probably just a matter of putting some sample code for setting up handlers somewhere and then starting to log stuff. If there's something we want to do (in terms of standarized log format or whatever) that isn't well covered by the default, it might be necessary to create some simple wrappers (which would presumably want to go in core.logging or the like) and then use those instead.

[dazer]

I think I may be able to build this but, as usual, before starting writing I'd like to set up the ideas I have and check it with you:

I imagine we need a different logger for each file, or, at least one specific logger for Aldriana's module (maybe even two there: one for general purpose and a cycle related one), one for RogueDamageCalaculator, another for DamageCalculator; as for objects we could use a general one (maybe some specific ones for some complex objects) and a rogue specific one. I believe they'd be non hierarchized so we can set the level at which they generate events separately.
Would we like to have a top most priority one for reporting purposes? this one would never be used from our side but rather from the UI when our end throws errors or simply weird dps/ep reports; it would send us back the setup used (stats, weapons, spec, proc set, level, race and the like) and the outcome we provided.

Handlers we may need are about 3: one that dispatches error/critical level events to a file another to console (for, say, warnings like "this proc is not available yet") and one for the report functionality. I imagine we could set up a second set of handlers that don't do anything if the UI doesn't expect us logging stuff (at least those that get displayed on the console).

Python API seems very straightforward to me:
logger_name.warning("message")
logger_name.critical("message")
I imagine we could set up a method in place like log_this("message") but I'm stil trying to figure how that function would catch the module it's called from to use one or another logger; or maybe pass it to the function like log_this(logger, "message")

from core import logger should happen again at each __init__ if we instantiate the loggers in logger.py or, if we like it better at the top of each module:
import logging
from core import logging_config
logger = logging.getLogger("aldriana_logger")

class AldrianaRogueDamageCalculator(RogueDamageClaculator):
    # stuff
    logger.warning("message")

[Aldriana]

I guess I'm not 100% clear why we need a different logger for every file; I'm not saying we don't, but I'm not quite sure what it does for us.

[dazer]

I'm assuming loging at 'debug' level is the closest it can get to a print statement used here and there to check some values. Now, the difference between print and logging is that the former gets deleted while the later statements stay in the code (and we silence them before delivering the library).

So, imagine something broke in the modeler: you'd want to set every logger there to log everything, even 'debug' logs; but you probably don't want the rogue_talents module to also throw debug logs.

Long story short: technically we don't, but I can picture some scenarios where it helps.