appyter.render.flask_app package

Submodules

appyter.render.flask_app.constants module

Constants that can be cached in thread-local storage

appyter.render.flask_app.constants.get_base_files()

Include all (non-hidden) files in cwd (include requirements.txt, utils, etc..)

appyter.render.flask_app.constants.get_cwd_fs()

Return fsspec compatible chroot to the current directory

appyter.render.flask_app.constants.get_deep_fields()

Parse the nbtemplate fields

appyter.render.flask_app.constants.get_env()

appyter.render.flask_app.constants.get_fields()

Parse the nbtemplate fields

appyter.render.flask_app.constants.get_form()

Render a form for the nbtemplate

appyter.render.flask_app.constants.get_html_exporer()

nbconvert html export

appyter.render.flask_app.constants.get_input_fs()

Return fsspec compatible chroot to the static directory

appyter.render.flask_app.constants.get_ipynb_hash()

A hash for the ipynb

appyter.render.flask_app.constants.get_ipynb_io()

Reuse the BytesIO stream

appyter.render.flask_app.constants.get_j2_env()

Get an initialized bare jinja2 environment (no context)

appyter.render.flask_app.constants.get_nbtemplate()

Parse the ipynb

appyter.render.flask_app.constants.get_nbtemplate_json()

Render the nbtemplate as nbtemplate_json

appyter.render.flask_app.constants.get_output_fs()

Return fsspec compatible chroot to the static directory

appyter.render.flask_app.constants.get_static_fs()

Return fsspec compatible chroot to the static directory

appyter.render.flask_app.core module

appyter.render.flask_app.core.post_index()

appyter.render.flask_app.core.post_ssr()

appyter.render.flask_app.development module

async appyter.render.flask_app.development.app_messager(emitter, config)

async appyter.render.flask_app.development.app_runner(emitter, config)

async appyter.render.flask_app.development.file_watcher(emitter, evt, path, **kwargs)

async appyter.render.flask_app.development.run_app(config)

appyter.render.flask_app.development.serve(app_path, **kwargs)

appyter.render.flask_app.drs module

A DRS endpoint for accessing storage://input

appyter.render.flask_app.drs.drs_objects(file_id)

appyter.render.flask_app.drs.drs_objects_access(file_id, access_id)

appyter.render.flask_app.drs.drs_objects_fetch(file_id)

appyter.render.flask_app.drs.drs_service_info()

appyter.render.flask_app.execution module

async appyter.render.flask_app.execution.submit(sid, data)

appyter.render.flask_app.export module

Endpoints for exporting results

appyter.render.flask_app.export.export(path)

appyter.render.flask_app.livereload module

appyter.render.flask_app.prepare module

appyter.render.flask_app.prepare.prepare_data(req)

Extract fields from submission

appyter.render.flask_app.prepare.prepare_executor(data, fallback=None)

Figure out the executor to use for this request

appyter.render.flask_app.prepare.prepare_request(req)

Extract internal session variables from request

appyter.render.flask_app.prepare.prepare_results(data)

Compute instance id & ensure results exist in storage

appyter.render.flask_app.prepare.prepare_storage(data)

Figure out the storage fsspec URI to use for this request

appyter.render.flask_app.production module

appyter.render.flask_app.production.serve(app_path, **kwargs)

appyter.render.flask_app.room_manager module

Manage rooms NOTE: rooms state would need to be distributed if the server was distributed.

async appyter.render.flask_app.room_manager.ensure_joined(client_sid)

async appyter.render.flask_app.room_manager.ensure_room(room)

async appyter.render.flask_app.room_manager.enter_room(client_sid, room_id)

async appyter.render.flask_app.room_manager.find_room(room_id)

async appyter.render.flask_app.room_manager.on_join(client_sid, room_data)

async appyter.render.flask_app.room_manager.remove_client_from_room(room_id, client_sid)

appyter.render.flask_app.room_manager.room_lock(room_id)

appyter.render.flask_app.socketio module

appyter.render.flask_app.static module

Represent the areas that can be handled externally in production

appyter.render.flask_app.static.data_files(path)

appyter.render.flask_app.static.favicon()

appyter.render.flask_app.static.get_index()

appyter.render.flask_app.static.static(filename)

appyter.render.flask_app.upload module

appyter.render.flask_app.upload.check(path)

appyter.render.flask_app.upload.organize_file_content(data_fs, tmp_fs, tmp_path, filename=None)

async appyter.render.flask_app.upload.siofu_done(sid, evt)

async appyter.render.flask_app.upload.siofu_progress(sid, evt)

async appyter.render.flask_app.upload.siofu_start(sid, data)

appyter.render.flask_app.upload.upload_from_request(req, fname, multiple=False)

Module contents

appyter.render.flask_app.create_app(**kwargs)

Completely initialize the flask application