Skip to main content

application

A base Application class for Datalayer applications.

All Datalayer applications should inherit from this.

class NoStart(/, *args, **kwargs)​

Exception to raise when an application shouldn't start.

class DatalayerApp(**kwargs: 't.Any') -> 'None'​

Base class for Datalayer applications.

name​

str(object='') -> str str(bytes_or_buffer[, encoding[, errors]]) -> str

Create a new string object from the given object. If encoding or errors is specified, then the object must expose a data buffer that will be decoded using the given encoding and error handler. Otherwise, returns the result of object.str() (if defined) or repr(object). encoding defaults to 'utf-8'. errors defaults to 'strict'.

config_file_paths​

Get the configuration file paths.

Returns​

  • List[str]

    List of configuration file paths.

write_default_config() -> None​

Write our default config to a .py config file.

migrate_config() -> None​

Migrate config/data from IPython 3.

load_config_file(suppress_errors: bool = True) -> None​

Load the config file.

By default, errors in loading config are handled, and a warning printed on screen. For testing, the suppress_errors option is set to False, so errors will make tests fail.

Parameters​

  • suppress_errors : bool, default True

    Whether to suppress configuration loading errors.

initialize(argv: Optional[list[str]] = None) -> None​

Initialize the application.

Parameters​

  • argv : Optional[list[str]], default None

    Command line arguments.

start() -> None​

Start the whole thing.

launch_instance(argv: Optional[Tuple[Any]] = None, **kwargs: Dict[str, Any]) -> None​

Launch an instance of a Datalayer Application.

Parameters​

  • argv : Optional[Tuple[Any]], default None

    Command line arguments.

  • **kwargs : Dict[str, Any]

    Additional keyword arguments.

Returns​

  • None

    This method does not return a value.