Registry / testing / robotframework-excellib

robotframework-excellib

library2.0.1pypypiunverified

Robot Framework library for working with Excel documents, based on `openpyxl`. It provides keywords to allow opening, reading, writing, and saving Excel files within Robot Framework test automation. The current version is 2.0.1, with the latest release on June 18, 2020. The project appears to be in maintenance mode, with no recent development activity beyond the 2020 release.

testing data serialization

pip install robotframework-excellib

github ↗package ↗

INSTALL

IMPORT

SIG · ROBOTFRAMEWORK-EXC

robotframework-excellib

testingpythonv2.0.1

Install

2.2s avg

Import

—

Disk

25MB

Pass rate

10/ 10

Env Coverage10 / 10

glibc

3.9–3.13

musl

3.9–3.13

Install & Compatibility

Where this runs

tested against v2.0.1 · pip install

no network on importno background threads

Install × environment matrix

Each cell = how many times install + import succeeded across repeated harness runs. Partial = flaky.
glibc = Debian/Ubuntu slim · musl = Alpine Linux

musl

py 3.10–3.920 runs

installs and imports cleanly · install 0.0s · import 0.000s · 26.6MB

glibc

py 3.10–3.920 runs

installs and imports cleanly · install 2.2s · import 0.000s · 27MB

25MB installed

● package 25MB

Code

Verified usage

Verified import paths — ran on the pinned version, not inferred.

ExcelLibrary

✓ *** Settings *** Library ExcelLibrary

✗ import ExcelLibrary Library robotframework-excellib

Robot Framework libraries are imported using the 'Library' setting in the *** Settings *** section, not standard Python import statements, and typically by their class name, not the package name.

This quickstart demonstrates how to create a new Excel document, write data to cells, save it, and then open an existing document to read its contents using the `robotframework-excellib` keywords.

*** Settings *** Library ExcelLibrary *** Test Cases *** Create And Write Excel Document ${doc_id}= Create Excel Document doc_id=MyNewExcel Write Excel Cell row_num=1 col_num=1 value=Hello Write Excel Cell row_num=1 col_num=2 value=World Save Excel Document filename=output.xlsx Close Current Excel Document Read From Excel Document ${doc_id}= Open Excel Document filename=output.xlsx doc_id=ExistingExcel ${cell_value}= Read Excel Cell row_num=1 col_num=1 Should Be Equal As Strings ${cell_value} Hello Close Current Excel Document

Debug

Known issues

breakingThe `Open Excel Document` keyword had a breaking change in an unspecified version, adding a new `keep_vba` argument. Scripts using older keyword signatures without this argument may fail after upgrading.

fix

Review calls to `Open Excel Document` and ensure the `keep_vba` argument is provided, e.g., `Open Excel Document    filename.xlsx    my_doc_id    keep_vba=False`.

affects: <=2.0.0 (potentially)

gotchaThere are multiple Robot Framework Excel libraries with similar names (`robotframework-excellib` and `robotframework-excellibrary`). `robotframework-excellib` is based on `openpyxl` and supports Python 3 and `.xlsx` files. The older `robotframework-excellibrary` is typically for Python 2 and `xls` files (via `xlutils` and `xlrd`). Ensure you are installing and using the correct library for your Python version and file type.

fix

For Python 3 and `.xlsx` files, use `pip install robotframework-excellib`. For Python 2 and `.xls` files, you might need `robotframework-excellibrary` if it's still maintained for those specific requirements.

affects: All versions

gotchaAttempting to create or open an Excel document using an identifier (`doc_id`) that already exists in the library's internal cache will raise a `SuchIdIsExistException`. This often happens when re-running tests or not properly closing documents.

fix

Ensure all Excel documents are closed using `Close Current Excel Document` or `Close All Excel Documents` after use, especially before attempting to recreate or reopen a document with the same `doc_id`. Use unique `doc_id`s for different documents or within different test cases if they are expected to be open concurrently.

affects: All versions

Upgrade

Version history

2.0.1latest on PyPI · released Jun 18, 2020

Audit

Dependencies

openpyxlrequiredCore library for handling .xlsx Excel files, which `robotframework-excellib` is based upon.

Agent activity

14 hits · last 30 days

node

Perplexity

OpenAI (training)

Resources

githubhttps://github.com/peterservice-rnd/robotframework-excellib ↗

packagehttps://pypi.org/project/robotframework-excellib/ ↗