Skip to main content
Join the official 2019 Python Developers SurveyStart the survey!

Topology models.

Project description

topo

In what follows

  • python is an alias for python3.5 or any later version (python3.6 and so on),
  • pypy is an alias for pypy3.5 or any later version (pypy3.6 and so on).

Installation

Install the latest pip & setuptools packages versions:

  • with CPython
    python -m pip install --upgrade pip setuptools
    
  • with PyPy
    pypy -m pip install --upgrade pip setuptools
    

User

Download and install the latest stable version from PyPI repository:

  • with CPython
    python -m pip install --upgrade topo
    
  • with PyPy
    pypy -m pip install --upgrade topo
    

Developer

Download the latest version from GitHub repository

git clone https://github.com/lycantropos/topo.git
cd topo

Install:

  • with CPython
    python setup.py install
    
  • with PyPy
    pypy setup.py install
    

Usage

topo provides

  • hashable,
  • partially ordered by <= ("is subset of") and >= ("is superset of") relations,
  • strictly ordered by < ("is strict subset of") and > ("is strict superset of") relations

models & objects:

  • EMPTY_SET: for set with no elements
    >>> from topo.base import EMPTY_SET
    >>> EMPTY_SET
    EmptySet()
    >>> str(EMPTY_SET)
    '{}'
    >>> EMPTY_SET <= EMPTY_SET
    True
    >>> EMPTY_SET < EMPTY_SET
    False
    >>> 1 in EMPTY_SET
    False
    # and so on for every object
    
  • DiscreteSet: for discrete sets of hashable objects (similar to built-in sets)
    >>> from topo.discrete import DiscreteSet
    >>> binary_set = DiscreteSet(0, 1)
    >>> binary_set
    DiscreteSet(0, 1)
    >>> str(binary_set)
    '{0, 1}'
    >>> EMPTY_SET <= binary_set
    True
    >>> binary_set < EMPTY_SET
    False
    >>> 0 in binary_set
    True
    >>> 10 in binary_set
    False
    
  • Interval: for intervals of floating point numbers
    >>> from topo.continuous import Interval
    >>> unit_segment = Interval(0, 1)
    >>> unit_segment
    Interval(0, 1, left_end_inclusive=True, right_end_inclusive=True)
    >>> str(unit_segment)
    '[0, 1]'
    >>> binary_set <= unit_segment
    True
    >>> unit_segment < binary_set
    False
    >>> 0.5 in unit_segment
    True
    >>> 10 in unit_segment
    False
    

with next operators overloaded:

  • |: for sets union

    >>> unit_segment | binary_set
    Interval(0, 1, left_end_inclusive=True, right_end_inclusive=True)
    

    since unit_segment contains binary_set elements.

  • -: for sets difference

    >>> unit_segment - binary_set
    Interval(0, 1, left_end_inclusive=False, right_end_inclusive=False)
    

    as we can see both ends were excluded.

  • &: for sets intersection

    >>> unit_segment & binary_set
    DiscreteSet(0, 1)
    

Also used in conditionals sets will evaluate to False if they are considered empty and True otherwise:

>>> if not EMPTY_SET:
        print('Hello World!')
    else:
        print('Something went wrong.')
Hello World!

Development

Bumping version

Preparation

Install bump2version.

Pre-release

Choose which version number category to bump following semver specification.

Test bumping version

bump2version --dry-run --verbose $CATEGORY

where $CATEGORY is the target version number category name, possible values are patch/minor/major.

Bump version

bump2version --verbose $CATEGORY

This will set version to major.minor.patch-alpha.

Release

Test bumping version

bump2version --dry-run --verbose --tag release

Bump version

bump2version --verbose --tag release

This will set version to major.minor.patch and add Git tag.

Notes

To avoid inconsistency between branches and pull requests, bumping version should be merged into master branch as separate pull request.

Running tests

Plain:

  • with CPython
    python setup.py test
    
  • with PyPy
    pypy setup.py test
    

Inside Docker container:

  • with CPython
    docker-compose --file docker-compose.cpython.yml up
    
  • with PyPy
    docker-compose --file docker-compose.pypy.yml up
    

Bash script (e.g. can be used in Git hooks):

  • with CPython

    ./run-tests.sh
    

    or

    ./run-tests.sh cpython
    
  • with PyPy

    ./run-tests.sh pypy
    

PowerShell script (e.g. can be used in Git hooks):

  • with CPython
    .\run-tests.ps1
    
    or
    .\run-tests.ps1 cpython
    
  • with PyPy
    .\run-tests.ps1 pypy
    

Project details


Download files

Download the file for your platform. If you're not sure which to choose, learn more about installing packages.

Files for topo, version 0.1.1
Filename, size File type Python version Upload date Hashes
Filename, size topo-0.1.1-py3-none-any.whl (9.0 kB) File type Wheel Python version py3 Upload date Hashes View hashes
Filename, size topo-0.1.1.tar.gz (9.2 kB) File type Source Python version None Upload date Hashes View hashes

Supported by

Elastic Elastic Search Pingdom Pingdom Monitoring Google Google BigQuery Sentry Sentry Error logging AWS AWS Cloud computing DataDog DataDog Monitoring Fastly Fastly CDN SignalFx SignalFx Supporter DigiCert DigiCert EV certificate StatusPage StatusPage Status page