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
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
Filter files by name, interpreter, ABI, and platform.
If you're not sure about the file name format, learn more about wheel file names.
Copy a direct link to the current filters
File details
Details for the file th2-common-utils-1.1.0.dev2274297199.tar.gz.
File metadata
- Download URL: th2-common-utils-1.1.0.dev2274297199.tar.gz
- Upload date:
- Size: 10.7 kB
- Tags: Source
- Uploaded using Trusted Publishing? No
- Uploaded via: twine/4.0.0 CPython/3.9.12
File hashes
| Algorithm | Hash digest | |
|---|---|---|
| SHA256 |
0b407732004b39ab6b7fcc20b05ddb11ff17358b161f87a1f24fca565c73cc10
|
|
| MD5 |
f36af5ec0abb4e93586dfd35b9c6b869
|
|
| BLAKE2b-256 |
2b3e6acbf794724e3559b324f9a3253034001aa0af269c92a98e0eaa44f2477b
|
File details
Details for the file th2_common_utils-1.1.0.dev2274297199-py3-none-any.whl.
File metadata
- Download URL: th2_common_utils-1.1.0.dev2274297199-py3-none-any.whl
- Upload date:
- Size: 18.1 kB
- Tags: Python 3
- Uploaded using Trusted Publishing? No
- Uploaded via: twine/4.0.0 CPython/3.9.12
File hashes
| Algorithm | Hash digest | |
|---|---|---|
| SHA256 |
a26993ccd4827b85d7e7d0d98cf1a3652de99f3e99df9828cef1d319d9be83b1
|
|
| MD5 |
71c87a66f5d3a15689482026be059fee
|
|
| BLAKE2b-256 |
f6cd3b35b989b22d0d4f3a131eb97369eae8e4a54f1329895641b2b9c61119fd
|
