From 5447ddd9bcb4547084e31366cbe00077f4653ce1 Mon Sep 17 00:00:00 2001 From: Dave Astels Date: Thu, 7 Mar 2019 16:16:39 -0500 Subject: [PATCH 01/11] Cut the cookies, added the code, and deleted the todos --- Logger/.gitignore | 12 + Logger/.pylintrc | 433 ++++++++++++++++++++++ Logger/.readthedocs.yml | 3 + Logger/.travis.yml | 48 +++ Logger/CODE_OF_CONDUCT.md | 127 +++++++ Logger/LICENSE | 21 ++ Logger/README.rst | 100 +++++ Logger/adafruit_logger/adafruit_logger.py | 123 ++++++ Logger/adafruit_logger/uart_handler.py | 68 ++++ Logger/docs/_static/favicon.ico | Bin 0 -> 4414 bytes Logger/docs/api.rst | 8 + Logger/docs/conf.py | 160 ++++++++ Logger/docs/examples.rst | 8 + Logger/docs/index.rst | 45 +++ Logger/examples/logger_simpletest.py | 0 Logger/requirements.txt | 1 + Logger/setup.py | 63 ++++ 17 files changed, 1220 insertions(+) create mode 100644 Logger/.gitignore create mode 100644 Logger/.pylintrc create mode 100644 Logger/.readthedocs.yml create mode 100644 Logger/.travis.yml create mode 100644 Logger/CODE_OF_CONDUCT.md create mode 100644 Logger/LICENSE create mode 100644 Logger/README.rst create mode 100644 Logger/adafruit_logger/adafruit_logger.py create mode 100644 Logger/adafruit_logger/uart_handler.py create mode 100644 Logger/docs/_static/favicon.ico create mode 100644 Logger/docs/api.rst create mode 100644 Logger/docs/conf.py create mode 100644 Logger/docs/examples.rst create mode 100644 Logger/docs/index.rst create mode 100644 Logger/examples/logger_simpletest.py create mode 100644 Logger/requirements.txt create mode 100644 Logger/setup.py diff --git a/Logger/.gitignore b/Logger/.gitignore new file mode 100644 index 0000000..55f127b --- /dev/null +++ b/Logger/.gitignore @@ -0,0 +1,12 @@ +*.mpy +.idea +__pycache__ +_build +*.pyc +.env +build* +bundles +*.DS_Store +.eggs +dist +**/*.egg-info \ No newline at end of file diff --git a/Logger/.pylintrc b/Logger/.pylintrc new file mode 100644 index 0000000..039eaec --- /dev/null +++ b/Logger/.pylintrc @@ -0,0 +1,433 @@ +[MASTER] + +# A comma-separated list of package or module names from where C extensions may +# be loaded. Extensions are loading into the active Python interpreter and may +# run arbitrary code +extension-pkg-whitelist= + +# Add files or directories to the blacklist. They should be base names, not +# paths. +ignore=CVS + +# Add files or directories matching the regex patterns to the blacklist. The +# regex matches against base names, not paths. +ignore-patterns= + +# Python code to execute, usually for sys.path manipulation such as +# pygtk.require(). +#init-hook= + +# Use multiple processes to speed up Pylint. +# jobs=1 +jobs=2 + +# List of plugins (as comma separated values of python modules names) to load, +# usually to register additional checkers. +load-plugins= + +# Pickle collected data for later comparisons. +persistent=yes + +# Specify a configuration file. +#rcfile= + +# Allow loading of arbitrary C extensions. Extensions are imported into the +# active Python interpreter and may run arbitrary code. +unsafe-load-any-extension=no + + +[MESSAGES CONTROL] + +# Only show warnings with the listed confidence levels. Leave empty to show +# all. Valid levels: HIGH, INFERENCE, INFERENCE_FAILURE, UNDEFINED +confidence= + +# Disable the message, report, category or checker with the given id(s). You +# can either give multiple identifiers separated by comma (,) or put this +# option multiple times (only on the command line, not in the configuration +# file where it should appear only once).You can also use "--disable=all" to +# disable everything first and then reenable specific checks. For example, if +# you want to run only the similarities checker, you can use "--disable=all +# --enable=similarities". If you want to run only the classes checker, but have +# no Warning level messages displayed, use"--disable=all --enable=classes +# --disable=W" +# disable=import-error,print-statement,parameter-unpacking,unpacking-in-except,old-raise-syntax,backtick,long-suffix,old-ne-operator,old-octal-literal,import-star-module-level,raw-checker-failed,bad-inline-option,locally-disabled,locally-enabled,file-ignored,suppressed-message,useless-suppression,deprecated-pragma,apply-builtin,basestring-builtin,buffer-builtin,cmp-builtin,coerce-builtin,execfile-builtin,file-builtin,long-builtin,raw_input-builtin,reduce-builtin,standarderror-builtin,unicode-builtin,xrange-builtin,coerce-method,delslice-method,getslice-method,setslice-method,no-absolute-import,old-division,dict-iter-method,dict-view-method,next-method-called,metaclass-assignment,indexing-exception,raising-string,reload-builtin,oct-method,hex-method,nonzero-method,cmp-method,input-builtin,round-builtin,intern-builtin,unichr-builtin,map-builtin-not-iterating,zip-builtin-not-iterating,range-builtin-not-iterating,filter-builtin-not-iterating,using-cmp-argument,eq-without-hash,div-method,idiv-method,rdiv-method,exception-message-attribute,invalid-str-codec,sys-max-int,bad-python3-import,deprecated-string-function,deprecated-str-translate-call +disable=print-statement,parameter-unpacking,unpacking-in-except,old-raise-syntax,backtick,long-suffix,old-ne-operator,old-octal-literal,import-star-module-level,raw-checker-failed,bad-inline-option,locally-disabled,locally-enabled,file-ignored,suppressed-message,useless-suppression,deprecated-pragma,apply-builtin,basestring-builtin,buffer-builtin,cmp-builtin,coerce-builtin,execfile-builtin,file-builtin,long-builtin,raw_input-builtin,reduce-builtin,standarderror-builtin,unicode-builtin,xrange-builtin,coerce-method,delslice-method,getslice-method,setslice-method,no-absolute-import,old-division,dict-iter-method,dict-view-method,next-method-called,metaclass-assignment,indexing-exception,raising-string,reload-builtin,oct-method,hex-method,nonzero-method,cmp-method,input-builtin,round-builtin,intern-builtin,unichr-builtin,map-builtin-not-iterating,zip-builtin-not-iterating,range-builtin-not-iterating,filter-builtin-not-iterating,using-cmp-argument,eq-without-hash,div-method,idiv-method,rdiv-method,exception-message-attribute,invalid-str-codec,sys-max-int,bad-python3-import,deprecated-string-function,deprecated-str-translate-call,import-error + +# Enable the message, report, category or checker with the given id(s). You can +# either give multiple identifier separated by comma (,) or put this option +# multiple time (only on the command line, not in the configuration file where +# it should appear only once). See also the "--disable" option for examples. +enable= + + +[REPORTS] + +# Python expression which should return a note less than 10 (10 is the highest +# note). You have access to the variables errors warning, statement which +# respectively contain the number of errors / warnings messages and the total +# number of statements analyzed. This is used by the global evaluation report +# (RP0004). +evaluation=10.0 - ((float(5 * error + warning + refactor + convention) / statement) * 10) + +# Template used to display messages. This is a python new-style format string +# used to format the message information. See doc for all details +#msg-template= + +# Set the output format. Available formats are text, parseable, colorized, json +# and msvs (visual studio).You can also give a reporter class, eg +# mypackage.mymodule.MyReporterClass. +output-format=text + +# Tells whether to display a full report or only the messages +reports=no + +# Activate the evaluation score. +score=yes + + +[REFACTORING] + +# Maximum number of nested blocks for function / method body +max-nested-blocks=5 + + +[LOGGING] + +# Logging modules to check that the string format arguments are in logging +# function parameter format +logging-modules=logging + + +[SPELLING] + +# Spelling dictionary name. Available dictionaries: none. To make it working +# install python-enchant package. +spelling-dict= + +# List of comma separated words that should not be checked. +spelling-ignore-words= + +# A path to a file that contains private dictionary; one word per line. +spelling-private-dict-file= + +# Tells whether to store unknown words to indicated private dictionary in +# --spelling-private-dict-file option instead of raising a message. +spelling-store-unknown-words=no + + +[MISCELLANEOUS] + +# List of note tags to take in consideration, separated by a comma. +# notes=FIXME,XXX,TODO +notes=FIXME,XXX + + +[TYPECHECK] + +# List of decorators that produce context managers, such as +# contextlib.contextmanager. Add to this list to register other decorators that +# produce valid context managers. +contextmanager-decorators=contextlib.contextmanager + +# List of members which are set dynamically and missed by pylint inference +# system, and so shouldn't trigger E1101 when accessed. Python regular +# expressions are accepted. +generated-members= + +# Tells whether missing members accessed in mixin class should be ignored. A +# mixin class is detected if its name ends with "mixin" (case insensitive). +ignore-mixin-members=yes + +# This flag controls whether pylint should warn about no-member and similar +# checks whenever an opaque object is returned when inferring. The inference +# can return multiple potential results while evaluating a Python object, but +# some branches might not be evaluated, which results in partial inference. In +# that case, it might be useful to still emit no-member and other checks for +# the rest of the inferred objects. +ignore-on-opaque-inference=yes + +# List of class names for which member attributes should not be checked (useful +# for classes with dynamically set attributes). This supports the use of +# qualified names. +ignored-classes=optparse.Values,thread._local,_thread._local + +# List of module names for which member attributes should not be checked +# (useful for modules/projects where namespaces are manipulated during runtime +# and thus existing member attributes cannot be deduced by static analysis. It +# supports qualified module names, as well as Unix pattern matching. +ignored-modules=board + +# Show a hint with possible names when a member name was not found. The aspect +# of finding the hint is based on edit distance. +missing-member-hint=yes + +# The minimum edit distance a name should have in order to be considered a +# similar match for a missing member name. +missing-member-hint-distance=1 + +# The total number of similar names that should be taken in consideration when +# showing a hint for a missing member. +missing-member-max-choices=1 + + +[VARIABLES] + +# List of additional names supposed to be defined in builtins. Remember that +# you should avoid to define new builtins when possible. +additional-builtins= + +# Tells whether unused global variables should be treated as a violation. +allow-global-unused-variables=yes + +# List of strings which can identify a callback function by name. A callback +# name must start or end with one of those strings. +callbacks=cb_,_cb + +# A regular expression matching the name of dummy variables (i.e. expectedly +# not used). +dummy-variables-rgx=_+$|(_[a-zA-Z0-9_]*[a-zA-Z0-9]+?$)|dummy|^ignored_|^unused_ + +# Argument names that match this expression will be ignored. Default to name +# with leading underscore +ignored-argument-names=_.*|^ignored_|^unused_ + +# Tells whether we should check for unused import in __init__ files. +init-import=no + +# List of qualified module names which can have objects that can redefine +# builtins. +redefining-builtins-modules=six.moves,future.builtins + + +[FORMAT] + +# Expected format of line ending, e.g. empty (any line ending), LF or CRLF. +# expected-line-ending-format= +expected-line-ending-format=LF + +# Regexp for a line that is allowed to be longer than the limit. +ignore-long-lines=^\s*(# )??$ + +# Number of spaces of indent required inside a hanging or continued line. +indent-after-paren=4 + +# String used as indentation unit. This is usually " " (4 spaces) or "\t" (1 +# tab). +indent-string=' ' + +# Maximum number of characters on a single line. +max-line-length=100 + +# Maximum number of lines in a module +max-module-lines=1000 + +# List of optional constructs for which whitespace checking is disabled. `dict- +# separator` is used to allow tabulation in dicts, etc.: {1 : 1,\n222: 2}. +# `trailing-comma` allows a space between comma and closing bracket: (a, ). +# `empty-line` allows space-only lines. +no-space-check=trailing-comma,dict-separator + +# Allow the body of a class to be on the same line as the declaration if body +# contains single statement. +single-line-class-stmt=no + +# Allow the body of an if to be on the same line as the test if there is no +# else. +single-line-if-stmt=no + + +[SIMILARITIES] + +# Ignore comments when computing similarities. +ignore-comments=yes + +# Ignore docstrings when computing similarities. +ignore-docstrings=yes + +# Ignore imports when computing similarities. +ignore-imports=no + +# Minimum lines number of a similarity. +min-similarity-lines=4 + + +[BASIC] + +# Naming hint for argument names +argument-name-hint=(([a-z][a-z0-9_]{2,30})|(_[a-z0-9_]*))$ + +# Regular expression matching correct argument names +argument-rgx=(([a-z][a-z0-9_]{2,30})|(_[a-z0-9_]*))$ + +# Naming hint for attribute names +attr-name-hint=(([a-z][a-z0-9_]{2,30})|(_[a-z0-9_]*))$ + +# Regular expression matching correct attribute names +attr-rgx=(([a-z][a-z0-9_]{2,30})|(_[a-z0-9_]*))$ + +# Bad variable names which should always be refused, separated by a comma +bad-names=foo,bar,baz,toto,tutu,tata + +# Naming hint for class attribute names +class-attribute-name-hint=([A-Za-z_][A-Za-z0-9_]{2,30}|(__.*__))$ + +# Regular expression matching correct class attribute names +class-attribute-rgx=([A-Za-z_][A-Za-z0-9_]{2,30}|(__.*__))$ + +# Naming hint for class names +# class-name-hint=[A-Z_][a-zA-Z0-9]+$ +class-name-hint=[A-Z_][a-zA-Z0-9_]+$ + +# Regular expression matching correct class names +# class-rgx=[A-Z_][a-zA-Z0-9]+$ +class-rgx=[A-Z_][a-zA-Z0-9_]+$ + +# Naming hint for constant names +const-name-hint=(([A-Z_][A-Z0-9_]*)|(__.*__))$ + +# Regular expression matching correct constant names +const-rgx=(([A-Z_][A-Z0-9_]*)|(__.*__))$ + +# Minimum line length for functions/classes that require docstrings, shorter +# ones are exempt. +docstring-min-length=-1 + +# Naming hint for function names +function-name-hint=(([a-z][a-z0-9_]{2,30})|(_[a-z0-9_]*))$ + +# Regular expression matching correct function names +function-rgx=(([a-z][a-z0-9_]{2,30})|(_[a-z0-9_]*))$ + +# Good variable names which should always be accepted, separated by a comma +# good-names=i,j,k,ex,Run,_ +good-names=r,g,b,w,i,j,k,n,x,y,z,ex,ok,Run,_ + +# Include a hint for the correct naming format with invalid-name +include-naming-hint=no + +# Naming hint for inline iteration names +inlinevar-name-hint=[A-Za-z_][A-Za-z0-9_]*$ + +# Regular expression matching correct inline iteration names +inlinevar-rgx=[A-Za-z_][A-Za-z0-9_]*$ + +# Naming hint for method names +method-name-hint=(([a-z][a-z0-9_]{2,30})|(_[a-z0-9_]*))$ + +# Regular expression matching correct method names +method-rgx=(([a-z][a-z0-9_]{2,30})|(_[a-z0-9_]*))$ + +# Naming hint for module names +module-name-hint=(([a-z_][a-z0-9_]*)|([A-Z][a-zA-Z0-9]+))$ + +# Regular expression matching correct module names +module-rgx=(([a-z_][a-z0-9_]*)|([A-Z][a-zA-Z0-9]+))$ + +# Colon-delimited sets of names that determine each other's naming style when +# the name regexes allow several styles. +name-group= + +# Regular expression which should only match function or class names that do +# not require a docstring. +no-docstring-rgx=^_ + +# List of decorators that produce properties, such as abc.abstractproperty. Add +# to this list to register other decorators that produce valid properties. +property-classes=abc.abstractproperty + +# Naming hint for variable names +variable-name-hint=(([a-z][a-z0-9_]{2,30})|(_[a-z0-9_]*))$ + +# Regular expression matching correct variable names +variable-rgx=(([a-z][a-z0-9_]{2,30})|(_[a-z0-9_]*))$ + + +[IMPORTS] + +# Allow wildcard imports from modules that define __all__. +allow-wildcard-with-all=no + +# Analyse import fallback blocks. This can be used to support both Python 2 and +# 3 compatible code, which means that the block might have code that exists +# only in one or another interpreter, leading to false positives when analysed. +analyse-fallback-blocks=no + +# Deprecated modules which should not be used, separated by a comma +deprecated-modules=optparse,tkinter.tix + +# Create a graph of external dependencies in the given file (report RP0402 must +# not be disabled) +ext-import-graph= + +# Create a graph of every (i.e. internal and external) dependencies in the +# given file (report RP0402 must not be disabled) +import-graph= + +# Create a graph of internal dependencies in the given file (report RP0402 must +# not be disabled) +int-import-graph= + +# Force import order to recognize a module as part of the standard +# compatibility libraries. +known-standard-library= + +# Force import order to recognize a module as part of a third party library. +known-third-party=enchant + + +[CLASSES] + +# List of method names used to declare (i.e. assign) instance attributes. +defining-attr-methods=__init__,__new__,setUp + +# List of member names, which should be excluded from the protected access +# warning. +exclude-protected=_asdict,_fields,_replace,_source,_make + +# List of valid names for the first argument in a class method. +valid-classmethod-first-arg=cls + +# List of valid names for the first argument in a metaclass class method. +valid-metaclass-classmethod-first-arg=mcs + + +[DESIGN] + +# Maximum number of arguments for function / method +max-args=5 + +# Maximum number of attributes for a class (see R0902). +# max-attributes=7 +max-attributes=11 + +# Maximum number of boolean expressions in a if statement +max-bool-expr=5 + +# Maximum number of branch for function / method body +max-branches=12 + +# Maximum number of locals for function / method body +max-locals=15 + +# Maximum number of parents for a class (see R0901). +max-parents=7 + +# Maximum number of public methods for a class (see R0904). +max-public-methods=20 + +# Maximum number of return / yield for function / method body +max-returns=6 + +# Maximum number of statements in function / method body +max-statements=50 + +# Minimum number of public methods for a class (see R0903). +min-public-methods=1 + + +[EXCEPTIONS] + +# Exceptions that will emit a warning when being caught. Defaults to +# "Exception" +overgeneral-exceptions=Exception diff --git a/Logger/.readthedocs.yml b/Logger/.readthedocs.yml new file mode 100644 index 0000000..f4243ad --- /dev/null +++ b/Logger/.readthedocs.yml @@ -0,0 +1,3 @@ +python: + version: 3 +requirements_file: requirements.txt diff --git a/Logger/.travis.yml b/Logger/.travis.yml new file mode 100644 index 0000000..9fb3383 --- /dev/null +++ b/Logger/.travis.yml @@ -0,0 +1,48 @@ +# This is a common .travis.yml for generating library release zip files for +# CircuitPython library releases using circuitpython-build-tools. +# See https://github.com/adafruit/circuitpython-build-tools for detailed setup +# instructions. + +dist: xenial +language: python +python: + - "3.6" + +cache: + pip: true + +# TODO: if deployment to PyPi is desired, change 'DEPLOY_PYPI' to "true", +# or remove the env block entirely and remove the condition in the +# deploy block. +env: + - DEPLOY_PYPI="false" + +deploy: + - provider: releases + api_key: "$GITHUB_TOKEN" + file_glob: true + file: "$TRAVIS_BUILD_DIR/bundles/*" + skip_cleanup: true + overwrite: true + on: + tags: true + # TODO: Use 'travis encrypt --com -r adafruit/' to generate + # the encrypted password for adafruit-travis. Paste result below. + - provider: pypi + user: adafruit-travis + password: + secure: #-- PASTE ENCRYPTED PASSWORD HERE --# + on: + tags: true + condition: $DEPLOY_PYPI = "true" + +install: + - pip install -r requirements.txt + - pip install circuitpython-build-tools Sphinx sphinx-rtd-theme + - pip install --force-reinstall pylint==1.9.2 + +script: + - pylint adafruit_logger.py + - ([[ ! -d "examples" ]] || pylint --disable=missing-docstring,invalid-name,bad-whitespace examples/*.py) + - circuitpython-build-bundles --filename_prefix adafruit-circuitpython-logger --library_location . + - cd docs && sphinx-build -E -W -b html . _build/html && cd .. diff --git a/Logger/CODE_OF_CONDUCT.md b/Logger/CODE_OF_CONDUCT.md new file mode 100644 index 0000000..8ee6e44 --- /dev/null +++ b/Logger/CODE_OF_CONDUCT.md @@ -0,0 +1,127 @@ +# Adafruit Community Code of Conduct + +## Our Pledge + +In the interest of fostering an open and welcoming environment, we as +contributors and leaders pledge to making participation in our project and +our community a harassment-free experience for everyone, regardless of age, body +size, disability, ethnicity, gender identity and expression, level or type of +experience, education, socio-economic status, nationality, personal appearance, +race, religion, or sexual identity and orientation. + +## Our Standards + +We are committed to providing a friendly, safe and welcoming environment for +all. + +Examples of behavior that contributes to creating a positive environment +include: + +* Be kind and courteous to others +* Using welcoming and inclusive language +* Being respectful of differing viewpoints and experiences +* Collaborating with other community members +* Gracefully accepting constructive criticism +* Focusing on what is best for the community +* Showing empathy towards other community members + +Examples of unacceptable behavior by participants include: + +* The use of sexualized language or imagery and sexual attention or advances +* The use of inappropriate images, including in a community member's avatar +* The use of inappropriate language, including in a community member's nickname +* Any spamming, flaming, baiting or other attention-stealing behavior +* Excessive or unwelcome helping; answering outside the scope of the question + asked +* Trolling, insulting/derogatory comments, and personal or political attacks +* Public or private harassment +* Publishing others' private information, such as a physical or electronic + address, without explicit permission +* Other conduct which could reasonably be considered inappropriate + +The goal of the standards and moderation guidelines outlined here is to build +and maintain a respectful community. We ask that you don’t just aim to be +"technically unimpeachable", but rather try to be your best self. + +We value many things beyond technical expertise, including collaboration and +supporting others within our community. Providing a positive experience for +other community members can have a much more significant impact than simply +providing the correct answer. + +## Our Responsibilities + +Project leaders are responsible for clarifying the standards of acceptable +behavior and are expected to take appropriate and fair corrective action in +response to any instances of unacceptable behavior. + +Project leaders have the right and responsibility to remove, edit, or +reject messages, comments, commits, code, issues, and other contributions +that are not aligned to this Code of Conduct, or to ban temporarily or +permanently any community member for other behaviors that they deem +inappropriate, threatening, offensive, or harmful. + +## Moderation + +Instances of behaviors that violate the Adafruit Community Code of Conduct +may be reported by any member of the community. Community members are +encouraged to report these situations, including situations they witness +involving other community members. + +You may report in the following ways: + +In any situation, you may send an email to . + +On the Adafruit Discord, you may send an open message from any channel +to all Community Helpers by tagging @community helpers. You may also send an +open message from any channel, or a direct message to @kattni#1507, +@tannewt#4653, @Dan Halbert#1614, @cater#2442, @sommersoft#0222, or +@Andon#8175. + +Email and direct message reports will be kept confidential. + +In situations on Discord where the issue is particularly egregious, possibly +illegal, requires immediate action, or violates the Discord terms of service, +you should also report the message directly to Discord. + +These are the steps for upholding our community’s standards of conduct. + +1. Any member of the community may report any situation that violates the +Adafruit Community Code of Conduct. All reports will be reviewed and +investigated. +2. If the behavior is an egregious violation, the community member who +committed the violation may be banned immediately, without warning. +3. Otherwise, moderators will first respond to such behavior with a warning. +4. Moderators follow a soft "three strikes" policy - the community member may +be given another chance, if they are receptive to the warning and change their +behavior. +5. If the community member is unreceptive or unreasonable when warned by a +moderator, or the warning goes unheeded, they may be banned for a first or +second offense. Repeated offenses will result in the community member being +banned. + +## Scope + +This Code of Conduct and the enforcement policies listed above apply to all +Adafruit Community venues. This includes but is not limited to any community +spaces (both public and private), the entire Adafruit Discord server, and +Adafruit GitHub repositories. Examples of Adafruit Community spaces include +but are not limited to meet-ups, audio chats on the Adafruit Discord, or +interaction at a conference. + +This Code of Conduct applies both within project spaces and in public spaces +when an individual is representing the project or its community. As a community +member, you are representing our community, and are expected to behave +accordingly. + +## Attribution + +This Code of Conduct is adapted from the [Contributor Covenant][homepage], +version 1.4, available at +, +and the [Rust Code of Conduct](https://www.rust-lang.org/en-US/conduct.html). + +For other projects adopting the Adafruit Community Code of +Conduct, please contact the maintainers of those projects for enforcement. +If you wish to use this code of conduct for your own project, consider +explicitly mentioning your moderation policy or making a copy with your +own moderation policy so as to avoid confusion. diff --git a/Logger/LICENSE b/Logger/LICENSE new file mode 100644 index 0000000..d69195f --- /dev/null +++ b/Logger/LICENSE @@ -0,0 +1,21 @@ +The MIT License (MIT) + +Copyright (c) 2019 Dave Astels for Adafruit Industries + +Permission is hereby granted, free of charge, to any person obtaining a copy +of this software and associated documentation files (the "Software"), to deal +in the Software without restriction, including without limitation the rights +to use, copy, modify, merge, publish, distribute, sublicense, and/or sell +copies of the Software, and to permit persons to whom the Software is +furnished to do so, subject to the following conditions: + +The above copyright notice and this permission notice shall be included in all +copies or substantial portions of the Software. + +THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR +IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, +FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE +AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER +LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, +OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE +SOFTWARE. diff --git a/Logger/README.rst b/Logger/README.rst new file mode 100644 index 0000000..430b28f --- /dev/null +++ b/Logger/README.rst @@ -0,0 +1,100 @@ +Introduction +============ + +.. image:: https://readthedocs.org/projects/adafruit-circuitpython-logger/badge/?version=latest + :target: https://circuitpython.readthedocs.io/projects/logger/en/latest/ + :alt: Documentation Status + +.. image:: https://img.shields.io/discord/327254708534116352.svg + :target: https://discord.gg/nBQh6qu + :alt: Discord + +.. image:: https://travis-ci.com/adafruit/Adafruit_CircuitPython_Logger.svg?branch=master + :target: https://travis-ci.com/adafruit/Adafruit_CircuitPython_Logger + :alt: Build Status + +Logging module for CircuitPython + + +Dependencies +============= +This driver depends on: + +* `Adafruit CircuitPython `_ + +Please ensure all dependencies are available on the CircuitPython filesystem. +This is easily achieved by downloading +`the Adafruit library and driver bundle `_. + +Usage Example +============= + +.. code-block:: python + + import board + import busio + from adafruit_logger.uart_handler import UartHandler + from adafruit_logger import * + + uart = busio.UART(board.TX, board.RX, baudrate=115200) + logger = Logger(UartHandler(uart)) + logger.level = INFO + logger.info('testing') + + +Contributing +============ + +Contributions are welcome! Please read our `Code of Conduct +`_ +before contributing to help this project stay welcoming. + +Building locally +================ + +Zip release files +----------------- + +To build this library locally you'll need to install the +`circuitpython-build-tools `_ package. + +.. code-block:: shell + + python3 -m venv .env + source .env/bin/activate + pip install circuitpython-build-tools + +Once installed, make sure you are in the virtual environment: + +.. code-block:: shell + + source .env/bin/activate + +Then run the build: + +.. code-block:: shell + + circuitpython-build-bundles --filename_prefix adafruit-circuitpython-logger --library_location . + +Sphinx documentation +----------------------- + +Sphinx is used to build the documentation based on rST files and comments in the code. First, +install dependencies (feel free to reuse the virtual environment from above): + +.. code-block:: shell + + python3 -m venv .env + source .env/bin/activate + pip install Sphinx sphinx-rtd-theme + +Now, once you have the virtual environment activated: + +.. code-block:: shell + + cd docs + sphinx-build -E -W -b html . _build/html + +This will output the documentation to ``docs/_build/html``. Open the index.html in your browser to +view them. It will also (due to -W) error out on any warning like Travis will. This is a good way to +locally verify it will pass. diff --git a/Logger/adafruit_logger/adafruit_logger.py b/Logger/adafruit_logger/adafruit_logger.py new file mode 100644 index 0000000..f05f4ca --- /dev/null +++ b/Logger/adafruit_logger/adafruit_logger.py @@ -0,0 +1,123 @@ +# The MIT License (MIT) +# +# Copyright (c) 2019 Dave Astels for Adafruit Industries +# +# Permission is hereby granted, free of charge, to any person obtaining a copy +# of this software and associated documentation files (the "Software"), to deal +# in the Software without restriction, including without limitation the rights +# to use, copy, modify, merge, publish, distribute, sublicense, and/or sell +# copies of the Software, and to permit persons to whom the Software is +# furnished to do so, subject to the following conditions: +# +# The above copyright notice and this permission notice shall be included in +# all copies or substantial portions of the Software. +# +# THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR +# IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, +# FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE +# AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER +# LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, +# OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN +# THE SOFTWARE. +""" +`adafruit_logger` +================================================================================ + +Logging module for CircuitPython + + +* Author(s): Dave Astels + +Implementation Notes +-------------------- + +**Hardware:** + + +**Software and Dependencies:** + +* Adafruit CircuitPython firmware for the supported boards: + https://github.com/adafruit/circuitpython/releases + +""" +#pylint:disable=redefined-outer-name + +# imports + +__version__ = "0.0.0-auto.0" +__repo__ = "https://github.com/adafruit/Adafruit_CircuitPython_Logger.git" + +import time + +levels = [(0, 'NOTSET'), + (10, 'DEBUG'), + (20, 'INFO'), + (30, 'WARNING'), + (40, 'ERROR'), + (50, 'CRITICAL')] + +for value, name in levels: + globals()[name] = value + +def level_for(value): + for i in range(len(levels)): + if value < levels[i][0]: + return levels[i-1][1] + return levels[0][1] + +class LoggingHandler(object): + + def format(self, level, msg): + now = time.localtime() + time_vals = (now.tm_year, now.tm_mon, now.tm_mday, + now.tm_hour, now.tm_min, now.tm_sec) + timestamp = '%4d/%02d/%02d %02d:%02d:%02d' % time_vals + return '{0}: {1} - {2}'.format(timestamp, level_for(level), msg) + + def emit(self, level, msg): + raise NotImplementedError() + +class PrintHandler(LoggingHandler): + + def emit(self, level, msg): + print(self.format(level, msg)) + + +# The level module-global variables get created when loaded +#pylint:disable=undefined-variable + +class Logger(object): + + def __init__(self, handler=None): + self._level = NOTSET + if handler is None: + self._handler = PrintHandler() + else: + self._handler = handler + + @property + def level(self): + return self._level + + @level.setter + def level(self, value): + self._level = value + + def log(self, level, format_string, *args): + if self._level != NOTSET and level >= self._level: + self._handler.emit(level, format_string.format(*args)) + + def debug(self, format_string, *args): + self.log(DEBUG, format_string, *args) + + def info(self, format_string, *args): + self.log(INFO, format_string, *args) + + def warning(self, format_string, *args): + self.log(WARNING, format_string, *args) + + def error(self, format_string, *args): + self.log(ERROR, format_string, *args) + + def critical(self, format_string, *args): + self.log(CRITICAL, format_string, *args) diff --git a/Logger/adafruit_logger/uart_handler.py b/Logger/adafruit_logger/uart_handler.py new file mode 100644 index 0000000..5e8a7cd --- /dev/null +++ b/Logger/adafruit_logger/uart_handler.py @@ -0,0 +1,68 @@ +# The MIT License (MIT) +# +# Copyright (c) 2019 Dave Astels for Adafruit Industries +# +# Permission is hereby granted, free of charge, to any person obtaining a copy +# of this software and associated documentation files (the "Software"), to deal +# in the Software without restriction, including without limitation the rights +# to use, copy, modify, merge, publish, distribute, sublicense, and/or sell +# copies of the Software, and to permit persons to whom the Software is +# furnished to do so, subject to the following conditions: +# +# The above copyright notice and this permission notice shall be included in +# all copies or substantial portions of the Software. +# +# THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR +# IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, +# FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE +# AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER +# LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, +# OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN +# THE SOFTWARE. +""" +`adafruit_logger` +================================================================================ + +UART message handler for the Logging module for CircuitPython + + +* Author(s): Dave Astels + +Implementation Notes +-------------------- + +**Hardware:** + + +**Software and Dependencies:** + +* Adafruit CircuitPython firmware for the supported boards: + https://github.com/adafruit/circuitpython/releases + +""" +#pylint:disable=missing-super-argument + +# Example: +# +# import board +# import busio +# from adafruit_logger.uart_handler import UartHandler +# from adafruit_logger import * +# +# uart = busio.UART(board.TX, board.RX, baudrate=115200) +# logger = Logger(UartHandler(uart)) +# logger.level = INFO +# logger.info('testing') + +from adafruit_logger import LoggingHandler + +class UartHandler(LoggingHandler): + + def __init__(self, uart): + self._uart = uart + + def format(self, level, msg): + return super().format(level, msg) + '\r\n' + + def emit(self, level, msg): + self._uart.write(bytes(self.format(level, msg), 'utf-8')) diff --git a/Logger/docs/_static/favicon.ico b/Logger/docs/_static/favicon.ico new file mode 100644 index 0000000000000000000000000000000000000000..5aca98376a1f7e593ebd9cf41a808512c2135635 GIT binary patch literal 4414 zcmd^BX;4#F6n=SG-XmlONeGrD5E6J{RVh+e928U#MG!$jWvO+UsvWh`x&VqGNx*en zx=qox7Dqv{kPwo%fZC$dDwVpRtz{HzTkSs8QhG0)%Y=-3@Kt!4ag|JcIo?$-F|?bXVS9UDUyev>MVZQ(H8K4#;BQW-t2CPorj8^KJrMX}QK zp+e<;4ldpXz~=)2GxNy811&)gt-}Q*yVQpsxr@VMoA##{)$1~=bZ1MmjeFw?uT(`8 z^g=09<=zW%r%buwN%iHtuKSg|+r7HkT0PYN*_u9k1;^Ss-Z!RBfJ?Un4w(awqp2b3 z%+myoFis_lTlCrGx2z$0BQdh+7?!JK#9K9@Z!VrG zNj6gK5r(b4?YDOLw|DPRoN7bdP{(>GEG41YcN~4r_SUHU2hgVtUwZG@s%edC;k7Sn zC)RvEnlq~raE2mY2ko64^m1KQL}3riixh?#J{o)IT+K-RdHae2eRX91-+g!y`8^># z-zI0ir>P%Xon)!@xp-BK2bDYUB9k613NRrY6%lVjbFcQc*pRqiK~8xtkNPLxt}e?&QsTB}^!39t_%Qb)~Ukn0O%iC;zt z<&A-y;3h++)>c1br`5VFM~5(83!HKx$L+my8sW_c#@x*|*vB1yU)_dt3vH;2hqPWx zAl^6@?ipx&U7pf`a*>Yq6C85nb+B=Fnn+(id$W#WB^uHAcZVG`qg;rWB}ubvi(Y>D z$ei>REw$#xp0SHAd^|1hq&9HJ=jKK8^zTH~nk)G?yUcmTh9vUM6Y0LMw4(gYVY$D$ zGl&WY&H<)BbJ&3sYbKjx1j^=3-0Q#f^}(aP1?8^`&FUWMp|rmtpK)bLQ1Zo?^s4jqK=Lfg*9&geMGVQ z#^-*!V`fG@;H&{M9S8%+;|h&Qrxym0Ar>WT4BCVLR8cGXF=JmEYN(sNT(9vl+S|%g z8r7nXQ(95i^`=+XHo|){$vf2$?=`F$^&wFlYXyXg$B{a>$-Fp+V}+D;9k=~Xl~?C4 zAB-;RKXdUzBJE{V&d&%R>aEfFe;vxqI$0@hwVM}gFeQR@j}a>DDxR+n+-*6|_)k%% z*mSpDV|=5I9!&VC&9tD%fcVygWZV!iIo2qFtm#!*(s|@ZT33*Ad;+<|3^+yrp*;oH zBSYLV(H1zTU?2WjrCQoQW)Z>J2a=dTriuvezBmu16`tM2fm7Q@d4^iqII-xFpwHGI zn9CL}QE*1vdj2PX{PIuqOe5dracsciH6OlAZATvE8rj6ykqdIjal2 z0S0S~PwHb-5?OQ-tU-^KTG@XNrEVSvo|HIP?H;7ZhYeZkhSqh-{reE!5di;1zk$#Y zCe7rOnlzFYJ6Z#Hm$GoidKB=2HBCwm`BbZVeZY4ukmG%1uz7p2URs6c9j-Gjj^oQV zsdDb3@k2e`C$1I5ML5U0Qs0C1GAp^?!*`=|Nm(vWz3j*j*8ucum2;r0^-6Aca=Gv) zc%}&;!+_*S2tlnnJnz0EKeRmw-Y!@9ob!XQBwiv}^u9MkaXHvM=!<3YX;+2#5Cj5pp?FEK750S3BgeSDtaE^ zXUM@xoV6yBFKfzvY20V&Lr0yC + CircuitPython Reference Documentation + CircuitPython Support Forum + Discord Chat + Adafruit Learning System + Adafruit Blog + Adafruit Store + +Indices and tables +================== + +* :ref:`genindex` +* :ref:`modindex` +* :ref:`search` diff --git a/Logger/examples/logger_simpletest.py b/Logger/examples/logger_simpletest.py new file mode 100644 index 0000000..e69de29 diff --git a/Logger/requirements.txt b/Logger/requirements.txt new file mode 100644 index 0000000..edf9394 --- /dev/null +++ b/Logger/requirements.txt @@ -0,0 +1 @@ +Adafruit-Blinka diff --git a/Logger/setup.py b/Logger/setup.py new file mode 100644 index 0000000..aeab7af --- /dev/null +++ b/Logger/setup.py @@ -0,0 +1,63 @@ +"""A setuptools based setup module. + +See: +https://packaging.python.org/en/latest/distributing.html +https://github.com/pypa/sampleproject +""" + +from setuptools import setup, find_packages +# To use a consistent encoding +from codecs import open +from os import path + +here = path.abspath(path.dirname(__file__)) + +# Get the long description from the README file +with open(path.join(here, 'README.rst'), encoding='utf-8') as f: + long_description = f.read() + +setup( + name='adafruit-circuitpython-logger', + + use_scm_version=True, + setup_requires=['setuptools_scm'], + + description='Logging module for CircuitPython', + long_description=long_description, + long_description_content_type='text/x-rst', + + # The project's main homepage. + url='https://github.com/adafruit/Adafruit_CircuitPython_Logger', + + # Author details + author='Adafruit Industries', + author_email='circuitpython@adafruit.com', + + install_requires=[ + 'Adafruit-Blinka' + ], + + # Choose your license + license='MIT', + + # See https://pypi.python.org/pypi?%3Aaction=list_classifiers + classifiers=[ + 'Development Status :: 3 - Alpha', + 'Intended Audience :: Developers', + 'Topic :: Software Development :: Libraries', + 'Topic :: System :: Hardware', + 'License :: OSI Approved :: MIT License', + 'Programming Language :: Python :: 3', + 'Programming Language :: Python :: 3.4', + 'Programming Language :: Python :: 3.5', + ], + + # What does your project relate to? + keywords='adafruit blinka circuitpython micropython logger logging programming', + + # You can just specify the packages manually here if your project is + # simple. Or you can use find_packages(). + # TODO: IF LIBRARY FILES ARE A PACKAGE FOLDER, + # CHANGE `py_modules=['...']` TO `packages=['...']` + py_modules=['adafruit_logger'], +) From 2f76eaf9cdef7c12d0853651fe322e64a65dd231 Mon Sep 17 00:00:00 2001 From: Dave Astels Date: Thu, 7 Mar 2019 16:33:40 -0500 Subject: [PATCH 02/11] Rearrange --- Logger/.gitignore => .gitignore | 0 Logger/.pylintrc => .pylintrc | 0 Logger/.readthedocs.yml => .readthedocs.yml | 0 Logger/.travis.yml => .travis.yml | 0 Logger/CODE_OF_CONDUCT.md => CODE_OF_CONDUCT.md | 0 Logger/LICENSE => LICENSE | 0 README.md | 1 - Logger/README.rst => README.rst | 0 .../adafruit_logger.py | 0 .../uart_handler.py | 0 {Logger/docs => docs}/_static/favicon.ico | Bin {Logger/docs => docs}/api.rst | 0 {Logger/docs => docs}/conf.py | 0 {Logger/docs => docs}/examples.rst | 0 {Logger/docs => docs}/index.rst | 0 {Logger/examples => examples}/logger_simpletest.py | 0 Logger/requirements.txt => requirements.txt | 0 Logger/setup.py => setup.py | 0 18 files changed, 1 deletion(-) rename Logger/.gitignore => .gitignore (100%) rename Logger/.pylintrc => .pylintrc (100%) rename Logger/.readthedocs.yml => .readthedocs.yml (100%) rename Logger/.travis.yml => .travis.yml (100%) rename Logger/CODE_OF_CONDUCT.md => CODE_OF_CONDUCT.md (100%) rename Logger/LICENSE => LICENSE (100%) delete mode 100644 README.md rename Logger/README.rst => README.rst (100%) rename {Logger/adafruit_logger => adafruit_logger}/adafruit_logger.py (100%) rename {Logger/adafruit_logger => adafruit_logger}/uart_handler.py (100%) rename {Logger/docs => docs}/_static/favicon.ico (100%) rename {Logger/docs => docs}/api.rst (100%) rename {Logger/docs => docs}/conf.py (100%) rename {Logger/docs => docs}/examples.rst (100%) rename {Logger/docs => docs}/index.rst (100%) rename {Logger/examples => examples}/logger_simpletest.py (100%) rename Logger/requirements.txt => requirements.txt (100%) rename Logger/setup.py => setup.py (100%) diff --git a/Logger/.gitignore b/.gitignore similarity index 100% rename from Logger/.gitignore rename to .gitignore diff --git a/Logger/.pylintrc b/.pylintrc similarity index 100% rename from Logger/.pylintrc rename to .pylintrc diff --git a/Logger/.readthedocs.yml b/.readthedocs.yml similarity index 100% rename from Logger/.readthedocs.yml rename to .readthedocs.yml diff --git a/Logger/.travis.yml b/.travis.yml similarity index 100% rename from Logger/.travis.yml rename to .travis.yml diff --git a/Logger/CODE_OF_CONDUCT.md b/CODE_OF_CONDUCT.md similarity index 100% rename from Logger/CODE_OF_CONDUCT.md rename to CODE_OF_CONDUCT.md diff --git a/Logger/LICENSE b/LICENSE similarity index 100% rename from Logger/LICENSE rename to LICENSE diff --git a/README.md b/README.md deleted file mode 100644 index 1dc85a4..0000000 --- a/README.md +++ /dev/null @@ -1 +0,0 @@ -# Adafruit_CircuitPython_Logger \ No newline at end of file diff --git a/Logger/README.rst b/README.rst similarity index 100% rename from Logger/README.rst rename to README.rst diff --git a/Logger/adafruit_logger/adafruit_logger.py b/adafruit_logger/adafruit_logger.py similarity index 100% rename from Logger/adafruit_logger/adafruit_logger.py rename to adafruit_logger/adafruit_logger.py diff --git a/Logger/adafruit_logger/uart_handler.py b/adafruit_logger/uart_handler.py similarity index 100% rename from Logger/adafruit_logger/uart_handler.py rename to adafruit_logger/uart_handler.py diff --git a/Logger/docs/_static/favicon.ico b/docs/_static/favicon.ico similarity index 100% rename from Logger/docs/_static/favicon.ico rename to docs/_static/favicon.ico diff --git a/Logger/docs/api.rst b/docs/api.rst similarity index 100% rename from Logger/docs/api.rst rename to docs/api.rst diff --git a/Logger/docs/conf.py b/docs/conf.py similarity index 100% rename from Logger/docs/conf.py rename to docs/conf.py diff --git a/Logger/docs/examples.rst b/docs/examples.rst similarity index 100% rename from Logger/docs/examples.rst rename to docs/examples.rst diff --git a/Logger/docs/index.rst b/docs/index.rst similarity index 100% rename from Logger/docs/index.rst rename to docs/index.rst diff --git a/Logger/examples/logger_simpletest.py b/examples/logger_simpletest.py similarity index 100% rename from Logger/examples/logger_simpletest.py rename to examples/logger_simpletest.py diff --git a/Logger/requirements.txt b/requirements.txt similarity index 100% rename from Logger/requirements.txt rename to requirements.txt diff --git a/Logger/setup.py b/setup.py similarity index 100% rename from Logger/setup.py rename to setup.py From 4c661445ec877d376eedaacd72a2df1ee3e225d2 Mon Sep 17 00:00:00 2001 From: Dave Astels Date: Thu, 7 Mar 2019 16:38:14 -0500 Subject: [PATCH 03/11] Use pylint on the dir, since that's what we're doing --- .travis.yml | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/.travis.yml b/.travis.yml index 9fb3383..0c99ea7 100644 --- a/.travis.yml +++ b/.travis.yml @@ -42,7 +42,7 @@ install: - pip install --force-reinstall pylint==1.9.2 script: - - pylint adafruit_logger.py + - pylint adafruit_logger/*.py - ([[ ! -d "examples" ]] || pylint --disable=missing-docstring,invalid-name,bad-whitespace examples/*.py) - circuitpython-build-bundles --filename_prefix adafruit-circuitpython-logger --library_location . - cd docs && sphinx-build -E -W -b html . _build/html && cd .. From 8d0a83372f52ad44416c701e1a32f601f2755c79 Mon Sep 17 00:00:00 2001 From: Dave Astels Date: Thu, 7 Mar 2019 17:18:08 -0500 Subject: [PATCH 04/11] Pylint tweaks, mainly docstrings --- adafruit_logger/adafruit_logger.py | 62 ++++++++++++++++++++++++++---- adafruit_logger/uart_handler.py | 5 +++ 2 files changed, 60 insertions(+), 7 deletions(-) diff --git a/adafruit_logger/adafruit_logger.py b/adafruit_logger/adafruit_logger.py index f05f4ca..a998c68 100644 --- a/adafruit_logger/adafruit_logger.py +++ b/adafruit_logger/adafruit_logger.py @@ -40,7 +40,7 @@ https://github.com/adafruit/circuitpython/releases """ -#pylint:disable=redefined-outer-name +#pylint:disable=redefined-outer-name,consider-using-enumerate,no-self-use # imports @@ -49,25 +49,33 @@ import time -levels = [(0, 'NOTSET'), +LEVELS = [(00, 'NOTSET'), (10, 'DEBUG'), (20, 'INFO'), (30, 'WARNING'), (40, 'ERROR'), (50, 'CRITICAL')] -for value, name in levels: +for value, name in LEVELS: globals()[name] = value def level_for(value): - for i in range(len(levels)): - if value < levels[i][0]: - return levels[i-1][1] - return levels[0][1] + """Convert a numberic level to the most appropriate name. + value -- a numeric level + """ + for i in range(len(LEVELS)): + if value < LEVELS[i][0]: + return LEVELS[i-1][1] + return LEVELS[0][1] class LoggingHandler(object): + """Abstract logging message handler.""" def format(self, level, msg): + """Generate a timestamped message. + level -- the logging level + msg -- the message to log + """ now = time.localtime() time_vals = (now.tm_year, now.tm_mon, now.tm_mday, now.tm_hour, now.tm_min, now.tm_sec) @@ -75,11 +83,20 @@ def format(self, level, msg): return '{0}: {1} - {2}'.format(timestamp, level_for(level), msg) def emit(self, level, msg): + """Send a message where it should go. + Place holder for subclass implementations. + """ raise NotImplementedError() + class PrintHandler(LoggingHandler): + """Send logging messages to the console by using print.""" def emit(self, level, msg): + """Send a message to teh console. + level -- the logging level + msg -- the message to log + """ print(self.format(level, msg)) @@ -87,8 +104,12 @@ def emit(self, level, msg): #pylint:disable=undefined-variable class Logger(object): + """Provide a logging api.""" def __init__(self, handler=None): + """Create an instance. + handler -- what to use to output messages. Defaults to a PrintHandler. + """ self._level = NOTSET if handler is None: self._handler = PrintHandler() @@ -97,27 +118,54 @@ def __init__(self, handler=None): @property def level(self): + """Get the level.""" return self._level @level.setter def level(self, value): + """Set the level.""" self._level = value def log(self, level, format_string, *args): + """Log a message. + level -- the priority level at which to log + format_string -- the core mesage string with embedded formatting directives + args -- arguments format_string.format(), can be empty + """ if self._level != NOTSET and level >= self._level: self._handler.emit(level, format_string.format(*args)) def debug(self, format_string, *args): + """Log a debug message. + format_string -- the core mesage string with embedded formatting directives + args -- arguments format_string.format(), can be empty + """ self.log(DEBUG, format_string, *args) def info(self, format_string, *args): + """Log a info message. + format_string -- the core mesage string with embedded formatting directives + args -- arguments format_string.format(), can be empty + """ self.log(INFO, format_string, *args) def warning(self, format_string, *args): + """Log a warning message. + format_string -- the core mesage string with embedded formatting directives + args -- arguments format_string.format(), can be empty + """ self.log(WARNING, format_string, *args) def error(self, format_string, *args): + """Log a error message. + format_string -- the core mesage string with embedded formatting directives + args -- arguments format_string.format(), can be empty + """ self.log(ERROR, format_string, *args) def critical(self, format_string, *args): + """Log a critical message. + format_string -- the core mesage string with embedded formatting directives + args -- arguments format_string.format(), can be empty + """ self.log(CRITICAL, format_string, *args) diff --git a/adafruit_logger/uart_handler.py b/adafruit_logger/uart_handler.py index 5e8a7cd..94834ca 100644 --- a/adafruit_logger/uart_handler.py +++ b/adafruit_logger/uart_handler.py @@ -57,8 +57,13 @@ from adafruit_logger import LoggingHandler class UartHandler(LoggingHandler): + """Send logging output to a serial port.""" def __init__(self, uart): + """Create an instance. + uart -- the busio.UART instance to which to write messages + """ + self._uart = uart def format(self, level, msg): From 353d4812c60a6eca81da5da2a5e853eddab792c9 Mon Sep 17 00:00:00 2001 From: Dave Astels Date: Thu, 7 Mar 2019 17:35:59 -0500 Subject: [PATCH 05/11] Fix to reflect structure --- docs/api.rst | 5 ++++- 1 file changed, 4 insertions(+), 1 deletion(-) diff --git a/docs/api.rst b/docs/api.rst index d437289..47651c6 100644 --- a/docs/api.rst +++ b/docs/api.rst @@ -4,5 +4,8 @@ .. If your library file(s) are nested in a directory (e.g. /adafruit_foo/foo.py) .. use this format as the module name: "adafruit_foo.foo" -.. automodule:: adafruit_logger +.. automodule:: adafruit_logger.adafruit_logger + :members: + + .. automodule:: adafruit_logger.uart_handler :members: From 2f46421f77413e3ba5784bef7cdf438f1688ef8d Mon Sep 17 00:00:00 2001 From: Dave Astels Date: Thu, 7 Mar 2019 17:41:23 -0500 Subject: [PATCH 06/11] Fix bad space --- docs/api.rst | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/docs/api.rst b/docs/api.rst index 47651c6..15cd112 100644 --- a/docs/api.rst +++ b/docs/api.rst @@ -7,5 +7,5 @@ .. automodule:: adafruit_logger.adafruit_logger :members: - .. automodule:: adafruit_logger.uart_handler +.. automodule:: adafruit_logger.uart_handler :members: From 1153fe0b8069315cb292951f6e7ef379dd168b49 Mon Sep 17 00:00:00 2001 From: Dave Astels Date: Thu, 7 Mar 2019 17:41:41 -0500 Subject: [PATCH 07/11] Add a simpletest --- examples/logger_simpletest.py | 6 ++++++ 1 file changed, 6 insertions(+) diff --git a/examples/logger_simpletest.py b/examples/logger_simpletest.py index e69de29..2b22e74 100644 --- a/examples/logger_simpletest.py +++ b/examples/logger_simpletest.py @@ -0,0 +1,6 @@ +from adafruit_logger import Logger, ERROR, INFO +logger = Logger() + +logger.level = ERROR +logger.log(INFO, 'Info message') +logger.log(ERROR, 'Error message') From d80b8fd139f0cec3ca9eff447a0da8636283df1c Mon Sep 17 00:00:00 2001 From: Dave Astels Date: Thu, 7 Mar 2019 17:57:43 -0500 Subject: [PATCH 08/11] Adjust for inadequate tooling --- examples/logger_simpletest.py | 3 ++- 1 file changed, 2 insertions(+), 1 deletion(-) diff --git a/examples/logger_simpletest.py b/examples/logger_simpletest.py index 2b22e74..ad0751e 100644 --- a/examples/logger_simpletest.py +++ b/examples/logger_simpletest.py @@ -1,4 +1,5 @@ -from adafruit_logger import Logger, ERROR, INFO +#pylint:disable=undefined-variable,wildcard-import,no-name-in-module +from adafruit_logger import * logger = Logger() logger.level = ERROR From 09b0e14d541203ac9b82775d7abb534cb7157810 Mon Sep 17 00:00:00 2001 From: Dave Astels Date: Fri, 8 Mar 2019 11:28:39 -0500 Subject: [PATCH 09/11] remove uart_handler from library, bring code back to top level --- .travis.yml | 2 +- .../adafruit_logger.py => adafruit_logger.py | 0 adafruit_logger/uart_handler.py | 73 ------------------- docs/api.rst | 6 +- 4 files changed, 2 insertions(+), 79 deletions(-) rename adafruit_logger/adafruit_logger.py => adafruit_logger.py (100%) delete mode 100644 adafruit_logger/uart_handler.py diff --git a/.travis.yml b/.travis.yml index 0c99ea7..9fb3383 100644 --- a/.travis.yml +++ b/.travis.yml @@ -42,7 +42,7 @@ install: - pip install --force-reinstall pylint==1.9.2 script: - - pylint adafruit_logger/*.py + - pylint adafruit_logger.py - ([[ ! -d "examples" ]] || pylint --disable=missing-docstring,invalid-name,bad-whitespace examples/*.py) - circuitpython-build-bundles --filename_prefix adafruit-circuitpython-logger --library_location . - cd docs && sphinx-build -E -W -b html . _build/html && cd .. diff --git a/adafruit_logger/adafruit_logger.py b/adafruit_logger.py similarity index 100% rename from adafruit_logger/adafruit_logger.py rename to adafruit_logger.py diff --git a/adafruit_logger/uart_handler.py b/adafruit_logger/uart_handler.py deleted file mode 100644 index 94834ca..0000000 --- a/adafruit_logger/uart_handler.py +++ /dev/null @@ -1,73 +0,0 @@ -# The MIT License (MIT) -# -# Copyright (c) 2019 Dave Astels for Adafruit Industries -# -# Permission is hereby granted, free of charge, to any person obtaining a copy -# of this software and associated documentation files (the "Software"), to deal -# in the Software without restriction, including without limitation the rights -# to use, copy, modify, merge, publish, distribute, sublicense, and/or sell -# copies of the Software, and to permit persons to whom the Software is -# furnished to do so, subject to the following conditions: -# -# The above copyright notice and this permission notice shall be included in -# all copies or substantial portions of the Software. -# -# THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR -# IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, -# FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE -# AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER -# LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, -# OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN -# THE SOFTWARE. -""" -`adafruit_logger` -================================================================================ - -UART message handler for the Logging module for CircuitPython - - -* Author(s): Dave Astels - -Implementation Notes --------------------- - -**Hardware:** - - -**Software and Dependencies:** - -* Adafruit CircuitPython firmware for the supported boards: - https://github.com/adafruit/circuitpython/releases - -""" -#pylint:disable=missing-super-argument - -# Example: -# -# import board -# import busio -# from adafruit_logger.uart_handler import UartHandler -# from adafruit_logger import * -# -# uart = busio.UART(board.TX, board.RX, baudrate=115200) -# logger = Logger(UartHandler(uart)) -# logger.level = INFO -# logger.info('testing') - -from adafruit_logger import LoggingHandler - -class UartHandler(LoggingHandler): - """Send logging output to a serial port.""" - - def __init__(self, uart): - """Create an instance. - uart -- the busio.UART instance to which to write messages - """ - - self._uart = uart - - def format(self, level, msg): - return super().format(level, msg) + '\r\n' - - def emit(self, level, msg): - self._uart.write(bytes(self.format(level, msg), 'utf-8')) diff --git a/docs/api.rst b/docs/api.rst index 15cd112..4491ecf 100644 --- a/docs/api.rst +++ b/docs/api.rst @@ -4,8 +4,4 @@ .. If your library file(s) are nested in a directory (e.g. /adafruit_foo/foo.py) .. use this format as the module name: "adafruit_foo.foo" -.. automodule:: adafruit_logger.adafruit_logger - :members: - -.. automodule:: adafruit_logger.uart_handler - :members: +.. automodule:: adafruit_logger From f708a32947e0f8bf5324b3d68d66ed838b29ca98 Mon Sep 17 00:00:00 2001 From: Dave Astels Date: Fri, 8 Mar 2019 11:46:33 -0500 Subject: [PATCH 10/11] Clean up import --- examples/logger_simpletest.py | 3 ++- 1 file changed, 2 insertions(+), 1 deletion(-) diff --git a/examples/logger_simpletest.py b/examples/logger_simpletest.py index ad0751e..82d6a36 100644 --- a/examples/logger_simpletest.py +++ b/examples/logger_simpletest.py @@ -1,5 +1,6 @@ #pylint:disable=undefined-variable,wildcard-import,no-name-in-module -from adafruit_logger import * +from adafruit_logger import Logger, ERROR, INFO + logger = Logger() logger.level = ERROR From e929e170caad1755f8a8097f994403be69022a14 Mon Sep 17 00:00:00 2001 From: Dave Astels Date: Fri, 8 Mar 2019 14:47:38 -0500 Subject: [PATCH 11/11] Reformat doc strings --- adafruit_logger.py | 64 +++++++++++++++++++++++++++++----------------- 1 file changed, 41 insertions(+), 23 deletions(-) diff --git a/adafruit_logger.py b/adafruit_logger.py index a998c68..a0c0f05 100644 --- a/adafruit_logger.py +++ b/adafruit_logger.py @@ -42,12 +42,11 @@ """ #pylint:disable=redefined-outer-name,consider-using-enumerate,no-self-use -# imports +import time __version__ = "0.0.0-auto.0" __repo__ = "https://github.com/adafruit/Adafruit_CircuitPython_Logger.git" -import time LEVELS = [(00, 'NOTSET'), (10, 'DEBUG'), @@ -61,7 +60,9 @@ def level_for(value): """Convert a numberic level to the most appropriate name. - value -- a numeric level + + :param value: a numeric level + """ for i in range(len(LEVELS)): if value < LEVELS[i][0]: @@ -73,8 +74,10 @@ class LoggingHandler(object): def format(self, level, msg): """Generate a timestamped message. - level -- the logging level - msg -- the message to log + + :param level: the logging level + :param msg: the message to log + """ now = time.localtime() time_vals = (now.tm_year, now.tm_mon, now.tm_mday, @@ -94,8 +97,10 @@ class PrintHandler(LoggingHandler): def emit(self, level, msg): """Send a message to teh console. - level -- the logging level - msg -- the message to log + + :param level: the logging level + :param msg: the message to log + """ print(self.format(level, msg)) @@ -108,7 +113,9 @@ class Logger(object): def __init__(self, handler=None): """Create an instance. - handler -- what to use to output messages. Defaults to a PrintHandler. + + :param handler: what to use to output messages. Defaults to a PrintHandler. + """ self._level = NOTSET if handler is None: @@ -118,54 +125,65 @@ def __init__(self, handler=None): @property def level(self): - """Get the level.""" + """The level.""" return self._level @level.setter def level(self, value): - """Set the level.""" self._level = value def log(self, level, format_string, *args): """Log a message. - level -- the priority level at which to log - format_string -- the core mesage string with embedded formatting directives - args -- arguments format_string.format(), can be empty + + :param level: the priority level at which to log + :param format_string: the core message string with embedded formatting directives + :param args: arguments to ``format_string.format()``, can be empty + """ if self._level != NOTSET and level >= self._level: self._handler.emit(level, format_string.format(*args)) def debug(self, format_string, *args): """Log a debug message. - format_string -- the core mesage string with embedded formatting directives - args -- arguments format_string.format(), can be empty + + :param format_string: the core message string with embedded formatting directives + :param args: arguments to ``format_string.format()``, can be empty + """ self.log(DEBUG, format_string, *args) def info(self, format_string, *args): """Log a info message. - format_string -- the core mesage string with embedded formatting directives - args -- arguments format_string.format(), can be empty + + :param format_string: the core message string with embedded formatting directives + :param args: arguments to ``format_string.format()``, can be empty + """ self.log(INFO, format_string, *args) def warning(self, format_string, *args): """Log a warning message. - format_string -- the core mesage string with embedded formatting directives - args -- arguments format_string.format(), can be empty + + :param format_string: the core message string with embedded formatting directives + :param args: arguments to ``format_string.format()``, can be empty + """ self.log(WARNING, format_string, *args) def error(self, format_string, *args): """Log a error message. - format_string -- the core mesage string with embedded formatting directives - args -- arguments format_string.format(), can be empty + + :param format_string: the core message string with embedded formatting directives + :param args: arguments to ``format_string.format()``, can be empty + """ self.log(ERROR, format_string, *args) def critical(self, format_string, *args): """Log a critical message. - format_string -- the core mesage string with embedded formatting directives - args -- arguments format_string.format(), can be empty + + :param format_string: the core message string with embedded formatting directives + :param args: arguments to ``format_string.format()``, can be empty + """ self.log(CRITICAL, format_string, *args)