Revision: c08509658cab
Branch:   default
Author:   Janne Piironen <[email protected]>
Date:     Mon Jun 16 09:19:48 2014 UTC
Log:      DateTime: renamed calculation keywords

Update issue 415
We discussed the keyword name change within the team and considered it a good one. I renamed the keywords as proposed in Peke's comment above and updated tests and docs to match.
http://code.google.com/p/robotframework/source/detail?r=c08509658cab

Added:
 /atest/robot/standard_libraries/datetime/add_time_to_date.txt
 /atest/robot/standard_libraries/datetime/subtract_date_from_date.txt
 /atest/robot/standard_libraries/datetime/subtract_time_from_date.txt
 /atest/testdata/standard_libraries/datetime/add_time_to_date.txt
 /atest/testdata/standard_libraries/datetime/subtract_date_from_date.txt
 /atest/testdata/standard_libraries/datetime/subtract_time_from_date.txt
Deleted:
 /atest/robot/standard_libraries/datetime/add_to_date.txt
 /atest/robot/standard_libraries/datetime/subtract_dates.txt
 /atest/robot/standard_libraries/datetime/subtract_from_date.txt
 /atest/testdata/standard_libraries/datetime/add_to_date.txt
 /atest/testdata/standard_libraries/datetime/subtract_dates.txt
 /atest/testdata/standard_libraries/datetime/subtract_from_date.txt
Modified:
 /atest/testdata/standard_libraries/datetime/time_calculations.txt
 /src/robot/libraries/DateTime.py

=======================================
--- /dev/null
+++ /atest/robot/standard_libraries/datetime/add_time_to_date.txt Mon Jun 16 09:19:48 2014 UTC
@@ -0,0 +1,8 @@
+*** Settings ***
+Suite Setup Run Tests ${EMPTY} standard_libraries/datetime/add_time_to_date.txt
+Force Tags       regression    pybot    jybot
+Resource         atest_resource.txt
+
+*** Test Cases ***
+Time addition to date should succeed
+    Check Test Case    ${TESTNAME}
=======================================
--- /dev/null
+++ /atest/robot/standard_libraries/datetime/subtract_date_from_date.txt Mon Jun 16 09:19:48 2014 UTC
@@ -0,0 +1,8 @@
+*** Settings ***
+Suite Setup Run Tests ${EMPTY} standard_libraries/datetime/subtract_date_from_date.txt
+Force Tags       regression    pybot    jybot
+Resource         atest_resource.txt
+
+*** Test Cases ***
+Subtraction between two dates should succeed
+    Check Test Case    ${TESTNAME}
=======================================
--- /dev/null
+++ /atest/robot/standard_libraries/datetime/subtract_time_from_date.txt Mon Jun 16 09:19:48 2014 UTC
@@ -0,0 +1,8 @@
+*** Settings ***
+Suite Setup Run Tests ${EMPTY} standard_libraries/datetime/subtract_time_from_date.txt
+Force Tags       regression    pybot    jybot
+Resource         atest_resource.txt
+
+*** Test Cases ***
+Time subtraction from date should succeed
+    Check Test Case    ${TESTNAME}
=======================================
--- /dev/null
+++ /atest/testdata/standard_libraries/datetime/add_time_to_date.txt Mon Jun 16 09:19:48 2014 UTC
@@ -0,0 +1,20 @@
+*** Settings ***
+Library          DateTime
+Variables        datesandtimes.py
+Test Template    Addition should succeed
+
+*** Variables ***
+${DATE1}           ${datetime(2014, 4, 24, 21, 45, 12, 123000)}
+${DATE2}           ${datetime(2014, 4, 24, 22, 45, 12, 123000)}
+
+*** Test Cases ***
+Time addition to date should succeed
+    ${DATE1}               1 hour           ${DATE2}
+    ${DATE1}               1h               ${DATE2}
+ 22:45:12 2014.04.24 01:02:01.000 23:47:13 2014.04.24 %H:%M:%S %Y.%m.%d
+
+*** Keywords ***
+Addition Should Succeed
+    [Arguments]    ${date}    ${time}    ${expected}     ${format}=datetime
+ ${new_date} = Add Time To Date ${date} ${time} ${format} date_format=${format}
+    Should Be Equal    ${new_date}    ${expected}
=======================================
--- /dev/null
+++ /atest/testdata/standard_libraries/datetime/subtract_date_from_date.txt Mon Jun 16 09:19:48 2014 UTC
@@ -0,0 +1,26 @@
+*** Settings ***
+Library          DateTime
+Variables        datesandtimes.py
+Test Template    Subtraction Should Succeed
+
+*** Variables ***
+${DATE1}           ${datetime(2014, 4, 24, 21, 45, 12, 123000)}
+${DATE2}           ${datetime(2014, 4, 24, 22, 45, 12, 123000)}
+
+*** Test Cases ***
+Subtraction between two dates should succeed
+    [Template]  Subtraction should succeed
+    ${DATE2}                   ${DATE1}               1 hour
+    ${DATE1}                   ${DATE2}               - 1 hour
+ ${DATE2} ${DATE1} ${3600.0} result_format=number + ${DATE2} ${DATE1} 01:00:00.000 result_format=timer + ${DATE2} ${DATE1} 1h result_format=compact + ${DATE2} ${DATE1} ${timedelta(hours=1)} result_format=timedelta
+    2014.04.24 22:45:12.123    ${DATE1}               1 hour
+ 22:45:12 2014.04.24 2014-04-24 21.43.11 01:02:01.000 result_format=timer date1_format=%H:%M:%S %Y.%m.%d date2_format=%Y-%m-%d %H.%M.%S
+
+*** Keywords ***
+Subtraction Should Succeed
+ [Arguments] ${latter_date} ${former_date} ${expected} ${result_format}=verbose ${date1_format}=${NONE} ${date2_format}=${NONE} + ${diff} = Subtract Date From Date ${latter_date} ${former_date} ${result_format} date1_format=${date1_format} date2_format=${date2_format}
+    Should Be Equal    ${diff}    ${expected}
=======================================
--- /dev/null
+++ /atest/testdata/standard_libraries/datetime/subtract_time_from_date.txt Mon Jun 16 09:19:48 2014 UTC
@@ -0,0 +1,21 @@
+*** Settings ***
+Library          DateTime
+Variables        datesandtimes.py
+Test Template    Time Subtraction Should Succeed
+
+*** Variables ***
+${DATE1}           ${datetime(2014, 4, 24, 21, 45, 12, 123000)}
+${DATE2}           ${datetime(2014, 4, 24, 22, 45, 12, 123000)}
+
+*** Test Cases ***
+Time subtraction from date should succeed
+    ${DATE2}               1 hour                  ${DATE1}
+    ${DATE2}               ${timedelta(hours=1)}   ${DATE1}
+ 23:47:13 2014.04.24 01:02:01.000 22:45:12 2014.04.24 %H:%M:%S %Y.%m.%d + 23:47:13 2014.04.24 00:00:00.100 23:47:12 2014.04.24 %H:%M:%S %Y.%m.%d
+
+*** Keywords ***
+Time Subtraction Should Succeed
+    [Arguments]    ${date}    ${time}    ${expected}    ${format}=datetime
+ ${new_date} = Subtract Time From Date ${date} ${time} ${format} date_format=${format}
+    Should Be Equal    ${new_date}    ${expected}
=======================================
--- /atest/robot/standard_libraries/datetime/add_to_date.txt Mon May 26 12:20:29 2014 UTC
+++ /dev/null
@@ -1,8 +0,0 @@
-*** Settings ***
-Suite Setup Run Tests ${EMPTY} standard_libraries/datetime/add_to_date.txt
-Force Tags       regression    pybot    jybot
-Resource         atest_resource.txt
-
-*** Test Cases ***
-Time addition to date should succeed
-    Check Test Case    ${TESTNAME}
=======================================
--- /atest/robot/standard_libraries/datetime/subtract_dates.txt Mon May 26 12:20:29 2014 UTC
+++ /dev/null
@@ -1,8 +0,0 @@
-*** Settings ***
-Suite Setup Run Tests ${EMPTY} standard_libraries/datetime/subtract_dates.txt
-Force Tags       regression    pybot    jybot
-Resource         atest_resource.txt
-
-*** Test Cases ***
-Subtraction between two dates should succeed
-    Check Test Case    ${TESTNAME}
=======================================
--- /atest/robot/standard_libraries/datetime/subtract_from_date.txt Mon May 26 12:20:29 2014 UTC
+++ /dev/null
@@ -1,8 +0,0 @@
-*** Settings ***
-Suite Setup Run Tests ${EMPTY} standard_libraries/datetime/subtract_from_date.txt
-Force Tags       regression    pybot    jybot
-Resource         atest_resource.txt
-
-*** Test Cases ***
-Time subtraction from date should succeed
-    Check Test Case    ${TESTNAME}
=======================================
--- /atest/testdata/standard_libraries/datetime/add_to_date.txt Thu Jun 12 08:50:24 2014 UTC
+++ /dev/null
@@ -1,20 +0,0 @@
-*** Settings ***
-Library          DateTime
-Variables        datesandtimes.py
-Test Template    Addition should succeed
-
-*** Variables ***
-${DATE1}           ${datetime(2014, 4, 24, 21, 45, 12, 123000)}
-${DATE2}           ${datetime(2014, 4, 24, 22, 45, 12, 123000)}
-
-*** Test Cases ***
-Time addition to date should succeed
-    ${DATE1}               1 hour           ${DATE2}
-    ${DATE1}               1h               ${DATE2}
- 22:45:12 2014.04.24 01:02:01.000 23:47:13 2014.04.24 %H:%M:%S %Y.%m.%d
-
-*** Keywords ***
-Addition Should Succeed
-    [Arguments]    ${date}    ${time}    ${expected}     ${format}=datetime
- ${new_date} = Add To Date ${date} ${time} ${format} date_format=${format}
-    Should Be Equal    ${new_date}    ${expected}
=======================================
--- /atest/testdata/standard_libraries/datetime/subtract_dates.txt Thu Jun 5 08:56:18 2014 UTC
+++ /dev/null
@@ -1,26 +0,0 @@
-*** Settings ***
-Library          DateTime
-Variables        datesandtimes.py
-Test Template    Subtraction Should Succeed
-
-*** Variables ***
-${DATE1}           ${datetime(2014, 4, 24, 21, 45, 12, 123000)}
-${DATE2}           ${datetime(2014, 4, 24, 22, 45, 12, 123000)}
-
-*** Test Cases ***
-Subtraction between two dates should succeed
-    [Template]  Subtraction should succeed
-    ${DATE2}                   ${DATE1}               1 hour
-    ${DATE1}                   ${DATE2}               - 1 hour
- ${DATE2} ${DATE1} ${3600.0} result_format=number - ${DATE2} ${DATE1} 01:00:00.000 result_format=timer - ${DATE2} ${DATE1} 1h result_format=compact - ${DATE2} ${DATE1} ${timedelta(hours=1)} result_format=timedelta
-    2014.04.24 22:45:12.123    ${DATE1}               1 hour
- 22:45:12 2014.04.24 2014-04-24 21.43.11 01:02:01.000 result_format=timer date1_format=%H:%M:%S %Y.%m.%d date2_format=%Y-%m-%d %H.%M.%S
-
-*** Keywords ***
-Subtraction Should Succeed
- [Arguments] ${latter_date} ${former_date} ${expected} ${result_format}=verbose ${date1_format}=${NONE} ${date2_format}=${NONE} - ${diff} = Subtract Dates ${latter_date} ${former_date} ${result_format} date1_format=${date1_format} date2_format=${date2_format}
-    Should Be Equal    ${diff}    ${expected}
=======================================
--- /atest/testdata/standard_libraries/datetime/subtract_from_date.txt Thu Jun 12 08:50:24 2014 UTC
+++ /dev/null
@@ -1,21 +0,0 @@
-*** Settings ***
-Library          DateTime
-Variables        datesandtimes.py
-Test Template    Time Subtraction Should Succeed
-
-*** Variables ***
-${DATE1}           ${datetime(2014, 4, 24, 21, 45, 12, 123000)}
-${DATE2}           ${datetime(2014, 4, 24, 22, 45, 12, 123000)}
-
-*** Test Cases ***
-Time subtraction from date should succeed
-    ${DATE2}               1 hour                  ${DATE1}
-    ${DATE2}               ${timedelta(hours=1)}   ${DATE1}
- 23:47:13 2014.04.24 01:02:01.000 22:45:12 2014.04.24 %H:%M:%S %Y.%m.%d - 23:47:13 2014.04.24 00:00:00.100 23:47:12 2014.04.24 %H:%M:%S %Y.%m.%d
-
-*** Keywords ***
-Time Subtraction Should Succeed
-    [Arguments]    ${date}    ${time}    ${expected}    ${format}=datetime
- ${new_date} = Subtract From Date ${date} ${time} ${format} date_format=${format}
-    Should Be Equal    ${new_date}    ${expected}
=======================================
--- /atest/testdata/standard_libraries/datetime/time_calculations.txt Thu Jun 5 08:56:18 2014 UTC +++ /atest/testdata/standard_libraries/datetime/time_calculations.txt Mon Jun 16 09:19:48 2014 UTC
@@ -18,10 +18,10 @@
 *** Keywords ***
 Time Addition To Time Should Succeed
[Arguments] ${time1} ${time2} ${expected} ${result_format}=verbose - ${new_time} = Add To Time ${time1} ${time2} ${result_format} + ${new_time} = Add Time To Time ${time1} ${time2} ${result_format}
     Should Be Equal    ${new_time}    ${expected}

 Time Subtraction From Time Should Succeed
[Arguments] ${time1} ${time2} ${expected} ${result_format}=verbose - ${new_time} = Subtract From Time ${time1} ${time2} ${result_format} + ${new_time} = Subtract Time From Time ${time1} ${time2} ${result_format}
     Should Be Equal    ${new_time}    ${expected}
=======================================
--- /src/robot/libraries/DateTime.py    Sat Jun 14 21:56:17 2014 UTC
+++ /src/robot/libraries/DateTime.py    Mon Jun 16 09:19:48 2014 UTC
@@ -290,9 +290,9 @@
from robot.utils import elapsed_time_to_string, secs_to_timestr, timestr_to_secs

 __version__ = get_version()
-__all__ = ['convert_time', 'convert_date', 'subtract_dates',
-           'subtract_from_date', 'subtract_from_time',
-           'add_to_time', 'add_to_date', 'get_current_date']
+__all__ = ['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']


 def get_current_date(time_zone='local', increment=0,
@@ -374,8 +374,9 @@
     return Time(time).convert(result_format, millis=not exclude_millis)


-def subtract_dates(date1, date2, result_format='number', exclude_millis=False,
-                   date1_format=None, date2_format=None):
+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.

     Arguments:
@@ -390,17 +391,17 @@
- _date2_format:_ Specifies possible `custom timestamp` format of _date2_.

      Examples:
- | ${time} = | Subtract Dates | 2014-05-28 12:05:52 | 2014-05-28 12:05:10 |
-    | Should Be Equal | ${time}        | ${42}                   |
- | ${time} = | Subtract Dates | 2014-05-28 12:05:52 | 2014-05-27 12:05:10 | verbose |
-    | Should Be Equal | ${time}        | 1 day 42 seconds        |
+ | ${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        |
     """
     time = Date(date1, date1_format) - Date(date2, date2_format)
     return time.convert(result_format, millis=not exclude_millis)


-def add_to_date(date, time, result_format='timestamp', exclude_millis=False,
-                date_format=None):
+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.

     Arguments:
@@ -414,16 +415,16 @@
- _date_format:_ Specifies possible `custom timestamp` format of _date_.

     Examples:
- | ${date} = | Add To Date | 2014-05-28 12:05:03.111 | 7 days | - | Should Be Equal | ${date} | 2014-06-04 12:05:03.111 | | - | ${date} = | Add To Date | 2014-05-28 12:05:03.111 | 01:02:03:004 |
-    | Should Be Equal | ${date}     | 2014-05-28 13:07:06.115 |
+ | ${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 |
     """
     date = Date(date, date_format) + Time(time)
     return date.convert(result_format, millis=not exclude_millis)


-def subtract_from_date(date, time, result_format='timestamp',
+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.

@@ -438,16 +439,17 @@
- _date_format:_ Specifies possible `custom timestamp` format of _date_.

     Examples:
- | ${date} = | Subtract From Date | 2014-06-04 12:05:03.111 | 7 days |
-    | Should Be Equal | ${date}            | 2014-05-28 12:05:03.111 |
- | ${date} = | Subtract From Date | 2014-05-28 13:07:06.115 | 01:02:03:004 |
-    | Should Be Equal | ${date}            | 2014-05-28 12:05:03.111 |
+ | ${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 |
     """
     date = Date(date, date_format) - Time(time)
     return date.convert(result_format, millis=not exclude_millis)


-def add_to_time(time1, time2, result_format='number', exclude_millis=False):
+def add_time_to_time(time1, time2, result_format='number',
+                     exclude_millis=False):
     """Adds time to another time and returns the resulting time.

     Arguments:
@@ -458,16 +460,16 @@
milliseconds as explained in `millisecond handling`.

     Examples:
-    | ${time} =       | Add To Time | 1 minute          | 42       |
-    | Should Be Equal | ${time}     | ${102}            |
- | ${time} = | Add To Time | 3 hours 5 minutes | 01:02:03 | timer | exclude_millis=yes |
-    | Should Be Equal | ${time}     | 04:07:03          |
+    | ${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          |
     """
     time = Time(time1) + Time(time2)
     return time.convert(result_format, millis=not exclude_millis)


-def subtract_from_time(time1, time2, result_format='number',
+def subtract_time_from_time(time1, time2, result_format='number',
                        exclude_millis=False):
     """Subtracts time from another time and returns the resulting time.

@@ -480,10 +482,10 @@
milliseconds as explained in `millisecond handling`.

     Examples:
-    | ${time} =       | Subtract From Time | 00:02:30 | 100      |
-    | Should Be Equal | ${time}            | ${50}    |
- | ${time} = | Subtract From Time | ${time} | 1 minute | compact |
-    | Should Be Equal | ${time}            | - 10s    |
+    | ${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    |
     """
     time = Time(time1) - Time(time2)
     return time.convert(result_format, millis=not exclude_millis)

--

--- You received this message because you are subscribed to the Google Groups "robotframework-commit" group.
To unsubscribe from this group and stop receiving emails from it, send an email 
to [email protected].
For more options, visit https://groups.google.com/d/optout.

Reply via email to