literalenum 0.1.1__tar.gz → 0.2.0__tar.gz

{literalenum-0.1.1 → literalenum-0.2.0}/PKG-INFO

@@ -1,6 +1,6 @@
 Metadata-Version: 2.4
 Name: literalenum
-Version: 0.1.1
+Version: 0.2.0
 Summary: A Python typing construct that provides namespaced literal constants with advanced typing features.
 Project-URL: Homepage, https://github.com/modularizer/literalenum
 Project-URL: Repository, https://github.com/modularizer/literalenum
@@ -12,6 +12,8 @@ Keywords: python,typehinting
 Requires-Python: >=3.10
 Description-Content-Type: text/markdown
 
+from sample_str_enum_solutions.a_strenum import HttpMethod
+
 # LiteralEnum
 
 **LiteralEnum** is an experiment/prototype for a proposed Python typing construct: 
@@ -60,10 +62,36 @@ This repo is currently set up as a package under `src/`.
 #source .venv/bin/activate
 pip install literalenum
 ```
-
+## Realistic Current Usage
 ```python
+from typing import Literal
 from literalenum import LiteralEnum
 
+HttpMethodT = Literal["GET", "POST", "DELETE"]
+class HttpMethod(LiteralEnum):
+    GET = "GET"
+    POST = "POST"
+    DELETE = "DELETE"
+
+def handle(method: HttpMethodT) -> None:
+    print(f"{method=}")
+
+handle("GET")          # this should type-check ✅ 
+handle(HttpMethod.GET) # this should type-check ✅ 
+handle("git")          # ❌ should be rejected by a type checker
+
+assert HttpMethod.GET == "GET"
+assert list(HttpMethod) == ["GET", "POST", "DELETE"]
+assert "GET" in HttpMethod
+print(HttpMethod.keys())
+print(HttpMethod.values())
+print(HttpMethod.mapping)
+```
+
+## Optimistic Future Usage
+```python
+from typing import LiteralEnum # NOT valid right now
+
 class HttpMethod(LiteralEnum):
     GET = "GET"
     POST = "POST"
@@ -72,8 +100,8 @@ class HttpMethod(LiteralEnum):
 def handle(method: HttpMethod) -> None:
     print(f"{method=}")
 
-handle("GET")          # ✅ should type-check
-handle(HttpMethod.GET) # ✅ should type-check
+handle("GET")          # the GOAL is that this should type-check ✅ , in reality: it will not unless typecheckers change
+handle(HttpMethod.GET) # the GOAL is that this should type-check ✅ , in reality: it will not unless typecheckers change
 handle("git")          # ❌ should be rejected by a type checker
 
 assert HttpMethod.GET == "GET"

{literalenum-0.1.1 → literalenum-0.2.0}/README.md

@@ -1,3 +1,5 @@
+from sample_str_enum_solutions.a_strenum import HttpMethod
+
 # LiteralEnum
 
 **LiteralEnum** is an experiment/prototype for a proposed Python typing construct: 
@@ -46,10 +48,36 @@ This repo is currently set up as a package under `src/`.
 #source .venv/bin/activate
 pip install literalenum
 ```
-
+## Realistic Current Usage
 ```python
+from typing import Literal
 from literalenum import LiteralEnum
 
+HttpMethodT = Literal["GET", "POST", "DELETE"]
+class HttpMethod(LiteralEnum):
+    GET = "GET"
+    POST = "POST"
+    DELETE = "DELETE"
+
+def handle(method: HttpMethodT) -> None:
+    print(f"{method=}")
+
+handle("GET")          # this should type-check ✅ 
+handle(HttpMethod.GET) # this should type-check ✅ 
+handle("git")          # ❌ should be rejected by a type checker
+
+assert HttpMethod.GET == "GET"
+assert list(HttpMethod) == ["GET", "POST", "DELETE"]
+assert "GET" in HttpMethod
+print(HttpMethod.keys())
+print(HttpMethod.values())
+print(HttpMethod.mapping)
+```
+
+## Optimistic Future Usage
+```python
+from typing import LiteralEnum # NOT valid right now
+
 class HttpMethod(LiteralEnum):
     GET = "GET"
     POST = "POST"
@@ -58,8 +86,8 @@ class HttpMethod(LiteralEnum):
 def handle(method: HttpMethod) -> None:
     print(f"{method=}")
 
-handle("GET")          # ✅ should type-check
-handle(HttpMethod.GET) # ✅ should type-check
+handle("GET")          # the GOAL is that this should type-check ✅ , in reality: it will not unless typecheckers change
+handle(HttpMethod.GET) # the GOAL is that this should type-check ✅ , in reality: it will not unless typecheckers change
 handle("git")          # ❌ should be rejected by a type checker
 
 assert HttpMethod.GET == "GET"

{literalenum-0.1.1 → literalenum-0.2.0}/pyproject.toml

@@ -5,7 +5,7 @@ build-backend = "hatchling.build"
 
 [project]
 name = "literalenum"
-version = "0.1.1"
+version = "0.2.0"
 description = "A Python typing construct that provides namespaced literal constants with advanced typing features."
 readme = "README.md"
 requires-python = ">=3.10"

{literalenum-0.1.1 → literalenum-0.2.0}/src/literalenum/stubgen.py

@@ -384,9 +384,50 @@ def _parse_out_args(raw: list[str] | None) -> list[Path]:
     return uniq
 
 
+def _resolve_root(raw: str) -> str:
+    """Resolve *raw* to a dotted module name importable by Python.
+
+    Accepts:
+      - A dotted import path:  ``myapp.models``
+      - A file path:           ``src/myapp/models.py``
+      - A directory path:      ``src/myapp/``
+
+    When a file or directory is given its parent is added to ``sys.path``
+    so that ``importlib`` can find it.
+    """
+    import sys
+
+    p = Path(raw)
+
+    # --- file path: /some/path/module.py ---
+    if p.is_file() and p.suffix == ".py":
+        parent = str(p.parent.resolve())
+        if parent not in sys.path:
+            sys.path.insert(0, parent)
+        return p.stem if p.name != "__init__.py" else p.parent.name
+
+    # --- directory path: /some/path/package/ ---
+    if p.is_dir():
+        parent = str(p.parent.resolve())
+        if parent not in sys.path:
+            sys.path.insert(0, parent)
+        return p.name
+
+    # --- dotted import name (ensure cwd is on path) ---
+    cwd = str(Path.cwd())
+    if cwd not in sys.path:
+        sys.path.insert(0, cwd)
+    return raw
+
+
 def main() -> int:
     ap = argparse.ArgumentParser()
-    ap.add_argument("root", help="Root import (package or module) to scan, e.g. myapp")
+    ap.add_argument(
+        "root",
+        help="Root to scan: a dotted import (myapp), "
+             "a .py file (src/myapp/models.py), "
+             "or a directory (src/myapp/).",
+    )
     ap.add_argument(
         "--out",
         action="append",
@@ -402,7 +443,8 @@ def main() -> int:
 
     write_adjacent: bool = not args.no_adjacent
     out_roots: list[Path] = _parse_out_args(args.out) if args.out else []
-    infos = _find_literal_enums(args.root)
+    root = _resolve_root(args.root)
+    infos = _find_literal_enums(root)
 
     by_module: dict[str, list[EnumInfo]] = {}
     for e in infos:

literalenum-0.1.1/pyrightconfig.json

@@ -1,3 +0,0 @@
-{
-  "stubPath": "typings"
-}