Skip to content

Ran black, updated to pylint 2.x #15

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

Merged
merged 2 commits into from
Mar 17, 2020
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension


Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
2 changes: 1 addition & 1 deletion .github/workflows/build.yml
Original file line number Diff line number Diff line change
Expand Up @@ -40,7 +40,7 @@ jobs:
source actions-ci/install.sh
- name: Pip install pylint, black, & Sphinx
run: |
pip install --force-reinstall pylint==1.9.2 black==19.10b0 Sphinx sphinx-rtd-theme
pip install --force-reinstall pylint black==19.10b0 Sphinx sphinx-rtd-theme
- name: Library version
run: git describe --dirty --always --tags
- name: PyLint
Expand Down
17 changes: 6 additions & 11 deletions adafruit_debouncer.py
Original file line number Diff line number Diff line change
Expand Up @@ -52,7 +52,8 @@
_UNSTABLE_STATE = const(0x02)
_CHANGED_STATE = const(0x04)

class Debouncer(object):

class Debouncer():
"""Debounce an input pin or an arbitrary predicate"""

def __init__(self, io_or_predicate, interval=0.010):
Expand All @@ -61,7 +62,7 @@ def __init__(self, io_or_predicate, interval=0.010):
:param int interval: bounce threshold in seconds (default is 0.010, i.e. 10 milliseconds)
"""
self.state = 0x00
if hasattr(io_or_predicate, 'value'):
if hasattr(io_or_predicate, "value"):
self.function = lambda: io_or_predicate.value
else:
self.function = io_or_predicate
Expand All @@ -72,23 +73,18 @@ def __init__(self, io_or_predicate, interval=0.010):
self._previous_state_duration = 0
self._state_changed_time = 0


def _set_state(self, bits):
self.state |= bits


def _unset_state(self, bits):
self.state &= ~bits


def _toggle_state(self, bits):
self.state ^= bits


def _get_state(self, bits):
return (self.state & bits) != 0


def update(self):
"""Update the debouncer state. MUST be called frequently"""
now = time.monotonic()
Expand All @@ -106,23 +102,22 @@ def update(self):
self._previous_state_duration = now - self._state_changed_time
self._state_changed_time = now


@property
def value(self):
"""Return the current debounced value."""
return self._get_state(_DEBOUNCED_STATE)


@property
def rose(self):
"""Return whether the debounced value went from low to high at the most recent update."""
return self._get_state(_DEBOUNCED_STATE) and self._get_state(_CHANGED_STATE)


@property
def fell(self):
"""Return whether the debounced value went from high to low at the most recent update."""
return (not self._get_state(_DEBOUNCED_STATE)) and self._get_state(_CHANGED_STATE)
return (not self._get_state(_DEBOUNCED_STATE)) and self._get_state(
_CHANGED_STATE
)

@property
def last_duration(self):
Expand Down
112 changes: 65 additions & 47 deletions docs/conf.py
Original file line number Diff line number Diff line change
Expand Up @@ -2,18 +2,19 @@

import os
import sys
sys.path.insert(0, os.path.abspath('..'))

sys.path.insert(0, os.path.abspath(".."))

# -- General configuration ------------------------------------------------

# Add any Sphinx extension module names here, as strings. They can be
# extensions coming with Sphinx (named 'sphinx.ext.*') or your custom
# ones.
extensions = [
'sphinx.ext.autodoc',
'sphinx.ext.intersphinx',
'sphinx.ext.napoleon',
'sphinx.ext.todo',
"sphinx.ext.autodoc",
"sphinx.ext.intersphinx",
"sphinx.ext.napoleon",
"sphinx.ext.todo",
]

# TODO: Please Read!
Expand All @@ -23,29 +24,32 @@
autodoc_mock_imports = ["digitalio"]


intersphinx_mapping = {'python': ('https://docs.python.org/3.4', None),'CircuitPython': ('https://circuitpython.readthedocs.io/en/latest/', None)}
intersphinx_mapping = {
"python": ("https://docs.python.org/3.4", None),
"CircuitPython": ("https://circuitpython.readthedocs.io/en/latest/", None),
}

# Add any paths that contain templates here, relative to this directory.
templates_path = ['_templates']
templates_path = ["_templates"]

source_suffix = '.rst'
source_suffix = ".rst"

# The master toctree document.
master_doc = 'index'
master_doc = "index"

# General information about the project.
project = u'Adafruit Debouncer Library'
copyright = u'2019 Dave Astels'
author = u'Dave Astels'
project = "Adafruit Debouncer Library"
copyright = "2019 Dave Astels"
author = "Dave Astels"

# The version info for the project you're documenting, acts as replacement for
# |version| and |release|, also used in various other places throughout the
# built documents.
#
# The short X.Y version.
version = u'1.0'
version = "1.0"
# The full version, including alpha/beta/rc tags.
release = u'1.0'
release = "1.0"

# The language for content autogenerated by Sphinx. Refer to documentation
# for a list of supported languages.
Expand All @@ -57,7 +61,7 @@
# List of patterns, relative to source directory, that match files and
# directories to ignore when looking for source files.
# This patterns also effect to html_static_path and html_extra_path
exclude_patterns = ['_build', 'Thumbs.db', '.DS_Store', '.env', 'CODE_OF_CONDUCT.md']
exclude_patterns = ["_build", "Thumbs.db", ".DS_Store", ".env", "CODE_OF_CONDUCT.md"]

# The reST default role (used for this markup: `text`) to use for all
# documents.
Expand All @@ -69,7 +73,7 @@
add_function_parentheses = True

# The name of the Pygments (syntax highlighting) style to use.
pygments_style = 'sphinx'
pygments_style = "sphinx"

# If true, `todo` and `todoList` produce output, else they produce nothing.
todo_include_todos = False
Expand All @@ -84,68 +88,76 @@
# The theme to use for HTML and HTML Help pages. See the documentation for
# a list of builtin themes.
#
on_rtd = os.environ.get('READTHEDOCS', None) == 'True'
on_rtd = os.environ.get("READTHEDOCS", None) == "True"

if not on_rtd: # only import and set the theme if we're building docs locally
try:
import sphinx_rtd_theme
html_theme = 'sphinx_rtd_theme'
html_theme_path = [sphinx_rtd_theme.get_html_theme_path(), '.']

html_theme = "sphinx_rtd_theme"
html_theme_path = [sphinx_rtd_theme.get_html_theme_path(), "."]
except:
html_theme = 'default'
html_theme_path = ['.']
html_theme = "default"
html_theme_path = ["."]
else:
html_theme_path = ['.']
html_theme_path = ["."]

# Add any paths that contain custom static files (such as style sheets) here,
# relative to this directory. They are copied after the builtin static files,
# so a file named "default.css" will overwrite the builtin "default.css".
html_static_path = ['_static']
html_static_path = ["_static"]

# The name of an image file (relative to this directory) to use as a favicon of
# the docs. This file should be a Windows icon file (.ico) being 16x16 or 32x32
# pixels large.
#
html_favicon = '_static/favicon.ico'
html_favicon = "_static/favicon.ico"

# Output file base name for HTML help builder.
htmlhelp_basename = 'AdafruitDebouncerLibrarydoc'
htmlhelp_basename = "AdafruitDebouncerLibrarydoc"

# -- Options for LaTeX output ---------------------------------------------

latex_elements = {
# The paper size ('letterpaper' or 'a4paper').
#
# 'papersize': 'letterpaper',

# The font size ('10pt', '11pt' or '12pt').
#
# 'pointsize': '10pt',

# Additional stuff for the LaTeX preamble.
#
# 'preamble': '',

# Latex figure (float) alignment
#
# 'figure_align': 'htbp',
# The paper size ('letterpaper' or 'a4paper').
#
# 'papersize': 'letterpaper',
# The font size ('10pt', '11pt' or '12pt').
#
# 'pointsize': '10pt',
# Additional stuff for the LaTeX preamble.
#
# 'preamble': '',
# Latex figure (float) alignment
#
# 'figure_align': 'htbp',
}

# Grouping the document tree into LaTeX files. List of tuples
# (source start file, target name, title,
# author, documentclass [howto, manual, or own class]).
latex_documents = [
(master_doc, 'AdafruitdebouncerLibrary.tex', u'Adafruitdebouncer Library Documentation',
author, 'manual'),
(
master_doc,
"AdafruitdebouncerLibrary.tex",
"Adafruitdebouncer Library Documentation",
author,
"manual",
),
]

# -- Options for manual page output ---------------------------------------

# One entry per manual page. List of tuples
# (source start file, name, description, authors, manual section).
man_pages = [
(master_doc, 'Adafruitdebouncerlibrary', u'Adafruit debouncer Library Documentation',
[author], 1)
(
master_doc,
"Adafruitdebouncerlibrary",
"Adafruit debouncer Library Documentation",
[author],
1,
)
]

# -- Options for Texinfo output -------------------------------------------
Expand All @@ -154,7 +166,13 @@
# (source start file, target name, title, author,
# dir menu entry, description, category)
texinfo_documents = [
(master_doc, 'AdafruitdebouncerLibrary', u'Adafruit debouncer Library Documentation',
author, 'AdafruitdebouncerLibrary', 'One line description of project.',
'Miscellaneous'),
(
master_doc,
"AdafruitdebouncerLibrary",
"Adafruit debouncer Library Documentation",
author,
"AdafruitdebouncerLibrary",
"One line description of project.",
"Miscellaneous",
),
]
7 changes: 6 additions & 1 deletion examples/debouncer_crickit_test.py
Original file line number Diff line number Diff line change
Expand Up @@ -34,11 +34,13 @@

ss = crickit.seesaw


def make_crikit_signal_debouncer(pin):
"""Return a lambda to read the specified pin"""
ss.pin_mode(pin, ss.INPUT_PULLUP)
return Debouncer(lambda: ss.digital_read(pin))


# Two buttons are pullups, connect to ground to activate
clock = make_crikit_signal_debouncer(crickit.SIGNAL1)
signal_2 = make_crikit_signal_debouncer(crickit.SIGNAL2)
Expand All @@ -54,6 +56,9 @@ def make_crikit_signal_debouncer(pin):
signal_5.update()

if clock.fell:
print('%u %u %u %u' % (signal_2.value, signal_3.value, signal_4.value, signal_5.value))
print(
"%u %u %u %u"
% (signal_2.value, signal_3.value, signal_4.value, signal_5.value)
)

time.sleep(0.1)
8 changes: 4 additions & 4 deletions examples/debouncer_simpletest.py
Original file line number Diff line number Diff line change
Expand Up @@ -36,10 +36,10 @@
while True:
switch.update()
if switch.fell:
print('Just pressed')
print("Just pressed")
if switch.rose:
print('Just released')
print("Just released")
if switch.value:
print('not pressed')
print("not pressed")
else:
print('pressed')
print("pressed")
10 changes: 5 additions & 5 deletions examples/debouncer_timing_test.py
Original file line number Diff line number Diff line change
Expand Up @@ -11,11 +11,11 @@
while True:
switch.update()
if switch.fell:
print('pressed')
print('was released for ', switch.last_duration)
print("pressed")
print("was released for ", switch.last_duration)
elif switch.rose:
print('released')
print('was pressed for ', switch.last_duration)
print("released")
print("was pressed for ", switch.last_duration)
else:
print('Stable for ', switch.current_duration)
print("Stable for ", switch.current_duration)
time.sleep(0.1)