Skip to content

Ran black, updated to pylint 2.x #4

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 16, 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
70 changes: 37 additions & 33 deletions adafruit_lps35hw.py
Original file line number Diff line number Diff line change
Expand Up @@ -53,33 +53,35 @@
from adafruit_register.i2c_struct import UnaryStruct
from adafruit_register.i2c_bits import RWBits, ROBits
from adafruit_register.i2c_bit import RWBit

# pylint: disable=bad-whitespace
_INTERRUPT_CFG = const(0x0B)
_THS_P_L = const(0x0C)
_THS_P_H = const(0x0D)
_WHO_AM_I = const(0x0F)
_CTRL_REG1 = const(0x10)
_CTRL_REG2 = const(0x11)
_CTRL_REG3 = const(0x12)
_FIFO_CTRL = const(0x14)
_REF_P_XL = const(0x15)
_REF_P_L = const(0x16)
_REF_P_H = const(0x17)
_RPDS_L = const(0x18)
_RPDS_H = const(0x19)
_RES_CONF = const(0x1A)
_INT_SOURCE = const(0x25)
_FIFO_STATUS = const(0x26)
_STATUS = const(0x27)
_PRESS_OUT_XL = const(0x28)
_PRESS_OUT_L = const(0x29)
_PRESS_OUT_H = const(0x2A)
_TEMP_OUT_L = const(0x2B)
_TEMP_OUT_H = const(0x2C)
_LPFP_RES = const(0x33)
_INTERRUPT_CFG = const(0x0B)
_THS_P_L = const(0x0C)
_THS_P_H = const(0x0D)
_WHO_AM_I = const(0x0F)
_CTRL_REG1 = const(0x10)
_CTRL_REG2 = const(0x11)
_CTRL_REG3 = const(0x12)
_FIFO_CTRL = const(0x14)
_REF_P_XL = const(0x15)
_REF_P_L = const(0x16)
_REF_P_H = const(0x17)
_RPDS_L = const(0x18)
_RPDS_H = const(0x19)
_RES_CONF = const(0x1A)
_INT_SOURCE = const(0x25)
_FIFO_STATUS = const(0x26)
_STATUS = const(0x27)
_PRESS_OUT_XL = const(0x28)
_PRESS_OUT_L = const(0x29)
_PRESS_OUT_H = const(0x2A)
_TEMP_OUT_L = const(0x2B)
_TEMP_OUT_H = const(0x2C)
_LPFP_RES = const(0x33)
# pylint: enable=bad-whitespace

class DataRate: # pylint: disable=too-few-public-methods

class DataRate: # pylint: disable=too-few-public-methods
"""Options for ``data_rate``

+---------------------------+-------------------------+
Expand All @@ -99,14 +101,16 @@ class DataRate: # pylint: disable=too-few-public-methods
+---------------------------+-------------------------+

"""

ONE_SHOT = const(0x00)
RATE_1_HZ = const(0x01)
RATE_10_HZ = const(0x02)
RATE_25_HZ = const(0x03)
RATE_50_HZ = const(0x04)
RATE_75_HZ = const(0x05)

class LPS35HW: # pylint: disable=too-many-instance-attributes

class LPS35HW: # pylint: disable=too-many-instance-attributes
"""Driver for the ST LPS35HW MEMS pressure sensor

:param ~busio.I2C i2c_bus: The I2C bus the LPS34HW is connected to.
Expand Down Expand Up @@ -136,7 +140,7 @@ class LPS35HW: # pylint: disable=too-many-instance-attributes
_one_shot = RWBit(_CTRL_REG2, 0)

# registers for configuring INT pin behavior
_interrupt_cfg = UnaryStruct(_CTRL_REG3, "<B") # to read all values for latching?
_interrupt_cfg = UnaryStruct(_CTRL_REG3, "<B") # to read all values for latching?

# INT status registers
_interrupt_active = RWBit(_INT_SOURCE, 2)
Expand All @@ -156,10 +160,10 @@ class LPS35HW: # pylint: disable=too-many-instance-attributes
_chip_id = UnaryStruct(_WHO_AM_I, "<B")
_pressure_threshold = UnaryStruct(_THS_P_L, "<H")

def __init__(self, i2c_bus, address=0x5d):
def __init__(self, i2c_bus, address=0x5D):
self.i2c_device = i2cdevice.I2CDevice(i2c_bus, address)
if self._chip_id != 0xb1:
raise RuntimeError('Failed to find LPS35HW! Chip ID 0x%x' % self._chip_id)
if self._chip_id != 0xB1:
raise RuntimeError("Failed to find LPS35HW! Chip ID 0x%x" % self._chip_id)

self.reset()

Expand All @@ -173,12 +177,12 @@ def __init__(self, i2c_bus, address=0x5d):
def pressure(self):
"""The current pressure measurement in hPa"""
# reset the filter to prevent spurious readings
self._reset_filter # pylint: disable=pointless-statement
self._reset_filter # pylint: disable=pointless-statement

# check for negative and convert
raw = self._raw_pressure
if raw & (1<<23) != 0:
raw = (raw - (1<<24))
if raw & (1 << 23) != 0:
raw = raw - (1 << 24)
return raw / 4096.0

@property
Expand Down Expand Up @@ -219,7 +223,7 @@ def pressure_threshold(self):
@pressure_threshold.setter
def pressure_threshold(self, value):
"""The high value threshold"""
self._pressure_threshold = (value * 16)
self._pressure_threshold = value * 16

@property
def high_threshold_enabled(self):
Expand Down
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 LPS35HW Library'
copyright = u'2019 Bryan Siepert'
author = u'Bryan Siepert'
project = u"Adafruit LPS35HW 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 = 'AdafruitLps35hwLibrarydoc'
htmlhelp_basename = "AdafruitLps35hwLibrarydoc"

# -- 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, 'AdafruitLPS35HWLibrary.tex', u'AdafruitLPS35HW Library Documentation',
author, 'manual'),
(
master_doc,
"AdafruitLPS35HWLibrary.tex",
u"AdafruitLPS35HW 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, 'AdafruitLPS35HWlibrary', u'Adafruit LPS35HW Library Documentation',
[author], 1)
(
master_doc,
"AdafruitLPS35HWlibrary",
u"Adafruit LPS35HW 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, 'AdafruitLPS35HWLibrary', u'Adafruit LPS35HW Library Documentation',
author, 'AdafruitLPS35HWLibrary', 'One line description of project.',
'Miscellaneous'),
(
master_doc,
"AdafruitLPS35HWLibrary",
u"Adafruit LPS35HW Library Documentation",
author,
"AdafruitLPS35HWLibrary",
"One line description of project.",
"Miscellaneous",
),
]
2 changes: 1 addition & 1 deletion examples/lps35hw_data_rate.py
Original file line number Diff line number Diff line change
Expand Up @@ -20,7 +20,7 @@
print("")
time.sleep(1)

#take another measurement
# take another measurement
lps.take_measurement()

print("New Pressure: %.2f hPa" % lps.pressure)
Expand Down
2 changes: 1 addition & 1 deletion examples/lps35hw_simpletest.py
Original file line number Diff line number Diff line change
Expand Up @@ -7,6 +7,6 @@

while True:
print("Pressure: %.2f hPa" % lps.pressure)
print("Temperature: %.2f C"% lps.temperature)
print("Temperature: %.2f C" % lps.temperature)
print("")
time.sleep(1)
Loading