genesiscoast/conditions-py

Conditions libary for Python 3+

Conditions-PY

Conditions is a Python port of the famous .NET library Conditions which helps developers write pre- and postcondition validations in a fluent manner. Writing these validations is easy and it improves the readability and maintainability of code.

Contents

• Installation
• Conditions
• Tests
• Examples
• Acknowledgements

Installation

Installation is done via PIP:

pip install conditions-py

Conditions

A full list of all the available conditions can be found in the Wiki.

Tests

Currently both unit and integration tests are written using the pytest library. Execution of tests in Visual Studio Code is performed using the pytest test runner.

Examples

import conditions_py


def speak(message: str):
    Condition\
        .requires_str(message, 'message')\
        .is_not_null_or_whitespace()

    # Do speaking...


def multiple(left: int, right: int):
    Condition\
        .requires_num(left, 'left')\
        .is_positive()

    Condition\
        .requires_num(right, 'right')\
        .is_greater_than(4)
        
    # Do multiplication
    
    
def is_true(value: bool):
    Condition\
        .requires_bool(value, 'value')\
        .is_true()
        
    # Do other stuff
    
    
def animals(dog: object, cat: object):
    Condition\
        .requires_obj(dog, 'dog')\
        .is_not_null()
        
    Condition\
        .requires_obj(cat, 'cat')\
        .is_null()
        
    # Do other stuff

A particular validation is executed immediately when it's method is called, and therefore all checks are executed in the order in which they are written:

Acknowledgements

• The icon "Tornado" designed by Adam Whitcroft from The Noun Project.
• Geoffrey Huntley (ghuntley) who is the original author of "Conditions" from which this project was based on.