No project description provided
Project description
main-entrypoint
A decorator to avoid if __name__ == "__main__":
, instead use
from main_entrypoint import entrypoint
@entrypoint
def main():
print("Hello World")
$ python my_script.py
Hello World
$ python -c "import my_script"
# no output
Installation
pip install main-entrypoint
Details
Specifying the @entrypoint
decorator on a function my_func
can be considered equivalent to running
if __name__ == "__main__":
my_func()
at the end of the same module.
If the decorator is used multiple times in the same file, the functions are executed in the order they are defined.
The default entrypoint
decorator uses the atexit
module. Simple usage of registered atexit functions still works as expected, but involved workflows (e.g. specific exception-flows) relying on atexit behaviour might:tm: break. In those cases, please consider to use one of the two other available modes, first_rerun_remaining
and immediate
, e.g.
from main_entrypoint import entrypoint
@entrypoint(mode="immediate")
def main():
print("Hello World")
immediate
calls the decorated function immediately, entities defined later in the module will not be available, so moving the function to the end of the module is encouraged. first_rerun_remaining
will effectively run everything after the decorated function twice, so the code should be free of side-effects and preferably only consist of definitions in this case. The default mode is at_exit
and should be considered as a first choice.
Future Work
- tests
- automating formatting, checking and releases
- allow to pass arguments to the entrypoint function
License
Project details
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 main_entrypoint-0.1.3-py3-none-any.whl
Algorithm | Hash digest | |
---|---|---|
SHA256 | c2ba8d27d140572146b1cd1980d7ede525847cf0486647fb72adb731b8efaa59 |
|
MD5 | 70ba2a680405d4040796114fab89a522 |
|
BLAKE2b-256 | 24c47873413ce0e530a04ddd3dfedac97bf1efdda080363fc16e49fc9379b8d3 |