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.0.0.dev1893624661.tar.gz
Algorithm | Hash digest | |
---|---|---|
SHA256 | 31ca07d1d8f887f77de1fa01e4b4809976e1fbc10d0ec3374d529f87228c8ff4 |
|
MD5 | 496558c1f1ed2b9f904176bfffbb1713 |
|
BLAKE2b-256 | cb05f6b149c91737b7335ecc831744ba1a56daed5b2126f59e796a82d49d0e45 |
Close
Hashes for th2_common_utils-1.0.0.dev1893624661-py3-none-any.whl
Algorithm | Hash digest | |
---|---|---|
SHA256 | 92b7a9ebef13d0e8b8ac85cc793dce1ab0cd9bf71783f679fb584b7c178cc26f |
|
MD5 | b4b5066fae01567bdd97fe409bcd3de6 |
|
BLAKE2b-256 | 9cdb225b5f6943c32cd6ce57da5c5f83a5253f0bd6124cb6de5585792da9c447 |