Merge pull request #237669 from l0b0/ruff-fix-nixos-render-docs

nixos-render-docs: De-lint using `ruff --fix`

authored by

pennae and committed by
GitHub
a58b0cf8 69f6fb32

+18 -28
+1 -4
pkgs/tools/nix/nixos-render-docs/src/nixos_render_docs/__init__.py
··· 1 import argparse 2 - import os 3 import sys 4 import textwrap 5 import traceback 6 from io import StringIO 7 from pprint import pprint 8 - from typing import Any, Dict 9 10 - from .md import Converter 11 from . import manual 12 from . import options 13 from . import parallel ··· 26 for arg in args: 27 pprint(arg, stream=buf) 28 if extra_info := buf.getvalue(): 29 - print(f"\x1b[1;34mextra info:\x1b[0m", file=sys.stderr) 30 print(textwrap.indent(extra_info, "\t"), file=sys.stderr, end="") 31 else: 32 print(e)
··· 1 import argparse 2 import sys 3 import textwrap 4 import traceback 5 from io import StringIO 6 from pprint import pprint 7 8 from . import manual 9 from . import options 10 from . import parallel ··· 23 for arg in args: 24 pprint(arg, stream=buf) 25 if extra_info := buf.getvalue(): 26 + print("\x1b[1;34mextra info:\x1b[0m", file=sys.stderr) 27 print(textwrap.indent(extra_info, "\t"), file=sys.stderr, end="") 28 else: 29 print(e)
+2 -2
pkgs/tools/nix/nixos-render-docs/src/nixos_render_docs/asciidoc.py
··· 1 from collections.abc import Mapping, Sequence 2 from dataclasses import dataclass 3 - from typing import Any, cast, Optional 4 from urllib.parse import quote 5 6 from .md import Renderer ··· 104 def hardbreak(self, token: Token, tokens: Sequence[Token], i: int) -> str: 105 return " +\n" 106 def softbreak(self, token: Token, tokens: Sequence[Token], i: int) -> str: 107 - return f" " 108 def code_inline(self, token: Token, tokens: Sequence[Token], i: int) -> str: 109 self._parstack[-1].continuing = True 110 return f"``{asciidoc_escape(token.content)}``"
··· 1 from collections.abc import Mapping, Sequence 2 from dataclasses import dataclass 3 + from typing import cast 4 from urllib.parse import quote 5 6 from .md import Renderer ··· 104 def hardbreak(self, token: Token, tokens: Sequence[Token], i: int) -> str: 105 return " +\n" 106 def softbreak(self, token: Token, tokens: Sequence[Token], i: int) -> str: 107 + return " " 108 def code_inline(self, token: Token, tokens: Sequence[Token], i: int) -> str: 109 self._parstack[-1].continuing = True 110 return f"``{asciidoc_escape(token.content)}``"
+1 -1
pkgs/tools/nix/nixos-render-docs/src/nixos_render_docs/commonmark.py
··· 1 from collections.abc import Mapping, Sequence 2 from dataclasses import dataclass 3 - from typing import Any, cast, Optional 4 5 from .md import md_escape, md_make_code, Renderer 6
··· 1 from collections.abc import Mapping, Sequence 2 from dataclasses import dataclass 3 + from typing import cast, Optional 4 5 from .md import md_escape, md_make_code, Renderer 6
+2 -3
pkgs/tools/nix/nixos-render-docs/src/nixos_render_docs/docbook.py
··· 1 from collections.abc import Mapping, Sequence 2 - from typing import Any, cast, Optional, NamedTuple 3 4 - import markdown_it 5 from markdown_it.token import Token 6 from xml.sax.saxutils import escape, quoteattr 7 ··· 197 spacing = ' spacing="compact"' if token.meta.get('compact', False) else '' 198 return f"<orderedlist{start}{spacing}>" 199 def ordered_list_close(self, token: Token, tokens: Sequence[Token], i: int) -> str: 200 - return f"</orderedlist>" 201 def heading_open(self, token: Token, tokens: Sequence[Token], i: int) -> str: 202 hlevel = int(token.tag[1:]) 203 result = self._close_headings(hlevel)
··· 1 from collections.abc import Mapping, Sequence 2 + from typing import cast, Optional, NamedTuple 3 4 from markdown_it.token import Token 5 from xml.sax.saxutils import escape, quoteattr 6 ··· 196 spacing = ' spacing="compact"' if token.meta.get('compact', False) else '' 197 return f"<orderedlist{start}{spacing}>" 198 def ordered_list_close(self, token: Token, tokens: Sequence[Token], i: int) -> str: 199 + return "</orderedlist>" 200 def heading_open(self, token: Token, tokens: Sequence[Token], i: int) -> str: 201 hlevel = int(token.tag[1:]) 202 result = self._close_headings(hlevel)
+1 -1
pkgs/tools/nix/nixos-render-docs/src/nixos_render_docs/html.py
··· 211 self._ordered_list_nesting += 1 212 return f'<div class="orderedlist"><ol class="orderedlist {extra}" {start} type="{style}">' 213 def ordered_list_close(self, token: Token, tokens: Sequence[Token], i: int) -> str: 214 - self._ordered_list_nesting -= 1; 215 return "</ol></div>" 216 def example_open(self, token: Token, tokens: Sequence[Token], i: int) -> str: 217 if id := cast(str, token.attrs.get('id', '')):
··· 211 self._ordered_list_nesting += 1 212 return f'<div class="orderedlist"><ol class="orderedlist {extra}" {start} type="{style}">' 213 def ordered_list_close(self, token: Token, tokens: Sequence[Token], i: int) -> str: 214 + self._ordered_list_nesting -= 1 215 return "</ol></div>" 216 def example_open(self, token: Token, tokens: Sequence[Token], i: int) -> str: 217 if id := cast(str, token.attrs.get('id', '')):
+1 -2
pkgs/tools/nix/nixos-render-docs/src/nixos_render_docs/manpage.py
··· 1 from collections.abc import Mapping, Sequence 2 from dataclasses import dataclass 3 - from typing import Any, cast, Iterable, Optional 4 5 import re 6 7 - import markdown_it 8 from markdown_it.token import Token 9 10 from .md import Renderer
··· 1 from collections.abc import Mapping, Sequence 2 from dataclasses import dataclass 3 + from typing import cast, Iterable, Optional 4 5 import re 6 7 from markdown_it.token import Token 8 9 from .md import Renderer
+3 -5
pkgs/tools/nix/nixos-render-docs/src/nixos_render_docs/manual.py
··· 7 from abc import abstractmethod 8 from collections.abc import Mapping, Sequence 9 from pathlib import Path 10 - from typing import Any, cast, ClassVar, Generic, get_args, NamedTuple, Optional, Union 11 12 - import markdown_it 13 from markdown_it.token import Token 14 15 from . import md, options ··· 17 from .html import HTMLRenderer, UnresolvedXrefError 18 from .manual_structure import check_structure, FragmentType, is_include, TocEntry, TocEntryType, XrefTarget 19 from .md import Converter, Renderer 20 - from .utils import Freezeable 21 22 class BaseConverter(Converter[md.TR], Generic[md.TR]): 23 # per-converter configuration for ns:arg=value arguments to include blocks, following ··· 519 # we use blender-style //path to denote paths relative to the origin file 520 # (usually index.html). this makes everything a lot easier and clearer. 521 if not into.startswith("//") or '/' in into[2:]: 522 - raise RuntimeError(f"html:into-file must be a relative-to-origin //filename", into) 523 into = token.meta['include-args']['into-file'] = into[2:] 524 if into in self._redirection_targets: 525 raise RuntimeError(f"redirection target {into} in line {token.map[0] + 1} is already in use") ··· 617 for item in xref_queue: 618 try: 619 target = item if isinstance(item, XrefTarget) else self._render_xref(*item) 620 - except UnresolvedXrefError as e: 621 if failed: 622 raise 623 deferred.append(item)
··· 7 from abc import abstractmethod 8 from collections.abc import Mapping, Sequence 9 from pathlib import Path 10 + from typing import Any, cast, ClassVar, Generic, get_args, NamedTuple 11 12 from markdown_it.token import Token 13 14 from . import md, options ··· 16 from .html import HTMLRenderer, UnresolvedXrefError 17 from .manual_structure import check_structure, FragmentType, is_include, TocEntry, TocEntryType, XrefTarget 18 from .md import Converter, Renderer 19 20 class BaseConverter(Converter[md.TR], Generic[md.TR]): 21 # per-converter configuration for ns:arg=value arguments to include blocks, following ··· 517 # we use blender-style //path to denote paths relative to the origin file 518 # (usually index.html). this makes everything a lot easier and clearer. 519 if not into.startswith("//") or '/' in into[2:]: 520 + raise RuntimeError("html:into-file must be a relative-to-origin //filename", into) 521 into = token.meta['include-args']['into-file'] = into[2:] 522 if into in self._redirection_targets: 523 raise RuntimeError(f"redirection target {into} in line {token.map[0] + 1} is already in use") ··· 615 for item in xref_queue: 616 try: 617 target = item if isinstance(item, XrefTarget) else self._render_xref(*item) 618 + except UnresolvedXrefError: 619 if failed: 620 raise 621 deferred.append(item)
+1 -1
pkgs/tools/nix/nixos-render-docs/src/nixos_render_docs/md.py
··· 1 from abc import ABC 2 from collections.abc import Mapping, MutableMapping, Sequence 3 - from typing import Any, Callable, cast, Generic, get_args, Iterable, Literal, NoReturn, Optional, TypeVar 4 5 import dataclasses 6 import re
··· 1 from abc import ABC 2 from collections.abc import Mapping, MutableMapping, Sequence 3 + from typing import Any, cast, Generic, get_args, Iterable, Literal, NoReturn, Optional, TypeVar 4 5 import dataclasses 6 import re
+1 -2
pkgs/tools/nix/nixos-render-docs/src/nixos_render_docs/options.py
··· 11 from typing import Any, Generic, Optional 12 from urllib.parse import quote 13 14 - import markdown_it 15 16 from . import md 17 from . import parallel ··· 265 ' <title>Configuration Options</title>', 266 ] 267 result += [ 268 - f'<variablelist xmlns:xlink="http://www.w3.org/1999/xlink"', 269 ' xmlns:nixos="tag:nixos.org"', 270 ' xmlns="http://docbook.org/ns/docbook"', 271 f' xml:id="{self._varlist_id}">',
··· 11 from typing import Any, Generic, Optional 12 from urllib.parse import quote 13 14 15 from . import md 16 from . import parallel ··· 264 ' <title>Configuration Options</title>', 265 ] 266 result += [ 267 + '<variablelist xmlns:xlink="http://www.w3.org/1999/xlink"', 268 ' xmlns:nixos="tag:nixos.org"', 269 ' xmlns="http://docbook.org/ns/docbook"', 270 f' xml:id="{self._varlist_id}">',
+1 -1
pkgs/tools/nix/nixos-render-docs/src/nixos_render_docs/parallel.py
··· 4 5 import multiprocessing 6 7 - from typing import Any, Callable, ClassVar, Iterable, Optional, TypeVar 8 9 R = TypeVar('R') 10 S = TypeVar('S')
··· 4 5 import multiprocessing 6 7 + from typing import Any, Callable, Iterable, Optional, TypeVar 8 9 R = TypeVar('R') 10 S = TypeVar('S')
+1 -1
pkgs/tools/nix/nixos-render-docs/src/nixos_render_docs/types.py
··· 1 from collections.abc import Sequence 2 - from typing import Any, Callable, Optional, Tuple, NamedTuple 3 4 from markdown_it.token import Token 5
··· 1 from collections.abc import Sequence 2 + from typing import Callable, Optional, NamedTuple 3 4 from markdown_it.token import Token 5
+2 -3
pkgs/tools/nix/nixos-render-docs/src/tests/test_commonmark.py
··· 2 3 from sample_md import sample1 4 5 - from typing import Mapping, Optional 6 7 - import markdown_it 8 9 class Converter(nrd.md.Converter[nrd.commonmark.CommonMarkRenderer]): 10 def __init__(self, manpage_urls: Mapping[str, str]): ··· 27 28 def test_full() -> None: 29 c = Converter({ 'man(1)': 'http://example.org' }) 30 - assert c._render(sample1) == f"""\ 31 **Warning:** foo 32 33 **Note:** nested
··· 2 3 from sample_md import sample1 4 5 + from typing import Mapping 6 7 8 class Converter(nrd.md.Converter[nrd.commonmark.CommonMarkRenderer]): 9 def __init__(self, manpage_urls: Mapping[str, str]): ··· 26 27 def test_full() -> None: 28 c = Converter({ 'man(1)': 'http://example.org' }) 29 + assert c._render(sample1) == """\ 30 **Warning:** foo 31 32 **Note:** nested
+1 -2
pkgs/tools/nix/nixos-render-docs/src/tests/test_manpage.py
··· 2 3 from sample_md import sample1 4 5 - from typing import Mapping, Optional 6 7 - import markdown_it 8 9 class Converter(nrd.md.Converter[nrd.manpage.ManpageRenderer]): 10 def __init__(self, manpage_urls: Mapping[str, str], options_by_id: dict[str, str] = {}):
··· 2 3 from sample_md import sample1 4 5 + from typing import Mapping 6 7 8 class Converter(nrd.md.Converter[nrd.manpage.ManpageRenderer]): 9 def __init__(self, manpage_urls: Mapping[str, str], options_by_id: dict[str, str] = {}):