Metadata-Version: 2.1
Name: th2_common_utils
Version: 1.0.0.dev1811327189
Summary: th2_common_utils
Home-page: https://github.com/th2-net/th2-common-utils-py
Author: TH2-devs
Author-email: th2-devs@exactprosystems.com
License: Apache License 2.0
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:
        ```python
        msg.fields['BO5Items'].list_value.values[0].message_value.fields['segment_instance_number'].message_value.fields['segment_number'].simple_value
        ```
        You can do this:
        ```python
        import th2_common_utils
        
        msg['BO5Items'][0]['segment_instance_number']['segment_number']
        ```
        
        ### 2. Convertors
        * `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**.
Platform: UNKNOWN
Requires-Python: >=3.7
Description-Content-Type: text/markdown
