functions to exit an cli application properly
Project description
Version 1.1.3 as of 2020-07-31, see changelog
cli_exit_tools
small toolset to properly exit a cli application:
print the traceback information (can be set with commandline option)
get a proper exit code from the Exception
flush the streams, to make sure output is written in proper order
demo how to integrate into Your cli module (see usage)
automated tests, Travis Matrix, Documentation, Badges, etc. are managed with PizzaCutter (cookiecutter on steroids)
Python version required: 3.6.0 or newer
tested on linux “bionic” with python 3.6, 3.7, 3.8, 3.8-dev, pypy3
100% code coverage, codestyle checking ,mypy static type checking ,tested under Linux, macOS, Windows, automatic daily builds and monitoring
Try it Online
You might try it right away in Jupyter Notebook by using the “launch binder” badge, or click here
Usage
example for the main_cli
# STDLIB
import sys
from typing import Optional
# EXT
import click
# CONSTANTS
CLICK_CONTEXT_SETTINGS = dict(help_option_names=['-h', '--help'])
try:
from . import __init__conf__
from . import cli_exit_tools
except (ImportError, ModuleNotFoundError): # pragma: no cover
# imports for doctest
import __init__conf__ # type: ignore # pragma: no cover
import cli_exit_tools # type: ignore # pragma: no cover
def info() -> None:
"""
>>> info()
Info for ...
"""
__init__conf__.print_info()
@click.group(help=__init__conf__.title, context_settings=CLICK_CONTEXT_SETTINGS)
@click.version_option(version=__init__conf__.version,
prog_name=__init__conf__.shell_command,
message='{} version %(version)s'.format(__init__conf__.shell_command))
@click.option('--traceback/--no-traceback', is_flag=True, type=bool, default=None, help='return traceback information on cli')
def cli_main(traceback: Optional[bool] = None) -> None:
if traceback is not None:
cli_exit_tools.config.traceback = traceback
@cli_main.command('info', context_settings=CLICK_CONTEXT_SETTINGS)
def cli_info() -> None:
""" get program informations """
info()
# entry point if main
if __name__ == '__main__':
try:
cli_main()
except Exception as exc:
cli_exit_tools.print_exception_message()
sys.exit(cli_exit_tools.get_system_exit_code(exc))
finally:
cli_exit_tools.flush_streams()
get the system exit code
def get_system_exit_code(exc: BaseException) -> int:
"""
Return the exit code for linux or windows os, based on the exception.
If, on windows, the winerror code is passed with the Exception, we return that winerror code.
Parameter
---------
exc
the exception to analyze
Result
------
exit_code
as integer
Examples
--------
>>> try:
... raise RuntimeError()
... except RuntimeError as exc:
... assert get_system_exit_code(exc) == 1
... setattr(exc, 'winerror', 42)
... assert get_system_exit_code(exc) == 42
... setattr(exc, 'winerror', None)
... assert get_system_exit_code(exc) == 1
"""
print the exception message
def print_exception_message(trace_back: bool = config.traceback, stream: Optional[TextIO] = None) -> None:
"""
Prints the Exception Message to stderr
if trace_back is True, it also prints the traceback information
if the exception has stdout, stderr attributes (like the subprocess.CalledProcessError)
those will be also printed to stderr
Parameter
---------
trace_back
if traceback information should be printed. This is usually set early
in the CLI application to the config object via a commandline option.
stream
optional, to which stream to print, default = stderr
Examples
--------
>>> # test with exc_info = None
>>> print_exception_message()
>>> # test with exc_info
>>> try:
... raise FileNotFoundError('test')
... except Exception: # noqa
... print_exception_message(False)
... print_exception_message(True)
>>> # test with subprocess to get stdout, stderr
>>> import subprocess
>>> try:
... discard=subprocess.run('unknown_command', shell=True, check=True)
... except subprocess.CalledProcessError:
... print_exception_message(False)
... print_exception_message(True)
... print_exception_message(True, stream=sys.stderr)
"""
flush the streams
def flush_streams() -> None:
"""
flush the streams - make sure the output is written early,
otherwise the output might be printed even after another CLI
command is launched
Examples
--------
>>> flush_streams()
"""
Usage from Commandline
Usage: cli_exit_tools [OPTIONS] COMMAND [ARGS]...
functions to exit an cli application properly
Options:
--version Show the version and exit.
--traceback / --no-traceback return traceback information on cli
-h, --help Show this message and exit.
Commands:
info get program informations
Installation and Upgrade
Before You start, its highly recommended to update pip and setup tools:
python -m pip --upgrade pip
python -m pip --upgrade setuptools
python -m pip --upgrade wheel
to install the latest release from PyPi via pip (recommended):
# install latest release from PyPi
python -m pip install --upgrade cli_exit_tools
# test latest release from PyPi without installing (can be skipped)
python -m pip install cli_exit_tools --install-option test
to install the latest development version from github via pip:
# normal install
python -m pip install --upgrade git+https://github.com/bitranox/cli_exit_tools.git
# to test without installing (can be skipped)
python -m pip install git+https://github.com/bitranox/cli_exit_tools.git --install-option test
# to install and upgrade all dependencies regardless of version number
python -m pip install --upgrade git+https://github.com/bitranox/cli_exit_tools.git --upgrade-strategy eager
include it into Your requirements.txt:
# Insert following line in Your requirements.txt:
# for the latest Release on pypi:
cli_exit_tools
# for the latest development version :
cli_exit_tools @ git+https://github.com/bitranox/cli_exit_tools.git
# to install and upgrade all modules mentioned in requirements.txt:
python -m pip install --upgrade -r /<path>/requirements.txt
to install the latest development version from source code:
# cd ~
$ git clone https://github.com/bitranox/cli_exit_tools.git
$ cd cli_exit_tools
# to test without installing (can be skipped)
python setup.py test
# normal install
python setup.py install
via makefile: makefiles are a very convenient way to install. Here we can do much more, like installing virtual environments, clean caches and so on.
# from Your shell's homedirectory:
$ git clone https://github.com/bitranox/cli_exit_tools.git
$ cd cli_exit_tools
# to run the tests:
$ make test
# to install the package
$ make install
# to clean the package
$ make clean
# uninstall the package
$ make uninstall
Requirements
following modules will be automatically installed :
## Project Requirements
click
Acknowledgements
special thanks to “uncle bob” Robert C. Martin, especially for his books on “clean code” and “clean architecture”
Contribute
I would love for you to fork and send me pull request for this project. - please Contribute
License
This software is licensed under the MIT license
—
Changelog
new MAJOR version for incompatible API changes,
new MINOR version for added functionality in a backwards compatible manner
new PATCH version for backwards compatible bug fixes
1.1.3
2020-07-31: initial release
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 cli_exit_tools-1.1.3-py3-none-any.whl
Algorithm | Hash digest | |
---|---|---|
SHA256 | de4ef1abd5ca1466cb9a3736294caa81abf04ab4c1dcbbcacffb502a4a8362d1 |
|
MD5 | 2c1c435e46d6e494a492e38b81f5d916 |
|
BLAKE2b-256 | b7539b0c07782a34657baf918098e0a4cdd79f4a11d129ea1938d259ecf77a2e |