Th2-data-services

BugFixes

1. [TH2-4039] An empty filter is validated.

User impact and migration instructions
This release is not required any additional steps to use.

Features
1. [TH2-3497] EventsTreeCollection got `get_leaves_iter` method.
2. [TH2-3497] EventsTreeCollection got `len_trees` and `len_detached_events` properties.
3. [TH2-3497] EventsTree and EventsTreeCollection got representation(`__repr__`) and `summary` methods.
4. [TH2-3558] Added module-level functions `add_stderr_logger` and `add_file_logger` to easily enable logging.
5. [TH2-3546][TH2-3583] `INTERACTIVE_MODE` - global parameter was introduced.
6. `Data.use_cache()` <- True by default.
7. Added data methods to get cache files paths `Data.get_cache_filepath()` and `Data.get_pending_cache_filepath()`.
8. [TH2-3665] Added method get_tree_by_id in ETC.
9. [TH2-3592] Added logging in EventsTreeCollection module when ETC create with detached events.
10. [TH2-3475] Implement Data objects joining
11. [TH2-3467] Added utils classes to convert timestamps.
12. [TH2-3662][TH2-3492] Added `get_detached_events_iter` and `get_detached_events` methods in EventsTreeCollections.
* Warning: Property `detached_events` is deprecated and will be removed in the future.
13. [TH2-3496] Added get_parentless_tree_collection method in EventsTreeCollection.
14. [TH2-3905] Separate filer classes added instead of `th2_data_services.Filter` class.
* Warning: Class `th2_data_services.Filter` is deprecated and will be removed in the future.

Improvements
1. [TH2-3003] Added automatic attachment of example.py code in readme.md.
2. [TH2-3558] Added more debug info about Data cache using.
3. [TH2-3389] GetXById http-provider command handles 404 error status instead of JsonDecodeException.
4. [TH2-3663] Speed up len_detached_events property

BugFixes
1. [TH2-3557][TH2-3560] Parent Data cache file will be created if you iterate a child Data object now.
2. [TH2-3545][TH2-3580] The Data object now uses an absolute path, so it doesn't lose its cache file if you change the working directory.
3. [TH2-3546][TH2-3583] Data cache file will not be removed if you use `INTERACTIVE_MODE` and the file is being read.
4. [TH2-3487][TH2-3585] `data = Data(source_data, cache=True).map(func)` Data object didn't write the cache in such case before. Fixed.
5. [TH2-3558] Used loggers name fixed. Changed to __name__.
6. [TH2-3733] Provider API class generate standard URL (without duplicate '/' and '/' before query)
7. [TH2-3598] Method get_subtree returns tree as EventsTree class.
8. [TH2-3593][TH2-3664] Method get_root_by_id returns root by any non-root ID as Th2Event.
9. [TH2-3595] When ETC creates subtree or itself ETC doesn't copy incoming data-stream.
10. [TH2-3732] Log message in http.GetMessages contains name of the stream.
11. [TH2-3734] EventsTreeCollection append_event method doesn't add duplicate event.
12. [TH2-3596][TH2-3594][TH2-3473] EventsTreeCollections. Get or find methods includes parentless results, if parentless exists.

BugFixes
1. [TH2-3739] GRPCProvider5API is based on grpc v0.1.6 now.

BugFixes

1. [TH2-3700] Filter iterate values only once - fixed.

BugFixes

1. [TH2-3470] Fixed cache in commands GetEvents and GetMessages for http-provider.
2. [TH2-3337] Url now use utf-8 encoding.
3. [TH2-3474] Parentless tree has stub event instead empty event now.

Improvements

1. [TH2-3493] The method recover_unknown_events has become public.

The main goal of the release 1.0.0 is to implement new architecture that solves many of extension's problems.
It also allows you to create your own Commands/DataSources/SourceAPIs.

Attention

The new version has raised the major version. It means the users should update their code to work with the new DS lib.

Version 0.6.x won't have new features but will have bug fixes.

Version 1.x.y doesn't use any adapters by default, 0.6.x does. If you need the save behavior as previous,
use `CodecPipelinesAdapter` manually.

User impact and migration instructions

1. [I] There is no more old-style DataSource class.
[M] Use a specific class for your purposes (HTTPDataSource or GRPCDataSource).
2. [I] There are no more `get_x` methods in the DataSource classes. Instead, it has the command method. This method
takes an object of the Command class.
[M] So if you used `data_source.get_events_from_data_provider` use `data_source.command(GetEvents(ARGS))` instead.
from `data_source.get_messages_from_data_provider` to `data_source.command(GetMessages(ARGS).apply_adapter(
codec_pipeline_adapter))`
from `find_messages_by_id_from_data_provider` to `GetMessagesById` or `GetMessageById`
from `find_events_by_id_from_data_provider` to `GetEventsById` or `GetEventById`
if you used broken_events parameter initialize the command with use_stub=True parameter.
3. [I] Modules structure was changed.
[M] You need to change some import paths.
4. [I] All class constructors/methods have got explicit arguments.
[M] Change old args names to new if required.
5. [I] Set of classes to create `EventsTree` representation was significantly changed.
[M] Use `EventsTreesCollection` instead of `EventsTree`. `EventsTree` is a real tree structure now.
Note, `EventsTreesCollection` has other methods, see the example to understand how to work with it.
6. [I] `EventsTree2` was removed.
[M] Use `EventsTreesCollection` instead.
7. [I] Exceptions were updated.
[M] Update your try-except statements

Improvements

1. [TH2-3247] Move DS version 1.0.0 to python 3.7+
2. [TH2-3404] Exceptions were updated. Implemented library-based exceptions.
3. [TH2-3213] Old `data_source` module was removed.

Features

1. [TH2-2465] Added the module `th2_gui_report` to create a link by event id or message id.
2. [TH2-2274] rpt-data-provider GRPC interface was implemented.
3. [TH2-3194] New `EventsTree` solution implemented. It includes the best parts from previous trees.
The tree also got a lot of useful methods to work with it ([see doc](documentation/api/events_tree.events_tree.md)).
4. [TH2-2942] Pure Provider v5 APIs implemented: `GRPCProvider5API`, `HTTPProvider5API`.
5. [TH2-2944] Developed commands for http and grpc instead of `data_source` get/find methods.
6. [TH2-2994] Provider v5 data source classes implemented: `GRPCProvider5DataSource`, `HTTPProvider5DataSource`.
7. [TH2-2941] Interface classes implemented: `ISourceAPI`, `IDataSource`, `ICommand`, `IAdapter`.

BugFixes

1. [TH2-3168] Fixed iterations in nested loops for Data object with limit.
2. [TH2-3354] API Doc generator issue fixed.
3. [TH2-3216] Incorrect work of Data object with multi-looping with cache enabled fixed.