mirror of
https://github.com/OpenBB-finance/OpenBB.git
synced 2026-07-02 17:24:45 +08:00
9a30186174
* stash some changes * add more robust testing * mypy * point PR at V5 * introduce spec file * codespell * test fix * fix workflow environment setup * fix workflow environment setup * fix workflow environment setup * add pyyaml to dependencies * split lint jobs * fix workflow environment setup * fix workflow environment setup * workflow env setup * workflow env setup * clean up code comments * add auth hook entrypoints * codespell * add codegen feature * codespell * move _unpack into dispatchers for consistency with codegen packages * surface nested models in the response * fix missing coverage in CI * socrata updates * test fix * detect plotly output * add --include and --exclude flags from generate-extension command * cap test matrix at python 3.14 * no useless comments * platform controller command description split * merge URL overloads from path params * exclude none and unset from model dump --------- Co-authored-by: deeleeramone <> Co-authored-by: Copilot <copilot@github.com>
29 lines
712 B
Python
29 lines
712 B
Python
"""Base output adapter protocol."""
|
|
|
|
from typing import Any, Protocol
|
|
|
|
|
|
class OutputAdapter(Protocol):
|
|
"""Protocol for output adapters."""
|
|
|
|
def display(
|
|
self,
|
|
data: Any,
|
|
title: str = "",
|
|
export: bool = False,
|
|
chart: bool = False,
|
|
) -> None:
|
|
"""Display data in the adapter's format.
|
|
|
|
Parameters
|
|
----------
|
|
data : Any
|
|
Data to display - can be OBBject, DataFrame, Series, dict, list, scalar, etc.
|
|
title : str
|
|
Title for the output
|
|
export : bool
|
|
Whether we are exporting (don't display if True)
|
|
chart : bool
|
|
Whether to display as chart if available
|
|
"""
|