Refactoring, fixes and new features for the 'chat.py' module #12

2023-09-17T09:43:36+02:00

juk0de commented

2023-09-17 09:43:36 +02:00

This Pull Request introduces several improvements in Chat and ChatDB classes defined in chat.py file of the chatmastermind module. The changes are aimed at optimizing code for better reusability and clarity, as well as introducing new features in the classes.

Changes:

New string constants (db_next_file, ignored_files, msg_location) are introduced for easier management of file related operations.
In the read_dir() and clear_dir() functions, an additional check is added to ignore certain files while processing chat data.
The Chat class is refactored to improve method naming and structuring. Several methods are renamed to follow a msg_<operation> pattern for better clarity. New methods such as msg_unique_id(), msg_unique_content() are added to handle more specific operations.
A new function validatate() has been introduced that performs checks on the chat messages when instantiating a new Chat or ChatDB instance.
The ChatDB class inherits the changes from Chat class. In addition, it's also extensively refactored. New methods like msg_gather(), msg_in_cache(), msg_in_db() etc. are added for more granular operations. Access to disk-level operations is now controlled by loc parameter in several methods. Functions that operate exclusively on the cache and DB directories now all have the prefix cache_ or db_.
Two new methods cache_move() and db_move() are added in ChatDB class to allow moving a given message to the cache directory and db directory respectively.

Testing:

New unit tests have been added to test_chat.py and existing tests have been modified to cover the new functions.

Impact:

These changes will improve overall code maintainability and extensibility of chat classes, will provide better error handling and allow more granular control over operations like moving messages, finding messages, sorting messages etc.

This Pull Request introduces several improvements in `Chat` and `ChatDB` classes defined in `chat.py` file of the `chatmastermind` module. The changes are aimed at optimizing code for better reusability and clarity, as well as introducing new features in the classes. ## Changes: 1. New string constants (`db_next_file`, `ignored_files`, `msg_location`) are introduced for easier management of file related operations. 2. In the `read_dir()` and `clear_dir()` functions, an additional check is added to ignore certain files while processing chat data. 3. The `Chat` class is refactored to improve method naming and structuring. Several methods are renamed to follow a `msg_<operation>` pattern for better clarity. New methods such as `msg_unique_id()`, `msg_unique_content()` are added to handle more specific operations. 4. A new function `validatate()` has been introduced that performs checks on the chat messages when instantiating a new `Chat` or `ChatDB` instance. 5. The `ChatDB` class inherits the changes from `Chat` class. In addition, it's also extensively refactored. New methods like `msg_gather()`, `msg_in_cache()`, `msg_in_db()` etc. are added for more granular operations. Access to disk-level operations is now controlled by `loc` parameter in several methods. Functions that operate exclusively on the cache and DB directories now all have the prefix `cache_` or `db_`. 6. Two new methods `cache_move()` and `db_move()` are added in `ChatDB` class to allow moving a given message to the cache directory and db directory respectively. ## Testing: New unit tests have been added to `test_chat.py` and existing tests have been modified to cover the new functions. ## Impact: These changes will improve overall code maintainability and extensibility of chat classes, will provide better error handling and allow more granular control over operations like moving messages, finding messages, sorting messages etc.

juk0de added 12 commits 2023-09-17 09:43:37 +02:00

chat: implemented special version of 'latest_message()' for the ChatDB class 5cb88dad1b

chat et al: '.next' and '.config.yaml' are now ignored by ChatDB 071871f929

chat: ChatDB now correctly ignores files that contain no valid messages 6ad404899e

refactor: renamed (almost) all Chat/ChatDB functions bbcff17558

chat: added new functions to ChatDB: msg_gather(), msg_find(), msg_remove() 454ce84d71

chat: added new functions: msg_unique_id(), msg_unique_content() and tests 829bfa31cd

message / chat: 'msg_id()' now returns 'file_path.stem' (removed suffix) ce4d45a434

chat: added validation during initialization 19c2b16301

chat: msg_remove() now supports multiple locations a571307d77

chat: added functions msg_in_cache() and msg_in_db(), also tests 30a62fcced

chat: added functions db_move() and chat_move() (and tests) 039d3fe3dc