switches.py 0.1.0

Use C-like switch construct (and more!) in Python

Table of Contents

• Overview
• Usage
• Documentation
• Tests
• Installation
• Dependencies
• License

Switches

if statements in Python can become cluttered when there are too many conditions to check or match, and more often, there is need to make these multiple if constructs more readable, syntactically clearer or at the very least aesthetically pleasing :), thus arising the inspiration for Switches.

Switches is a package that helps support C-like switch statements (and more!) in Python.

Usage

Consider the following (overly simplified) code snippet:

val = get_some_value()
if val == 10:
    do_stuff1()
elif val == 15:
    do_stuff2()
elif val == 20:
    do_stuff3()
elif val == 30:
    do_stuff4()
else:
    do_other_stuff()

Using Switches, we could rewrite this as:

from switches.switch import switch

val = get_some_value()
with switch(val) as s:
    s.case(10, do_stuff1)
    s.case(15, do_stuff2)
    s.case(20, do_stuff3)
    s.case(30, do_stuff4)
    s.default(do_other_stuff)

When writing if conditional tests of equality, Switches can make things pretty easier. In the snippet above, breaks are automatically (implicitly) added to each case statement when fallthrough is set to False(False by default), unlike C-style switches.

For more information about fallthrough attribute and break statements see the doc.

Documentation

More information is contained in the documentation. Read the docs.

Tests

See the tests folder for tests and other examples.

Installation

Via Pip:

pip install switches.py
Alternatively:

Clone this repo, and do:

cd Switches
python setup.py install

Dependencies

Python 3.6+

License

MIT