scala-option

Scala like Option type in Python.

Implements the child classes None and Some, but renamed to none and some, since None is a built-in type in Python.

Table of Contents

• Installation
  • Requirements
  • Installing Using PIP
  • Building from Source
• Usage
  • Quick Start
  • Implemented Methods
• License

Installation

Requirements

This library requires Python 3.12 or newer, because it uses the latest syntax for generics, introduced in Python 3.12.

Download Python

You can check your python version by running the command:

Windows:

py --version

Linux and macOS:

python3 --version

You can download Python from: Download Python

Installing Using PIP

You can install the package by running the command:

pip install scala-option

Building from Source

First, clone the repository or download source code from the latest release.

Next, install the build package:

pip install build

Then, build the project by running:

Windows:

py -m build

Linux and macOS:

python -m build

To install the package locally, run:

pip install -e .

Usage

Quick Start

Once you have installed the package (see Installation), you just need to add the import statement:

Attention: the package name contains an underscore instead of a dash

from scala_option import Option, none, some

Then you can begin using the Option type. Here's a little example:

import random
from scala_option import Option, none, some

def fivety_fivety() -> Option[int]:
  if random.random() <= 0.5:
    return some(1)
  else:
    return none

def print_option(option: Option) -> None:
  if option.is_empty():
    print("You got nothing!")
  else:
    print(f"You got something: {option.get()}")

Implemented Methods

The Option type implements many of the most important methods of the Scala Option (Scala Option documentation).

The methods are documented using Docstrings.

List of methods:

• get()
• is_empty()
• non_empty()
• get_or_else(default)
• or_else(alternative)
• map(f)
• flat_map(f)
• fold(if_empty, f)
• filter(p)
• exists(p)
• contains(elem)
• to_list()

License

MIT License