Update supported Python versions and update CI/CD #35
Conversation
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
traversaro
approved these changes
May 17, 2024
flferretti
approved these changes
May 17, 2024
Comment on lines
54
to
86
| def get_default_logging_level(env_var: str) -> logging.LoggingLevel: | ||
| """ | ||
| Get the default logging level. | ||
| Args: | ||
| env_var: The environment variable to check. | ||
| Returns: | ||
| The logging level to set. | ||
| """ | ||
|
|
||
| import os | ||
|
|
||
| try: | ||
| return logging.LoggingLevel[os.environ[env_var].upper()] | ||
|
|
||
| # Raise if the environment variable is set but the logging level is invalid. | ||
| except AttributeError: | ||
| msg = f"Invalid logging level defined in {env_var}: '{os.environ[env_var]}'" | ||
| raise ValueError(msg) | ||
|
|
||
| # If the environment variable is not set, return the logging level depending | ||
| # on the installation mode. | ||
| except KeyError: | ||
| return ( | ||
| logging.LoggingLevel.DEBUG | ||
| if installation_is_editable() | ||
| else logging.LoggingLevel.WARNING | ||
| ) | ||
|
|
||
|
|
||
| # Configure the logger with the default logging level. | ||
| logging.configure(level=get_default_logging_level(env_var="ROD_LOGGING_LEVEL")) |
There was a problem hiding this comment.
If the environment variable can only be ROD_LOGGING_LEVEL, is there a reason why you're passing it as the argument of this function? Can it just be hardcoded?
Suggested change
| def get_default_logging_level(env_var: str) -> logging.LoggingLevel: | |
| """ | |
| Get the default logging level. | |
| Args: | |
| env_var: The environment variable to check. | |
| Returns: | |
| The logging level to set. | |
| """ | |
| import os | |
| try: | |
| return logging.LoggingLevel[os.environ[env_var].upper()] | |
| # Raise if the environment variable is set but the logging level is invalid. | |
| except AttributeError: | |
| msg = f"Invalid logging level defined in {env_var}: '{os.environ[env_var]}'" | |
| raise ValueError(msg) | |
| # If the environment variable is not set, return the logging level depending | |
| # on the installation mode. | |
| except KeyError: | |
| return ( | |
| logging.LoggingLevel.DEBUG | |
| if installation_is_editable() | |
| else logging.LoggingLevel.WARNING | |
| ) | |
| # Configure the logger with the default logging level. | |
| logging.configure(level=get_default_logging_level(env_var="ROD_LOGGING_LEVEL")) | |
| def get_default_logging_level() -> logging.LoggingLevel: | |
| """ | |
| Get the default logging level. | |
| Returns: | |
| The logging level to set. | |
| """ | |
| import os | |
| try: | |
| return logging.LoggingLevel[os.environ["ROD_LOGGING_LEVEL"].upper()] | |
| # Raise if the environment variable is set but the logging level is invalid. | |
| except AttributeError: | |
| msg = f"Invalid logging level defined in 'ROD_LOGGING_LEVEL'" | |
| raise ValueError(msg) | |
| # If the environment variable is not set, return the logging level depending | |
| # on the installation mode. | |
| except KeyError: | |
| return ( | |
| logging.LoggingLevel.DEBUG | |
| if installation_is_editable() | |
| else logging.LoggingLevel.WARNING | |
| ) | |
| # Configure the logger with the default logging level. | |
| logging.configure(level=get_default_logging_level() |
There was a problem hiding this comment.
Having the environment variable explicitly defined makes it more visible to users rather than hiding it inside the logic of a function. Since we do not have documentation, I valued readability.
There was a problem hiding this comment.
It makes sense, thanks for the explanation!
37d1227 to
5e96179
Compare
Co-authored-by: Filippo Luca Ferretti <[email protected]>
|
FYI @lorycontixd I had to update your test introduced in #33 to make it work on Windows. |
|
@diegoferigo Yep, no problem. |
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
4 participants
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
No description provided.