asgi-cli 0.4.4__tar.gz → 0.4.5__tar.gz

{asgi_cli-0.4.4/src/asgi_cli.egg-info → asgi_cli-0.4.5}/PKG-INFO

@@ -1,6 +1,6 @@
 Metadata-Version: 2.4
 Name: asgi-cli
-Version: 0.4.4
+Version: 0.4.5
 Summary: Call ASGI Python application from command line, just like CURL
 Author-email: Andriy Kornatskyy <andriy.kornatskyy@live.com>
 License: MIT
@@ -53,32 +53,30 @@ asgi-cli --help
 ```
 
 ```text
-usage: asgi-cli [-h] [-V] [-X COMMAND] [-H HEADER] [-d DATA | -F MULTIPART]
-                [-I] [-b] [-p] [-n NUMBER] [-v]
+usage: asgi_cli [-h] [-V] [--app-dir APP_DIR] [-X METHOD] [-H HEADER]
+                [-d DATA | -F MULTIPART] [-I | -b | -p | -v]
+                [--root-path ROOT_PATH] [-n NUMBER]
                 app [url]
 
 positional arguments:
   app                   an application module
   url                   a uniform resource locator or path (default /)
 
-optional arguments:
+options:
   -h, --help            show this help message and exit
   -V, --version         show program's version number and exit
-  -X COMMAND, --request COMMAND
-                        specify request command to use, e.g. POST (default
-                        GET)
-  -H HEADER, --header HEADER
-                        pass custom header line, e.g. -H='Accept:
-                        application/json'
-  -d DATA, --data DATA  request body data, e.g. '{"msg":"hello"}', 'msg=hello'
-  -F MULTIPART, --form MULTIPART
-                        specify HTTP multipart POST data, e.g. name=value or
-                        name=@file
+  --app-dir APP_DIR     look for APP in the specified directory, by adding this to the PYTHONPATH
+  -X, --request METHOD  specify request method to use, e.g. POST (default GET)
+  -H, --header HEADER   pass custom header line, e.g. -H='Accept: application/json'
+  -d, --data DATA       request body data, e.g. '{"msg":"hello"}', 'msg=hello'
+  -F, --form MULTIPART  specify HTTP multipart POST data, e.g. name=value or name=@file
   -I, --head            show status and headers only
-  -b, --benchmark       issue a number of requests through repeated iterations
-                        (reports throughtput and average call time)
-  -p, --profile         prints out a report of top 10 functions ordered by
-                        internal time, saves to 'stats.cprof' file
+  --root-path ROOT_PATH
+                        set the ASGI 'root_path'
+  -b, --benchmark       issue a number of requests through repeated iterations (reports
+                        throughtput and average call time)
+  -p, --profile         prints out a report of top 10 functions ordered by internal time, saves to
+                        'stats.cprof' file
   -n NUMBER             a number of requests to issue (default 100K)
   -v, --verbose         make the operation more talkative
 ```

{asgi_cli-0.4.4 → asgi_cli-0.4.5}/README.md

@@ -22,32 +22,30 @@ asgi-cli --help
 ```
 
 ```text
-usage: asgi-cli [-h] [-V] [-X COMMAND] [-H HEADER] [-d DATA | -F MULTIPART]
-                [-I] [-b] [-p] [-n NUMBER] [-v]
+usage: asgi_cli [-h] [-V] [--app-dir APP_DIR] [-X METHOD] [-H HEADER]
+                [-d DATA | -F MULTIPART] [-I | -b | -p | -v]
+                [--root-path ROOT_PATH] [-n NUMBER]
                 app [url]
 
 positional arguments:
   app                   an application module
   url                   a uniform resource locator or path (default /)
 
-optional arguments:
+options:
   -h, --help            show this help message and exit
   -V, --version         show program's version number and exit
-  -X COMMAND, --request COMMAND
-                        specify request command to use, e.g. POST (default
-                        GET)
-  -H HEADER, --header HEADER
-                        pass custom header line, e.g. -H='Accept:
-                        application/json'
-  -d DATA, --data DATA  request body data, e.g. '{"msg":"hello"}', 'msg=hello'
-  -F MULTIPART, --form MULTIPART
-                        specify HTTP multipart POST data, e.g. name=value or
-                        name=@file
+  --app-dir APP_DIR     look for APP in the specified directory, by adding this to the PYTHONPATH
+  -X, --request METHOD  specify request method to use, e.g. POST (default GET)
+  -H, --header HEADER   pass custom header line, e.g. -H='Accept: application/json'
+  -d, --data DATA       request body data, e.g. '{"msg":"hello"}', 'msg=hello'
+  -F, --form MULTIPART  specify HTTP multipart POST data, e.g. name=value or name=@file
   -I, --head            show status and headers only
-  -b, --benchmark       issue a number of requests through repeated iterations
-                        (reports throughtput and average call time)
-  -p, --profile         prints out a report of top 10 functions ordered by
-                        internal time, saves to 'stats.cprof' file
+  --root-path ROOT_PATH
+                        set the ASGI 'root_path'
+  -b, --benchmark       issue a number of requests through repeated iterations (reports
+                        throughtput and average call time)
+  -p, --profile         prints out a report of top 10 functions ordered by internal time, saves to
+                        'stats.cprof' file
   -n NUMBER             a number of requests to issue (default 100K)
   -v, --verbose         make the operation more talkative
 ```

{asgi_cli-0.4.4 → asgi_cli-0.4.5}/pyproject.toml

@@ -53,3 +53,7 @@ where = ["src"]
 
 [tool.setuptools.package-data]
 asgi_cli = ["py.typed"]
+
+[tool.coverage.run]
+source = ["src/asgi_cli"]
+omit = ["*/test_*.py", "*/tests/*"]

asgi_cli-0.4.5/src/asgi_cli/__init__.py

@@ -0,0 +1 @@
+__version__ = "0.4.5"

{asgi_cli-0.4.4 → asgi_cli-0.4.5}/src/asgi_cli/builder.py

@@ -13,7 +13,6 @@ default_scope: Scope = {
     "asgi": {"version": "3.0", "spec_version": "2.1"},
     "http_version": "1.1",
     "client": ("127.0.0.1", 49327),
-    "root_path": "",
     "headers": [
         (b"accept", b"*/*"),
         (b"user-agent", b"asgi-cli/" + __version__.encode("latin-1")),
@@ -24,10 +23,10 @@ default_scope: Scope = {
 def build_scope(options: Options) -> Scope:
     scope: Scope = copy.deepcopy(default_scope)
     if options.headers_only:
-        if not options.command:
-            options.command = "HEAD"
+        if not options.method:
+            options.method = "HEAD"
 
-    scope["method"] = (options.command or "GET").upper()
+    scope["method"] = (options.method or "GET").upper()
 
     for line in options.header:
         name, value = line.encode("latin-1").split(b": ", 1)
@@ -44,6 +43,7 @@ def build_scope(options: Options) -> Scope:
         port = default_port[scheme]
     scope["server"] = (host, port)
     scope["headers"].append((b"host", netloc.encode("latin-1")))
+    scope["root_path"] = options.root_path
     scope["raw_path"] = urljoin(path, query).encode()
     scope["path"] = unquote(path)
     scope["query_string"] = query.encode()

{asgi_cli-0.4.4 → asgi_cli-0.4.5}/src/asgi_cli/loader.py

@@ -1,9 +1,20 @@
 import importlib
+import os
+import sys
 import typing
 
 from asgi_cli.typing import ASGICallable
 
 
+def should_add_to_syspath(app_dir: str) -> bool:
+    if not os.path.exists(app_dir):
+        return False
+    for path in sys.path:
+        if os.path.exists(path) and os.path.samefile(app_dir, path):
+            return False
+    return True
+
+
 def from_string(import_str: str) -> ASGICallable:
     module_str, _, attrs_str = import_str.partition(":")
     if not module_str or not attrs_str:

{asgi_cli-0.4.4 → asgi_cli-0.4.5}/src/asgi_cli/main.py

@@ -12,6 +12,8 @@ from asgi_cli.typing import Options
 async def go(args: typing.List[str]) -> int:
     try:
         options: Options = parser.parse_options(args)
+        if loader.should_add_to_syspath(options.app_dir):
+            sys.path.append(options.app_dir)
         app = loader.from_string(options.app)
         scope = builder.build_scope(options)
         executor = Executor(app, scope, builder.gen_chunks(options))

{asgi_cli-0.4.4 → asgi_cli-0.4.5}/src/asgi_cli/parser.py

@@ -22,7 +22,7 @@ def parse_number(s: str) -> int:
 
 
 def parse_options(args: typing.List[str]) -> Options:
-    parser = argparse.ArgumentParser()
+    parser = argparse.ArgumentParser(prog="asgi-cli")
     parser.add_argument("app", help="an application module")
     parser.add_argument(
         "url",
@@ -33,11 +33,18 @@ def parse_options(args: typing.List[str]) -> Options:
     parser.add_argument(
         "-V", "--version", action="version", version="%(prog)s " + __version__
     )
+    parser.add_argument(
+        "--app-dir",
+        help="look for APP in the specified directory, by "
+        "adding this to the PYTHONPATH",
+        default="",
+        dest="app_dir",
+    )
     parser.add_argument(
         "-X",
         "--request",
-        help="specify request command to use, e.g. POST (default GET)",
-        dest="command",
+        help="specify request method to use, e.g. POST (default GET)",
+        dest="method",
     )
     parser.add_argument(
         "-H",
@@ -73,6 +80,12 @@ def parse_options(args: typing.List[str]) -> Options:
         default=False,
         dest="headers_only",
     )
+    parser.add_argument(
+        "--root-path",
+        help="set the ASGI 'root_path'",
+        default="",
+        dest="root_path",
+    )
     group.add_argument(
         "-b",
         "--benchmark",
@@ -114,15 +127,15 @@ def parse_options(args: typing.List[str]) -> Options:
         )
         return
     if options.data:
-        if options.command is None:
-            options.command = "POST"
+        if options.method is None:
+            options.method = "POST"
         data = "&".join(options.data)
         if not has_content_type(options.header):
             content_type = guess_content_type(data)
             options.header.append(f"content-type: {content_type}")
         options.data = data.encode("utf-8")
     elif options.multipart:
-        options.command = "POST"
+        options.method = "POST"
         boundary = "----" + "".join(
             random.choice(string.ascii_letters) for _ in range(12)
         )

asgi_cli-0.4.5/src/asgi_cli/tests/test_loader.py

@@ -0,0 +1,17 @@
+import os
+import sys
+import unittest
+
+from asgi_cli.loader import from_string, should_add_to_syspath
+
+
+class LoaderTestCase(unittest.TestCase):
+    def test_should_add_to_syspath(self) -> None:
+        self.assertFalse(should_add_to_syspath(""))
+        self.assertFalse(should_add_to_syspath("."))
+        for path in sys.path:
+            self.assertFalse(should_add_to_syspath(path))
+        self.assertTrue(should_add_to_syspath(os.path.dirname(__file__)))
+
+    def test_from_string(self) -> None:
+        self.assertRaises(ValueError, lambda: from_string("unknown"))

{asgi_cli-0.4.4 → asgi_cli-0.4.5}/src/asgi_cli/tests/test_main.py

@@ -16,6 +16,8 @@ class MainTestCase(unittest.TestCase):
         main(["-X", "POST", "-v", "example:app"])
         main(["-X", "POST", "-d", "msg=hello", "example:app"])
         main(["-I", "example:app"])
+        main(["--app-dir", ".", "app:main"])
+        main(["--app-dir", "./requirements", "app:main"])
         main(["-b", "-n", "1K", "example:app"])
         main(["-p", "-n", "1K", "example:app"])
         main(["-H", "Accept: application/json", "example:app"])

{asgi_cli-0.4.4 → asgi_cli-0.4.5}/src/asgi_cli/typing.py

@@ -9,12 +9,14 @@ Headers = typing.List[typing.Tuple[bytes, bytes]]
 
 
 class Options:
-    command: str
+    method: str
+    app_dir: str
     headers_only: bool
     header: typing.List[str]
     data: bytes
     multipart: typing.List[str]
     boundary: bytes
+    root_path: str
     benchmark: bool
     profile: bool
     number: int

{asgi_cli-0.4.4 → asgi_cli-0.4.5/src/asgi_cli.egg-info}/PKG-INFO

@@ -1,6 +1,6 @@
 Metadata-Version: 2.4
 Name: asgi-cli
-Version: 0.4.4
+Version: 0.4.5
 Summary: Call ASGI Python application from command line, just like CURL
 Author-email: Andriy Kornatskyy <andriy.kornatskyy@live.com>
 License: MIT
@@ -53,32 +53,30 @@ asgi-cli --help
 ```
 
 ```text
-usage: asgi-cli [-h] [-V] [-X COMMAND] [-H HEADER] [-d DATA | -F MULTIPART]
-                [-I] [-b] [-p] [-n NUMBER] [-v]
+usage: asgi_cli [-h] [-V] [--app-dir APP_DIR] [-X METHOD] [-H HEADER]
+                [-d DATA | -F MULTIPART] [-I | -b | -p | -v]
+                [--root-path ROOT_PATH] [-n NUMBER]
                 app [url]
 
 positional arguments:
   app                   an application module
   url                   a uniform resource locator or path (default /)
 
-optional arguments:
+options:
   -h, --help            show this help message and exit
   -V, --version         show program's version number and exit
-  -X COMMAND, --request COMMAND
-                        specify request command to use, e.g. POST (default
-                        GET)
-  -H HEADER, --header HEADER
-                        pass custom header line, e.g. -H='Accept:
-                        application/json'
-  -d DATA, --data DATA  request body data, e.g. '{"msg":"hello"}', 'msg=hello'
-  -F MULTIPART, --form MULTIPART
-                        specify HTTP multipart POST data, e.g. name=value or
-                        name=@file
+  --app-dir APP_DIR     look for APP in the specified directory, by adding this to the PYTHONPATH
+  -X, --request METHOD  specify request method to use, e.g. POST (default GET)
+  -H, --header HEADER   pass custom header line, e.g. -H='Accept: application/json'
+  -d, --data DATA       request body data, e.g. '{"msg":"hello"}', 'msg=hello'
+  -F, --form MULTIPART  specify HTTP multipart POST data, e.g. name=value or name=@file
   -I, --head            show status and headers only
-  -b, --benchmark       issue a number of requests through repeated iterations
-                        (reports throughtput and average call time)
-  -p, --profile         prints out a report of top 10 functions ordered by
-                        internal time, saves to 'stats.cprof' file
+  --root-path ROOT_PATH
+                        set the ASGI 'root_path'
+  -b, --benchmark       issue a number of requests through repeated iterations (reports
+                        throughtput and average call time)
+  -p, --profile         prints out a report of top 10 functions ordered by internal time, saves to
+                        'stats.cprof' file
   -n NUMBER             a number of requests to issue (default 100K)
   -v, --verbose         make the operation more talkative
 ```

asgi_cli-0.4.4/src/asgi_cli/__init__.py

@@ -1 +0,0 @@
-__version__ = "0.4.4"

asgi_cli-0.4.4/src/asgi_cli/tests/test_loader.py

@@ -1,8 +0,0 @@
-import unittest
-
-from asgi_cli.loader import from_string
-
-
-class LoaderTestCase(unittest.TestCase):
-    def test_from_string(self) -> None:
-        self.assertRaises(ValueError, lambda: from_string("unknown"))