Function markdownFromFile

markdown/core.py:505–531

Read Markdown text from a file or stream and write HTML output to a file or stream. This is a shortcut function which initializes an instance of [`Markdown`][markdown.Markdown], and calls the [`convertFile`][markdown.Markdown.convertFile] method rather than [`convert`][markdown.Mar

(**kwargs: Any)

def markdownFromFile(**kwargs: Any):
    """
    Read Markdown text from a file or stream and write HTML output to a file or stream.

    This is a shortcut function which initializes an instance of [`Markdown`][markdown.Markdown],
    and calls the [`convertFile`][markdown.Markdown.convertFile] method rather than
    [`convert`][markdown.Markdown.convert].

    Keyword arguments:
        input (str | BinaryIO): A file name or readable object.
        output (str | BinaryIO): A file name or writable object.
        encoding (str): Encoding of input and output.
        **kwargs: Any arguments accepted by the `Markdown` class.

    !!! warning
        The Python-Markdown library does ***not*** sanitize its HTML output.
        As `markdown.markdownFromFile` writes directly to the file system, there is no
        easy way to sanitize the output from Python code. Therefore, it is
        recommended that the `markdown.markdownFromFile` function not be used on input
        from an untrusted source.  For more information see [Sanitizing HTML
        Output](../../sanitization.md).

    """
    md = Markdown(**kwargs)
    md.convertFile(kwargs.get('input', None),
                   kwargs.get('output', None),
                   kwargs.get('encoding', None))