asana-api-cli 3.1.2__tar.gz → 3.1.3__tar.gz

{asana_api_cli-3.1.2/src/asana_api_cli.egg-info → asana_api_cli-3.1.3}/PKG-INFO

@@ -1,6 +1,6 @@
 Metadata-Version: 2.4
 Name: asana-api-cli
-Version: 3.1.2
+Version: 3.1.3
 Summary: Command-line wrapper around the official Asana Python SDK
 Author: Masanao Izumo
 License-Expression: MIT

{asana_api_cli-3.1.2 → asana_api_cli-3.1.3}/pyproject.toml

@@ -1,6 +1,6 @@
 [project]
 name = "asana-api-cli"
-version = "3.1.2"
+version = "3.1.3"
 description = "Command-line wrapper around the official Asana Python SDK"
 authors = [{name = "Masanao Izumo"}]
 readme = "README.md"

{asana_api_cli-3.1.2 → asana_api_cli-3.1.3}/src/asana_api_cli/cli.py

@@ -59,9 +59,9 @@ from asana_api_cli.click_ext import (
     LazyGroup,
 )
 from asana_api_cli.formatter import formatted, formatter_flag_names, make_formatter_options
+from asana_api_cli.multibyte_filename import MultibyteFilenameSupport
 from asana_api_cli.session import (
     AsanaSession,
-    MultibyteFilenameSupport,
 )
 from asana_api_cli.structured_arg import (
     click_callback,
@@ -895,10 +895,11 @@ def _make_command(api_cls: type, op: _Operation) -> click.Command:
     options.extend(_make_per_call_kwarg_options())
 
     # ``--multibyte-filenames`` is an asana-api extension that toggles the
-    # multipart filename patch (``MultibyteFilenameSupport`` in session.py). It
-    # only affects multipart uploads, so it is exposed solely on upload commands
-    # (``does_upload``) rather than as a global flag. Off by default to preserve
-    # strict SDK parity (the SDK emits ``filename=`` only); see sdk-deviations.md.
+    # multipart filename patch (``MultibyteFilenameSupport`` in
+    # ``multibyte_filename.py``). It only affects multipart uploads, so it is
+    # exposed solely on upload commands (``does_upload``) rather than as a global
+    # flag. Off by default to preserve strict SDK parity (the SDK emits
+    # ``filename=`` only); see sdk-deviations.md.
     # Its callback installs the patch and scopes it to this command via
     # ``ctx.with_resource``; ``expose_value=False`` keeps it out of
     # ``inner_callback``'s ``**kwargs``.

{asana_api_cli-3.1.2 → asana_api_cli-3.1.3}/src/asana_api_cli/formatter.py

@@ -386,9 +386,19 @@ def _print_csv(rows: list[dict[str, Any]], *, with_bom: bool = False) -> None:
     # ``dict.fromkeys`` preserves insertion order (Python 3.7+), giving a
     # stable column order based on first appearance.
     fieldnames = list(dict.fromkeys(key for row in rows for key in row))
-    # lineterminator="\n" avoids Windows text-mode stdout translating the
-    # csv module's default "\r\n" into "\r\r\n".
-    writer = csv.DictWriter(buf, fieldnames=fieldnames, lineterminator="\n")
+    # RFC 4180: CRLF between records; newlines inside a field stay verbatim.
+    writer = csv.DictWriter(buf, fieldnames=fieldnames, lineterminator="\r\n")
     writer.writeheader()
     writer.writerows(rows)
-    click.echo(buf.getvalue(), nl=False)
+    # Write bytes via the binary layer so the stdout text layer can't translate
+    # newlines (Windows would turn each "\r\n" into "\r\r\n"); fall back to text
+    # for streams without one.
+    text = buf.getvalue()
+    out = sys.stdout
+    raw = getattr(out, "buffer", None)
+    if raw is None:
+        out.write(text)
+    else:
+        out.flush()
+        raw.write(text.encode(out.encoding or "utf-8"))
+        raw.flush()

asana_api_cli-3.1.3/src/asana_api_cli/multibyte_filename.py

@@ -0,0 +1,68 @@
+"""RFC 5987 multipart filename support for the ``python-asana`` SDK.
+
+``MultibyteFilenameSupport`` patches ``urllib3``'s multipart encoder to add the
+RFC 5987 ``filename*=`` parameter so non-ASCII attachment filenames round-trip.
+"""
+
+from __future__ import annotations
+
+import urllib.parse
+from collections.abc import Callable
+from typing import Any
+
+from urllib3.fields import RequestField
+
+
+class MultibyteFilenameSupport:
+    """Make multipart uploads round-trip filenames with non-ASCII characters.
+
+    In ``python-asana`` 5.2.4 (the latest version checked, and likely later
+    ones too), uploading a file whose name has characters outside ASCII
+    stores a garbled (mojibake) name on Asana: the SDK's multipart encoder
+    emits only ``filename="..."`` and omits the RFC 5987 ``filename*=``
+    parameter the server needs to decode them. This context manager patches
+    ``urllib3.fields.RequestField.make_multipart`` to add
+    ``filename*=utf-8''<percent-encoded>`` for such names, scoped to the
+    ``with`` block::
+
+        with MultibyteFilenameSupport():
+            # urllib3-based uploads in this block emit filename*=
+            ...
+    """
+
+    def __init__(self) -> None:
+        self._original: Callable[..., None] | None = None
+
+    def install(self) -> None:
+        if self._original is not None:
+            return
+        self._original = RequestField.make_multipart
+        original = self._original
+
+        def _patched(
+            field: RequestField,
+            content_disposition: str | None = None,
+            content_type: str | None = None,
+            content_location: str | None = None,
+        ) -> None:
+            original(field, content_disposition, content_type, content_location)
+            filename = field._filename  # pyright: ignore[reportPrivateUsage]
+            if filename and any(ord(c) > 127 for c in filename):
+                encoded = urllib.parse.quote(filename, safe="")
+                existing = field.headers.get("Content-Disposition") or ""
+                field.headers["Content-Disposition"] = existing + f"; filename*=utf-8''{encoded}"
+
+        RequestField.make_multipart = _patched  # pyright: ignore[reportAttributeAccessIssue]
+
+    def uninstall(self) -> None:
+        if self._original is None:
+            return
+        RequestField.make_multipart = self._original  # pyright: ignore[reportAttributeAccessIssue]
+        self._original = None
+
+    def __enter__(self) -> MultibyteFilenameSupport:
+        self.install()
+        return self
+
+    def __exit__(self, *exc: Any) -> None:
+        self.uninstall()

{asana_api_cli-3.1.2 → asana_api_cli-3.1.3}/src/asana_api_cli/session.py

@@ -11,80 +11,17 @@ import http.client
 import logging
 import os
 import sys
-import urllib.parse
-from collections.abc import Callable
 from dataclasses import dataclass
 from typing import Any
 
 import asana
 import click
-from urllib3.fields import RequestField
 
 from asana_api_cli.redactor import HttpClientAuthRedactor
 
 ACCESS_TOKEN_ENV = "ASANA_ACCESS_TOKEN"
 
 
-class MultibyteFilenameSupport:
-    """Make multipart uploads round-trip filenames with non-ASCII characters.
-
-    In ``python-asana`` 5.2.4 (the latest version checked, and likely later
-    ones too), uploading a file whose name has characters outside ASCII
-    stores a garbled (mojibake) name on Asana: the SDK's multipart encoder
-    emits only ``filename="..."`` and omits the RFC 5987 ``filename*=``
-    parameter the server needs to decode them. This context manager patches
-    ``urllib3.fields.RequestField.make_multipart`` to add
-    ``filename*=utf-8''<percent-encoded>`` for such names.
-
-    Off by default to preserve strict SDK parity. The CLI enables it when
-    ``--multibyte-filenames`` is passed to an upload command (e.g.
-    ``attachments create-attachment-for-object``): that option's callback enters
-    this context manager via ``ctx.with_resource``, scoping the patch to the
-    command. The context-manager form scopes the patch to a block::
-
-        with MultibyteFilenameSupport():
-            # urllib3-based uploads in this block emit filename*=
-            ...
-    """
-
-    def __init__(self) -> None:
-        self._original: Callable[..., None] | None = None
-
-    def install(self) -> None:
-        if self._original is not None:
-            return
-        self._original = RequestField.make_multipart
-        original = self._original
-
-        def _patched(
-            field: RequestField,
-            content_disposition: str | None = None,
-            content_type: str | None = None,
-            content_location: str | None = None,
-        ) -> None:
-            original(field, content_disposition, content_type, content_location)
-            filename = field._filename  # pyright: ignore[reportPrivateUsage]
-            if filename and any(ord(c) > 127 for c in filename):
-                encoded = urllib.parse.quote(filename, safe="")
-                existing = field.headers.get("Content-Disposition") or ""
-                field.headers["Content-Disposition"] = existing + f"; filename*=utf-8''{encoded}"
-
-        RequestField.make_multipart = _patched  # pyright: ignore[reportAttributeAccessIssue]
-
-    def uninstall(self) -> None:
-        if self._original is None:
-            return
-        RequestField.make_multipart = self._original  # pyright: ignore[reportAttributeAccessIssue]
-        self._original = None
-
-    def __enter__(self) -> MultibyteFilenameSupport:
-        self.install()
-        return self
-
-    def __exit__(self, *exc: Any) -> None:
-        self.uninstall()
-
-
 @dataclass
 class _Runtime:
     """Configuration shared globally during a CLI invocation.

{asana_api_cli-3.1.2 → asana_api_cli-3.1.3/src/asana_api_cli.egg-info}/PKG-INFO

@@ -1,6 +1,6 @@
 Metadata-Version: 2.4
 Name: asana-api-cli
-Version: 3.1.2
+Version: 3.1.3
 Summary: Command-line wrapper around the official Asana Python SDK
 Author: Masanao Izumo
 License-Expression: MIT

{asana_api_cli-3.1.2 → asana_api_cli-3.1.3}/src/asana_api_cli.egg-info/SOURCES.txt

@@ -5,6 +5,7 @@ src/asana_api_cli/__init__.py
 src/asana_api_cli/cli.py
 src/asana_api_cli/click_ext.py
 src/asana_api_cli/formatter.py
+src/asana_api_cli/multibyte_filename.py
 src/asana_api_cli/redactor.py
 src/asana_api_cli/session.py
 src/asana_api_cli/structured_arg.py
@@ -20,6 +21,7 @@ tests/test_cli_invocation.py
 tests/test_cli_surface.py
 tests/test_click_ext.py
 tests/test_formatter.py
+tests/test_multibyte_filename.py
 tests/test_py310_compat.py
 tests/test_redactor.py
 tests/test_sdk_boilerplate.py

{asana_api_cli-3.1.2 → asana_api_cli-3.1.3}/tests/test_formatter.py

@@ -2,7 +2,9 @@
 
 from __future__ import annotations
 
+import io
 import json
+import sys
 from typing import Any, cast
 
 import click
@@ -132,17 +134,27 @@ class TestFormatOutputCsv:
         _format_output([], output_format="csv", jq_query=None)
         assert capsys.readouterr().out == ""
 
-    def test_no_carriage_returns_in_csv_output(self, capsys: pytest.CaptureFixture[str]) -> None:
-        # csv module's default lineterminator is "\r\n", which would interact
-        # with Windows text-mode stdout to produce "\r\r\n". We force "\n"
-        # so the platform layer handles any translation.
+    def test_crlf_rows_with_verbatim_lf_in_field(self, capsys: pytest.CaptureFixture[str]) -> None:
+        # RFC 4180: each record is terminated by CRLF, while a newline inside a
+        # quoted field is written verbatim (LF). The bytes are identical on every
+        # platform — no text-layer translation doubling a CR into "\r\r\n".
         _format_output(
-            [{"a": "1", "b": "2"}, {"a": "3", "b": "4"}],
+            [{"a": "1", "b": "x\ny"}, {"a": "2", "b": "z"}],
             output_format="csv",
             jq_query=None,
         )
         out = capsys.readouterr().out
-        assert "\r" not in out
+        assert out == 'a,b\r\n1,"x\ny"\r\n2,z\r\n'
+        assert out.count("\r\n") == 3  # header + 2 records, each CRLF-terminated
+        assert "\r\r\n" not in out
+
+    def test_crlf_preserved_on_pure_text_stdout(self, monkeypatch: pytest.MonkeyPatch) -> None:
+        # A pure text stream (io.StringIO) has no binary buffer, exercising the
+        # fallback branch. It still emits RFC 4180 CRLF terminators verbatim.
+        buf = io.StringIO()
+        monkeypatch.setattr(sys, "stdout", buf)
+        _format_output([{"a": "1"}], output_format="csv", jq_query=None)
+        assert buf.getvalue() == "a\r\n1\r\n"
 
     def test_bom_off_by_default(self, capsys: pytest.CaptureFixture[str]) -> None:
         _format_output([{"a": "1"}], output_format="csv", jq_query=None)

asana_api_cli-3.1.3/tests/test_multibyte_filename.py

@@ -0,0 +1,117 @@
+"""Tests for asana_api_cli.multibyte_filename — the ``MultibyteFilenameSupport``
+context manager that augments ``urllib3.fields.RequestField.make_multipart`` so
+multipart fields whose filename contains non-ASCII characters also carry the
+RFC 5987 ``filename*=UTF-8''<percent-encoded>`` parameter.
+
+The CLI wiring (the per-command ``--multibyte-filenames`` flag) is covered in
+``test_cli_invocation.py``.
+"""
+
+from __future__ import annotations
+
+from collections.abc import Iterator
+
+import pytest
+from urllib3.fields import RequestField
+
+from asana_api_cli.multibyte_filename import MultibyteFilenameSupport
+
+
+@pytest.fixture
+def _clean_request_field() -> Iterator[None]:
+    """Snapshot and restore ``urllib3.fields.RequestField.make_multipart``."""
+    saved = RequestField.make_multipart
+    try:
+        yield
+    finally:
+        RequestField.make_multipart = saved  # pyright: ignore[reportAttributeAccessIssue]
+
+
+def _content_disposition(filename: str | None) -> str:
+    """Build a fresh ``RequestField`` and return its rendered
+    Content-Disposition after ``make_multipart``."""
+    field = RequestField("file", b"data", filename=filename)
+    field.make_multipart()
+    result = field.headers["Content-Disposition"]
+    assert result is not None  # set unconditionally by make_multipart
+    return result
+
+
+class TestMultibyteFilenameSupport:
+    """``MultibyteFilenameSupport`` augments ``RequestField.make_multipart``
+    so that multipart fields whose filename contains non-ASCII characters
+    also carry the RFC 5987 ``filename*=UTF-8''<percent-encoded>``
+    parameter."""
+
+    def test_context_manager_installs_and_uninstalls(self, _clean_request_field: None) -> None:
+        original = RequestField.make_multipart
+        with MultibyteFilenameSupport():
+            assert RequestField.make_multipart is not original
+        assert RequestField.make_multipart is original
+
+    def test_explicit_install_uninstall(self, _clean_request_field: None) -> None:
+        original = RequestField.make_multipart
+        patcher = MultibyteFilenameSupport()
+        patcher.install()
+        assert RequestField.make_multipart is not original
+        patcher.uninstall()
+        assert RequestField.make_multipart is original
+
+    def test_uninstall_safe_to_call_twice(self, _clean_request_field: None) -> None:
+        patcher = MultibyteFilenameSupport()
+        patcher.install()
+        patcher.uninstall()
+        patcher.uninstall()  # no-op, must not raise
+
+    def test_install_idempotent_on_same_instance(self, _clean_request_field: None) -> None:
+        """A second ``install()`` on the same instance must not capture
+        the already-patched function as the new ``_original`` — that
+        would make ``uninstall()`` restore the patch instead of the
+        true upstream function."""
+        original = RequestField.make_multipart
+        patcher = MultibyteFilenameSupport()
+        patcher.install()
+        first_patched = RequestField.make_multipart
+        patcher.install()
+        # Still the same patched function — no double-wrapping.
+        assert RequestField.make_multipart is first_patched
+        patcher.uninstall()
+        # And ``_original`` survived intact, so uninstall restored upstream.
+        assert RequestField.make_multipart is original
+
+    def test_default_behavior_unchanged_without_patch(self) -> None:
+        """Sanity check on the upstream baseline: a non-ASCII filename
+        only produces ``filename="<utf-8 chars>"`` (no ``filename*=``)
+        when the patch is NOT installed."""
+        disposition = _content_disposition("日本語.txt")
+        assert "filename*=" not in disposition
+
+    def test_ascii_filename_is_noop(self, _clean_request_field: None) -> None:
+        """ASCII filenames must pass through unchanged — no extra
+        ``filename*=`` parameter."""
+        with MultibyteFilenameSupport():
+            disposition = _content_disposition("ascii.txt")
+        assert 'filename="ascii.txt"' in disposition
+        assert "filename*=" not in disposition
+
+    def test_non_ascii_filename_adds_filename_star(self, _clean_request_field: None) -> None:
+        """Non-ASCII filenames get an additional RFC 5987
+        ``filename*=utf-8''<percent-encoded>`` parameter."""
+        with MultibyteFilenameSupport():
+            disposition = _content_disposition("日本語.txt")
+        # Original ``filename=`` is kept (servers that don't speak RFC
+        # 5987 fall back to it).
+        assert 'filename="日本語.txt"' in disposition
+        # Plus the encoded ``filename*=`` variant for servers that do.
+        assert "filename*=utf-8''%E6%97%A5%E6%9C%AC%E8%AA%9E.txt" in disposition
+
+    def test_no_filename_field_unaffected(self, _clean_request_field: None) -> None:
+        """Multipart fields without a filename (e.g. plain form data
+        like ``parent=<gid>``) must pass through unchanged."""
+        with MultibyteFilenameSupport():
+            field = RequestField("parent", b"12345")
+            field.make_multipart()
+        disposition = field.headers["Content-Disposition"]
+        assert disposition is not None
+        assert 'name="parent"' in disposition
+        assert "filename*=" not in disposition

{asana_api_cli-3.1.2 → asana_api_cli-3.1.3}/tests/test_session.py

@@ -1,5 +1,5 @@
 """Tests for asana_api_cli.session — the AsanaSession side-effect lifecycle,
-MultibyteFilenameSupport, the pagination knobs, the ``_CONFIG_KNOBS``
+the pagination knobs, the ``_CONFIG_KNOBS``
 Configuration table, and the ApiClient-instance settings (``--user-agent`` /
 ``--set-default-header``).
 
@@ -15,11 +15,9 @@ from collections.abc import Iterator
 from typing import Any
 
 import pytest
-from urllib3.fields import RequestField
 
 from asana_api_cli.session import (
     AsanaSession,
-    MultibyteFilenameSupport,
     runtime,
 )
 
@@ -155,112 +153,6 @@ class TestAsanaSessionSideEffectLifecycle:
         assert http.client.HTTPConnection.debuglevel == 0
 
 
-# ---------------------------------------------------------------------------
-# MultibyteFilenameSupport
-# ---------------------------------------------------------------------------
-
-
-@pytest.fixture
-def _clean_request_field() -> Iterator[None]:
-    """Snapshot and restore ``urllib3.fields.RequestField.make_multipart``."""
-    saved = RequestField.make_multipart
-    try:
-        yield
-    finally:
-        RequestField.make_multipart = saved  # pyright: ignore[reportAttributeAccessIssue]
-
-
-def _content_disposition(filename: str | None) -> str:
-    """Build a fresh ``RequestField`` and return its rendered
-    Content-Disposition after ``make_multipart``."""
-    field = RequestField("file", b"data", filename=filename)
-    field.make_multipart()
-    result = field.headers["Content-Disposition"]
-    assert result is not None  # set unconditionally by make_multipart
-    return result
-
-
-class TestMultibyteFilenameSupport:
-    """``MultibyteFilenameSupport`` augments ``RequestField.make_multipart``
-    so that multipart fields whose filename contains non-ASCII characters
-    also carry the RFC 5987 ``filename*=UTF-8''<percent-encoded>``
-    parameter. Off by default to preserve strict SDK parity; opt-in via
-    ``--multibyte-filenames``."""
-
-    def test_context_manager_installs_and_uninstalls(self, _clean_request_field: None) -> None:
-        original = RequestField.make_multipart
-        with MultibyteFilenameSupport():
-            assert RequestField.make_multipart is not original
-        assert RequestField.make_multipart is original
-
-    def test_explicit_install_uninstall(self, _clean_request_field: None) -> None:
-        original = RequestField.make_multipart
-        patcher = MultibyteFilenameSupport()
-        patcher.install()
-        assert RequestField.make_multipart is not original
-        patcher.uninstall()
-        assert RequestField.make_multipart is original
-
-    def test_uninstall_safe_to_call_twice(self, _clean_request_field: None) -> None:
-        patcher = MultibyteFilenameSupport()
-        patcher.install()
-        patcher.uninstall()
-        patcher.uninstall()  # no-op, must not raise
-
-    def test_install_idempotent_on_same_instance(self, _clean_request_field: None) -> None:
-        """A second ``install()`` on the same instance must not capture
-        the already-patched function as the new ``_original`` — that
-        would make ``uninstall()`` restore the patch instead of the
-        true upstream function."""
-        original = RequestField.make_multipart
-        patcher = MultibyteFilenameSupport()
-        patcher.install()
-        first_patched = RequestField.make_multipart
-        patcher.install()
-        # Still the same patched function — no double-wrapping.
-        assert RequestField.make_multipart is first_patched
-        patcher.uninstall()
-        # And ``_original`` survived intact, so uninstall restored upstream.
-        assert RequestField.make_multipart is original
-
-    def test_default_behavior_unchanged_without_patch(self) -> None:
-        """Sanity check on the upstream baseline: a non-ASCII filename
-        only produces ``filename="<utf-8 chars>"`` (no ``filename*=``)
-        when the patch is NOT installed."""
-        disposition = _content_disposition("日本語.txt")
-        assert "filename*=" not in disposition
-
-    def test_ascii_filename_is_noop(self, _clean_request_field: None) -> None:
-        """ASCII filenames must pass through unchanged — no extra
-        ``filename*=`` parameter."""
-        with MultibyteFilenameSupport():
-            disposition = _content_disposition("ascii.txt")
-        assert 'filename="ascii.txt"' in disposition
-        assert "filename*=" not in disposition
-
-    def test_non_ascii_filename_adds_filename_star(self, _clean_request_field: None) -> None:
-        """Non-ASCII filenames get an additional RFC 5987
-        ``filename*=utf-8''<percent-encoded>`` parameter."""
-        with MultibyteFilenameSupport():
-            disposition = _content_disposition("日本語.txt")
-        # Original ``filename=`` is kept (servers that don't speak RFC
-        # 5987 fall back to it).
-        assert 'filename="日本語.txt"' in disposition
-        # Plus the encoded ``filename*=`` variant for servers that do.
-        assert "filename*=utf-8''%E6%97%A5%E6%9C%AC%E8%AA%9E.txt" in disposition
-
-    def test_no_filename_field_unaffected(self, _clean_request_field: None) -> None:
-        """Multipart fields without a filename (e.g. plain form data
-        like ``parent=<gid>``) must pass through unchanged."""
-        with MultibyteFilenameSupport():
-            field = RequestField("parent", b"12345")
-            field.make_multipart()
-        disposition = field.headers["Content-Disposition"]
-        assert disposition is not None
-        assert 'name="parent"' in disposition
-        assert "filename*=" not in disposition
-
-
 # ---------------------------------------------------------------------------
 # AsanaSession pagination kwargs
 # ---------------------------------------------------------------------------