Robocorp Tasks

4.1.1 · active · verified Thu Apr 16

robocorp-tasks is a Python framework designed to simplify the development of Python automations by providing a runner for tasks, offering logging out of the box, and managing the lifecycle for running such tasks. It is currently at version 4.1.1 and receives continuous updates as part of the broader Robocorp/Sema4.ai ecosystem.

Common errors

```
Error: "Sending logoff command to the desktop session"
```
cause This error can occur if the Windows Customer Experience Improvement Program interferes with desktop sessions, causing unexpected logoffs during automation.

fix Disable the Windows Group Policy 'User Account Control: Behavior of the elevation prompt for standard users' and 'Windows Customer Experience Improvement Program' settings. Refer to Robocorp documentation for specific policy paths.
```
UnicodeEncodeError or garbled characters in logs/output
```
cause Often related to Windows code page settings not being configured for Unicode, leading to character encoding issues.

fix Ensure your Windows system's code page is set to Unicode. Check Robocorp's troubleshooting guide for detailed steps on adjusting locale settings.
```
Encountering a PID lock in environment building
```
cause This typically indicates an issue during the creation or setup of the Python execution environment by RCC (Robocorp Command Center), possibly due to a stuck process or cache corruption.

fix Clear or clean up local environment caches using the `rcc` command-line tool. Consult RCC documentation for specific cache clearing commands.
```
ImportError: cannot import name '_internal_module' from 'robocorp.tasks'
```
cause Attempting to import internal modules or functions that are not part of the public API (indicated by a leading underscore).

fix Only import symbols that are part of the documented public API. Avoid importing any modules or functions that begin with an underscore (`_`).

Warnings

breaking The broader Robocorp ecosystem has transitioned focus from Robot Framework to Python. While existing Robot Framework bots continue to operate, all new development and tooling support is directed towards Python. Users should plan to migrate or develop new automations in Python.
Fix: Develop new automations in Python. Convert existing Robot Framework projects to Python where feasible.
deprecated The `Robocorp Code` VS Code extension has been deprecated and replaced by the `Sema4.ai extension`. Users should uninstall the old extension and install the new one for continued support and new features.
Fix: Uninstall 'Robocorp Code' extension from VS Code and install 'Sema4.ai Extension'.
gotcha Robocorp libraries with versions `0.x.x` are considered in development and may introduce breaking changes on any update. Although `robocorp-tasks` is now `4.x.x`, developers should always check the changelog for major version updates (`X.0.0`) for specific migration guidance as per SemVer.
Fix: Always consult the changelog (e.g., on PyPI or GitHub) when upgrading to a new major version to understand breaking changes and migration steps.
gotcha Modules and functions within the Robocorp libraries that start with an underscore (`_`) are considered internal and are not part of the public API. Importing or relying on these can lead to unexpected behavior or breaking changes in minor updates.
Fix: Only import and use symbols directly exposed under the `robocorp.<library>` namespace (e.g., `robocorp.tasks.task`), avoiding any `_` prefixed modules or functions.
gotcha In current versions, the `python -m robocorp.tasks run` command is designed to execute only one task per invocation. If multiple tasks are found in the target script/directory without a specific task name (`-t`) being provided, an error will be raised.
Fix: When running tasks, either ensure only one `@task` decorated function exists in the target file/directory, or explicitly specify the task to run using the `-t <task_name>` argument: `python -m robocorp.tasks run my_tasks.py -t my_specific_task`.

Install

pip install robocorp-tasks Install robocorp-tasks
pip install robocorp Install Robocorp metapackage (recommended for full ecosystem)

Imports

task
wrong:
```
from robocorp.robot import task
```
correct:
```
from robocorp.tasks import task
```
Old Robot Framework-centric paths or incorrect top-level imports are common mistakes.
setup
```
from robocorp.tasks import setup
```
Used for defining setup fixtures for tasks or sessions.
teardown
```
from robocorp.tasks import teardown
```
Used for defining teardown fixtures for tasks or sessions.

Quickstart

This quickstart defines a basic Robocorp task using the `@task` decorator. It uses `robocorp.log` for output and demonstrates how to access environment variables. Tasks are executed via the `python -m robocorp.tasks run` command, specifying the file or directory and optionally the task name.

import os
from robocorp.tasks import task
from robocorp import log

@task
def hello_robocorp_world():
    """A simple Robocorp task that logs a message."""
    name = os.environ.get('ROBOCORP_USER_NAME', 'World')
    log.info(f"Hello, {name} from Robocorp!")
    log.critical("This is a critical log message.")
    log.debug("This is a debug message.")

# To run: Save as tasks.py and execute 'python -m robocorp.tasks run tasks.py'
# You can also use 'python -m robocorp.tasks run . -t hello_robocorp_world' in a directory.

view raw JSON →