panyc 1.0.0__py3-none-any.whl

panyc-1.0.0.data/scripts/panyc.py

@@ -0,0 +1,26 @@
+# Copyright © 2025 Matteo Benzi <matteo.benzi97@gmail.com>
+#
+# 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.
+
+import inspect
+
+def raise_if(expr, message):
+    if expr:
+        caller = inspect.stack()[1]
+        raise AssertionError(f"{caller.filename}:{caller.lineno}: {message}")
+
+def todo(message=""):
+    caller = inspect.stack()[1]
+    if len(message) > 0:
+        message = f" ({message})"
+    raise NotImplementedError(f'{caller.filename}:{caller.lineno}: Function "{caller.function}" not implemented{message}')
+
+def unreachable(message=""):
+    caller = inspect.stack()[1]
+    if len(message) > 0:
+        message = f" ({message})"
+    raise NotImplementedError(f'{caller.filename}:{caller.lineno}: Reached unreachable code in "{caller.function}"{message}')

panyc-1.0.0.dist-info/METADATA

@@ -0,0 +1,86 @@
+Metadata-Version: 2.4
+Name: panyc
+Version: 1.0.0
+Home-page: https://codeberg.org/bnz/panyc
+Author: bnz
+Author-email: matteo.benzi97@gmail.com
+License: MIT
+Description-Content-Type: text/markdown
+Dynamic: author
+Dynamic: author-email
+Dynamic: description
+Dynamic: description-content-type
+Dynamic: home-page
+Dynamic: license
+
+# Panyc
+
+Super simple python package to solve 2 problems:
+- In Python `assert` is not guaranteed to work (see the `-O` flag)
+- The very convenient `todo()`/`unreachable()`/... functions to panic in case reached, are missing
+
+### Usage
+
+```python
+from panyc import raise_if
+
+def is_even(x):
+	raise_if(type(x) != int, f"expected an integer, got {type(x)}")
+	return x % 2 == 0
+
+def main():
+	x = 6.9
+	print("Is", x, "even?", is_even(x))
+
+main()
+```
+Will result in `AssertionError: /path/to/file/example.py:4: expected an integer, got <class 'float'>`
+
+> A couple of notice:
+> - first of all the condition must be true to raise, in the contrary of `assert` where it must be false
+> - secondly it raise an `AssertionError` as well, so the error handling remain the same
+>
+> So if you plan to rewrite your `assert`s you have to change the condition and nothing else
+
+
+```python
+from panyc import todo
+
+def end_world_hungry():
+	todo()
+
+def main():
+	end_world_hungry()
+
+main()
+```
+Will result in `NotImplementedError: /path/to/file/example.py:4: Function "end_world_hungry" not implemented`
+
+
+```python
+from panyc import unreachable
+
+def sound(x):
+	if x == "cat":
+		return "meow"
+	elif x == "dog":
+		return "woof"
+	elif x == "duck":
+		return "quack"
+	unreachable() # we do not expect other animals
+
+def main():
+	print(sound("crocodile"))
+
+main()
+```
+Will result in `NotImplementedError: /path/to/file/example.py:10: Reached unreachable code in "sound"`
+
+### Installation
+
+Just copy the only file `panyc.py` in your project.
+
+If you like the slop, there's also the package on pypi:
+```console
+$ pip install panyc
+```

panyc-1.0.0.dist-info/RECORD

@@ -0,0 +1,6 @@
+panyc.py,sha256=ZghaC8FuxZBQ5SYUQevn1qJXKQ724__8ZpARrt2MT2U,1758
+panyc-1.0.0.data/scripts/panyc.py,sha256=ZghaC8FuxZBQ5SYUQevn1qJXKQ724__8ZpARrt2MT2U,1758
+panyc-1.0.0.dist-info/METADATA,sha256=EolqYH6NnOHs2AILP54p54Bx-04D6MyNqLqAMYwoCrg,1932
+panyc-1.0.0.dist-info/WHEEL,sha256=_zCd3N1l69ArxyTb8rzEoP9TpbYXkqRFSNOD5OuxnTs,91
+panyc-1.0.0.dist-info/top_level.txt,sha256=qZYkGaMuDKYFeaeh764gVaQv4ZduogjeaKXSDAuGzCE,6
+panyc-1.0.0.dist-info/RECORD,,

panyc-1.0.0.dist-info/WHEEL

@@ -0,0 +1,5 @@
+Wheel-Version: 1.0
+Generator: setuptools (80.9.0)
+Root-Is-Purelib: true
+Tag: py3-none-any
+

panyc-1.0.0.dist-info/top_level.txt

@@ -0,0 +1 @@
+panyc

panyc.py

@@ -0,0 +1,26 @@
+# Copyright © 2025 Matteo Benzi <matteo.benzi97@gmail.com>
+#
+# 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.
+
+import inspect
+
+def raise_if(expr, message):
+    if expr:
+        caller = inspect.stack()[1]
+        raise AssertionError(f"{caller.filename}:{caller.lineno}: {message}")
+
+def todo(message=""):
+    caller = inspect.stack()[1]
+    if len(message) > 0:
+        message = f" ({message})"
+    raise NotImplementedError(f'{caller.filename}:{caller.lineno}: Function "{caller.function}" not implemented{message}')
+
+def unreachable(message=""):
+    caller = inspect.stack()[1]
+    if len(message) > 0:
+        message = f" ({message})"
+    raise NotImplementedError(f'{caller.filename}:{caller.lineno}: Reached unreachable code in "{caller.function}"{message}')