Run through black and isort
This commit is contained in:
parent
0af66c6964
commit
fdb126996a
8 changed files with 297 additions and 252 deletions
|
|
@ -1 +1 @@
|
|||
__import__('pkg_resources').declare_namespace(__name__)
|
||||
__import__("pkg_resources").declare_namespace(__name__)
|
||||
|
|
|
|||
|
|
@ -11,11 +11,9 @@
|
|||
|
||||
import re
|
||||
|
||||
from ipcalc import Network
|
||||
|
||||
from docutils import nodes
|
||||
from docutils.parsers.rst import Directive
|
||||
|
||||
from ipcalc import Network
|
||||
from sphinx import addnodes
|
||||
from sphinx.domains import Domain, ObjType
|
||||
from sphinx.errors import NoUri
|
||||
|
|
@ -24,15 +22,15 @@ from sphinx.roles import XRefRole
|
|||
from sphinx.util import logging
|
||||
from sphinx.util.nodes import make_refnode
|
||||
|
||||
__version__ = '0.3.0'
|
||||
__version__ = "0.4.0"
|
||||
|
||||
|
||||
logger = logging.getLogger(__name__)
|
||||
|
||||
|
||||
def ip_object_anchor(typ, path):
|
||||
path = re.sub(r'[.:/]', '-', path)
|
||||
return typ.lower() + '-' + path
|
||||
path = re.sub(r"[.:/]", "-", path)
|
||||
return typ.lower() + "-" + path
|
||||
|
||||
|
||||
class ip_node(nodes.Inline, nodes.TextElement):
|
||||
|
|
@ -47,17 +45,16 @@ class IPXRefRole(XRefRole):
|
|||
"""
|
||||
Cross referencing role for the IP domain.
|
||||
"""
|
||||
|
||||
def __init__(self, method, index_type, **kwargs):
|
||||
self.method = method
|
||||
self.index_type = index_type
|
||||
innernodeclass = None
|
||||
if method in ('v4', 'v6'):
|
||||
if method in ("v4", "v6"):
|
||||
innernodeclass = ip_node
|
||||
super(IPXRefRole, self).__init__(
|
||||
innernodeclass=innernodeclass, **kwargs)
|
||||
super(IPXRefRole, self).__init__(innernodeclass=innernodeclass, **kwargs)
|
||||
|
||||
def __cal__(self, typ, rawtext, text, lineno, inliner,
|
||||
options=None, content=None):
|
||||
def __cal__(self, typ, rawtext, text, lineno, inliner, options=None, content=None):
|
||||
if content is None:
|
||||
content = []
|
||||
if options is None:
|
||||
|
|
@ -66,28 +63,31 @@ class IPXRefRole(XRefRole):
|
|||
Network(text)
|
||||
except ValueError as e:
|
||||
env = inliner.document.settings.env
|
||||
logger.warning("invalid ip address/range %s" % text, location=(env.docname, lineno))
|
||||
logger.warning(
|
||||
"invalid ip address/range %s" % text, location=(env.docname, lineno)
|
||||
)
|
||||
return [nodes.literal(text, text), []]
|
||||
return super(IPXRefRole, self).__call__(
|
||||
typ, rawtext, text, lineno, inliner, options, content)
|
||||
typ, rawtext, text, lineno, inliner, options, content
|
||||
)
|
||||
|
||||
def process_link(self, env, refnode, has_explicit_title, title, target):
|
||||
domaindata = env.domaindata['ip']
|
||||
domaindata = env.domaindata["ip"]
|
||||
domaindata[self.method][target] = (target, refnode)
|
||||
return title, target
|
||||
|
||||
def result_nodes(self, document, env, node, is_ref):
|
||||
try:
|
||||
node['typ'] = self.method
|
||||
node["typ"] = self.method
|
||||
indexnode = addnodes.index()
|
||||
targetid = 'index-%s' % env.new_serialno('index')
|
||||
targetnode = nodes.target('', '', ids=[targetid])
|
||||
targetid = "index-%s" % env.new_serialno("index")
|
||||
targetnode = nodes.target("", "", ids=[targetid])
|
||||
doctitle = list(document.traverse(nodes.title))[0].astext()
|
||||
idxtext = "%s; %s" % (node.astext(), doctitle)
|
||||
idxtext2 = "%s; %s" % (self.index_type, node.astext())
|
||||
indexnode['entries'] = [
|
||||
('single', idxtext, targetid, '', None),
|
||||
('single', idxtext2, targetid, '', None),
|
||||
indexnode["entries"] = [
|
||||
("single", idxtext, targetid, "", None),
|
||||
("single", idxtext2, targetid, "", None),
|
||||
]
|
||||
return [indexnode, targetnode, node], []
|
||||
except KeyError as e:
|
||||
|
|
@ -104,20 +104,21 @@ class IPRange(Directive):
|
|||
def handle_rangespec(self, node):
|
||||
titlenode = nodes.title()
|
||||
node.append(titlenode)
|
||||
titlenode.append(nodes.inline('', self.get_prefix_title()))
|
||||
titlenode.append(nodes.literal('', self.rangespec))
|
||||
titlenode.append(nodes.inline("", self.get_prefix_title()))
|
||||
titlenode.append(nodes.literal("", self.rangespec))
|
||||
ids = ip_object_anchor(self.typ, self.rangespec)
|
||||
node['ids'].append(ids)
|
||||
node["ids"].append(ids)
|
||||
self.env.domaindata[self.domain][self.typ][ids] = (
|
||||
self.env.docname,
|
||||
self.options.get('synopsis', ''))
|
||||
self.options.get("synopsis", ""),
|
||||
)
|
||||
return ids
|
||||
|
||||
def run(self):
|
||||
if ':' in self.name:
|
||||
self.domain, self.objtype = self.name.split(':', 1)
|
||||
if ":" in self.name:
|
||||
self.domain, self.objtype = self.name.split(":", 1)
|
||||
else:
|
||||
self.domain, self.objtype = '', self.name
|
||||
self.domain, self.objtype = "", self.name
|
||||
self.env = self.state.document.settings.env
|
||||
self.rangespec = self.arguments[0]
|
||||
node = nodes.section()
|
||||
|
|
@ -127,97 +128,98 @@ class IPRange(Directive):
|
|||
else:
|
||||
doctitle = list(self.state.document.traverse(nodes.title))[0].astext()
|
||||
idx_text = "%s; %s" % (self.rangespec, doctitle)
|
||||
self.indexnode = addnodes.index(entries=[
|
||||
('single', idx_text, name, '', None),
|
||||
('single', self.get_index_text(), name, '', None)
|
||||
])
|
||||
self.indexnode = addnodes.index(
|
||||
entries=[
|
||||
("single", idx_text, name, "", None),
|
||||
("single", self.get_index_text(), name, "", None),
|
||||
]
|
||||
)
|
||||
|
||||
if self.content:
|
||||
contentnode = nodes.paragraph('')
|
||||
contentnode = nodes.paragraph("")
|
||||
node.append(contentnode)
|
||||
self.state.nested_parse(
|
||||
self.content, self.content_offset, contentnode)
|
||||
self.state.nested_parse(self.content, self.content_offset, contentnode)
|
||||
|
||||
iprange = ip_range()
|
||||
node.append(iprange)
|
||||
iprange['rangespec'] = self.rangespec
|
||||
iprange["rangespec"] = self.rangespec
|
||||
return [self.indexnode, node]
|
||||
|
||||
|
||||
class IPv4Range(IPRange):
|
||||
typ = 'v4range'
|
||||
typ = "v4range"
|
||||
|
||||
def get_prefix_title(self):
|
||||
return _('IPv4 address range ')
|
||||
return _("IPv4 address range ")
|
||||
|
||||
def get_index_text(self):
|
||||
return "%s; %s" % (_('IPv4 range'), self.rangespec)
|
||||
return "%s; %s" % (_("IPv4 range"), self.rangespec)
|
||||
|
||||
|
||||
class IPv6Range(IPRange):
|
||||
typ = 'v6range'
|
||||
typ = "v6range"
|
||||
|
||||
def get_prefix_title(self):
|
||||
return _('IPv6 address range ')
|
||||
return _("IPv6 address range ")
|
||||
|
||||
def get_index_text(self):
|
||||
return "%s; %s" % (_('IPv6 range'), self.rangespec)
|
||||
return "%s; %s" % (_("IPv6 range"), self.rangespec)
|
||||
|
||||
|
||||
class IPDomain(Domain):
|
||||
"""
|
||||
IP address and range domain.
|
||||
"""
|
||||
name = 'ip'
|
||||
label = 'IP addresses and ranges.'
|
||||
|
||||
name = "ip"
|
||||
label = "IP addresses and ranges."
|
||||
|
||||
object_types = {
|
||||
'v4': ObjType(_('v4'), 'v4', 'obj'),
|
||||
'v6': ObjType(_('v6'), 'v6', 'obj'),
|
||||
'v4range': ObjType(_('v4range'), 'v4range', 'obj'),
|
||||
'v6range': ObjType(_('v6range'), 'v6range', 'obj'),
|
||||
"v4": ObjType(_("v4"), "v4", "obj"),
|
||||
"v6": ObjType(_("v6"), "v6", "obj"),
|
||||
"v4range": ObjType(_("v4range"), "v4range", "obj"),
|
||||
"v6range": ObjType(_("v6range"), "v6range", "obj"),
|
||||
}
|
||||
|
||||
directives = {
|
||||
'v4range': IPv4Range,
|
||||
'v6range': IPv6Range,
|
||||
"v4range": IPv4Range,
|
||||
"v6range": IPv6Range,
|
||||
}
|
||||
|
||||
roles = {
|
||||
'v4': IPXRefRole('v4', _('IPv4 address')),
|
||||
'v6': IPXRefRole('v6', _('IPv6 address')),
|
||||
'v4range': IPXRefRole('v4range', _('IPv4 range')),
|
||||
'v6range': IPXRefRole('v6range', _('IPv6 range')),
|
||||
"v4": IPXRefRole("v4", _("IPv4 address")),
|
||||
"v6": IPXRefRole("v6", _("IPv6 address")),
|
||||
"v4range": IPXRefRole("v4range", _("IPv4 range")),
|
||||
"v6range": IPXRefRole("v6range", _("IPv6 range")),
|
||||
}
|
||||
|
||||
initial_data = {
|
||||
'v4': {},
|
||||
'v6': {},
|
||||
'v4range': {},
|
||||
'v6range': {},
|
||||
'ips': [],
|
||||
"v4": {},
|
||||
"v6": {},
|
||||
"v4range": {},
|
||||
"v6range": {},
|
||||
"ips": [],
|
||||
}
|
||||
|
||||
def clear_doc(self, docname):
|
||||
to_remove = []
|
||||
for key, value in self.data['v4range'].items():
|
||||
for key, value in self.data["v4range"].items():
|
||||
if docname == value[0]:
|
||||
to_remove.append(key)
|
||||
for key in to_remove:
|
||||
del self.data['v4range'][key]
|
||||
del self.data["v4range"][key]
|
||||
|
||||
to_remove = []
|
||||
for key, value in self.data['v6range'].items():
|
||||
for key, value in self.data["v6range"].items():
|
||||
if docname == value[0]:
|
||||
to_remove.append(key)
|
||||
for key in to_remove:
|
||||
del self.data['v6range'][key]
|
||||
self.data['ips'] = [
|
||||
item for item in self.data['ips'] if item['docname'] != docname
|
||||
del self.data["v6range"][key]
|
||||
self.data["ips"] = [
|
||||
item for item in self.data["ips"] if item["docname"] != docname
|
||||
]
|
||||
|
||||
def resolve_xref(self, env, fromdocname, builder, typ, target, node,
|
||||
contnode):
|
||||
def resolve_xref(self, env, fromdocname, builder, typ, target, node, contnode):
|
||||
key = ip_object_anchor(typ, target)
|
||||
try:
|
||||
info = self.data[typ][key]
|
||||
|
|
@ -226,19 +228,20 @@ class IPDomain(Domain):
|
|||
role = self.roles.get(typ)
|
||||
if role is None:
|
||||
return None
|
||||
resnode = role.result_nodes(env.get_doctree(fromdocname),
|
||||
env, node, True)[0][2]
|
||||
resnode = role.result_nodes(env.get_doctree(fromdocname), env, node, True)[
|
||||
0
|
||||
][2]
|
||||
if isinstance(resnode, addnodes.pending_xref):
|
||||
text = node[0][0]
|
||||
reporter = env.get_doctree(fromdocname).reporter
|
||||
reporter.warning('Cannot resolve reference to %r' % text,
|
||||
line=node.line)
|
||||
reporter.warning(
|
||||
"Cannot resolve reference to %r" % text, line=node.line
|
||||
)
|
||||
return node.children
|
||||
return resnode
|
||||
else:
|
||||
title = typ.upper() + ' ' + target
|
||||
return make_refnode(builder, fromdocname, info[0], key,
|
||||
contnode, title)
|
||||
title = typ.upper() + " " + target
|
||||
return make_refnode(builder, fromdocname, info[0], key, contnode, title)
|
||||
|
||||
@property
|
||||
def items(self):
|
||||
|
|
@ -257,13 +260,15 @@ def process_ips(app, doctree):
|
|||
|
||||
for node in doctree.traverse(ip_node):
|
||||
ip = node.astext()
|
||||
domaindata['ips'].append({
|
||||
'docname': env.docname,
|
||||
'source': node.parent.source or env.doc2path(env.docname),
|
||||
'lineno': node.parent.line,
|
||||
'ip': ip,
|
||||
'typ': node.parent['typ'],
|
||||
})
|
||||
domaindata["ips"].append(
|
||||
{
|
||||
"docname": env.docname,
|
||||
"source": node.parent.source or env.doc2path(env.docname),
|
||||
"lineno": node.parent.line,
|
||||
"ip": ip,
|
||||
"typ": node.parent["typ"],
|
||||
}
|
||||
)
|
||||
replacement = nodes.literal(ip, ip)
|
||||
node.replace_self(replacement)
|
||||
|
||||
|
|
@ -285,17 +290,14 @@ def process_ip_nodes(app, doctree, fromdocname):
|
|||
env = app.builder.env
|
||||
domaindata = env.domaindata[IPDomain.name]
|
||||
|
||||
header = (_('IP address'), _('Used by'))
|
||||
header = (_("IP address"), _("Used by"))
|
||||
colwidths = (1, 3)
|
||||
|
||||
for node in doctree.traverse(ip_range):
|
||||
content = []
|
||||
net = Network(node['rangespec'])
|
||||
net = Network(node["rangespec"])
|
||||
ips = {}
|
||||
for key, value in [
|
||||
(ip_info['ip'], ip_info) for ip_info in
|
||||
domaindata['ips']
|
||||
]:
|
||||
for key, value in [(ip_info["ip"], ip_info) for ip_info in domaindata["ips"]]:
|
||||
try:
|
||||
if not key in net:
|
||||
continue
|
||||
|
|
@ -313,34 +315,32 @@ def process_ip_nodes(app, doctree, fromdocname):
|
|||
tgroup += nodes.colspec(colwidth=colwidth)
|
||||
thead = nodes.thead()
|
||||
tgroup += thead
|
||||
thead += create_table_row([
|
||||
nodes.paragraph(text=label) for label in header])
|
||||
thead += create_table_row([nodes.paragraph(text=label) for label in header])
|
||||
tbody = nodes.tbody()
|
||||
tgroup += tbody
|
||||
for ip, ip_info in [
|
||||
(ip, ips[ip]) for ip in sorted(ips, key=sort_ip)
|
||||
]:
|
||||
for ip, ip_info in [(ip, ips[ip]) for ip in sorted(ips, key=sort_ip)]:
|
||||
para = nodes.paragraph()
|
||||
para += nodes.literal('', ip)
|
||||
para += nodes.literal("", ip)
|
||||
refnode = nodes.paragraph()
|
||||
refuris = set()
|
||||
refnodes = []
|
||||
for item in ip_info:
|
||||
ids = ip_object_anchor(item['typ'], item['ip'])
|
||||
if ids not in para['ids']:
|
||||
para['ids'].append(ids)
|
||||
ids = ip_object_anchor(item["typ"], item["ip"])
|
||||
if ids not in para["ids"]:
|
||||
para["ids"].append(ids)
|
||||
|
||||
domaindata[item['typ']][ids] = (fromdocname, '')
|
||||
newnode = nodes.reference('', '', internal=True)
|
||||
domaindata[item["typ"]][ids] = (fromdocname, "")
|
||||
newnode = nodes.reference("", "", internal=True)
|
||||
try:
|
||||
newnode['refuri'] = app.builder.get_relative_uri(
|
||||
fromdocname, item['docname'])
|
||||
if newnode['refuri'] in refuris:
|
||||
newnode["refuri"] = app.builder.get_relative_uri(
|
||||
fromdocname, item["docname"]
|
||||
)
|
||||
if newnode["refuri"] in refuris:
|
||||
continue
|
||||
refuris.add(newnode['refuri'])
|
||||
refuris.add(newnode["refuri"])
|
||||
except NoUri:
|
||||
pass
|
||||
title = env.titles[item['docname']]
|
||||
title = env.titles[item["docname"]]
|
||||
innernode = nodes.Text(title.astext())
|
||||
newnode.append(innernode)
|
||||
refnodes.append(newnode)
|
||||
|
|
@ -351,13 +351,13 @@ def process_ip_nodes(app, doctree, fromdocname):
|
|||
tbody += create_table_row([para, refnode])
|
||||
content.append(table)
|
||||
else:
|
||||
para = nodes.paragraph(_('No IP addresses in this range'))
|
||||
para = nodes.paragraph(_("No IP addresses in this range"))
|
||||
content.append(para)
|
||||
node.replace_self(content)
|
||||
|
||||
|
||||
def setup(app):
|
||||
app.add_domain(IPDomain)
|
||||
app.connect('doctree-read', process_ips)
|
||||
app.connect('doctree-resolved', process_ip_nodes)
|
||||
return {'version': __version__}
|
||||
app.connect("doctree-read", process_ips)
|
||||
app.connect("doctree-resolved", process_ip_nodes)
|
||||
return {"version": __version__}
|
||||
|
|
|
|||
Loading…
Add table
Add a link
Reference in a new issue