Bases and Mixins to store functions for later execution
Project description
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.
Installation
$ pip install sqlalchemy-function
Quickstart
In the setup, we create a SQLAlchemy session, define a Parent model
subclassing FunctionRelator
, and a Function model subclassing
FunctionMixin
.
from sqlalchemy_function import FunctionMixin, FunctionRelator
from sqlalchemy import create_engine, Column, ForeignKey, Integer
from sqlalchemy.orm import relationship, sessionmaker, scoped_session
from sqlalchemy.ext.declarative import declarative_base
# standard session creation
engine = create_engine('sqlite:///:memory:')
session_factory = sessionmaker(bind=engine)
Session = scoped_session(session_factory)
session = Session()
Base = declarative_base()
# define a Function model parent
class Parent(FunctionRelator, Base):
__tablename__ = 'parent'
id = Column(Integer, primary_key=True)
# Fuction models must reference their parent with a `parent` attribute
functions = relationship('Function', backref='parent')
# define a Function model with the FunctionMixin
class Function(FunctionMixin, Base):
__tablename__ = 'function'
id = Column(Integer, primary_key=True)
parent_id = Column(Integer, ForeignKey('parent.id'))
Base.metadata.create_all(engine)
We can now register, store, and call functions as follows.
@Function.register
def foo(parent, *args, **kwargs):
print('My parent is', parent)
print('My args are', args)
print('My kwargs are', kwargs)
return 'return value'
parent = Parent()
Function.foo(parent, 'hello world', goodbye='moon')
parent.functions[0]()
Out:
My parent is <__main__.Parent object at 0x7f8b4d200518>
My args are ('hello world',)
My kwargs are {'goodbye': 'moon'}
'return value'
Citation
@software{bowen2020sqlalchemy-function,
author = {Dillon Bowen},
title = {SQLAlchemy-Function},
url = {https://dsbowen.github.io/sqlalchemy-function/},
date = {2020-06-05},
}
License
Users must cite this package in any publications which use it.
It is licensed with the MIT License.
Project details
Release history Release notifications | RSS feed
Download files
Download the file for your platform. If you're not sure which to choose, learn more about installing packages.
Source Distribution
Built Distribution
Hashes for sqlalchemy-function-0.0.7.tar.gz
Algorithm | Hash digest | |
---|---|---|
SHA256 | 43bd7eb99bad69768d636987785bafc9e83ea0978ef98f64b9b39db0065a801f |
|
MD5 | 2afbc8e27fd1be3e08a71eeaee69f5fd |
|
BLAKE2b-256 | 6da541141a213ac8e248516bb178dbf448b7ebe61f117e795a61981038eb173a |
Hashes for sqlalchemy_function-0.0.7-py3-none-any.whl
Algorithm | Hash digest | |
---|---|---|
SHA256 | 0a0315b7b9822894a89b8204473fa807d97a27212ee0ef9ee3e1931895053c71 |
|
MD5 | c6e7a71aecfa2414dd100796d82ebf5a |
|
BLAKE2b-256 | d5d14b0fc3844f9da05b1f517058a384581188c6cb6c5493c919d0ae3cf1f4e2 |