Python library with useful functions for developers and QA needs
Project description
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 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.
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',
#... )
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.1.0.dev2268570544.tar.gz
Algorithm | Hash digest | |
---|---|---|
SHA256 | e493a089dedf90c28a9bf0ea79c10077489d9f38c01a34b052837b5e2c3cfd55 |
|
MD5 | 12fc988571e8cc2fba9bfca8d47d1bce |
|
BLAKE2b-256 | 6bd3ddf3917b050f3d81e031b18b08435e7ca4999c713b1d9df9fcd898f900b1 |
Close
Hashes for th2_common_utils-1.1.0.dev2268570544-py3-none-any.whl
Algorithm | Hash digest | |
---|---|---|
SHA256 | 932fc1d5890bd0b9c003bf3f306c141871478831700ce9f08063a94456abba58 |
|
MD5 | 4e91b5fcef1399ceea4452f61fb72ae7 |
|
BLAKE2b-256 | 892bdad2ed7bb02230da9d6979a57c8fbb46ccd55b28c98ded6a3a4c5ab63801 |