schema_salad.makedoc

Module Contents

Classes

MyRenderer

Custom renderer with different representations of selected HTML tags.

ToC

RenderType

Functions

vocab_type_name(url)

Remove the avro namespace, if any.

has_types(items)

linkto(item)

markdown_list_hook(markdown, text, state)

Patches problematic Markdown lists for later HTML generation.

patch_fenced_code(original_markdown_text, ...)

Reverts fenced code fragments found in the modified contents back to their original definition.

to_id(text)

number_headings(toc, maindoc)

fix_doc(doc)

avrold_doc(j, outdoc, renderlist, redirects, brand, ...)

arg_parser()

Build the argument parser.

main()

Shortcut entrypoint.

makedoc(stdout, schema[, redirects, only, brand, ...])

Emit HTML representation of a given schema.

Attributes

basicTypes

schema_salad.makedoc.vocab_type_name(url)

Remove the avro namespace, if any.

Parameters:

url (str) –

Return type:

str

schema_salad.makedoc.has_types(items)
Parameters:

items (Any) –

Return type:

List[str]

schema_salad.makedoc.linkto(item)
Parameters:

item (str) –

Return type:

str

class schema_salad.makedoc.MyRenderer(escape=True, allow_harmful_protocols=None)

Bases: mistune.renderers.HTMLRenderer

digraph inheritanced9b3aab934 { bgcolor=transparent; rankdir=LR; size="8.0, 12.0"; "BaseRenderer" [fillcolor=white,fontname="Vera Sans, DejaVu Sans, Liberation Sans, Arial, Helvetica, sans",fontsize=10,height=0.25,shape=box,style="setlinewidth(0.5),filled"]; "HTMLRenderer" [fillcolor=white,fontname="Vera Sans, DejaVu Sans, Liberation Sans, Arial, Helvetica, sans",fontsize=10,height=0.25,shape=box,style="setlinewidth(0.5),filled"]; "BaseRenderer" -> "HTMLRenderer" [arrowsize=0.5,style="setlinewidth(0.5)"]; "MyRenderer" [URL="#schema_salad.makedoc.MyRenderer",fillcolor=white,fontname="Vera Sans, DejaVu Sans, Liberation Sans, Arial, Helvetica, sans",fontsize=10,height=0.25,shape=box,style="setlinewidth(0.5),filled",target="_top",tooltip="Custom renderer with different representations of selected HTML tags."]; "HTMLRenderer" -> "MyRenderer" [arrowsize=0.5,style="setlinewidth(0.5)"]; }

Custom renderer with different representations of selected HTML tags.

heading(text, level)

Override HTML heading creation with text IDs.

Parameters:

  • text (str) –

  • level (int) –

Return type:

str

text(text)

Don’t escape quotation marks.

Parameters:

text (str) –

Return type:

str

inline_html(html)

Don’t escape characters in predefined HTML within paragraph tags.

Parameters:

html (str) –

Return type:

str

block_html(html)

Don’t escape characters nor wrap predefined HTML within paragraph tags.

Parameters:

html (str) –

Return type:

str

block_code(code, info=None)

Don’t escape quotation marks.

Parameters:

  • code (str) –

  • info (Optional[str]) –

Return type:

str

schema_salad.makedoc.markdown_list_hook(markdown, text, state)

Patches problematic Markdown lists for later HTML generation.

When a Markdown list with paragraphs not indented with the list markers (no spaces before following lines), mistune v2 does not handle them correctly. This is however permitted as per https://daringfireball.net/projects/markdown/syntax#list

For example:

`markdown * some list * item with paragraph * other item `

Similarly, lists that are completely indented or that contains nested lists produce incorrect HTML <p>/<li> tag combinations.

Because list parsing is deeply nested within mistune.block_parser.BlockParser and that there is no easy way to override utility functions it employs to adjust patterns of list items without reimplementing it or a lot of monkey patching, instead catch the problem cases before rendering and adjust them with a hook.

See https://github.com/lepture/mistune/issues/296 and https://github.com/common-workflow-language/schema_salad/pull/619

Parameters:

  • markdown (Markdown[str, Any]) –

  • text (str) –

  • state (mistune.State) –

Return type:

Tuple[str, mistune.State]

schema_salad.makedoc.patch_fenced_code(original_markdown_text, modified_markdown_text)

Reverts fenced code fragments found in the modified contents back to their original definition.

Parameters:

  • original_markdown_text (str) –

  • modified_markdown_text (str) –

Return type:

str

schema_salad.makedoc.to_id(text)
Parameters:

text (str) –

Return type:

str

class schema_salad.makedoc.ToC
add_entry(thisdepth, title)

Add an entry to the table of contents.

Parameters:

  • thisdepth (int) –

  • title (str) –

Return type:

str

contents(idn)
Parameters:

idn (str) –

Return type:

str

schema_salad.makedoc.basicTypes = ('https://w3id.org/cwl/salad#null', 'http://www.w3.org/2001/XMLSchema#boolean',...
schema_salad.makedoc.number_headings(toc, maindoc)
Parameters:

  • toc (ToC) –

  • maindoc (str) –

Return type:

str

schema_salad.makedoc.fix_doc(doc)
Parameters:

doc (Union[List[str], str]) –

Return type:

str

class schema_salad.makedoc.RenderType(toc, j, renderlist, redirects, primitiveType)
Parameters:

  • toc (ToC) –

  • j (List[Dict[str, Any]]) –

  • renderlist (List[str]) –

  • redirects (Dict[str, str]) –

  • primitiveType (str) –

typefmt(tp, redirects, nbsp=False, jsonldPredicate=None)
Parameters:

  • tp (Any) –

  • redirects (Dict[str, str]) –

  • nbsp (bool) –

  • jsonldPredicate (Optional[Union[Dict[str, str], str]]) –

Return type:

str

render_type(f, depth)
Parameters:

  • f (Dict[str, Any]) –

  • depth (int) –

Return type:

None

schema_salad.makedoc.avrold_doc(j, outdoc, renderlist, redirects, brand, brandlink, primtype, brandstyle=None, brandinverse=False)
Parameters:

  • j (List[Dict[str, Any]]) –

  • outdoc (IO[Any]) –

  • renderlist (List[str]) –

  • redirects (Dict[str, str]) –

  • brand (str) –

  • brandlink (str) –

  • primtype (str) –

  • brandstyle (Optional[str]) –

  • brandinverse (Optional[bool]) –

Return type:

None

schema_salad.makedoc.arg_parser()

Build the argument parser.

Return type:

argparse.ArgumentParser

schema_salad.makedoc.main()

Shortcut entrypoint.

Return type:

None

schema_salad.makedoc.makedoc(stdout, schema, redirects=None, only=None, brand=None, brandlink=None, primtype=None, brandstyle=None, brandinverse=False)

Emit HTML representation of a given schema.

Parameters:

  • stdout (IO[Any]) –

  • schema (str) –

  • redirects (Optional[List[str]]) –

  • only (Optional[List[str]]) –

  • brand (Optional[str]) –

  • brandlink (Optional[str]) –

  • primtype (Optional[str]) –

  • brandstyle (Optional[str]) –

  • brandinverse (Optional[bool]) –

Return type:

None