mir/bind
2
0
Fork 0
mirror of https://gitlab.isc.org/isc-projects/bind9 synced 2025-09-01 06:55:30 +00:00
Code Issues Releases Wiki Activity

Add ability to filter tables using blocks

Browse Source 
A new syntax
.. namedconf:statementlist::
   :filter_blocks: type secondary
allows to generate tables with statements allowed within specified
blocks.
This commit is contained in:
Petr Špaček
2022-06-27 18:19:25 +02:00
parent 5c04e3c524
commit 08a8acffdc
1 changed files with 27 additions and 5 deletions
Download Patch File Download Diff File Expand all files Collapse all files

28
doc/arm/_ext/iscconf.py
View File

@@ -67,11 +67,17 @@ def domain_factory(domainname, domainlabel, todolist, grammar):
process_statementlist_nodes() callback. process_statementlist_nodes() callback.
""" """
option_spec = {"filter_tags": lambda arg: split_csv(arg, required=True)} option_spec = {
"filter_blocks": lambda arg: split_csv(arg, required=True),
"filter_tags": lambda arg: split_csv(arg, required=True),
}
def run(self): def run(self):
placeholder = todolist("") placeholder = todolist("")
placeholder["isc_filter_tags"] = set(self.options.get("filter_tags", [])) placeholder["isc_filter_tags"] = set(self.options.get("filter_tags", []))
placeholder["isc_filter_blocks"] = set(
self.options.get("filter_blocks", [])
)
return [placeholder] return [placeholder]
class ISCConfDomain(Domain): class ISCConfDomain(Domain):
@@ -428,7 +434,7 @@ def domain_factory(domainname, domainlabel, todolist, grammar):
of statements. of statements.
""" """
def gen_replacement_table(acceptable_tags): def gen_replacement_table(acceptable_blocks, acceptable_tags):
table_header = [ table_header = [
TableColumn("ref", "Statement"), TableColumn("ref", "Statement"),
TableColumn("short", "Description"), TableColumn("short", "Description"),
@@ -452,8 +458,16 @@ def domain_factory(domainname, domainlabel, todolist, grammar):
sorted( sorted(
filter( filter(
lambda item: ( lambda item: (
(
not acceptable_tags not acceptable_tags
or item["tags"].intersection(acceptable_tags) or item["tags"].intersection(acceptable_tags)
)
and (
not acceptable_blocks
or item["block_names"].intersection(
acceptable_blocks
)
)
), ),
iscconf.list_all(fromdocname), iscconf.list_all(fromdocname),
), ),
@@ -467,10 +481,17 @@ def domain_factory(domainname, domainlabel, todolist, grammar):
for node in doctree.traverse(todolist): for node in doctree.traverse(todolist):
acceptable_tags = node["isc_filter_tags"] acceptable_tags = node["isc_filter_tags"]
node.replace_self(gen_replacement_table(acceptable_tags)) acceptable_blocks = node["isc_filter_blocks"]
node.replace_self(
gen_replacement_table(acceptable_blocks, acceptable_tags)
)
def list_all(self, fromdocname): def list_all(self, fromdocname):
for statement in self.data["statements"].values(): for statement in self.data["statements"].values():
block_names = set(
path[-1]
for path in self.statement_blocks.get(statement["signature"], [])
)
tags_txt = ", ".join(statement["tags"]) tags_txt = ", ".join(statement["tags"])
refpara = nodes.inline() refpara = nodes.inline()
@@ -485,6 +506,7 @@ def domain_factory(domainname, domainlabel, todolist, grammar):
) )
copy = statement.copy() copy = statement.copy()
copy["block_names"] = block_names
copy["ref"] = refpara copy["ref"] = refpara
copy["tags_txt"] = tags_txt copy["tags_txt"] = tags_txt
yield copy yield copy