Skip to content

Commit 1c9215d

Browse files
aaltataaltat
committed
Release notes for 5.0.0b1
1 parent f1e30e8 commit 1c9215d

File tree

1 file changed

+183
-0
lines changed

1 file changed

+183
-0
lines changed

‎docs/SeleniumLibrary-5.0.0b1.rst‎

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

0 commit comments

Comments
 (0)