thesoup 1.3.0

A soup of random python utils

The Soup

A collection of Python utility classes and functions.

Full API documentation is available at sigabrtio.github.io/thesoup.

---

Installation

From PyPI

pip install thesoup

From source

git clone https://github.com/sigabrtio/thesoup.git
cd thesoup
pip install .

To run the tests:

pip install -e ".[test]"
python -m nose2 --start-dir tst

---

Components

Classes

• Graphs

  • DiGraph — abstract directed graph
  • MutableDiGraph — abstract mutable directed graph
  • AdjListGraph — adjacency-list implementation of MutableDiGraph

• Heap

  • MinHeap
  • MaxHeap

• Binary Trees

  • BinarySearchTree

• Trie (ASCII only)

• Sets

  • CountSet — set that tracks occurrence counts of repeated elements
  • DisjointSets — disjoint-set / union-find structure (Wikipedia)

• Result

  • Result — a result type similar to Rust's Result

Functions

• Collections

  • flatten — flatten a nested collection
  • flatten_to_tuple — flatten a nested collection, preserving tuples
  • subsequence — find all subsequences of a list
  • foreach — foreach that works on any collection
  • group_by — group a collection into a map by some criteria

• Graph Traversals

  • bfs — breadth-first search
  • dfs — depth-first search
  • dijkstra — Dijkstra's shortest path
  • shortest_path_dag — specialised shortest path for DAGs

• Strings

  • is_anagram — test if two strings are anagrams

• Other

  • merge — k-way merge