Skip to content

Ran black, updated to pylint 2.x #13

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 17, 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
18 changes: 8 additions & 10 deletions adafruit_am2320.py
Original file line number Diff line number Diff line change
Expand Up @@ -65,7 +65,7 @@


def _crc16(data):
crc = 0xffff
crc = 0xFFFF
for byte in data:
crc ^= byte
for _ in range(8):
Expand All @@ -79,20 +79,17 @@ def _crc16(data):

class AM2320Exception(Exception):
"""Base class for exceptions."""
pass


class AM2320DeviceNotFound(AM2320Exception, ValueError):
"""Indicates that a device couldn't be found."""
pass


class AM2320ReadError(AM2320Exception, RuntimeError):
"""indicates that valid data could not be read from the sensor.

This may be due to a regular I2C read failure, or due to a checksum
mismatch."""
pass


class AM2320:
Expand All @@ -102,6 +99,7 @@ class AM2320:
:param int address: (optional) The I2C address of the device.

"""

def __init__(self, i2c_bus, address=AM2320_DEFAULT_ADDR):
for _ in range(3):
# retry since we have to wake up the devices
Expand All @@ -111,7 +109,7 @@ def __init__(self, i2c_bus, address=AM2320_DEFAULT_ADDR):
except ValueError:
pass
time.sleep(0.25)
raise AM2320DeviceNotFound('AM2320 not found')
raise AM2320DeviceNotFound("AM2320 not found")

def _read_register(self, register, length):
with self._i2c as i2c:
Expand All @@ -127,17 +125,17 @@ def _read_register(self, register, length):
# print("cmd: %s" % [hex(i) for i in cmd])
i2c.write(bytes(cmd))
time.sleep(0.002) # wait 2 ms for reply
result = bytearray(length+4) # 2 bytes pre, 2 bytes crc
result = bytearray(length + 4) # 2 bytes pre, 2 bytes crc
i2c.readinto(result)
# print("$%02X => %s" % (register, [hex(i) for i in result]))
# Check preamble indicates correct readings
if result[0] != 0x3 or result[1] != length:
raise AM2320ReadError('I2C read failure')
raise AM2320ReadError("I2C read failure")
# Check CRC on all but last 2 bytes
crc1 = struct.unpack("<H", bytes(result[-2:]))[0]
crc2 = _crc16(result[0:-2])
if crc1 != crc2:
raise AM2320ReadError('CRC failure 0x%04X vs 0x%04X' % (crc1, crc2))
raise AM2320ReadError("CRC failure 0x%04X vs 0x%04X" % (crc1, crc2))
return result[2:-2]

@property
Expand All @@ -146,10 +144,10 @@ def temperature(self):
temperature = struct.unpack(">H", self._read_register(AM2320_REG_TEMP_H, 2))[0]
if temperature >= 32768:
temperature = 32768 - temperature
return temperature/10.0
return temperature / 10.0

@property
def relative_humidity(self):
"""The measured relative humidity in percent."""
humidity = struct.unpack(">H", self._read_register(AM2320_REG_HUM_H, 2))[0]
return humidity/10.0
return humidity / 10.0
112 changes: 65 additions & 47 deletions docs/conf.py
Original file line number Diff line number Diff line change
Expand Up @@ -2,43 +2,47 @@

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",
]

intersphinx_mapping = {'python': ('https://docs.python.org/3.4', None),'CircuitPython': ('https://circuitpython.readthedocs.io/en/latest/', None)}
intersphinx_mapping = {
"python": ("https://docs.python.org/3.4", 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 am2320 Library'
copyright = u'2017 Limor Fried'
author = u'Limor Fried'
project = u"Adafruit am2320 Library"
copyright = u"2017 Limor Fried"
author = u"Limor Fried"

# 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 @@ -50,7 +54,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 @@ -62,7 +66,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 @@ -77,68 +81,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 = 'AdafruitAm2320Librarydoc'
htmlhelp_basename = "AdafruitAm2320Librarydoc"

# -- 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, 'Adafruitam2320Library.tex', u'Adafruitam2320 Library Documentation',
author, 'manual'),
(
master_doc,
"Adafruitam2320Library.tex",
u"Adafruitam2320 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, 'Adafruitam2320library', u'Adafruit am2320 Library Documentation',
[author], 1)
(
master_doc,
"Adafruitam2320library",
u"Adafruit am2320 Library Documentation",
[author],
1,
)
]

# -- Options for Texinfo output -------------------------------------------
Expand All @@ -147,7 +159,13 @@
# (source start file, target name, title, author,
# dir menu entry, description, category)
texinfo_documents = [
(master_doc, 'Adafruitam2320Library', u'Adafruit am2320 Library Documentation',
author, 'Adafruitam2320Library', 'One line description of project.',
'Miscellaneous'),
(
master_doc,
"Adafruitam2320Library",
u"Adafruit am2320 Library Documentation",
author,
"Adafruitam2320Library",
"One line description of project.",
"Miscellaneous",
),
]
50 changes: 21 additions & 29 deletions setup.py
Original file line number Diff line number Diff line change
Expand Up @@ -7,54 +7,46 @@

# Always prefer setuptools over distutils
from setuptools import setup, find_packages

# To use a consistent encoding
from codecs import open
from os import path

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

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

setup(
name='adafruit-circuitpython-am2320',

name="adafruit-circuitpython-am2320",
use_scm_version=True,
setup_requires=['setuptools_scm'],

description='CircuitPython driver for the AM2320 temperature and humidity sensor.',
setup_requires=["setuptools_scm"],
description="CircuitPython driver for the AM2320 temperature and humidity sensor.",
long_description=long_description,
long_description_content_type='text/x-rst',

long_description_content_type="text/x-rst",
# The project's main homepage.
url='https://github.com/adafruit/Adafruit_CircuitPython_AM2320',

url="https://github.com/adafruit/Adafruit_CircuitPython_AM2320",
# Author details
author='Adafruit Industries',
author_email='[email protected]',

install_requires=['Adafruit-Blinka', 'adafruit-circuitpython-busdevice'],

author="Adafruit Industries",
author_email="[email protected]",
install_requires=["Adafruit-Blinka", "adafruit-circuitpython-busdevice"],
# Choose your license
license='MIT',

license="MIT",
# See https://pypi.python.org/pypi?%3Aaction=list_classifiers
classifiers=[
'Development Status :: 3 - Alpha',
'Intended Audience :: Developers',
'Topic :: Software Development :: Libraries',
'Topic :: System :: Hardware',
'License :: OSI Approved :: MIT License',
'Programming Language :: Python :: 3',
'Programming Language :: Python :: 3.4',
'Programming Language :: Python :: 3.5',
"Development Status :: 3 - Alpha",
"Intended Audience :: Developers",
"Topic :: Software Development :: Libraries",
"Topic :: System :: Hardware",
"License :: OSI Approved :: MIT License",
"Programming Language :: Python :: 3",
"Programming Language :: Python :: 3.4",
"Programming Language :: Python :: 3.5",
],

# What does your project relate to?
keywords='adafruit am2320 temperature humidity hardware micropython circuitpython',

keywords="adafruit am2320 temperature humidity hardware micropython circuitpython",
# You can just specify the packages manually here if your project is
# simple. Or you can use find_packages().
py_modules=['adafruit_am2320'],
py_modules=["adafruit_am2320"],
)