ickc/pantable

View on GitHub
src/pantable/table_to_codeblock.py

Summary

Maintainability
A
45 mins
Test Coverage
from __future__ import annotations

from typing import TYPE_CHECKING

from panflute.elements import Table

if TYPE_CHECKING:
    from typing import Optional

    from panflute.elements import Doc

from .ast import PanTable


def table_to_codeblock(
    element: Optional[Table] = None,
    doc: Optional[Doc] = None,
    format: str = 'csv',
    fancy_table: bool = False,
    include: str = '',
    csv_kwargs: Optional[dict] = None,
) -> Optional[PanTable]:
    """convert Table element and to csv table in code-block with class "table" in panflute AST"""
    if type(element) is Table:
        return (
            PanTable
            .from_panflute_ast(element)
            .to_pantablemarkdown()
            # no options chosen here to match historical behavior
            .to_pancodeblock(
                format=format,
                fancy_table=fancy_table,
                include=include,
                csv_kwargs=csv_kwargs,
            )
            .to_panflute_ast()
        )
    return None