small gist,to return a default value if the parameter is None
Project description
Version 1.1.4 as of 2020-07-31, see changelog
lib_parameter
small gist, to return a default value if the parameter is None
for mypy type annotation, the parameter usually has the type Optional[T], the returned type will have the type T
really not worth a package, just dont know where else to put it.
# definition
from typing import TypeVar, Optional
T = TypeVar('T')
def get_default_if_none(parameter: Optional[T], default: T) -> T:
if parameter is None:
return default
else:
return parameter
# usage
from typing import Optional
import lib_parameter
x: Optional[int] = None
x = lib_parameter.get_default_if_none(x, default=1)
# now x is from type int, not Optional[int]
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
import the module and check the code - its easy and documented there, including doctest examples.
in case of any questions the usage section might be expanded at a later time
Usage from Commandline
Usage: lib_parameter [OPTIONS] COMMAND [ARGS]...
small gist,to return a default value if the parameter is None
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 lib_parameter
# test latest release from PyPi without installing (can be skipped)
python -m pip install lib_parameter --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/lib_parameter.git
# to test without installing (can be skipped)
python -m pip install git+https://github.com/bitranox/lib_parameter.git --install-option test
# to install and upgrade all dependencies regardless of version number
python -m pip install --upgrade git+https://github.com/bitranox/lib_parameter.git --upgrade-strategy eager
include it into Your requirements.txt:
# Insert following line in Your requirements.txt:
# for the latest Release on pypi:
lib_parameter
# for the latest development version :
lib_parameter @ git+https://github.com/bitranox/lib_parameter.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/lib_parameter.git
$ cd lib_parameter
# 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/lib_parameter.git
$ cd lib_parameter
# 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
cli_exit_tools @ git+https://github.com/bitranox/cli_exit_tools.git
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.4
2020-07-31: initial PyPi 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 lib_parameter-1.1.4-py3-none-any.whl
Algorithm | Hash digest | |
---|---|---|
SHA256 | 57a53eecd95819db6ef9609f8b5d67624b8929a0cd56a39c6ce81b4ba3916846 |
|
MD5 | a3c160320927d1b636eb02bd4ff4679d |
|
BLAKE2b-256 | 42ce57d9a189127e42046b8152967cd94cd7cd8d975f4507cf12593a5ac3f362 |