Pre-release
This release is a pre-release and may not be stable for production use.
th2-common-utils-py
Python library with useful functions for developers and QA needs.
Installation
pip install th2-common-utils
Usage
1. Message fields access
The library provides a convenient way for Message fields access.
Instead of this:
msg.fields['BO5Items'].list_value.values[0].message_value.fields['segment_instance_number'].message_value.fields['segment_number'].simple_value
You can do this:
import th2_common_utils
msg['BO5Items'][0]['segment_instance_number']['segment_number']
2. Converters
message_to_dict(message)- note, you will lose all metadata of the Message.dict_to_message(fields, session_alias, message_type)- where:- fields - required argument - message fields as a python dict;
- session_alias and message_type - optional arguments - used to generate message metadata.
dict_to_root_message_filter(message_type, message_filter, metadata_filter, ignore_fields, check_repeating_group_order, time_precision, decimal_precision)- all arguments are optional.message_to_typed_message(message, message_type)- where:- message - Message object;
- message_type - TypedMessage class object.
message_to_table(message)- where:- message - Message object or dict.
To import functions above:
from th2_common_utils import message_to_dict, dict_to_message # ...
3. Working with events
th2-common-utils provides the class to work with events - EventUtils.
Methods of EventUtils class:
create_event_body(component)- creates event body fromcomponentas bytes.create_event_id()- creates EventID.create_event(id, parent_id, start_timestamp, end_timestamp, status, name, type, body, attached_message_ids)- creates event; all arguments are optional.
To use functions above:
from th2_common_utils import EventUtils as eu
my_event = eu.create_event(id=eu.create_event_id,
name='My event',
#... )
1 maintainer
Metadata
1 maintainer
Release files for th2-common-utils 1.1.0.dev2300108594
For a detailed explanation of source distributions (sdists) and built distributions (wheels), please see the package formats documentation.
Source distribution (sdist)
| File | Size | Uploaded | |
|---|---|---|---|
| th2-common-utils-1.1.0.dev2300108594.tar.gz | 10.8 kB | Details |
Built distribution (wheel)
| File | Interpreter | ABI | Platform | Reset |
|---|---|---|---|---|
| th2_common_utils-1.1.0.dev2300108594-py3-none-any.whl | Python 3 | none | any | Details |
Total release size: 29.0 kB
Release files / th2-common-utils-1.1.0.dev2300108594.tar.gz
| Download URL | th2-common-utils-1.1.0.dev2300108594.tar.gz |
|---|---|
| Size | 10.8 kB |
| Tags | Source |
|
SHA-256 checksum How to use checksums |
58e92fe8e1a0cdb3e1565e8f9bb693cf8b45326626b9e0b4e4053214deb85803
|
|
BLAKE2b-256 checksum How to use checksums |
60aad281e0ffe9a7c9fb5e84abe6bee4e336a81662c565dd6e0847b21e55a1db
|
| Upload date | |
|
Uploaded using Trusted Publishing? What is trusted publishing? |
No |
| Uploaded via |
twine/4.0.0 CPython/3.9.12
|
Release files / th2_common_utils-1.1.0.dev2300108594-py3-none-any.whl
| Download URL | th2_common_utils-1.1.0.dev2300108594-py3-none-any.whl |
|---|---|
| Size | 18.1 kB |
| Tags | Python 3 |
|
SHA-256 checksum How to use checksums |
e9282e5f0970930c4aa76511df14268b8c3a78452549c1e1d782112460f19cb4
|
|
BLAKE2b-256 checksum How to use checksums |
56c6d525ca7683d5ad39d8585ed59577a71bb3505fbd4405d5121dafde8aef91
|
| Upload date | |
|
Uploaded using Trusted Publishing? What is trusted publishing? |
No |
| Uploaded via |
twine/4.0.0 CPython/3.9.12
|
