Skip to content

Modules

Top-level package for Fast Dash.

FastDash

Fast Dash app object containing automatically generated UI components and callbacks.

This is the primary Fast Dash data structure. Can be thought of as a wrapper around a flask WSGI application. It has in-built support for automated UI generation and sets all parameters required for Fast Dash app deployment.

Source code in fast_dash/fast_dash.py 
 33
 34
 35
 36
 37
 38
 39
 40
 41
 42
 43
 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
 85
 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
112
113
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
141
142
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
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
318
319
320
321
322
323
324
325
326
327
328
329
330
331
332
333
334
335
336
337
338
339
340
341
342
343
344
345
346
347
348
349
350
351
352
353
354
355
356
357
358
359
360
361
362
363
364
365
366
367
368
369
370
371
372
373
374
375
376
377
378
379
380
381
382
383
384
385
386
387
388
389
390
391
392
393
394
395
396
397
398
399
400
401
402
class FastDash:
    """
    Fast Dash app object containing automatically generated UI components and callbacks.

    This is the primary Fast Dash data structure. Can be thought of as a wrapper around
    a flask WSGI application. It has in-built support for automated UI generation and
    sets all parameters required for Fast Dash app deployment.
    """

    def __init__(
        self,
        callback_fn,
        layout="sidebar",
        mosaic=None,
        inputs=None,
        outputs=None,
        output_labels="infer",
        title=None,
        title_image_path=None,
        subheader=None,
        github_url=None,
        linkedin_url=None,
        twitter_url=None,
        navbar=True,
        footer=True,
        about=True,
        theme=None,
        update_live=False,
        port=8080,
        mode=None,
        minimal=False,
        disable_logs=False,
        scale_height=1,
        run_kwargs=dict(),
        **kwargs
    ):
        """
        Args:
            callback_fn (func): Python function that Fast Dash deploys. \
                This function guides the behavior of and interaction between input and output components.

            layout (str, optional): App layout style. Currently supports 'base' and 'sidebar'. Defaults to sidebar.

            mosaic (str): Mosaic array layout, if sidebar layout is selected.

            inputs (Fast component, list of Fast components, optional): Components to represent inputs of the callback function.\
                Defaults to None. If `None`, Fast Dash attempts to infer the best components from callback function's type \
                hints and default values. In the absence of type hints, default components are all `Text`.

            outputs (Fast component, list of Fast components, optional): Components to represent outputs of the callback function.\
                Defaults to None. If `None`, Fast Dash attempts to infer the best components from callback function's type hints.\
                In the absence of type hints, default components are all `Text`.

            output_labels(list of string labels or "infer" or None, optional): Labels given to the output components. If None, inputs are\
                set labeled integers starting at 1 (Output 1, Output 2, and so on). If "infer", labels are inferred from the function\
                signature. Defaults to infer.

            title (str, optional): Title given to the app. If `None`, function name (assumed to be in snake case)\
                is converted to title case. Defaults to None.

            title_image_path (str, optional): Path (local or URL) of the app title image. Defaults to None.

            subheader (str, optional): Subheader of the app, displayed below the title image and title\
                If `None`, Fast Dash tries to use the callback function's docstring instead. Defaults to None.


            github_url (str, optional): GitHub URL for branding. Displays a GitHub logo in the navbar, which takes users to the\
                specified URL. Defaults to None.

            linkedin_url (str, optional): LinkedIn URL for branding Displays a LinkedIn logo in the navbar, which takes users to the\
                specified URL. Defaults to None.

            twitter_url (str, optional): Twitter URL for branding. Displays a Twitter logo in the navbar, which takes users to the\
                specified URL. Defaults to None.

            navbar (bool, optional): Display navbar. Defaults to True.

            footer (bool, optional): Display footer. Defaults to True.

            about (Union[str, bool], optional): App description to display on clicking the `About` button. If True, content is inferred from\
                the docstring of the callback function. If string, content is used directly as markdown. \
                `About` is hidden if False or None. Defaults to True.

            theme (str, optional): Apply theme to the app.All available themes can be found at https://bootswatch.com/. Defaults to JOURNAL. 

            update_live (bool, optional): Enable hot reloading. If the number of inputs is 0, this is set to True automatically. Defaults to False.

            port (int, optional): Port to which the app should be deployed. Defaults to 8080.

            mode (str, optional): Mode in which to launch the app. Acceptable options are `None`, `jupyterlab`, `inline`, 'external`.\
                Defaults to None.

            minimal (bool, optional): Display minimal version by hiding navbar, title, title image, subheader and footer. Defaults to False.

            disable_logs (bool, optional): Hide app logs. Sets logger level to `ERROR`. Defaults to False.

            scale_height (float, optional): Height of the app container is enlarged as a multiple of this. Defaults to 1.

            run_kwargs (dict, optional): All values from this variable are passed to Dash's `.run` method.
        """

        self.callback_fn = callback_fn
        self.layout_pattern = layout
        self.mosaic = mosaic
        self.output_labels = output_labels

        if output_labels == "infer":
            self.output_labels = _infer_variable_names(callback_fn)

        self.inputs = (
            _infer_input_components(callback_fn)
            if inputs is None
            else inputs
            if isinstance(inputs, list)
            else [inputs]
        )
        self.outputs = _infer_output_components(
            callback_fn, outputs, self.output_labels
        )
        self.update_live = (
            True
            if (isinstance(self.inputs, list) and len(self.inputs) == 0)
            else update_live
        )
        self.mode = mode
        self.disable_logs = disable_logs
        self.scale_height = scale_height
        self.port = port
        self.run_kwargs = run_kwargs
        self.run_kwargs.update(dict(port=port))
        self.kwargs = kwargs

        if self.disable_logs is True:
            log = logging.getLogger("werkzeug")
            log.setLevel(logging.ERROR)

        else:
            log = logging.getLogger("werkzeug")
            log.setLevel(logging.DEBUG)

        if title is None:
            title = re.sub("[^0-9a-zA-Z]+", " ", callback_fn.__name__).title()

        self.title = title
        self.title_image_path = title_image_path
        self.subtitle = (
            subheader
            if subheader is not None
            else _parse_docstring_as_markdown(
                callback_fn, title=self.title, get_short=True
            )
        )
        self.github_url = github_url
        self.linkedin_url = linkedin_url
        self.twitter_url = twitter_url
        self.navbar = navbar
        self.footer = footer
        self.about = about
        self.theme = theme or "JOURNAL"
        self.minimal = minimal

        # Extract input tags
        self.input_tags = [inp.tag for inp in self.inputs]
        self.output_tags = [inp.tag for inp in self.outputs]

        # Assign IDs to components
        self.inputs_with_ids = _assign_ids_to_inputs(self.inputs, self.callback_fn)
        self.outputs_with_ids = _assign_ids_to_outputs(self.outputs)
        self.ack_mask = [
            False if (not hasattr(input_, "ack") or (input_.ack is None)) else True
            for input_ in self.inputs_with_ids
        ]

        # Default state of outputs
        self.output_state_default = [
            output_.placeholder if hasattr(output_, "placeholder") else None
            for output_ in self.outputs_with_ids
        ]

        self.output_state_blank = [None for output_ in self.outputs_with_ids]
        self.latest_output_state = self.output_state_blank

        # Define Flask server
        server = flask.Flask(__name__)
        external_stylesheets = [
            theme_mapper(self.theme),
            "https://use.fontawesome.com/releases/v5.9.0/css/all.css",
        ]

        source = dash.Dash
        # if self.mode is not None:
        #     try:
        #         from jupyter_dash import JupyterDash

        #         source = JupyterDash

        #     except ImportError as e:
        #         self.mode = None
        #         warnings.warn(str(e))
        #         warnings.warn("Ignoring mode argument")

        self.app = source(
            __name__,
            external_stylesheets=external_stylesheets,
            server=server,
            **self.kwargs
        )
        # Define app title
        self.app.title = self.title or ""

        # Intialize layout
        self.set_layout()

        # Register callbacks
        self.register_callback_fn()

        # Keep track of the number of clicks
        self.submit_clicks = 0
        self.reset_clicks = 0
        self.app_initialized = False

        # Allow easier access to Dash server
        self.server = self.app.server

    def run(self):
        self.app.run(**self.run_kwargs) if self.mode is None else self.app.run_server(
            jupyter_mode=self.mode, **self.run_kwargs
        )

    def run_server(self):
        self.app.run_server(
            **self.run_kwargs
        ) if self.mode is None else self.app.run_server(
            jupyter_mode=self.mode, **self.run_kwargs
        )

    def set_layout(self):
        if self.inputs is not None:
            input_groups = _make_input_groups(self.inputs_with_ids, self.update_live)

        if self.outputs is not None:
            output_groups = _make_output_groups(self.outputs_with_ids, self.update_live)

        layout_args = {
            "mosaic": self.mosaic,
            "inputs": input_groups,
            "outputs": output_groups,
            "title": self.title,
            "title_image_path": self.title_image_path,
            "subtitle": self.subtitle,
            "github_url": self.github_url,
            "linkedin_url": self.linkedin_url,
            "twitter_url": self.twitter_url,
            "navbar": self.navbar,
            "footer": self.footer,
            "about": self.about,
            "minimal": self.minimal,
            "scale_height": self.scale_height,
            "app": self,
        }

        if self.layout_pattern == "sidebar":
            app_layout = SidebarLayout(**layout_args)

        else:
            app_layout = BaseLayout(**layout_args)

        self.layout_object = app_layout
        self.app.layout = app_layout.generate_layout()

    def register_callback_fn(self):
        @self.app.callback(
            [
                Output(
                    component_id=output_.id,
                    component_property=output_.component_property,
                )
                for output_ in self.outputs_with_ids
            ]
            + [Output("error-notify-div", "children")],
            [
                Input(
                    component_id=input_.id, component_property=input_.component_property
                )
                for input_ in self.inputs_with_ids
            ]
            + [
                Input(component_id="reset_inputs", component_property="n_clicks"),
                Input(component_id="submit_inputs", component_property="n_clicks"),
            ],
            prevent_initial_callback=True,
        )
        def process_input(*args):
            if (
                ctx.triggered_id not in ["submit_inputs", "reset_inputs"]
                and self.update_live is False
            ):
                raise PreventUpdate

            default_notification = None

            try:
                inputs = _transform_inputs(args[:-2], self.input_tags)

                if ctx.triggered_id == "submit_inputs" or (
                    self.update_live is True and None not in args
                ):
                    self.app_initialized = True

                    output_state = self.callback_fn(*inputs)

                    if isinstance(output_state, tuple):
                        self.output_state = list(output_state)

                    else:
                        self.output_state = [output_state]

                    # Transform outputs to fit in the desired components
                    self.output_state = _transform_outputs(
                        self.output_state, self.output_tags
                    )

                    # Log the latest output state
                    self.latest_output_state = self.output_state

                    return self.output_state + [default_notification]

                elif ctx.triggered_id == "reset_inputs":
                    self.output_state = self.output_state_default
                    return self.output_state + [default_notification]

                elif self.app_initialized:
                    return self.output_state + [default_notification]

                else:
                    return self.output_state_default + [default_notification]

            except Exception as e:
                traceback.print_exc()
                notification = _get_error_notification_component(str(e))

                return self.output_state_default + [notification]

        @self.app.callback(
            [
                Output(
                    component_id=input_.ack.id,
                    component_property=input_.ack.component_property,
                )
                for input_ in self.inputs_with_ids
            ]
            + [Output("dummy-div", "children")],
            [
                Input(
                    component_id=input_.id, component_property=input_.component_property
                )
                for input_ in self.inputs_with_ids
            ]
            + [Input("dummy-div", "children")],
        )
        def process_ack_outputs(*args):
            ack_components = [
                ack if mask is True else None
                for mask, ack in zip(self.ack_mask, list(args)[:-1])
            ]
            return ack_components + [[]]

        # Set layout callbacks
        if not self.minimal:
            self.layout_object.callbacks(self)

__init__(callback_fn, layout='sidebar', mosaic=None, inputs=None, outputs=None, output_labels='infer', title=None, title_image_path=None, subheader=None, github_url=None, linkedin_url=None, twitter_url=None, navbar=True, footer=True, about=True, theme=None, update_live=False, port=8080, mode=None, minimal=False, disable_logs=False, scale_height=1, run_kwargs=dict(), kwargs)

Parameters:

Name Type Description Default
callback_fn func

Python function that Fast Dash deploys. This function guides the behavior of and interaction between input and output components.

 required
layout str

App layout style. Currently supports 'base' and 'sidebar'. Defaults to sidebar.

 'sidebar'
mosaic str

Mosaic array layout, if sidebar layout is selected.

 None
inputs Fast component, list of Fast components

Components to represent inputs of the callback function. Defaults to None. If None, Fast Dash attempts to infer the best components from callback function's type hints and default values. In the absence of type hints, default components are all Text.

 None
outputs Fast component, list of Fast components

Components to represent outputs of the callback function. Defaults to None. If None, Fast Dash attempts to infer the best components from callback function's type hints. In the absence of type hints, default components are all Text.

 None
output_labels(list of string labels or "infer" or None

Labels given to the output components. If None, inputs are set labeled integers starting at 1 (Output 1, Output 2, and so on). If "infer", labels are inferred from the function signature. Defaults to infer.

 required
title str

Title given to the app. If None, function name (assumed to be in snake case) is converted to title case. Defaults to None.

 None
title_image_path str

Path (local or URL) of the app title image. Defaults to None.

 None
subheader str

Subheader of the app, displayed below the title image and title If None, Fast Dash tries to use the callback function's docstring instead. Defaults to None.

 None
github_url str

GitHub URL for branding. Displays a GitHub logo in the navbar, which takes users to the specified URL. Defaults to None.

 None
linkedin_url str

LinkedIn URL for branding Displays a LinkedIn logo in the navbar, which takes users to the specified URL. Defaults to None.

 None
twitter_url str

Twitter URL for branding. Displays a Twitter logo in the navbar, which takes users to the specified URL. Defaults to None.

 None
navbar bool

Display navbar. Defaults to True.

 True
footer bool

Display footer. Defaults to True.

 True
about Union[str, bool]

App description to display on clicking the About button. If True, content is inferred from the docstring of the callback function. If string, content is used directly as markdown. About is hidden if False or None. Defaults to True.

 True
theme str

Apply theme to the app.All available themes can be found at https://bootswatch.com/. Defaults to JOURNAL.

None
update_live bool

Enable hot reloading. If the number of inputs is 0, this is set to True automatically. Defaults to False.

 False
port int

Port to which the app should be deployed. Defaults to 8080.

 8080
mode str

Mode in which to launch the app. Acceptable options are None, jupyterlab, inline, 'external`. Defaults to None.

 None
minimal bool

Display minimal version by hiding navbar, title, title image, subheader and footer. Defaults to False.

 False
disable_logs bool

Hide app logs. Sets logger level to ERROR. Defaults to False.

 False
scale_height float

Height of the app container is enlarged as a multiple of this. Defaults to 1.

 1
run_kwargs dict

All values from this variable are passed to Dash's .run method.

 dict()
Source code in fast_dash/fast_dash.py 
 42
 43
 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
 85
 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
112
113
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
141
142
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
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
def __init__(
    self,
    callback_fn,
    layout="sidebar",
    mosaic=None,
    inputs=None,
    outputs=None,
    output_labels="infer",
    title=None,
    title_image_path=None,
    subheader=None,
    github_url=None,
    linkedin_url=None,
    twitter_url=None,
    navbar=True,
    footer=True,
    about=True,
    theme=None,
    update_live=False,
    port=8080,
    mode=None,
    minimal=False,
    disable_logs=False,
    scale_height=1,
    run_kwargs=dict(),
    **kwargs
):
    """
    Args:
        callback_fn (func): Python function that Fast Dash deploys. \
            This function guides the behavior of and interaction between input and output components.

        layout (str, optional): App layout style. Currently supports 'base' and 'sidebar'. Defaults to sidebar.

        mosaic (str): Mosaic array layout, if sidebar layout is selected.

        inputs (Fast component, list of Fast components, optional): Components to represent inputs of the callback function.\
            Defaults to None. If `None`, Fast Dash attempts to infer the best components from callback function's type \
            hints and default values. In the absence of type hints, default components are all `Text`.

        outputs (Fast component, list of Fast components, optional): Components to represent outputs of the callback function.\
            Defaults to None. If `None`, Fast Dash attempts to infer the best components from callback function's type hints.\
            In the absence of type hints, default components are all `Text`.

        output_labels(list of string labels or "infer" or None, optional): Labels given to the output components. If None, inputs are\
            set labeled integers starting at 1 (Output 1, Output 2, and so on). If "infer", labels are inferred from the function\
            signature. Defaults to infer.

        title (str, optional): Title given to the app. If `None`, function name (assumed to be in snake case)\
            is converted to title case. Defaults to None.

        title_image_path (str, optional): Path (local or URL) of the app title image. Defaults to None.

        subheader (str, optional): Subheader of the app, displayed below the title image and title\
            If `None`, Fast Dash tries to use the callback function's docstring instead. Defaults to None.


        github_url (str, optional): GitHub URL for branding. Displays a GitHub logo in the navbar, which takes users to the\
            specified URL. Defaults to None.

        linkedin_url (str, optional): LinkedIn URL for branding Displays a LinkedIn logo in the navbar, which takes users to the\
            specified URL. Defaults to None.

        twitter_url (str, optional): Twitter URL for branding. Displays a Twitter logo in the navbar, which takes users to the\
            specified URL. Defaults to None.

        navbar (bool, optional): Display navbar. Defaults to True.

        footer (bool, optional): Display footer. Defaults to True.

        about (Union[str, bool], optional): App description to display on clicking the `About` button. If True, content is inferred from\
            the docstring of the callback function. If string, content is used directly as markdown. \
            `About` is hidden if False or None. Defaults to True.

        theme (str, optional): Apply theme to the app.All available themes can be found at https://bootswatch.com/. Defaults to JOURNAL. 

        update_live (bool, optional): Enable hot reloading. If the number of inputs is 0, this is set to True automatically. Defaults to False.

        port (int, optional): Port to which the app should be deployed. Defaults to 8080.

        mode (str, optional): Mode in which to launch the app. Acceptable options are `None`, `jupyterlab`, `inline`, 'external`.\
            Defaults to None.

        minimal (bool, optional): Display minimal version by hiding navbar, title, title image, subheader and footer. Defaults to False.

        disable_logs (bool, optional): Hide app logs. Sets logger level to `ERROR`. Defaults to False.

        scale_height (float, optional): Height of the app container is enlarged as a multiple of this. Defaults to 1.

        run_kwargs (dict, optional): All values from this variable are passed to Dash's `.run` method.
    """

    self.callback_fn = callback_fn
    self.layout_pattern = layout
    self.mosaic = mosaic
    self.output_labels = output_labels

    if output_labels == "infer":
        self.output_labels = _infer_variable_names(callback_fn)

    self.inputs = (
        _infer_input_components(callback_fn)
        if inputs is None
        else inputs
        if isinstance(inputs, list)
        else [inputs]
    )
    self.outputs = _infer_output_components(
        callback_fn, outputs, self.output_labels
    )
    self.update_live = (
        True
        if (isinstance(self.inputs, list) and len(self.inputs) == 0)
        else update_live
    )
    self.mode = mode
    self.disable_logs = disable_logs
    self.scale_height = scale_height
    self.port = port
    self.run_kwargs = run_kwargs
    self.run_kwargs.update(dict(port=port))
    self.kwargs = kwargs

    if self.disable_logs is True:
        log = logging.getLogger("werkzeug")
        log.setLevel(logging.ERROR)

    else:
        log = logging.getLogger("werkzeug")
        log.setLevel(logging.DEBUG)

    if title is None:
        title = re.sub("[^0-9a-zA-Z]+", " ", callback_fn.__name__).title()

    self.title = title
    self.title_image_path = title_image_path
    self.subtitle = (
        subheader
        if subheader is not None
        else _parse_docstring_as_markdown(
            callback_fn, title=self.title, get_short=True
        )
    )
    self.github_url = github_url
    self.linkedin_url = linkedin_url
    self.twitter_url = twitter_url
    self.navbar = navbar
    self.footer = footer
    self.about = about
    self.theme = theme or "JOURNAL"
    self.minimal = minimal

    # Extract input tags
    self.input_tags = [inp.tag for inp in self.inputs]
    self.output_tags = [inp.tag for inp in self.outputs]

    # Assign IDs to components
    self.inputs_with_ids = _assign_ids_to_inputs(self.inputs, self.callback_fn)
    self.outputs_with_ids = _assign_ids_to_outputs(self.outputs)
    self.ack_mask = [
        False if (not hasattr(input_, "ack") or (input_.ack is None)) else True
        for input_ in self.inputs_with_ids
    ]

    # Default state of outputs
    self.output_state_default = [
        output_.placeholder if hasattr(output_, "placeholder") else None
        for output_ in self.outputs_with_ids
    ]

    self.output_state_blank = [None for output_ in self.outputs_with_ids]
    self.latest_output_state = self.output_state_blank

    # Define Flask server
    server = flask.Flask(__name__)
    external_stylesheets = [
        theme_mapper(self.theme),
        "https://use.fontawesome.com/releases/v5.9.0/css/all.css",
    ]

    source = dash.Dash
    # if self.mode is not None:
    #     try:
    #         from jupyter_dash import JupyterDash

    #         source = JupyterDash

    #     except ImportError as e:
    #         self.mode = None
    #         warnings.warn(str(e))
    #         warnings.warn("Ignoring mode argument")

    self.app = source(
        __name__,
        external_stylesheets=external_stylesheets,
        server=server,
        **self.kwargs
    )
    # Define app title
    self.app.title = self.title or ""

    # Intialize layout
    self.set_layout()

    # Register callbacks
    self.register_callback_fn()

    # Keep track of the number of clicks
    self.submit_clicks = 0
    self.reset_clicks = 0
    self.app_initialized = False

    # Allow easier access to Dash server
    self.server = self.app.server

Fastify(component, component_property, ack=None, placeholder=None, label_=None, tag=None, args, kwargs)

Modify a Dash component into a FastComponent.

Parameters:

Name Type Description Default
component Dash component

Dash component that needs to be modified

 required
component_property str

Component property that's assigned the input or output values

 required
ack Dash component

Dash component that's displayed as an acknowledgement of the original component

 None
placeholder str

Placeholder value of the component.

 None
label_ str

Component title.

 None
tag str

Optional tag applied to the component.

 None

Returns:

Type Description

Fast component: Dash component modified to make it compatible with Fast Dash.
Source code in fast_dash/utils.py 
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
def Fastify(component, component_property, ack=None, placeholder=None, label_=None,tag=None, *args, **kwargs):
    """
    Modify a Dash component into a FastComponent.

    Args:
        component (Dash component): Dash component that needs to be modified
        component_property (str): Component property that's assigned the input or output values
        ack (Dash component, optional): Dash component that's displayed as an acknowledgement of the original component
        placeholder (str, optional): Placeholder value of the component.
        label_ (str, optional): Component title.
        tag (str, optional): Optional tag applied to the component.

    Returns:
        Fast component: Dash component modified to make it compatible with Fast Dash.
    """

    class FastComponent(type(component)):
        def __init__(self, component, component_property, ack=ack, placeholder=placeholder, label_=label_, tag=tag, *args, **kwargs):

            self.component_property = component_property
            self.ack = ack
            self.label_ = label_
            self.placeholder = placeholder
            self.tag = tag

            # Copy normal attributes
            for attr_name, attr_value in vars(component).items():
                setattr(self, attr_name, attr_value)

            # Copy the __doc__ attribute
            self.__doc__ = component.__doc__

            for key, value in kwargs.items():
                setattr(self, key, value)

        def __call__(self, **kwargs):            
            self_copy = copy.deepcopy(self)
            for key, value in kwargs.items():
                setattr(self_copy, key, value)

            return self_copy

    return FastComponent(component, component_property, ack=ack, placeholder=placeholder, label_=label_, tag=tag)

fastdash(_callback_fn=None, *, layout='sidebar', mosaic=None, inputs=None, outputs=None, output_labels='infer', title=None, title_image_path=None, subheader=None, github_url=None, linkedin_url=None, twitter_url=None, navbar=True, footer=True, about=True, theme=None, update_live=False, port=8080, mode=None, minimal=False, disable_logs=False, scale_height=1, run_kwargs=dict(), kwargs)

Function decorator / wrapper for Fast Dash.

Parameters:

Name Type Description Default
callback_fn func

Python function that Fast Dash deploys. This function guides the behavior of and interaction between input and output components.

 required
layout str

App layout style. Currently supports 'base' and 'sidebar'. Defaults to sidebar.

 'sidebar'
mosaic str

Mosaic array layout, if sidebar layout is selected.

 None
inputs Fast component, list of Fast components

Components to represent inputs of the callback function. Defaults to None. If None, Fast Dash attempts to infer the best components from callback function's type hints and default values. In the absence of type hints, default components are all Text.

 None
outputs Fast component, list of Fast components

Components to represent outputs of the callback function. Defaults to None. If None, Fast Dash attempts to infer the best components from callback function's type hints. In the absence of type hints, default components are all Text.

 None
output_labels(list of string labels or "infer" or None

Labels given to the output components. If None, inputs are set labeled integers starting at 1 (Output 1, Output 2, and so on). If "infer", labels are inferred from the function signature. Defaults to infer.

 required
title str

Title given to the app. If None, function name (assumed to be in snake case) is converted to title case. Defaults to None.

 None
title_image_path str

Path (local or URL) of the app title image. Defaults to None.

 None
subheader str

Subheader of the app, displayed below the title image and title If None, Fast Dash tries to use the callback function's docstring instead. Defaults to None.

 None
github_url str

GitHub URL for branding. Displays a GitHub logo in the navbar, which takes users to the specified URL. Defaults to None.

 None
linkedin_url str

LinkedIn URL for branding Displays a LinkedIn logo in the navbar, which takes users to the specified URL. Defaults to None.

 None
twitter_url str

Twitter URL for branding. Displays a Twitter logo in the navbar, which takes users to the specified URL. Defaults to None.

 None
navbar bool

Display navbar. Defaults to True.

 True
footer bool

Display footer. Defaults to True.

 True
about Union[str, bool]

App description to display on clicking the About button. If True, content is inferred from the docstring of the callback function. If string, content is used directly as markdown. About is hidden if False or None. Defaults to True.

 True
theme str

Apply theme to the app.All available themes can be found at https://bootswatch.com/. Defaults to JOURNAL.

None
update_live bool

Enable hot reloading. If the number of inputs is 0, this is set to True automatically. Defaults to False.

 False
port int

Port to which the app should be deployed. Defaults to 8080.

 8080
mode str

Mode in which to launch the app. Acceptable options are None, jupyterlab, inline, 'external`. Defaults to None.

 None
minimal bool

Display minimal version by hiding navbar, title, title image, subheader and footer. Defaults to False.

 False
disable_logs bool

Hide app logs. Sets logger level to ERROR. Defaults to False.

 False
scale_height float

Height of the app container is enlarged as a multiple of this. Defaults to 1.

 1
run_kwargs dict

All values from this variable are passed to Dash's .run method.

 dict()
Source code in fast_dash/fast_dash.py 
405
406
407
408
409
410
411
412
413
414
415
416
417
418
419
420
421
422
423
424
425
426
427
428
429
430
431
432
433
434
435
436
437
438
439
440
441
442
443
444
445
446
447
448
449
450
451
452
453
454
455
456
457
458
459
460
461
462
463
464
465
466
467
468
469
470
471
472
473
474
475
476
477
478
479
480
481
482
483
484
485
486
487
488
489
490
491
492
493
494
495
496
497
498
499
500
501
502
503
504
505
506
507
508
509
510
511
512
513
514
515
516
517
518
519
520
521
522
523
524
525
526
527
528
529
530
531
532
533
534
535
536
537
538
539
def fastdash(
    _callback_fn=None,
    *,
    layout="sidebar",
    mosaic=None,
    inputs=None,
    outputs=None,
    output_labels="infer",
    title=None,
    title_image_path=None,
    subheader=None,
    github_url=None,
    linkedin_url=None,
    twitter_url=None,
    navbar=True,
    footer=True,
    about=True,
    theme=None,
    update_live=False,
    port=8080,
    mode=None,
    minimal=False,
    disable_logs=False,
    scale_height=1,
    run_kwargs=dict(),
    **kwargs
):
    """
    Function decorator / wrapper for Fast Dash.

    Args:
        callback_fn (func): Python function that Fast Dash deploys. \
            This function guides the behavior of and interaction between input and output components.

        layout (str, optional): App layout style. Currently supports 'base' and 'sidebar'. Defaults to sidebar.

        mosaic (str): Mosaic array layout, if sidebar layout is selected.

        inputs (Fast component, list of Fast components, optional): Components to represent inputs of the callback function.\
            Defaults to None. If `None`, Fast Dash attempts to infer the best components from callback function's type \
            hints and default values. In the absence of type hints, default components are all `Text`.

        outputs (Fast component, list of Fast components, optional): Components to represent outputs of the callback function.\
            Defaults to None. If `None`, Fast Dash attempts to infer the best components from callback function's type hints.\
            In the absence of type hints, default components are all `Text`.

        output_labels(list of string labels or "infer" or None, optional): Labels given to the output components. If None, inputs are\
            set labeled integers starting at 1 (Output 1, Output 2, and so on). If "infer", labels are inferred from the function\
            signature. Defaults to infer.

        title (str, optional): Title given to the app. If `None`, function name (assumed to be in snake case)\
            is converted to title case. Defaults to None.

        title_image_path (str, optional): Path (local or URL) of the app title image. Defaults to None.

        subheader (str, optional): Subheader of the app, displayed below the title image and title\
            If `None`, Fast Dash tries to use the callback function's docstring instead. Defaults to None.


        github_url (str, optional): GitHub URL for branding. Displays a GitHub logo in the navbar, which takes users to the\
            specified URL. Defaults to None.

        linkedin_url (str, optional): LinkedIn URL for branding Displays a LinkedIn logo in the navbar, which takes users to the\
            specified URL. Defaults to None.

        twitter_url (str, optional): Twitter URL for branding. Displays a Twitter logo in the navbar, which takes users to the\
            specified URL. Defaults to None.

        navbar (bool, optional): Display navbar. Defaults to True.

        footer (bool, optional): Display footer. Defaults to True.

        about (Union[str, bool], optional): App description to display on clicking the `About` button. If True, content is inferred from\
            the docstring of the callback function. If string, content is used directly as markdown. \
            `About` is hidden if False or None. Defaults to True.

        theme (str, optional): Apply theme to the app.All available themes can be found at https://bootswatch.com/. Defaults to JOURNAL. 

        update_live (bool, optional): Enable hot reloading. If the number of inputs is 0, this is set to True automatically. Defaults to False.

        port (int, optional): Port to which the app should be deployed. Defaults to 8080.

        mode (str, optional): Mode in which to launch the app. Acceptable options are `None`, `jupyterlab`, `inline`, 'external`.\
            Defaults to None.

        minimal (bool, optional): Display minimal version by hiding navbar, title, title image, subheader and footer. Defaults to False.

        disable_logs (bool, optional): Hide app logs. Sets logger level to `ERROR`. Defaults to False.

        scale_height (float, optional): Height of the app container is enlarged as a multiple of this. Defaults to 1.

        run_kwargs (dict, optional): All values from this variable are passed to Dash's `.run` method.
        """

    def decorator_fastdash(callback_fn):
        "Decorator for callback_fn"

        @functools.wraps(callback_fn)
        def wrapper_fastdash(**kwargs):
            app = FastDash(callback_fn=callback_fn, **kwargs)
            app.run()
            return callback_fn

        return wrapper_fastdash(
            layout=layout,
            mosaic=mosaic,
            inputs=inputs,
            outputs=outputs,
            output_labels=output_labels,
            title=title,
            title_image_path=title_image_path,
            subheader=subheader,
            github_url=github_url,
            linkedin_url=linkedin_url,
            twitter_url=twitter_url,
            navbar=navbar,
            footer=footer,
            about=about,
            theme=theme,
            update_live=update_live,
            mode=mode,
            port=port,
            minimal=minimal,
            disable_logs=disable_logs,
            scale_height=scale_height,
            run_kwargs=run_kwargs,
            **kwargs
        )

    # If the decorator is called with arguments
    if _callback_fn is None:
        return decorator_fastdash
    # If the decorator is called without arguments. Use default input and output values
    else:
        return decorator_fastdash(_callback_fn)