Skip to main content

Environ

Environ (Runtime Environment Object) is used to manage and control the application's runtime environment. Within the same runtime environment, each AppId can only run one version in the App container. When an App exists in multiple runtime environments, the version numbers can be the same or different.

The runtime environment object that the current application belongs to can be accessed through app.env.

Properties

NameTypeDescription
envIdstrRuntime environment ID, e.g.: JRE_MWcVmUZjEq
orgIdstrOrganization ID, e.g.: wanyun
titlestrRuntime environment title
remarkstrRuntime environment remarks
rootPathstrRuntime environment root path
updateTimeintUpdate timestamp of runtime environment configuration
entrystrCurrently used entry address
Danger

Developers can read the above properties, but should not forcibly modify these property values, as it may cause unpredictable errors.

Methods

getApp

Get a deployed App object.

Parameters:

  • appId (str): Application ID
  • version (str, optional): Application version
  • initApp (bool, optional): Whether to initialize the application, defaults to False

Return Value:

Application object

Return Type:

App or None

Note

This method requires that the application must exist in the deployment records.

getAppIgnoreRule

Get an application object without requiring deployment records to exist.

Parameters:

  • appId (str): Application ID
  • version (str): Application version

返回值:

返回值类型:

App 或 None

getAppPath

Get the relative path of the application under the runtime environment root directory.

Parameters:

  • appId (str): Application ID

Return Value:

Application path.

Return Type:

str

getAppDistPath

Get the relative path of the application's dist directory under the runtime environment root directory.

Parameters:

  • appId (str): Application ID

Return Value:

Application dist path.

Return Type:

str

getAppDistAbsolutePath

Get the absolute path of the application's dist directory, the path on disk.

Parameters:

  • appId (str): Application ID

Return Value:

Absolute path of the application's dist directory.

Return Type:

str

Usage Example

# Get the runtime environment of the current application
env = app.env

# Get a deployed application
myApp = env.getApp("wanyun.MyApp")

# Get application path
appPath = env.getAppPath("wanyun.MyApp")
print(f"Application path: {appPath}")

# Get application deployment rules
rule = env.getRuleByAppId("wanyun.MyApp")
if rule:
print(f"Application version: {rule.version}")
print(f"Debug mode: {rule.debug}")
JitAI AssistantBeta
Powered by JitAI