Merge pull request #110 from MindscapeHQ/js/fix-sending-exception

Version 4.4.0 bug fix and features

Author: redJ4y

.travis.yml

@@ -1,29 +1,24 @@
-sudo: false
-
 language: python
 
 cache: pip
 
-python: ["2.7", "3.2", "3.3", "3.4", "3.5", "3.6", "pypy"]
-
-# Workaround to install Python 3.7
-# https://github.com/travis-ci/travis-ci/issues/9815
-matrix:
-  include:
-    - python: 3.7
-      dist: xenial
-      sudo: true
+python:
+  - "2.7"
+  - "3.6"
+  - "3.7"
+  - "3.8"
+  - "3.9"
+  - "3.10"
+  - "3.11"
+  - "pypy"
+  - "pypy3"
 
 install:
-  - pip install .[dev]
+  - python -m pip install coverage .[dev]
 
 script:
-  # Django 1.8 requires Python 2.7+
-  - if [[ $TRAVIS_PYTHON_VERSION != 2.6 && $TRAVIS_PYTHON_VERSION == 2* ]]; then coverage run -m unittest2 discover python2; fi
-  # Coverage/Coveralls has dropped support for Python 3.2
-  - if [[ $TRAVIS_PYTHON_VERSION != 3.2 && $TRAVIS_PYTHON_VERSION == 3* ]]; then coverage run -m unittest discover python3; fi
-  - if [[ $TRAVIS_PYTHON_VERSION == 'pypy' ]]; then coverage run -m unittest2 discover python2; fi
-  # - if [[ $TRAVIS_PYTHON_VERSION == 'pypy3' ]]; then coverage run -m unittest discover python3; fi
+  - if [[ $TRAVIS_PYTHON_VERSION == 2* || $TRAVIS_PYTHON_VERSION == 'pypy' ]]; then coverage run --source=python2 -m unittest discover python2/tests; fi
+  - if [[ $TRAVIS_PYTHON_VERSION == 3* || $TRAVIS_PYTHON_VERSION == 'pypy3' ]]; then coverage run --source=python3 -m unittest discover python3/tests; fi
 
 after_success:
   coveralls

CHANGELOG.md

@@ -1,11 +1,26 @@
+## 4.4.0 (11/08/2023):
+Features:
+  - Added `RaygunHandler.from_sender()` factory to construct a `RaygunHandler` instance using an existing `RaygunSender`. This allows for additional configuration of the sender.
+  - Added a `config` parameter the to Flask and WSGI middleware provider constructors. This also allows for additional configuration of the sender.
+  - The `RaygunHandler` now adds tags corresponding to the logging level, which now defaults to `logging.ERROR`.
+  - Errors/exceptions sent via the `RaygunHandler` now have their message overriden by the logged message.
+Bug fixes:
+  - The `RaygunHandler` now attempts to capture `exc_info` from the `record`. This can be obtained if `logger.exception()` is used or if `exc_info=True` is set in the logger call.
+    - If `exc_info` cannot be obtained by the `RaygunHandler`, it no longer attempts to construct a `RaygunErrorMessage` with `None` values. Instead, it generates a fallback error message using information gathered from the `record`. This is essentially an error with a single stack frame representing the call to the logger.
+Quality of life updates:
+  - Updated `CONTRIBUTING.MD`.
+  - Got unit tests running again (`django` upgrade).
+  - Updated `python3/samples/sample.py` and `python3/samples/sampleWithLogging.py`.
+  - Cleaned up `python3/raygun4py/cli.py`.
+
 ## 4.3.0 (06/06/2019):
 Features:
   - Added a new config option, `transmit_environment_variables`, to control sending any environment variables at all
   - Added support to `filter_keys` config option for ignoring keys with a simple wildcard approach. See README for more information
 
 ## 4.2.3 (28/03/2019):
 Bugfixes
-  - Add request rawData to the build_wsgi_compliant_request utilities to fix a bug where rawData is set manually then overwritten by an empty object.
+  - Add request `rawData` to the `build_wsgi_compliant_request` utilities to fix a bug where `rawData` is set manually then overwritten by an empty object.
 
 ## 4.2.2 (23/01/2019):
 Bugfixes

CONTRIBUTING.MD

@@ -1,20 +1,32 @@
-# Getting Started with Local Development
-The following will show you how to get started with local development
+## Getting Started with Local Development
+Before starting, you'll need to ensure you have the appropriate version of Python installed.
 
-## Python 2
-1. `cd <project folder> && virtualenv -p <PATH TO PYTHON2> venv2`
-1. activate the virtual env
-1. `pip install .[dev]`
-1. Run tests
-```
-python -m unittest2 discover python2
-```
+---
 
-## Python 3
-1. `cd <project folder> && virtualenv -p <PATH TO PYTHON3> venv3`
-1. activate the virtual env
-1. `pip install .[dev]`
-1. Run tests
+# Python 2
+1. Install the virtual environment manager: `python2 -m pip install virtualenv`
+2. Navigate to the project directory: `cd <project folder>`
+3. Create a new virtual environment using Python 2: `python2 -m virtualenv venv2`
+4. Activate the virtual environment. On Windows, use `venv2\Scripts\activate`. On Unix or MacOS, use `source venv2/bin/activate`.
+5. Install the development dependencies and prepare local package: `python2 -m pip install -e .[dev]`
+6. Run tests with the command: 
+```bash
+python2 -m unittest discover python2/tests
 ```
-python -m unittest discover python3
+- Remember to deactivate the virtual environment when you're done: `deactivate`
+
+---
+
+# Python 3
+1. Install the virtual environment manager: `python3 -m pip install virtualenv`
+2. Navigate to the project directory: `cd <project folder>`
+3. Create a new virtual environment using Python 3: `python3 -m virtualenv venv3`
+4. Activate the virtual environment. On Windows, use `venv3\Scripts\activate`. On Unix or MacOS, use `source venv3/bin/activate`.
+5. Install the development dependencies and prepare local package: `python3 -m pip install -e .[dev]`
+6. Run tests with the command: 
+```bash
+python3 -m unittest discover python3/tests
 ```
+- Remember to deactivate the virtual environment when you're done: `deactivate`
+
+---

README.rst

@@ -8,7 +8,9 @@ raygun4py
   :target: https://coveralls.io/r/MindscapeHQ/raygun4py?branch=master
 
 
-Official Raygun provider for **Python 2.7**, **Python 3+** and **PyPy**
+Official Raygun provider for **Python 2.7**, **Python 3.1+** and **PyPy**
+
+Please also refer to our `documentation site <https://raygun.com/documentation/language-guides/python/crash-reporting/installation/>`_, as this is maintained with higher priority.
 
 
 Installation
@@ -18,16 +20,8 @@ The easiest way to install this is as a pip package, as it is available from PyP
 
     $ pip install raygun4py
 
-Then import and instantiate the module:
-
-.. code:: python
-
-    from raygun4py import raygunprovider
-
-    client = raygunprovider.RaygunSender('your_apikey')
-
 Test the installation
-------------------------
+---------------------
 
 From the command line, run::
 
@@ -38,61 +32,80 @@ Replace :code:`your_apikey` with the one listed on your Raygun dashboard. This w
 Usage
 =====
 
+Import and instantiate the module:
+
+.. code:: python
+
+    from raygun4py import raygunprovider
+
+    sender = raygunprovider.RaygunSender("paste_your_api_key_here")
+
 Automatically send the current exception like this:
 
 .. code:: python
 
     try:
         raise Exception("foo")
     except:
-        client.send_exception()
+        sender.send_exception()
 
 See `sending functions`_ for more ways to send.
 
-
 Uncaught exception handler
 --------------------------
 
-To automatically pick up unhandled exceptions with custom logic, you can provide a callback function to sys.excepthook:
+To automatically send unhandled exceptions, you can provide a callback function to :code:`sys.excepthook`:
 
 .. code:: python
 
   def handle_exception(exc_type, exc_value, exc_traceback):
       sender = raygunprovider.RaygunSender("your_apikey")
       sender.send_exception(exc_info=(exc_type, exc_value, exc_traceback))
+      sys.__excepthook__(exc_type, exc_value, exc_traceback)
 
   sys.excepthook = handle_exception
 
+Note that after sending the exception, we invoke the default :code:`sys.__excepthook__` to maintain the expected behavior for unhandled exceptions. This ensures the program terminates as it would without the custom exception handler in place.
+
 Logging
 -------
 
-You can also send exceptions using a logger:
+You can send errors/exceptions via a logger by attaching a :code:`RaygunHandler`:
 
 .. code:: python
 
-  logger = logging.getLogger("mylogger")
-  rgHandler = raygunprovider.RaygunHandler("your_apikey")
-  logger.addHandler(rgHandler)
+  logger = logging.getLogger()
+  raygun_handler = raygunprovider.RaygunHandler("paste_your_api_key_here")
+  logger.addHandler(raygun_handler)
 
-  def log_exception(exc_type, exc_value, exc_traceback):
-      logger.error("An exception occurred", exc_info = (exc_type, exc_value, exc_traceback))
+A :code:`RaygunHandler` can also be instantiated from an existing :code:`RaygunSender`:
+
+.. code:: python
 
-  sys.excepthook = log_exception
+  raygun_handler = raygunprovider.RaygunHandler.from_sender(sender)
+
+It is then recommended to use :code:`logger.exception()` or :code:`logger.error(exc_info=True)` in the scope of an :code:`except` block:
+
+.. code:: python
 
-This uses the built-in :code:`RaygunHandler`. You can provide your own handler implementation based on that class if you need custom sending behavior.
+  try:
+      raise Exception("Example exception")
+  except:
+      logger.exception("Example logger.exception log")
+      # Or
+      logger.error("Example logger.error log", exc_info=True)
 
+Note that using a :code:`RaygunHandler` outside the scope of an :code:`except` block will not allow it to populate a full stack trace.
 
 Web frameworks
 --------------
 
-Raygun4py includes dedicated middleware implementations for Django and Flask, as well as generic WSGI frameworks (Tornado, Bottle, Ginkgo etc). These are available for both Python 2.6/2.7 and Python 3+.
+Raygun4py includes dedicated middleware implementations for Django and Flask, as well as generic WSGI frameworks (Tornado, Bottle, Ginkgo etc). These are available for both Python 2.7 and Python 3.1+.
 
 Django
 ++++++
 
-To configure Django to automatically send all exceptions that are raised in views to Raygun:
-
-settings.py
+To configure Django to automatically send all exceptions that are raised in views to Raygun, add the following to :code:`settings.py`:
 
 .. code:: python
 
@@ -127,6 +140,8 @@ The above configuration is the minimal required setup. The full set of options s
 Flask
 +++++
 
+To attach a request exception handler that enhances reports with Flask-specific environment data, use our middleware :code:`flask.Provider`:
+
 .. code:: python
 
   from flask import Flask, current_app
@@ -136,6 +151,8 @@ Flask
 
   flask.Provider(app, 'your_apikey').attach()
 
+The :code:`flask.Provider` constructor can also take an optional :code:`config` argument. This should be a standard :code:`Dict` of supported options, as shown in advanced configuration below. It also returns the underlying :code:`RaygunSender`, which you may decide to use elsewhere.
+
 WSGI
 ++++
 
@@ -164,6 +181,8 @@ An example using **Tornado**, which will pick up exceptions that occur in the WS
     server = wsgiref.simple_server.make_server('', 8888, raygun_wrapped_app)
     server.serve_forever()
 
+The :code:`wsgi.Provider` constructor can also take an optional :code:`config` argument. This should be a standard :code:`Dict` of supported options, as shown in advanced configuration below.
+
 Note that many frameworks (tornado, pryramid, gevent et al) will swallow exceptions that occur within their domain.
 
 Let us know if we're missing middleware for your framework, or feel free to submit a pull request.
@@ -355,13 +374,6 @@ For Python 3, chained exceptions are supported and automatically sent along with
 
 This occurs when an exception is raised while handling another exception - see tests_functional.py for an example.
 
-Troubleshooting
-===============
-
-To see the HTTP response code from sending the message to raygun, `print client.send()` (as in line 27 of test.py). It will be 403 if an invalid API key was entered, and 202 if successful.
-
-Create a thread in the official support forums at http://raygun.io/forums, and we'll help you out.
-
 Changelog
 =========
 

python2/raygun4py/version.py

@@ -2,4 +2,4 @@
 # 1) we don't load dependencies by storing it in __init__.py
 # 2) we can import it in setup.py for the same reason
 # 3) we can import it into your module module
-__version__ = '4.3.2'
+__version__ = '4.4.0'

python3/raygun4py/cli.py

@@ -1,38 +1,35 @@
-import sys
 from optparse import OptionParser
+
 from raygun4py import raygunprovider
 
 
 def main():
     usage = '\n  raygun4py test <apikey>'
     parser = OptionParser(usage=usage)
 
-    options, args = parser.parse_args()
+    _, args = parser.parse_args()
 
-    if 'install' in args:
-        if len(args) > 1:
-            print("Installed API key! Now run 'raygun4py test' to check it's working")
-        else:
-            print('Please provide a Raygun API key!')
-    elif 'test' in args:
-        if len(args) > 1 and isinstance(args[1], str):
-            send_test_exception(args[1])
-        else:
-            print('Please provide your API key')
+    if len(args) < 2 or not isinstance(args[1], str):
+        print('Please provide your API key')
+        parser.print_help()
+    elif args[0] == 'test':
+        send_test_exception(args[1])
     else:
+        print(f"Invalid command '{args[0]}'")
         parser.print_help()
 
 
 def send_test_exception(apikey):
     client = raygunprovider.RaygunSender(apikey)
 
     try:
-        raise Exception("Test exception from Raygun4py3!")
-    except:
+        raise Exception("Test exception from Raygun4py (Python3)")
+    except Exception:
         response = client.send_exception()
 
-        if response[0] is 202:
-            print("Success! Now check your Raygun dashboard at https://app.raygun.io")
+        if response[0] == 202:
+            print("Success! Now check your Raygun dashboard at https://app.raygun.com")
         else:
-            print("Something went wrong - please check your API key or contact us to get help. The response was:")
+            print(
+                "Something went wrong - please check your API key or contact us for help. The response was:")
             print(response)

python3/raygun4py/middleware/django.py

@@ -1,27 +1,30 @@
 import django
 from django.conf import settings
+
 from raygun4py import raygunprovider
-from django.utils.functional import cached_property
 
 try:
     from django.utils.deprecation import MiddlewareMixin
 except ImportError:
     MiddlewareMixin = object
 
+
 class Provider(MiddlewareMixin):
 
     def __init__(self, get_response=None):
         self.get_response = get_response
         config = getattr(settings, 'RAYGUN4PY_CONFIG', {})
-        apiKey = getattr(settings, 'RAYGUN4PY_API_KEY', config.get('api_key', None))
+        apiKey = getattr(settings, 'RAYGUN4PY_API_KEY',
+                         config.get('api_key', None))
 
         self.sender = raygunprovider.RaygunSender(apiKey, config=config)
 
     def process_exception(self, request, exception):
         raygun_request = self._mapRequest(request)
         env = self._get_django_environment()
 
-        self.sender.send_exception(exception=exception, request=raygun_request, extra_environment_data=env)
+        self.sender.send_exception(
+            exception=exception, request=raygun_request, extra_environment_data=env)
 
     def _mapRequest(self, request):
         headers = request.META.items()