-
-
Notifications
You must be signed in to change notification settings - Fork 18
New issue
Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.
By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.
Already on GitHub? Sign in to your account
Feature: add verbosity option and improve log #156
Merged
Merged
Conversation
This file contains 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
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
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.
ℹ️ this PR supersedes the #155
Context
Recently, we faced an issue with the log length using qgis-plugin-ci on GitLab CI/CD:
See this job: https://gitlab.com/Oslandia/qgis/ign-geotuileur/-/jobs/3056269109
But I've been thinking for a long time that we should reduce the amount of information returned to the terminal or let the end-user pick.
Proposed 'log policy'
print
to systematically display information to the CLI end-user and which doesn't require some log filter or format. And mark the statement with# noqa: T2
to avoid flake8 alerts. Example:Plugin archive created: qtribu.0.15.0-beta2.zip (Size: 731.37 Ko)
logger.error
for blocking issues or interrupted process. If the case is predictable and predicted, do not raise brutal exception to avoid hard readable trace in terminal. Example:logger.warning
for annoying or imperfect but not blocking situations . Example:2022-09-22 14:45:01||WARNING||parameters||Homepage is not given in the metadata. It is a mandatory information to publish the plugin on the QGIS official repository.
logger.info
for normal message during the process.logger.debug
for detailed message during specific steps. example: list of zipped files, etc.Changes
STILL IN PROGRESS
add a verbosity option
-v
with an incremental countadd a setting into the
setup.cfg
to customize log format. Default:%(asctime)s||%(levelname)s||%(module)s||%(message)s
- OPTION STILL NOT IMPLEMENTEDremove option alias
-v
from theversion
option to avoid conflictimprove some exception handling: mainly add
Trace: {exc}
and use f-string instead of format as recommendedadd some volontary print statements (typically to conclude each successful command)
add flake8-print as development requirement to enforce the lg policy. Use
# noqa: T2
for relevant print statements