Importing custom testing library in Robot Framework

Question

I am writing a custom testing library for Robot Framework in Python and I want to import it like this:

Library         CustomLibrary

I put the folder containing the source code on the PYTHONPATH but I am still getting the error: Importing test library 'CustomLibrary' failed: ImportError: No module named CustomLibrary

The CustomLibrary class is defined in the __init__.py file, like in the AppiumLibrary like this:

from CustomLibrary.keywords import *

class CustomLibrary(_CustomKeywords):
    ROBOT_LIBRARY_SCOPE = 'GLOBAL'

How can I solve this problem, so I can import it in Robot Framework? I want to keep the class definition inside the init file.

Have you checked this post? https://stackoverflow.com/questions/15746675/how-to-write-a-python-module-package — AutoTester213, Oct 08 '19 at 07:43
When you say _"put the folder containing the source code on PYTHONPATH"_, what do you mean? If `CustomLibrary` is a folder in the folder `foo`, are you putting `foo` on PYTHONPATh, or `foo/CustomLibrary`? — Bryan Oakley, Oct 08 '19 at 17:57

score 3 · Accepted Answer · answered Oct 08 '19 at 18:02

You need to make sure that the folder containing CustomLibrary is on PYTHONPATH.

For example, the following works as expected for me:

create a folder in /tmp named CustomLibrary
create a file named /tmp/CustomLibrary/__init__.py
define a class named CustomLibrary in /tmp/CustomLibrary/__init__.py
define a method in the CustomLibrary class
import the library in a test with Library CustomLibrary
add /tmp to PYTHONPATH and run robot. For example, robot --pythonpath /tmp example.robot

Importing custom testing library in Robot Framework

1 Answers1