Ran black, updated to pylint 2.x

This commit is contained in:
dherrada 2020-03-15 16:17:54 -04:00
parent ffbfb560f9
commit 0e13195ac9
11 changed files with 140 additions and 116 deletions

View file

@ -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

View file

@ -40,6 +40,7 @@ Implementation Notes
"""
import gc
try:
from displayio import Glyph
except ImportError:
@ -49,8 +50,10 @@ from .glyph_cache import GlyphCache
__version__ = "0.0.0-auto.0"
__repo__ = "https://github.com/adafruit/Adafruit_CircuitPython_Bitmap_Font.git"
class BDF(GlyphCache):
"""Loads glyphs from a BDF file in the given bitmap_class."""
def __init__(self, f, bitmap_class):
super().__init__()
self.file = f
@ -119,7 +122,7 @@ class BDF(GlyphCache):
pass
elif line.startswith(b"STARTCHAR"):
# print(lineno, line.strip())
#_, character_name = line.split()
# _, character_name = line.split()
character = True
elif line.startswith(b"ENDCHAR"):
character = False
@ -127,14 +130,16 @@ class BDF(GlyphCache):
bounds = current_info["bounds"]
shift = current_info["shift"]
gc.collect()
self._glyphs[code_point] = Glyph(current_info["bitmap"],
0,
bounds[0],
bounds[1],
bounds[2],
bounds[3],
shift[0],
shift[1])
self._glyphs[code_point] = Glyph(
current_info["bitmap"],
0,
bounds[0],
bounds[1],
bounds[2],
bounds[3],
shift[0],
shift[1],
)
remaining.remove(code_point)
if not remaining:
return
@ -178,7 +183,7 @@ class BDF(GlyphCache):
start = current_y * width
x = 0
for i in range(rounded_x):
val = (bits >> ((rounded_x-i-1)*8)) & 0xFF
val = (bits >> ((rounded_x - i - 1) * 8)) & 0xFF
for j in range(7, -1, -1):
if x >= width:
break
@ -189,5 +194,5 @@ class BDF(GlyphCache):
x += 1
current_y += 1
elif metadata:
#print(lineno, line.strip())
# print(lineno, line.strip())
pass

View file

@ -45,19 +45,23 @@ __repo__ = "https://github.com/adafruit/Adafruit_CircuitPython_Bitmap_Font.git"
def load_font(filename, bitmap=None):
"""Loads a font file. Returns None if unsupported."""
# pylint: disable=import-outside-toplevel
if not bitmap:
import displayio
bitmap = displayio.Bitmap
font_file = open(filename, "rb")
first_four = font_file.read(4)
#print(first_four)
if filename.endswith("bdf") and first_four == b"STAR":
from . import bdf
return bdf.BDF(font_file, bitmap)
if filename.endswith("pcf") and first_four == b"\x01fcp":
import pcf
return pcf.PCF(font_file)
if filename.endswith("ttf") and first_four == b"\x00\x01\x00\x00":
import ttf
return ttf.TTF(font_file)
return None

View file

@ -47,12 +47,12 @@ __repo__ = "https://github.com/adafruit/Adafruit_CircuitPython_Bitmap_Font.git"
class GlyphCache:
"""Caches glyphs loaded by a subclass."""
def __init__(self):
self._glyphs = {}
def load_glyphs(self, code_points):
"""Loads displayio.Glyph objects into the GlyphCache from the font."""
pass
def get_glyph(self, code_point):
"""Returns a displayio.Glyph for the given code point or None is unsupported."""

View file

@ -5,28 +5,29 @@ from .glyph_cache import GlyphCache
import displayio
import struct
_PCF_PROPERTIES = (1<<0)
_PCF_ACCELERATORS = (1<<1)
_PCF_METRICS = (1<<2)
_PCF_BITMAPS = (1<<3)
_PCF_INK_METRICS = (1<<4)
_PCF_BDF_ENCODINGS = (1<<5)
_PCF_SWIDTHS = (1<<6)
_PCF_GLYPH_NAMES = (1<<7)
_PCF_BDF_ACCELERATORS = (1<<8)
_PCF_PROPERTIES = 1 << 0
_PCF_ACCELERATORS = 1 << 1
_PCF_METRICS = 1 << 2
_PCF_BITMAPS = 1 << 3
_PCF_INK_METRICS = 1 << 4
_PCF_BDF_ENCODINGS = 1 << 5
_PCF_SWIDTHS = 1 << 6
_PCF_GLYPH_NAMES = 1 << 7
_PCF_BDF_ACCELERATORS = 1 << 8
_PCF_DEFAULT_FORMAT = 0x00000000
_PCF_INKBOUNDS = 0x00000200
_PCF_ACCEL_W_INKBOUNDS = 0x00000100
_PCF_COMPRESSED_METRICS = 0x00000100
_PCF_GLYPH_PAD_MASK = (3<<0) # See the bitmap table for explanation */
_PCF_BYTE_MASK = (1<<2) # If set then Most Sig Byte First */
_PCF_BIT_MASK = (1<<3) # If set then Most Sig Bit First */
_PCF_SCAN_UNIT_MASK = (3<<4)
_PCF_GLYPH_PAD_MASK = 3 << 0 # See the bitmap table for explanation */
_PCF_BYTE_MASK = 1 << 2 # If set then Most Sig Byte First */
_PCF_BIT_MASK = 1 << 3 # If set then Most Sig Bit First */
_PCF_SCAN_UNIT_MASK = 3 << 4
# https://fontforge.github.io/en-US/documentation/reference/pcf-format/
class PCF(GlyphCache):
def __init__(self, f):
super().__init__()
@ -47,17 +48,17 @@ class PCF(GlyphCache):
def get_bounding_box(self):
property_table_offset = self.tables[_PCF_PROPERTIES]["offset"]
self.file.seek(property_table_offset)
format, = self.read("<I")
(format,) = self.read("<I")
if format & _PCF_BYTE_MASK == 0:
raise RuntimeError("Only big endian supported")
nprops, = self.read(">I")
(nprops,) = self.read(">I")
self.file.seek(property_table_offset + 8 + 9 * nprops)
pos = self.file.tell()
if pos % 4 > 0:
self.file.read(4 - pos % 4)
string_size, = self.read(">I")
(string_size,) = self.read(">I")
strings = self.file.read(string_size)
string_map = {}
@ -89,7 +90,7 @@ class PCF(GlyphCache):
x, _, _, _ = self.get_bounding_box()
# create a scratch bytearray to load pixels into
scratch_row = memoryview(bytearray((((x-1)//32)+1) * 4))
scratch_row = memoryview(bytearray((((x - 1) // 32) + 1) * 4))
self.file.seek(0)
while True:
@ -104,7 +105,7 @@ class PCF(GlyphCache):
pass
elif line.startswith(b"STARTCHAR"):
# print(lineno, line.strip())
#_, character_name = line.split()
# _, character_name = line.split()
character = True
elif line.startswith(b"ENDCHAR"):
character = False
@ -151,10 +152,12 @@ class PCF(GlyphCache):
if desired_character:
bits = int(line.strip(), 16)
for i in range(rounded_x):
val = (bits >> ((rounded_x-i-1)*8)) & 0xFF
val = (bits >> ((rounded_x - i - 1) * 8)) & 0xFF
scratch_row[i] = val
current_info["bitmap"]._load_row(current_y, scratch_row[:bytes_per_row])
current_info["bitmap"]._load_row(
current_y, scratch_row[:bytes_per_row]
)
current_y += 1
elif metadata:
#print(lineno, line.strip())
# print(lineno, line.strip())
pass

View file

@ -6,6 +6,7 @@ import struct
# https://developer.apple.com/fonts/TrueType-Reference-Manual/RM06/Chap6glyf.html
class TTF:
def __init__(self, f):
f.seek(0)
@ -41,7 +42,7 @@ class TTF:
while f.tell() < glyf_offset + glyf_length:
numberOfContours, xMin, yMin, xMax, yMax = read(">hhhhh")
if numberOfContours > 0: # Simple
if numberOfContours > 0: # Simple
print(numberOfContours)
ends = []
for _ in range(numberOfContours):

View file

@ -2,7 +2,8 @@
import os
import sys
sys.path.insert(0, os.path.abspath('..'))
sys.path.insert(0, os.path.abspath(".."))
# -- General configuration ------------------------------------------------
@ -10,10 +11,10 @@ sys.path.insert(0, os.path.abspath('..'))
# 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!
@ -23,29 +24,32 @@ extensions = [
autodoc_mock_imports = ["displayio"]
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 Bitmap_Font Library'
copyright = u'2019 Scott Shawcroft'
author = u'Scott Shawcroft'
project = u"Adafruit Bitmap_Font Library"
copyright = u"2019 Scott Shawcroft"
author = u"Scott Shawcroft"
# 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.
@ -57,7 +61,7 @@ language = None
# 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.
@ -69,7 +73,7 @@ default_role = "any"
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
@ -84,59 +88,62 @@ napoleon_numpy_docstring = False
# 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 = 'AdafruitBitmap_fontLibrarydoc'
htmlhelp_basename = "AdafruitBitmap_fontLibrarydoc"
# -- 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, 'AdafruitBitmap_FontLibrary.tex', u'AdafruitBitmap_Font Library Documentation',
author, 'manual'),
(
master_doc,
"AdafruitBitmap_FontLibrary.tex",
u"AdafruitBitmap_Font Library Documentation",
author,
"manual",
),
]
# -- Options for manual page output ---------------------------------------
@ -144,8 +151,13 @@ latex_documents = [
# One entry per manual page. List of tuples
# (source start file, name, description, authors, manual section).
man_pages = [
(master_doc, 'AdafruitBitmap_Fontlibrary', u'Adafruit Bitmap_Font Library Documentation',
[author], 1)
(
master_doc,
"AdafruitBitmap_Fontlibrary",
u"Adafruit Bitmap_Font Library Documentation",
[author],
1,
)
]
# -- Options for Texinfo output -------------------------------------------
@ -154,7 +166,13 @@ man_pages = [
# (source start file, target name, title, author,
# dir menu entry, description, category)
texinfo_documents = [
(master_doc, 'AdafruitBitmap_FontLibrary', u'Adafruit Bitmap_Font Library Documentation',
author, 'AdafruitBitmap_FontLibrary', 'One line description of project.',
'Miscellaneous'),
(
master_doc,
"AdafruitBitmap_FontLibrary",
u"Adafruit Bitmap_Font Library Documentation",
author,
"AdafruitBitmap_FontLibrary",
"One line description of project.",
"Miscellaneous",
),
]

View file

@ -6,6 +6,7 @@ import sys
# Add paths so this runs in CPython in-place.
sys.path.append(os.path.join(sys.path[0], ".."))
from adafruit_bitmap_font import bitmap_font # pylint: disable=wrong-import-position
sys.path.append(os.path.join(sys.path[0], "../test"))
font = bitmap_font.load_font(sys.argv[1])

View file

@ -6,6 +6,7 @@ https://github.com/pypa/sampleproject
"""
from setuptools import setup, find_packages
# To use a consistent encoding
from codecs import open
from os import path
@ -13,51 +14,40 @@ 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-bitmap_font',
name="adafruit-circuitpython-bitmap_font",
use_scm_version=True,
setup_requires=['setuptools_scm'],
description='Loads bitmap fonts into CircuitPython displayio.',
setup_requires=["setuptools_scm"],
description="Loads bitmap fonts into CircuitPython displayio.",
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_Bitmap_Font',
url="https://github.com/adafruit/Adafruit_CircuitPython_Bitmap_Font",
# Author details
author='Adafruit Industries',
author_email='circuitpython@adafruit.com',
install_requires=[
'Adafruit-Blinka'
],
author="Adafruit Industries",
author_email="circuitpython@adafruit.com",
install_requires=["Adafruit-Blinka"],
# 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 blinka circuitpython micropython font text displayio bitmap',
keywords="adafruit blinka circuitpython micropython font text displayio bitmap",
# You can just specify the packages manually here if your project is
# simple. Or you can use find_packages().
# TODO: IF LIBRARY FILES ARE A PACKAGE FOLDER,
# CHANGE `py_modules=['...']` TO `packages=['...']`
py_modules=['adafruit_bitmap_font'],
py_modules=["adafruit_bitmap_font"],
)

View file

@ -1,4 +1,3 @@
class Bitmap:
def __init__(self, width, height, color_count):
self.width = width

View file

@ -1,3 +1,6 @@
import collections
Glyph = collections.namedtuple("Glyph", ["bitmap", "tile_index", "width", "height", "dx", "dy", "shift_x", "shift_y"])
Glyph = collections.namedtuple(
"Glyph",
["bitmap", "tile_index", "width", "height", "dx", "dy", "shift_x", "shift_y"],
)