https://github.com/emcd/python-falsifier
https://github.com/emcd/python-falsifier
Last synced: 10 months ago
JSON representation
- Host: GitHub
- URL: https://github.com/emcd/python-falsifier
- Owner: emcd
- License: apache-2.0
- Created: 2024-12-16T03:17:02.000Z (over 1 year ago)
- Default Branch: master
- Last Pushed: 2025-04-11T03:49:56.000Z (about 1 year ago)
- Last Synced: 2025-04-11T04:29:14.795Z (about 1 year ago)
- Language: Python
- Size: 91.8 KB
- Stars: 0
- Watchers: 1
- Forks: 0
- Open Issues: 0
-
Metadata Files:
- Readme: README.rst
- License: LICENSE.txt
Awesome Lists containing this project
README
.. vim: set fileencoding=utf-8:
.. -*- coding: utf-8 -*-
.. +--------------------------------------------------------------------------+
| |
| Licensed under the Apache License, Version 2.0 (the "License"); |
| you may not use this file except in compliance with the License. |
| You may obtain a copy of the License at |
| |
| http://www.apache.org/licenses/LICENSE-2.0 |
| |
| Unless required by applicable law or agreed to in writing, software |
| distributed under the License is distributed on an "AS IS" BASIS, |
| WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. |
| See the License for the specific language governing permissions and |
| limitations under the License. |
| |
+--------------------------------------------------------------------------+
*******************************************************************************
falsifier
*******************************************************************************
.. image:: https://img.shields.io/pypi/v/falsifier
:alt: Package Version
:target: https://pypi.org/project/falsifier/
.. image:: https://img.shields.io/pypi/status/falsifier
:alt: PyPI - Status
:target: https://pypi.org/project/falsifier/
.. image:: https://github.com/emcd/python-falsifier/actions/workflows/tester.yaml/badge.svg?branch=master&event=push
:alt: Tests Status
:target: https://github.com/emcd/python-falsifier/actions/workflows/tester.yaml
.. image:: https://emcd.github.io/python-falsifier/coverage.svg
:alt: Code Coverage Percentage
:target: https://github.com/emcd/python-falsifier/actions/workflows/tester.yaml
.. image:: https://img.shields.io/github/license/emcd/python-falsifier
:alt: Project License
:target: https://github.com/emcd/python-falsifier/blob/master/LICENSE.txt
.. image:: https://img.shields.io/pypi/pyversions/falsifier
:alt: Python Versions
:target: https://pypi.org/project/falsifier/
🎭 A very simple Python library package which provides a **base class for
falsey objects** - objects that evaluate to ``False`` in boolean contexts.
Installation 📦
===============================================================================
::
pip install falsifier
Examples 💡
===============================================================================
The ``Falsifier`` class provides a base for creating objects that evaluate to
``False`` in boolean contexts:
>>> from falsifier import Falsifier
>>> obj = Falsifier( )
>>> bool( obj )
False
Identity-based equality ensures each instance is only equal to itself:
>>> obj2 = Falsifier( )
>>> obj == obj2
False
>>> obj == obj
True
Use Cases 🎯
===============================================================================
* 🚩 **Sentinel Objects**: Base class for creating unique sentinel objects that
evaluate to ``False``.
* 🕳️ **Absence Indicators**: Foundation for creating objects that represent
absence or invalidity when ``None`` or ``False`` may be valid.
`More Flair `_
===============================================================================
.. image:: https://img.shields.io/github/last-commit/emcd/python-falsifier
:alt: GitHub last commit
:target: https://github.com/emcd/python-falsifier
.. image:: https://img.shields.io/endpoint?url=https://raw.githubusercontent.com/copier-org/copier/master/img/badge/badge-grayscale-inverted-border-orange.json
:alt: Copier
:target: https://github.com/copier-org/copier
.. image:: https://img.shields.io/badge/%F0%9F%A5%9A-Hatch-4051b5.svg
:alt: Hatch
:target: https://github.com/pypa/hatch
.. image:: https://img.shields.io/badge/pre--commit-enabled-brightgreen?logo=pre-commit
:alt: pre-commit
:target: https://github.com/pre-commit/pre-commit
.. image:: https://microsoft.github.io/pyright/img/pyright_badge.svg
:alt: Pyright
:target: https://microsoft.github.io/pyright
.. image:: https://img.shields.io/endpoint?url=https://raw.githubusercontent.com/astral-sh/ruff/main/assets/badge/v2.json
:alt: Ruff
:target: https://github.com/astral-sh/ruff
.. image:: https://img.shields.io/pypi/implementation/falsifier
:alt: PyPI - Implementation
:target: https://pypi.org/project/falsifier/
.. image:: https://img.shields.io/pypi/wheel/falsifier
:alt: PyPI - Wheel
:target: https://pypi.org/project/falsifier/
Other Projects by This Author 🌟
===============================================================================
* `python-absence `_ (`absence `_ on PyPI)
🕳️ A Python library package which provides a **sentinel for absent values** - a falsey, immutable singleton that represents the absence of a value in contexts where ``None`` or ``False`` may be valid values.
* `python-accretive `_ (`accretive `_ on PyPI)
🌌 A Python library package which provides **accretive data structures** - collections which can grow but never shrink.
* `python-classcore `_ (`classcore `_ on PyPI)
🏭 A Python library package which provides **foundational class factories and decorators** for providing classes with attributes immutability and concealment and other custom behaviors.
* `python-dynadoc `_ (`dynadoc `_ on PyPI)
📝 A Python library package which bridges the gap between **rich annotations** and **automatic documentation generation** with configurable renderers and support for reusable fragments.
* `python-frigid `_ (`frigid `_ on PyPI)
🔒 A Python library package which provides **immutable data structures** - collections which cannot be modified after creation.
* `python-icecream-truck `_ (`icecream-truck `_ on PyPI)
🍦 **Flavorful Debugging** - A Python library which enhances the powerful and well-known ``icecream`` package with flavored traces, configuration hierarchies, customized outputs, ready-made recipes, and more.
* `python-mimeogram `_ (`mimeogram `_ on PyPI)
📨 A command-line tool for **exchanging collections of files with Large Language Models** - bundle multiple files into a single clipboard-ready document while preserving directory structure and metadata... good for code reviews, project sharing, and LLM interactions.