Pre-release
This release is a pre-release and may not be stable for production use.
th2-common-utils-py (1.2.1)
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 methods to work with events:
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.create_timestamp()- createsTimestampwith current time.
To use functions above:
from th2_common_utils import create_event, create_event_id
my_event = create_event(id=create_event_id(),
name='My event',
#... )
1 maintainer
Metadata
1 maintainer
Release files for th2-common-utils 1.2.1.dev2434116454
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.2.1.dev2434116454.tar.gz | 10.8 kB | Details |
Built distribution (wheel)
| File | Interpreter | ABI | Platform | Reset |
|---|---|---|---|---|
| th2_common_utils-1.2.1.dev2434116454-py3-none-any.whl | Python 3 | none | any | Details |
Total release size: 28.9 kB
Release files / th2-common-utils-1.2.1.dev2434116454.tar.gz
| Download URL | th2-common-utils-1.2.1.dev2434116454.tar.gz |
|---|---|
| Size | 10.8 kB |
| Tags | Source |
|
SHA-256 checksum How to use checksums |
bac171a04f91f3fc1ab3f2f971bec4a29c161f0c5509f6c74fa9872e080d9ad7
|
|
BLAKE2b-256 checksum How to use checksums |
fafb6333048e6cb4c0a7a4cbce60252d8bdbe8e24347bdb6bef8c7956d90460c
|
| Upload date | |
|
Uploaded using Trusted Publishing? What is trusted publishing? |
No |
| Uploaded via |
twine/4.0.1 CPython/3.9.13
|
Release files / th2_common_utils-1.2.1.dev2434116454-py3-none-any.whl
| Download URL | th2_common_utils-1.2.1.dev2434116454-py3-none-any.whl |
|---|---|
| Size | 18.1 kB |
| Tags | Python 3 |
|
SHA-256 checksum How to use checksums |
07787ce67b264ce000f430bc35916837a50b3009c2b609ca0f8b9d6db8d13e2c
|
|
BLAKE2b-256 checksum How to use checksums |
c815228d19cee2e16b1892b0a1e57522c4479e3d5166fda311566b56987bc663
|
| Upload date | |
|
Uploaded using Trusted Publishing? What is trusted publishing? |
No |
| Uploaded via |
twine/4.0.1 CPython/3.9.13
|
