Skip to content

Black: format w/ string normalization #738

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.

Sign up for GitHub

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
Feb 26, 2022
Merged

Black: format w/ string normalization #738

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
2 commits
Select commit Hold shift + click to select a range
e505308
black: Use string normalization
tony Feb 22, 2022
2b069bf
chore: Run black + isort with string normalization (one time diff)
tony Feb 26, 2022
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
90 changes: 45 additions & 45 deletions docs/_ext/aafig.py
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -32,7 +32,7 @@

logger = logging.getLogger(__name__)

DEFAULT_FORMATS = dict(html='svg', latex='pdf', text=None)
DEFAULT_FORMATS = dict(html="svg", latex="pdf", text=None)


def merge_dict(dst, src):
Expand All @@ -42,17 +42,17 @@ def merge_dict(dst, src):
return dst


def get_basename(text, options, prefix='aafig'):
def get_basename(text, options, prefix="aafig"):
options = options.copy()
if 'format' in options:
del options['format']
if "format" in options:
del options["format"]
hashkey = text + str(options)
id = sha(hashkey.encode('utf-8')).hexdigest()
return '%s-%s' % (prefix, id)
id = sha(hashkey.encode("utf-8")).hexdigest()
return "%s-%s" % (prefix, id)


class AafigError(SphinxError):
category = 'aafig error'
category = "aafig error"


class AafigDirective(images.Image):
Expand All @@ -76,22 +76,22 @@ class AafigDirective(images.Image):

def run(self):
aafig_options = dict()
own_options_keys = [self.own_option_spec.keys()] + ['scale']
own_options_keys = [self.own_option_spec.keys()] + ["scale"]
for (k, v) in self.options.items():
if k in own_options_keys:
# convert flags to booleans
if v is None:
v = True
# convert percentage to float
if k == 'scale' or k == 'aspect':
if k == "scale" or k == "aspect":
v = float(v) / 100.0
aafig_options[k] = v
del self.options[k]
self.arguments = ['']
self.arguments = [""]
(image_node,) = images.Image.run(self)
if isinstance(image_node, nodes.system_message):
return [image_node]
text = '\n'.join(self.content)
text = "\n".join(self.content)
image_node.aafig = dict(options=aafig_options, text=text)
return [image_node]

Expand All @@ -101,45 +101,45 @@ def render_aafig_images(app, doctree):
merge_dict(format_map, DEFAULT_FORMATS)
if aafigure is None:
logger.warn(
'aafigure module not installed, ASCII art images '
'will be redered as literal text'
"aafigure module not installed, ASCII art images "
"will be redered as literal text"
)
for img in doctree.traverse(nodes.image):
if not hasattr(img, 'aafig'):
if not hasattr(img, "aafig"):
continue
if aafigure is None:
continue
options = img.aafig['options']
text = img.aafig['text']
options = img.aafig["options"]
text = img.aafig["text"]
format = app.builder.format
merge_dict(options, app.builder.config.aafig_default_options)
if format in format_map:
options['format'] = format_map[format]
options["format"] = format_map[format]
else:
logger.warn(
'unsupported builder format "%s", please '
'add a custom entry in aafig_format config '
'option for this builder' % format
"add a custom entry in aafig_format config "
"option for this builder" % format
)
img.replace_self(nodes.literal_block(text, text))
continue
if options['format'] is None:
if options["format"] is None:
img.replace_self(nodes.literal_block(text, text))
continue
try:
fname, outfn, id, extra = render_aafigure(app, text, options)
except AafigError as exc:
logger.warn('aafigure error: ' + str(exc))
logger.warn("aafigure error: " + str(exc))
img.replace_self(nodes.literal_block(text, text))
continue
img['uri'] = fname
img["uri"] = fname
# FIXME: find some way to avoid this hack in aafigure
if extra:
(width, height) = [x.split('"')[1] for x in extra.split()]
if 'width' not in img:
img['width'] = width
if 'height' not in img:
img['height'] = height
if "width" not in img:
img["width"] = width
if "height" not in img:
img["height"] = height


def render_aafigure(app, text, options):
Expand All @@ -148,36 +148,36 @@ def render_aafigure(app, text, options):
"""

if aafigure is None:
raise AafigError('aafigure module not installed')
raise AafigError("aafigure module not installed")

fname = get_basename(text, options)
fname = '%s.%s' % (get_basename(text, options), options['format'])
if app.builder.format == 'html':
fname = "%s.%s" % (get_basename(text, options), options["format"])
if app.builder.format == "html":
# HTML
imgpath = relative_uri(app.builder.env.docname, '_images')
imgpath = relative_uri(app.builder.env.docname, "_images")
relfn = posixpath.join(imgpath, fname)
outfn = path.join(app.builder.outdir, '_images', fname)
outfn = path.join(app.builder.outdir, "_images", fname)
else:
# Non-HTML
if app.builder.format != 'latex':
if app.builder.format != "latex":
logger.warn(
'aafig: the builder format %s is not officially '
'supported, aafigure images could not work. '
'Please report problems and working builder to '
'avoid this warning inthe future' % app.builder.format
"aafig: the builder format %s is not officially "
"supported, aafigure images could not work. "
"Please report problems and working builder to "
"avoid this warning inthe future" % app.builder.format
)
relfn = fname
outfn = path.join(app.builder.outdir, fname)
metadata_fname = '%s.aafig' % outfn
metadata_fname = "%s.aafig" % outfn

try:
if path.isfile(outfn):
extra = None
if options['format'].lower() == 'svg':
if options["format"].lower() == "svg":
f = None
try:
try:
f = open(metadata_fname, 'r')
f = open(metadata_fname, "r")
extra = f.read()
except Exception:
raise AafigError()
Expand All @@ -197,20 +197,20 @@ def render_aafigure(app, text, options):
raise AafigError(str(e))

extra = None
if options['format'].lower() == 'svg':
if options["format"].lower() == "svg":
extra = visitor.get_size_attrs()
f = open(metadata_fname, 'w')
f = open(metadata_fname, "w")
f.write(extra)
f.close()

return relfn, outfn, id, extra


def setup(app):
app.add_directive('aafig', AafigDirective)
app.connect('doctree-read', render_aafig_images)
app.add_config_value('aafig_format', DEFAULT_FORMATS, 'html')
app.add_config_value('aafig_default_options', dict(), 'html')
app.add_directive("aafig", AafigDirective)
app.connect("doctree-read", render_aafig_images)
app.add_config_value("aafig_format", DEFAULT_FORMATS, "html")
app.add_config_value("aafig_default_options", dict(), "html")


# vim: set expandtab shiftwidth=4 softtabstop=4 :
Loading