Initializing help system before first use

xpressinsight.AppConfig

Purpose
Insight application configuration decorator. An Insight application class must be decorated with this decorator.
Synopsis
class xpressinsight.AppConfig(EntitiesConfig)
Example
Example of a minimal Insight app showing the application configuration decorator: 
>>> import xpressinsight as xi
... import sys
...
... @xi.AppConfig(name="AppConfig Example",
...               version=xi.AppVersion(1, 0, 0))
... class InsightApp(xi.AppBase):
...     @xi.ExecModeLoad()
...     def load(self):
...         print(f"Current app name: {self.insight.app_name}")
...         print(f"Default app name: {self.app_cfg.name}")
...         print(f"App version:      {self.app_cfg.version}")
...
...     @xi.ExecModeRun()
...     def run(self):
...         pass
...
... if __name__ == "__main__":
...     app = xi.create_app(InsightApp)
...     app.insight.app_name = "My " + app.app_cfg.name
...     sys.exit(app.call_exec_mode("LOAD"))
...
Current app name: My AppConfig Example
Default app name: AppConfig Example
App version:      1.0.0
Related topics
AppBase.app_cfg,
AppConfig.__init__,
AppConfig.entities,
AppConfig.exec_modes,
AppConfig.exec_resource_groups,
AppConfig.get_entity,
AppConfig.get_exec_mode,
AppConfig.get_exec_resource_group,
AppConfig.name,
AppConfig.partial_populate,
AppConfig.result_data,
AppConfig.scen_types,
AppConfig.version,
EntitiesConfig

Parent Topic App Configuration Classes

© 2001-2024 Fair Isaac Corporation. All rights reserved. This documentation is the property of Fair Isaac Corporation (“FICO”). Receipt or possession of this documentation does not convey rights to disclose, reproduce, make derivative works, use, or allow others to use it except solely for internal evaluation purposes to determine whether to purchase a license to the software described in this documentation, or as otherwise set forth in a written software license agreement between you and FICO (or a FICO affiliate). Use of this documentation and the software described in it must conform strictly to the foregoing permitted uses, and no other use is permitted.