pyrevit.coreutils.envvars

pyRevit managed environment variables framework.

pyRevit provides the environment variables framework to the pyRevit core and all pyRevit tools so they can store arbitary data withing the running host session and share small data quickly between script runs.

Some settings needs to be set for the current session and might need to affect the behaviour of all individual scripts inside the extensions. (e.g. If user activates the DEBUG mode, all scripts should follow and log the debug entries.) The information is saved using AppDomain.GetData and SetData in a dictionary parameter. The dictionary is used to minimize the addition of named parameters to the AppDomain. The dictionary then includes all the internal parameters and their associated value. This way each script does not need to read the usersettings data which reduces io and saves time.

pyRevit uses environment variables extensively at its core and making changes to the core environment variables (starting with PYREVIT_) through scripts is strongly prohibited.

Example

>>> from pyrevit.coreutils import envvars
>>> envvars.set_pyrevit_env_var('MY_SCRIPT_STATUS', True)
>>> envvars.set_pyrevit_env_var('MY_SCRIPT_CONFIG', {'someconfig': True})

Then another script or same script when executed later within the same session can query the shared environment variable:

>>> envvars.get_pyrevit_env_vars('MY_SCRIPT_STATUS')
True
>>> envvars.get_pyrevit_env_vars('MY_SCRIPT_CONFIG')
{'someconfig': True}
pyrevit.coreutils.envvars.get_pyrevit_env_var(param_name)

Get value of a parameter shared between all scripts.

Parameters:param_name (str) – name of environment variable
Returns:any object stored as the environment variable value
Return type:object
pyrevit.coreutils.envvars.get_pyrevit_env_vars()

Get the root dictionary, holding all environment variables.

pyrevit.coreutils.envvars.set_pyrevit_env_var(param_name, param_value)

Set value of a parameter shared between all scripts.

Parameters:
  • param_name (str) – name of environment variable
  • param_value (object) – any python object