Robot Framework Integrated Development Environment (RIDE)
dialoghelps.py
Go to the documentation of this file.
1 # Copyright 2008-2015 Nokia Networks
2 # Copyright 2016- Robot Framework Foundation
3 #
4 # Licensed under the Apache License, Version 2.0 (the "License");
5 # you may not use this file except in compliance with the License.
6 # You may obtain a copy of the License at
7 #
8 # http://www.apache.org/licenses/LICENSE-2.0
9 #
10 # Unless required by applicable law or agreed to in writing, software
11 # distributed under the License is distributed on an "AS IS" BASIS,
12 # WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
13 # See the License for the specific language governing permissions and
14 # limitations under the License.
15 
16 
17 def get_help(title):
18  return '\n'.join(_HELPS[title])
19 
20 
21 
24 _HELPS = {}
25 
28 _EXAMPLES = {
29 'ESCAPE': "Possible pipes in the value must be escaped with a backslash like '\|'.",
30 'TAG': "Separate tags with a pipe character like 'tag | second tag | 3rd'.",
31 'FIXTURE': "Separate possible arguments with a pipe character like 'My Keyword | arg 1 | arg 2'.",
32 'TIMEOUT': ("Use time syntax like '1min 10s' or '2 hours' or give the value as seconds.\n"
33  "Optional message can be specified like '3 minutes | My message here'."),
34 'ARGUMENTS': ("Specify the arguments separated with a pipe character like '${arg1} | ${arg2}'.\n"
35  "Default values are given using equal sign and the last argument can be a list variable.\n"
36  "Example: '${arg1} | ${arg2}=default value | @{rest}'.\n"
37  "Note. You can use variable shortcuts in this field.")
38 }
39 
40 for row in """
41 Scalar Variable
42 Give name and value of the variable.
43 
44 List Variable
45 Give name and value of the variable. Input list variable items into separate cells.
46 
47 Dictionary Variable
48 Give name and value of the variable. Input dictionary items into separate cells.
49 Individual items must be in format `key=value`
50 
51 Library
52 Give name, optional arguments and optional alias of the library to import.
53 Separate multiple arguments with a pipe character like 'arg 1 | arg 2'.
54 Alias can be used to import same library multiple times with different names.
55 
56 Variables
57 Give path and optional arguments of the variable file to import.
58 Separate multiple arguments with a pipe character like 'arg 1 | arg 2'.
59 %(ESCAPE)s
60 
61 Resource
62 Give path to the resource file to import.
63 Existing resources will be automatically loaded to the resource tree.
64 New resources must be created separately.
65 
66 Documentation
67 Give the documentation.
68 Simple formatting like *bold* and _italic_ can be used.
69 Additionally, URLs are converted to clickable links.
70 
71 Force Tags
72 These tags are set to all test cases in this test suite.
73 Inherited tags are not shown in this view.
74 %(TAG)s
75 %(ESCAPE)s
76 
77 Default Tags
78 These tags are set to all test cases in this test suite unless test cases have their own tags.
79 %(TAG)s
80 %(ESCAPE)s
81 
82 Tags
83 These tags are set to this test case in addition to Force Tags and they override possible Default Tags.
84 Inherited tags are not shown in this view.
85 %(TAG)s
86 %(ESCAPE)s
87 
88 Suite Setup
89 This keyword is executed before executing any of the test cases or lower level suites.
90 %(FIXTURE)s
91 %(ESCAPE)s
92 
93 Suite Teardown
94 This keyword is executed after all test cases and lower level suites have been executed.
95 %(FIXTURE)s
96 %(ESCAPE)s
97 
98 Test Setup
99 This keyword is executed before every test case in this suite unless test cases override it.
100 %(FIXTURE)s
101 %(ESCAPE)s
102 
103 Test Teardown
104 This keyword is executed after every test case in this suite unless test cases override it.
105 %(FIXTURE)s
106 %(ESCAPE)s
107 
108 Setup
109 This keyword is executed before other keywords in this test case.
110 Overrides possible Test Setup set on the suite level.
111 %(FIXTURE)s
112 %(ESCAPE)s
113 
114 Teardown
115 This keyword is executed after other keywords in this test case even if the test fails.
116 Overrides possible Test Teardown set on the suite level.
117 %(FIXTURE)s
118 %(ESCAPE)s
119 
120 Test Template
121 Specifies the default template keyword used by tests in this suite.
122 The test cases will contain only data to use as arguments to that keyword.
123 
124 Template
125 Specifies the template keyword to use.
126 The test itself will contain only data to use as arguments to that keyword.
127 
128 Arguments
129 %(ARGUMENTS)s
130 %(ESCAPE)s
131 
132 Return Value
133 Specify the return value. Use a pipe character to separate multiple values.
134 %(ESCAPE)s
135 
136 Test Timeout
137 Maximum time test cases in this suite are allowed to execute before aborting them forcefully.
138 Can be overridden by individual test cases using Timeout setting.
139 %(TIMEOUT)s
140 
141 Timeout
142 Maximum time this test/keyword is allowed to execute before aborting it forcefully.
143 With test cases this setting overrides Test Timeout set on the suite level.
144 %(TIMEOUT)s
145 
146 Metadata
147 Give a name and a value for the suite metadata.
148 
149 New Test Case
150 Give a name for the new test case.
151 
152 New User Keyword
153 Give a name and arguments for the new user keyword.
154 %(ARGUMENTS)s
155 
156 Copy User Keyword
157 Give a name for the new user keyword.
158 """.splitlines():
159  row = row.strip()
160  if not row:
161  current = None
162  elif current is None:
163  current = _HELPS.setdefault(row, [])
164  else:
165  current.append(row % _EXAMPLES)