jepler/Adafruit_CircuitPython_BD3491FS
1
0
Fork 0
Code Issues Pull requests Projects Releases Packages Wiki Activity

Ran black, updated to pylint 2.x

Browse source
This commit is contained in:
dherrada 2020-03-12 19:13:51 -04:00
parent 582a741f9b
commit 6f5f2a5f9d
5 changed files with 118 additions and 95 deletions
Show stats Download patch file Download diff file Expand all files Collapse all files

2
.github/workflows/build.yml vendored
View file

@ -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

10
adafruit_bd3491fs.py
View file

@ -63,6 +63,7 @@ _SURROUND_GAIN = const(0x78)
_SYSTEM_RESET = const(0xFE)
# pylint: enable=bad-whitespace
class Input: # pylint: disable=too-few-public-methods,invalid-name
"""Options for ``active_input``
@ -87,6 +88,7 @@ class Input: # pylint: disable=too-few-public-methods,invalid-name
+-----------------+------------------+
"""
A = const(0x00)
B = const(0x01)
C = const(0x02)
@ -95,6 +97,8 @@ 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
"""Options for ``imput_gain``
@ -123,6 +127,7 @@ class Level: # pylint: disable=too-few-public-methods
+----------------------+-------+
"""
LEVEL_0DB = const(0x00)
LEVEL_2DB = const(0x01)
LEVEL_4DB = const(0x02)
@ -155,7 +160,6 @@ class BD3491FS: # pylint: disable=too-many-instance-attributes
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"""
@ -205,7 +209,7 @@ class BD3491FS: # pylint: disable=too-many-instance-attributes
@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
@ -222,7 +226,7 @@ class BD3491FS: # pylint: disable=too-many-instance-attributes
@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

96
docs/conf.py
View file

@ -2,7 +2,8 @@
import os
import sys
sys.path.insert(0, os.path.abspath('..'))
sys.path.insert(0, os.path.abspath(".."))
# -- General configuration ------------------------------------------------
@ -10,10 +11,10 @@ sys.path.insert(0, os.path.abspath('..'))
# 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!
@ -23,29 +24,40 @@ extensions = [
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.
@ -57,7 +69,7 @@ language = None
# 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.
@ -69,7 +81,7 @@ default_role = "any"
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
@ -84,32 +96,33 @@ napoleon_numpy_docstring = False
# 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 ---------------------------------------------
@ -117,15 +130,12 @@ 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',
@ -135,8 +145,13 @@ latex_elements = {
# (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 ---------------------------------------
@ -144,8 +159,13 @@ latex_documents = [
# 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 -------------------------------------------
@ -154,7 +174,13 @@ man_pages = [
# (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
examples/bd3491fs_simpletest.py
View file

@ -1,6 +1,7 @@
import board
import busio
import adafruit_bd3491fs
i2c = busio.I2C(board.SCL, board.SDA)
bd3491fs = adafruit_bd3491fs.BD3491FS(i2c)

54
setup.py
View file

@ -6,6 +6,7 @@ https://github.com/pypa/sampleproject
"""
from setuptools import setup, find_packages
# To use a consistent encoding
from codecs import open
from os import path
@ -13,53 +14,44 @@ 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:
with open(path.join(here, "README.rst"), encoding="utf-8") as f:
long_description = f.read()
setup(
name='adafruit-circuitpython-bd3491fs',
name="adafruit-circuitpython-bd3491fs",
use_scm_version=True,
setup_requires=['setuptools_scm'],
description='CircuitPython library for the Rohm BD3491FS Audio Processor',
setup_requires=["setuptools_scm"],
description="CircuitPython library for the Rohm BD3491FS Audio Processor",
long_description=long_description,
long_description_content_type='text/x-rst',
long_description_content_type="text/x-rst",
# The project's main homepage.
url='https://github.com/adafruit/Adafruit_CircuitPython_BD3491FS',
url="https://github.com/adafruit/Adafruit_CircuitPython_BD3491FS",
# Author details
author='Adafruit Industries',
author_email='circuitpython@adafruit.com',
author="Adafruit Industries",
author_email="circuitpython@adafruit.com",
install_requires=[
'Adafruit-Blinka',
'adafruit-circuitpython-busdevice',
'adafruit-circuitpython-register'
"Adafruit-Blinka",
"adafruit-circuitpython-busdevice",
"adafruit-circuitpython-register",
],
# Choose your license
license='MIT',
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',
"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 bd3491fs audio',
keywords="adafruit blinka circuitpython micropython bd3491fs audio",
# 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_bd3491fs'],
py_modules=["adafruit_bd3491fs"],
)