With Python's try-except to receive notifications about Errors or Successes in your code through messenger app or email.
Development Status :: 3 - Alpha
Copyright (c) 2023 MinWoo Park, South Korea
The ExceptNotifier Python package offers a flexible approach to receiving notifications by enhancing Python's try-except statement. This package enables you to receive alerts through various messaging applications or emails.
With ExceptNotifier, you can obtain detailed compilation errors, including debug information, sent directly to your preferred messaging platform or email. By integrating OpenAI's ChatGPT, you can receive additional error code information as long as you provide the required API model name and key. This feature ensures that error handling and notifications are more informative and accessible, streamlining your debugging process.
Applicable to both IPython and Python, but needs to be ported differently only in ExceptNotifier. Please refer to the detailed example. (SuccessNotifier and SendNotifier have the same syntax.)
The latest stable release (and required dependencies) can be installed from PyPI:
pip install ExceptNotifier
You may instead want to use the development version from Github:
pip install git+https://github.com/dsdanielpark/ExceptNotifier.git
| App | Required Enviroment Variables | Free or Paid | Ease of Setup | Time Required for Setup | Guide Tutorial Link |
|---|---|---|---|---|---|
| Beep | N/A | Free | N/A | 0min | ExceptBeep |
| Desktop | N/A | Free | N/A | 0min | ExceptDesktop |
| Telegram | _TELEGRAM_TOKEN | Freemium | Easy | 2min | ExceptTelegram  |
| Discord | _DISCORD_WEBHOOK_URL | Freemium | Easy | 1min | ExceptDiscord |
| AWS Chime | _CHIME_WEBHOOK_URL | Freemium | Easy | 1min | ExceptChime |
| Slack | _SLACK_WEBHOOK_URL | Freemium | Easy | 3min | ExceptSlack |
| G-Mail | _GAMIL_RECIPIENT_ADDR, _GMAIL_SENDER_ADDR, _GMAIL_APP_PASSWORD_OF_SENDER | Restricted free | Medium | 3min | ExceptMail |
| Line | _LINE_NOTIFY_API_TOKEN | Freemium | Medium | 4min | ExceptLine |
| SMS | _TWILIO_SID, _TWILIO_TOKEN, _RECIPIENT_PHONE_NUMBER, _SENDER_PHONE_NUMBER | Not free | Medium | 5min | ExceptSMS |
| Microsoft Teams | _TEAMS_WEBHOOK_URL | Not Free | Medium | 5min | ExceptTeams |
| KakaoTalk | _KAKAO_TOKEN_PATH | Freemium | Hell | >=10min(Token refreshes daily) | ExceptKakao |
If you add the following two variables to the required variables for each application in the table above, you can receive error location and explanation, as well as examples, from OpenAI's model
| API | Required Variables | Free or Paid | Ease of Setup | Time Required for Setup | Guide Tutorial Link |
|---|---|---|---|---|---|
| OpenAI API | Required variables for each application+ _OPEN_AI_MODEL,_OPEN_AI_API | Not free | Easy | 2min | APIOpenAI |
| Google Bard API | Required variables for each application+ _BARD_API_KEY,'_BARD_ADVICE_LANG' | Free | Easy | 1min | Google Bard |
_BARD_ADVICE_LANG to 'ko' or 'jp'._PROMPT_COMMAND system variable.I will update tutorial ASAP. README.md is sufficient, but read the application's official documentation if necessary. However, we are preparing a more detailed and friendly tutorial.
In this example, some API keys were exposed by creating and removing a test application, but for security reasons, your API key should not be exposed to the outside world.
To use the desired application, you must define the necessary variables. Ensure that the variable names remain unchanged, and you can use either local or global variables. If you are using Telegram, an example is attached as an image.
Notifier
If you use Python's try except statement as it is, but change except as follows, you can receive notifications through your application.
[appName] ExceptChime, ExceptTelegram, ExceptDiscord, ExceptSMS, ExceptMail, ExceptKakao, ExceptLine, ExceptSlack, ExceptTeams, ExceptDesktope, ExceptBeep
Example
import sys, os
from ExceptNotifier import ExceptTelegram
sys.excepthook = ExceptTelegram.__call__
os.environ['_TELEGRAM_TOKEN'] = "xxxx"
try:
print(1/0)
except ExceptTelegram: # sending except message to telegram
sys.exit()
You can receive debugging information from ChatGPT via OpenAI's API when using the Except statement. The syntax remains the same, but you'll need to configure these two variables:
_OPEN_AI_MODEL,_OPEN_AI_API
Example
import sys, os
from ExceptNotifier import ExceptTelegram
sys.excepthook = ExceptTelegram.__call__
os.environ['_TELEGRAM_TOKEN'] = "xxxx"
os.environ['_OPEN_AI_MODEL']="gpt-3.5-turbo"
os.environ['_OPEN_AI_API']="sk-xxxxxx"
try:
print(1/0)
except ExceptTelegram: # sending msg WITH AI DEBUGGING to telegram
sys.exit()
You can receive debugging information from Google Bard via the python package Bard API. you'll need to configure a variable:
_BARD_API_KEY
(Optional) Google Bard officially supports Korean, so you can set the language of Bard Advice to Korean. Additionally, if _BARD_ADVICE_LANG is set to korean, debugging hints for code in Korean are provided. Just set a variable _BARD_ADVICE_LANG as 'ko'. Japanese is also supported. Set as 'jp'.
from ExceptNotifier import ExceptTelegram, SuccessTelegram, SendTelegram
import sys, os
sys.excepthook = ExceptTelegram.__call__
os.environ['_TELEGRAM_TOKEN'] = "xxxxxxxxx"
os.environ['_BARD_API_KEY']="xxxxxxxxx"
# os.environ['_BARD_ADVICE_LANG']="ko"
try:
print(1/0)
SuccessTelegram().__call__() #1. success sender
except ExceptTelegram as e: #2. except sender
sys.exit()
SendTelegram().__call__() #3. customized sender
Notifier
[appName]SuccessChime, SuccessTelegram, SuccessDiscord, SuccessSMS, SuccessMail, SuccessKakao, SuccessLine, SuccessSlack, SuccessTeams, SuccessDesktope, SuccessBeep
Example
import sys, os
from ExceptNotifier import SuccessTelgeram
sys.excepthook = ExceptTelegram.__call__
os.environ['_TELEGRAM_TOKEN'] = "xxxx"
try:
print(1/20)
SuccessTelgeram().__call__() # sending success message to telegram
except:
sys.exit()
Notifier
[appName]SendChime, SendTelegram, SendDiscord, SendSMS, SendMail, SendKakao, SendLine, SendSlack, SendTeams, SendDesktope, SendBeep
Example
import sys, os
from ExceptNotifier import SendTelegram
sys.excepthook = ExceptTelegram.__call__
os.environ['_TELEGRAM_TOKEN'] = "xxxx"
SendTelegram().__call__() # sending message to telegram
noti = SendTelegram()
noti() # sending message to telegram
It is recommended to conduct a simple message sending test through the sender. Assuming that you can communicate with REST API or WEBHOOK normally, ExceptNotifier can work normally.
[appName]_msgsend_chime_msg, send_telegram_msg, send_discord_msg, send_sms_msg, send_gmail_msg, send_kakao_msg, send_line_msg, send_slack_msg, send_teams_msg, send_desktop_msg, beep
Example
from ExceptNotifier import send_telegram_msg
send_telegram_msg(_TELEGRAM_TOKEN, "Any Test Message")
You can use all the same except for the python code and ExceptNotifier mentioned above. In other words, the SuccesNotifier, SendNotifier, and Sender functions can all be used same in IPython without any special processing. Only ExceptNotifier is need to be defined.
Notifier in IpythonYou have to use raise in Ipython ExceptNotifier.
Example code without Open AI API
from ExceptNotifier import ExceptTelegramIpython
import os
os.environ['_TELEGRAM_TOKEN'] = "xxxxx"
get_ipython().set_custom_exc((Exception,), ExceptTelegramIpython)
try:
print(1/0)
except:
raise
Example code With Open AI API
from ExceptNotifier import ExceptTelegramIpython
import os
get_ipython().set_custom_exc((Exception,), ExceptTelegramIpython)
os.environ['_OPEN_AI_MODEL'] = "gpt-3.5-turbo"
os.environ['_OPEN_AI_API'] = "sk-xxxxx"
os.environ['_TELEGRAM_TOKEN'] = "xxxxx"
try:
print(1/0)
except:
raise
Notifier in Ipython
import sys
import os
from ExceptNotifier import SuccessTelegram
os.environ['_TELEGRAM_TOKEN'] = "xxxxx"
try:
print(1/20) # Your Code Here
SuccessTelegram().__call__() # Sending Success message
except:
raise
Notifier in Ipython
import sys
import os
from ExceptNotifier import SendTelegram
os.environ['_TELEGRAM_TOKEN'] = "xxxxx"
SendTelegram().__call__() # Sending telegram message
from ExceptNotifier import send_telegram_msg
_TELEGRAM_TOKEN = "xxxxx"
send_telegram_msg(_TELEGRAM_TOKEN, "This is test message")
You can receive debugging information from ChatGPT via OpenAI's API when using the Except statement. The syntax remains the same, but you'll need to configure these two variables:
_OPEN_AI_MODEL,_OPEN_AI_API
You can receive debugging information from Google Bard via the python package Bard API when using the Except statement. The syntax remains the same, but you'll need to configure a variable:
_BARD_API_KEY
(Optional) Google Bard officially supports Korean, so you can set the language of Bard Advice to Korean. Additionally, if _BARD_ADVICE_LANG is set to korean, debugging hints for code in Korean are provided. Just set a variable _BARD_ADVICE_LANG as 'ko'. Japanese is also supported. Set as 'jp'.
As all classes function the same, the example will only use one image, like in Telegram.
Start_bot and must enter anything to your bot.
API TEST
from ExceptNotifier import send_telegram_msg
_TELEGRAM_TOKEN = "xxxxx:xxxxx-xxxx"
send_telegram_msg(_TELEGRAM_TOKEN, 'msg')
For more infomation, visit Telegram Bot Father API
Notifier
from ExceptNotifier import ExceptTelegram, SuccessTelegram, SendTelegram
import sys, os
sys.excepthook = ExceptTelegram.__call__
os.environ['_TELEGRAM_TOKEN'] = "xxxx"
try:
print(1/0)
SuccessTelegram().__call__() #1. success sender
except ExceptTelegram as e: #2. except sender
sys.exit()
SendTelegram().__call__() #3. customized sender
_OPEN_AI_API and _OPEN_AI_MODEL environment variables in all application use case, AI MODEL will automatically send debugging information as a message. Currently, it is mainly based on the GPT-3.5-TURBO model, but we plan to update it so that other models can be used later.
Notifierfrom ExceptNotifier import ExceptTelegram, SuccessTelegram, SendTelegram
import sys, os
sys.excepthook = ExceptTelegram.__call__
os.environ['_TELEGRAM_TOKEN'] = "xxxx"
os.environ['_OPEN_AI_MODEL']="gpt-3.5-turbo"
os.environ['_OPEN_AI_API']="sk-xxxxxx"
try:
print(1/0)
SuccessTelegram().__call__() #1. success sender
except ExceptTelegram as e: #2. except sender
sys.exit()
SendTelegram().__call__() #3. customized sender
_BARD_API_KEY. If you would like to receive guidance in Korean, you can optionally set the following. Set _BARD_ADVICE_LANG as ko or jp.
Notifierfrom ExceptNotifier import ExceptTelegram, SuccessTelegram, SendTelegram
import sys, os
sys.excepthook = ExceptTelegram.__call__
os.environ['_TELEGRAM_TOKEN'] = "xxxxxxxxx"
os.environ['_BARD_API_KEY']="xxxxxxxxx"
# os.environ['_BARD_ADVICE_LANG']="ko"
try:
print(1/0)
SuccessTelegram().__call__() #1. success sender
except ExceptTelegram as e: #2. except sender
sys.exit()
SendTelegram().__call__() #3. customized sender
In the except statement, an email is sent along with the error message. Additionally, you can send emails from any desired line.
API TEST
from ExceptNotifier import send_gmail_msg
_GMAIL_SENDER_ADDR = 'xxxx@gmail.com'
_GAMIL_RECIPIENT_ADDR = 'xxxx@gmail.com'
_GMAIL_APP_PASSWORD_OF_SENDER = 'xxxx'
subject_msg = "Test Title"
body_msg = "Test Body"
send_gmail_msg(
_GMAIL_SENDER_ADDR,
_GAMIL_RECIPIENT_ADDR,
_GMAIL_APP_PASSWORD_OF_SENDER,
subject_msg,
body_msg)
Notifier
import sys, os
from ExceptNotifier import ExceptMail, SuccessMail, SendMail
sys.excepthook = ExceptMail.__call__
# Define the next two variables optionally when using OpenAI's API.
# os.environ['_OPEN_AI_MODEL']="gpt-3.5-turbo"
# os.environ['_OPEN_AI_API']="sk-xxxxxx"
os.environ['_GAMIL_RECIPIENT_ADDR'] = 'xxxxxxx@gmail.com'
os.environ['_GMAIL_SENDER_ADDR'] = 'yyyyyy@gmail.com'
os.environ['_GMAIL_APP_PASSWORD_OF_SENDER'] = 'zzzzzz'
try:
main() # Your Code Here
SuccessMail().__call__() # No Exception -> Send Success mail.
except ExceptMail: # Exception -> Send Fail mail.
pass
SendMail().__call__() # When Process Ended -> Any Line mail.
import sys, os
from ExceptNotifier import ExceptMail, SuccessMail, SendMail
# Define the next two variables optionally when using OpenAI's API.
# os.environ['_OPEN_AI_MODEL']="gpt-3.5-turbo"
# os.environ['_OPEN_AI_API']="sk-xxxxxx"
os.environ['_GAMIL_RECIPIENT_ADDR'] = 'xxxxxxx@gmail.com'
os.environ['_GMAIL_SENDER_ADDR'] = 'yyyyyy@gmail.com'
os.environ['_GMAIL_APP_PASSWORD_OF_SENDER'] = 'zzzzzz'
sys.excepthook = ExceptMail.__call__
try:
# 02.Locate your code
print(1/0)
SuccessMail().__call__() # Success Mail
except ExceptMail as e: # Exception Mail
sys.exit()
print(e)
SendMail().__call__() # Put Any Line: Sending mail
import sys, os
from ExceptNotifier import ExceptMail, SuccessMail, SendMail
sys.excepthook = ExceptMail.__call__
# Define the next two variables optionally when using OpenAI's API.
# os.environ['_OPEN_AI_MODEL']="gpt-3.5-turbo"
# os.environ['_OPEN_AI_API']="sk-xxxxxx"
os.environ['_GAMIL_RECIPIENT_ADDR'] = 'xxxxxxx@gmail.com'
os.environ['_GMAIL_SENDER_ADDR'] = 'yyyyyy@gmail.com'
os.environ['_GMAIL_APP_PASSWORD_OF_SENDER'] = 'zzzzzz'
try:
'your code'
SuccessMail().__call__()
except ExceptMail:
pass
SendMail().__call__()
Edit Channel in the upper right corner of the chat window.Integrations - Webhook - New Webhook.Copy Webhook.
API TEST
from ExceptNotifier import send_discord_msg
send_discord_msg(_DISCORD_WEBHOOK_URL, "Any Test Message")
Notifier
import sys, os
from ExceptNotifier import ExceptDiscord, SuccessDiscord, SendDiscord
sys.excepthook = ExceptDiscord.__call__
# Define the next two variables optionally when using OpenAI's API.
# os.environ['_OPEN_AI_MODEL']="gpt-3.5-turbo"
# os.environ['_OPEN_AI_API']="sk-xxxxxx"
os.environ['_DISCORD_WEBHOOK_URL'] = "xxxxxxxxxxxxxxxxx"
try:
print(1/20)
SuccessDiscord().__call__() #1 success sender
except ExceptDiscord as e: #2 except sender
sys.exit()
SendDiscord().__call__() #3 customized sender
Room Setting in the upper right corner.Manage Webhook and botCopy Webhook.API TEST
from ExceptNotifier import send_chime_msg
send_chime_msg(_CHIME_WEBHOOK_URL, "Any Test Message")
Notifier
import sys, os
from ExceptNotifier import SuccessChime, ExceptChime, SendChime
sys.excepthook = ExceptChime.__call__
# Define the next two variables optionally when using OpenAI's API.
# os.environ['_OPEN_AI_MODEL']="gpt-3.5-turbo"
# os.environ['_OPEN_AI_API']="sk-xxxxxx"
os.environ['_CHIME_WEBHOOK_URL'] = "xxxxxxxxxxxxxxxxxx"
try:
print(1/0)
SuccessChime().__call__() #1 success sender
except ExceptChime as e: #2 except sender
sys.exit()
SendChime().__call__() #3 customized sender
Create an app - From scratch - Create AppIncoming Webhooks - Activate Incomming On - Add New Webhook to WorkspaceWebhook URLAPI TEST
from ExceptNotifier import send_slack_msg
send_slack_msg(_SLACK_WEBHOOK_URL, "Any Test Message")
Notifier
import sys
from ExceptNotifier import ExceptSlack, SuccessSlack, SendSlack
sys.excepthook = ExceptSlack.__call__
# Define the next two variables optionally when using OpenAI's API.
# os.environ['_OPEN_AI_MODEL']="gpt-3.5-turbo"
# os.environ['_OPEN_AI_API']="sk-xxxxxx"
os.environ['_SLACK_WEBHOOK_URL'] = 'https://hooks.slack.com/services/xxxxxxxxxxxxxxxxxxx'
try:
print(1/0)
SuccessSlack().__call__() #1 success sender
except ExceptSlack as e: #2 except sender
sys.exit()
SendSlack().__call__() #3 customized sender
Generate Token, enter Service Name and click 1-on-1 chat with LINE (anything you like)API TEST
from ExceptNotifier import send_line_msg
send_line_msg(_LINE_NOTIFY_API_TOKEN:, "Any Test Message")
Notifier
import sys
from ExceptNotifier import ExceptLine, SuccessLine, SendLine
sys.excepthook = ExceptLine.__call__
# Define the next two variables optionally when using OpenAI's API.
# os.environ['_OPEN_AI_MODEL']="gpt-3.5-turbo"
# os.environ['_OPEN_AI_API']="sk-xxxxxx"
os.environ['_LINE_NOTIFY_API_TOKEN'] = 'xxxxxxxxxxx'
try:
print(1/20)
SuccessLine().__call__() #1 success sender
except ExceptLine as e: #2 except sender
sys.exit()
SendLine().__call__() #3 customized sender
API TEST
from ExceptNotifier import send_sms_msg
_TWILIO_SID = 'xxxx'
_TWILIO_TOKEN = "xxxx"
_SENDER_PHONE_NUMBER = "xxxx"
_RECIPIENT_PHONE_NUMBER = "xxxx"
send_sms_msg(
_TWILIO_SID,
_TWILIO_TOKEN,
_SENDER_PHONE_NUMBER,
_RECIPIENT_PHONE_NUMBER,
"Any Test Message")
Notifier
import sys
from ExceptNotifier import ExceptSMS, SuccessSMS, SendSMS
sys.excepthook = ExceptSMS.__call__
# Define the next two variables optionally when using OpenAI's API.
# os.environ['_OPEN_AI_MODEL']="gpt-3.5-turbo"
# os.environ['_OPEN_AI_API']="sk-xxxxxx"
os.environ['_TWILIO_SID'] = 'xxxx'
os.environ['_TWILIO_TOKEN'] = 'yyyyyy'
os.environ['_RECIPIENT_PHONE_NUMBER']="+aaaaaa",
os.environ['_SENDER_PHONE_NUMBER']="+bbbbbb",
try:
print(1/10)
SuccessSMS().__call__() #1 success sender
except ExceptSMS as e: #2 except sender
sys.exit()
SendSMS().__call__() #3 customized sender
App - Search: webhook - Incoming Webhook https://teams.microsoft.com/l/app/203a1e2c-26cc-47ca-83ae-be98f960b6b2?source=app-details-dialogRequest Approval Connectors in Settings.Connectors After configuring webhook incoming in Connector, copy the webhook URL.API TEST
from ExceptNotifier import send_teams_msg
_TEAMS_WEBHOOK_URL = 'xxxx'
send_teams_msg(_TEAMS_WEBHOOK_URL, "Any Test Message")
Notifier
import sys
from ExceptNotifier import ExceptTeams, SuccessTeams, SendTeams
sys.excepthook = ExceptTeams.__call__
# Define the next two variables optionally when using OpenAI's API.
# os.environ['_OPEN_AI_MODEL']="gpt-3.5-turbo"
# os.environ['_OPEN_AI_API']="sk-xxxxxx"
os.environ['_TEAMS_WEBHOOK_URL'] = 'microsoft webhook _TEAMS_WEBHOOK_URL'
try:
print(1/20)
SuccessTeams().__call__() #1 success sender
except ExceptTeams as e: #2 except sender
sys.exit()
SendTeams().__call__() #3 customized sender
My Application on the top bar.Add an application, set a name, and create it.Kakao Login in the left menu, then change the State of Kakao Login Activation to ON on the resulting page.My Application > Product Settings > Kakao Login, be sure to set Redirect URI as follows: https://example.com/oauthSend message in KakaoTalk to optional agreement.REST API Key in My Application > App Settings > Summary.API TEST
from ExceptNotifier import send_kakao_msg
_KAKAO_TOKEN_PATH = 'xxx/xx/xxx.json'
send_kakao_msg(_KAKAO_TOKEN_PATH, msg)
Notifier
import sys
from ExceptNotifier import ExceptKakao, SuccessKakao, SendKakao
sys.excepthook = ExceptKakao.__call__
# Define the next two variables optionally when using OpenAI's API.
# os.environ['_OPEN_AI_MODEL']="gpt-3.5-turbo"
# os.environ['_OPEN_AI_API']="sk-xxxxxx"
os.environ['_KAKAO_TOKEN_PATH'] = 'xxxx/xxx/xxx.json''
try:
print(1/0)
SuccessKakao().__call__() #1 success sender
except ExceptKakao as e: #2 except sender
sys.exit()
SendKakao().__call__() #3 customized sender
a. Get Webhook URL by visiting here
API TEST
from ExceptNotifier import send_wechat_msg
send_wechat_msg(_WECHAT_WEBHOOK_URL, msg)
Notifier
import sys
from ExceptNotifier import ExceptWechat, SuccessWechat, SendWechat
# Define the next two variables optionally when using OpenAI's API.
# os.environ['_OPEN_AI_MODEL']="gpt-3.5-turbo"
# os.environ['_OPEN_AI_API']="sk-xxxxxx"
os.environ['_WECHAT_WEBHOOK_URL'] = "xxxxxxxxxxx"
sys.excepthook = ExceptWechat.__call__
try:
print(1/0)
SuccessWechat().__call__() #1 success sender
except ExceptWechat as e: #2 except sender
sys.exit()
SendWechat().__call__() #3 customized sender
No setup is required. Use as follows.
TEST
from ExceptNotifier import beep
beep(sec=1, freq=1000)
Notifier
from Exceptnotifier import ExceptBeep, SuccessBeep, SendBeep(), beep()
os.environ['BEEP_TIME'] = 1
sys.excepthook = ExceptBeep.__call__
try:
print(1/20)
SuccessBeep().__call__() #1 success beep-beep
except ExceptBeep as e: #2 except beep-beep
sys.exit()
SendBeep().__call__() #3 customized beep-beep
beep()
No setup is required. Use as follows.
TEST
from ExceptNotifier import send_desktop_msg
title_msg = "Test Title"
body_msg = "Test Body"
DISP_TIME = 5
send_desktop_msg(title_msg, body_msg, DISP_TIME)
Notifier
from ExceptNotifier import ExceptDesktop, SuccessDesktop, SendDesktop
sys.excepthook = ExceptDesktop.__call__
# Define the next two variables optionally when using OpenAI's API.
# os.environ['_OPEN_AI_MODEL']="gpt-3.5-turbo"
# os.environ['_OPEN_AI_API']="sk-xxxxxx"
try:
print(1/0)
SuccessDesktop().__call__() #1 success sender
except ExceptDesktop as e: #2 except sender
sys.exit()
SendDesktop().__call__() #3 customized sender
Official Document: https://exceptnotifier.readthedocs.io/en/latest/
Documentation can be automatically generated by Sphinx. But, I do not use Google style because it requires the Napoleon extension for Sphinx. I will use m2r to convert the README.md file to .rst so that it can be included.
Having generated it with Sphinx, we can also host the documentation freely at ReadTheDocs.org.
ExceptNotifier: MIT
Licenses apply the each dependencies package, and the created posts follow CC BY-NC-SA.
Sincerely grateful for any reports on new features or bugs. Your valuable feedback on the code is highly appreciated. [Open a new issue]
I will announce contributing rules when the code development status changes to beta soon. Until then, please create an issue for feature requests and bug reports. I would greatly appreciate it if you use it a lot and give your opinions generously. Thank you sincerely.
Everyone participating in the ExceptNotifier project, and in particular in the issue tracker, pull requests, and social media activity, is expected to treat other people with respect and more generally to follow the guidelines articulated in the Python Community Code of Conduct.
:mortar_board: Core maintainer: Daniel Park, South Korea
:envelope: Email: parkminwoo1991@gmail.com
Applying ExceptNotifier in Python
In Python, we use sys.excepthook to call the exceptnotifier by taking advantage of the interpreter calling sys.excepthook with three arguments (exception class, exception instance, traceback object) when an exception occurs. Since sys.excepthook is the highest-level exception handler that occurs just before the system shuts down, exceptnotifier is implemented as a class that inherits from baseexception and overrides sys.excepthook. For overriding exceptions that cannot be raised or exceptions raised in threads, please refer to the sys.unraisablehook() function and the threading.excepthook() function, respectively.
Application of ExceptNotifier in iPython
Strictly, iPython is a package, not a programming language like Python, but it has been classified to aid understanding. IPython (Interactive Python) is a package consisting of a command shell for interactive computing for multiple programming languages.
It is a very useful package that allows you to compile Python bit by bit in an interactive session through the concept of an interactive shell, but in iPython, control by sys.excepthook occurs just before the prompt is returned, so it is impossible to receive a traceback object using sys.excepthook and send an error message to each messenger app. Additionally, because it was necessary to inherit from baseexception, it was necessary to override other functions in iPython.
Therefore, at first, we considered the magics in cell, but the problem of having to import the magic function every time in the cell can be cumbersome to use, so we decided to use the set_custom_exc in iPython, which can work even by overriding it once. The set_custom_exc allows you to set a custom exception handler that is called when an exception in the exc_tuple occurs in the main loop (especially the run_code() method), and is designed so that the handle can return a structured traceback or None. Therefore, we can receive the traceback and send it to each messenger app. The order of top-level exception handling in iPython is different. You can use by calling raise in the except statement.
Using Environment Variables (environ) In Python's except statement, it was designed to inherit exceptionbase, so we thought about how to pass variables into the class and decided to set variables through os.environ to use them by distributing them as a package. Additionally, since the user's webhook URL or API key will not change, we named the variables in uppercase and set special names to prevent contamination from duplicate variables. Since the variables are used within the class, we added an underscore before the variable name.
About example code
For explanation, in Python, the example uses the overrided sys.excepthook in the except statement, like except ExceptTelegram as e:. However, you can use it simply by overriding sys.excepthook once and calling raise in the except statement. In IPython, you can use set_custom_exc to override the Exception with a user-defined function once, and then call raise in the except statement to repeatedly take the desired ExceptNotifier action. Also, although the example uses ExceptTelegram.__call__ or SuccessTelegram().__call__(), these are expressions to aid understanding, and you can change them to a more concise form if you prefer.
I would appreciate it if you could share the document widely by specifying that the source is the ExceptNotifier official github.
FAQs
With Python's try-except to receive notifications about Errors or Successes in your code through messenger app or email.
We found that exceptnotifier demonstrated a healthy version release cadence and project activity because the last version was released less than a year ago. It has 1 open source maintainer collaborating on the project.
Did you know?
Socket for GitHub automatically highlights issues in each pull request and monitors the health of all your open source dependencies. Discover the contents of your packages and block harmful activity before you install or update your dependencies.
Security News
PyPI confirms no security flaws were exploited in the Ultralytics supply chain attack and highlights improvements for safer package publishing.
Security News
Research
The Socket Research Team breaks down a malicious wrapper package that uses obfuscation to harvest credentials and exfiltrate sensitive data.
Research
Security News
Attackers used a malicious npm package typosquatting a popular ESLint plugin to steal sensitive data, execute commands, and exploit developer systems.