emsm.core.application

exception emsm.core.application.ApplicationException

Bases: Exception

Base class for all exceptions in this module.

exception emsm.core.application.WrongUserError(required_user)

Bases: emsm.core.application.ApplicationException

Raised if the EMSM is executed by the wrong user.

class emsm.core.application.Application(instance_dir)

Bases: object

This class manages the initialisation and the complete run process of the EMSM.

An EMSM application should be executed in a code structure similar to this one:

app = Application()
try:
    app.setup()
    app.run()
except Exception as err:
    app.handle_exception()
    raise
finally:
    exit(app.finish())

argparser()

Returns the EMSM ArgumentParser, that is used internally.

conf()

Returns the used Configuration instance.

exit_code()

Returns the exit code of the application.

See also

set_exit_code()

finish()

Performs some clean up and background stuff.

Returns:exit_code()

Note

Do not mix this method up with the emsm.core.plugins.PluginManager.finish() method. These are not related.

See also

• run()
• exit_code()

handle_exception()

Checks sys.exc_info() if there is currently an uncaught exception and logs it.

paths()

Returns the used Pathsystem instance.

plugins()

Returns the used PluginManager instance.

run()

Runs the plugins.

See also

• emsm.core.plugins.PluginManager.run()
• emsm.core.plugins.PluginManager.finish()

server()

Returns the used ServerManager instance.

set_exit_code(code)

Sets the exit code to code. This is the exit code, that is used for the Python exit() function.

Raises:

• TypeError – if code is not an int.
• ValueError – if code < 0.

See also

• exit_code()
• exit()

setup()

Initialises all components of the EMSM.

This method will block, until the EMSM filelock could be acquired or the configuration timeout value is reached.

worlds()

Returns the used WorldManager instance.