# `gradio_log`
A Log component for Gradio which can easily show some log file in the interface.
## Installation
```bash
pip install gradio_log
```
## Usage
```python
from pathlib import Path
import logging
import gradio as gr
import tempfile
from gradio_log import Log
import logging
class CustomFormatter(logging.Formatter):
green = "\x1b[32;20m"
blue = "\x1b[34;20m"
yellow = "\x1b[33;20m"
red = "\x1b[31;20m"
bold_red = "\x1b[31;1m"
reset = "\x1b[0m"
format = "%(asctime)s - %(levelname)s - %(message)s (%(filename)s:%(lineno)d)"
FORMATS = {
logging.DEBUG: blue + format + reset,
logging.INFO: green + format + reset,
logging.WARNING: yellow + format + reset,
logging.ERROR: red + format + reset,
logging.CRITICAL: bold_red + format + reset,
}
def format(self, record):
log_fmt = self.FORMATS.get(record.levelno)
formatter = logging.Formatter(log_fmt)
return formatter.format(record)
formatter = CustomFormatter()
log_file = "/tmp/gradio_log.txt"
Path(log_file).touch()
ch = logging.FileHandler(log_file)
ch.setLevel(logging.DEBUG)
ch.setFormatter(formatter)
logger = logging.getLogger("gradio_log")
logger.setLevel(logging.DEBUG)
for handler in logger.handlers:
logger.removeHandler(handler)
logger.addHandler(ch)
logger.info("The logs will be displayed in here.")
def create_log_handler(level):
def l(text):
getattr(logger, level)(text)
return l
with gr.Blocks() as demo:
text = gr.Textbox(label="Enter text to write to log file")
with gr.Row():
for l in ["debug", "info", "warning", "error", "critical"]:
button = gr.Button(f"log as {l}")
button.click(fn=create_log_handler(l), inputs=text)
Log(log_file)
if __name__ == "__main__":
demo.launch()
```
## `Log`
### Initialization
name | type | default | description |
---|---|---|---|
log_file |
```python str ``` | None |
the log file path to read from. |
tail |
```python int ``` | 100 |
from the end of the file, the number of lines to start read from. |
dark |
```python bool ``` | False |
if True, will render the component in dark mode. |
label |
```python str | None ``` | None |
The label for this component. Appears above the component and is also used as the header if there are a table of examples for this component. If None and used in a `gr.Interface`, the label will be the name of the parameter this component is assigned to. |
info |
```python str | None ``` | None |
additional component description. |
every |
```python float ``` | 0.3 |
New log pulling interval. |
show_label |
```python bool | None ``` | None |
if True, will display label. |
container |
```python bool ``` | True |
If True, will place the component in a container - providing some extra padding around the border. |
scale |
```python int | None ``` | None |
relative size compared to adjacent Components. For example if Components A and B are in a Row, and A has scale=2, and B has scale=1, A will be twice as wide as B. Should be an integer. scale applies in Rows, and to top-level Components in Blocks where fill_height=True. |
min_width |
```python int ``` | 160 |
minimum pixel width, will wrap if not sufficient screen space to satisfy this value. If a certain scale value results in this Component being narrower than min_width, the min_width parameter will be respected first. |
interactive |
```python bool | None ``` | None |
if True, will be rendered as an editable textbox; if False, editing will be disabled. If not provided, this is inferred based on whether the component is used as an input or output. |
visible |
```python bool ``` | True |
If False, component will be hidden. |
elem_id |
```python str | None ``` | None |
An optional string that is assigned as the id of this component in the HTML DOM. Can be used for targeting CSS styles. |
elem_classes |
```python list[str] | str | None ``` | None |
An optional list of strings that are assigned as the classes of this component in the HTML DOM. Can be used for targeting CSS styles. |
render |
```python bool ``` | True |
If False, component will not render be rendered in the Blocks context. Should be used if the intention is to assign event listeners now but render the component later. |