Skip to content

Commit e44a966

Browse files
authored
Merge pull request #7 from adafruit/pylint-update
Ran black, updated to pylint 2.x
2 parents 4b2e1a3 + 41b43eb commit e44a966

File tree

4 files changed

+106
-86
lines changed

4 files changed

+106
-86
lines changed

.github/workflows/build.yml

+1-1
Original file line numberDiff line numberDiff line change
@@ -40,7 +40,7 @@ jobs:
4040
source actions-ci/install.sh
4141
- name: Pip install pylint, black, & Sphinx
4242
run: |
43-
pip install --force-reinstall pylint==1.9.2 black==19.10b0 Sphinx sphinx-rtd-theme
43+
pip install --force-reinstall pylint black==19.10b0 Sphinx sphinx-rtd-theme
4444
- name: Library version
4545
run: git describe --dirty --always --tags
4646
- name: PyLint

adafruit_mpl115a2.py

+9-7
Original file line numberDiff line numberDiff line change
@@ -50,14 +50,16 @@
5050
__repo__ = "https://github.com/adafruit/Adafruit_CircuitPython_MPL115A2.git"
5151

5252
# pylint: disable=bad-whitespace
53-
_MPL115A2_ADDRESS = const(0x60)
54-
_MPL115A2_REGISTER_PRESSURE_MSB = const(0x00)
55-
_MPL115A2_REGISTER_A0_COEFF_MSB = const(0x04)
56-
_MPL115A2_REGISTER_STARTCONVERSION = const(0x12)
53+
_MPL115A2_ADDRESS = const(0x60)
54+
_MPL115A2_REGISTER_PRESSURE_MSB = const(0x00)
55+
_MPL115A2_REGISTER_A0_COEFF_MSB = const(0x04)
56+
_MPL115A2_REGISTER_STARTCONVERSION = const(0x12)
5757
# pylint: enable=bad-whitespace
5858

59+
5960
class MPL115A2:
6061
"""Driver for MPL115A2 I2C barometric pressure / temperature sensor."""
62+
6163
def __init__(self, i2c, address=_MPL115A2_ADDRESS):
6264
self._i2c = i2c_device.I2CDevice(i2c, address)
6365
self._buf = bytearray(4)
@@ -66,7 +68,7 @@ def __init__(self, i2c, address=_MPL115A2_ADDRESS):
6668
@property
6769
def pressure(self):
6870
"""The pressure in hPa."""
69-
return self._read()[0]*10
71+
return self._read()[0] * 10
7072

7173
@property
7274
def temperature(self):
@@ -94,7 +96,7 @@ def _read(self):
9496
self._buf[1] = 0x00 # why? see datasheet, pg. 9, fig. 4
9597
with self._i2c as i2c:
9698
i2c.write(self._buf, end=2)
97-
time.sleep(0.005) # see datasheet, Conversion Time = 3ms MAX
99+
time.sleep(0.005) # see datasheet, Conversion Time = 3ms MAX
98100
self._buf[0] = _MPL115A2_REGISTER_PRESSURE_MSB
99101
i2c.write(self._buf, end=1)
100102
i2c.readinto(self._buf)
@@ -104,7 +106,7 @@ def _read(self):
104106
# see datasheet pg. 6, eqn. 1, result in counts
105107
pressure = self._a0 + (self._b1 + self._c12 * temp) * pressure + self._b2 * temp
106108
# see datasheet pg. 6, eqn. 2, result in kPa
107-
pressure = (65/1023) * pressure + 50
109+
pressure = (65 / 1023) * pressure + 50
108110
# stolen from arduino driver, result in deg C
109111
temp = (temp - 498) / -5.35 + 25
110112
return pressure, temp

docs/conf.py

+73-47
Original file line numberDiff line numberDiff line change
@@ -2,18 +2,19 @@
22

33
import os
44
import sys
5-
sys.path.insert(0, os.path.abspath('..'))
5+
6+
sys.path.insert(0, os.path.abspath(".."))
67

78
# -- General configuration ------------------------------------------------
89

910
# Add any Sphinx extension module names here, as strings. They can be
1011
# extensions coming with Sphinx (named 'sphinx.ext.*') or your custom
1112
# ones.
1213
extensions = [
13-
'sphinx.ext.autodoc',
14-
'sphinx.ext.intersphinx',
15-
'sphinx.ext.napoleon',
16-
'sphinx.ext.todo',
14+
"sphinx.ext.autodoc",
15+
"sphinx.ext.intersphinx",
16+
"sphinx.ext.napoleon",
17+
"sphinx.ext.todo",
1718
]
1819

1920
# TODO: Please Read!
@@ -23,29 +24,40 @@
2324
# autodoc_mock_imports = ["digitalio", "busio"]
2425

2526

26-
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)}
27+
intersphinx_mapping = {
28+
"python": ("https://docs.python.org/3.4", None),
29+
"BusDevice": (
30+
"https://circuitpython.readthedocs.io/projects/busdevice/en/latest/",
31+
None,
32+
),
33+
"Register": (
34+
"https://circuitpython.readthedocs.io/projects/register/en/latest/",
35+
None,
36+
),
37+
"CircuitPython": ("https://circuitpython.readthedocs.io/en/latest/", None),
38+
}
2739

2840
# Add any paths that contain templates here, relative to this directory.
29-
templates_path = ['_templates']
41+
templates_path = ["_templates"]
3042

31-
source_suffix = '.rst'
43+
source_suffix = ".rst"
3244

3345
# The master toctree document.
34-
master_doc = 'index'
46+
master_doc = "index"
3547

3648
# General information about the project.
37-
project = u'Adafruit MPL115A2 Library'
38-
copyright = u'2018 Carter Nelson'
39-
author = u'Carter Nelson'
49+
project = u"Adafruit MPL115A2 Library"
50+
copyright = u"2018 Carter Nelson"
51+
author = u"Carter Nelson"
4052

4153
# The version info for the project you're documenting, acts as replacement for
4254
# |version| and |release|, also used in various other places throughout the
4355
# built documents.
4456
#
4557
# The short X.Y version.
46-
version = u'1.0'
58+
version = u"1.0"
4759
# The full version, including alpha/beta/rc tags.
48-
release = u'1.0'
60+
release = u"1.0"
4961

5062
# The language for content autogenerated by Sphinx. Refer to documentation
5163
# for a list of supported languages.
@@ -57,7 +69,7 @@
5769
# List of patterns, relative to source directory, that match files and
5870
# directories to ignore when looking for source files.
5971
# This patterns also effect to html_static_path and html_extra_path
60-
exclude_patterns = ['_build', 'Thumbs.db', '.DS_Store', '.env', 'CODE_OF_CONDUCT.md']
72+
exclude_patterns = ["_build", "Thumbs.db", ".DS_Store", ".env", "CODE_OF_CONDUCT.md"]
6173

6274
# The reST default role (used for this markup: `text`) to use for all
6375
# documents.
@@ -69,7 +81,7 @@
6981
add_function_parentheses = True
7082

7183
# The name of the Pygments (syntax highlighting) style to use.
72-
pygments_style = 'sphinx'
84+
pygments_style = "sphinx"
7385

7486
# If true, `todo` and `todoList` produce output, else they produce nothing.
7587
todo_include_todos = False
@@ -84,68 +96,76 @@
8496
# The theme to use for HTML and HTML Help pages. See the documentation for
8597
# a list of builtin themes.
8698
#
87-
on_rtd = os.environ.get('READTHEDOCS', None) == 'True'
99+
on_rtd = os.environ.get("READTHEDOCS", None) == "True"
88100

89101
if not on_rtd: # only import and set the theme if we're building docs locally
90102
try:
91103
import sphinx_rtd_theme
92-
html_theme = 'sphinx_rtd_theme'
93-
html_theme_path = [sphinx_rtd_theme.get_html_theme_path(), '.']
104+
105+
html_theme = "sphinx_rtd_theme"
106+
html_theme_path = [sphinx_rtd_theme.get_html_theme_path(), "."]
94107
except:
95-
html_theme = 'default'
96-
html_theme_path = ['.']
108+
html_theme = "default"
109+
html_theme_path = ["."]
97110
else:
98-
html_theme_path = ['.']
111+
html_theme_path = ["."]
99112

100113
# Add any paths that contain custom static files (such as style sheets) here,
101114
# relative to this directory. They are copied after the builtin static files,
102115
# so a file named "default.css" will overwrite the builtin "default.css".
103-
html_static_path = ['_static']
116+
html_static_path = ["_static"]
104117

105118
# The name of an image file (relative to this directory) to use as a favicon of
106119
# the docs. This file should be a Windows icon file (.ico) being 16x16 or 32x32
107120
# pixels large.
108121
#
109-
html_favicon = '_static/favicon.ico'
122+
html_favicon = "_static/favicon.ico"
110123

111124
# Output file base name for HTML help builder.
112-
htmlhelp_basename = 'AdafruitMpl115a2Librarydoc'
125+
htmlhelp_basename = "AdafruitMpl115a2Librarydoc"
113126

114127
# -- Options for LaTeX output ---------------------------------------------
115128

116129
latex_elements = {
117-
# The paper size ('letterpaper' or 'a4paper').
118-
#
119-
# 'papersize': 'letterpaper',
120-
121-
# The font size ('10pt', '11pt' or '12pt').
122-
#
123-
# 'pointsize': '10pt',
124-
125-
# Additional stuff for the LaTeX preamble.
126-
#
127-
# 'preamble': '',
128-
129-
# Latex figure (float) alignment
130-
#
131-
# 'figure_align': 'htbp',
130+
# The paper size ('letterpaper' or 'a4paper').
131+
#
132+
# 'papersize': 'letterpaper',
133+
# The font size ('10pt', '11pt' or '12pt').
134+
#
135+
# 'pointsize': '10pt',
136+
# Additional stuff for the LaTeX preamble.
137+
#
138+
# 'preamble': '',
139+
# Latex figure (float) alignment
140+
#
141+
# 'figure_align': 'htbp',
132142
}
133143

134144
# Grouping the document tree into LaTeX files. List of tuples
135145
# (source start file, target name, title,
136146
# author, documentclass [howto, manual, or own class]).
137147
latex_documents = [
138-
(master_doc, 'AdafruitMPL115A2Library.tex', u'AdafruitMPL115A2 Library Documentation',
139-
author, 'manual'),
148+
(
149+
master_doc,
150+
"AdafruitMPL115A2Library.tex",
151+
u"AdafruitMPL115A2 Library Documentation",
152+
author,
153+
"manual",
154+
),
140155
]
141156

142157
# -- Options for manual page output ---------------------------------------
143158

144159
# One entry per manual page. List of tuples
145160
# (source start file, name, description, authors, manual section).
146161
man_pages = [
147-
(master_doc, 'AdafruitMPL115A2library', u'Adafruit MPL115A2 Library Documentation',
148-
[author], 1)
162+
(
163+
master_doc,
164+
"AdafruitMPL115A2library",
165+
u"Adafruit MPL115A2 Library Documentation",
166+
[author],
167+
1,
168+
)
149169
]
150170

151171
# -- Options for Texinfo output -------------------------------------------
@@ -154,7 +174,13 @@
154174
# (source start file, target name, title, author,
155175
# dir menu entry, description, category)
156176
texinfo_documents = [
157-
(master_doc, 'AdafruitMPL115A2Library', u'Adafruit MPL115A2 Library Documentation',
158-
author, 'AdafruitMPL115A2Library', 'One line description of project.',
159-
'Miscellaneous'),
177+
(
178+
master_doc,
179+
"AdafruitMPL115A2Library",
180+
u"Adafruit MPL115A2 Library Documentation",
181+
author,
182+
"AdafruitMPL115A2Library",
183+
"One line description of project.",
184+
"Miscellaneous",
185+
),
160186
]

setup.py

+23-31
Original file line numberDiff line numberDiff line change
@@ -7,55 +7,47 @@
77

88
# Always prefer setuptools over distutils
99
from setuptools import setup, find_packages
10+
1011
# To use a consistent encoding
1112
from codecs import open
1213
from os import path
1314

1415
here = path.abspath(path.dirname(__file__))
1516

1617
# Get the long description from the README file
17-
with open(path.join(here, 'README.rst'), encoding='utf-8') as f:
18+
with open(path.join(here, "README.rst"), encoding="utf-8") as f:
1819
long_description = f.read()
1920

2021
setup(
21-
name='adafruit-circuitpython-mpl115a2',
22-
22+
name="adafruit-circuitpython-mpl115a2",
2323
use_scm_version=True,
24-
setup_requires=['setuptools_scm'],
25-
26-
description='CircuitPython driver for MPL115A2 I2C Barometric Pressure/Temperature Sensor.',
24+
setup_requires=["setuptools_scm"],
25+
description="CircuitPython driver for MPL115A2 I2C Barometric Pressure/Temperature Sensor.",
2726
long_description=long_description,
28-
long_description_content_type='text/x-rst',
29-
27+
long_description_content_type="text/x-rst",
3028
# The project's main homepage.
31-
url='https://github.com/adafruit/Adafruit_CircuitPython_MPL115A2',
32-
29+
url="https://github.com/adafruit/Adafruit_CircuitPython_MPL115A2",
3330
# Author details
34-
author='Adafruit Industries',
35-
author_email='[email protected]',
36-
37-
install_requires=['Adafruit-Blinka', 'adafruit-circuitpython-busdevice'],
38-
31+
author="Adafruit Industries",
32+
author_email="[email protected]",
33+
install_requires=["Adafruit-Blinka", "adafruit-circuitpython-busdevice"],
3934
# Choose your license
40-
license='MIT',
41-
35+
license="MIT",
4236
# See https://pypi.python.org/pypi?%3Aaction=list_classifiers
4337
classifiers=[
44-
'Development Status :: 3 - Alpha',
45-
'Intended Audience :: Developers',
46-
'Topic :: Software Development :: Libraries',
47-
'Topic :: System :: Hardware',
48-
'License :: OSI Approved :: MIT License',
49-
'Programming Language :: Python :: 3',
50-
'Programming Language :: Python :: 3.4',
51-
'Programming Language :: Python :: 3.5',
38+
"Development Status :: 3 - Alpha",
39+
"Intended Audience :: Developers",
40+
"Topic :: Software Development :: Libraries",
41+
"Topic :: System :: Hardware",
42+
"License :: OSI Approved :: MIT License",
43+
"Programming Language :: Python :: 3",
44+
"Programming Language :: Python :: 3.4",
45+
"Programming Language :: Python :: 3.5",
5246
],
53-
5447
# What does your project relate to?
55-
keywords='adafruit i2c barometric pressure temperature '
56-
'mpl115a2 hardware micropython circuitpython',
57-
48+
keywords="adafruit i2c barometric pressure temperature "
49+
"mpl115a2 hardware micropython circuitpython",
5850
# You can just specify the packages manually here if your project is
5951
# simple. Or you can use find_packages().
60-
py_modules=['adafruit_mpl115a2'],
61-
)
52+
py_modules=["adafruit_mpl115a2"],
53+
)

0 commit comments

Comments
 (0)