Python API: sam v8_1_5
sam.getdate()

Just having some fun...
This is the python interface to the command 'sam get date'.
Command Description:

The 'sam getdate' utility is useful within other scripts
when you need to pass date information on the command line.

It allows you to do things like
   runMyProgram --start-date=`sam getdate YESTERDAY` --end-date=`sam getdate TOMORROW`

The "magic words" you may use are:
   TODAY         - midnight on this day
   YESTERDAY     - midnight of TODAY-1d
   TOMORROW      - midnight of TODAY+1d
   NOW           - right now
   START_OF_TIME - start of time

You may also use combinations such as

   sam getdate "TODAY+3d"     # 3 days from now
   sam getdate "TODAY-1m"     # 1 month ago
   sam getdate "TOMORROW+1y"  # 1 year from tomorrow


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

Return value: SamStruct.SamTime.SamTime

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
------------------------------------------------------------------------------------------------------------------------------------
(*) args                       SamTime              TODAY, YESTERDAY, etc., describes the date of interest
    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
    format                     string               format to use for output printing; default = %d-%b-%Y
    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
====================================================================================================================================

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: