Skip to content

Commit

Permalink
Prepared update version v0.7.0
Browse files Browse the repository at this point in the history
  • Loading branch information
Nakama3942 committed Jun 26, 2023
1 parent 60ec251 commit d2f67e2
Show file tree
Hide file tree
Showing 4 changed files with 61 additions and 3 deletions.
53 changes: 53 additions & 0 deletions CHANGELOG.md
Original file line number Diff line number Diff line change
Expand Up @@ -424,3 +424,56 @@ print(f"{GetAnsiFormat('reset/on')}Test string")
#### Enhancements:
- Added new animations and worked out the old ones;
- Added a new category of types: Timer, and 3 entries for it.

---

## "Buffer improvement" update v0.7.0 (26.06.2023)

#### Enhancements:
- All entry types were merged into one `entry()` method, and all type differences were moved to the `LoggerEntryTypes` (available), `ProcessEntryTypes` (available), `ServiceProcessEntryTypes` (not available), `ServiceTimerEntryTypes` (not available) classes;
- Due to the acquired complexity, a simplified version of the Logger was written - SimpleLogger, where all the cut Logger methods, such as `debug`, `message`, etc., were transferred;
- Removed the ability to create custom icon sets (and removed the icon set module);
- The ability to change the color of entries has been removed (now it is impossible to change the color scheme at all due to the new improved data storage system for entry types);
- Added new type `EnvironmentType`;
- Added new Logger environments:
- `PLAIN_CONSOLE`;
- `MARKDOWN`;
- `PLAIN`;
- All types (classes) created for use within the library have been redefined from their original modules into the new `basic.lib_types` package;
- Animations and Text buffers module moved to `src` package;
- Removed emptied package `text`;
- Removed `CombinationException`;
- Added `EnvironmentException` and `InitException`;
- Buffer updated:
- Added Buffer input implementation (because after creating a Logger object, you can't use the standard Python `print()`, `input()` and other functions that can affect console output when using the `CONSOLE` environment and the new `PLAIN_CONSOLE`) - now there is not only output in console, but also input (`input()` method in Buffer);
- Updated the `save()` method of the Text buffer (now the `clean` argument is important for any environment, since the Buffer of Logger can store not only log entries, which allows the `empty()` method, which is a standard `print()` in the library);
- The implementation of the `remove()` method in the buffer is complete;
- Added `clear()` and `load()` methods;
- `TextBufferType` is no longer an abstract class like other types-class;
- Buffer development completed;
- Added methods-publishers in the Logger, which display certain information about the Logger in the logs:
- `publish_id()` publishes the generated Logger ID;
- `publish_program_name()` publishes the name of the program whose work is being logged;
- `publish_environment()` publishes the environment in which the Logger works;
- `publish_global_settings()` publishes global Logger settings;
- `publish_author()` publishes the author of the library;
- `publish_license()` publishes a library license;
- `separator()` adds a separator in the form of a line of eighty dashes;
- Added wrapper methods in Logger for Buffer methods:
- `Logger.addy()`[^strange] - `TextBufferType.insert()`;
- `Logger.modify()`[^strange] - `TextBufferType.replace()`;
- `Logger.catchy()`[^strange] - `TextBufferType.pop()`;
- `Logger.extractly()`[^strange] - `TextBufferType.remove()`;
- `Logger.clearly()`[^strange] - `TextBufferType.clear()`;
- `Logger.savy()`[^strange] - `TextBufferType.save()`;
- `Logger.loady()`[^strange] - `TextBufferType.load()`;
- `Logger.getty()`[^strange] - `TextBufferType.input()`;
- Of the new wrapper and publisher methods, SimpleLogger implements:
- `SimpleLogger.print()` - `Logger.empty()`;
- `SimpleLogger.input()` - `Logger.getty()`;
- `SimpleLogger.save()` - `Logger.savy()`;
- `SimpleLogger.load()` - `Logger.loady()`;
- `SimpleLogger.separator()` - `Logger.separator()`;
- Optimized buffer initialization.

[^strange]: Why such strange names were chosen is a big story here ... Initially, each entry type represented a different method, but in the documentation, the entry was always represented by the word "entry". When the author had to add the `Logger.note_process()` method, there was a need to add lines without forming them (that is, to do a regular `print()` in the Logger, since there was already a functional in the buffer). Since it was thought that such strings would be called "empty", they began to be called "empty". Having already two methods ending in "y", other names were invented for all other Buffer wrapper methods with the main condition - the last letter "y". This was done just for fun. The native language of the author is Ukrainian.
7 changes: 4 additions & 3 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -88,9 +88,8 @@ Any information to the output can be turned off (according to the default, every
- [x] v0.5.1 - Hints update (added status message templates and hint symbols (icons) near log entries status)
- [x] v0.6.0 - Progress update (added start of some log entries in threads (process))
- [x] v0.6.1 - Animation update (added animations in processes)
- [ ] v0.7.0 - "Buffer improvement" update (added buffer clearing and loading)
- [ ] v0.7.1 - Conversion update (added conversion from Console type to HTML and vice versa)
- [ ] v0.7.2 - Search update (added search by log entry types)
- [x] v0.7.0 - "Buffer improvement" update (buffer development completed and entry type system reworked)
- [ ] v0.7.1 - Search update (added search by log entry types)
- [ ] v0.8.0 - Export update (added conversion to different types, such as csv, pdf, etc.)
- [ ] v0.9.0 - Extension update (made wheel format and instruction of toml)
- [ ] v0.9.1 - Documenting update (all updates since v0.7.0 are documented; updated old documentation; documentation site generation added)
Expand Down Expand Up @@ -132,6 +131,8 @@ pip install mighty_logger

## Usage

ATTENTION!!! OUTDATED MATERIAL! RELEVANCE - v0.6.1! WILL BE OVERWRITTEN IN v0.9.1!

This is the simplest example of using the library:

```python
Expand Down
2 changes: 2 additions & 0 deletions docs/APPLYING.md
Original file line number Diff line number Diff line change
@@ -1,6 +1,8 @@
## Applying
Instructions for using the library for practical purposes.

ATTENTION!!! OUTDATED MATERIAL! RELEVANCE - v0.6.1! WILL BE OVERWRITTEN IN v0.9.1!

#### Content
- [Applying](#applying)
- [Content](#content)
Expand Down
2 changes: 2 additions & 0 deletions docs/DATA.md
Original file line number Diff line number Diff line change
@@ -1,6 +1,8 @@
## Data
The library stores various important data for use that you may need to know while using the library.

ATTENTION!!! OUTDATED MATERIAL! RELEVANCE - v0.6.1! WILL BE OVERWRITTEN IN v0.9.1!

#### Content
- [Data](#data)
- [Content](#content)
Expand Down

0 comments on commit d2f67e2

Please sign in to comment.