Skip to content

Commit

Permalink
Ran black, updated to pylint 2.x
Browse files Browse the repository at this point in the history
  • Loading branch information
evaherrada committed Mar 12, 2020
1 parent 582a741 commit 6f5f2a5
Show file tree
Hide file tree
Showing 5 changed files with 118 additions and 95 deletions.
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
36 changes: 20 additions & 16 deletions adafruit_bd3491fs.py
Original file line number Diff line number Diff line change
Expand Up @@ -53,17 +53,18 @@
from adafruit_register.i2c_struct import UnaryStruct

# pylint: disable=bad-whitespace
_INPUT_SELECTOR = const(0x04)
_INPUT_GAIN = const(0x06)
_INPUT_SELECTOR = const(0x04)
_INPUT_GAIN = const(0x06)
_VOLUME_GAIN_CH1 = const(0x21)
_VOLUME_GAIN_CH2 = const(0x22)
_BASS_GAIN = const(0x51)
_TREBLE_GAIN = const(0x57)
_SURROUND_GAIN = const(0x78)
_SYSTEM_RESET = const(0xFE)
_BASS_GAIN = const(0x51)
_TREBLE_GAIN = const(0x57)
_SURROUND_GAIN = const(0x78)
_SYSTEM_RESET = const(0xFE)
# pylint: enable=bad-whitespace

class Input: # pylint: disable=too-few-public-methods,invalid-name

class Input: # pylint: disable=too-few-public-methods,invalid-name
"""Options for ``active_input``
+-----------------+------------------+
Expand All @@ -87,6 +88,7 @@ class Input: # pylint: disable=too-few-public-methods,invalid-name
+-----------------+------------------+
"""

A = const(0x00)
B = const(0x01)
C = const(0x02)
Expand All @@ -95,7 +97,9 @@ class Input: # pylint: disable=too-few-public-methods,invalid-name
F = const(0x06)
SHORT = const(0x05)
MUTE = const(0x07)
class Level: # pylint: disable=too-few-public-methods


class Level: # pylint: disable=too-few-public-methods
"""Options for ``imput_gain``
+----------------------+-------+
Expand Down Expand Up @@ -123,6 +127,7 @@ class Level: # pylint: disable=too-few-public-methods
+----------------------+-------+
"""

LEVEL_0DB = const(0x00)
LEVEL_2DB = const(0x01)
LEVEL_4DB = const(0x02)
Expand All @@ -135,7 +140,7 @@ class Level: # pylint: disable=too-few-public-methods
LEVEL_20DB = const(0x0A)


class BD3491FS: # pylint: disable=too-many-instance-attributes
class BD3491FS: # pylint: disable=too-many-instance-attributes
"""Driver for the Rohm BD3491FS audio processor
:param ~busio.I2C i2c_bus: The I2C bus the BD3491FS is connected to.
Expand All @@ -149,13 +154,12 @@ class BD3491FS: # pylint: disable=too-many-instance-attributes

def __init__(self, i2c_bus):
self.i2c_device = i2cdevice.I2CDevice(i2c_bus, 0x41)
self._current_active_input = 7 # mute
self._current_input_gain = 0 # 0dB
self._current_ch1_attenuation = 255 # muted
self._current_ch2_attenuation = 255 # muted
self._current_active_input = 7 # mute
self._current_input_gain = 0 # 0dB
self._current_ch1_attenuation = 255 # muted
self._current_ch2_attenuation = 255 # muted
self.reset()


def reset(self):
"""Reset the sensor, muting the input, reducting input gain to 0dB, and the output channnel
attenuation to maximum"""
Expand Down Expand Up @@ -205,7 +209,7 @@ def channel_1_attenuation(self):

@channel_1_attenuation.setter
def channel_1_attenuation(self, value):
if ((value < 0) or ((value > 87) and (value != 255))):
if (value < 0) or ((value > 87) and (value != 255)):
raise ValueError("channel 1 attenuation must be from 0-87db")
self._ch1_attenuation = value
self._current_ch1_attenuation = value
Expand All @@ -222,7 +226,7 @@ def channel_2_attenuation(self):

@channel_2_attenuation.setter
def channel_2_attenuation(self, value):
if ((value < 0) or ((value > 87) and (value != 255))):
if (value < 0) or ((value > 87) and (value != 255)):
raise ValueError("channel 2 attenuation must be from 0-87db")
self._ch2_attenuation = value
self._current_ch2_attenuation = value
120 changes: 73 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,40 @@
autodoc_mock_imports = ["micropython", "adafruit_bus_device", "adafruit_register"]


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

# 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 = u"1.0"
# The full version, including alpha/beta/rc tags.
release = u'1.0'
release = u"1.0"

# The language for content autogenerated by Sphinx. Refer to documentation
# for a list of supported languages.
Expand All @@ -57,7 +69,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 +81,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 +96,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 = 'AdafruitBd3491fsLibrarydoc'
htmlhelp_basename = "AdafruitBd3491fsLibrarydoc"

# -- 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, 'AdafruitBD3491FSLibrary.tex', u'AdafruitBD3491FS Library Documentation',
author, 'manual'),
(
master_doc,
"AdafruitBD3491FSLibrary.tex",
u"AdafruitBD3491FS 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, 'AdafruitBD3491FSlibrary', u'Adafruit BD3491FS Library Documentation',
[author], 1)
(
master_doc,
"AdafruitBD3491FSlibrary",
u"Adafruit BD3491FS Library Documentation",
[author],
1,
)
]

# -- Options for Texinfo output -------------------------------------------
Expand All @@ -154,7 +174,13 @@
# (source start file, target name, title, author,
# dir menu entry, description, category)
texinfo_documents = [
(master_doc, 'AdafruitBD3491FSLibrary', u'Adafruit BD3491FS Library Documentation',
author, 'AdafruitBD3491FSLibrary', 'One line description of project.',
'Miscellaneous'),
(
master_doc,
"AdafruitBD3491FSLibrary",
u"Adafruit BD3491FS Library Documentation",
author,
"AdafruitBD3491FSLibrary",
"One line description of project.",
"Miscellaneous",
),
]
1 change: 1 addition & 0 deletions examples/bd3491fs_simpletest.py
Original file line number Diff line number Diff line change
@@ -1,6 +1,7 @@
import board
import busio
import adafruit_bd3491fs

i2c = busio.I2C(board.SCL, board.SDA)
bd3491fs = adafruit_bd3491fs.BD3491FS(i2c)

Expand Down
Loading

0 comments on commit 6f5f2a5

Please sign in to comment.