gradio-highlightedcode 0.0.4

A variant of the Code component that supports highlighting lines of code.

gradio_highlightedcode

A variant of the Code component that supports highlighting lines of code.

Installation

pip install gradio_highlightedcode

Usage

import time
import gradio as gr
from gradio_highlightedcode import HighlightedCode


example = HighlightedCode().example_inputs()

initial_value = """import random

def scramble_name(name):
    name_list = list(name)
"""

completion = """    random.shuffle(name_list)
    return ''.join(name_list)

# Example usage:
print(scramble_name("Python"))
"""

def generate_code():
    for i in range(len(completion)):
        time.sleep(0.03)
        yield HighlightedCode(initial_value + completion[:i], highlights=[(5, "rgb(255 254 213)")])

with gr.Blocks() as demo:
    code = HighlightedCode(initial_value, language="python")
    btn = gr.Button("Generate", variant="primary")
    btn.click(generate_code, outputs=code)

if __name__ == "__main__":
    demo.launch()

HighlightedCode

Initialization

name	type	default	description
value	str | tuple[str] | None	None	Default value to show in the code editor. If callable, the function will be called whenever the app loads to set the initial value of the component.
language	typing.Optional[ typing.Literal[ "python", "markdown", "json", "html", "css", "javascript", "typescript", "yaml", "dockerfile", "shell", "r", ] ][ "python" | "markdown" | "json" | "html" | "css" | "javascript" | "typescript" | "yaml" | "dockerfile" | "shell" | "r", None, ]	None	The language to display the code as. Supported languages listed in `gr.Code.languages`.
highlights	list[tuple[int, str]] | None	None	A list of tuples indicating lines to highlight. The first element of the tuple is the starting line number (1-indexed) and the second element is the highlight color (as a CSS hex string). The highlights are applied in order, with later highlights taking precedence over earlier ones.
every	float | None	None	If `value` is a callable, run the function 'every' number of seconds while the client connection is open. Has no effect otherwise. The event can be accessed (e.g. to cancel it) via this component's .load_event attribute.
lines	int	5	None
label	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.
interactive	bool | None	None	Whether user should be able to enter code or only view it.
show_label	bool | None	None	if True, will display label.
container	bool	True	If True, will place the component in a container - providing some extra padding around the border.
scale	int | None	None	relative width compared to adjacent Components in a Row. For example, if Component A has scale=2, and Component B has scale=1, A will be twice as wide as B. Should be an integer.
min_width	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.
visible	bool	True	If False, component will be hidden.
elem_id	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	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	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.

Events

name	description
change	Triggered when the value of the HighlightedCode changes either because of user input (e.g. a user types in a textbox) OR because of a function update (e.g. an image receives a value from the output of an event trigger). See .input() for a listener that is only triggered by user input.
input	This listener is triggered when the user changes the value of the HighlightedCode.
focus	This listener is triggered when the HighlightedCode is focused.
blur	This listener is triggered when the HighlightedCode is unfocused/blurred.

User function

The impact on the users predict function varies depending on whether the component is used as an input or output for an event (or both).

• When used as an Input, the component only impacts the input signature of the user function.
• When used as an output, the component only impacts the return signature of the user function.

The code snippet below is accurate in cases where the component is used as both an input and an output.

• As output: Is passed, passes the code entered as a str.
• As input: Should return, expects a str of code or a single-element tuple: (filepath,) with the str path to a file containing the code.

def predict(
    value: str | None
) -> tuple[str] | str | None:
    return value