Skip to content

Ran black, updated to pylint 2.x #8

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 2 commits 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
43 changes: 26 additions & 17 deletions adafruit_binascii.py
Original file line number Diff line number Diff line change
Expand Up @@ -48,7 +48,7 @@
__version__ = "0.0.0-auto.0"
__repo__ = "https://github.com/adafruit/Adafruit_CircuitPython_binascii.git"


# fmt: off
TABLE_A2B_B64 = (
-1, -1, -1, -1, -1, -1, -1, -1, -1, -1, -1, -1, -1, -1, -1, -1,
-1, -1, -1, -1, -1, -1, -1, -1, -1, -1, -1, -1, -1, -1, -1, -1,
Expand All @@ -67,15 +67,18 @@
-1, -1, -1, -1, -1, -1, -1, -1, -1, -1, -1, -1, -1, -1, -1, -1,
-1, -1, -1, -1, -1, -1, -1, -1, -1, -1, -1, -1, -1, -1, -1, -1,
)
Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

I think in this case we should return this table to its original formatting and disable Black around this block of code.

# fmt: on

TABLE_B2A_B64 = "ABCDEFGHIJKLMNOPQRSTUVWXYZabcdefghijklmnopqrstuvwxyz0123456789+/"

TABLE_B2A_B64 = (
"ABCDEFGHIJKLMNOPQRSTUVWXYZabcdefghijklmnopqrstuvwxyz0123456789+/")

class Error(Exception):
"""Exception raised on errors. These are usually programming errors."""

# pylint: disable=unnecessary-pass
pass


if not "unhexlify" in globals():
# pylint: disable=function-redefined
def unhexlify(hexstr):
Expand Down Expand Up @@ -104,18 +107,23 @@ def hexlify(data):
if not data:
raise TypeError("Data provided is zero-length")
data = "".join("%02x" % i for i in data)
return bytes(data, 'utf-8')
return bytes(data, "utf-8")


B2A_HEX = hexlify
A2B_HEX = unhexlify


def _transform(n):
if n == -1:
return '\xff'
return "\xff"
return chr(n)
TABLE_A2B_B64 = ''.join(map(_transform, TABLE_A2B_B64))


TABLE_A2B_B64 = "".join(map(_transform, TABLE_A2B_B64))
assert len(TABLE_A2B_B64) == 256


def a2b_base64(b64_data):
"""Convert a block of base64 data back to binary and return the binary data.

Expand All @@ -132,12 +140,12 @@ def a2b_base64(b64_data):
char = chr(char)
if char == "=":
if quad_pos > 2 or (quad_pos == 2 and last_char_was_a_pad):
break # stop on 'xxx=' or on 'xx=='
break # stop on 'xxx=' or on 'xx=='
last_char_was_a_pad = True
else:
n = ord(TABLE_A2B_B64[ord(char)])
if n == 0xff:
continue # ignore strange characters
if n == 0xFF:
continue # ignore strange characters
#
# Shift it in on the low end, and see if there's
# a byte ready for output.
Expand All @@ -147,15 +155,16 @@ def a2b_base64(b64_data):
#
if leftbits >= 8:
leftbits -= 8
res.append((leftchar >> leftbits).to_bytes(1, 'big'))
leftchar &= ((1 << leftbits) - 1)
res.append((leftchar >> leftbits).to_bytes(1, "big"))
leftchar &= (1 << leftbits) - 1
#
last_char_was_a_pad = False
else:
if leftbits != 0:
raise Exception("Incorrect padding")

return b''.join(res)
return b"".join(res)


def b2a_base64(bin_data):
"""Convert binary data to a line of ASCII characters in base64 coding.
Expand All @@ -173,18 +182,18 @@ def b2a_base64(bin_data):
# Shift into our buffer, and output any 6bits ready
leftchar = (leftchar << 8) | char
leftbits += 8
res.append(TABLE_B2A_B64[(leftchar >> (leftbits-6)) & 0x3f])
res.append(TABLE_B2A_B64[(leftchar >> (leftbits - 6)) & 0x3F])
leftbits -= 6
if leftbits >= 6:
res.append(TABLE_B2A_B64[(leftchar >> (leftbits-6)) & 0x3f])
res.append(TABLE_B2A_B64[(leftchar >> (leftbits - 6)) & 0x3F])
leftbits -= 6
#
if leftbits == 2:
res.append(TABLE_B2A_B64[(leftchar & 3) << 4])
res.append("=")
res.append("=")
elif leftbits == 4:
res.append(TABLE_B2A_B64[(leftchar & 0xf) << 2])
res.append(TABLE_B2A_B64[(leftchar & 0xF) << 2])
res.append("=")
res.append('\n')
return bytes(''.join(res), 'ascii')
res.append("\n")
return bytes("".join(res), "ascii")
112 changes: 65 additions & 47 deletions docs/conf.py
Original file line number Diff line number Diff line change
Expand Up @@ -2,18 +2,19 @@

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

# TODO: Please Read!
Expand All @@ -23,29 +24,32 @@
# autodoc_mock_imports = ["digitalio", "busio"]


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 binascii Library'
copyright = u'2019 Brent Rubell '
author = u'Brent Rubell '
project = u"Adafruit binascii Library"
copyright = u"2019 Brent Rubell "
author = u"Brent Rubell "

# 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 @@ -57,7 +61,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 @@ -69,7 +73,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 @@ -84,68 +88,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 = 'AdafruitBinasciiLibrarydoc'
htmlhelp_basename = "AdafruitBinasciiLibrarydoc"

# -- 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, 'AdafruitbinasciiLibrary.tex', u'Adafruitbinascii Library Documentation',
author, 'manual'),
(
master_doc,
"AdafruitbinasciiLibrary.tex",
u"Adafruitbinascii 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, 'Adafruitbinasciilibrary', u'Adafruit binascii Library Documentation',
[author], 1)
(
master_doc,
"Adafruitbinasciilibrary",
u"Adafruit binascii Library Documentation",
[author],
1,
)
]

# -- Options for Texinfo output -------------------------------------------
Expand All @@ -154,7 +166,13 @@
# (source start file, target name, title, author,
# dir menu entry, description, category)
texinfo_documents = [
(master_doc, 'AdafruitbinasciiLibrary', u'Adafruit binascii Library Documentation',
author, 'AdafruitbinasciiLibrary', 'One line description of project.',
'Miscellaneous'),
(
master_doc,
"AdafruitbinasciiLibrary",
u"Adafruit binascii Library Documentation",
author,
"AdafruitbinasciiLibrary",
"One line description of project.",
"Miscellaneous",
),
]
Loading