literalenum 0.1.1__py3-none-any.whl → 0.2.0__py3-none-any.whl

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.dist-info → literalenum-0.2.0.dist-info}/METADATA

@@ -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.dist-info → literalenum-0.2.0.dist-info}/RECORD

@@ -1,7 +1,7 @@
 literalenum/__init__.py,sha256=Cle3alhK2TPqkjKZ6yEFB3_2yv-y0EwtdYUnbkRG_-s,477
 literalenum/literal_enum.py,sha256=OfB73GCHeZ5G1cAz3EA99zzZsmQ6jtL3xx3AKK-XP-0,3907
 literalenum/mypy_plugin.py,sha256=JExHoi8NP_QJI0eESRed3TdR3DxEVrj7qA6q-bhj3KU,11020
-literalenum/stubgen.py,sha256=U-Ch7-KyAoJXMmGFW5sLRNNszYnMd0T_3mjXHtAOWEo,14456
+literalenum/stubgen.py,sha256=IWT774iThGrbXkYOjVcoCd8Osst9InXpwUJvb3EcG4I,15654
 literalenum/compatibility_extensions/__init__.py,sha256=nIY32idsLpo9VyXtDREWMzLAfYUU7K7Zm3Cl69mWR0k,551
 literalenum/compatibility_extensions/annotated.py,sha256=68TxWaCzMdcuFgnyWfWHUtzUClP5r99BMydSufdgcRA,146
 literalenum/compatibility_extensions/bare_class.py,sha256=LXhT5BfIBJmfA8ZQmHfAVyF4IpM9911oUcj4xtonLFM,75
@@ -20,8 +20,8 @@ literalenum/compatibility_extensions/str_enum.py,sha256=y-VWFyaEDXmNicgyqzdEpsx-
 literalenum/compatibility_extensions/strawberry_enum.py,sha256=mjg3Pyy0w_AggRRB_UtuWQiOguiG66eTN5E_rpwd7cg,526
 typing_literalenum.py,sha256=ZoM0rbr-7Hp72uqohJ6enm-eIhUwAHTGBsb-FsQmXJs,24837
 literalenum/py.typed,sha256=47DEQpj8HBSa-_TImW-5JCeuQeRkm5NMpJWZG3hSuFU,0
-literalenum-0.1.1.dist-info/METADATA,sha256=ZO4NgWWrqRpFZgexLjkyMX5wBVYmn2UMfS5KSdfXuiA,3957
-literalenum-0.1.1.dist-info/WHEEL,sha256=WLgqFyCfm_KASv4WHyYy0P3pM_m7J5L9k2skdKLirC8,87
-literalenum-0.1.1.dist-info/entry_points.txt,sha256=AK8je10LoLMOXuWLjXSqHV2rsTxPW9HlG7YTJGfwkCY,46
-literalenum-0.1.1.dist-info/licenses/LICENSE,sha256=tQZYOMusRS38hVum5uAxSBrSxoQG9w0h6tkyE3RlPmw,1212
-literalenum-0.1.1.dist-info/RECORD,,
+literalenum-0.2.0.dist-info/METADATA,sha256=2f2bFRLze4cbkzhiL5xogmz_vJyQU4Rqwd_B-PtqOd4,4879
+literalenum-0.2.0.dist-info/WHEEL,sha256=WLgqFyCfm_KASv4WHyYy0P3pM_m7J5L9k2skdKLirC8,87
+literalenum-0.2.0.dist-info/entry_points.txt,sha256=AK8je10LoLMOXuWLjXSqHV2rsTxPW9HlG7YTJGfwkCY,46
+literalenum-0.2.0.dist-info/licenses/LICENSE,sha256=tQZYOMusRS38hVum5uAxSBrSxoQG9w0h6tkyE3RlPmw,1212
+literalenum-0.2.0.dist-info/RECORD,,