demessaging.backend package

Core module for generating a de-messaging backend module.

This module defines the base classes to serve a general python module as a backend module in the DASF.

The most important members are:

main([module_name])	Main function for starting a backend module from the command line.
BackendModule([root])	A base class for a backend module.
BackendFunction()	A base class for a function model.
BackendClass()	A basis for class models

Functions:

main([module_name])

Main function for starting a backend module from the command line.

demessaging.backend.main(module_name: str = '__main__', *args, **config_kws) → Type[BackendModule]

Main function for starting a backend module from the command line.

Parameters:

• doc (str) – The documentation of the object. If empty, this will be taken from the corresponding __doc__ attribute.

• registry (demessaging.config.registry.ApiRegistry) – Utilities for imports and encoders.

• template (demessaging.template.Template) – The demessaging.template.Template that is used to render the module for the generated API.

• messaging_config (Union[demessaging.config.messaging.PulsarConfig, demessaging.config.messaging.WebsocketURLConfig]) – Configuration on how to connect to the message broker.

• listen_config (demessaging.config.backend.ListenConfig) – None

• log_config (demessaging.config.logging.LoggingConfig) – Configuration for the logging.

• debug (bool) – Run the backend module in debug mode (creates more verbose error messages).

• members (List[Union[str, Callable, Type[object], Any]]) – List of members for this module

• imports (str) – Imports that should be added to the generate API module.

• json_schema_extra (Dict[str, Any]) – Any extra parameter for the JSON schema export for the function

Submodules

• demessaging.backend.class_ module
  • BackendClass
    • BackendClass.backend_config
    • BackendClass.create_model()
    • BackendClass.function
    • BackendClass.get_api_info()
    • BackendClass.get_constructor_fields()
    • BackendClass.model_config
    • BackendClass.model_json_schema()
    • BackendClass.return_model
  • BackendClassConfig
    • BackendClassConfig.Class
    • BackendClassConfig.annotations
    • BackendClassConfig.class_name
    • BackendClassConfig.doc
    • BackendClassConfig.field_params
    • BackendClassConfig.init_doc
    • BackendClassConfig.json_schema_extra
    • BackendClassConfig.method_configs
    • BackendClassConfig.methods
    • BackendClassConfig.model_config
    • BackendClassConfig.models
    • BackendClassConfig.name
    • BackendClassConfig.registry
    • BackendClassConfig.reporter_args
    • BackendClassConfig.serializers
    • BackendClassConfig.signature
    • BackendClassConfig.template
    • BackendClassConfig.update_from_cls()
    • BackendClassConfig.validators
  • ClassAPIModel
    • ClassAPIModel.methods
    • ClassAPIModel.model_config
    • ClassAPIModel.name
    • ClassAPIModel.rpc_schema
• demessaging.backend.function module
  • BackendFunction
    • BackendFunction.backend_config
    • BackendFunction.create_model()
    • BackendFunction.func_name
    • BackendFunction.get_api_info()
    • BackendFunction.model_config
    • BackendFunction.model_json_schema()
    • BackendFunction.return_model
  • BackendFunctionConfig
    • BackendFunctionConfig.annotations
    • BackendFunctionConfig.class_name
    • BackendFunctionConfig.doc
    • BackendFunctionConfig.field_params
    • BackendFunctionConfig.function
    • BackendFunctionConfig.json_schema_extra
    • BackendFunctionConfig.model_config
    • BackendFunctionConfig.name
    • BackendFunctionConfig.registry
    • BackendFunctionConfig.reporter_args
    • BackendFunctionConfig.return_annotation
    • BackendFunctionConfig.return_serializer
    • BackendFunctionConfig.return_validators
    • BackendFunctionConfig.returns
    • BackendFunctionConfig.serializers
    • BackendFunctionConfig.signature
    • BackendFunctionConfig.template
    • BackendFunctionConfig.update_from_function()
    • BackendFunctionConfig.validators
  • FunctionAPIModel
    • FunctionAPIModel.model_config
    • FunctionAPIModel.name
    • FunctionAPIModel.return_schema
    • FunctionAPIModel.rpc_schema
  • ReturnModel
    • ReturnModel.model_config
    • ReturnModel.root
  • get_return_model()
• demessaging.backend.module module
  • BackendModule
    • BackendModule.backend_config
    • BackendModule.compute()
    • BackendModule.create_model()
    • BackendModule.generate()
    • BackendModule.get_api_info()
    • BackendModule.handle_message()
    • BackendModule.listen()
    • BackendModule.model_config
    • BackendModule.model_json_schema()
    • BackendModule.process_request()
    • BackendModule.pulsar
    • BackendModule.root
    • BackendModule.send_request()
    • BackendModule.shell()
    • BackendModule.test_connect()
  • BackendModuleConfig
    • BackendModuleConfig.class_name
    • BackendModuleConfig.debug
    • BackendModuleConfig.doc
    • BackendModuleConfig.imports
    • BackendModuleConfig.json_schema_extra
    • BackendModuleConfig.listen_config
    • BackendModuleConfig.log_config
    • BackendModuleConfig.members
    • BackendModuleConfig.messaging_config
    • BackendModuleConfig.model_config
    • BackendModuleConfig.models
    • BackendModuleConfig.module
    • BackendModuleConfig.registry
    • BackendModuleConfig.template
  • ModuleAPIModel
    • ModuleAPIModel.classes
    • ModuleAPIModel.functions
    • ModuleAPIModel.model_config
    • ModuleAPIModel.rpc_schema
• demessaging.backend.utils module
  • AsyncIoThread
    • AsyncIoThread.run()
  • ImportMixin
    • ImportMixin.statement()
  • camelize()
  • get_desc()
  • get_fields()
  • get_kws()
  • get_module_imports()
  • run_async()
  • slugify()
  • snake_to_camel()