Sardana custom settings¶
Sardana provides a module located at its root directory called
sardanacustomsettings
which stores global configuration options.
It can be modified permanently so that it affects all applications
(use with care), or accessed at run time for setting options for
the current execution.
This module contains some Sardana-wide default configurations.
The idea is that the final user may edit the values here to customize certain aspects of Sardana.
-
UNITTEST_DOOR_NAME
= 'door/demo1/1'¶ UnitTest door name: the door to be used by unit tests. UNITTEST_DOOR_NAME must be defined for running sardana unittests.
-
UNITTEST_POOL_DS_NAME
= 'unittest1'¶ UnitTests Pool DS name: Pool DS to use in unit tests.
-
UNITTEST_POOL_NAME
= 'pool/demo1/1'¶ UnitTests Pool Device name: Pool Device to use in unit tests.
-
LOG_FILES_SIZE
= 10000000.0¶ Size and number of rotating backups of the log files. The Pool and MacroServer Device servers will use these values for their logs.
-
SPOCK_INPUT_HANDLER
= 'CLI'¶ Input handler for spock interactive macros. Accepted values are:
“CLI”: Input via spock command line. This is the default.
“Qt”: Input via Qt dialogs
-
SCAN_RECORDER_MAP
= None¶ Use this map in order to avoid ambiguity with scan recorders (file) if extension is intended to be the recorder selector. Set it to a dict<str, str> where:
key - scan file extension e.g. “.h5”
value - recorder name
The SCAN_RECORDER_MAP will make an union with the dynamically (created map at the MacroServer startup) taking precedence in case the extensions repeats in both of them.
-
LOG_MACRO_FILTER
= 'sardana.macroserver.msmacromanager.LogMacroFilter'¶ Filter for macro logging: name of the class to be used as filter for the macro logging
if LOG_MACRO_FILTER is not defined no filter will be used
if LOG_MACRO_FILTER is wrongly defined a user warning will be issued and no filter will be used
if LOG_MACRO_FILTER is correctly defined but macro filter can not be initialized a user warning will be issued and no filter will be used
-
VALUE_BUFFER_CODEC
= 'pickle'¶ Type of encoding for ValueBuffer Tango attribute of experimental channels
-
VALUE_REF_BUFFER_CODEC
= 'pickle'¶ Type of encoding for ValueRefBuffer Tango attribute of experimental channels
-
MS_ENV_SHELVE_BACKEND
= None¶ Database backend for MacroServer environment implemented using shelve. Available options:
None (default) - first try “gnu” and if not available fallback to “dumb”
“gnu” - better performance than dumb, but requires installation of additional package e.g. python3-gdbm on Debian. At the time of writing of this documentation it is not available for conda.
“dumb” - worst performance but directly available with Python 3.
-
MACROEXECUTOR_MAX_HISTORY
= 100¶ macroexecutor maximum number of macros stored in the history. Available options:
None (or no setting) - unlimited history (may slow down the GUI operation if grows too big)
0 - history will not be filled
<int> - max number of macros stored in the history