Skip to main content

global exception handler with notification and timing features

Project description

exceptionalpy

features

  • exception handling decorator (ex / catch)

  • timing decorator (ti / timeit)

  • exception handling and timing decorator (exti / catch_timeit)

  • Handler

    • handle exceptions
      • print stacktrace
      • forward stacktrace to notifier
    • handle timing results of functions
      • forward to notifier
  • BaseNotifier

    • provide interface for extensions
  • HTTPNotifier

    • send stacktrace via POST to specified url
  • SMTPNotifier

    • send stacktrace via Mail to specified email addresses
  • Rescuer

    • Manager like interface for threads / processes
    • Capture exceptions

usage

basic

import time
from exceptionalpy import catch, timeit, exceptionalpy_handler as handler

handler.verbose = True  # since you probably want to see your timing results


@timeit()
def gotta_work_fast():
  time.sleep(0.4)
  
  
@catch()
def cant_fail():
  raise ArithmeticError


gotta_work_fast()  
# gotta_work_fast completed in 400432710 ns | 400.43271 ms | 0.40043270999999997 s
cant_fail()
# prints stacktrace
print("I will still be printed.")
print("Since the program will not exit even though an exception occurred.")

extensive guide

import time
from exceptionalpy import ex, exceptionalpy_handler as handler

# lets be verbose
handler.verbose = True
# you can either just catch all exceptions with
handler.init()
# and then stop again with
handler.deinit()


# or you can decorate the functions of which you want the exceptions to be caught
@ex()
def i_will_throw():
  raise BaseException


# there is also a timing decorator that catches the exception
from exceptionalpy import exti


@exti()
def i_take_a_moment_to_throw():
  time.sleep(0.6)
  print("Heyyyyy")
  raise ArithmeticError


# if you still want to time your functions and 
# have the result be forwarded to the notifier
from exceptionalpy import ti


@ti()
def i_take_a_moment():
  time.sleep(0.4)
  print("Slow function here, hi")
  
  
i_take_a_moment()
# upon successful execution, if you set the handlers verbose option to True,
# you will see something like this
# i_take_a_moment completed in 400432710 ns | 400.43271 ms | 0.40043270999999997 s
# and that result will be jsonified and forwarded to the notifier

# before any exceptions happen, you can also attach a notifier
from exceptionalpy.HTTP import HTTPNotifier

handler.notifier = HTTPNotifier("https://my-server:1337/api/exceptional", "POST")

# or just use a completely different handler
from exceptionalpy.SMTP import SMTPSHandler

handler = SMTPSHandler(("127.0.0.1", 25),  # which SMTP server to use
                       "exceptionalpy@locahost",  # the sender address
                       "dev@localhost",  # the receiver address
                       "There was an exception in your program")  # the subject
#  nothing bad will happen if you don't call
handler.deinit()
# beforehand. you can do it, but it's a waste of cpu cycles.

i_will_throw()
print("I will still be printed")
i_take_a_moment_to_throw()
print("I get printed as well since the program does not exit")

Project details


Download files

Download the file for your platform. If you're not sure which to choose, learn more about installing packages.

Source Distribution

exceptionalpy-0.4.tar.gz (5.9 kB view details)

Uploaded Source

File details

Details for the file exceptionalpy-0.4.tar.gz.

File metadata

  • Download URL: exceptionalpy-0.4.tar.gz
  • Upload date:
  • Size: 5.9 kB
  • Tags: Source
  • Uploaded using Trusted Publishing? No
  • Uploaded via: twine/3.4.1 importlib_metadata/3.7.3 pkginfo/1.7.0 requests/2.22.0 requests-toolbelt/0.9.1 tqdm/4.59.0 CPython/3.9.2

File hashes

Hashes for exceptionalpy-0.4.tar.gz
Algorithm Hash digest
SHA256 9173dcda164b7ebbc521661677cb3edb0db80af0d1fc4f740b08cf6ac5a9c46d
MD5 c77b3e694ba1ed90f8e104db3f9955cd
BLAKE2b-256 b833883afc56520d62af2a5f36cfa839de6557777fd0a14705347910fc1bb598

See more details on using hashes here.

Supported by

AWS AWS Cloud computing and Security Sponsor Datadog Datadog Monitoring Fastly Fastly CDN Google Google Download Analytics Microsoft Microsoft PSF Sponsor Pingdom Pingdom Monitoring Sentry Sentry Error logging StatusPage StatusPage Status page