robot.libraries.DateTime Namespace Reference

Classes
class	Date
class	Time

Functions
def	add_time_to_date (date, time, result_format='timestamp', exclude_millis=False, date_format=None)
	Adds time to date and returns the resulting date. More...
def	add_time_to_time (time1, time2, result_format='number', exclude_millis=False)
	Adds time to another time and returns the resulting time. More...
def	convert_date (date, result_format='timestamp', exclude_millis=False, date_format=None)
	Converts between supported date formats. More...
def	convert_time (time, result_format='number', exclude_millis=False)
	Converts between supported time formats. More...
def	get_current_date (time_zone='local', increment=0, result_format='timestamp', exclude_millis=False)
	Returns current local or UTC time with an optional increment. More...
def	subtract_date_from_date (date1, date2, result_format='number', exclude_millis=False, date1_format=None, date2_format=None)
	Subtracts date from another date and returns time between. More...
def	subtract_time_from_date (date, time, result_format='timestamp', exclude_millis=False, date_format=None)
	Subtracts time from date and returns the resulting date. More...
def	subtract_time_from_time (time1, time2, result_format='number', exclude_millis=False)
	Subtracts time from another time and returns the resulting time. More...

Variables
list	__all__
	__version__ = get_version()

Function Documentation

add_time_to_date()

def robot.libraries.DateTime.add_time_to_date	(		date,
			time,
			result_format = 'timestamp',
			exclude_millis = False,
			date_format = None
	)

Adds time to date and returns the resulting date.

Arguments:
- ``date:``           Date to add time to in one of the supported
                      `date formats`.
- ``time:``           Time that is added in one of the supported
                      `time formats`.
- ``result_format:``  Format of the returned date.
- ``exclude_millis:`` When set to any true value, rounds and drops
                      milliseconds as explained in `millisecond handling`.
- ``date_format:``    Possible `custom timestamp` format of ``date``.

Examples:
| ${date} =       | Add Time To Date | 2014-05-28 12:05:03.111 | 7 days       |
| Should Be Equal | ${date}          | 2014-06-04 12:05:03.111 |              |
| ${date} =       | Add Time To Date | 2014-05-28 12:05:03.111 | 01:02:03:004 |
| Should Be Equal | ${date}          | 2014-05-28 13:07:06.115 |

Definition at line 439 of file DateTime.py.

add_time_to_time()

def robot.libraries.DateTime.add_time_to_time	(		time1,
			time2,
			result_format = 'number',
			exclude_millis = False
	)

Adds time to another time and returns the resulting time.

Arguments:
- ``time1:``          First time in one of the supported `time formats`.
- ``time2:``          Second time in one of the supported `time formats`.
- ``result_format:``  Format of the returned time.
- ``exclude_millis:`` When set to any true value, rounds and drops
                      milliseconds as explained in `millisecond handling`.

Examples:
| ${time} =       | Add Time To Time | 1 minute          | 42       |
| Should Be Equal | ${time}          | ${102}            |
| ${time} =       | Add Time To Time | 3 hours 5 minutes | 01:02:03 | timer | exclude_millis=yes |
| Should Be Equal | ${time}          | 04:07:03          |

Definition at line 484 of file DateTime.py.

convert_date()

def robot.libraries.DateTime.convert_date	(		date,
			result_format = 'timestamp',
			exclude_millis = False,
			date_format = None
	)

Converts between supported date formats.

Arguments:
- ``date:``           Date in one of the supported `date formats`.
- ``result_format:``  Format of the returned date.
- ``exclude_millis:`` When set to any true value, rounds and drops
                      milliseconds as explained in `millisecond handling`.
- ``date_format:``    Specifies possible `custom timestamp` format.

Examples:
| ${date} =       | Convert Date | 20140528 12:05:03.111   |
| Should Be Equal | ${date}      | 2014-05-28 12:05:03.111 |
| ${date} =       | Convert Date | ${date}                 | epoch |
| Should Be Equal | ${date}      | ${1401267903.111}       |
| ${date} =       | Convert Date | 5.28.2014 12:05         | exclude_millis=yes | date_format=%m.%d.%Y %H:%M |
| Should Be Equal | ${date}      | 2014-05-28 12:05:00     |

Definition at line 369 of file DateTime.py.

convert_time()

def robot.libraries.DateTime.convert_time	(		time,
			result_format = 'number',
			exclude_millis = False
	)

Converts between supported time formats.

Arguments:
- ``time:``           Time in one of the supported `time formats`.
- ``result_format:``  Format of the returned time.
- ``exclude_millis:`` When set to any true value, rounds and drops
                      milliseconds as explained in `millisecond handling`.

Examples:
| ${time} =       | Convert Time  | 10 seconds        |
| Should Be Equal | ${time}       | ${10}             |
| ${time} =       | Convert Time  | 1:00:01           | verbose |
| Should Be Equal | ${time}       | 1 hour 1 second   |
| ${time} =       | Convert Time  | ${3661.5} | timer | exclude_milles=yes |
| Should Be Equal | ${time}       | 01:01:02          |

Definition at line 391 of file DateTime.py.

get_current_date()

def robot.libraries.DateTime.get_current_date	(		time_zone = 'local',
			increment = 0,
			result_format = 'timestamp',
			exclude_millis = False
	)

Returns current local or UTC time with an optional increment.

Arguments:
- ``time_zone:``      Get the current time on this time zone. Currently only
                      ``local`` (default) and ``UTC`` are supported.
                      Has no effect if date is returned as an `epoch time`.
- ``increment:``      Optional time increment to add to the returned date in
                      one of the supported `time formats`. Can be negative.
- ``result_format:``  Format of the returned date (see `date formats`).
- ``exclude_millis:`` When set to any true value, rounds and drops
                      milliseconds as explained in `millisecond handling`.

Examples:
| ${date} =       | Get Current Date |
| Should Be Equal | ${date}          | 2014-06-12 20:00:58.946 |
| ${date} =       | Get Current Date | UTC                     |
| Should Be Equal | ${date}          | 2014-06-12 17:00:58.946 |
| ${date} =       | Get Current Date | increment=02:30:00      |
| Should Be Equal | ${date}          | 2014-06-12 22:30:58.946 |
| ${date} =       | Get Current Date | UTC                     | - 5 hours |
| Should Be Equal | ${date}          | 2014-06-12 12:00:58.946 |
| ${date} =       | Get Current Date | result_format=datetime  |
| Should Be Equal | ${date.year}     | ${2014}                 |
| Should Be Equal | ${date.month}    | ${6}                    |

Definition at line 334 of file DateTime.py.

subtract_date_from_date()

def robot.libraries.DateTime.subtract_date_from_date	(		date1,
			date2,
			result_format = 'number',
			exclude_millis = False,
			date1_format = None,
			date2_format = None
	)

Subtracts date from another date and returns time between.

Arguments:
- ``date1:``          Date to subtract another date from in one of the
                      supported `date formats`.
- ``date2:``          Date that is subtracted in one of the supported
                      `date formats`.
- ``result_format:``  Format of the returned time (see `time formats`).
- ``exclude_millis:`` When set to any true value, rounds and drops
                      milliseconds as explained in `millisecond handling`.
- ``date1_format:``   Possible `custom timestamp` format of ``date1``.
- ``date2_format:``   Possible `custom timestamp` format of ``date2``.

 Examples:
| ${time} =       | Subtract Date From Date | 2014-05-28 12:05:52     | 2014-05-28 12:05:10 |
| Should Be Equal | ${time}                 | ${42}                   |
| ${time} =       | Subtract Date From Date | 2014-05-28 12:05:52     | 2014-05-27 12:05:10 | verbose |
| Should Be Equal | ${time}                 | 1 day 42 seconds        |

Definition at line 414 of file DateTime.py.

subtract_time_from_date()

def robot.libraries.DateTime.subtract_time_from_date	(		date,
			time,
			result_format = 'timestamp',
			exclude_millis = False,
			date_format = None
	)

Subtracts time from date and returns the resulting date.

Arguments:
- ``date:``           Date to subtract time from in one of the supported
                      `date formats`.
- ``time:``           Time that is subtracted in one of the supported
                     `time formats`.
- ``result_format:``  Format of the returned date.
- ``exclude_millis:`` When set to any true value, rounds and drops
                      milliseconds as explained in `millisecond handling`.
- ``date_format:``    Possible `custom timestamp` format of ``date``.

Examples:
| ${date} =       | Subtract Time From Date | 2014-06-04 12:05:03.111 | 7 days |
| Should Be Equal | ${date}                 | 2014-05-28 12:05:03.111 |
| ${date} =       | Subtract Time From Date | 2014-05-28 13:07:06.115 | 01:02:03:004 |
| Should Be Equal | ${date}                 | 2014-05-28 12:05:03.111 |

Definition at line 463 of file DateTime.py.

subtract_time_from_time()

def robot.libraries.DateTime.subtract_time_from_time	(		time1,
			time2,
			result_format = 'number',
			exclude_millis = False
	)

Subtracts time from another time and returns the resulting time.

Arguments:
- ``time1:``          Time to subtract another time from in one of
                      the supported `time formats`.
- ``time2:``          Time to subtract in one of the supported `time formats`.
- ``result_format:``  Format of the returned time.
- ``exclude_millis:`` When set to any true value, rounds and drops
                      milliseconds as explained in `millisecond handling`.

Examples:
| ${time} =       | Subtract Time From Time | 00:02:30 | 100      |
| Should Be Equal | ${time}                 | ${50}    |
| ${time} =       | Subtract Time From Time | ${time}  | 1 minute | compact |
| Should Be Equal | ${time}                 | - 10s    |

Definition at line 506 of file DateTime.py.

Variable Documentation

__all__

list robot.libraries.DateTime.__all__

private

Initial value:

=  ['convert_time', 'convert_date', 'subtract_date_from_date',
           'subtract_time_from_date', 'subtract_time_from_time',
           'add_time_to_time', 'add_time_to_date', 'get_current_date']

Definition at line 304 of file DateTime.py.

__version__

robot.libraries.DateTime.__version__ = get_version()

private

Definition at line 303 of file DateTime.py.