Skip to content

Commit 602f714

Browse files
Shortened the usage syntax for the CrashReporters.
`console_crash_reporter` and `file_crash_reporter` are removed!
1 parent 78c43c8 commit 602f714

5 files changed

Lines changed: 62 additions & 9 deletions

File tree

CHANGES-LOG.md

Lines changed: 28 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -6,6 +6,34 @@ Help this project by [Donation](DONATE.md)
66
Changes log
77
-----------
88

9+
### 2.4.6
10+
11+
Shortened the usage syntax for the CrashReporters:
12+
13+
```python
14+
import log21
15+
16+
# Define a ConsoleReporter object
17+
console_reporter = log21.CrashReporter.ConsoleReporter()
18+
19+
20+
# This works with other `log21.CrashReporter.Reporter` subclasses as well.
21+
22+
# Old syntax (still supported)
23+
@console_reporter.reporter
24+
def divide_old(a, b):
25+
return a / b
26+
27+
28+
# New Syntax
29+
@console_reporter.reporter
30+
def divide_new(a, b):
31+
return a / b
32+
33+
```
34+
35+
`console_crash_reporter` and `file_crash_reporter` are removed!
36+
937
### 2.4.5
1038

1139
Added `no_color` parameter to ProgressBar.

README.md

Lines changed: 26 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -53,9 +53,33 @@ python setup.py install
5353
Changes
5454
-------
5555

56-
### 2.4.5
56+
### 2.4.6
5757

58-
Added `no_color` parameter to ProgressBar.
58+
Shortened the usage syntax for the CrashReporters:
59+
60+
```python
61+
import log21
62+
63+
# Define a ConsoleReporter object
64+
console_reporter = log21.CrashReporter.ConsoleReporter()
65+
66+
67+
# This works with other `log21.CrashReporter.Reporter` subclasses as well.
68+
69+
# Old syntax (still supported)
70+
@console_reporter.reporter
71+
def divide_old(a, b):
72+
return a / b
73+
74+
75+
# New Syntax
76+
@console_reporter.reporter
77+
def divide_new(a, b):
78+
return a / b
79+
80+
```
81+
82+
`console_crash_reporter` and `file_crash_reporter` are removed!
5983

6084
[Full Changes Log](https://github.com/MPCodeWriter21/log21/blob/master/CHANGES-LOG.md)
6185

log21/CrashReporter/Reporters.py

Lines changed: 4 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -135,6 +135,9 @@ def ignore(self, exception: _Type[BaseException]):
135135
else:
136136
raise ValueError('exception is already in the list of exceptions to ignore')
137137

138+
def __call__(self, func):
139+
return self.reporter(func)
140+
138141

139142
class ConsoleReporter(Reporter):
140143
"""
@@ -263,7 +266,7 @@ class EmailReporter(Reporter):
263266
>>> # Define a EmailReporter object
264267
>>> email_reporter = EmailReporter(
265268
... mail_host='smtp.yandex.ru',
266-
... mail_port=465,
269+
... port=465,
267270
... from_address='MyEmail@yandex.ru',
268271
... to_address='CodeWriter21@gmail.com',
269272
... password='My$up3rStr0ngP@assw0rd XD'

log21/__init__.py

Lines changed: 3 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -22,7 +22,7 @@
2222
from log21.Formatters import ColorizingFormatter, DecolorizingFormatter
2323
from log21.Colors import Colors, get_color, get_colors, ansi_escape, get_color_name, closest_color
2424

25-
__version__ = "2.4.5"
25+
__version__ = "2.4.6"
2626
__author__ = "CodeWriter21 (Mehrad Pooryoussof)"
2727
__github__ = "Https://GitHub.com/MPCodeWriter21/log21"
2828
__all__ = ['ColorizingStreamHandler', 'DecolorizingFileHandler', 'ColorizingFormatter', 'DecolorizingFormatter',
@@ -31,8 +31,8 @@
3131
'pprint', 'pretty_print', 'tree_format', 'TreePrint', 'Manager', 'get_color_name', 'closest_color',
3232
'ansi_escape', '__version__', '__author__', '__github__', 'debug', 'info', 'warning', 'warn', 'error',
3333
'critical', 'fatal', 'exception', 'log', 'basic_config', 'basicConfig', 'ProgressBar', 'progress_bar',
34-
'LoggingWindow', 'LoggingWindowHandler', 'get_logging_window', 'CrashReporter', 'console_crash_reporter',
35-
'file_crash_reporter', 'console_reporter', 'file_reporter']
34+
'LoggingWindow', 'LoggingWindowHandler', 'get_logging_window', 'CrashReporter', 'console_reporter',
35+
'file_reporter']
3636

3737
_manager = Manager()
3838
_logging.setLoggerClass(Logger)
@@ -455,7 +455,5 @@ def progress_bar(progress: float, total: float, width: int = None, prefix: str =
455455

456456

457457
console_reporter = CrashReporter.ConsoleReporter()
458-
console_crash_reporter = console_reporter.reporter
459458

460459
file_reporter = CrashReporter.FileReporter(file='crash_report.log')
461-
file_crash_reporter = file_reporter.reporter

setup.py

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -7,7 +7,7 @@
77
long_description = file.read()
88

99
DESCRIPTION = 'A simple logging package that helps you log colorized messages in Windows console.'
10-
VERSION = '2.4.5'
10+
VERSION = '2.4.6'
1111

1212
setup(
1313
name='log21',

0 commit comments

Comments
 (0)