optionz 0.1.0__tar.gz

optionz-0.1.0/.github/workflows/publish.yml

@@ -0,0 +1,35 @@
+# $schema=https://www.schemastore.org/github-workflow.json
+on:
+  release:
+    types:
+      - created
+  push:
+    tags:
+      - "v*.*.*"
+
+name: release
+
+jobs:
+  pypi-publish:
+    name: upload release to PyPI
+    runs-on: ubuntu-latest
+    environment: pypi
+    permissions:
+      id-token: write
+    steps:
+      - name: Checkout code
+        uses: actions/checkout@v4
+
+      - name: Install uv
+        uses: astral-sh/setup-uv@v3
+        with:
+          enable-cache: true
+
+      - name: Set up Python
+        run: uv python install
+
+      - name: Build package distributions
+        run: uv build
+
+      - name: Publish to PyPI
+        run: uv publish

optionz-0.1.0/.gitignore

@@ -0,0 +1,11 @@
+# Python-generated files
+__pycache__/
+*.py[oc]
+build/
+docs/build/
+dist/
+wheels/
+*.egg-info
+
+# Virtual environments
+.venv

optionz-0.1.0/.python-version

@@ -0,0 +1 @@
+3.13

optionz-0.1.0/LICENSE

@@ -0,0 +1,21 @@
+MIT License
+
+Copyright (c) 2026, Fábio Macêdo Mendes
+
+Permission is hereby granted, free of charge, to any person obtaining a copy
+of this software and associated documentation files (the "Software"), to deal
+in the Software without restriction, including without limitation the rights
+to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
+copies of the Software, and to permit persons to whom the Software is
+furnished to do so, subject to the following conditions:
+
+The above copyright notice and this permission notice shall be included in all
+copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
+AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
+OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
+SOFTWARE.

optionz-0.1.0/PKG-INFO

@@ -0,0 +1,83 @@
+Metadata-Version: 2.4
+Name: optionz
+Version: 0.1.0
+Summary: Some utility functions for Optional values.
+Project-URL: Homepage, http://github.com/fabiomacedomendes/optionz
+Project-URL: Repository, http://github.com/fabiomacedomendes/optionz
+Author-email: Fábio Macêdo Mendes <fabiomacedomendes@gmail.com>
+Maintainer-email: Fábio Macêdo Mendes <fabiomacedomendes@gmail.com>
+License-Expression: MIT
+License-File: LICENSE
+Classifier: Development Status :: 4 - Beta
+Classifier: Intended Audience :: Developers
+Classifier: License :: OSI Approved :: MIT License
+Classifier: Programming Language :: Python :: 3
+Classifier: Programming Language :: Python :: 3 :: Only
+Classifier: Programming Language :: Python :: 3.13
+Classifier: Programming Language :: Python :: 3.14
+Classifier: Topic :: Utilities
+Requires-Python: >=3.13
+Description-Content-Type: text/markdown
+
+# Optionz
+
+A nullable type is needed when there can be an absence of a value. Python uses
+`None` to represent the empty value and `Optional[T]`, i.e., `T | None` to 
+represent a nullable `T`. The other option is to use exceptions, but they are 
+not expressed as values in the type system, which can be brittle and error-prone.
+
+Python approach is a compromise between the "million dollar mistake",
+in which `null` is a valid member of every type and the more structured
+`Maybe[T]`, that models nullables as a tagged union of `Just[T]` and `Nothing`.
+
+This library provides some utility functions for working with `Optional` values
+in a more functional style, inspired by the `Maybe` monad in Haskell and Rust's
+equivalent `Option` type. 
+
+The main philosophy is that we *do not* want to introduce a new type like
+[returns](https://returns.readthedocs.io/) and other similar libraries. 
+Instead, we want to provide a similar functionality using plain `Optional` values 
+so that your code can adopt it incrementally without feeling like an alien in 
+the Python ecosystem.
+
+As much as I like functional programming and the `Maybe` monad, I think Python's
+approach is fine and offers most of the same static guarantees. The crucial
+difference is that `Maybe` is a **tagged union** of two types and Python's
+`Optional` is a **union of sets**. They behave mostly the same, but the latter do
+not allow nesting: `Optional[Optional[T]]` flattens to `Optional[T]`, while
+`Maybe[Maybe[T]]` is a whole new type. This is a difference that rarely
+matters in practice, and I don't any anyone is clearly superior to the other.
+
+
+## Installation
+
+Install Optionz using pip/uv/poetry whatever you like. For example:
+
+```bash
+pip install optionz
+```
+
+Optionz consists of a single file, so you can also just copy `opt.py` to your 
+project and import it from there. It do not define any new type so there is
+no conflict with code that import vs ones that vendorize it.
+
+
+## Usage
+
+Import `opt` and use the functions as needed. 
+
+```python
+import opt
+
+opt.unwrap(42) # 42
+opt.unwrap(None) # raises ValueError
+```
+
+## Documentation
+
+The documentation is available at https://optionz.rtfd.io/ and includes more 
+examples and explanations of the functions provided by the library.
+
+## License
+
+Optionz is licensed under the MIT License. See [LICENSE](LICENSE) for more details.

optionz-0.1.0/README.md

@@ -0,0 +1,62 @@
+# Optionz
+
+A nullable type is needed when there can be an absence of a value. Python uses
+`None` to represent the empty value and `Optional[T]`, i.e., `T | None` to 
+represent a nullable `T`. The other option is to use exceptions, but they are 
+not expressed as values in the type system, which can be brittle and error-prone.
+
+Python approach is a compromise between the "million dollar mistake",
+in which `null` is a valid member of every type and the more structured
+`Maybe[T]`, that models nullables as a tagged union of `Just[T]` and `Nothing`.
+
+This library provides some utility functions for working with `Optional` values
+in a more functional style, inspired by the `Maybe` monad in Haskell and Rust's
+equivalent `Option` type. 
+
+The main philosophy is that we *do not* want to introduce a new type like
+[returns](https://returns.readthedocs.io/) and other similar libraries. 
+Instead, we want to provide a similar functionality using plain `Optional` values 
+so that your code can adopt it incrementally without feeling like an alien in 
+the Python ecosystem.
+
+As much as I like functional programming and the `Maybe` monad, I think Python's
+approach is fine and offers most of the same static guarantees. The crucial
+difference is that `Maybe` is a **tagged union** of two types and Python's
+`Optional` is a **union of sets**. They behave mostly the same, but the latter do
+not allow nesting: `Optional[Optional[T]]` flattens to `Optional[T]`, while
+`Maybe[Maybe[T]]` is a whole new type. This is a difference that rarely
+matters in practice, and I don't any anyone is clearly superior to the other.
+
+
+## Installation
+
+Install Optionz using pip/uv/poetry whatever you like. For example:
+
+```bash
+pip install optionz
+```
+
+Optionz consists of a single file, so you can also just copy `opt.py` to your 
+project and import it from there. It do not define any new type so there is
+no conflict with code that import vs ones that vendorize it.
+
+
+## Usage
+
+Import `opt` and use the functions as needed. 
+
+```python
+import opt
+
+opt.unwrap(42) # 42
+opt.unwrap(None) # raises ValueError
+```
+
+## Documentation
+
+The documentation is available at https://optionz.rtfd.io/ and includes more 
+examples and explanations of the functions provided by the library.
+
+## License
+
+Optionz is licensed under the MIT License. See [LICENSE](LICENSE) for more details.

optionz-0.1.0/docs/Makefile

@@ -0,0 +1,20 @@
+# Minimal makefile for Sphinx documentation
+#
+
+# You can set these variables from the command line, and also
+# from the environment for the first two.
+SPHINXOPTS    ?=
+SPHINXBUILD   ?= uv run sphinx-build
+SOURCEDIR     = source
+BUILDDIR      = build
+
+# Put it first so that "make" without argument is like "make help".
+help:
+	@$(SPHINXBUILD) -M help "$(SOURCEDIR)" "$(BUILDDIR)" $(SPHINXOPTS) $(O)
+
+.PHONY: help Makefile
+
+# Catch-all target: route all unknown targets to Sphinx using the new
+# "make mode" option.  $(O) is meant as a shortcut for $(SPHINXOPTS).
+%: Makefile
+	@$(SPHINXBUILD) -M $@ "$(SOURCEDIR)" "$(BUILDDIR)" $(SPHINXOPTS) $(O)

optionz-0.1.0/docs/make.bat

@@ -0,0 +1,35 @@
+@ECHO OFF
+
+pushd %~dp0
+
+REM Command file for Sphinx documentation
+
+if "%SPHINXBUILD%" == "" (
+	set SPHINXBUILD=sphinx-build
+)
+set SOURCEDIR=source
+set BUILDDIR=build
+
+%SPHINXBUILD% >NUL 2>NUL
+if errorlevel 9009 (
+	echo.
+	echo.The 'sphinx-build' command was not found. Make sure you have Sphinx
+	echo.installed, then set the SPHINXBUILD environment variable to point
+	echo.to the full path of the 'sphinx-build' executable. Alternatively you
+	echo.may add the Sphinx directory to PATH.
+	echo.
+	echo.If you don't have Sphinx installed, grab it from
+	echo.https://www.sphinx-doc.org/
+	exit /b 1
+)
+
+if "%1" == "" goto help
+
+%SPHINXBUILD% -M %1 %SOURCEDIR% %BUILDDIR% %SPHINXOPTS% %O%
+goto end
+
+:help
+%SPHINXBUILD% -M help %SOURCEDIR% %BUILDDIR% %SPHINXOPTS% %O%
+
+:end
+popd

optionz-0.1.0/docs/source/api.rst

@@ -0,0 +1,40 @@
+API Reference
+=============
+
+.. warning:: 
+
+   Sphinx autodoc is used to generate this documentation. It does not do a 
+   particularly good job at rendering type annotations, so trust your API 
+   or the code itself over the documentation shown here.
+
+   All functions are fully typed and the type annotations are mostly correct.
+
+Unwrapping options
+------------------
+
+.. autofunction:: opt.unwrap
+.. autofunction:: opt.unwrap_or
+.. autofunction:: opt.unwrap_or_else
+.. autofunction:: opt.expect
+
+
+Mapping over options
+--------------------
+
+.. autofunction:: opt.map
+.. autofunction:: opt.call
+
+
+Zipping and combining options
+-----------------------------
+
+.. autofunction:: opt.zip
+.. autofunction:: opt.together
+
+
+Iterating over options
+----------------------
+
+.. autofunction:: opt.iter
+.. autofunction:: opt.elements
+.. autofunction:: opt.values

optionz-0.1.0/docs/source/conf.py

@@ -0,0 +1,37 @@
+# Configuration file for the Sphinx documentation builder.
+#
+# For the full list of built-in configuration values, see the documentation:
+# https://www.sphinx-doc.org/en/master/usage/configuration.html
+
+# -- Project information -----------------------------------------------------
+# https://www.sphinx-doc.org/en/master/usage/configuration.html#project-information
+
+project = "optionz"
+copyright = "2026, Fábio Macêdo Mendes"
+author = "Fábio Macêdo Mendes"
+release = "0.1.0"
+
+# -- General configuration ---------------------------------------------------
+# https://www.sphinx-doc.org/en/master/usage/configuration.html#general-configuration
+
+extensions = [
+    "sphinx_mdinclude",
+    "sphinx.ext.autodoc",
+    "sphinx.ext.napoleon",
+    "sphinx_autodoc_typehints",
+]
+
+autodoc_typehints = "none"
+napoleon_google_docstring = True
+napoleon_numpy_docstring = False
+typehints_document_overloads = False
+
+templates_path = ["_templates"]
+exclude_patterns = []  # type: ignore
+source_suffix = [".rst", ".md"]
+
+# -- Options for HTML output -------------------------------------------------
+# https://www.sphinx-doc.org/en/master/usage/configuration.html#options-for-html-output
+
+html_theme = "alabaster"
+html_static_path = ["_static"]

optionz-0.1.0/docs/source/development.rst

@@ -0,0 +1,59 @@
+Development
+===========
+
+Local setup
+-----------
+
+You must have `uv` installed and everything else follows seamlessly. From project root:
+
+.. code-block:: bash
+
+   uv sync --group dev
+
+
+Pull requests and contributing
+------------------------------
+
+This library is simple enough that you can vendorize and implement your own 
+changes to it. If you want to contribute, please open a pull request with your 
+changes and we can discuss them there.
+
+We have a strict **NO CODING AGENT** policy. If it looks like you are Claude
+or any other agent, we will ignore your PR.
+
+
+Routine tasks and commands
+--------------------------
+
+We use `uv` + `taskipy` to define and run common tasks.
+
+**Build documentation**
+
+.. code-block:: bash
+   
+   uv run task docs
+
+**Run tests**
+
+.. code-block:: bash
+   
+   uv run task test
+
+**Linter**
+
+.. code-block:: bash
+   
+   uv run task lint
+
+**Build the package**
+
+.. code-block:: bash
+   
+   uv run task build
+
+**List tasks**
+
+.. code-block:: bash
+   
+   uv run task -l
+

optionz-0.1.0/docs/source/index.rst

@@ -0,0 +1,21 @@
+.. optionz documentation master file, created by
+   sphinx-quickstart on Sat Jun 13 14:26:03 2026.
+   You can adapt this file completely to your liking, but it should at least
+   contain the root `toctree` directive.
+
+Optionz documentation
+=====================
+
+.. toctree::
+   :maxdepth: 1
+   :caption: Contents:
+
+   api
+   development
+
+
+Introduction 
+------------
+
+.. mdinclude:: ../../README.md 
+   :start-line: 2