Metadata-Version: 2.1
Name: insult-error
Version: 0.3.1
Summary: Intentionally insulting exceptions
Home-page: https://github.com/keithfma/insult_error
Author: Keith Ma
Author-email: itsallnans@gmail.com
License: UNKNOWN
Description: # Intentionally Insulting Exceptions for Python
        
        [![CircleCI](https://circleci.com/gh/keithfma/insult_error.svg?style=shield)](https://circleci.com/gh/keithfma/insult_error) 
        
        This package provides a set of insulting exceptions you can use to make your
        future self laugh, bother your collaborators, or both.
        
        The core feature is the `InsultError` exception class, which behaves just like
        a normal exception with a few differences:
        1. The raised error is a given a randomly-selected insulting name
        2. If no message is provided, the error will use a random insulting message
        3. A special keyword argument `rating` provides some control over how offensive
           you want the error and message to be (1 being tamest and 10 being meanest)
           
        To start the abuse, you can either explicitly raise `InsultError`s in your code,
        or you can call `always_insult_me` to convert all unhandled exceptions to insults.
        This works by wrapping `sys.excepthook` such that the error is changed, but your
        +stack trace is not.
        
        Please contribute! This package will be much more fun if not limited to the
        measly initial set of options. Obviously, racist, sexist, or other bullshit
        jokes are not welcome.
        
        ### `InsultError` Example Usage
        
        ```python
        from insult_error import InsultError
        
        # raise a random insult with a random message (defaults to rating=5)
        raise InsultError
        # >>> NotThisAgain: Don't believe everything you think.
        
        # raise a random insult with a user-specified message
        raise InsultError('This is my message')
        # >>> NotThisAgain: This is my message
        
        # raise a random insult with <= 2 rating
        raise InsultError(rating=2)
        # >>> ForGodsSake: I don’t have the time or the crayons to explain this to you.
        
        # raise a random insult with <= 6 rating
        raise InsultError(rating=6)
        # >>> FuckYouBuddy: I envy people who have never met you.
        
        # handle InsultError exceptions (just like normal, non-insulting errors)
        try:
            raise InsultError
        except InsultError:
            print('Better luck next time!')
        # >>> Better luck next time!
        ```
        
        ### `always_insult_me` Example Usage
        
        ```python
        from insult_error import always_insult_me, dont_always_insult_me
        
        # turn on ubiquitous insults, uncaught exceptions will be converted to InsultErrors and messages replaced too
        always_insult_me()
        raise ValueError('a normal message')
        # >>>
        # Traceback (most recent call last):
        #   File "<stdin>", line 1, in <module>
        # FuckYouBuddy: I don't have the time or the crayons to explain this to you
        
        # turn off insults, things go back to normal
        dont_always_insult_me()  
        raise ValueError('another normal message')
        # >>>
        # Traceback (most recent call last):
        #   File "<stdin>", line 1, in <module>
        # ValueError: another normal message
        
        # turn insults back on, but this time preserve error messages
        always_insult_me(preserve_msg=True)
        raise ValueError('a normal message')
        # >>>
        # Traceback (most recent call last):
        #   File "<stdin>", line 1, in <module>
        # FuckYouBuddy: a normal message
        ```
        
Platform: UNKNOWN
Classifier: License :: OSI Approved :: MIT License
Description-Content-Type: text/markdown
