Python API: sam v8_1_5
sam.updateFileParameters()

Just having some fun...
This is the python interface to the command 'sam update file parameters'.
Command Description:

Update the datafile Parameters associated with this file by
adding any new parameters, or replacing existing values with new
values.

Example:
       # a file named MyParamFile.py:
       from SamStruct.Params import Params
       newParams = Params({'Global' : {'newKeyword':'newValue',
                                        'existingKeyword':'newValue'},
                            'Reco' : {'newRecoWord':'newValue'}})

       # python interface:
       from Sam import sam
       sam.updateFileParameters(params=newParams, fileName='here_is_my_file')

       # or, define a 'params' object to be used by commandline:
       params = newParams
       
Command line usage with the above example:

       $ setup sam
       $ sam update file parameters --paramFile=MyParamFile.py --fileName='here_is_my_file'

       

Python Usage:
	from Sam import sam
	result = sam.updateFileParameters(...)

Return value: 

Arguments are passed as keyword-value pairs, as in:
	 myfunc(arg1='myarg', arg2='anotherarg', d=1)

Argument Keyword Description:
	(*) indicates that this keyword is required
	>>> indicates that either the API object or the CLI equivalent (<<<) is required
====================================================================================================================================
    KEYWORD                    DATA TYPE            DESCRIPTION
------------------------------------------------------------------------------------------------------------------------------------
    c                          SamBoolean           automatically close all servants after each method call
    corbaCallTimeout           int                  time in seconds for CORBA method calls to return before timing out (default: 0; zero implies no timeout)
    d                          SamBoolean           debug mode
(*) fileName                   string               name of an existing file to be updated
    paramFile                  string               name of a file defining a "params" object
    params                     Params               python dictionary of parameters to be updated
    retryInterval              int                  retry interval base in seconds; will multiply this base times retryCount (default: 5)
    retryJitter                int                  retry jitter, random jitter added to base retry interval times retryCount (default: 5)
    retryMaxCount              int                  number of times to retry CORBA calls for retriable exceptions (default: 25; zero implies no retries)
    s                          SamBoolean           retrySilently mode (do not issue messages to stderr on proxy retries)
    t                          SamBoolean           time-it mode (print additional info on timings)
    v                          SamBoolean           verbose mode
====================================================================================================================================

Must have at least one of:	
	(params, paramFile) 

Mutually exclusive keywords:	
	(params || paramFile) 

Environment Defaults:
	c = os.environ['SAM_PYAPI_AUTO_CLOSE_SERVANTS']
	corbaCallTimeout = os.environ['SAM_PYAPI_CORBA_CALL_TIMEOUT']
	retryInterval = os.environ['SAM_PYAPI_RETRY_INTERVAL']
	retryJitter = os.environ['SAM_PYAPI_RETRY_JITTER']
	retryMaxCount = os.environ['SAM_PYAPI_RETRY_MAX_COUNT']
	s = os.environ['SAM_PYAPI_RETRY_SILENTLY']



See Also: