Skip to content

Commit 49ee200

Browse files
aaltataaltat
committed
Release notes for 5.0.0
1 parent 6117d8c commit 49ee200

File tree

1 file changed

+212
-0
lines changed

1 file changed

+212
-0
lines changed

‎docs/SeleniumLibrary-5.0.0.rst‎

Lines changed: 212 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,212 @@
1+
=====================
2+
SeleniumLibrary 5.0.0
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.0 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.
13+
14+
All issues targeted for SeleniumLibrary v5.0.0 can be found
15+
from the `issue tracker`_.
16+
17+
If you have pip_ installed, just run
18+
19+
::
20+
21+
pip install --upgrade robotframework-seleniumlibrary
22+
23+
to install the latest available release or use
24+
25+
::
26+
27+
pip install robotframework-seleniumlibrary==5.0.0
28+
29+
to install exactly this version. Alternatively you can download the source
30+
distribution from PyPI_ and install it manually.
31+
32+
SeleniumLibrary 5.0.0 was released on Saturday January 30, 2021. SeleniumLibrary supports
33+
Python 3.6+, Selenium 3.141.0+ and Robot Framework 3.1.2+.
34+
35+
.. _Robot Framework: http://robotframework.org
36+
.. _SeleniumLibrary: https://github.com/robotframework/SeleniumLibrary
37+
.. _Selenium: http://seleniumhq.org
38+
.. _pip: http://pip-installer.org
39+
.. _PyPI: https://pypi.python.org/pypi/robotframework-seleniumlibrary
40+
.. _issue tracker: https://github.com/robotframework/SeleniumLibrary/issues?q=milestone%3Av5.0.0
41+
42+
43+
.. contents::
44+
:depth: 2
45+
:local:
46+
47+
Most important enhancements
48+
===========================
49+
50+
Selenium 4 has deprecated all find_element_by_* methods, therefore move using find_element(By.*) (`#1575`_, alpha 1)
51+
--------------------------------------------------------------------------------------------------------------------
52+
SeleniumLibrary now uses find_element(By.*) methods to locate elements, instead of the deprecated find_element_by_*
53+
methods. This will result less warning messages in the outputs.
54+
55+
Many thanks for Badari to providing PR to make the change.
56+
57+
Support of list of locator-strings to use different strategies and WebElement as entry point. (`#1512`_, alpha 1)
58+
-----------------------------------------------------------------------------------------------------------------
59+
SeleniumLibrary offers support chain different types locators together. Example: Get WebElements xpath://a >> css:.foo
60+
is not possible.
61+
62+
There is small change the separator string is a backwards incompatible change, in that case, locator can be
63+
provided as a list.
64+
65+
Many thanks for Badari for providing the initial PR for implementing the chained locators.
66+
67+
Implement better IDE support for SeleniumLibrary (`#1588`_, alpha 1)
68+
--------------------------------------------------------------------
69+
SeleniumLibrary now provides Python `stub file`_/.pyi file for the SeleniumLibrary instance. This
70+
offers better automatic completions from Python IDE.
71+
72+
Backwards incompatible changes
73+
==============================
74+
75+
Support of list of locator-strings to use different strategies and WebElement as entry point. (`#1512`_, alpha 1)
76+
-----------------------------------------------------------------------------------------------------------------
77+
SeleniumLibrary offers support chain different types locators together. Example: Get WebElements xpath://a >> css:.foo
78+
is not possible.
79+
80+
There is small change the separator string is a backwards incompatible change, in that case, locator can be
81+
provided as a list.
82+
83+
Many thanks for Badari for providing the initial PR for implementing the chained locators.
84+
85+
Implement better IDE support for SeleniumLibrary (`#1588`_, alpha 1)
86+
--------------------------------------------------------------------
87+
SeleniumLibrary now provides Python `stub file`_/.pyi file for the SeleniumLibrary instance. This
88+
offers better automatic completions from Python IDE.
89+
90+
Remove deprecated keywords (`#1655`_, alpha 3)
91+
-----------------------------------------------
92+
Select Window and Locator Should Match X Times have been removed.
93+
94+
Boolean arguments are converted by Robot Framework (`#1676`_, beta 1)
95+
---------------------------------------------------------------------
96+
Boolean argument handling is not anymore done by the SeleniumLibrary. Instead library
97+
relies on the Robot Framework and type hints to perform conversion correctly.
98+
99+
100+
Drop Python 2 and Jython support (`#1444`_) (`#1451`_)
101+
------------------------------------------------------
102+
Support for Python 2 is dropped in this release. This also means that Jython is not anymore supported.
103+
Many thanks for hugovk for providing help in this task.
104+
105+
Acknowledgements
106+
================
107+
108+
This release also contained nice enhancements from the community.
109+
110+
Drag And Drop does not work with event firing (`#1653`_)
111+
--------------------------------------------------------
112+
Ed Manlove fixed bug (which is actually Selenium bug), if Event Firing WebDriver is used,
113+
all keywords that used Selenium Action Chains did fail. Now there is a workaround and
114+
keywords do work normally with Event Firing WebDriver.
115+
116+
Fix typo in locator documentation (`#1660`_)
117+
--------------------------------------------
118+
robco fixed documentation bug int he locator documentation.
119+
120+
Support of list of locator-strings to use different strategies and WebElement as entry point. (`#1512`_)
121+
--------------------------------------------------------------------------------------------------------
122+
badari412 provided initial implementation and inspiration for the list of locator-strings implementation.
123+
124+
Fix README (`#1665`_)
125+
---------------------
126+
I think someone did provide fix fow this, but I have lost track who that person was and I am sorry about that.
127+
If you want your name to be mentioned, please send us a PR to fix this doc.
128+
129+
130+
Full list of fixes and enhancements
131+
===================================
132+
133+
.. list-table::
134+
:header-rows: 1
135+
136+
* - ID
137+
- Type
138+
- Priority
139+
- Summary
140+
* - `#1444`_
141+
- enhancement
142+
- critical
143+
- Drop Python 2 support
144+
* - `#1451`_
145+
- enhancement
146+
- critical
147+
- Drop Jython support
148+
* - `#1575`_
149+
- enhancement
150+
- critical
151+
- Selenium 4 has deprecated all find_element_by_* methods, therefore move using find_element(By.*)
152+
* - `#1657`_
153+
- enhancement
154+
- critical
155+
- Add type hints to methods which are keywords
156+
* - `#1649`_
157+
- bug
158+
- high
159+
- Also add stub file to distribution
160+
* - `#1653`_
161+
- bug
162+
- high
163+
- Drag And Drop does not work with event firing
164+
* - `#1660`_
165+
- bug
166+
- high
167+
- Fix typo in locator documentation
168+
* - `#1512`_
169+
- enhancement
170+
- high
171+
- Support of list of locator-strings to use different strategies and WebElement as entry point.
172+
* - `#1588`_
173+
- enhancement
174+
- high
175+
- Implement better IDE support for SeleniumLibrary
176+
* - `#1655`_
177+
- enhancement
178+
- high
179+
- Remove deprecated keywords
180+
* - `#1676`_
181+
- enhancement
182+
- high
183+
- Boolean arguments are converted by Robot Framework
184+
* - `#1021`_
185+
- bug
186+
- medium
187+
- Some keywords do not work if text argument is not string
188+
* - `#1665`_
189+
- bug
190+
- medium
191+
- Fix README
192+
* - `#1652`_
193+
- enhancement
194+
- medium
195+
- Add support for xpath starting with ((//
196+
197+
Altogether 14 issues. View on the `issue tracker <https://github.com/robotframework/SeleniumLibrary/issues?q=milestone%3Av5.0.0>`__.
198+
199+
.. _#1444: https://github.com/robotframework/SeleniumLibrary/issues/1444
200+
.. _#1451: https://github.com/robotframework/SeleniumLibrary/issues/1451
201+
.. _#1575: https://github.com/robotframework/SeleniumLibrary/issues/1575
202+
.. _#1657: https://github.com/robotframework/SeleniumLibrary/issues/1657
203+
.. _#1649: https://github.com/robotframework/SeleniumLibrary/issues/1649
204+
.. _#1653: https://github.com/robotframework/SeleniumLibrary/issues/1653
205+
.. _#1660: https://github.com/robotframework/SeleniumLibrary/issues/1660
206+
.. _#1512: https://github.com/robotframework/SeleniumLibrary/issues/1512
207+
.. _#1588: https://github.com/robotframework/SeleniumLibrary/issues/1588
208+
.. _#1655: https://github.com/robotframework/SeleniumLibrary/issues/1655
209+
.. _#1676: https://github.com/robotframework/SeleniumLibrary/issues/1676
210+
.. _#1021: https://github.com/robotframework/SeleniumLibrary/issues/1021
211+
.. _#1665: https://github.com/robotframework/SeleniumLibrary/issues/1665
212+
.. _#1652: https://github.com/robotframework/SeleniumLibrary/issues/1652

0 commit comments

Comments
 (0)