OSFI.OsfiEnv.OsfiEnv Class Reference

Public Member Functions
def	__init__ (self, base_cfg=None)
def	external_var (self, key)
def	__getitem__ (self, key)
def	__setitem__ (self, key, value)
def	__delitem__ (self, key)
def	__contains__ (self, key)

Detailed Description

Singleton store of environmental settings for OSFI.
Created so that init-once and environment-based configurations are easier to mock
for unit-testing purposes.

Member Function Documentation

__getitem__()

def OSFI.OsfiEnv.OsfiEnv.__getitem__	(		self,
			key
	)

Retrieve value from the shared storage, or None if no value is present under that key.

References OSFI.OsfiEnv.OsfiEnv._values.

__setitem__()

def OSFI.OsfiEnv.OsfiEnv.__setitem__	(		self,
			key,
			value
	)

Store a value under a given ID

References OSFI.OsfiEnv.OsfiEnv._values.

external_var()

def OSFI.OsfiEnv.OsfiEnv.external_var	(		self,
			key
	)

Retrieve a value from the external configuration, which is normally os.environ.
:param key: Name of the environment variable.
:returns: Value, or None if the variable is not present.

References OSFI.OsfiEnv.OsfiEnv._base_cfg.

---

The documentation for this class was generated from the following file:

• include/Python/OSFI/OsfiEnv.py