Package VisionEgg :: Module Configuration
[frames] | no frames]

Module Configuration

source code


Load config values from environment, config file, or defaults.

Applications should not import this module directly.  Instead, 'import
VisionEgg' will result in an attribute 'VisionEgg.config', which has
the configuration options as attributes.

This module searches for configuration options from the following
places: environment variables, configuration file, generic defaults.
Environment variables take precedence over the configuration file,
which takes precedence over the generic defaults.

This module also determines the location of the Vision Egg
directories.  The VISIONEGG_SYSTEM_DIR directory is by default the
'VisionEgg' directory in Python's site-packages.  VISIONEGG_USER_DIR
is by default 'VisionEgg' in the directory specified by the
environment variable HOME, if it exists, and os.curdir otherwise.

You can create a configuration file that contains defaults for your
system.  This should be a text file with key/value pairs.  Blank lines
and anything after the pound symbol ('#') will be treated as a
comment.  Each key/value pairs should be on its own line and in the
format 'KEY=VALUE'.  By default the file 'VisionEgg.cfg' from the
VISIONEGG_USER_DIR or VISIONEGG_SYSTEM_DIR as specified above.
However, You can specify a different filename and directory by setting
the environment variable VISIONEGG_CONFIG_FILE.



Classes
  Config
Holds global Vision Egg configuration information.
Functions
 
save_settings()
Save the current values to the config file, overwriting what is there.
source code
Variables
  defaults = {'VISIONEGG_ALWAYS_START_LOGGING': 0, 'VISIONEGG_DO...
  extra_darwin_defaults = {'VISIONEGG_DARWIN_MAXPRIORITY_CONVENT...
Variables Details

defaults

Value:
{'VISIONEGG_ALWAYS_START_LOGGING': 0, 'VISIONEGG_DOUBLE_BUFFER': 1, 'V\
ISIONEGG_FRAMELESS_WINDOW': 0, 'VISIONEGG_FULLSCREEN': 0, 'VISIONEGG_G\
UI_INIT': 1, 'VISIONEGG_GAMMA_INVERT_RED': 2.1, 'VISIONEGG_GAMMA_INVER\
T_GREEN': 2.1, 'VISIONEGG_GAMMA_INVERT_BLUE': 2.1, 'VISIONEGG_GAMMA_FI\
LE': 'custom.ve_gamma', 'VISIONEGG_GAMMA_SOURCE': 'none', 'VISIONEGG_G\
UI_ON_ERROR': 1, 'VISIONEGG_HIDE_MOUSE': 1, 'VISIONEGG_LOG_FILE': 'Vis\
ionEgg.log', 'VISIONEGG_LOG_TO_STDERR': 1, 'VISIONEGG_MAXPRIORITY': 0,\
 'VISIONEGG_MONITOR_REFRESH_HZ': 60.0, 'VISIONEGG_MULTISAMPLE_SAMPLES'\
...

extra_darwin_defaults

Value:
{'VISIONEGG_DARWIN_MAXPRIORITY_CONVENTIONAL_NOT_REALTIME': 1, 'VISIONE\
GG_DARWIN_CONVENTIONAL_PRIORITY':-20, 'VISIONEGG_DARWIN_REALTIME_PERIO\
D_DENOM': 120, 'VISIONEGG_DARWIN_REALTIME_COMPUTATION_DENOM': 2400, 'V\
ISIONEGG_DARWIN_REALTIME_CONSTRAINT_DENOM': 1200, 'VISIONEGG_DARWIN_RE\
ALTIME_PREEMPTIBLE': 0, 'VISIONEGG_DARWIN_PTHREAD_PRIORITY': 'max',}