Python library with useful functions for developers and QA needs
Project description
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 fromcomponent
as 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()
- createsTimestamp
with 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',
#... )
Project details
Release history Release notifications | RSS feed
Download files
Download the file for your platform. If you're not sure which to choose, learn more about installing packages.
Source Distribution
Built Distribution
Close
Hashes for th2-common-utils-1.2.1.dev2468362759.tar.gz
Algorithm | Hash digest | |
---|---|---|
SHA256 | eb8295aeec6f8a7df3d41131ab03abd674a44033c5c4151268cd8f5a52575ec0 |
|
MD5 | 3ab290346971d3a256b0aa86a2e4fe7f |
|
BLAKE2b-256 | 535114b5902351277769c3f6e29f99e536638153b0517f2bbd04246d80990a29 |
Close
Hashes for th2_common_utils-1.2.1.dev2468362759-py3-none-any.whl
Algorithm | Hash digest | |
---|---|---|
SHA256 | 14284150538e5a2d1ae8714ef448ed80b84bc7b4dd42df5f75a92b3e2b7ed30b |
|
MD5 | 8a05b8fd6ba88fe8f8edf83d2809b0e9 |
|
BLAKE2b-256 | fab9148fab6566d60f335b116dcb68f6ba4f88cab11a2dad385487587f466924 |