Skip to main content

Define Gradio using type hints

Project description

FnGradio

This is an experimental library that allows you to define Gradio apps using type hints.

Install

pip install fngradio

Simple Example

Instead of (where type hints are not used for the interface):

import gradio as gr


def add_int_numbers(a: int, b: int) -> int:
    """
    Add two int numbers
    """
    return a + b


demo = gr.Interface(
    fn=add_int_numbers,
    api_name="add_int_numbers",
    inputs=[
        gr.Number(precision=0),
        gr.Number(precision=0)
    ],
    outputs=[gr.Number(precision=0)],
)

if __name__ == '__main__':
    demo.launch(share=False)

You can define the Gradio interface around by just adding the fngr.interface annotation which will create inputs and outputs based on the type hints:

import fngradio as fngr


@fngr.interface
def add_int_numbers(a: int, b: int) -> int:
    """
    Add two int numbers
    """
    return a + b


if __name__ == '__main__':
    add_int_numbers.launch(share=False)

Slider for Integer With Range

You can use pydantic's Field annotation to provide additional information. If ge and le are defined for an integer, then it will use the Gradio's Slider component.

from typing import Annotated
from pydantic import Field
import fngradio as fngr


@fngr.interface
def add_int_numbers_with_sliders(
    a: Annotated[int, Field(title="First value", ge=0, le=100)] = 50,
    b: Annotated[int, Field(title="Second value", ge=0, le=100)] = 50
) -> int:
    """
    Add two int numbers
    """
    return a + b

Specify Component in Type Annotation

You can also specify the Gradio Component to use by adding it to the type annotation:

from typing import Annotated
import gradio as gr
import fngradio as fngr

@fngr.interface
def to_upper_case(
    s: Annotated[str, gr.TextArea(label="text", value="Hello")]
) -> Annotated[str, gr.TextArea()]:
    """
    Converts text to upper case
    """
    return s.upper()

Tabbed Interface

A tabbed interface can be useful when you have multiple tools (e.g. multiple MCP tools).

Instead of:

demo = gr.TabbedInterface(
    interface_list=[
        add_int_numbers,
        to_upper_case
    ],
    tab_names=["add_int_numbers", "to_upper_case"]
)

You could use the fngr.tabbed_interface:

demo = fngr.tabbed_interface([
    add_int_numbers,
    to_upper_case
])

The main advantage is that it will try to infer the names from the interface.

Project details


Download files

Download the file for your platform. If you're not sure which to choose, learn more about installing packages.

Source Distribution

fngradio-0.0.2.tar.gz (4.4 kB view details)

Uploaded Source

Built Distribution

If you're not sure about the file name format, learn more about wheel file names.

fngradio-0.0.2-py3-none-any.whl (4.0 kB view details)

Uploaded Python 3

File details

Details for the file fngradio-0.0.2.tar.gz.

File metadata

  • Download URL: fngradio-0.0.2.tar.gz
  • Upload date:
  • Size: 4.4 kB
  • Tags: Source
  • Uploaded using Trusted Publishing? Yes
  • Uploaded via: twine/6.1.0 CPython/3.12.9

File hashes

Hashes for fngradio-0.0.2.tar.gz
Algorithm Hash digest
SHA256 a3e37ab0ece16069f0101abb1e7b7d94f9d1a55cd3cc4f22ee522ba618bb994d
MD5 e60e148fd4e57640181be72aa983fdcd
BLAKE2b-256 4ac6704337b0385f2d79ef2a36962762b7515ab7db06764d26d62f6c198636fe

See more details on using hashes here.

Provenance

The following attestation bundles were made for fngradio-0.0.2.tar.gz:

Publisher: ci.yml on de-code/fngradio

Attestations: Values shown here reflect the state when the release was signed and may no longer be current.

File details

Details for the file fngradio-0.0.2-py3-none-any.whl.

File metadata

  • Download URL: fngradio-0.0.2-py3-none-any.whl
  • Upload date:
  • Size: 4.0 kB
  • Tags: Python 3
  • Uploaded using Trusted Publishing? Yes
  • Uploaded via: twine/6.1.0 CPython/3.12.9

File hashes

Hashes for fngradio-0.0.2-py3-none-any.whl
Algorithm Hash digest
SHA256 2f14579e325133da72fd160c1e35fe7b655abdfb67e9b80bc1df260ed3291bfd
MD5 a7fb574470da42b3f8adcb9532dbf817
BLAKE2b-256 811ba9b43ac0da1f6125d500e5586264f6e0f384b2d6d3239c84d0b1be0efc21

See more details on using hashes here.

Provenance

The following attestation bundles were made for fngradio-0.0.2-py3-none-any.whl:

Publisher: ci.yml on de-code/fngradio

Attestations: Values shown here reflect the state when the release was signed and may no longer be current.

Supported by

AWS Cloud computing and Security Sponsor Datadog Monitoring Depot Continuous Integration Fastly CDN Google Download Analytics Pingdom Monitoring Sentry Error logging StatusPage Status page