Skip to content

Commit

Permalink
Applied black
Browse files Browse the repository at this point in the history
  • Loading branch information
cokelaer committed Nov 24, 2021
1 parent 137cb68 commit 9b49d8f
Show file tree
Hide file tree
Showing 3 changed files with 21 additions and 25 deletions.
14 changes: 7 additions & 7 deletions sequana_sphinxext/pipeline.py
Original file line number Diff line number Diff line change
Expand Up @@ -36,25 +36,25 @@ def get_rule_doc(name):

try:
data = urllib.request.urlopen(url).read().decode("utf8")
except HTTPError: #pragma: no cover
except HTTPError: # pragma: no cover
return f"Could not access to {url}"

try:
from sequana_pipetools import Module

m = Module(f"pipeline:{name}")
version = m.version
except ValueError: #pragma: no cover
except ValueError: # pragma: no cover
version = "Not installed locally."
except ImportError: #pragma: no cover
except ImportError: # pragma: no cover
version = "?"

docstring = "**current version**:{}\n\n{}".format(version, data)

return docstring


class snakemake_base(Body, Element): #pragma: no cover
class snakemake_base(Body, Element): # pragma: no cover
def dont_traverse(self, *args, **kwargs):
return []

Expand Down Expand Up @@ -91,17 +91,17 @@ def visit_perform(self, node):
res = core.publish_parts(node.rule_docstring, writer=w)["html_body"]
self.body.append('<div class="">' + res + "</div>")
node.children = []
except Exception as err: #pragma: no cover
except Exception as err: # pragma: no cover
print(err)
self.body.append('<div class=""> no docstring </div>')

def depart_perform(self, node):
node.children = []

def visit_ignore(self, node): #pragma: no cover
def visit_ignore(self, node): # pragma: no cover
node.children = []

def depart_ignore(self, node): #pragma: no cover
def depart_ignore(self, node): # pragma: no cover
node.children = []

app.add_node(
Expand Down
10 changes: 5 additions & 5 deletions sequana_sphinxext/snakemakerule.py
Original file line number Diff line number Diff line change
Expand Up @@ -37,7 +37,7 @@ def get_rule_doc(name):
rule = Module(name)
filename = rule.path + "/%s.rules" % name
data = open(filename, "r").read()
except ImportError: #pragma no cover
except ImportError: # pragma no cover
url = "https://raw.githubusercontent.com/sequana/sequana/master/sequana/rules/"
if name.count("/") == 0:
url = f"{url}/{name}/{name}.rules"
Expand Down Expand Up @@ -88,12 +88,12 @@ def get_rule_doc(name):
return docstring


class snakemake_base(Body, Element): #pragma: no cover
class snakemake_base(Body, Element): # pragma: no cover
def dont_traverse(self, *args, **kwargs):
return []


class snakemake_rule(snakemake_base): #pragma: no cover
class snakemake_rule(snakemake_base): # pragma: no cover
pass


Expand Down Expand Up @@ -141,10 +141,10 @@ def visit_perform(self, node):
def depart_perform(self, node):
node.children = []

def depart_ignore(self, node): #pragma: no cover
def depart_ignore(self, node): # pragma: no cover
node.children = []

def visit_ignore(self, node): #pragma: no cover
def visit_ignore(self, node): # pragma: no cover
node.children = []

app.add_node(
Expand Down
22 changes: 9 additions & 13 deletions sequana_sphinxext/wrapper.py
Original file line number Diff line number Diff line change
Expand Up @@ -41,18 +41,15 @@ def get_rule_doc(name):
data = r.content.decode()
rulename_tag = "rule %s" % name

if "404: Not Found" in data: #pragma no cover
if "404: Not Found" in data: # pragma no cover
print(f"URL not found: {url}")
return (
title
+ f"**docstring for {name} wrapper not yet available (no README.md found)**"
)
return title + f"**docstring for {name} wrapper not yet available (no README.md found)**"

def get_section(data, section):

if section in ["Example", "Configuration"]:
code = f"\n**{section}**\n::\n\n"
elif section in ['References', 'Reference']:
elif section in ["References", "Reference"]:
code = f"\n**{section}**\n\n"
else:
code = ""
Expand All @@ -79,20 +76,19 @@ def get_section(data, section):
config = get_section(data, "Configuration")
ref = get_section(data, "References")


url = f"https://github.com/sequana/sequana-wrappers/blob/main/wrappers/{name}/README.md"
rst = f"The `{name} <{url}>`_ wrapper "
rst += docstring + example_code + config + ref
rst += f"\n\n....\n\nFound a bug or have an issue ? Please report here https://github.com/sequana/sequana-wrappers/issues"
return rst


class snakemake_base(Body, Element): #pragma: no cover
class snakemake_base(Body, Element): # pragma: no cover
def dont_traverse(self, *args, **kwargs):
return []


class sequana_wrapper(snakemake_base): #pragma: no cover
class sequana_wrapper(snakemake_base): # pragma: no cover
pass


Expand All @@ -101,7 +97,7 @@ def run(content, node_class, state, content_offset):
name = content[0]
try:
node.rule_docstring = get_rule_doc(name)
except Exception: # pragma: no cover
except Exception: # pragma: no cover
node.rule_docstring = f"Could not read or interpret documentation for {name}"
state.nested_parse(content, content_offset, node)
return [node]
Expand Down Expand Up @@ -133,17 +129,17 @@ def visit_perform(self, node):
res = core.publish_parts(node.rule_docstring, writer=w)["html_body"]
self.body.append('<div class="sequana_wrapper">' + res + "</div><br>")
node.children = []
except Exception as err: #pragma: no cover
except Exception as err: # pragma: no cover
print(err)
self.body.append('<div class="sequana_wrapper"> no valid docstring </div>')

def depart_perform(self, node):
node.children = []

def depart_ignore(self, node): #pragma: no cover
def depart_ignore(self, node): # pragma: no cover
node.children = []

def visit_ignore(self, node): # pragma: no cover
def visit_ignore(self, node): # pragma: no cover
node.children = []

app.add_node(
Expand Down

0 comments on commit 9b49d8f

Please sign in to comment.