Skip to content

Commit 4ae6107

Browse files
committed
Ran black, updated to pylint 2.x
1 parent 5e170a1 commit 4ae6107

File tree

4 files changed

+117
-91
lines changed

4 files changed

+117
-91
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_tca9548a.py

Lines changed: 22 additions & 14 deletions
Original file line numberDiff line numberDiff line change
@@ -49,7 +49,8 @@
4949
__version__ = "0.0.0-auto.0"
5050
__repo__ = "https://github.com/adafruit/Adafruit_CircuitPython_TCA9548A.git"
5151

52-
class TCA9548A_Channel():
52+
53+
class TCA9548A_Channel:
5354
"""Helper class to represent an output channel on the TCA9548A and take care
5455
of the necessary I2C commands for channel switching. This class needs to
5556
behave like an I2CDevice."""
@@ -67,7 +68,7 @@ def try_lock(self):
6768

6869
def unlock(self):
6970
"""Pass thru for unlock."""
70-
self.tca.i2c.writeto(self.tca.address, b'\x00')
71+
self.tca.i2c.writeto(self.tca.address, b"\x00")
7172
return self.tca.i2c.unlock()
7273

7374
def readfrom_into(self, address, buffer, **kwargs):
@@ -84,28 +85,35 @@ def writeto(self, address, buffer, **kwargs):
8485

8586
def writeto_then_readfrom(self, address, buffer_out, buffer_in, **kwargs):
8687
"""Pass thru for writeto_then_readfrom."""
87-
#In linux, at least, this is a special kernel function call
88+
# In linux, at least, this is a special kernel function call
8889
if address == self.tca.address:
8990
raise ValueError("Device address must be different than TCA9548A address.")
9091

91-
if hasattr(self.tca.i2c, 'writeto_then_readfrom'):
92+
if hasattr(self.tca.i2c, "writeto_then_readfrom"):
9293
self.tca.i2c.writeto_then_readfrom(address, buffer_out, buffer_in, **kwargs)
9394
else:
94-
self.tca.i2c.writeto(address, buffer_out,
95-
start=kwargs.get("out_start", 0),
96-
end=kwargs.get("out_end", None),
97-
stop=False)
98-
self.tca.i2c.readfrom_into(address, buffer_in,
99-
start=kwargs.get("in_start", 0),
100-
end=kwargs.get("in_end", None))
101-
102-
class TCA9548A():
95+
self.tca.i2c.writeto(
96+
address,
97+
buffer_out,
98+
start=kwargs.get("out_start", 0),
99+
end=kwargs.get("out_end", None),
100+
stop=False,
101+
)
102+
self.tca.i2c.readfrom_into(
103+
address,
104+
buffer_in,
105+
start=kwargs.get("in_start", 0),
106+
end=kwargs.get("in_end", None),
107+
)
108+
109+
110+
class TCA9548A:
103111
"""Class which provides interface to TCA9548A I2C multiplexer."""
104112

105113
def __init__(self, i2c, address=_DEFAULT_ADDRESS):
106114
self.i2c = i2c
107115
self.address = address
108-
self.channels = [None]*8
116+
self.channels = [None] * 8
109117

110118
def __len__(self):
111119
return 8

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 = ["micropython"]
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 TCA9548A Library'
38-
copyright = u'2018 Carter Nelson'
39-
author = u'Carter Nelson'
49+
project = u"Adafruit TCA9548A 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 = 'AdafruitTca9548aLibrarydoc'
125+
htmlhelp_basename = "AdafruitTca9548aLibrarydoc"
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, 'AdafruitTCA9548ALibrary.tex', u'AdafruitTCA9548A Library Documentation',
139-
author, 'manual'),
148+
(
149+
master_doc,
150+
"AdafruitTCA9548ALibrary.tex",
151+
u"AdafruitTCA9548A 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, 'AdafruitTCA9548Alibrary', u'Adafruit TCA9548A Library Documentation',
148-
[author], 1)
162+
(
163+
master_doc,
164+
"AdafruitTCA9548Alibrary",
165+
u"Adafruit TCA9548A 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, 'AdafruitTCA9548ALibrary', u'Adafruit TCA9548A Library Documentation',
158-
author, 'AdafruitTCA9548ALibrary', 'One line description of project.',
159-
'Miscellaneous'),
177+
(
178+
master_doc,
179+
"AdafruitTCA9548ALibrary",
180+
u"Adafruit TCA9548A Library Documentation",
181+
author,
182+
"AdafruitTCA9548ALibrary",
183+
"One line description of project.",
184+
"Miscellaneous",
185+
),
160186
]

setup.py

Lines changed: 21 additions & 29 deletions
Original file line numberDiff line numberDiff line change
@@ -7,54 +7,46 @@
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-tca9548a',
22-
22+
name="adafruit-circuitpython-tca9548a",
2323
use_scm_version=True,
24-
setup_requires=['setuptools_scm'],
25-
26-
description='CircuitPython driver for the TCA9548A I2C Multiplexer.',
24+
setup_requires=["setuptools_scm"],
25+
description="CircuitPython driver for the TCA9548A I2C Multiplexer.",
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_TCA9548A',
32-
29+
url="https://github.com/adafruit/Adafruit_CircuitPython_TCA9548A",
3330
# Author details
34-
author='Adafruit Industries',
35-
author_email='circuitpython@adafruit.com',
36-
37-
install_requires=['Adafruit-Blinka'],
38-
31+
author="Adafruit Industries",
32+
author_email="circuitpython@adafruit.com",
33+
install_requires=["Adafruit-Blinka"],
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 tca9548a i2c multiplexer hardware micropython circuitpython',
56-
48+
keywords="adafruit tca9548a i2c multiplexer hardware micropython circuitpython",
5749
# You can just specify the packages manually here if your project is
5850
# simple. Or you can use find_packages().
59-
py_modules=['adafruit_tca9548a'],
51+
py_modules=["adafruit_tca9548a"],
6052
)

0 commit comments

Comments
 (0)