Skip to content

Commit ec3b9ad

Browse files
authored
Merge pull request #3 from adafruit/pylint-update
Ran black, updated to pylint 2.x
2 parents 6b4be15 + c3cdcaf commit ec3b9ad

File tree

6 files changed

+111
-94
lines changed

6 files changed

+111
-94
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_ds3502.py

+7-7
Original file line numberDiff line numberDiff line change
@@ -52,15 +52,16 @@
5252
__repo__ = "https://github.com/adafruit/Adafruit_CircuitPython_DS3502.git"
5353

5454

55-
5655
from time import sleep
5756
from micropython import const
5857
from adafruit_register.i2c_struct import UnaryStruct
5958
from adafruit_register.i2c_bit import RWBit
6059
import adafruit_bus_device.i2c_device as i2cdevice
60+
6161
# pylint: disable=bad-whitespace
62-
_REG_WIPER = const(0x00) # Wiper value register (R/W)
63-
_REG_CONTROL = const(0x02) # Configuration Register (R/W)
62+
_REG_WIPER = const(0x00) # Wiper value register (R/W)
63+
_REG_CONTROL = const(0x02) # Configuration Register (R/W)
64+
6465

6566
class DS3502:
6667
"""Driver for the DS3502 I2C Digital Potentiometer.
@@ -72,12 +73,11 @@ class DS3502:
7273
def __init__(self, i2c_bus, address=0x28):
7374
self.i2c_device = i2cdevice.I2CDevice(i2c_bus, address)
7475

75-
7676
# set to mode 1 on init to not write to the IVR every time you set
7777
self._write_only_to_wiper = True
7878

7979
_wiper = UnaryStruct(_REG_WIPER, ">B")
80-
_write_only_to_wiper = RWBit(_REG_CONTROL, 7)
80+
_write_only_to_wiper = RWBit(_REG_CONTROL, 7)
8181

8282
@property
8383
def wiper(self):
@@ -89,7 +89,7 @@ def wiper(self):
8989

9090
@wiper.setter
9191
def wiper(self, value):
92-
if value < 0 or value >127:
92+
if value < 0 or value > 127:
9393
raise ValueError("wiper must be from 0-127")
9494
self._wiper = value
9595

@@ -100,5 +100,5 @@ def set_default(self, default):
100100
"""
101101
self._write_only_to_wiper = False
102102
self.wiper = default
103-
sleep(0.1) # wait for write to eeprom to finish
103+
sleep(0.1) # wait for write to eeprom to finish
104104
self._write_only_to_wiper = True

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 = ["micropython", "adafruit_register", "adafruit_bus_device"]
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 DS3502 Library'
38-
copyright = u'2019 Bryan Siepert'
39-
author = u'Bryan Siepert'
49+
project = u"Adafruit DS3502 Library"
50+
copyright = u"2019 Bryan Siepert"
51+
author = u"Bryan Siepert"
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 = 'AdafruitDs3502Librarydoc'
125+
htmlhelp_basename = "AdafruitDs3502Librarydoc"
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, 'AdafruitDS3502Library.tex', u'AdafruitDS3502 Library Documentation',
139-
author, 'manual'),
148+
(
149+
master_doc,
150+
"AdafruitDS3502Library.tex",
151+
u"AdafruitDS3502 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, 'AdafruitDS3502library', u'Adafruit DS3502 Library Documentation',
148-
[author], 1)
162+
(
163+
master_doc,
164+
"AdafruitDS3502library",
165+
u"Adafruit DS3502 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, 'AdafruitDS3502Library', u'Adafruit DS3502 Library Documentation',
158-
author, 'AdafruitDS3502Library', 'One line description of project.',
159-
'Miscellaneous'),
177+
(
178+
master_doc,
179+
"AdafruitDS3502Library",
180+
u"Adafruit DS3502 Library Documentation",
181+
author,
182+
"AdafruitDS3502Library",
183+
"One line description of project.",
184+
"Miscellaneous",
185+
),
160186
]

examples/ds3502_set_default.py

+1-2
Original file line numberDiff line numberDiff line change
@@ -1,4 +1,3 @@
1-
21
import board
32
import adafruit_ds3502
43

@@ -19,4 +18,4 @@
1918
# ds3502.set_default(99)
2019

2120

22-
print("Default wiper value: %d"%ds3502.wiper)
21+
print("Default wiper value: %d" % ds3502.wiper)

examples/ds3502_simpletest.py

+6-6
Original file line numberDiff line numberDiff line change
@@ -14,28 +14,28 @@
1414
while True:
1515

1616
ds3502.wiper = 127
17-
print("Wiper set to %d"%ds3502.wiper)
17+
print("Wiper set to %d" % ds3502.wiper)
1818
voltage = wiper_output.value
1919
voltage *= 3.3
2020
voltage /= 65535
21-
print("Wiper voltage: %.2f V"%voltage)
21+
print("Wiper voltage: %.2f V" % voltage)
2222
print("")
2323
sleep(1.0)
2424

2525
ds3502.wiper = 0
26-
print("Wiper set to %d"%ds3502.wiper)
26+
print("Wiper set to %d" % ds3502.wiper)
2727
voltage = wiper_output.value
2828
voltage *= 3.3
2929
voltage /= 65535
30-
print("Wiper voltage: %.2f V"%voltage)
30+
print("Wiper voltage: %.2f V" % voltage)
3131
print("")
3232
sleep(1.0)
3333

3434
ds3502.wiper = 63
35-
print("Wiper set to %d"%ds3502.wiper)
35+
print("Wiper set to %d" % ds3502.wiper)
3636
voltage = wiper_output.value
3737
voltage *= 3.3
3838
voltage /= 65535
39-
print("Wiper voltage: %.2f V"%voltage)
39+
print("Wiper voltage: %.2f V" % voltage)
4040
print("")
4141
sleep(1.0)

0 commit comments

Comments
 (0)