yatodo 0.1.0__tar.gz

yatodo-0.1.0/PKG-INFO

@@ -0,0 +1,22 @@
+Metadata-Version: 2.4
+Name: yatodo
+Version: 0.1.0
+Summary: A placeholder for code that needs to be implemented. Raises a NotImplementedError with a descriptive message about the call site. Can be inserted anywhere in the code where functionality is yet to be implemented, without basedpyright screaming warnings. The name yatodo is because there is already a todo. 呀土豆？
+Requires-Python: >=3.12
+Description-Content-Type: text/markdown
+Requires-Dist: build>=1.4.0
+Requires-Dist: flit-core>=3.12.0
+Requires-Dist: twine>=6.2.0
+
+# YATODO
+
+<center><a href="https://ja.wikipedia.org/wiki/%E3%83%88%E3%83%89">
+  <figure>
+    <img src="https://upload.wikimedia.org/wikipedia/commons/thumb/8/85/Adult_male_Northern_Fur_Seal.jpg/250px-Adult_male_Northern_Fur_Seal.jpg" alt="や!トド!" width="200"/>
+    <figcaption>や!トド!</figcaption>
+  </figure>
+</a>
+</center>
+
+YATODO (Yet Another TODO) is a placeholder function for code that needs to be implemented. It raises a NotImplementedError with a descriptive message about the call site. It can be inserted anywhere in the code where functionality is yet to be implemented, without basedpyright screaming warnings. You can use it as a placeholder for function bodies, expressions that are not yet decided, or even insert into the middle of an not fully implemented class.
+

yatodo-0.1.0/README.md

@@ -0,0 +1,11 @@
+# YATODO
+
+<center><a href="https://ja.wikipedia.org/wiki/%E3%83%88%E3%83%89">
+  <figure>
+    <img src="https://upload.wikimedia.org/wikipedia/commons/thumb/8/85/Adult_male_Northern_Fur_Seal.jpg/250px-Adult_male_Northern_Fur_Seal.jpg" alt="や!トド!" width="200"/>
+    <figcaption>や!トド!</figcaption>
+  </figure>
+</a>
+</center>
+
+YATODO (Yet Another TODO) is a placeholder function for code that needs to be implemented. It raises a NotImplementedError with a descriptive message about the call site. It can be inserted anywhere in the code where functionality is yet to be implemented, without basedpyright screaming warnings. You can use it as a placeholder for function bodies, expressions that are not yet decided, or even insert into the middle of an not fully implemented class.

yatodo-0.1.0/pyproject.toml

@@ -0,0 +1,18 @@
+[project]
+name = "yatodo"
+version = "0.1.0"
+description = "A placeholder for code that needs to be implemented. Raises a NotImplementedError with a descriptive message about the call site. Can be inserted anywhere in the code where functionality is yet to be implemented, without basedpyright screaming warnings. The name yatodo is because there is already a todo. 呀土豆？"
+readme = "README.md"
+requires-python = ">=3.12"
+dependencies = [
+    "build>=1.4.0",
+    "flit-core>=3.12.0",
+    "twine>=6.2.0",
+]
+
+[tool.ruff]
+indent-width = 2
+
+[build-system]
+requires = ["flit_core>=3.8"]
+build-backend = "flit_core.buildapi"

yatodo-0.1.0/src/yatodo.py

@@ -0,0 +1,21 @@
+from typing import NoReturn
+
+
+def todo(what: str = "") -> NoReturn:
+  """
+  A placeholder for code that needs to be implemented.
+  Raises a NotImplementedError with a descriptive message about the call site.
+  Can be inserted anywhere in the code where functionality is yet to be implemented, without basedpyright screaming warnings.
+  """
+  import inspect
+  import sys
+
+  # Temporarily suppress the traceback to show a cleaner error message.
+  sys.tracebacklimit = 0
+  caller_frame = inspect.stack()[1]
+  message = (
+    f"\n\nTODO: {'Implementation needed' if not what else f'{f"Implement {what}" if not what.startswith("Implement") else what}'}\n"
+    f"      in function '{caller_frame.function}'\n"
+    f"      at {caller_frame.filename}:{caller_frame.lineno}\n"
+  )
+  raise NotImplementedError(message)