stackvar 3.1.0

Dispatch function's parameters through the callstack omitting arguments on intermediary functions. (a.k.a.: stack variable)

Dispatch function’s parameters through the callstack omitting arguments on intermediary functions.

Installing

https://pypi.org/project/stackvar/

pip install -U stackvar

Example

import stackvar

def test_stackvar():
    # sending within a context
    with stackvar.send(send_email, email='[e-mail]'):
        foo()
    # Use default value
    send_email()
    # pass specific value
    send_email('[e-mail]')

def foo():
    # intermediary function
    bar()

def bar():
    # intermediary function
    send_email()

@stackvar.receive()
def send_email(email: stackvar.Variable = '[e-mail]'):
    print(f'Sending email to={email}')

if __name__ == '__main__':
    test_stackvar()

Will output

Sending email to=[e-mail]
Sending email to=[e-mail]
Sending email to=[e-mail]

Cheatsheet

import stackvar
import uuid

def cheat_sheet_doc():
    # Using namespace (recommended method)
    my_namespace = stackvar.Namespace(uuid.uuid4())
    @stackvar.receive(my_namespace)
    def send_email(email: stackvar.Variable = '[e-mail]'):
        print(f'Sending email to={email}')
    with stackvar.send(my_namespace, email='[e-mail]'):
        send_email()

    # Automatic namespace (solved from function)
    @stackvar.receive()
    def send_email2(email: stackvar.Variable = '[e-mail]'):
        print(f'Sending email to={email}')
    with stackvar.send(send_email2, email='[e-mail]'):
        send_email2()

    # Without decorator
    ns_uuid2 = stackvar.Namespace(uuid.uuid4())
    def send_email_nodecorator():
        email1 = ns_uuid2.email1
        # setting default value for a variable
        email2 = getattr(ns_uuid2, 'email2', '[e-mail]')
        print(f'Sending email1 to={email1} and {email2}')
        # another fancier way to set a default
        email2 = stackvar.get(ns_uuid2, email2='[e-mail]')
        print(f'Sending email1 to={email1} and {email2}')
    with stackvar.send(ns_uuid2, email1='[e-mail]'):
        send_email_nodecorator()

    # No default values
    ns_uuid3 = stackvar.Namespace(uuid.uuid4())
    @stackvar.receive(ns_uuid3)
    def send_no_default(email1: stackvar.Variable, email2: stackvar.Variable):
        print(f'Sending={email1} and {email2}')
    with stackvar.send(ns_uuid3,
                       email1='[e-mail]',
                       email2='[e-mail]'):
        send_no_default()

    # Using Factory for mutable values
    ns_uuid4 = stackvar.Namespace(uuid.uuid4())
    @stackvar.receive(ns_uuid4)
    def send_factory(email_list: stackvar.Factory = list):
        email_list.append('[e-mail]')
        print(f'Sending to={email_list}')
    with stackvar.send(ns_uuid4):
        send_factory()

if __name__ == '__main__':
    cheat_sheet_doc()

More docs

Check examples at https://gitlab.com/joaduo/stackvar/-/tree/main/tests