curlify3 0.7__tar.gz → 0.9__tar.gz

{curlify3-0.7 → curlify3-0.9}/PKG-INFO

@@ -1,6 +1,6 @@
-Metadata-Version: 2.4
+Metadata-Version: 2.5
 Name: curlify3
-Version: 0.7
+Version: 0.9
 Summary: yet another library to convert request object to curl command
 Project-URL: Repository, https://github.com/shpaker/curlify3
 Author-email: "A.Shpak" <shpaker@gmail.com>
@@ -24,6 +24,8 @@ Convert request objects from popular Python HTTP libraries into ready-to-run `cu
 - Works with **client-side** requests (`requests`, `httpx`, `httpx2`) and **server-side** incoming requests (`aiohttp.web`, `starlette` / `fastapi`)
 - Faithful rendering of headers, query parameters, cookies (`-b`), and bodies
 - Body payloads: text, JSON, form-encoded, multipart, binary
+- POSIX shell output by default, Windows PowerShell output with `shell="powershell"`
+- One-line output by default, multi-line with `pretty=True` and long option names with `long_options=True`
 - Zero runtime dependencies
 
 ## Installation
@@ -116,6 +118,56 @@ print(to_curl(req))
 
 `to_curl_async()` works with `httpx2.Request` too.
 
+### Readable output
+
+`pretty=True` puts every option on its own line, and `long_options=True` spells the options out (`--header` instead of `-H`). They are independent, so either can be used alone.
+
+```python
+import requests
+from curlify3 import to_curl
+
+req = requests.Request(
+    "POST",
+    "https://httpbin.org/post",
+    json={"date": "2026-08-10"},
+).prepare()
+
+print(to_curl(req, pretty=True, long_options=True))
+# curl https://httpbin.org/post \
+#   --request POST \
+#   --header 'content-type: application/json' \
+#   --data '{"date": "2026-08-10"}'
+```
+
+The url moves to the first line, where `curl` reads it just as well as in the trailing position — the same layout Chrome DevTools' "Copy as cURL" produces. A request with no options stays on one line.
+
+`pretty=True` is rejected with a `ValueError` for `shell="powershell"`: the `--%` token that dialect relies on is effective only until the next newline, and a backtick cannot extend it, so a multi-line command would be passed to `curl.exe` in pieces.
+
+### Windows PowerShell
+
+By default the command is formatted for POSIX shells. Pass `shell="powershell"` to get one that pastes into Windows PowerShell 5.1.
+
+```python
+import requests
+from curlify3 import to_curl
+
+req = requests.Request(
+    "POST",
+    "https://httpbin.org/post",
+    json={"date": "2026-08-10"},
+).prepare()
+
+print(to_curl(req, shell="powershell"))
+# curl.exe --% -X POST -H "content-type: application/json" -d "{\"date\": \"2026-08-10\"}" "https://httpbin.org/post"
+```
+
+`curl.exe` avoids the `Invoke-WebRequest` alias, and `--%` — PowerShell's stop-parsing token — hands the rest to `curl.exe` verbatim. The token is what makes arbitrary JSON survive: without it, 5.1's argument binder re-quotes values by counting every double quote, escaped or not, and mangles the body. Two consequences worth knowing:
+
+- `%NAME%` environment-variable references in a payload are still expanded.
+- The command is for PowerShell only — in `cmd`, git-bash, or WSL, `curl.exe` chokes on `--%`; use the default `shell="sh"` output there. On `pwsh` 7.2+, run `$PSNativeCommandArgumentPassing = 'Legacy'` in the session first.
+
+The constants `curlify3.SH` and `curlify3.POWERSHELL` are exported for use instead of the raw strings.
+
 ### `aiohttp` — server-side
 
 Render an incoming request inside a handler. The async variant is required because the body is read from the stream.
@@ -146,15 +198,17 @@ async def echo(request: Request):
 
 ## API
 
-### `to_curl(request) -> str`
+### `to_curl(request, shell="sh", pretty=False, long_options=False) -> str`
 
 Render a request object as a `curl` command. Use for synchronous request types (`requests.PreparedRequest`, `httpx.Request`, `httpx2.Request`).
 
-### `to_curl_async(request) -> str`
+### `to_curl_async(request, shell="sh", pretty=False, long_options=False) -> str`
 
 Async variant. Use for server-side request objects whose body must be `await`-ed (`aiohttp.web.Request`, `starlette.requests.Request`) or when you prefer the async pathway for `httpx` / `httpx2`.
 
-Both functions raise `ValueError("unknown request object")` if the request type is not recognized.
+`shell` selects the output dialect: `"sh"` (default, POSIX shells) or `"powershell"` (Windows PowerShell 5.1; for `pwsh` 7.2+ see the PowerShell section). `pretty` breaks the command across lines, `long_options` spells the options out; both default to `False`, which keeps the output on a single line with short options.
+
+Both functions raise `ValueError` if the request type or the `shell` value is not recognized, or if `pretty=True` is combined with `shell="powershell"`.
 
 ## Supported request objects
 

{curlify3-0.7 → curlify3-0.9}/README.md

@@ -15,6 +15,8 @@ Convert request objects from popular Python HTTP libraries into ready-to-run `cu
 - Works with **client-side** requests (`requests`, `httpx`, `httpx2`) and **server-side** incoming requests (`aiohttp.web`, `starlette` / `fastapi`)
 - Faithful rendering of headers, query parameters, cookies (`-b`), and bodies
 - Body payloads: text, JSON, form-encoded, multipart, binary
+- POSIX shell output by default, Windows PowerShell output with `shell="powershell"`
+- One-line output by default, multi-line with `pretty=True` and long option names with `long_options=True`
 - Zero runtime dependencies
 
 ## Installation
@@ -107,6 +109,56 @@ print(to_curl(req))
 
 `to_curl_async()` works with `httpx2.Request` too.
 
+### Readable output
+
+`pretty=True` puts every option on its own line, and `long_options=True` spells the options out (`--header` instead of `-H`). They are independent, so either can be used alone.
+
+```python
+import requests
+from curlify3 import to_curl
+
+req = requests.Request(
+    "POST",
+    "https://httpbin.org/post",
+    json={"date": "2026-08-10"},
+).prepare()
+
+print(to_curl(req, pretty=True, long_options=True))
+# curl https://httpbin.org/post \
+#   --request POST \
+#   --header 'content-type: application/json' \
+#   --data '{"date": "2026-08-10"}'
+```
+
+The url moves to the first line, where `curl` reads it just as well as in the trailing position — the same layout Chrome DevTools' "Copy as cURL" produces. A request with no options stays on one line.
+
+`pretty=True` is rejected with a `ValueError` for `shell="powershell"`: the `--%` token that dialect relies on is effective only until the next newline, and a backtick cannot extend it, so a multi-line command would be passed to `curl.exe` in pieces.
+
+### Windows PowerShell
+
+By default the command is formatted for POSIX shells. Pass `shell="powershell"` to get one that pastes into Windows PowerShell 5.1.
+
+```python
+import requests
+from curlify3 import to_curl
+
+req = requests.Request(
+    "POST",
+    "https://httpbin.org/post",
+    json={"date": "2026-08-10"},
+).prepare()
+
+print(to_curl(req, shell="powershell"))
+# curl.exe --% -X POST -H "content-type: application/json" -d "{\"date\": \"2026-08-10\"}" "https://httpbin.org/post"
+```
+
+`curl.exe` avoids the `Invoke-WebRequest` alias, and `--%` — PowerShell's stop-parsing token — hands the rest to `curl.exe` verbatim. The token is what makes arbitrary JSON survive: without it, 5.1's argument binder re-quotes values by counting every double quote, escaped or not, and mangles the body. Two consequences worth knowing:
+
+- `%NAME%` environment-variable references in a payload are still expanded.
+- The command is for PowerShell only — in `cmd`, git-bash, or WSL, `curl.exe` chokes on `--%`; use the default `shell="sh"` output there. On `pwsh` 7.2+, run `$PSNativeCommandArgumentPassing = 'Legacy'` in the session first.
+
+The constants `curlify3.SH` and `curlify3.POWERSHELL` are exported for use instead of the raw strings.
+
 ### `aiohttp` — server-side
 
 Render an incoming request inside a handler. The async variant is required because the body is read from the stream.
@@ -137,15 +189,17 @@ async def echo(request: Request):
 
 ## API
 
-### `to_curl(request) -> str`
+### `to_curl(request, shell="sh", pretty=False, long_options=False) -> str`
 
 Render a request object as a `curl` command. Use for synchronous request types (`requests.PreparedRequest`, `httpx.Request`, `httpx2.Request`).
 
-### `to_curl_async(request) -> str`
+### `to_curl_async(request, shell="sh", pretty=False, long_options=False) -> str`
 
 Async variant. Use for server-side request objects whose body must be `await`-ed (`aiohttp.web.Request`, `starlette.requests.Request`) or when you prefer the async pathway for `httpx` / `httpx2`.
 
-Both functions raise `ValueError("unknown request object")` if the request type is not recognized.
+`shell` selects the output dialect: `"sh"` (default, POSIX shells) or `"powershell"` (Windows PowerShell 5.1; for `pwsh` 7.2+ see the PowerShell section). `pretty` breaks the command across lines, `long_options` spells the options out; both default to `False`, which keeps the output on a single line with short options.
+
+Both functions raise `ValueError` if the request type or the `shell` value is not recognized, or if `pretty=True` is combined with `shell="powershell"`.
 
 ## Supported request objects
 

curlify3-0.9/curlify3/__init__.py

@@ -0,0 +1,9 @@
+from curlify3._curl import POWERSHELL, SH, to_curl, to_curl_async
+
+__version__ = "0.9"
+__all__ = [
+    "POWERSHELL",
+    "SH",
+    "to_curl",
+    "to_curl_async",
+]

curlify3-0.9/curlify3/_curl.py

@@ -0,0 +1,168 @@
+import re
+
+from asyncio import iscoroutine
+from typing import Callable, NamedTuple, Optional
+
+from curlify3._utils import make_request_obj, make_request_obj_async
+
+MULTIPART_FORM_DATA = re.compile(rb'form-data; name="(.[^"]+)"\r\n\r\n(.+)\r\n')
+MULTIPART_FILE_DATA = re.compile(rb'form-data; name="(.[^"]+)"; filename="(.[^"]+)"')
+
+PS_QUOTE = re.compile(r'(\\*)"')
+PS_TRAILING_BACKSLASHES = re.compile(r"\\+$")
+
+SH = "sh"
+POWERSHELL = "powershell"
+
+SHORT_OPTIONS = {
+    "request": "-X",
+    "header": "-H",
+    "cookie": "-b",
+    "data": "-d",
+    "form": "-F",
+}
+LONG_OPTIONS = {
+    "request": "--request",
+    "header": "--header",
+    "cookie": "--cookie",
+    "data": "--data",
+    "form": "--form",
+}
+
+
+def quote_sh(value):
+    return f"'{value}'"
+
+
+def quote_sh_url(url):
+    return url if not "&" in url else quote_sh(url)
+
+
+def quote_sh_cookies(cookies):
+    return quote_sh(cookies) if " " in cookies else cookies
+
+
+def quote_powershell(value):
+    # the command is emitted behind the --% stop-parsing token, so the only parser left is the
+    # C runtime of curl.exe: wrap in "...", escape " as \" doubling any run of backslashes
+    # directly before it, and double a trailing run so it cannot swallow the closing quote
+    value = PS_QUOTE.sub(lambda matched: matched.group(1) * 2 + '\\"', str(value))
+    value = PS_TRAILING_BACKSLASHES.sub(lambda matched: matched.group() * 2, value)
+    return f'"{value}"'
+
+
+class ShellConfig(NamedTuple):
+    binary: str
+    args_prefix: str
+    quote: Callable
+    quote_url: Callable
+    quote_cookies: Callable
+    # what separates arguments in pretty mode, None when the shell cannot span lines
+    pretty_separator: Optional[str]
+
+
+SHELLS = {
+    SH: ShellConfig("curl", "", quote_sh, quote_sh_url, quote_sh_cookies, " \\\n  "),
+    # --% is the stop-parsing token: Windows PowerShell 5.1 (the dialect's target) hands
+    # everything after it to curl.exe verbatim (only %VAR% references expand), leaving the
+    # C runtime as the single parser — 5.1's own argument binder re-quotes by counting every
+    # double quote, escaped or not, and corrupts JSON payloads no matter how they are written;
+    # pwsh 7.2+ binds even these arguments the new way and needs
+    # $PSNativeCommandArgumentPassing = 'Legacy' in the session first (documented in README);
+    # the url and cookies are always quoted to keep whitespace safe for the C runtime parser
+    # pretty is impossible here: --% is effective only until the next newline and the line
+    # continuation character (`) cannot extend it (about_Parsing), so a multi-line command
+    # would pass the backtick to curl.exe and run the next line on its own
+    POWERSHELL: ShellConfig("curl.exe", "--%", quote_powershell, quote_powershell, quote_powershell, None),
+}
+
+
+def make_curl_headers(headers, quote, options):
+    option = options["header"]
+    return [f"{option} {quote(f'{header}: {value}')}" for header, value in headers.items()]
+
+
+def make_curl_cookies(cookies, quote_cookies, options):
+    if not cookies:
+        return []
+    return [f"{options['cookie']} {quote_cookies(cookies)}"]
+
+
+def make_multipart_curl_args(body, quote, options):
+    option = options["form"]
+    body_parts = []
+    body = body.encode() if isinstance(body, str) else body
+    for matched in MULTIPART_FORM_DATA.finditer(body):
+        groups = matched.groups()
+        body_parts.append(f"{option} {quote(f'{groups[0].decode()}={groups[1].decode()}')}")
+    for matched in MULTIPART_FILE_DATA.finditer(body):
+        groups = matched.groups()
+        body_parts.append(f"{option} {quote(f'{groups[0].decode()}=@{groups[1].decode()}')}")
+    return body_parts
+
+
+def make_curl_body(body, headers, quote, options):
+    if "multipart" in headers.get("content-type", ""):
+        return make_multipart_curl_args(body, quote, options)
+    if not body:
+        return []
+    return [f"{options['data']} {quote(body)}"]
+
+
+def make_curl_string(method, url, headers, body, cookies, http2=False, shell=SH, pretty=False, long_options=False):
+    if shell not in SHELLS:
+        raise ValueError(f"unknown shell: {shell!r}, expected one of {sorted(SHELLS)}")
+    shell_conf = SHELLS[shell]
+    if pretty and shell_conf.pretty_separator is None:
+        raise ValueError(f"pretty output is not supported for shell: {shell!r}")
+    options = LONG_OPTIONS if long_options else SHORT_OPTIONS
+    if "content-length" in headers:
+        del headers["content-length"]
+    if body and isinstance(body, (str, bytes)) and not headers.get("content-type"):
+        headers["content-type"] = "plain/text"
+    args = [
+        "--http2" if http2 else None,
+        f"{options['request']} {method}" if method != "GET" else None,
+        *make_curl_cookies(cookies, shell_conf.quote_cookies, options),
+        *make_curl_headers(headers, shell_conf.quote, options),
+        *make_curl_body(body, headers, shell_conf.quote, options),
+    ]
+    args = [str(entity) for entity in args if entity]
+    command = " ".join([part for part in (shell_conf.binary, shell_conf.args_prefix) if part])
+    url = shell_conf.quote_url(url)
+    if pretty:
+        return shell_conf.pretty_separator.join([f"{command} {url}", *args])
+    return " ".join([command, *args, url])
+
+
+def to_curl(request, shell=SH, pretty=False, long_options=False):
+    data = make_request_obj(request)
+    return make_curl_string(
+        method=data.method,
+        url=data.url,
+        headers=data.headers,
+        body=data.body(),
+        cookies=data.cookies,
+        http2=getattr(data, "http2", False),
+        shell=shell,
+        pretty=pretty,
+        long_options=long_options,
+    )
+
+
+async def to_curl_async(request, shell=SH, pretty=False, long_options=False):
+    data = make_request_obj_async(request)
+    body = data.body()
+    if iscoroutine(body):
+        body = await body
+    return make_curl_string(
+        method=data.method,
+        url=data.url,
+        headers=data.headers,
+        body=body,
+        cookies=data.cookies,
+        http2=getattr(data, "http2", False),
+        shell=shell,
+        pretty=pretty,
+        long_options=long_options,
+    )

{curlify3-0.7 → curlify3-0.9}/pyproject.toml

@@ -1,6 +1,6 @@
 [project]
 name = "curlify3"
-version = "0.7"
+version = "0.9"
 description = "yet another library to convert request object to curl command"
 readme = "README.md"
 requires-python = ">=3.10"

curlify3-0.7/curlify3/__init__.py

@@ -1,7 +0,0 @@
-from curlify3._curl import to_curl, to_curl_async
-
-__version__ = "0.7"
-__all__ = [
-    "to_curl",
-    "to_curl_async",
-]

curlify3-0.7/curlify3/_curl.py

@@ -1,91 +0,0 @@
-import re
-
-from asyncio import iscoroutine
-
-from curlify3._utils import make_request_obj, make_request_obj_async
-
-MULTIPART_FORM_DATA = re.compile(rb'form-data; name="(.[^"]+)"\r\n\r\n(.+)\r\n')
-MULTIPART_FILE_DATA = re.compile(rb'form-data; name="(.[^"]+)"; filename="(.[^"]+)"')
-
-
-def make_full_url(url) -> str:
-    return url if not "&" in url else f"'{url}'"
-
-
-def make_curl_headers(headers):
-    results = []
-    for header, value in headers.items():
-        results.append(f"-H '{header}: {value}'")
-    return " ".join(results)
-
-
-def make_curl_cookies(cookies):
-    if not cookies:
-        return None
-    if " " in cookies:
-        cookies = f"'{cookies}'"
-    return f"-b {cookies}"
-
-
-def make_multipart_curl_args(body):
-    body_parts = []
-    body = body.encode() if isinstance(body, str) else body
-    for matched in MULTIPART_FORM_DATA.finditer(body):
-        groups = matched.groups()
-        body_parts.append(f"-F '{groups[0].decode()}={groups[1].decode()}'")
-    for matched in MULTIPART_FILE_DATA.finditer(body):
-        groups = matched.groups()
-        body_parts.append(f"-F '{groups[0].decode()}=@{groups[1].decode()}'")
-    return " ".join(body_parts)
-
-
-def make_curl_body(body, headers):
-    if "multipart" in headers.get("content-type", ""):
-        return make_multipart_curl_args(body)
-    if not body:
-        return ""
-    return f"-d '{body}'"
-
-
-def make_curl_string(method, url, headers, body, cookies, http2=False):
-    if "content-length" in headers:
-        del headers["content-length"]
-    if body and isinstance(body, (str, bytes)) and not headers.get("content-type"):
-        headers["content-type"] = "plain/text"
-    cli_parts = [
-        f"curl",
-        "--http2" if http2 else None,
-        f"-X {method}" if method != "GET" else None,
-        make_curl_cookies(cookies),
-        make_curl_headers(headers),
-        make_curl_body(body, headers),
-        make_full_url(url),
-    ]
-    return " ".join([str(entity) for entity in cli_parts if entity])
-
-
-def to_curl(request):
-    data = make_request_obj(request)
-    return make_curl_string(
-        method=data.method,
-        url=data.url,
-        headers=data.headers,
-        body=data.body(),
-        cookies=data.cookies,
-        http2=getattr(data, "http2", False),
-    )
-
-
-async def to_curl_async(request):
-    data = make_request_obj_async(request)
-    body = data.body()
-    if iscoroutine(body):
-        body = await body
-    return make_curl_string(
-        method=data.method,
-        url=data.url,
-        headers=data.headers,
-        body=body,
-        cookies=data.cookies,
-        http2=getattr(data, "http2", False),
-    )