Skip to content

Commit 8af21f4

Browse files
committed
Ran black, updated to pylint 2.x
1 parent c510912 commit 8af21f4

File tree

4 files changed

+111
-87
lines changed

4 files changed

+111
-87
lines changed

.github/workflows/build.yml

Lines changed: 1 addition & 1 deletion
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_adt7410.py

Lines changed: 9 additions & 6 deletions
Original file line numberDiff line numberDiff line change
@@ -61,6 +61,7 @@
6161
_ADT7410_ID = const(0xB)
6262
_ADT7410_SWRST = const(0x2F)
6363

64+
6465
class ADT7410:
6566
"""Interface to the Analog Devices ADT7410 temperature sensor."""
6667

@@ -71,22 +72,23 @@ class ADT7410:
7172
comparator_mode = RWBit(_ADT7410_CONFIG, 4)
7273
high_resolution = RWBit(_ADT7410_CONFIG, 7)
7374

74-
7575
def __init__(self, i2c_bus, address=0x48):
7676
self.i2c_device = I2CDevice(i2c_bus, address)
7777
self._buf = bytearray(3)
7878
# Verify the manufacturer and device ids to ensure we are talking to
7979
# what we expect.
8080
_id = (self._read_register(_ADT7410_ID)[0]) & 0xF8
8181
if _id != 0xC8:
82-
raise ValueError("Unable to find ADT7410 at i2c address " + str(hex(address)))
82+
raise ValueError(
83+
"Unable to find ADT7410 at i2c address " + str(hex(address))
84+
)
8385
self.reset()
8486

8587
@property
8688
def temperature(self):
8789
"""The temperature in celsius"""
8890
temp = self._read_register(_ADT7410_TEMPMSB, 2)
89-
return struct.unpack('>h', temp)[0] / 128
91+
return struct.unpack(">h", temp)[0] / 128
9092

9193
@property
9294
def status(self):
@@ -110,9 +112,10 @@ def reset(self):
110112
def _read_register(self, addr, num=1):
111113
self._buf[0] = addr
112114
with self.i2c_device as i2c:
113-
i2c.write_then_readinto(self._buf, self._buf, out_end=1,
114-
in_start=1, in_end=num+1)
115-
return self._buf[1:num+1]
115+
i2c.write_then_readinto(
116+
self._buf, self._buf, out_end=1, in_start=1, in_end=num + 1
117+
)
118+
return self._buf[1 : num + 1]
116119

117120
def _write_register(self, addr, data=None):
118121
self._buf[0] = addr

docs/conf.py

Lines changed: 73 additions & 47 deletions
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 ADT7410 Library'
38-
copyright = u'2019 ladyada'
39-
author = u'ladyada'
49+
project = u"Adafruit ADT7410 Library"
50+
copyright = u"2019 ladyada"
51+
author = u"ladyada"
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 = 'AdafruitAdt7410Librarydoc'
125+
htmlhelp_basename = "AdafruitAdt7410Librarydoc"
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, 'AdafruitADT7410Library.tex', u'AdafruitADT7410 Library Documentation',
139-
author, 'manual'),
148+
(
149+
master_doc,
150+
"AdafruitADT7410Library.tex",
151+
u"AdafruitADT7410 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, 'AdafruitADT7410library', u'Adafruit ADT7410 Library Documentation',
148-
[author], 1)
162+
(
163+
master_doc,
164+
"AdafruitADT7410library",
165+
u"Adafruit ADT7410 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, 'AdafruitADT7410Library', u'Adafruit ADT7410 Library Documentation',
158-
author, 'AdafruitADT7410Library', 'One line description of project.',
159-
'Miscellaneous'),
177+
(
178+
master_doc,
179+
"AdafruitADT7410Library",
180+
u"Adafruit ADT7410 Library Documentation",
181+
author,
182+
"AdafruitADT7410Library",
183+
"One line description of project.",
184+
"Miscellaneous",
185+
),
160186
]

setup.py

Lines changed: 28 additions & 33 deletions
Original file line numberDiff line numberDiff line change
@@ -7,57 +7,52 @@
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-adt7410',
22-
22+
name="adafruit-circuitpython-adt7410",
2323
use_scm_version=True,
24-
setup_requires=['setuptools_scm'],
25-
26-
description='CircuitPython driver for reading temperature from the Analog Devices ADT7410 '
27-
'precision temperature sensor.',
24+
setup_requires=["setuptools_scm"],
25+
description="CircuitPython driver for reading temperature from the Analog Devices ADT7410 "
26+
"precision temperature sensor.",
2827
long_description=long_description,
29-
long_description_content_type='text/x-rst',
30-
28+
long_description_content_type="text/x-rst",
3129
# The project's main homepage.
32-
url='https://github.com/adafruit/Adafruit_CircuitPython_ADT7410',
33-
30+
url="https://github.com/adafruit/Adafruit_CircuitPython_ADT7410",
3431
# Author details
35-
author='Adafruit Industries',
36-
author_email='[email protected]',
37-
38-
install_requires=['Adafruit-Blinka', 'adafruit-circuitpython-busdevice',
39-
'adafruit-circuitpython-register'],
40-
32+
author="Adafruit Industries",
33+
author_email="[email protected]",
34+
install_requires=[
35+
"Adafruit-Blinka",
36+
"adafruit-circuitpython-busdevice",
37+
"adafruit-circuitpython-register",
38+
],
4139
# Choose your license
42-
license='MIT',
43-
40+
license="MIT",
4441
# See https://pypi.python.org/pypi?%3Aaction=list_classifiers
4542
classifiers=[
46-
'Development Status :: 3 - Alpha',
47-
'Intended Audience :: Developers',
48-
'Topic :: Software Development :: Libraries',
49-
'Topic :: System :: Hardware',
50-
'License :: OSI Approved :: MIT License',
51-
'Programming Language :: Python :: 3',
52-
'Programming Language :: Python :: 3.4',
53-
'Programming Language :: Python :: 3.5',
43+
"Development Status :: 3 - Alpha",
44+
"Intended Audience :: Developers",
45+
"Topic :: Software Development :: Libraries",
46+
"Topic :: System :: Hardware",
47+
"License :: OSI Approved :: MIT License",
48+
"Programming Language :: Python :: 3",
49+
"Programming Language :: Python :: 3.4",
50+
"Programming Language :: Python :: 3.5",
5451
],
55-
5652
# What does your project relate to?
57-
keywords='adafruit analog precision temperature sensor hardware adt7410 '
58-
'micropython circuitpython',
59-
53+
keywords="adafruit analog precision temperature sensor hardware adt7410 "
54+
"micropython circuitpython",
6055
# You can just specify the packages manually here if your project is
6156
# simple. Or you can use find_packages().
62-
py_modules=['adafruit_adt7410'],
63-
)
57+
py_modules=["adafruit_adt7410"],
58+
)

0 commit comments

Comments
 (0)