文件输出

用于输出到文件（或标准输出）的子命令的抽象基类。

class FileOutputSubcommand(parser: ArgumentParser)

抽象子命令，用于将应用程序输出为某种类型的文件。

after_write_file(args: Namespace, filename: str, doc: Document) → None

abstract file_contents(args: Namespace, doc: Document) → str | bytes | list[str] | list[bytes]

子类必须重写此方法以返回给定文档的输出文件内容。 子类方法返回不同类型： str: html, json bytes: SVG, png

Raises:

NotImplementedError –

filename_from_route(route: str, ext: str) → str

classmethod files_arg(output_type_name: str) → tuple[str | tuple[str, ...], Argument]

返回一个用于files的位置参数，以指定命令的文件输入。

子类应将其包含到它们的类 args 中。

Example

class Foo(FileOutputSubcommand):

    args = (

        FileOutputSubcommand.files_arg("FOO"),

        # more args for Foo

    ) + FileOutputSubcommand.other_args()

invoke(args: Namespace) → None

classmethod other_args() → tuple[tuple[str | tuple[str, ...], Argument], ...]

返回-o / --output的参数以指定输出应写入的位置，并为--args传递任何额外的命令行参数给子命令。

子类应该将这些附加到它们的类 args 中。

Example

class Foo(FileOutputSubcommand):

    args = (

        FileOutputSubcommand.files_arg("FOO"),

        # more args for Foo

    ) + FileOutputSubcommand.other_args()

write_file(args: Namespace, filename: str, doc: Document) → None