sqlalchemy-function 0.0.5

Bases and Mixins to store functions for later execution

SQLAlchemy-Function

SQLAlchemy-Function defines a SQLALchemy Mixin for creating Function models.

A Function model has a parent (optional), a function, arguments, and keyword arguments. When called, the Function model executes its function, passing in its parent (if applicable), its arguments, and its keyword arguments.

Example

Suppose we have a function, foo, which we want to store. We also want to store the arguments and keyword arguments with which we will later execute foo.

After setup, we can achieve this with the following:

def foo(*args, **kwargs):
    print('My arguments are:', args)
    print('My keyword arguments are:', kwargs)
    return 'hello world'

f = Function(func=foo, args=['hello moon'], kwargs={'hello': 'star'})
session.add(f)
session.commit()
print(f())

Output:

My arguments are: ('hello moon',)
My keyword arguments are: {'hello': 'star'}
hello world

Documentation

You can find the latest documentation at https://dsbowen.github.io/sqlalchemy-function.

License

Publications which use this software should include the following citation for SQLAlchemy-Function and its dependency, SQLAlchemy-Mutable:

Bowen, D.S. (2019). SQLAlchemy-Function [Computer software]. https://dsbowen.github.io/sqlalchemy-function.

Bowen, D.S. (2019). SQLAlchemy-Mutable [Computer software]. https://dsbowen.github.io/sqlalchemy-mutable.

This project is licensed under the MIT License LICENSE.