Skip to content

Commit 41eb330

Browse files
committed
Update the Console Scripts documentation
1 parent 2496d17 commit 41eb330

File tree

1 file changed

+52
-0
lines changed

1 file changed

+52
-0
lines changed

seleniumbase/console_scripts/ReadMe.md

Lines changed: 52 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -49,6 +49,58 @@ file name while keeping the original file intact.
4949
Works with Katalon Recorder scripts.
5050
See: http://www.katalon.com/automation-recorder
5151

52+
### extract-objects
53+
54+
* Usage:
55+
``seleniumbase extract-objects [SELENIUMBASE_PYTHON_FILE]``
56+
57+
* Output:
58+
Creates page objects based on selectors found in a
59+
seleniumbase Python file and saves those objects to the
60+
"page_objects.py" file in the same folder as the tests.
61+
62+
### inject-objects
63+
64+
* Usage:
65+
``seleniumbase inject-objects [SELENIUMBASE_PYTHON_FILE] [OPTIONS]``
66+
67+
* Options:
68+
``-c``, ``--comments`` (Add object selectors to the comments.)
69+
70+
* Output:
71+
Takes the page objects found in the "page_objects.py"
72+
file and uses those to replace matching selectors in
73+
the selected seleniumbase Python file.
74+
75+
### objectify
76+
77+
* Usage:
78+
``seleniumbase objectify [SELENIUMBASE_PYTHON_FILE] [OPTIONS]``
79+
80+
* Options:
81+
``-c``, ``--comments`` (Add object selectors to the comments.)
82+
83+
* Output:
84+
A modified version of the file where the selectors
85+
have been replaced with variable names defined in
86+
"page_objects.py", supporting the Page Object Pattern.
87+
(This has the same outcome as combining
88+
``extract-objects`` with ``inject-objects``)
89+
90+
### revert-objects
91+
92+
* Usage:
93+
``seleniumbase revert-objects [SELENIUMBASE_PYTHON_FILE] [OPTIONS]``
94+
95+
* Options:
96+
``-c``, ``--comments`` (Keep existing comments for the lines.)
97+
98+
* Output:
99+
Reverts the changes made by ``seleniumbase objectify ...`` or
100+
``seleniumbase inject-objects ...`` when run against a
101+
seleniumbase Python file. Objects will get replaced by
102+
selectors stored in the "page_objects.py" file.
103+
52104
### download
53105

54106
* Usage:

0 commit comments

Comments
 (0)