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.

Sign up for GitHub

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 17, 2020
Merged

Ran black, updated to pylint 2.x #15

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
1 commit
Select commit
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
View file
Open in desktop
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
91 changes: 58 additions & 33 deletions adafruit_veml6070.py
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -55,28 +55,31 @@

# Set I2C addresses:
# pylint: disable=bad-whitespace
_VEML6070_ADDR_ARA = const(0x18 >> 1)
_VEML6070_ADDR_CMD = const(0x70 >> 1)
_VEML6070_ADDR_LOW = const(0x71 >> 1)
_VEML6070_ADDR_ARA = const(0x18 >> 1)
_VEML6070_ADDR_CMD = const(0x70 >> 1)
_VEML6070_ADDR_LOW = const(0x71 >> 1)
_VEML6070_ADDR_HIGH = const(0x73 >> 1)

# Integration Time dictionary. [0] is the byte setting; [1] is the risk
# level divisor.
_VEML6070_INTEGRATION_TIME = { "VEML6070_HALF_T": [0x00, 0],
"VEML6070_1_T": [0x01, 1],
"VEML6070_2_T": [0x02, 2],
"VEML6070_4_T": [0x03, 4]
}
_VEML6070_INTEGRATION_TIME = {
"VEML6070_HALF_T": [0x00, 0],
"VEML6070_1_T": [0x01, 1],
"VEML6070_2_T": [0x02, 2],
"VEML6070_4_T": [0x03, 4],
}

# UV Risk Level dictionary. [0],[1] are the lower and uppper bounds of the range
_VEML6070_RISK_LEVEL = { "LOW": [0, 560],
"MODERATE": [561, 1120],
"HIGH": [1121, 1494],
"VERY HIGH": [1495, 2054],
"EXTREME": [2055, 9999]
}
_VEML6070_RISK_LEVEL = {
"LOW": [0, 560],
"MODERATE": [561, 1120],
"HIGH": [1121, 1494],
"VERY HIGH": [1495, 2054],
"EXTREME": [2055, 9999],
}
# pylint: enable=bad-whitespace


class VEML6070:
"""
Driver base for the VEML6070 UV Light Sensor
Expand Down Expand Up @@ -114,8 +117,10 @@ class VEML6070:
def __init__(self, i2c_bus, _veml6070_it="VEML6070_1_T", ack=False):
# Check if the IT is valid
if _veml6070_it not in _VEML6070_INTEGRATION_TIME:
raise ValueError('Integration Time invalid. Valid values are: ',
_VEML6070_INTEGRATION_TIME.keys())
raise ValueError(
"Integration Time invalid. Valid values are: ",
_VEML6070_INTEGRATION_TIME.keys(),
)

# Check if ACK is valid
if ack not in (True, False):
Expand All @@ -136,14 +141,15 @@ def __init__(self, i2c_bus, _veml6070_it="VEML6070_1_T", ack=False):
try:
with I2CDevice(i2c_bus, _VEML6070_ADDR_ARA) as ara:
ara.readinto(ara_buf)
except ValueError: # the ARA address is never valid? datasheet error?
except ValueError: # the ARA address is never valid? datasheet error?
pass
self.buf = bytearray(1)
self.buf[0] = self._ack << 5 | _VEML6070_INTEGRATION_TIME[self._it][0] << 2 | 0x02
self.buf[0] = (
self._ack << 5 | _VEML6070_INTEGRATION_TIME[self._it][0] << 2 | 0x02
)
with self.i2c_cmd as i2c_cmd:
i2c_cmd.write(self.buf)


@property
def uv_raw(self):
"""
Expand Down Expand Up @@ -172,8 +178,12 @@ def ack(self, new_ack):
if new_ack != bool(new_ack):
raise ValueError("ACK must be 'True' or 'False'.")
self._ack = int(new_ack)
self.buf[0] = (self._ack << 5 | self._ack_thd << 4 |
_VEML6070_INTEGRATION_TIME[self._it][0] << 2 | 0x02)
self.buf[0] = (
self._ack << 5
| self._ack_thd << 4
| _VEML6070_INTEGRATION_TIME[self._it][0] << 2
| 0x02
)
with self.i2c_cmd as i2c_cmd:
i2c_cmd.write(self.buf)

Expand All @@ -191,8 +201,12 @@ def ack_threshold(self, new_ack_thd):
if new_ack_thd not in (0, 1):
raise ValueError("ACK Threshold must be '0' or '1'.")
self._ack_thd = int(new_ack_thd)
self.buf[0] = (self._ack << 5 | self._ack_thd << 4 |
_VEML6070_INTEGRATION_TIME[self._it][0] << 2 | 0x02)
self.buf[0] = (
self._ack << 5
| self._ack_thd << 4
| _VEML6070_INTEGRATION_TIME[self._it][0] << 2
| 0x02
)
with self.i2c_cmd as i2c_cmd:
i2c_cmd.write(self.buf)

Expand All @@ -209,12 +223,18 @@ def integration_time(self):
@integration_time.setter
def integration_time(self, new_it):
if new_it not in _VEML6070_INTEGRATION_TIME:
raise ValueError("Integration Time invalid. Valid values are: ",
_VEML6070_INTEGRATION_TIME.keys())
raise ValueError(
"Integration Time invalid. Valid values are: ",
_VEML6070_INTEGRATION_TIME.keys(),
)

self._it = new_it
self.buf[0] = (self._ack << 5 | self._ack_thd << 4 |
_VEML6070_INTEGRATION_TIME[new_it][0] << 2 | 0x02)
self.buf[0] = (
self._ack << 5
| self._ack_thd << 4
| _VEML6070_INTEGRATION_TIME[new_it][0] << 2
| 0x02
)
with self.i2c_cmd as i2c_cmd:
i2c_cmd.write(self.buf)

Expand All @@ -231,8 +251,12 @@ def wake(self):
"""
Wakes the VEML6070 from sleep. ``[veml6070].uv_raw`` will also wake from sleep.
"""
self.buf[0] = (self._ack << 5 | self._ack_thd << 4 |
_VEML6070_INTEGRATION_TIME[self._it][0] << 2 | 0x02)
self.buf[0] = (
self._ack << 5
| self._ack_thd << 4
| _VEML6070_INTEGRATION_TIME[self._it][0] << 2
| 0x02
)
with self.i2c_cmd as i2c_cmd:
i2c_cmd.write(self.buf)

Expand Down Expand Up @@ -261,15 +285,16 @@ def get_index(self, _raw):
if div == 0:
raise ValueError(
"[veml6070].get_index only available for Integration Times 1, 2, & 4.",
"Use [veml6070].set_integration_time(new_it) to change the Integration Time."
)
"Use [veml6070].set_integration_time(new_it) to change the Integration Time.",
)

# adjust the raw value using the divisor, then loop through the Risk Level dict
# to find which range the adjusted raw value is in.
raw_adj = int(_raw / div)
for levels in _VEML6070_RISK_LEVEL:
tmp_range = range(_VEML6070_RISK_LEVEL[levels][0],
_VEML6070_RISK_LEVEL[levels][1])
tmp_range = range(
_VEML6070_RISK_LEVEL[levels][0], _VEML6070_RISK_LEVEL[levels][1]
)
if raw_adj in tmp_range:
risk = levels
break
Expand Down
114 changes: 68 additions & 46 deletions docs/conf.py
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -2,47 +2,55 @@

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.viewcode',
"sphinx.ext.autodoc",
"sphinx.ext.intersphinx",
"sphinx.ext.viewcode",
]

# Uncomment the below if you use native CircuitPython modules such as
# digitalio, micropython and busio. List the modules you use. Without it, the
# autodoc module docs will fail to generate with a warning.
# autodoc_mock_imports = ["micropython", "adafruit_bus_device"]

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 VEML6070 Library'
copyright = u'2017 Limor Fried & Michael Schroeder'
author = u'Limor Fried & Michael Schroeder'
project = u"Adafruit VEML6070 Library"
copyright = u"2017 Limor Fried & Michael Schroeder"
author = u"Limor Fried & Michael Schroeder"

# 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 @@ -54,7 +62,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 @@ -66,7 +74,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 @@ -80,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 = 'AdafruitVeml6070Librarydoc'
htmlhelp_basename = "AdafruitVeml6070Librarydoc"

# -- 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, 'AdafruitVEML6070Library.tex', u'AdafruitVEML6070 Library Documentation',
author, 'manual'),
(
master_doc,
"AdafruitVEML6070Library.tex",
u"AdafruitVEML6070 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, 'AdafruitVEML6070library', u'Adafruit VEML6070 Library Documentation',
[author], 1)
(
master_doc,
"AdafruitVEML6070library",
u"Adafruit VEML6070 Library Documentation",
[author],
1,
)
]

# -- Options for Texinfo output -------------------------------------------
Expand All @@ -150,7 +166,13 @@
# (source start file, target name, title, author,
# dir menu entry, description, category)
texinfo_documents = [
(master_doc, 'AdafruitVEML6070Library', u'Adafruit VEML6070 Library Documentation',
author, 'AdafruitVEML6070Library', 'One line description of project.',
'Miscellaneous'),
(
master_doc,
"AdafruitVEML6070Library",
u"Adafruit VEML6070 Library Documentation",
author,
"AdafruitVEML6070Library",
"One line description of project.",
"Miscellaneous",
),
]
Loading