Patch: Document metaprogrammed module attributes #19
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
Expanded documentation to include dynamically-generated module-level attributes
that cannot be detected or documented without running the code. Specifically:
* adafruit_logging.NOTSET
* adafruit_logging.DEBUG
* adafruit_logging.INFO
* adafruit_logging.WARNING
* adafruit_logging.ERROR
* adafruit_logging.CRITICAL
are all module-level attributes that are generated using this block of
metaprogramming (line 65):
```
LEVELS = [
(00, "NOTSET"),
(10, "DEBUG"),
(20, "INFO"),
(30, "WARNING"),
(40, "ERROR"),
(50, "CRITICAL"),
]
for level_value, level_name in LEVELS:
globals()[level_name] = level_value
```
garrettheath4
commented
Aug 11, 2021
garrettheath4
commented
Aug 11, 2021
brentru
requested changes
Aug 11, 2021
… type to `Logger.addHandler(..)` docstring, and reverted `level_for(..)` param rename from `level_value` back to `value` as suggested by @brentru
garrettheath4
commented
Aug 11, 2021
There was a problem hiding this comment.
Replied to 2 comments and resolved suggestions by @brentru
Suggestions were to remove PyCharm-specific code inspection comments, add param type to Logger.addHandler(..) docstring, and revert level_for(..) param rename from level_value back to value
brentru
approved these changes
Aug 12, 2021
|
@garrettheath4 This is failing on |
# Conflicts: # adafruit_logging/__init__.py
|
I merged main to this branch and resolved the conflicts. Fixed one other pylint issue resulting from renaming some of the arguments in this PR. Changes look good to me as well. |
adafruit-adabot
added a commit
to adafruit/Adafruit_CircuitPython_Bundle
that referenced
this pull request
Dec 13, 2021
Updating https://github.com/adafruit/Adafruit_CircuitPython_Logging to 3.7.3 from 3.7.2: > Merge pull request adafruit/Adafruit_CircuitPython_Logging#19 from garrettheath4/document-dynamic-levels > update rtd py version
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.
Expanded documentation to include dynamically-generated module-level attributes that cannot be detected (by an IDE) or documented (by NumpyDoc) without running the code. Specifically:
adafruit_logging.NOTSETadafruit_logging.DEBUGadafruit_logging.INFOadafruit_logging.WARNINGadafruit_logging.ERRORadafruit_logging.CRITICALare all module-level attributes that are generated using this block of metaprogramming (line 65):