Skip to content

Types

Download

Bases: OutputParamType, ClickPath

A class that inherits from OutputParamType and ClickPath. It represents a download parameter type.

Source code in src/guigaga/types.py 
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
class Download(OutputParamType, ClickPath):
    """
    A class that inherits from OutputParamType and ClickPath. It represents a download parameter type.
    """
    def __init__(self, filename, *args, **kwargs):
        """
        Initializes a Download instance.

        Args:
          filename: The name of the file to download.
          *args: Variable length argument list.
          **kwargs: Arbitrary keyword arguments.
        """
        super().__init__(*args, **kwargs)
        self.value = filename

    def render(self, schema: OptionSchema | ArgumentSchema) -> Component:
        """
        Renders the download component.

        Args:
          schema (OptionSchema | ArgumentSchema): The schema to render.

        Returns:
          Component: The rendered component.
        """
        return File(label=schema.name)

__init__(filename, *args, **kwargs)

Initializes a Download instance.

Parameters:

Name Type Description Default
filename

The name of the file to download.

 required
*args

Variable length argument list.

 ()
**kwargs

Arbitrary keyword arguments.

 {}
Source code in src/guigaga/types.py 
118
119
120
121
122
123
124
125
126
127
128
def __init__(self, filename, *args, **kwargs):
    """
    Initializes a Download instance.

    Args:
      filename: The name of the file to download.
      *args: Variable length argument list.
      **kwargs: Arbitrary keyword arguments.
    """
    super().__init__(*args, **kwargs)
    self.value = filename

render(schema)

Renders the download component.

Parameters:

Name Type Description Default
schema OptionSchema | ArgumentSchema

The schema to render.

 required

Returns:

Name Type Description
Component Component

The rendered component.
Source code in src/guigaga/types.py 
130
131
132
133
134
135
136
137
138
139
140
def render(self, schema: OptionSchema | ArgumentSchema) -> Component:
    """
    Renders the download component.

    Args:
      schema (OptionSchema | ArgumentSchema): The schema to render.

    Returns:
      Component: The rendered component.
    """
    return File(label=schema.name)

FileExplorer

Bases: InputParamType, ClickPath

A class that inherits from InputParamType and ClickPath. It represents a file explorer parameter type.

Source code in src/guigaga/types.py 
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
class FileExplorer(InputParamType, ClickPath):
    """
    A class that inherits from InputParamType and ClickPath. It represents a file explorer parameter type.
    """
    def __init__(self, *args, **kwargs):
        """
        Initializes a FileExplorer instance.

        Args:
          *args: Variable length argument list.
          **kwargs: Arbitrary keyword arguments.
        """
        super().__init__(*args, **kwargs)

    def render(self, schema: OptionSchema | ArgumentSchema) -> Component:
        """
        Renders the file explorer component.

        Args:
          schema (OptionSchema | ArgumentSchema): The schema to render.

        Returns:
          Component: The rendered component.
        """
        return GradioFileExplorer(label=schema.name, file_count="single", value=schema.default)

__init__(*args, **kwargs)

Initializes a FileExplorer instance.

Parameters:

Name Type Description Default
*args

Variable length argument list.

 ()
**kwargs

Arbitrary keyword arguments.

 {}
Source code in src/guigaga/types.py 
147
148
149
150
151
152
153
154
155
def __init__(self, *args, **kwargs):
    """
    Initializes a FileExplorer instance.

    Args:
      *args: Variable length argument list.
      **kwargs: Arbitrary keyword arguments.
    """
    super().__init__(*args, **kwargs)

render(schema)

Renders the file explorer component.

Parameters:

Name Type Description Default
schema OptionSchema | ArgumentSchema

The schema to render.

 required

Returns:

Name Type Description
Component Component

The rendered component.
Source code in src/guigaga/types.py 
157
158
159
160
161
162
163
164
165
166
167
def render(self, schema: OptionSchema | ArgumentSchema) -> Component:
    """
    Renders the file explorer component.

    Args:
      schema (OptionSchema | ArgumentSchema): The schema to render.

    Returns:
      Component: The rendered component.
    """
    return GradioFileExplorer(label=schema.name, file_count="single", value=schema.default)

FilePath

Bases: File

A class that inherits from File. It represents a file path.

Source code in src/guigaga/types.py 
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
class FilePath(File):
    """
    A class that inherits from File. It represents a file path.
    """
    def __init__(self, *args, **kwargs):
        """
        Initializes a FilePath instance.

        Args:
          *args: Variable length argument list.
          **kwargs: Arbitrary keyword arguments.
        """
        super().__init__(*args, **kwargs)

    def _process_single_file(self, f) -> pathlib.Path | bytes:
        """
        Processes a single file.

        Args:
          f: The file to process.

        Returns:
          pathlib.Path | bytes: The processed file.

        Raises:
          ValueError: If the file type is unknown.
        """
        file_name = f.path
        if self.type == "filepath":
            file = tempfile.NamedTemporaryFile(delete=False, dir=self.GRADIO_CACHE)
            file.name = file_name
            return pathlib.Path(file_name)
        elif self.type == "binary":
            with open(file_name, "rb") as file_data:
                return file_data.read()
        else:
            raise ValueError(
                "Unknown type: "
                + str(type)
                + ". Please choose from: 'filepath', 'binary'."
            )

__init__(*args, **kwargs)

Initializes a FilePath instance.

Parameters:

Name Type Description Default
*args

Variable length argument list.

 ()
**kwargs

Arbitrary keyword arguments.

 {}
Source code in src/guigaga/types.py 
48
49
50
51
52
53
54
55
56
def __init__(self, *args, **kwargs):
    """
    Initializes a FilePath instance.

    Args:
      *args: Variable length argument list.
      **kwargs: Arbitrary keyword arguments.
    """
    super().__init__(*args, **kwargs)

InputParamType

Bases: ParamType

A class that inherits from ParamType. It represents an input parameter type.

Source code in src/guigaga/types.py 
31
32
33
34
35
class InputParamType(ParamType):
    """
    A class that inherits from ParamType. It represents an input parameter type.
    """
    pass

OutputParamType

Bases: ParamType

A class that inherits from ParamType. It represents an output parameter type.

Source code in src/guigaga/types.py 
37
38
39
40
41
class OutputParamType(ParamType):
    """
    A class that inherits from ParamType. It represents an output parameter type.
    """
    pass

ParamType

Bases: ClickParamType, ABC

An abstract base class that inherits from ClickParamType and ABC. It provides a blueprint for parameter types.

Source code in src/guigaga/types.py 
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
class ParamType(ClickParamType, ABC):
    """
    An abstract base class that inherits from ClickParamType and ABC. It provides a blueprint for parameter types.
    """
    @abstractmethod
    def render(self, schema: OptionSchema | ArgumentSchema) -> Component:
        """
        An abstract method that must be implemented by any class that inherits from ParamType.

        Args:
          schema (OptionSchema | ArgumentSchema): The schema to render.

        Returns:
          Component: The rendered component.
        """
        pass

render(schema) abstractmethod

An abstract method that must be implemented by any class that inherits from ParamType.

Parameters:

Name Type Description Default
schema OptionSchema | ArgumentSchema

The schema to render.

 required

Returns:

Name Type Description
Component Component

The rendered component.
Source code in src/guigaga/types.py 
18
19
20
21
22
23
24
25
26
27
28
29
@abstractmethod
def render(self, schema: OptionSchema | ArgumentSchema) -> Component:
    """
    An abstract method that must be implemented by any class that inherits from ParamType.

    Args:
      schema (OptionSchema | ArgumentSchema): The schema to render.

    Returns:
      Component: The rendered component.
    """
    pass

Upload

Bases: InputParamType, ClickPath

A class that inherits from InputParamType and ClickPath. It represents an upload parameter type.

Source code in src/guigaga/types.py 
 86
 87
 88
 89
 90
 91
 92
 93
 94
 95
 96
 97
 98
 99
100
101
102
103
104
105
106
107
108
109
110
111
class Upload(InputParamType, ClickPath):
    """
    A class that inherits from InputParamType and ClickPath. It represents an upload parameter type.
    """
    def __init__(self, *args, **kwargs):
        """
        Initializes an Upload instance.

        Args:
          *args: Variable length argument list.
          **kwargs: Arbitrary keyword arguments.
        """
        super().__init__(*args, **kwargs)


    def render(self, schema: OptionSchema | ArgumentSchema) -> Component:
        """
        Renders the upload component.

        Args:
          schema (OptionSchema | ArgumentSchema): The schema to render.

        Returns:
          Component: The rendered component.
        """
        return File(label=schema.name)

__init__(*args, **kwargs)

Initializes an Upload instance.

Parameters:

Name Type Description Default
*args

Variable length argument list.

 ()
**kwargs

Arbitrary keyword arguments.

 {}
Source code in src/guigaga/types.py 
90
91
92
93
94
95
96
97
98
def __init__(self, *args, **kwargs):
    """
    Initializes an Upload instance.

    Args:
      *args: Variable length argument list.
      **kwargs: Arbitrary keyword arguments.
    """
    super().__init__(*args, **kwargs)

render(schema)

Renders the upload component.

Parameters:

Name Type Description Default
schema OptionSchema | ArgumentSchema

The schema to render.

 required

Returns:

Name Type Description
Component Component

The rendered component.
Source code in src/guigaga/types.py 
101
102
103
104
105
106
107
108
109
110
111
def render(self, schema: OptionSchema | ArgumentSchema) -> Component:
    """
    Renders the upload component.

    Args:
      schema (OptionSchema | ArgumentSchema): The schema to render.

    Returns:
      Component: The rendered component.
    """
    return File(label=schema.name)