Use wrapt instead of functools.wraps in order to preserve function si…

[jwelch92]

…gnatures.

Which problem is this PR solving?

• Fixes Beeline tracing decorator does preserve function signature  #197

Short description of the changes

• Changes existing decorators that use only functools.wraps to use the wrapt.decorator decorator instead. This allows beeline traced functions to keep their original signature intact.

[JamieDanielson]

@jwelch92 this is looking good so far. I notice it's a draft but figured I'd take a look and provide some feedback. The linting is breaking in the CI build - can you take a look? Also, in testing the update with the same scenario you provided in the issue, I am seeing the same result. These two things may be related, let us know what you think!

CI Linting error:

#!/bin/bash -eo pipefail
poetry run pylint --rcfile=pylint.rc beeline
************* Module beeline.aiotrace
beeline/aiotrace.py:81:19: E1120: No value for argument 'instance' in function call (no-value-for-parameter)
beeline/aiotrace.py:81:19: E1120: No value for argument 'args' in function call (no-value-for-parameter)
beeline/aiotrace.py:81:19: E1120: No value for argument 'kwargs' in function call (no-value-for-parameter)
beeline/aiotrace.py:88:19: E1120: No value for argument 'instance' in function call (no-value-for-parameter)
beeline/aiotrace.py:88:19: E1120: No value for argument 'args' in function call (no-value-for-parameter)
beeline/aiotrace.py:88:19: E1120: No value for argument 'kwargs' in function call (no-value-for-parameter)
beeline/aiotrace.py:94:19: E1120: No value for argument 'instance' in function call (no-value-for-parameter)
beeline/aiotrace.py:94:19: E1120: No value for argument 'args' in function call (no-value-for-parameter)
beeline/aiotrace.py:94:19: E1120: No value for argument 'kwargs' in function call (no-value-for-parameter)
beeline/aiotrace.py:123:15: E1120: No value for argument 'instance' in function call (no-value-for-parameter)
beeline/aiotrace.py:123:15: E1120: No value for argument 'args' in function call (no-value-for-parameter)
beeline/aiotrace.py:123:15: E1120: No value for argument 'kwargs' in function call (no-value-for-parameter)
beeline/aiotrace.py:139:15: E1120: No value for argument 'instance' in function call (no-value-for-parameter)
beeline/aiotrace.py:139:15: E1120: No value for argument 'args' in function call (no-value-for-parameter)
beeline/aiotrace.py:139:15: E1120: No value for argument 'kwargs' in function call (no-value-for-parameter)
************* Module beeline.trace
beeline/trace.py:421:19: E1120: No value for argument 'instance' in function call (no-value-for-parameter)
beeline/trace.py:421:19: E1120: No value for argument 'args' in function call (no-value-for-parameter)
beeline/trace.py:421:19: E1120: No value for argument 'kwargs' in function call (no-value-for-parameter)
beeline/trace.py:427:19: E1120: No value for argument 'instance' in function call (no-value-for-parameter)
beeline/trace.py:427:19: E1120: No value for argument 'args' in function call (no-value-for-parameter)
beeline/trace.py:427:19: E1120: No value for argument 'kwargs' in function call (no-value-for-parameter)

Exited with code exit status 2
CircleCI received exit code 2

Result using updated wrapt instead of functools.wrap in local testing:

Example function: example_traced
Full Arg Spec: FullArgSpec(args=[], varargs='args', varkw='kwargs', defaults=None, kwonlyargs=[], kwonlydefaults=None, annotations={'return': None})
Signature: (a: str, b: str, c: Optional[str] = None) -> None

[jwelch92]

Thanks for taking a look @JamieDanielson! I'll try to address this feedback when I get a chance.

Are there any guidelines or rules for when it is appropriate to supress linting rules? Based on wrapt's docs I think no matter what there will be a function with some unused arguments in order to have a compatible signature for what wrapt expects.

Thanks!

[vreynolds]

Hey @jwelch92,

As far as the linter errors, I believe they are trying to tell us that the callers of those functions supply a different number of arguments from what's defined in the signature (not that those arguments are unused inside the function definition). That does appear to be the case, though I am unsure if that's intentional or not -- there's like several layers of higher order functions in there 😅 I assume this is the same issue described here

I think if it is intentional, and the decorators are meant to change the function signature, we can use signature-mutators in the Pylint config, or just suppress those warnings inline.

[github-actions]

Marking this PR as stale because it has been open 30 days with no activity. Please add a comment if this PR is still relevant; otherwise this PR will be automatically closed in 7 days.

[github-actions]

Closing this PR due to inactivity. Please see our Honeycomb OSS Lifecyle and Practices.