Skip to content

Ran black, updated to pylint 2.x #10

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
25 changes: 15 additions & 10 deletions adafruit_max31856.py
Original file line number Diff line number Diff line change
Expand Up @@ -47,6 +47,7 @@
from time import sleep
from micropython import const
from adafruit_bus_device.spi_device import SPIDevice

try:
from struct import unpack
except ImportError:
Expand Down Expand Up @@ -92,7 +93,7 @@
_MAX31856_FAULT_OPEN = const(0x01)


class ThermocoupleType: # pylint: disable=too-few-public-methods
class ThermocoupleType: # pylint: disable=too-few-public-methods
"""An enum-like class representing the different types of thermocouples that the MAX31856 can
use. The values can be referenced like ``ThermocoupleType.K`` or ``ThermocoupleType.S``
Possible values are
Expand All @@ -107,6 +108,7 @@ class ThermocoupleType: # pylint: disable=too-few-public-methods
- ``ThermocoupleType.T``

"""

# pylint: disable=invalid-name
B = 0b0000
E = 0b0001
Expand Down Expand Up @@ -156,13 +158,15 @@ def temperature(self):
self._perform_one_shot_measurement()

# unpack the 3-byte temperature as 4 bytes
raw_temp = unpack(">i", self._read_register(_MAX31856_LTCBH_REG, 3)+bytes([0]))[0]
raw_temp = unpack(
">i", self._read_register(_MAX31856_LTCBH_REG, 3) + bytes([0])
)[0]

# shift to remove extra byte from unpack needing 4 bytes
raw_temp >>= 8

# effectively shift raw_read >> 12 to convert pseudo-float
temp_float = (raw_temp / 4096.0)
temp_float = raw_temp / 4096.0

return temp_float

Expand Down Expand Up @@ -202,16 +206,17 @@ def temperature_thresholds(self, val):
self._write_u8(_MAX31856_LTLFTL_REG, int_low)

@property
def reference_temperature_thresholds(self): # pylint: disable=invalid-name
def reference_temperature_thresholds(self): # pylint: disable=invalid-name
"""The cold junction's low and high temperature thresholds
as a ``(low_temp, high_temp)`` tuple
"""
return (float(unpack("b", self._read_register(_MAX31856_CJLF_REG, 1))[0]),
float(unpack("b", self._read_register(_MAX31856_CJHF_REG, 1))[0]))

return (
float(unpack("b", self._read_register(_MAX31856_CJLF_REG, 1))[0]),
float(unpack("b", self._read_register(_MAX31856_CJHF_REG, 1))[0]),
)

@reference_temperature_thresholds.setter
def reference_temperature_thresholds(self, val): # pylint: disable=invalid-name
def reference_temperature_thresholds(self, val): # pylint: disable=invalid-name

self._write_u8(_MAX31856_CJLF_REG, int(val[0]))
self._write_u8(_MAX31856_CJHF_REG, int(val[1]))
Expand Down Expand Up @@ -245,7 +250,7 @@ def fault(self):
"tc_high": bool(faults & _MAX31856_FAULT_TCHIGH),
"tc_low": bool(faults & _MAX31856_FAULT_TCLOW),
"voltage": bool(faults & _MAX31856_FAULT_OVUV),
"open_tc": bool(faults & _MAX31856_FAULT_OPEN)
"open_tc": bool(faults & _MAX31856_FAULT_OPEN),
}

def _perform_one_shot_measurement(self):
Expand Down Expand Up @@ -278,4 +283,4 @@ def _write_u8(self, address, val):
with self._device as device:
self._BUFFER[0] = (address | 0x80) & 0xFF
self._BUFFER[1] = val & 0xFF
device.write(self._BUFFER, end=2) # pylint: disable=no-member
device.write(self._BUFFER, end=2) # pylint: disable=no-member
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 = ["digitalio", "busio", "micropython", "adafruit_bus_device"]


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 MAX31856 Library'
copyright = u'2018 Bryan Siepert'
author = u'Bryan Siepert'
project = u"Adafruit MAX31856 Library"
copyright = u"2018 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 = 'AdafruitMax31856Librarydoc'
htmlhelp_basename = "AdafruitMax31856Librarydoc"

# -- 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, 'AdafruitMAX31856Library.tex', u'AdafruitMAX31856 Library Documentation',
author, 'manual'),
(
master_doc,
"AdafruitMAX31856Library.tex",
u"AdafruitMAX31856 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, 'AdafruitMAX31856library', u'Adafruit MAX31856 Library Documentation',
[author], 1)
(
master_doc,
"AdafruitMAX31856library",
u"Adafruit MAX31856 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, 'AdafruitMAX31856Library', u'Adafruit MAX31856 Library Documentation',
author, 'AdafruitMAX31856Library', 'One line description of project.',
'Miscellaneous'),
(
master_doc,
"AdafruitMAX31856Library",
u"Adafruit MAX31856 Library Documentation",
author,
"AdafruitMAX31856Library",
"One line description of project.",
"Miscellaneous",
),
]
3 changes: 2 additions & 1 deletion examples/max31856_simpletest.py
Original file line number Diff line number Diff line change
Expand Up @@ -2,6 +2,7 @@
import busio
import digitalio
import adafruit_max31856

# create a spi object
spi = busio.SPI(board.SCK, board.MOSI, board.MISO)

Expand All @@ -10,7 +11,7 @@
cs.direction = digitalio.Direction.OUTPUT

# create a thermocouple object with the above
thermocouple = adafruit_max31856.MAX31856(spi,cs)
thermocouple = adafruit_max31856.MAX31856(spi, cs)

# print the temperature!
print(thermocouple.temperature)
32 changes: 23 additions & 9 deletions examples/max31856_thresholds_and_faults.py
Original file line number Diff line number Diff line change
Expand Up @@ -3,6 +3,7 @@
import busio
import digitalio
import adafruit_max31856

# create a spi object
spi = busio.SPI(board.SCK, board.MOSI, board.MISO)

Expand All @@ -24,19 +25,32 @@
current_temp_thresholds = thermocouple.temperature_thresholds
current_cj_thresholds = thermocouple.reference_temperature_thresholds
current_faults = thermocouple.fault
print("Temps: %.2f :: cj: %.2f"%(thermocouple.temperature,
thermocouple.reference_temperature))
print(
"Temps: %.2f :: cj: %.2f"
% (thermocouple.temperature, thermocouple.reference_temperature)
)
print("Thresholds:")
print("Temp low: %.2f high: %.2f"%current_temp_thresholds)
print("CJ low: %.2f high: %.2f"%current_cj_thresholds)
print("Temp low: %.2f high: %.2f" % current_temp_thresholds)
print("CJ low: %.2f high: %.2f" % current_cj_thresholds)
print("")
print("Faults:")
print("Temp Hi: %s | CJ Hi: %s"%(current_faults['tc_high'], current_faults['cj_high']))
print("Temp Low: %s | CJ Low: %s"%(current_faults['tc_low'], current_faults['cj_low']))
print("Temp Range: %s | CJ Range: %s"%(current_faults['tc_range'], current_faults['cj_range']))
print(
"Temp Hi: %s | CJ Hi: %s"
% (current_faults["tc_high"], current_faults["cj_high"])
)
print(
"Temp Low: %s | CJ Low: %s"
% (current_faults["tc_low"], current_faults["cj_low"])
)
print(
"Temp Range: %s | CJ Range: %s"
% (current_faults["tc_range"], current_faults["cj_range"])
)
print("")
print("Open Circuit: %s Voltage Over/Under: %s"%(current_faults['open_tc'],
current_faults['voltage']))
print(
"Open Circuit: %s Voltage Over/Under: %s"
% (current_faults["open_tc"], current_faults["voltage"])
)
print("")

time.sleep(1.0)
Loading