IPM
UniversalSettings Class Reference

IPM settings are placed in ^IPM.settings global in SYS namespace Use this class to set or get settings. More...

Inheritance diagram for UniversalSettings:
Inheritance graph

Static Public Member Functions

_.Library.Status GetAll (configArray)
 Returns configArray, that includes all configurable settings.
 
_.Library.String GetValue (_.Library.String indx)
 Gets value from global array. More...
 
 PrintList ()
 Writes in terminal key : value pairs for all configurable settings.
 

Static Public Attributes

 ColorScheme = None
 Possible values: yes, none.
 
 PipCaller = None
 A path pointing either to a python executable or a pip executable, controlled by <parameter>UseStandalonePip</parameter> More...
 
 SemVerPostRelease = None
 Possible values: 0, 1. More...
 
 TerminalPrompt = None
 Possible values: green, red, magenta, blue, yellow, cyan, none.
 
 UseStandalonePip = None
 Possible values: "", 0, 1. More...
 

Detailed Description

IPM settings are placed in ^IPM.settings global in SYS namespace Use this class to set or get settings.

Available settings default_registry (string) - default registry url analytics_tracking_id analytics_available (boolean) - if 1 - send usage statistics

Member Function Documentation

◆ GetValue()

_.Library.String GetValue ( _.Library.String  indx)
static

Gets value from global array.

indx - global subscript

Member Data Documentation

◆ PipCaller

PipCaller = None
static

A path pointing either to a python executable or a pip executable, controlled by <parameter>UseStandalonePip</parameter>

In the special case where the path is empty, the script tries to resolve the path in the following order:

  1. Where available (typically 2024.2+) - Use PythonRuntimeLibrary in iris.cpf to find the directory containing the python executable
  2. On Windows, try to find <iris-root>/bin/irispip.exe
  3. Unless <parameter>UseStandalonePip</parameter> is explicitly set to 1, try to find whichever python3/python is first available in $PATH
  4. Unless <parameter>UseStandalonePip</parameter> is explicitly set to 0, try to find whichever pip3/pip is first available in $PATH

◆ SemVerPostRelease

SemVerPostRelease = None
static

Possible values: 0, 1.

Indicates whether the SemVer comparison treats the version 1.0.0-1.m1 as a post-release of 1.0.0, hence 1.0.0-1.m1 > 1.0.0 Default value is 0, where 1.0.0-anystring is considered a pre-release of 1.0.0, hence 1.0.0-anystring < 1.0.0

◆ UseStandalonePip

UseStandalonePip = None
static

Possible values: "", 0, 1.

Indicates whether <parameter>PipCaller</parameter> is a pip executable instead of python