alcarney / erratum Goto Github PK

Add a sphinx directive that can be used to automatically insert the troubleshooting page.

Trying to use an error decorator with a class method as follows:

class MyClass:

    @MyError
    def my_method(self, var):
        ...

will result in an error like the following

Exception raised:
    Traceback (most recent call last):
 line 61, in __call__
        return self._f(*args, **kwargs)
      File "/home/alex/Programming/python/topos/.tox/docs/lib/python3.6/site-packages/erratum/error.py", line 33, in wrapper
        return f(*args, **kwargs)
    TypeError: my_method() missing 1 required positional argument: 'var'
    More info --> https://topos.readthedocs.io/en/latest/troubleshooting.html#vertexcoordinateerror

What I think is happening is that the way the Error class is wrapping functions it's not passing through the self argument to the method underneath. A work around for now is to use the Error as a context manager instead, e.g.

class MyClass:

    def my_method(self, var):
        with MyError():
            ...

but it would be nice to fix this