TextOutput¶
Bases: OutputElement
value: str
property
¶
Returns:
Type | Description |
---|---|
str
|
The path or list of paths for the output file(s): if paths are not absolute, then |
str
|
they are considered relative to the data output folder. See |
str
|
Best Practices With Data for more information. |
__init__(key, value, label=None, tags=None, truncate_at=50000)
¶
A text file preview.
Parameters:
Name | Type | Description | Default |
---|---|---|---|
key |
str
|
ID of the element. It must be unique as it is the key used to story data in
Project(), otherwise it will lead to conflicts at runtime in both execution and
Streamlit modes. The key will be transformed into snake case and slugified to avoid
any special character or whitespace. Note that an ID cannot start with |
required |
value |
str
|
Path to the output CSV file which must have a |
required |
label |
Optional[str]
|
Typically to be used by Streamlit for display purpose only. If not defined, it
will default to the |
None
|
tags |
Optional[List[str]]
|
Optional meta-data information about the expected file. This information is only used when the JSON output attributes are written to the output manifest. |
None
|
truncate_at |
int
|
Truncate the preview at the specified number of characters. |
50000
|
Raises:
Type | Description |
---|---|
ValueError
|
if the |
AttributeError
|
if one the |
Example
from onecode import text_output, Mode, Project
Project().mode = Mode.CONSOLE
widget = text_output(
key="TextOutput",
value="/path/to/file.txt",
label="My TextOutput",
tags=['Text'],
truncate_at=1000
)
print(widget)
"/path/to/file.txt"
_validate(value)
¶
No validation is performed.
streamlit()
staticmethod
¶
Returns:
Type | Description |
---|---|
str
|
The Streamlit code to preview text of a file. |