Tools to ease creating larger test libraries for Robot Framework using Python. The Robot Framework hybrid and dynamic library API gives more flexibility for library than the static library API, but they also sets requirements for libraries which needs to be implemented in the library side. PythonLibCore eases the problem by providing simpler interface and handling all the requirements towards the Robot Framework library APIs.
Code is stable and version 1.0 is already used by SeleniumLibrary and WhiteLibrary. The version 2.0 support changes in the Robot Framework 3.2.
There are two ways to use PythonLibCore, either by HybridCore or by using DynamicCore. HybridCore provides support for the hybrid library API and DynamicCore provides support for dynamic library API. Consult the Robot Framework User Guide, for choosing the correct API for library.
Regardless which library API is chosen, both have similar requirements.
- Library must inherit either the HybridCore or DynamicCore.
- Library keywords must be decorated with Robot Framework @keyword decorator.
- Provide a list of class instances implementing keywords to library_components argument in the HybridCore or DynamicCore __init__.
It is also possible implement keywords in the library main class, by marking method with @keyword as keywords. It is not requires pass main library instance in the library_components argument.
All keyword, also keywords implemented in the classes outside of the main library are available in the library instance as methods. This automatically publish library keywords in as methods in the Python public API.
The example in below demonstrates how the PythonLibCore can be used with a library.
python
"""Main library."""
from robotlibcore import DynamicCore
from mystuff import Library1, Library2
- class MyLibrary(DynamicCore):
"""General library documentation."""
- def __init__(self):
libraries = [Library1(), Library2()] DynamicCore.__init__(self, libraries)
@keyword def keyword_in_main(self): pass
python
"""Library components."""
from robotlibcore import keyword
class Library1(object):
@keyword def example(self): """Keyword documentation.""" pass
@keyword def another_example(self, arg1, arg2='default'): pass
- def not_keyword(self):
pass
class Library2(object):
@keyword('Custom name') def this_name_is_not_used(self): pass
@keyword(tags=['tag', 'another']) def tags(self): pass