Skip to content

app/__init__

Full documentation pages are generated for docstring reference only and may contain symbols imported from other modules. Imported symbols are not distinguished from locally defined symbols and will appear in any module that they are imported into. For better information on where symbols should be imported from, review the sourcecode on the github.

FoSpy.ui.app

__all__ module-attribute 

__all__ = [
    "assets",
    "block_widgets",
    "console",
    "editors",
    "menus",
    "window",
]

available module-attribute 

available = True

import_e module-attribute 

import_e = e

UINotAvailable

Bases: Exception

Source code in FoSpy/ui/available.py 
4
5
class UINotAvailable(Exception):
    pass

_import_gate 

_import_gate()
Source code in FoSpy/ui/app/__init__.py 
18
19
20
21
def _import_gate():
    global available, import_e
    if not available:
        raise import_e

validate_ui 

validate_ui(ui_name)
Source code in FoSpy/ui/available.py 
53
54
55
56
57
58
59
60
61
62
63
64
def validate_ui(ui_name):
    ui_lower = ui_name.lower()
    if ui_lower not in _UI_REQUIREMENTS:
        valids = ", ".join(_UI_REQUIREMENTS.keys())
        raise UINotAvailable(f"UI '{ui_name}' is not a valid UI. Valid options are: {valids}.")

    if ui_lower not in AVAILABLE_UIS:
        raise UINotAvailable(
            f"The '{ui_name}' UI backend cannot be used because it is missing dependencies. "
            "Refer to the summary below and install the missing dependencies to use this UI.\n\n"
            f"{_summarize_reqs(_UI_REQUIREMENTS[ui_lower])}"
        )