DIRAC Common Utilities

9.1.6 · active · verified Sat Apr 11

diraccommon is a Python library providing stateless utilities extracted from the main DIRAC framework for use by DiracX and other projects. As of version 9.1.6, it requires Python 3.11 or later and is actively maintained with frequent integration releases, indicating a rapid development and release cadence.

Warnings

breaking Python version requirement changed to 3.11 or higher. Older Python environments (e.g., 3.10 and below) are no longer supported.
Fix: Ensure your Python environment is version 3.11 or newer before upgrading or installing `diraccommon`.
breaking Database schema changes were introduced in version 9.1.1, including the removal of the `AccountingCache` table from `ResourceManagementDB` and removal of `ResourceStatus/StatusTypes` entries from CS.
Fix: For existing DIRAC deployments, administrators must follow the recommended MySQL and CS deployment steps detailed in the release notes for v9.1.1, including `DROP TABLE AccountingCache;` and removing specific CS entries.
breaking Significant database schema changes were introduced in version 9.1.0, including new indices on `JobDB.Jobs` and `PilotAgentsDB.PilotAgents`, and the dropping of `NodeHistory`, `NodeLog`, and `NodeStatus` tables from `ResourceStatusDB`.
Fix: Administrators upgrading existing DIRAC deployments to 9.1.0 or later must execute the recommended MySQL changes, including ALTER TABLE and DROP TABLE statements, as described in the v9.1.0 release notes.
gotcha The CLI argument `--diracx-dist-dir` was replaced with `--diracx-src-dir` in related `DiracX` components. Users migrating or updating scripts that interact with `DiracX` via CLI should be aware of this change.
Fix: Update any scripts or configurations that use `--diracx-dist-dir` to use `--diracx-src-dir` instead.

Install

pip install diraccommon Install latest version

Imports

S_OK, S_ERROR
```
from DIRAC.Core.Utilities.ReturnValues import S_OK, S_ERROR
```
Common return value objects often used in DIRAC projects. While 'diraccommon' provides utilities, these are fundamental throughout DIRAC.
get_example_value
```
from DIRAC.Core.Utilities.SomeUtilityModule import get_example_value
```
Specific utility imports will vary depending on the functionality required. 'diraccommon' typically exposes modules under the 'DIRAC.Core.Utilities' namespace.

Quickstart

This example demonstrates using a common utility function, `uniqueElements`, from `DIRAC.Core.Utilities.List` to process a list. Many of `diraccommon`'s utilities reside within the `DIRAC.Core.Utilities` sub-packages.

from DIRAC.Core.Utilities.List import uniqueElements

my_list = [1, 2, 2, 3, 4, 4, 5]
unique_items = uniqueElements(my_list)

print(f"Original list: {my_list}")
print(f"Unique elements: {unique_items}")

view raw JSON →