Provenance hints to user_note and user_error and error handling for missing coupling direction

[mandresm]

• Error handling for Possible naming problem in esm_tools. #1268
• adds get_first_provenance method to more easily use the first occurrence of provenance in a dictionary or list to report suggestions in the error messages
• adds hint functionality to user_error and user_note: if you add a list of hints as input to one of this methods, you can add <HINT_#> placeholders to your message for user_note and user_error. These place holders will be substituted using the hint's properties you define for each hint.

For #1268 it generates this user error now:

Closes #1268

[mandresm]

This can still be improved, for example, by making an Hint object and an UserNote object. However, I think improving it would only make sense if we refactor the whole user_note thing, move it to it's own module, and including the loguru logger into it. WDYT @pgierz?

[pgierz]

Yes, plus 100000000 points. Having those be in esm_parser is not where they belong. Suggestion: put it in the esm_tools module directly, which is where we should keep things that are needed in all of the sub packages.

from loguru import logger
# Alternatively: from esm_tools.logging import logger (see implementation in pymorize)

class Hint
   def __init__(self, message):
       self.message = message

   def error(self, message=None):
        if message is None:
            message = self.message
        logger.error(message)
   # Same with info, debug, critical, etc

...something like that. Maybe with static methods so you don't need to initialise the object.

[mandresm]

Suggestion: put it in the esm_tools module directly, which is where we should keep things that are needed in all of the sub packages.

done!

[pgierz]

I have one naming suggestion, otherwise this is good to go.

[mandresm]

#bump

[mandresm]

#bump