Author: pekka.klarck
Date: Tue Apr 7 08:15:54 2009
New Revision: 1722
Modified:
trunk/doc/libraries/BuiltIn.html
Log:
regen
Modified: trunk/doc/libraries/BuiltIn.html
==============================================================================
--- trunk/doc/libraries/BuiltIn.html (original)
+++ trunk/doc/libraries/BuiltIn.html Tue Apr 7 08:15:54 2009
@@ -79,7 +79,7 @@
</head>
<body>
<h1>BuiltIn - Documentation</h1>
-<p><b>Version:</b> trunk 20090322</p>
+<p><b>Version:</b> trunk 20090403</p>
<h2 id="introduction">Introduction</h2>
<p class='libdoc'>BuiltIn library provides a set of often needed generic
keywords.<br />
@@ -99,6 +99,7 @@
<a href="#Create List" title="Returns a list containing given
items.">Create List</a>
<a href="#Evaluate" title="Evaluates the given expression in Python and
returns the results.">Evaluate</a>
<a href="#Fail" title="Fails the test immediately with the given
(optional) message.">Fail</a>
+<a href="#Get Count" title="Returns and logs how many times `item2` is
found from `item1`.">Get Count</a>
<a href="#Get Length" title="Returns and logs the length of the given
item.">Get Length</a>
<a href="#Get Time" title="Returns the current time in the requested
format.">Get Time</a>
<a href="#Grep" title="Returns the text grepped using
`pattern`.">Grep</a>
@@ -139,6 +140,7 @@
<a href="#Should Be Equal As Strings" title="Fails if objects are unequal
after converting them to
strings.">Should Be Equal As Strings</a>
<a href="#Should Be True" title="Fails if the given condition is not
true.">Should Be True</a>
<a href="#Should Contain" title="Fails if `item1` does not contain `item2`
one or more times.">Should Contain</a>
+<a href="#Should Contain X Times" title="Fails if `item1` does not contain
`item2` `count` times.">Should Contain X Times</a>
<a href="#Should End With" title="Fails if the string `str1` does not end
with the string `str2`.">Should End With</a>
<a href="#Should Match" title="Fails unless the given `string` matches the
given `pattern`.">Should Match</a>
<a href="#Should Match Regexp" title="Fails if `string` does not match
`pattern` as a regular expression.">Should Match Regexp</a>
@@ -149,13 +151,14 @@
<a href="#Should Not Be Equal As Strings" title="Fails if objects are
equal after converting them to
strings.">Should Not Be Equal As Strings</a>
<a href="#Should Not Be True" title="Fails if the given condition is
true.">Should Not Be True</a>
<a href="#Should Not Contain" title="Fails if `item1` contains `item2` one
or more times.">Should Not Contain</a>
+<a href="#Should Not Contain X Times" title="Fails if `item1` contains
`item2` `count`
times.">Should Not Contain X Times</a>
<a href="#Should Not End With" title="Fails if the string `str1` ends with
the string `str2`.">Should Not End With</a>
<a href="#Should Not Match" title="Fails if the given `string` matches the
given `pattern`.">Should Not Match</a>
<a href="#Should Not Match Regexp" title="Fails if `string` matches
`pattern` as a regular
expression.">Should Not Match Regexp</a>
<a href="#Should Not Start With" title="Fails if the string `str1` starts
with the string `str2`.">Should Not Start With</a>
<a href="#Should Start With" title="Fails if the string `str1` does not
start with the string `str2`.">Should Start With</a>
<a href="#Sleep" title="Pauses the test executed for the given
time.">Sleep</a>
-<a href="#Syslog" title="Logs the given message with the given level into
syslog.">Syslog</a>
+<a href="#Syslog" title="*DEPRECATED* Use `Log` keyword with WARN level
instead. This keyword will be removed in Robot Framework
2.2.">Syslog</a>
<a href="#Variable Should Exist" title="Fails unless the given variable
exists within the current scope.">Variable Should Exist</a>
<a href="#Variable Should Not Exist" title="Fails if the given variable
exists within the current
scope.">Variable Should Not Exist</a>
<a href="#Wait Until Keyword Succeeds" title="Waits until the specified
keyword succeeds or the given timeout
expires.">Wait Until Keyword Succeeds</a>
@@ -363,6 +366,30 @@
<td class="doc">Fails the test immediately with the given (optional)
message.</td>
</tr>
<tr>
+ <td class="kw"><a name="Get Count"></a>Get Count</td>
+ <td class="arg">item1, item2</td>
+ <td class="doc">Returns and logs how many times <span
class="name">item2</span> is found from <span class="name">item1</span>.<br
/>
+<br />
+This keyword works with Python strings and lists and all objects that
either have 'count' method or can be converted to Python lists.<br />
+<br />
+Example:<br />
+<table border="1" class="doc">
+<tr>
+<td>${count} =</td>
+<td>Get Count</td>
+<td>${some item}</td>
+<td>interesting value</td>
+</tr>
+<tr>
+<td>Should Be True</td>
+<td>5 < ${count} < 10</td>
+<td></td>
+<td></td>
+</tr>
+</table>
+</td>
+</tr>
+<tr>
<td class="kw"><a name="Get Length"></a>Get Length</td>
<td class="arg">item</td>
<td class="doc">Returns and logs the length of the given item.<br />
@@ -882,7 +909,7 @@
<br />
Variables set with this keyword are available everywhere within the scope
of the currently executed test suite. Setting variables with this keyword
thus has the same effect as creating them using the Variable table in the
test data file or importing them from variable files. Other test suites,
including possible child test suites, will not see variables set with this
keyword.<br />
<br />
-The variable name must be given either in the escaped format (e.g.
\${SCALAR} or \...@{list}) or without curly braces (e.g. $SCALAR or @LIST) to
prevent it from being resolved.<br />
+The name of the variable can be given either as a normal variable name
(e.g. ${NAME}) or in escaped format (e.g. \${NAME}), but the former works
only in Robot Framework 2.1 and newer.<br />
<br />
If a variable already exists within the new scope, its value will be
overwritten. Otherwise a new variable is created. If a variable already
exists within the current scope, the value can be left empty and the
variable within the new scope gets the value within the current scope.<br />
<br />
@@ -890,7 +917,7 @@
<table border="1" class="doc">
<tr>
<td>Set Suite Variable</td>
-<td>$GREET</td>
+<td>${GREET}</td>
<td>Hello, world!</td>
</tr>
<tr>
@@ -900,7 +927,7 @@
</tr>
<tr>
<td>Set Suite Variable</td>
-<td>\${ID}</td>
+<td>${ID}</td>
<td></td>
</tr>
</table>
@@ -1159,6 +1186,30 @@
</td>
</tr>
<tr>
+ <td class="kw"><a name="Should Contain X Times"></a>Should Contain X
Times</td>
+ <td class="arg">item1, item2, count, msg=None</td>
+ <td class="doc">Fails if <span class="name">item1</span> does not
contain <span class="name">item2</span> <span class="name">count</span>
times.<br />
+<br />
+Works with strings, lists and all objects that <a href="#Get Count"
class="name">Get Count</a> works with. The default error message can be
overridden with <span class="name">msg</span> and the actual count is
always logged.<br />
+<br />
+Examples:<br />
+<table border="1" class="doc">
+<tr>
+<td>Should Contain X Times</td>
+<td>${output}</td>
+<td>hello</td>
+<td>2</td>
+</tr>
+<tr>
+<td>Should Contain X Times</td>
+<td>${some list}</td>
+<td>value</td>
+<td>3</td>
+</tr>
+</table>
+</td>
+</tr>
+<tr>
<td class="kw"><a name="Should End With"></a>Should End With</td>
<td class="arg">str1, str2, msg=None, values=True</td>
<td class="doc">Fails if the string <span class="name">str1</span> does
not end with the string <span class="name">str2</span>.<br />
@@ -1304,6 +1355,30 @@
</td>
</tr>
<tr>
+ <td class="kw"><a name="Should Not Contain X Times"></a>Should Not
Contain X Times</td>
+ <td class="arg">item1, item2, count, msg=None</td>
+ <td class="doc">Fails if <span class="name">item1</span> contains <span
class="name">item2</span> <span class="name">count</span> times.<br />
+<br />
+Works with strings, lists and all objects that <a href="#Get Count"
class="name">Get Count</a> works with. The default error message can be
overridden with <span class="name">msg</span> and the actual count is
always logged.<br />
+<br />
+Examples:<br />
+<table border="1" class="doc">
+<tr>
+<td>Should Not Contain X Times</td>
+<td>${output}</td>
+<td>hello</td>
+<td>3</td>
+</tr>
+<tr>
+<td>Should Not Contain X Times</td>
+<td>${some list}</td>
+<td>value</td>
+<td>2</td>
+</tr>
+</table>
+</td>
+</tr>
+<tr>
<td class="kw"><a name="Should Not End With"></a>Should Not End With</td>
<td class="arg">str1, str2, msg=None, values=True</td>
<td class="doc">Fails if the string <span class="name">str1</span> ends
with the string <span class="name">str2</span>.<br />
@@ -1375,7 +1450,7 @@
<tr>
<td class="kw"><a name="Syslog"></a>Syslog</td>
<td class="arg">message, level=INFO</td>
- <td class="doc">Logs the given message with the given level into
syslog.</td>
+ <td class="doc"><b>DEPRECATED</b> Use <a href="#Log"
class="name">Log</a> keyword with WARN level instead. This keyword will be
removed in Robot Framework 2.2.</td>
</tr>
<tr>
<td class="kw"><a name="Variable Should Exist"></a>Variable Should
Exist</td>
@@ -1419,9 +1494,9 @@
</tr>
</table>
<p class="footer">
-Altogether 70 keywords.<br />
+Altogether 73 keywords.<br />
Generated by <a
href="http://code.google.com/p/robotframework/wiki/LibraryDocumentationTool";>libdoc.py</a>
-on 2009-03-25 22:52:34.
+on 2009-04-07 18:15:28.
</p>
</body>
</html>
