autosig 0.5.0

Define signatures to create beautiful APIs

Autosig

Autosig allows to create classes that describe signatures of functions and common processing of arguments. This allows to:

• Model functions that share the same signature with instances of class Signature

• Model the commonalities between different signatures, e.g. sharing the first few arguments

• Model common processing normally associated with signatures, such as default values, type checking, validation and conversion, this both at the level of individual arguments and globally for a signature (e.g, check the the first argument is a DataFrame vs. check the that first two arguments are both of the same type)

Since a signature is modeled with class, inheritance can be used to capture commonalities and differences between signatures:

from autosig import *
# define a class with Signature x and y are parameters with no special properties
binary_op = Signature(
    x = param(),
    y = param())

# define a parameter with an int annotation, converting to int if necessary)
int_param = param(converter=int)

# define another signature with two integer parameters, same annotation and
# conversion behavior
binary_int_op = Signature(
    x = int_param,
    y = int_param)


# define a binary operator
@autosig(binary_op)
def add(x, y):
    return x + y

# define a binary operator with int parameters
@autosig(binary_int_op)
def int_add(x, y):
    return x + y

add(2, 3) # 5
add(2, "3") # fails
int_add(2, "3") # 5

History

0.5.0 (2018-09-21)

• All new API, many breaking changes (sorry)

• signature decorator is gone

• create signatures directly withe the Signature constructor (it is no longer a base class to inherit from)

• do not use inheritance to define new signatures form old ones. It was a dead end as far as controlling the order of arguments. Use instead the + operator to combine two signatures, analogous to inheriting from one while adding new attributes.

• the new approach gives control over order of arguments, allows to mix mandatory and default arguments in one signature yet allow to reuse it (“stick” new mandatory arguments in between the arguments of the old signature)

0.4.1 (2018-09-05)

• Close abstraction holes revealing dependency on attr (which is gratefully acknowledged, but could be confusing).

0.3.1 (2018-08-30)

• Improved docstring generation

0.3.0 (2018-08-30)

• Compose docstring from param docstrings

0.2.3 (2018-08-28)

• Better and passing tests.

0.2.2 (2018-08-27)

• More stringent enforcement of signatures including defaults. Fixed build.

0.1.0 (2018-04-25)

• First release on PyPI.