Skip to content

Ran black, updated to pylint 2.x #8

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 1 commit into from
Mar 9, 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 pylint black==19.10b0 Sphinx sphinx-rtd-theme
- name: Library version
run: git describe --dirty --always --tags
- name: PyLint
Expand Down
11 changes: 6 additions & 5 deletions adafruit_nunchuk.py
Original file line number Diff line number Diff line change
Expand Up @@ -52,6 +52,7 @@
_I2C_INIT_DELAY = 0.1
_I2C_READ_DELAY = 0.01


class Nunchuk:
"""Class which provides interface to Nintendo Nunchuk controller."""

Expand All @@ -62,9 +63,9 @@ def __init__(self, i2c, address=_DEFAULT_ADDRESS):
with self.i2c_device as i2c_dev:
# turn off encrypted data
# http://wiibrew.org/wiki/Wiimote/Extension_Controllers
i2c_dev.write(b'\xF0\x55')
i2c_dev.write(b"\xF0\x55")
time.sleep(_I2C_INIT_DELAY)
i2c_dev.write(b'\xFB\x00')
i2c_dev.write(b"\xFB\x00")

@property
def joystick(self):
Expand All @@ -73,12 +74,12 @@ def joystick(self):
return self.buffer[0], self.buffer[1]

@property
def button_C(self): #pylint: disable=invalid-name
def button_C(self): # pylint: disable=invalid-name
"""Return current pressed state of button C."""
return not bool(self._read_data()[5] & 0x02)

@property
def button_Z(self): #pylint: disable=invalid-name
def button_Z(self): # pylint: disable=invalid-name
"""Return current pressed state of button Z."""
return not bool(self._read_data()[5] & 0x01)

Expand All @@ -95,7 +96,7 @@ def acceleration(self):
return x, y, z

def _read_data(self):
return self._read_register(b'\x00')
return self._read_register(b"\x00")

def _read_register(self, address):
with self.i2c_device as i2c:
Expand Down
116 changes: 69 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,36 @@
# autodoc_mock_imports = ["digitalio", "busio"]


intersphinx_mapping = {'python': ('https://docs.python.org/3.4', None),'BusDevice': ('https://circuitpython.readthedocs.io/projects/busdevice/en/latest/', None),'CircuitPython': ('https://circuitpython.readthedocs.io/en/latest/', None)}
intersphinx_mapping = {
"python": ("https://docs.python.org/3.4", None),
"BusDevice": (
"https://circuitpython.readthedocs.io/projects/busdevice/en/latest/",
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 Nunchuk Library'
copyright = u'2019 Carter Nelson'
author = u'Carter Nelson'
project = "Adafruit Nunchuk Library"
copyright = "2019 Carter Nelson"
author = "Carter Nelson"

# 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 +65,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 +77,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 +92,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 = 'AdafruitNunchukLibrarydoc'
htmlhelp_basename = "AdafruitNunchukLibrarydoc"

# -- 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, 'AdafruitNunchukLibrary.tex', u'AdafruitNunchuk Library Documentation',
author, 'manual'),
(
master_doc,
"AdafruitNunchukLibrary.tex",
"AdafruitNunchuk 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, 'AdafruitNunchuklibrary', u'Adafruit Nunchuk Library Documentation',
[author], 1)
(
master_doc,
"AdafruitNunchuklibrary",
"Adafruit Nunchuk Library Documentation",
[author],
1,
)
]

# -- Options for Texinfo output -------------------------------------------
Expand All @@ -154,7 +170,13 @@
# (source start file, target name, title, author,
# dir menu entry, description, category)
texinfo_documents = [
(master_doc, 'AdafruitNunchukLibrary', u'Adafruit Nunchuk Library Documentation',
author, 'AdafruitNunchukLibrary', 'One line description of project.',
'Miscellaneous'),
(
master_doc,
"AdafruitNunchukLibrary",
"Adafruit Nunchuk Library Documentation",
author,
"AdafruitNunchukLibrary",
"One line description of project.",
"Miscellaneous",
),
]
24 changes: 12 additions & 12 deletions examples/nunchuk_accel_mouse.py
Original file line number Diff line number Diff line change
Expand Up @@ -14,24 +14,24 @@
cDown = False
zDown = False

#This is to allow double checking (only on left click - and it doesn't really work)
CHECK_COUNT=0
# This is to allow double checking (only on left click - and it doesn't really work)
CHECK_COUNT = 0


#This is just to show that we're getting back data - uncomment it and hold down the buttons
#while True:
# This is just to show that we're getting back data - uncomment it and hold down the buttons
# while True:
# print((0 if nc.button_C else 1, 0 if nc.button_Z else 1))

while True:
accel = nc.acceleration
# print(accel)
# x, y = nc.joystick
# print((x,y))
x = accel[0]/4
y = accel[1]/4
print((x,y))
#Eliminate spurious reads
if (x == 255 or y == 255):
# print(accel)
# x, y = nc.joystick
# print((x,y))
x = accel[0] / 4
y = accel[1] / 4
print((x, y))
# Eliminate spurious reads
if x == 255 or y == 255:
continue
relX = x - centerX
relY = y - centerY
Expand Down
12 changes: 6 additions & 6 deletions examples/nunchuk_analog_mouse.py
Original file line number Diff line number Diff line change
Expand Up @@ -14,18 +14,18 @@
cDown = False
zDown = False

#This is to allow double checking (only on left click - and it doesn't really work)
CHECK_COUNT=0
# This is to allow double checking (only on left click - and it doesn't really work)
CHECK_COUNT = 0


#This is just to show that we're getting back data - uncomment it and hold down the buttons
#while True:
# This is just to show that we're getting back data - uncomment it and hold down the buttons
# while True:
# print((0 if nc.button_C else 1, 0 if nc.button_Z else 1))

while True:
x, y = nc.joystick
#Eliminate spurious reads
if (x == 255 or y == 255):
# Eliminate spurious reads
if x == 255 or y == 255:
continue
relX = x - centerX
relY = centerY - y
Expand Down
4 changes: 2 additions & 2 deletions examples/nunchuk_mouse.py
Original file line number Diff line number Diff line change
Expand Up @@ -9,8 +9,8 @@

while True:
x, y = nc.joystick
x = (x - 128)//2
y = (128 - y)//2
x = (x - 128) // 2
y = (128 - y) // 2
if abs(x) > THRESHOLD:
m.move(x, 0, 0)
if abs(y) > THRESHOLD:
Expand Down