Skip to main content

Merge signatures of two functions with Advanced Hackery.

Project description

https://travis-ci.org/Kwpolska/merge_args.svg?branch=master

This small library uses Advanced Python Hackery to change the signature of a function to be a mixture of itself and a function that it wraps. It’s like functools.wraps, but it allows the wrapped function to add its own arguments into the mix.

Usage

from merge_args import merge_args

def old(foo, bar):
    """This is old's docstring."""
    print(foo, bar)
    return foo + bar

@merge_args(old)
def new(prefix, foo, *args, **kwargs):
    return old(prefix + foo, *args, **kwargs)

If you then run help(new), this is the output:

Help on function new in module __main__:

new(prefix, foo, bar)
    This is old's docstring.

How it works?

I wrote a detailed blog post, describing the ins and outs of how this package works:

https://chriswarrick.com/blog/2018/09/20/python-hackery-merging-signatures-of-two-python-functions/

This module was inspired by F4D3C0D3 on #python (formerly on freenode IRC).

License

Copyright © 2018-2022, Chris Warrick. All rights reserved.

Redistribution and use in source and binary forms, with or without modification, are permitted provided that the following conditions are met:

  1. Redistributions of source code must retain the above copyright notice, this list of conditions, and the following disclaimer.

  2. Redistributions in binary form must reproduce the above copyright notice, this list of conditions, and the following disclaimer in the documentation and/or other materials provided with the distribution.

  3. Neither the name of the author of this software nor the names of contributors to this software may be used to endorse or promote products derived from this software without specific prior written consent.

THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS “AS IS” AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT OWNER OR CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.

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

merge_args-0.1.5.tar.gz (6.0 kB view details)

Uploaded Source

Built Distribution

merge_args-0.1.5-py2.py3-none-any.whl (6.0 kB view details)

Uploaded Python 2 Python 3

File details

Details for the file merge_args-0.1.5.tar.gz.

File metadata

  • Download URL: merge_args-0.1.5.tar.gz
  • Upload date:
  • Size: 6.0 kB
  • Tags: Source
  • Uploaded using Trusted Publishing? No
  • Uploaded via: twine/4.0.1 CPython/3.8.15

File hashes

Hashes for merge_args-0.1.5.tar.gz
Algorithm Hash digest
SHA256 ad37e6c4c7f1eadda5a0564b26ca7d56f8a37f232f5c5c46f9ef93d352757c23
MD5 78ad4ff9f94a581880f1ac1c4ef2bbfb
BLAKE2b-256 cd6e7dc4bd3583b991b7e131c948ede058f6678afa9aea6b88961d507b4fa951

See more details on using hashes here.

Provenance

File details

Details for the file merge_args-0.1.5-py2.py3-none-any.whl.

File metadata

  • Download URL: merge_args-0.1.5-py2.py3-none-any.whl
  • Upload date:
  • Size: 6.0 kB
  • Tags: Python 2, Python 3
  • Uploaded using Trusted Publishing? No
  • Uploaded via: twine/4.0.1 CPython/3.8.15

File hashes

Hashes for merge_args-0.1.5-py2.py3-none-any.whl
Algorithm Hash digest
SHA256 f296a2dd9156dd055e3f540f0fb5784b94933457a4e0e8d0031a763c26bf24a8
MD5 9383e5c148a7b5b37de7669109d2a047
BLAKE2b-256 84dd8b9bf1b36927707ae04ec6f8e63f36cdce8c32cea2ed3ecffb04565264d0

See more details on using hashes here.

Provenance

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