Easy Flow

`py_simple.easy_flow`

easy_flow is built to simplify work flows

`EasyFlowError`

Bases: Exception

Raised when a Python file can't be run.

Wraps the underlying error (missing file, bad permissions, an exception raised inside the file being run, etc.) so py_simple functions can fail with one consistent, easy-to-read exception instead of a random builtin one.

Parameters:

Name	Type	Description	Default
`message`	`str`	Human-readable description of what went wrong.	required

`retry(func, attempts=3, delay=1)`

Calls a function, automatically retrying it if it raises an exception up to a specified number of attempts, with a pause between tries.

Parameters:

Name	Type	Description	Default
`func`	`callable`	The function to execute.	required
`attempts`	`int`	Maximum number of times to try running the function. Defaults to 3.	`3`
`delay`	`int or float`	Time to wait in seconds between failed attempts. Defaults to 1.	`1`

Returns:

Name	Type	Description
`Any`		The return value of `func` if it succeeds.

Raises:

Type	Description
`Exception`	The last exception raised by `func` if all attempts fail.

Example

The Py_simple WayThe Traditional Way

from py_simple import retry

def flaky_api():
    # Might fail sometimes
    pass

result = retry(flaky_api, attempts=5, delay=2)

import time

def flaky_api():
    pass

attempts = 5
delay = 2
for i in range(attempts):
    try:
        result = flaky_api()
        break
    except Exception as e:
        if i == attempts - 1:
            raise e
        time.sleep(delay)

`run_py_file(filename)`

Runs a Python file as if it were called directly from the command line (i.e. as __main__), using the current process.

Parameters:

Name	Type	Description	Default
`filename`	`str`	Path to the `.py` file to run.	required

Example

The Py_simple WayThe Traditional Way

from py_simple import run_py_file

run_py_file("script.py")

import runpy

print("RUNNING: script.py")
try:
    runpy.run_path("script.py")
except Exception as e:
    print(f"Couldn't run the file: {e}")

`run_py_file_safe(filename)`

Runs a Python file as if it were called directly from the command line (i.e. as __main__), returning a success flag instead of raising an exception if something goes wrong.

Parameters:

Name	Type	Description	Default
`filename`	`str`	Path to the `.py` file to run.	required

Returns:

Name	Type	Description
`tuple`		`(True, None)` if the file ran successfully, or `(False, error_message)` if it failed, where `error_message` (str) describes what went wrong.

Example

The Py_simple WayThe Traditional Way

from py_simple import run_py_file_safe

success, error = run_py_file_safe("script.py")
if not success:
    print(f"Couldn't run the file: {error}")

import runpy

print("RUNNING: script.py")
try:
    runpy.run_path("script.py")
except Exception as e:
    print(f"Couldn't run the file: {e}")

`time_function_call(function, args=None)`

Runs a function once and returns how long it took to run, in seconds.

Raises EasyFlowError if the function raises an exception while running.

Parameters:

Name	Type	Description	Default
`function`		The function to run and time.	required
`args`	`list`	Positional arguments to pass to the function. Leave as None to call it with no arguments.	`None`

Returns:

Name	Type	Description
`float`	`float`	Number of seconds the function took to run.

Example

The Py_simple WayThe Traditional Way

from py_simple import time_function_call

def add(a, b):
    return a + b

time_function_call(add, [2, 3])  # -> 0.000002

import time

def add(a, b):
    return a + b

start = time.time()
try:
    add(2, 3)
except Exception as e:
    print(f"Couldn't time the function: {e}")
duration = time.time() - start

`time_it(func)`

Decorator that measures how long a function takes to run, prints the elapsed time, and returns the original result.

Parameters:

Name	Type	Description	Default
`func`	`callable`	The function to decorate.	required

Returns:

Name	Type	Description
`callable`		A wrapped version of `func` that behaves the same but prints its runtime each time it's called.

Example

The Py_simple WayThe Traditional Way

from py_simple import time_it

@time_it
def add(a, b):
    return a + b

add(2, 3)  # prints: add took 0.00s

import time

def add(a, b):
    return a + b

start = time.time()
result = add(2, 3)
elapsed = time.time() - start
print(f"add took {elapsed:.2f}s")