commit 2ab8e742a541659baa0470e3be8fc7e01ff51175 · pyrox.dev/nixpkgs

+77 -76
pkgs/tools/nix/nixos-render-docs/src/nixos_render_docs/manual.py
···

       4
       4
        
       from abc import abstractmethod

     

       5
       5
        
       from collections.abc import Mapping, Sequence

     

       6
       6
        
       from pathlib import Path

     

       7
       7
       -
       from typing import Any, cast, NamedTuple, Optional, Union

     

       7
       7
       +
       from typing import Any, cast, Generic, NamedTuple, Optional, Union

     

       8
       8
        
       from xml.sax.saxutils import escape, quoteattr

     

       9
       9
        
       

     

       10
       10
        
       import markdown_it

     

       11
       11
        
       from markdown_it.token import Token

     

       12
       12
        
       

     

       13
       13
       -
       from . import options

     

       13
       13
       +
       from . import md, options

     

       14
       14
        
       from .docbook import DocBookRenderer, Heading

     

       15
       15
        
       from .md import Converter

     

       16
       16
       +
       

     

       17
       17
       +
       class BaseConverter(Converter[md.TR], Generic[md.TR]):

     

       18
       18
       +
           _base_paths: list[Path]

     

       19
       19
       +
       

     

       20
       20
       +
           def convert(self, file: Path) -> str:

     

       21
       21
       +
               self._base_paths = [ file ]

     

       22
       22
       +
               try:

     

       23
       23
       +
                   with open(file, 'r') as f:

     

       24
       24
       +
                       return self._render(f.read())

     

       25
       25
       +
               except Exception as e:

     

       26
       26
       +
                   raise RuntimeError(f"failed to render manual {file}") from e

     

       27
       27
       +
       

     

       28
       28
       +
           def _parse(self, src: str) -> list[Token]:

     

       29
       29
       +
               tokens = super()._parse(src)

     

       30
       30
       +
               for token in tokens:

     

       31
       31
       +
                   if token.type != "fence" or not token.info.startswith("{=include=} "):

     

       32
       32
       +
                       continue

     

       33
       33
       +
                   typ = token.info[12:].strip()

     

       34
       34
       +
                   if typ == 'options':

     

       35
       35
       +
                       token.type = 'included_options'

     

       36
       36
       +
                       self._parse_options(token)

     

       37
       37
       +
                   elif typ in [ 'sections', 'chapters', 'preface', 'parts', 'appendix' ]:

     

       38
       38
       +
                       token.type = 'included_' + typ

     

       39
       39
       +
                       self._parse_included_blocks(token)

     

       40
       40
       +
                   else:

     

       41
       41
       +
                       raise RuntimeError(f"unsupported structural include type '{typ}'")

     

       42
       42
       +
               return tokens

     

       43
       43
       +
       

     

       44
       44
       +
           def _parse_included_blocks(self, token: Token) -> None:

     

       45
       45
       +
               assert token.map

     

       46
       46
       +
               included = token.meta['included'] = []

     

       47
       47
       +
               for (lnum, line) in enumerate(token.content.splitlines(), token.map[0] + 2):

     

       48
       48
       +
                   line = line.strip()

     

       49
       49
       +
                   path = self._base_paths[-1].parent / line

     

       50
       50
       +
                   if path in self._base_paths:

     

       51
       51
       +
                       raise RuntimeError(f"circular include found in line {lnum}")

     

       52
       52
       +
                   try:

     

       53
       53
       +
                       self._base_paths.append(path)

     

       54
       54
       +
                       with open(path, 'r') as f:

     

       55
       55
       +
                           tokens = self._parse(f.read())

     

       56
       56
       +
                           included.append((tokens, path))

     

       57
       57
       +
                       self._base_paths.pop()

     

       58
       58
       +
                   except Exception as e:

     

       59
       59
       +
                       raise RuntimeError(f"processing included file {path} from line {lnum}") from e

     

       60
       60
       +
       

     

       61
       61
       +
           def _parse_options(self, token: Token) -> None:

     

       62
       62
       +
               assert token.map

     

       63
       63
       +
       

     

       64
       64
       +
               items = {}

     

       65
       65
       +
               for (lnum, line) in enumerate(token.content.splitlines(), token.map[0] + 2):

     

       66
       66
       +
                   if len(args := line.split(":", 1)) != 2:

     

       67
       67
       +
                       raise RuntimeError(f"options directive with no argument in line {lnum}")

     

       68
       68
       +
                   (k, v) = (args[0].strip(), args[1].strip())

     

       69
       69
       +
                   if k in items:

     

       70
       70
       +
                       raise RuntimeError(f"duplicate options directive {k} in line {lnum}")

     

       71
       71
       +
                   items[k] = v

     

       72
       72
       +
               try:

     

       73
       73
       +
                   id_prefix = items.pop('id-prefix')

     

       74
       74
       +
                   varlist_id = items.pop('list-id')

     

       75
       75
       +
                   source = items.pop('source')

     

       76
       76
       +
               except KeyError as e:

     

       77
       77
       +
                   raise RuntimeError(f"options directive {e} missing in block at line {token.map[0] + 1}")

     

       78
       78
       +
               if items.keys():

     

       79
       79
       +
                   raise RuntimeError(

     

       80
       80
       +
                       f"unsupported options directives in block at line {token.map[0] + 1}",

     

       81
       81
       +
                       " ".join(items.keys()))

     

       82
       82
       +
       

     

       83
       83
       +
               try:

     

       84
       84
       +
                   with open(self._base_paths[-1].parent / source, 'r') as f:

     

       85
       85
       +
                       token.meta['id-prefix'] = id_prefix

     

       86
       86
       +
                       token.meta['list-id'] = varlist_id

     

       87
       87
       +
                       token.meta['source'] = json.load(f)

     

       88
       88
       +
               except Exception as e:

     

       89
       89
       +
                   raise RuntimeError(f"processing options block in line {token.map[0] + 1}") from e

     

       16
       90
        
       

     

       17
       91
        
       class ManualDocBookRenderer(DocBookRenderer):

     

       18
       92
        
           _toplevel_tag: str

     
···

       113
       187
        
               info = f" language={quoteattr(token.info)}" if token.info != "" else ""

     

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

     

       115
       189
        
       

     

       116
       116
       -
       class DocBookConverter(Converter[ManualDocBookRenderer]):

     

       117
       117
       -
           _base_paths: list[Path]

     

       118
       118
       -
       

     

       190
       190
       +
       class DocBookConverter(BaseConverter[ManualDocBookRenderer]):

     

       119
       191
        
           def __init__(self, manpage_urls: Mapping[str, str], revision: str):

     

       120
       192
        
               super().__init__()

     

       121
       193
        
               self._renderer = ManualDocBookRenderer('book', revision, manpage_urls)

     

       122
       122
       -
       

     

       123
       123
       -
           def convert(self, file: Path) -> str:

     

       124
       124
       -
               self._base_paths = [ file ]

     

       125
       125
       -
               try:

     

       126
       126
       -
                   with open(file, 'r') as f:

     

       127
       127
       -
                       return self._render(f.read())

     

       128
       128
       -
               except Exception as e:

     

       129
       129
       -
                   raise RuntimeError(f"failed to render manual {file}") from e

     

       130
       130
       -
       

     

       131
       131
       -
           def _parse(self, src: str) -> list[Token]:

     

       132
       132
       -
               tokens = super()._parse(src)

     

       133
       133
       -
               for token in tokens:

     

       134
       134
       -
                   if token.type != "fence" or not token.info.startswith("{=include=} "):

     

       135
       135
       -
                       continue

     

       136
       136
       -
                   typ = token.info[12:].strip()

     

       137
       137
       -
                   if typ == 'options':

     

       138
       138
       -
                       token.type = 'included_options'

     

       139
       139
       -
                       self._parse_options(token)

     

       140
       140
       -
                   elif typ in [ 'sections', 'chapters', 'preface', 'parts', 'appendix' ]:

     

       141
       141
       -
                       token.type = 'included_' + typ

     

       142
       142
       -
                       self._parse_included_blocks(token)

     

       143
       143
       -
                   else:

     

       144
       144
       -
                       raise RuntimeError(f"unsupported structural include type '{typ}'")

     

       145
       145
       -
               return tokens

     

       146
       146
       -
       

     

       147
       147
       -
           def _parse_included_blocks(self, token: Token) -> None:

     

       148
       148
       -
               assert token.map

     

       149
       149
       -
               included = token.meta['included'] = []

     

       150
       150
       -
               for (lnum, line) in enumerate(token.content.splitlines(), token.map[0] + 2):

     

       151
       151
       -
                   line = line.strip()

     

       152
       152
       -
                   path = self._base_paths[-1].parent / line

     

       153
       153
       -
                   if path in self._base_paths:

     

       154
       154
       -
                       raise RuntimeError(f"circular include found in line {lnum}")

     

       155
       155
       -
                   try:

     

       156
       156
       -
                       self._base_paths.append(path)

     

       157
       157
       -
                       with open(path, 'r') as f:

     

       158
       158
       -
                           tokens = self._parse(f.read())

     

       159
       159
       -
                           included.append((tokens, path))

     

       160
       160
       -
                       self._base_paths.pop()

     

       161
       161
       -
                   except Exception as e:

     

       162
       162
       -
                       raise RuntimeError(f"processing included file {path} from line {lnum}") from e

     

       163
       163
       -
       

     

       164
       164
       -
           def _parse_options(self, token: Token) -> None:

     

       165
       165
       -
               assert token.map

     

       166
       166
       -
       

     

       167
       167
       -
               items = {}

     

       168
       168
       -
               for (lnum, line) in enumerate(token.content.splitlines(), token.map[0] + 2):

     

       169
       169
       -
                   if len(args := line.split(":", 1)) != 2:

     

       170
       170
       -
                       raise RuntimeError(f"options directive with no argument in line {lnum}")

     

       171
       171
       -
                   (k, v) = (args[0].strip(), args[1].strip())

     

       172
       172
       -
                   if k in items:

     

       173
       173
       -
                       raise RuntimeError(f"duplicate options directive {k} in line {lnum}")

     

       174
       174
       -
                   items[k] = v

     

       175
       175
       -
               try:

     

       176
       176
       -
                   id_prefix = items.pop('id-prefix')

     

       177
       177
       -
                   varlist_id = items.pop('list-id')

     

       178
       178
       -
                   source = items.pop('source')

     

       179
       179
       -
               except KeyError as e:

     

       180
       180
       -
                   raise RuntimeError(f"options directive {e} missing in block at line {token.map[0] + 1}")

     

       181
       181
       -
               if items.keys():

     

       182
       182
       -
                   raise RuntimeError(

     

       183
       183
       -
                       f"unsupported options directives in block at line {token.map[0] + 1}",

     

       184
       184
       -
                       " ".join(items.keys()))

     

       185
       185
       -
       

     

       186
       186
       -
               try:

     

       187
       187
       -
                   with open(self._base_paths[-1].parent / source, 'r') as f:

     

       188
       188
       -
                       token.meta['id-prefix'] = id_prefix

     

       189
       189
       -
                       token.meta['list-id'] = varlist_id

     

       190
       190
       -
                       token.meta['source'] = json.load(f)

     

       191
       191
       -
               except Exception as e:

     

       192
       192
       -
                   raise RuntimeError(f"processing options block in line {token.map[0] + 1}") from e

     

       193
       194
        
       

     

       194
       195
        
       

     

       195
       196