Makes scripts feel like functions.
Project description
Callscript
Not worth it to refactor your script into a bunch of functions? This is a simple python library that lets you run your script as though you had, so you can
call results = callscript('myscript.py', x=3, y=4)
. Just add comments in your scirpt to show where the inputs and outputs are, and callscript
will
make the function work properly:
# myscript.py
x = 1 # input
y = 2 # input
w = x * y
v = x / y # output
z = x + y # output
print(z) # ignore
Why does this exist? Because sometimes you don't want to touch your old code or want to keep working with it using an interactive coding tool like Spyder, VSCode's interactive mode, or Jupyter, but you still want to be able to test your script using new parameters, or wrap it with a user interface.
Or maybe you're not sure how to go about changing the script's code to make it work in a new context and don't have a lot of time at the moment to work it out, or maybe you're collaborating with someone who isn't ready to refactor the script yet.
In any case, with callscript
, you can leave the original script alone and wrap it with your new functionality.
Installation
Install callscript
with PyPI
pip install callscript
Usage / Examples
Simple Input-Output Labeling
If you label your script with the "input" or "output" comments, callscript
can call it!
# examples/script.py
x = 3 # input
y = 5 # input
z = x + y # output
Then from your other code, you can call it with the callscript()
function:
>>> from callscript import callscript
>>> callscript('examples/script.py', x=10, y=20)
{'z': 30}
Modifying Input-Output Variable Names for your Function's API
Want to change your variable names? You can do that, too!
# examples/script2.py
x = 3 # input:FirstWeek
y = 5 # input:SecondWeek
z = x + y # output:sum
>>> callscript('examples/script2.py', FirstWeek=10, SecondWeek=20)
{'sum': 30}
Ignoring Lines When the Script is Called as a Function
Want some lines to be ignored when being called by callscript()
? Use the # ignore
tag!
# examples/script3.py
x = 3 # input
y = 5 # input
input('What is your name?') # ignore
z = x + y # output
z = 100000 # ignore
>>> callscript('examples/script3.py', x=10, y=20)
{'z': 30}
Using the Orignal Script Values as Function Defaults
callscript()
will automatically use the original values of the inputs in the script as defaults.
# examples/script4.py
name = 'Nick' # input
greeting = 'Hello, ' # input
msg = greeting + name # output
>>> callscript('examples/script4.py', name='Emma')
{'msg': 'Hello, Emma'}
Authors
Running Tests
To run tests, run the following command
tox
Contributing
Adding to the Changelog
Don't modify the CHANGELOG.rst
file directly! Instead, usescriv create
make a new entry for the changelog. After you've written a contribution, add the entry and write what you did into the template. When we are ready to make a release, we'll use the scriv collect
command to aggregate these fragments into a new changeelog entry.
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 callscript-0.7.1-py3-none-any.whl
Algorithm | Hash digest | |
---|---|---|
SHA256 | 38c8f448b777a38147eb61892039878cc610032f8f2d64f03755410ec3a8c22d |
|
MD5 | bc8b57cca8a081b2701cd69cfef40d8b |
|
BLAKE2b-256 | 923933c295e067c6adefc89b9e424112aa79b5dcebdbcf2ffbd5d67e3d313a80 |