Skip to content

Commit a7273f6

Browse files
committed
Release notes for 5.0.0a3
1 parent 73b7693 commit a7273f6

File tree

1 file changed

+173
-0
lines changed

1 file changed

+173
-0
lines changed

docs/SeleniumLibrary-5.0.0a3.rst

Lines changed: 173 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,173 @@
1+
=======================
2+
SeleniumLibrary 5.0.0a3
3+
=======================
4+
5+
6+
.. default-role:: code
7+
8+
9+
SeleniumLibrary_ is a web testing library for `Robot Framework`_ that utilizes
10+
the Selenium_ tool internally. SeleniumLibrary 5.0.0a3 is a new release with
11+
chained locators support and improving autocompletion from Python IDE. Support
12+
for Python 2 ja Jython is dropped in this release. Compared to Alpha 2, this
13+
release typing hints for keyword arguments and keyword documentation is generated
14+
by using Robot Framework 4 development version.
15+
16+
All issues targeted for SeleniumLibrary v5.0.0 can be found
17+
from the `issue tracker`_.
18+
19+
**REMOVE ``--pre`` from the next command with final releases.**
20+
If you have pip_ installed, just run
21+
22+
::
23+
24+
pip install --pre --upgrade robotframework-seleniumlibrary
25+
26+
to install the latest available release or use
27+
28+
::
29+
30+
pip install robotframework-seleniumlibrary==5.0.0a3
31+
32+
to install exactly this version. Alternatively you can download the source
33+
distribution from PyPI_ and install it manually.
34+
35+
SeleniumLibrary 5.0.0a3 was released on Monday September 28, 2020. SeleniumLibrary supports
36+
Python 3.6+, Selenium 3.141.0+ and Robot Framework 3.1.2+.
37+
38+
.. _Robot Framework: http://robotframework.org
39+
.. _SeleniumLibrary: https://github.com/robotframework/SeleniumLibrary
40+
.. _Selenium: http://seleniumhq.org
41+
.. _pip: http://pip-installer.org
42+
.. _PyPI: https://pypi.python.org/pypi/robotframework-seleniumlibrary
43+
.. _issue tracker: https://github.com/robotframework/SeleniumLibrary/issues?q=milestone%3Av5.0.0
44+
45+
46+
.. contents::
47+
:depth: 2
48+
:local:
49+
50+
Most important enhancements
51+
===========================
52+
53+
Selenium 4 has deprecated all find_element_by_* methods, therefore move using find_element(By.*) (`#1575`_, alpha 1)
54+
--------------------------------------------------------------------------------------------------------------------
55+
SeleniumLibrary now uses find_element(By.*) methods to locate elements, instead of the deprecated find_element_by_*
56+
methods. This will result less warning messages in the outputs.
57+
58+
Many thanks for Badari to providing PR to make the change.
59+
60+
Support of list of locator-strings to use different strategies and WebElement as entry point. (`#1512`_, alpha 1)
61+
-----------------------------------------------------------------------------------------------------------------
62+
SeleniumLibrary offers support chain different types locators together. Example: Get WebElements xpath://a >> css:.foo
63+
is not possible.
64+
65+
There is small change the separator string is a backwards incompatible change, in that case, locator can be
66+
provided as a list.
67+
68+
Many thanks for Badari for providing the initial PR for implementing the chained locators.
69+
70+
Implement better IDE support for SeleniumLibrary (`#1588`_, alpha 1)
71+
--------------------------------------------------------------------
72+
SeleniumLibrary now provides Python `stub file`_/.pyi file for the SeleniumLibrary instance. This
73+
offers better automatic completions from Python IDE.
74+
75+
Backwards incompatible changes
76+
==============================
77+
78+
Selenium 4 has deprecated all find_element_by_* methods, therefore move using find_element(By.*) (`#1575`_, alpha 1)
79+
--------------------------------------------------------------------------------------------------------------------
80+
SeleniumLibrary now uses find_element(By.*) methods to locate elements, instead of the deprecated find_element_by_*
81+
methods. This will result less warning messages in the outputs.
82+
83+
Many thanks for Badari to providing PR to make the change.
84+
85+
Support of list of locator-strings to use different strategies and WebElement as entry point. (`#1512`_, alpha 1)
86+
-----------------------------------------------------------------------------------------------------------------
87+
SeleniumLibrary offers support chain different types locators together. Example: Get WebElements xpath://a >> css:.foo
88+
is not possible.
89+
90+
There is small change the separator string is a backwards incompatible change, in that case, locator can be
91+
provided as a list.
92+
93+
Many thanks for Badari for providing the initial PR for implementing the chained locators.
94+
95+
Implement better IDE support for SeleniumLibrary (`#1588`_, alpha 1)
96+
--------------------------------------------------------------------
97+
SeleniumLibrary now provides Python `stub file`_/.pyi file for the SeleniumLibrary instance. This
98+
offers better automatic completions from Python IDE.
99+
100+
Remove deprecated keywords (`#1655`_, alpha 3)
101+
-----------------------------------------------
102+
Select Window and Locator Should Match X Times have been removed.
103+
104+
.. _stub file: https://www.python.org/dev/peps/pep-0484/#stub-files
105+
106+
Full list of fixes and enhancements
107+
===================================
108+
109+
.. list-table::
110+
:header-rows: 1
111+
112+
* - ID
113+
- Type
114+
- Priority
115+
- Summary
116+
- Added
117+
* - `#1444`_
118+
- enhancement
119+
- critical
120+
- Drop Python 2 support
121+
- alpha 1
122+
* - `#1451`_
123+
- enhancement
124+
- critical
125+
- Drop Jython support
126+
- alpha 1
127+
* - `#1575`_
128+
- enhancement
129+
- critical
130+
- Selenium 4 has deprecated all find_element_by_* methods, therefore move using find_element(By.*)
131+
- alpha 1
132+
* - `#1657`_
133+
- enhancement
134+
- critical
135+
- Add type hints to methods which are keywords
136+
- alpha 3
137+
* - `#1649`_
138+
- bug
139+
- high
140+
- Also add stub file to distribution
141+
- alpha 2
142+
* - `#1512`_
143+
- enhancement
144+
- high
145+
- Support of list of locator-strings to use different strategies and WebElement as entry point.
146+
- alpha 1
147+
* - `#1588`_
148+
- enhancement
149+
- high
150+
- Implement better IDE support for SeleniumLibrary
151+
- alpha 1
152+
* - `#1655`_
153+
- enhancement
154+
- high
155+
- Remove deprecated keywords
156+
- alpha 3
157+
* - `#1021`_
158+
- bug
159+
- medium
160+
- Some keywords do not work if text argument is not string
161+
- alpha 3
162+
163+
Altogether 9 issues. View on the `issue tracker <https://github.com/robotframework/SeleniumLibrary/issues?q=milestone%3Av5.0.0>`__.
164+
165+
.. _#1444: https://github.com/robotframework/SeleniumLibrary/issues/1444
166+
.. _#1451: https://github.com/robotframework/SeleniumLibrary/issues/1451
167+
.. _#1575: https://github.com/robotframework/SeleniumLibrary/issues/1575
168+
.. _#1657: https://github.com/robotframework/SeleniumLibrary/issues/1657
169+
.. _#1649: https://github.com/robotframework/SeleniumLibrary/issues/1649
170+
.. _#1512: https://github.com/robotframework/SeleniumLibrary/issues/1512
171+
.. _#1588: https://github.com/robotframework/SeleniumLibrary/issues/1588
172+
.. _#1655: https://github.com/robotframework/SeleniumLibrary/issues/1655
173+
.. _#1021: https://github.com/robotframework/SeleniumLibrary/issues/1021

0 commit comments

Comments
 (0)