falsifier


Namefalsifier JSON
Version 2.0 PyPI version JSON
download
home_pageNone
SummaryProduction of falsey objects.
upload_time2024-12-21 00:31:33
maintainerNone
docs_urlNone
authorNone
requires_python>=3.10
licenseNone
keywords comparison falsey identity truthy
VCS
bugtrack_url
requirements No requirements were recorded.
Travis-CI No Travis.
coveralls test coverage No coveralls.
            .. 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 <https://www.imdb.com/title/tt0151804/characters/nm0431918>`_
===============================================================================

.. 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://img.shields.io/badge/security-bandit-yellow.svg
   :alt: Bandit
   :target: https://github.com/PyCQA/bandit

.. image:: https://img.shields.io/badge/linting-pylint-yellowgreen
   :alt: Pylint
   :target: https://github.com/pylint-dev/pylint

.. 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/

            

Raw data

            {
    "_id": null,
    "home_page": null,
    "name": "falsifier",
    "maintainer": null,
    "docs_url": null,
    "requires_python": ">=3.10",
    "maintainer_email": null,
    "keywords": "comparison, falsey, identity, truthy",
    "author": null,
    "author_email": "Eric McDonald <emcd@users.noreply.github.com>",
    "download_url": "https://files.pythonhosted.org/packages/33/3d/db25ad0aaf05e6f4e89cee24c9ce97a24310c11898bdb3d301ace4f27397/falsifier-2.0.tar.gz",
    "platform": null,
    "description": ".. vim: set fileencoding=utf-8:\n.. -*- coding: utf-8 -*-\n.. +--------------------------------------------------------------------------+\n   |                                                                          |\n   | Licensed under the Apache License, Version 2.0 (the \"License\");          |\n   | you may not use this file except in compliance with the License.         |\n   | You may obtain a copy of the License at                                  |\n   |                                                                          |\n   |     http://www.apache.org/licenses/LICENSE-2.0                           |\n   |                                                                          |\n   | Unless required by applicable law or agreed to in writing, software      |\n   | distributed under the License is distributed on an \"AS IS\" BASIS,        |\n   | WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. |\n   | See the License for the specific language governing permissions and      |\n   | limitations under the License.                                           |\n   |                                                                          |\n   +--------------------------------------------------------------------------+\n\n*******************************************************************************\n                                  falsifier\n*******************************************************************************\n\n.. image:: https://img.shields.io/pypi/v/falsifier\n   :alt: Package Version\n   :target: https://pypi.org/project/falsifier/\n\n.. image:: https://img.shields.io/pypi/status/falsifier\n   :alt: PyPI - Status\n   :target: https://pypi.org/project/falsifier/\n\n.. image:: https://github.com/emcd/python-falsifier/actions/workflows/tester.yaml/badge.svg?branch=master&event=push\n   :alt: Tests Status\n   :target: https://github.com/emcd/python-falsifier/actions/workflows/tester.yaml\n\n.. image:: https://emcd.github.io/python-falsifier/coverage.svg\n   :alt: Code Coverage Percentage\n   :target: https://github.com/emcd/python-falsifier/actions/workflows/tester.yaml\n\n.. image:: https://img.shields.io/github/license/emcd/python-falsifier\n   :alt: Project License\n   :target: https://github.com/emcd/python-falsifier/blob/master/LICENSE.txt\n\n.. image:: https://img.shields.io/pypi/pyversions/falsifier\n   :alt: Python Versions\n   :target: https://pypi.org/project/falsifier/\n\n\n\ud83c\udfad A very simple Python library package which provides a **base class for\nfalsey objects** - objects that evaluate to ``False`` in boolean contexts.\n\n\nInstallation \ud83d\udce6\n===============================================================================\n\n::\n\n    pip install falsifier\n\n\nExamples \ud83d\udca1\n===============================================================================\n\nThe ``Falsifier`` class provides a base for creating objects that evaluate to\n``False`` in boolean contexts:\n\n>>> from falsifier import Falsifier\n>>> obj = Falsifier( )\n>>> bool( obj )\nFalse\n\nIdentity-based equality ensures each instance is only equal to itself:\n\n>>> obj2 = Falsifier( )\n>>> obj == obj2\nFalse\n>>> obj == obj\nTrue\n\n\nUse Cases \ud83c\udfaf\n===============================================================================\n\n* \ud83d\udea9 **Sentinel Objects**: Base class for creating unique sentinel objects that\n  evaluate to ``False``.\n* \ud83d\udd73\ufe0f **Absence Indicators**: Foundation for creating objects that represent\n  absence or invalidity when ``None`` or ``False`` may be valid.\n\n\n`More Flair <https://www.imdb.com/title/tt0151804/characters/nm0431918>`_\n===============================================================================\n\n.. image:: https://img.shields.io/github/last-commit/emcd/python-falsifier\n   :alt: GitHub last commit\n   :target: https://github.com/emcd/python-falsifier\n\n.. image:: https://img.shields.io/endpoint?url=https://raw.githubusercontent.com/copier-org/copier/master/img/badge/badge-grayscale-inverted-border-orange.json\n   :alt: Copier\n   :target: https://github.com/copier-org/copier\n\n.. image:: https://img.shields.io/badge/%F0%9F%A5%9A-Hatch-4051b5.svg\n   :alt: Hatch\n   :target: https://github.com/pypa/hatch\n\n.. image:: https://img.shields.io/badge/pre--commit-enabled-brightgreen?logo=pre-commit\n   :alt: pre-commit\n   :target: https://github.com/pre-commit/pre-commit\n\n.. image:: https://img.shields.io/badge/security-bandit-yellow.svg\n   :alt: Bandit\n   :target: https://github.com/PyCQA/bandit\n\n.. image:: https://img.shields.io/badge/linting-pylint-yellowgreen\n   :alt: Pylint\n   :target: https://github.com/pylint-dev/pylint\n\n.. image:: https://microsoft.github.io/pyright/img/pyright_badge.svg\n   :alt: Pyright\n   :target: https://microsoft.github.io/pyright\n\n.. image:: https://img.shields.io/endpoint?url=https://raw.githubusercontent.com/astral-sh/ruff/main/assets/badge/v2.json\n   :alt: Ruff\n   :target: https://github.com/astral-sh/ruff\n\n.. image:: https://img.shields.io/pypi/implementation/falsifier\n   :alt: PyPI - Implementation\n   :target: https://pypi.org/project/falsifier/\n\n.. image:: https://img.shields.io/pypi/wheel/falsifier\n   :alt: PyPI - Wheel\n   :target: https://pypi.org/project/falsifier/\n",
    "bugtrack_url": null,
    "license": null,
    "summary": "Production of falsey objects.",
    "version": "2.0",
    "project_urls": {
        "Documentation": "https://emcd.github.io/python-falsifier",
        "Download": "https://pypi.org/project/falsifier/#files",
        "Homepage": "https://github.com/emcd/python-falsifier",
        "Issue Tracker": "https://github.com/emcd/python-falsifier/issues",
        "Source Code": "https://github.com/emcd/python-falsifier"
    },
    "split_keywords": [
        "comparison",
        " falsey",
        " identity",
        " truthy"
    ],
    "urls": [
        {
            "comment_text": "",
            "digests": {
                "blake2b_256": "a560a057cc3a98181bc860e0c91d1fc15848c3eff58374f9ab65c5c52b87b5d5",
                "md5": "2615c8984b74c8ef74007aa6f4f7ceeb",
                "sha256": "e8bbc9ca1f1ff24868561ea31169bf93fb8c6aa83470ffacc36fb60e7b6764f3"
            },
            "downloads": -1,
            "filename": "falsifier-2.0-py3-none-any.whl",
            "has_sig": false,
            "md5_digest": "2615c8984b74c8ef74007aa6f4f7ceeb",
            "packagetype": "bdist_wheel",
            "python_version": "py3",
            "requires_python": ">=3.10",
            "size": 13709,
            "upload_time": "2024-12-21T00:31:30",
            "upload_time_iso_8601": "2024-12-21T00:31:30.314388Z",
            "url": "https://files.pythonhosted.org/packages/a5/60/a057cc3a98181bc860e0c91d1fc15848c3eff58374f9ab65c5c52b87b5d5/falsifier-2.0-py3-none-any.whl",
            "yanked": false,
            "yanked_reason": null
        },
        {
            "comment_text": "",
            "digests": {
                "blake2b_256": "333ddb25ad0aaf05e6f4e89cee24c9ce97a24310c11898bdb3d301ace4f27397",
                "md5": "818f13f68f5ad224f76c014fe39919c8",
                "sha256": "5e37da17902e82722f237a5a1811a957ae68c188dea19895dd1ad3e970a68fba"
            },
            "downloads": -1,
            "filename": "falsifier-2.0.tar.gz",
            "has_sig": false,
            "md5_digest": "818f13f68f5ad224f76c014fe39919c8",
            "packagetype": "sdist",
            "python_version": "source",
            "requires_python": ">=3.10",
            "size": 13795,
            "upload_time": "2024-12-21T00:31:33",
            "upload_time_iso_8601": "2024-12-21T00:31:33.030128Z",
            "url": "https://files.pythonhosted.org/packages/33/3d/db25ad0aaf05e6f4e89cee24c9ce97a24310c11898bdb3d301ace4f27397/falsifier-2.0.tar.gz",
            "yanked": false,
            "yanked_reason": null
        }
    ],
    "upload_time": "2024-12-21 00:31:33",
    "github": true,
    "gitlab": false,
    "bitbucket": false,
    "codeberg": false,
    "github_user": "emcd",
    "github_project": "python-falsifier",
    "travis_ci": false,
    "coveralls": false,
    "github_actions": true,
    "lcname": "falsifier"
}
        
Elapsed time: 0.62064s