maybe-missing 0.1__tar.gz

maybe_missing-0.1/LICENSE

@@ -0,0 +1,201 @@
+                                 Apache License
+                           Version 2.0, January 2004
+                        http://www.apache.org/licenses/
+
+   TERMS AND CONDITIONS FOR USE, REPRODUCTION, AND DISTRIBUTION
+
+   1. Definitions.
+
+      "License" shall mean the terms and conditions for use, reproduction,
+      and distribution as defined by Sections 1 through 9 of this document.
+
+      "Licensor" shall mean the copyright owner or entity authorized by
+      the copyright owner that is granting the License.
+
+      "Legal Entity" shall mean the union of the acting entity and all
+      other entities that control, are controlled by, or are under common
+      control with that entity. For the purposes of this definition,
+      "control" means (i) the power, direct or indirect, to cause the
+      direction or management of such entity, whether by contract or
+      otherwise, or (ii) ownership of fifty percent (50%) or more of the
+      outstanding shares, or (iii) beneficial ownership of such entity.
+
+      "You" (or "Your") shall mean an individual or Legal Entity
+      exercising permissions granted by this License.
+
+      "Source" form shall mean the preferred form for making modifications,
+      including but not limited to software source code, documentation
+      source, and configuration files.
+
+      "Object" form shall mean any form resulting from mechanical
+      transformation or translation of a Source form, including but
+      not limited to compiled object code, generated documentation,
+      and conversions to other media types.
+
+      "Work" shall mean the work of authorship, whether in Source or
+      Object form, made available under the License, as indicated by a
+      copyright notice that is included in or attached to the work
+      (an example is provided in the Appendix below).
+
+      "Derivative Works" shall mean any work, whether in Source or Object
+      form, that is based on (or derived from) the Work and for which the
+      editorial revisions, annotations, elaborations, or other modifications
+      represent, as a whole, an original work of authorship. For the purposes
+      of this License, Derivative Works shall not include works that remain
+      separable from, or merely link (or bind by name) to the interfaces of,
+      the Work and Derivative Works thereof.
+
+      "Contribution" shall mean any work of authorship, including
+      the original version of the Work and any modifications or additions
+      to that Work or Derivative Works thereof, that is intentionally
+      submitted to Licensor for inclusion in the Work by the copyright owner
+      or by an individual or Legal Entity authorized to submit on behalf of
+      the copyright owner. For the purposes of this definition, "submitted"
+      means any form of electronic, verbal, or written communication sent
+      to the Licensor or its representatives, including but not limited to
+      communication on electronic mailing lists, source code control systems,
+      and issue tracking systems that are managed by, or on behalf of, the
+      Licensor for the purpose of discussing and improving the Work, but
+      excluding communication that is conspicuously marked or otherwise
+      designated in writing by the copyright owner as "Not a Contribution."
+
+      "Contributor" shall mean Licensor and any individual or Legal Entity
+      on behalf of whom a Contribution has been received by Licensor and
+      subsequently incorporated within the Work.
+
+   2. Grant of Copyright License. Subject to the terms and conditions of
+      this License, each Contributor hereby grants to You a perpetual,
+      worldwide, non-exclusive, no-charge, royalty-free, irrevocable
+      copyright license to reproduce, prepare Derivative Works of,
+      publicly display, publicly perform, sublicense, and distribute the
+      Work and such Derivative Works in Source or Object form.
+
+   3. Grant of Patent License. Subject to the terms and conditions of
+      this License, each Contributor hereby grants to You a perpetual,
+      worldwide, non-exclusive, no-charge, royalty-free, irrevocable
+      (except as stated in this section) patent license to make, have made,
+      use, offer to sell, sell, import, and otherwise transfer the Work,
+      where such license applies only to those patent claims licensable
+      by such Contributor that are necessarily infringed by their
+      Contribution(s) alone or by combination of their Contribution(s)
+      with the Work to which such Contribution(s) was submitted. If You
+      institute patent litigation against any entity (including a
+      cross-claim or counterclaim in a lawsuit) alleging that the Work
+      or a Contribution incorporated within the Work constitutes direct
+      or contributory patent infringement, then any patent licenses
+      granted to You under this License for that Work shall terminate
+      as of the date such litigation is filed.
+
+   4. Redistribution. You may reproduce and distribute copies of the
+      Work or Derivative Works thereof in any medium, with or without
+      modifications, and in Source or Object form, provided that You
+      meet the following conditions:
+
+      (a) You must give any other recipients of the Work or
+          Derivative Works a copy of this License; and
+
+      (b) You must cause any modified files to carry prominent notices
+          stating that You changed the files; and
+
+      (c) You must retain, in the Source form of any Derivative Works
+          that You distribute, all copyright, patent, trademark, and
+          attribution notices from the Source form of the Work,
+          excluding those notices that do not pertain to any part of
+          the Derivative Works; and
+
+      (d) If the Work includes a "NOTICE" text file as part of its
+          distribution, then any Derivative Works that You distribute must
+          include a readable copy of the attribution notices contained
+          within such NOTICE file, excluding those notices that do not
+          pertain to any part of the Derivative Works, in at least one
+          of the following places: within a NOTICE text file distributed
+          as part of the Derivative Works; within the Source form or
+          documentation, if provided along with the Derivative Works; or,
+          within a display generated by the Derivative Works, if and
+          wherever such third-party notices normally appear. The contents
+          of the NOTICE file are for informational purposes only and
+          do not modify the License. You may add Your own attribution
+          notices within Derivative Works that You distribute, alongside
+          or as an addendum to the NOTICE text from the Work, provided
+          that such additional attribution notices cannot be construed
+          as modifying the License.
+
+      You may add Your own copyright statement to Your modifications and
+      may provide additional or different license terms and conditions
+      for use, reproduction, or distribution of Your modifications, or
+      for any such Derivative Works as a whole, provided Your use,
+      reproduction, and distribution of the Work otherwise complies with
+      the conditions stated in this License.
+
+   5. Submission of Contributions. Unless You explicitly state otherwise,
+      any Contribution intentionally submitted for inclusion in the Work
+      by You to the Licensor shall be under the terms and conditions of
+      this License, without any additional terms or conditions.
+      Notwithstanding the above, nothing herein shall supersede or modify
+      the terms of any separate license agreement you may have executed
+      with Licensor regarding such Contributions.
+
+   6. Trademarks. This License does not grant permission to use the trade
+      names, trademarks, service marks, or product names of the Licensor,
+      except as required for reasonable and customary use in describing the
+      origin of the Work and reproducing the content of the NOTICE file.
+
+   7. Disclaimer of Warranty. Unless required by applicable law or
+      agreed to in writing, Licensor provides the Work (and each
+      Contributor provides its Contributions) on an "AS IS" BASIS,
+      WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or
+      implied, including, without limitation, any warranties or conditions
+      of TITLE, NON-INFRINGEMENT, MERCHANTABILITY, or FITNESS FOR A
+      PARTICULAR PURPOSE. You are solely responsible for determining the
+      appropriateness of using or redistributing the Work and assume any
+      risks associated with Your exercise of permissions under this License.
+
+   8. Limitation of Liability. In no event and under no legal theory,
+      whether in tort (including negligence), contract, or otherwise,
+      unless required by applicable law (such as deliberate and grossly
+      negligent acts) or agreed to in writing, shall any Contributor be
+      liable to You for damages, including any direct, indirect, special,
+      incidental, or consequential damages of any character arising as a
+      result of this License or out of the use or inability to use the
+      Work (including but not limited to damages for loss of goodwill,
+      work stoppage, computer failure or malfunction, or any and all
+      other commercial damages or losses), even if such Contributor
+      has been advised of the possibility of such damages.
+
+   9. Accepting Warranty or Additional Liability. While redistributing
+      the Work or Derivative Works thereof, You may choose to offer,
+      and charge a fee for, acceptance of support, warranty, indemnity,
+      or other liability obligations and/or rights consistent with this
+      License. However, in accepting such obligations, You may act only
+      on Your own behalf and on Your sole responsibility, not on behalf
+      of any other Contributor, and only if You agree to indemnify,
+      defend, and hold each Contributor harmless for any liability
+      incurred by, or claims asserted against, such Contributor by reason
+      of your accepting any such warranty or additional liability.
+
+   END OF TERMS AND CONDITIONS
+
+   APPENDIX: How to apply the Apache License to your work.
+
+      To apply the Apache License to your work, attach the following
+      boilerplate notice, with the fields enclosed by brackets "[]"
+      replaced with your own identifying information. (Don't include
+      the brackets!)  The text should be enclosed in the appropriate
+      comment syntax for the file format. We also recommend that a
+      file or class name and description of purpose be included on the
+      same "printed page" as the copyright notice for easier
+      identification within third-party archives.
+
+   Copyright [yyyy] [name of copyright owner]
+
+   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.

maybe_missing-0.1/MANIFEST.in

@@ -0,0 +1,2 @@
+include README.md
+recursive-include maybe_missing py.typed *.pyi

maybe_missing-0.1/PKG-INFO

@@ -0,0 +1,147 @@
+Metadata-Version: 2.4
+Name: maybe-missing
+Version: 0.1
+Summary: A tiny typed sentinel for distinguishing None from not provided
+Author-email: Alexander Tikhonov <random.gauss@gmail.com>
+License-Expression: Apache-2.0
+Project-URL: Homepage, https://github.com/Fatal1ty/maybe-missing
+Keywords: typing,sentinel,optional,api,dataclass,maybe
+Classifier: Intended Audience :: Developers
+Classifier: Operating System :: OS Independent
+Classifier: Programming Language :: Python :: 3
+Classifier: Programming Language :: Python :: 3.10
+Classifier: Programming Language :: Python :: 3.11
+Classifier: Programming Language :: Python :: 3.12
+Classifier: Programming Language :: Python :: 3.13
+Classifier: Programming Language :: Python :: 3.14
+Classifier: Development Status :: 5 - Production/Stable
+Classifier: Typing :: Typed
+Requires-Python: >=3.10
+Description-Content-Type: text/markdown
+License-File: LICENSE
+Dynamic: license-file
+
+# maybe-missing
+
+`maybe-missing` is a tiny typed helper for one annoyingly real distinction:
+
+- `None` means “the caller explicitly sent null”
+- `MISSING` means “the caller did not send this value at all”
+
+That difference matters in patch APIs, dataclasses, settings layers, and anywhere a database column is nullable but an omitted field should mean “leave it alone”.
+
+## Why this exists
+
+Python’s `Optional[T]` answers only one question: can the value be `None`?
+
+It does **not** answer the other question: was there a value in the first place?
+
+That becomes awkward fast:
+
+- JSON `null` is a valid payload value
+- a nullable Postgres column may need to be set to `NULL` intentionally
+- omitting a field in a PATCH request should usually mean “don’t update it”
+- a dataclass default should sometimes mean “missing”, not “defaulted to null”
+
+So this package gives you exactly two public names:
+
+- `Maybe[T]`
+- `MISSING`
+
+And then gets out of your way.
+
+## Installation
+
+```bash
+pip install maybe-missing
+```
+
+## Usage
+
+```python
+from maybe_missing import Maybe, MISSING
+
+
+def update_display_name(display_name: Maybe[str | None] = MISSING) -> None:
+    if display_name is MISSING:
+        print("leave the existing value alone")
+    elif display_name is None:
+        print("explicitly store NULL")
+    else:
+        print(f"store {display_name!r}")
+```
+
+## Dataclass example
+
+```python
+from dataclasses import dataclass
+
+from maybe_missing import Maybe, MISSING
+
+
+@dataclass(slots=True)
+class UserPatch:
+    nickname: Maybe[str | None] = MISSING
+    bio: Maybe[str | None] = MISSING
+
+
+def apply_patch(patch: UserPatch) -> None:
+    if patch.nickname is not MISSING:
+        # update nickname to a string or to NULL
+        ...
+
+    if patch.bio is not MISSING:
+        # update bio to a string or to NULL
+        ...
+```
+
+## API example
+
+Imagine a request body for partial updates:
+
+```json
+{
+  "nickname": null
+}
+```
+
+This should mean:
+
+- `nickname` was provided
+- its value is explicitly `null`
+- the server should write `NULL`
+
+While this body:
+
+```json
+{}
+```
+
+should mean:
+
+- `nickname` was not provided
+- keep the current value as is
+
+`Maybe[T]` helps model that cleanly in Python code.
+
+## There are only a couple of lines though
+
+Yes.
+
+There are only a couple of lines.
+
+And that’s exactly why it’s more pleasant not to duplicate them across your projects and just do:
+
+```python
+from maybe_missing import Maybe, MISSING
+```
+
+Isn’t it?
+
+## Typing
+
+The package includes `py.typed`, so type checkers and IDEs can treat it as a typed distribution.
+
+## Compatibility
+
+This package currently targets Python 3.10+.

maybe_missing-0.1/README.md

@@ -0,0 +1,124 @@
+# maybe-missing
+
+`maybe-missing` is a tiny typed helper for one annoyingly real distinction:
+
+- `None` means “the caller explicitly sent null”
+- `MISSING` means “the caller did not send this value at all”
+
+That difference matters in patch APIs, dataclasses, settings layers, and anywhere a database column is nullable but an omitted field should mean “leave it alone”.
+
+## Why this exists
+
+Python’s `Optional[T]` answers only one question: can the value be `None`?
+
+It does **not** answer the other question: was there a value in the first place?
+
+That becomes awkward fast:
+
+- JSON `null` is a valid payload value
+- a nullable Postgres column may need to be set to `NULL` intentionally
+- omitting a field in a PATCH request should usually mean “don’t update it”
+- a dataclass default should sometimes mean “missing”, not “defaulted to null”
+
+So this package gives you exactly two public names:
+
+- `Maybe[T]`
+- `MISSING`
+
+And then gets out of your way.
+
+## Installation
+
+```bash
+pip install maybe-missing
+```
+
+## Usage
+
+```python
+from maybe_missing import Maybe, MISSING
+
+
+def update_display_name(display_name: Maybe[str | None] = MISSING) -> None:
+    if display_name is MISSING:
+        print("leave the existing value alone")
+    elif display_name is None:
+        print("explicitly store NULL")
+    else:
+        print(f"store {display_name!r}")
+```
+
+## Dataclass example
+
+```python
+from dataclasses import dataclass
+
+from maybe_missing import Maybe, MISSING
+
+
+@dataclass(slots=True)
+class UserPatch:
+    nickname: Maybe[str | None] = MISSING
+    bio: Maybe[str | None] = MISSING
+
+
+def apply_patch(patch: UserPatch) -> None:
+    if patch.nickname is not MISSING:
+        # update nickname to a string or to NULL
+        ...
+
+    if patch.bio is not MISSING:
+        # update bio to a string or to NULL
+        ...
+```
+
+## API example
+
+Imagine a request body for partial updates:
+
+```json
+{
+  "nickname": null
+}
+```
+
+This should mean:
+
+- `nickname` was provided
+- its value is explicitly `null`
+- the server should write `NULL`
+
+While this body:
+
+```json
+{}
+```
+
+should mean:
+
+- `nickname` was not provided
+- keep the current value as is
+
+`Maybe[T]` helps model that cleanly in Python code.
+
+## There are only a couple of lines though
+
+Yes.
+
+There are only a couple of lines.
+
+And that’s exactly why it’s more pleasant not to duplicate them across your projects and just do:
+
+```python
+from maybe_missing import Maybe, MISSING
+```
+
+Isn’t it?
+
+## Typing
+
+The package includes `py.typed`, so type checkers and IDEs can treat it as a typed distribution.
+
+## Compatibility
+
+This package currently targets Python 3.10+.

maybe_missing-0.1/maybe_missing/__init__.py

@@ -0,0 +1,20 @@
+from enum import Enum as _Enum, auto as _auto
+from typing import (
+    Final as _Final,
+    Literal as _Literal,
+    TypeAlias as _TypeAlias,
+    TypeVar as _TypeVar,
+)
+
+__all__ = ["Maybe", "MISSING"]
+
+_T = _TypeVar("_T")
+
+
+class _MissingSentinel(_Enum):
+    MISSING = _auto()
+
+
+Maybe: _TypeAlias = _T | _Literal[_MissingSentinel.MISSING]
+
+MISSING: _Final = _MissingSentinel.MISSING

maybe_missing-0.1/maybe_missing/__init__.pyi

@@ -0,0 +1,12 @@
+import enum
+import typing
+
+__all__ = ["Maybe", "MISSING"]
+
+_T = typing.TypeVar("_T")
+
+class _MissingSentinel(enum.Enum):
+    MISSING = ...
+
+MISSING: typing.Final[_MissingSentinel]
+Maybe: typing.TypeAlias = _T | typing.Literal[_MissingSentinel.MISSING]

maybe_missing-0.1/maybe_missing.egg-info/PKG-INFO

@@ -0,0 +1,147 @@
+Metadata-Version: 2.4
+Name: maybe-missing
+Version: 0.1
+Summary: A tiny typed sentinel for distinguishing None from not provided
+Author-email: Alexander Tikhonov <random.gauss@gmail.com>
+License-Expression: Apache-2.0
+Project-URL: Homepage, https://github.com/Fatal1ty/maybe-missing
+Keywords: typing,sentinel,optional,api,dataclass,maybe
+Classifier: Intended Audience :: Developers
+Classifier: Operating System :: OS Independent
+Classifier: Programming Language :: Python :: 3
+Classifier: Programming Language :: Python :: 3.10
+Classifier: Programming Language :: Python :: 3.11
+Classifier: Programming Language :: Python :: 3.12
+Classifier: Programming Language :: Python :: 3.13
+Classifier: Programming Language :: Python :: 3.14
+Classifier: Development Status :: 5 - Production/Stable
+Classifier: Typing :: Typed
+Requires-Python: >=3.10
+Description-Content-Type: text/markdown
+License-File: LICENSE
+Dynamic: license-file
+
+# maybe-missing
+
+`maybe-missing` is a tiny typed helper for one annoyingly real distinction:
+
+- `None` means “the caller explicitly sent null”
+- `MISSING` means “the caller did not send this value at all”
+
+That difference matters in patch APIs, dataclasses, settings layers, and anywhere a database column is nullable but an omitted field should mean “leave it alone”.
+
+## Why this exists
+
+Python’s `Optional[T]` answers only one question: can the value be `None`?
+
+It does **not** answer the other question: was there a value in the first place?
+
+That becomes awkward fast:
+
+- JSON `null` is a valid payload value
+- a nullable Postgres column may need to be set to `NULL` intentionally
+- omitting a field in a PATCH request should usually mean “don’t update it”
+- a dataclass default should sometimes mean “missing”, not “defaulted to null”
+
+So this package gives you exactly two public names:
+
+- `Maybe[T]`
+- `MISSING`
+
+And then gets out of your way.
+
+## Installation
+
+```bash
+pip install maybe-missing
+```
+
+## Usage
+
+```python
+from maybe_missing import Maybe, MISSING
+
+
+def update_display_name(display_name: Maybe[str | None] = MISSING) -> None:
+    if display_name is MISSING:
+        print("leave the existing value alone")
+    elif display_name is None:
+        print("explicitly store NULL")
+    else:
+        print(f"store {display_name!r}")
+```
+
+## Dataclass example
+
+```python
+from dataclasses import dataclass
+
+from maybe_missing import Maybe, MISSING
+
+
+@dataclass(slots=True)
+class UserPatch:
+    nickname: Maybe[str | None] = MISSING
+    bio: Maybe[str | None] = MISSING
+
+
+def apply_patch(patch: UserPatch) -> None:
+    if patch.nickname is not MISSING:
+        # update nickname to a string or to NULL
+        ...
+
+    if patch.bio is not MISSING:
+        # update bio to a string or to NULL
+        ...
+```
+
+## API example
+
+Imagine a request body for partial updates:
+
+```json
+{
+  "nickname": null
+}
+```
+
+This should mean:
+
+- `nickname` was provided
+- its value is explicitly `null`
+- the server should write `NULL`
+
+While this body:
+
+```json
+{}
+```
+
+should mean:
+
+- `nickname` was not provided
+- keep the current value as is
+
+`Maybe[T]` helps model that cleanly in Python code.
+
+## There are only a couple of lines though
+
+Yes.
+
+There are only a couple of lines.
+
+And that’s exactly why it’s more pleasant not to duplicate them across your projects and just do:
+
+```python
+from maybe_missing import Maybe, MISSING
+```
+
+Isn’t it?
+
+## Typing
+
+The package includes `py.typed`, so type checkers and IDEs can treat it as a typed distribution.
+
+## Compatibility
+
+This package currently targets Python 3.10+.

maybe_missing-0.1/maybe_missing.egg-info/SOURCES.txt

@@ -0,0 +1,12 @@
+LICENSE
+MANIFEST.in
+README.md
+pyproject.toml
+maybe_missing/__init__.py
+maybe_missing/__init__.pyi
+maybe_missing/py.typed
+maybe_missing.egg-info/PKG-INFO
+maybe_missing.egg-info/SOURCES.txt
+maybe_missing.egg-info/dependency_links.txt
+maybe_missing.egg-info/top_level.txt
+tests/test_public_api.py

maybe_missing-0.1/maybe_missing.egg-info/dependency_links.txt

@@ -0,0 +1 @@
+

maybe_missing-0.1/maybe_missing.egg-info/top_level.txt

@@ -0,0 +1 @@
+maybe_missing

maybe_missing-0.1/pyproject.toml

@@ -0,0 +1,37 @@
+[build-system]
+requires = ["setuptools>=77.0.3"]
+build-backend = "setuptools.build_meta"
+
+[project]
+name = "maybe-missing"
+version = "0.1"
+license = "Apache-2.0"
+description = "A tiny typed sentinel for distinguishing None from not provided"
+readme = "README.md"
+authors = [{ name = "Alexander Tikhonov", email = "random.gauss@gmail.com" }]
+requires-python = ">=3.10"
+keywords = ["typing", "sentinel", "optional", "api", "dataclass", "maybe"]
+classifiers = [
+    "Intended Audience :: Developers",
+    "Operating System :: OS Independent",
+    "Programming Language :: Python :: 3",
+    "Programming Language :: Python :: 3.10",
+    "Programming Language :: Python :: 3.11",
+    "Programming Language :: Python :: 3.12",
+    "Programming Language :: Python :: 3.13",
+    "Programming Language :: Python :: 3.14",
+    "Development Status :: 5 - Production/Stable",
+    "Typing :: Typed",
+]
+
+[project.urls]
+Homepage = "https://github.com/Fatal1ty/maybe-missing"
+
+[tool.setuptools]
+include-package-data = true
+
+[tool.setuptools.packages.find]
+include = ["maybe_missing*"]
+
+[tool.setuptools.package-data]
+maybe_missing = ["py.typed", "*.pyi"]

maybe_missing-0.1/setup.cfg

@@ -0,0 +1,4 @@
+[egg_info]
+tag_build = 
+tag_date = 0
+

maybe_missing-0.1/tests/test_public_api.py

@@ -0,0 +1,32 @@
+import unittest
+
+import maybe_missing
+from maybe_missing import *  # noqa: F403
+
+
+class PublicApiTests(unittest.TestCase):
+    def test_module_exports_only_public_names(self) -> None:
+        self.assertEqual(maybe_missing.__all__, ["Maybe", "MISSING"])
+
+        public_names = {
+            name
+            for name in dir(maybe_missing)
+            if not name.startswith("_") and name not in {"__all__"}
+        }
+        self.assertEqual(public_names, {"Maybe", "MISSING"})
+
+    def test_star_import_respects_all(self) -> None:
+        self.assertIn("Maybe", globals())
+        self.assertIn("MISSING", globals())
+        self.assertIs(MISSING, maybe_missing.MISSING)  # noqa: F405
+
+    def test_missing_is_distinct_from_none(self) -> None:
+        self.assertIsNot(maybe_missing.MISSING, None)
+        value = None
+        missing = maybe_missing.MISSING
+        self.assertIsNone(value)
+        self.assertIsNot(value, missing)
+
+
+if __name__ == "__main__":
+    unittest.main()