commit 8b8670db100efed03a979f7ec24c353f72c0bdbd · pyrox.dev/nixpkgs

pkgs/tools/nix/nixos-render-docs/src/nixos_render_docs/__init__.py

···

       4
       4
        
       from typing import Any, Dict

     

       5
       5
        
       

     

       6
       6
        
       from .md import Converter

     

       7
       7
       +
       from . import manual

     

       7
       8
        
       from . import options

     

       8
       9
        
       

     

       9
       10
        
       def main() -> None:

     
···

       12
       13
        
           commands = parser.add_subparsers(dest='command', required=True)

     

       13
       14
        
       

     

       14
       15
        
           options.build_cli(commands.add_parser('options'))

     

       16
       16
       +
           manual.build_cli(commands.add_parser('manual'))

     

       15
       17
        
       

     

       16
       18
        
           args = parser.parse_args()

     

       17
       19
        
           if args.command == 'options':

     

       18
       20
        
               options.run_cli(args)

     

       21
       21
       +
           elif args.command == 'manual':

     

       22
       22
       +
               manual.run_cli(args)

     

       19
       23
        
           else:

     

       20
       24
        
               raise RuntimeError('command not hooked up', args)

+143

pkgs/tools/nix/nixos-render-docs/src/nixos_render_docs/manual.py

···

       1
       1
       +
       import argparse

     

       2
       2
       +
       import json

     

       3
       3
       +
       

     

       4
       4
       +
       from abc import abstractmethod

     

       5
       5
       +
       from collections.abc import MutableMapping, Sequence

     

       6
       6
       +
       from typing import Any, cast, NamedTuple, Optional, Union

     

       7
       7
       +
       from xml.sax.saxutils import escape, quoteattr

     

       8
       8
       +
       from markdown_it.token import Token

     

       9
       9
       +
       from markdown_it.utils import OptionsDict

     

       10
       10
       +
       

     

       11
       11
       +
       from .docbook import DocBookRenderer

     

       12
       12
       +
       from .md import Converter

     

       13
       13
       +
       

     

       14
       14
       +
       class RenderedSection:

     

       15
       15
       +
           id: Optional[str]

     

       16
       16
       +
           chapters: list[str]

     

       17
       17
       +
       

     

       18
       18
       +
           def __init__(self, id: Optional[str]) -> None:

     

       19
       19
       +
               self.id = id

     

       20
       20
       +
               self.chapters = []

     

       21
       21
       +
       

     

       22
       22
       +
       class BaseConverter(Converter):

     

       23
       23
       +
           _sections: list[RenderedSection]

     

       24
       24
       +
       

     

       25
       25
       +
           def __init__(self, manpage_urls: dict[str, str]):

     

       26
       26
       +
               super().__init__(manpage_urls)

     

       27
       27
       +
               self._sections = []

     

       28
       28
       +
       

     

       29
       29
       +
           def add_section(self, id: Optional[str], chapters: list[str]) -> None:

     

       30
       30
       +
               self._sections.append(RenderedSection(id))

     

       31
       31
       +
               for content in chapters:

     

       32
       32
       +
                   self._md.renderer._title_seen = False # type: ignore[attr-defined]

     

       33
       33
       +
                   self._sections[-1].chapters.append(self._render(content))

     

       34
       34
       +
       

     

       35
       35
       +
           @abstractmethod

     

       36
       36
       +
           def finalize(self) -> str: raise NotImplementedError()

     

       37
       37
       +
       

     

       38
       38
       +
       class ManualDocBookRenderer(DocBookRenderer):

     

       39
       39
       +
           # needed to check correctness of chapters.

     

       40
       40
       +
           # we may want to use front matter instead of this kind of heuristic.

     

       41
       41
       +
           _title_seen = False

     

       42
       42
       +
       

     

       43
       43
       +
           def _heading_tag(self, token: Token, tokens: Sequence[Token], i: int, options: OptionsDict,

     

       44
       44
       +
                            env: MutableMapping[str, Any]) -> tuple[str, dict[str, str]]:

     

       45
       45
       +
               (tag, attrs) = super()._heading_tag(token, tokens, i, options, env)

     

       46
       46
       +
               if self._title_seen:

     

       47
       47
       +
                   if token.tag == 'h1':

     

       48
       48
       +
                       raise RuntimeError("only one title heading allowed", token)

     

       49
       49
       +
                   return (tag, attrs)

     

       50
       50
       +
               self._title_seen = True

     

       51
       51
       +
               return ("chapter", attrs | {

     

       52
       52
       +
                   'xmlns': "http://docbook.org/ns/docbook",

     

       53
       53
       +
                   'xmlns:xlink': "http://www.w3.org/1999/xlink",

     

       54
       54
       +
               })

     

       55
       55
       +
       

     

       56
       56
       +
           # TODO minimize docbook diffs with existing conversions. remove soon.

     

       57
       57
       +
           def paragraph_open(self, token: Token, tokens: Sequence[Token], i: int, options: OptionsDict,

     

       58
       58
       +
                              env: MutableMapping[str, Any]) -> str:

     

       59
       59
       +
               return super().paragraph_open(token, tokens, i, options, env) + "\n "

     

       60
       60
       +
           def paragraph_close(self, token: Token, tokens: Sequence[Token], i: int, options: OptionsDict,

     

       61
       61
       +
                               env: MutableMapping[str, Any]) -> str:

     

       62
       62
       +
               return "\n" + super().paragraph_close(token, tokens, i, options, env)

     

       63
       63
       +
           def code_block(self, token: Token, tokens: Sequence[Token], i: int, options: OptionsDict,

     

       64
       64
       +
                          env: MutableMapping[str, Any]) -> str:

     

       65
       65
       +
               return f"<programlisting>\n{escape(token.content)}</programlisting>"

     

       66
       66
       +
           def fence(self, token: Token, tokens: Sequence[Token], i: int, options: OptionsDict,

     

       67
       67
       +
                     env: MutableMapping[str, Any]) -> str:

     

       68
       68
       +
               info = f" language={quoteattr(token.info)}" if token.info != "" else ""

     

       69
       69
       +
               return f"<programlisting{info}>\n{escape(token.content)}</programlisting>"

     

       70
       70
       +
       

     

       71
       71
       +
       class DocBookConverter(BaseConverter):

     

       72
       72
       +
           __renderer__ = ManualDocBookRenderer

     

       73
       73
       +
       

     

       74
       74
       +
           def finalize(self) -> str:

     

       75
       75
       +
               result = []

     

       76
       76
       +
       

     

       77
       77
       +
               for section in self._sections:

     

       78
       78
       +
                   id = "id=" + quoteattr(section.id) if section.id is not None else ""

     

       79
       79
       +
                   result.append(f'<section {id}>')

     

       80
       80
       +
                   result += section.chapters

     

       81
       81
       +
                   result.append(f'</section>')

     

       82
       82
       +
       

     

       83
       83
       +
               return "\n".join(result)

     

       84
       84
       +
       

     

       85
       85
       +
       

     

       86
       86
       +
       

     

       87
       87
       +
       class Section:

     

       88
       88
       +
           id: Optional[str] = None

     

       89
       89
       +
           chapters: list[str]

     

       90
       90
       +
       

     

       91
       91
       +
           def __init__(self) -> None:

     

       92
       92
       +
               self.chapters = []

     

       93
       93
       +
       

     

       94
       94
       +
       class SectionAction(argparse.Action):

     

       95
       95
       +
           def __call__(self, parser: argparse.ArgumentParser, ns: argparse.Namespace,

     

       96
       96
       +
                        values: Union[str, Sequence[Any], None], opt_str: Optional[str] = None) -> None:

     

       97
       97
       +
               sections = getattr(ns, self.dest)

     

       98
       98
       +
               if sections is None: sections = []

     

       99
       99
       +
               sections.append(Section())

     

       100
       100
       +
               setattr(ns, self.dest, sections)

     

       101
       101
       +
       

     

       102
       102
       +
       class SectionIDAction(argparse.Action):

     

       103
       103
       +
           def __call__(self, parser: argparse.ArgumentParser, ns: argparse.Namespace,

     

       104
       104
       +
                        values: Union[str, Sequence[Any], None], opt_str: Optional[str] = None) -> None:

     

       105
       105
       +
               sections = getattr(ns, self.dest)

     

       106
       106
       +
               if sections is None: raise argparse.ArgumentError(self, "no active section")

     

       107
       107
       +
               sections[-1].id = cast(str, values)

     

       108
       108
       +
       

     

       109
       109
       +
       class ChaptersAction(argparse.Action):

     

       110
       110
       +
           def __call__(self, parser: argparse.ArgumentParser, ns: argparse.Namespace,

     

       111
       111
       +
                        values: Union[str, Sequence[Any], None], opt_str: Optional[str] = None) -> None:

     

       112
       112
       +
               sections = getattr(ns, self.dest)

     

       113
       113
       +
               if sections is None: raise argparse.ArgumentError(self, "no active section")

     

       114
       114
       +
               sections[-1].chapters.extend(cast(Sequence[str], values))

     

       115
       115
       +
       

     

       116
       116
       +
       def _build_cli_db(p: argparse.ArgumentParser) -> None:

     

       117
       117
       +
           p.add_argument('--manpage-urls', required=True)

     

       118
       118
       +
           p.add_argument("outfile")

     

       119
       119
       +
           p.add_argument("--section", dest="contents", action=SectionAction, nargs=0)

     

       120
       120
       +
           p.add_argument("--section-id", dest="contents", action=SectionIDAction)

     

       121
       121
       +
           p.add_argument("--chapters", dest="contents", action=ChaptersAction, nargs='+')

     

       122
       122
       +
       

     

       123
       123
       +
       def _run_cli_db(args: argparse.Namespace) -> None:

     

       124
       124
       +
           with open(args.manpage_urls, 'r') as manpage_urls:

     

       125
       125
       +
               md = DocBookConverter(json.load(manpage_urls))

     

       126
       126
       +
               for section in args.contents:

     

       127
       127
       +
                   chapters = []

     

       128
       128
       +
                   for p in section.chapters:

     

       129
       129
       +
                       with open(p, 'r') as f:

     

       130
       130
       +
                           chapters.append(f.read())

     

       131
       131
       +
                   md.add_section(section.id, chapters)

     

       132
       132
       +
               with open(args.outfile, 'w') as f:

     

       133
       133
       +
                   f.write(md.finalize())

     

       134
       134
       +
       

     

       135
       135
       +
       def build_cli(p: argparse.ArgumentParser) -> None:

     

       136
       136
       +
           formats = p.add_subparsers(dest='format', required=True)

     

       137
       137
       +
           _build_cli_db(formats.add_parser('docbook'))

     

       138
       138
       +
       

     

       139
       139
       +
       def run_cli(args: argparse.Namespace) -> None:

     

       140
       140
       +
           if args.format == 'docbook':

     

       141
       141
       +
               _run_cli_db(args)

     

       142
       142
       +
           else:

     

       143
       143
       +
               raise RuntimeError('format not hooked up', args)