From 32d074dc9f978a4af7e8381a5273c5b561602a99 Mon Sep 17 00:00:00 2001 From: jackwener Date: Tue, 10 Mar 2026 20:48:42 +0800 Subject: [PATCH] feat: anti-detection hardening, transaction cache, article parsing, structured write output Anti-detection: - Add 6 sec-ch-ua-* Client Hints headers (arch, bitness, full-version, etc.) - POST requests now send Referer: x.com/compose/post + Priority: u=1, i - follow/unfollow REST adds include_profile_interstitial_type param Performance: - Transaction ID cache with 1h TTL (~/.twitter-cli/transaction_cache.json) - resolve_user_id: auto-detect screen_name vs numeric user_id Features: - Twitter Article parsing: extract long-form content as Markdown - Write operations emit structured JSON/YAML when piped or OUTPUT env set ActionResult: {success, action, id, url, ...} 84 tests passing --- README.md | 12 +- SKILL.md | 14 +- tests/conftest.py | 3 + tests/test_cli.py | 45 ++++- twitter_cli/cli.py | 355 +++++++++++++++++++++++------------ twitter_cli/client.py | 147 ++++++++++++++- twitter_cli/constants.py | 16 ++ twitter_cli/models.py | 2 + twitter_cli/output.py | 68 +++++++ twitter_cli/serialization.py | 16 ++ 10 files changed, 533 insertions(+), 145 deletions(-) create mode 100644 twitter_cli/output.py diff --git a/README.md b/README.md index c741894..27f0342 100644 --- a/README.md +++ b/README.md @@ -26,10 +26,10 @@ A terminal-first CLI for Twitter/X: read timelines, bookmarks, and user profiles - Tweet detail: view a tweet and its replies - List timeline: fetch tweets from a Twitter List - User lookup: fetch user profile, tweets, likes, followers, and following -- JSON output: export any data for scripting and AI agent integration +- Structured output: export any data as YAML or JSON for scripting and AI agent integration - Optional scoring filter: rank tweets by engagement weights -> **AI Agent Tip:** Always use `--json` for structured output instead of parsing the default rich-text display. Use `--max` to limit results. +> **AI Agent Tip:** Prefer `--yaml` for structured output unless a strict JSON parser is required. Non-TTY stdout defaults to YAML automatically. Use `--max` to limit results. **Write:** - Post: create new tweets and replies @@ -88,12 +88,12 @@ twitter feed --input tweets.json # Bookmarks twitter bookmarks -twitter bookmarks --max 30 --json +twitter bookmarks --max 30 --yaml # Search twitter search "Claude Code" twitter search "AI agent" -t Latest --max 50 -twitter search "机器学习" --json +twitter search "机器学习" --yaml twitter search "topic" -o results.json # Save to file twitter search "trending" --filter # Apply ranking filter @@ -294,9 +294,9 @@ After installation, OpenClaw can call `twitter-cli` commands directly. - 推文详情:查看推文及其回复 - 列表时间线:获取 Twitter List 的推文 - 用户查询:查看用户资料、推文、点赞、粉丝和关注 -- JSON 输出:便于脚本处理和 AI agent 集成 +- 结构化输出:支持 YAML 和 JSON,便于脚本处理和 AI agent 集成 -> **AI Agent 提示:** 需要结构化输出时始终使用 `--json`,不要解析默认的富文本显示。用 `--max` 控制返回数量。 +> **AI Agent 提示:** 需要结构化输出时优先使用 `--yaml`,除非下游必须是 JSON。stdout 不是 TTY 时默认输出 YAML。用 `--max` 控制返回数量。 **写入:** - 发推:发布新推文和回复 diff --git a/SKILL.md b/SKILL.md index c954b7a..50ae85f 100644 --- a/SKILL.md +++ b/SKILL.md @@ -33,7 +33,7 @@ uv tool install twitter-cli ### Step 0: Check if already authenticated ```bash -twitter whoami --json 2>/dev/null && echo "AUTH_OK" || echo "AUTH_NEEDED" +twitter status --yaml >/dev/null && echo "AUTH_OK" || echo "AUTH_NEEDED" ``` If `AUTH_OK`, skip to [Command Reference](#command-reference). @@ -97,9 +97,12 @@ twitter whoami twitter feed # Pretty table output ``` -### JSON: `--json` flag (agent-readable) +### YAML / JSON: structured output + +Non-TTY stdout defaults to YAML automatically. Use `OUTPUT=yaml|json|rich|auto` to override. ```bash +twitter feed --yaml twitter feed --json | jq '.[0].text' ``` @@ -121,7 +124,10 @@ twitter -c search "AI" --max 20 # ~80% fewer tokens than --json ### Read Operations ```bash +twitter status # Quick auth check +twitter status --yaml # Structured auth status twitter whoami # Current authenticated user +twitter whoami --yaml # YAML output twitter whoami --json # JSON output twitter user elonmusk # User profile twitter user elonmusk --json # JSON output @@ -129,10 +135,10 @@ twitter feed # Home timeline (For You) twitter feed -t following # Following timeline twitter feed --max 50 # Limit count twitter feed --filter # Enable ranking filter -twitter feed --json > tweets.json # Export as JSON +twitter feed --yaml > tweets.yaml # Export as YAML twitter feed --input tweets.json # Read from local JSON file twitter bookmarks # Bookmarked tweets -twitter bookmarks --max 30 --json +twitter bookmarks --max 30 --yaml twitter search "keyword" # Search tweets twitter search "AI agent" -t Latest --max 50 twitter search "topic" -o results.json # Save to file diff --git a/tests/conftest.py b/tests/conftest.py index cdb2594..0edb643 100644 --- a/tests/conftest.py +++ b/tests/conftest.py @@ -1,6 +1,7 @@ from __future__ import annotations import json +import os from pathlib import Path from typing import Any @@ -8,6 +9,8 @@ import pytest from twitter_cli.models import Author, Metrics, Tweet +os.environ.setdefault("OUTPUT", "rich") + @pytest.fixture() def tweet_factory(): diff --git a/tests/test_cli.py b/tests/test_cli.py index aa06654..c2ad51a 100644 --- a/tests/test_cli.py +++ b/tests/test_cli.py @@ -2,6 +2,7 @@ from __future__ import annotations from click.testing import CliRunner import pytest +import yaml from twitter_cli.cli import cli from twitter_cli.models import UserProfile @@ -108,6 +109,39 @@ def test_cli_whoami_command(monkeypatch) -> None: assert '"screenName": "testuser"' in result_json.output +def test_cli_whoami_auto_yaml(monkeypatch) -> None: + class FakeClient: + def fetch_me(self) -> UserProfile: + return UserProfile(id="42", name="Test User", screen_name="testuser") + + monkeypatch.setenv("OUTPUT", "auto") + monkeypatch.setattr("twitter_cli.cli._get_client", lambda config=None: FakeClient()) + runner = CliRunner() + + result = runner.invoke(cli, ["whoami"]) + + assert result.exit_code == 0 + payload = yaml.safe_load(result.output) + assert payload["screenName"] == "testuser" + + +def test_cli_status_auto_yaml(monkeypatch) -> None: + class FakeClient: + def fetch_me(self) -> UserProfile: + return UserProfile(id="42", name="Test User", screen_name="testuser") + + monkeypatch.setenv("OUTPUT", "auto") + monkeypatch.setattr("twitter_cli.cli._get_client", lambda config=None: FakeClient()) + runner = CliRunner() + + result = runner.invoke(cli, ["status"]) + + assert result.exit_code == 0 + payload = yaml.safe_load(result.output) + assert payload["authenticated"] is True + assert payload["user"]["screenName"] == "testuser" + + def test_cli_reply_command(monkeypatch) -> None: calls = [] @@ -143,12 +177,11 @@ def test_cli_quote_command(monkeypatch) -> None: def test_cli_follow_command(monkeypatch) -> None: - from twitter_cli.models import UserProfile actions = [] class FakeClient: - def fetch_user(self, screen_name: str) -> UserProfile: - return UserProfile(id="42", name="Alice", screen_name=screen_name) + def resolve_user_id(self, identifier: str) -> str: + return "42" def follow_user(self, user_id: str) -> bool: actions.append(("follow", user_id)) @@ -163,12 +196,11 @@ def test_cli_follow_command(monkeypatch) -> None: def test_cli_unfollow_command(monkeypatch) -> None: - from twitter_cli.models import UserProfile actions = [] class FakeClient: - def fetch_user(self, screen_name: str) -> UserProfile: - return UserProfile(id="42", name="Alice", screen_name=screen_name) + def resolve_user_id(self, identifier: str) -> str: + return "42" def unfollow_user(self, user_id: str) -> bool: actions.append(("unfollow", user_id)) @@ -193,4 +225,3 @@ def test_cli_compact_mode(tmp_path, tweet_factory) -> None: assert '"@alice"' in result.output # Compact output should NOT have full metrics keys assert '"metrics"' not in result.output - diff --git a/twitter_cli/cli.py b/twitter_cli/cli.py index 4757cbf..9bf2108 100644 --- a/twitter_cli/cli.py +++ b/twitter_cli/cli.py @@ -27,7 +27,6 @@ Write commands: from __future__ import annotations -import json import logging import re import sys @@ -50,12 +49,14 @@ from .formatter import ( print_user_profile, print_user_table, ) +from .output import default_structured_format, emit_structured, structured_output_options, use_rich_output from .serialization import ( tweets_from_json, + tweets_to_data, tweets_to_compact_json, tweets_to_json, user_profile_to_dict, - users_to_json, + users_to_data, ) @@ -88,10 +89,11 @@ def _load_tweets_from_json(path): raise RuntimeError("Invalid tweet JSON file %s: %s" % (path, exc)) -def _get_client(config=None): - # type: (Optional[Dict[str, Any]]) -> TwitterClient +def _get_client(config=None, quiet=False): + # type: (Optional[Dict[str, Any]], bool) -> TwitterClient """Create an authenticated API client.""" - console.print("\n🔐 Getting Twitter cookies...") + if not quiet: + console.print("\n🔐 Getting Twitter cookies...") cookies = get_cookies() rate_limit_config = (config or {}).get("rateLimit") return TwitterClient( @@ -102,6 +104,15 @@ def _get_client(config=None): ) +def _get_client_for_output(config=None, quiet=False): + # type: (Optional[Dict[str, Any]], bool) -> TwitterClient + """Call _get_client while staying compatible with monkeypatched legacy signatures.""" + try: + return _get_client(config, quiet=quiet) + except TypeError: + return _get_client(config) + + def _exit_with_error(exc): # type: (RuntimeError) -> None console.print("[red]❌ %s[/red]" % exc) @@ -155,16 +166,17 @@ def _normalize_tweet_id(value): return candidate -def _apply_filter(tweets, do_filter, config): - # type: (List[Tweet], bool, dict) -> List[Tweet] +def _apply_filter(tweets, do_filter, config, rich_output=True): + # type: (List[Tweet], bool, dict, bool) -> List[Tweet] """Optionally apply tweet filtering.""" if not do_filter: return tweets filter_config = config.get("filter", {}) original_count = len(tweets) filtered = filter_tweets(tweets, filter_config) - print_filter_stats(original_count, filtered, console) - console.print() + if rich_output: + print_filter_stats(original_count, filtered, console) + console.print() return filtered @@ -181,41 +193,44 @@ def cli(ctx, verbose, compact): ctx.obj["compact"] = compact -def _fetch_and_display(fetch_fn, label, emoji, max_count, as_json, output_file, do_filter, config=None, compact=False): - # type: (Any, str, str, Optional[int], bool, Optional[str], bool, Optional[dict], bool) -> None +def _fetch_and_display(fetch_fn, label, emoji, max_count, as_json, as_yaml, output_file, do_filter, config=None, compact=False): + # type: (Any, str, str, Optional[int], bool, bool, Optional[str], bool, Optional[dict], bool) -> None """Common fetch-filter-display logic for timeline-like commands.""" if config is None: config = load_config() + rich_output = use_rich_output(as_json=as_json, as_yaml=as_yaml, compact=compact) try: fetch_count = _resolve_configured_count(config, max_count) - console.print("%s Fetching %s (%d tweets)...\n" % (emoji, label, fetch_count)) + if rich_output: + console.print("%s Fetching %s (%d tweets)...\n" % (emoji, label, fetch_count)) start = time.time() tweets = fetch_fn(fetch_count) elapsed = time.time() - start - console.print("✅ Fetched %d %s in %.1fs\n" % (len(tweets), label, elapsed)) + if rich_output: + console.print("✅ Fetched %d %s in %.1fs\n" % (len(tweets), label, elapsed)) except RuntimeError as exc: _exit_with_error(exc) - filtered = _apply_filter(tweets, do_filter, config) + filtered = _apply_filter(tweets, do_filter, config, rich_output=rich_output) if output_file: Path(output_file).write_text(tweets_to_json(filtered), encoding="utf-8") - console.print("💾 Saved to %s\n" % output_file) + if rich_output: + console.print("💾 Saved to %s\n" % output_file) if compact: click.echo(tweets_to_compact_json(filtered)) return - if as_json: - click.echo(tweets_to_json(filtered)) + if emit_structured(tweets_to_data(filtered), as_json=as_json, as_yaml=as_yaml): return print_tweet_table(filtered, console, title="%s %s — %d tweets" % (emoji, label, len(filtered))) console.print() -def _run_bookmarks_command(max_count, as_json, output_file, do_filter, compact=False): - # type: (Optional[int], bool, Optional[str], bool, bool) -> None +def _run_bookmarks_command(max_count, as_json, as_yaml, output_file, do_filter, compact=False): + # type: (Optional[int], bool, bool, Optional[str], bool, bool) -> None config = load_config() def _run(): @@ -226,6 +241,7 @@ def _run_bookmarks_command(max_count, as_json, output_file, do_filter, compact=F "🔖", max_count, as_json, + as_yaml, output_file, do_filter, config, @@ -245,48 +261,53 @@ def _run_bookmarks_command(max_count, as_json, output_file, do_filter, compact=F help="Feed type: for-you (algorithmic) or following (chronological).", ) @click.option("--max", "-n", "max_count", type=int, default=None, help="Max number of tweets to fetch.") -@click.option("--json", "as_json", is_flag=True, help="Output as JSON.") +@structured_output_options @click.option("--input", "-i", "input_file", type=str, default=None, help="Load tweets from JSON file.") @click.option("--output", "-o", "output_file", type=str, default=None, help="Save filtered tweets to JSON file.") @click.option("--filter", "do_filter", is_flag=True, help="Enable score-based filtering.") @click.pass_context -def feed(ctx, feed_type, max_count, as_json, input_file, output_file, do_filter): - # type: (Any, str, Optional[int], bool, Optional[str], Optional[str], bool) -> None +def feed(ctx, feed_type, max_count, as_json, as_yaml, input_file, output_file, do_filter): + # type: (Any, str, Optional[int], bool, bool, Optional[str], Optional[str], bool) -> None """Fetch home timeline with optional filtering.""" compact = ctx.obj.get("compact", False) + rich_output = use_rich_output(as_json=as_json, as_yaml=as_yaml, compact=compact) config = load_config() try: if input_file: - console.print("📂 Loading tweets from %s..." % input_file) + if rich_output: + console.print("📂 Loading tweets from %s..." % input_file) tweets = _load_tweets_from_json(input_file) - console.print(" Loaded %d tweets" % len(tweets)) + if rich_output: + console.print(" Loaded %d tweets" % len(tweets)) else: fetch_count = _resolve_configured_count(config, max_count) - client = _get_client(config) + client = _get_client_for_output(config, quiet=not rich_output) label = "following feed" if feed_type == "following" else "home timeline" - console.print("📡 Fetching %s (%d tweets)...\n" % (label, fetch_count)) + if rich_output: + console.print("📡 Fetching %s (%d tweets)...\n" % (label, fetch_count)) start = time.time() if feed_type == "following": tweets = client.fetch_following_feed(fetch_count) else: tweets = client.fetch_home_timeline(fetch_count) elapsed = time.time() - start - console.print("✅ Fetched %d tweets in %.1fs\n" % (len(tweets), elapsed)) + if rich_output: + console.print("✅ Fetched %d tweets in %.1fs\n" % (len(tweets), elapsed)) except RuntimeError as exc: _exit_with_error(exc) - filtered = _apply_filter(tweets, do_filter, config) + filtered = _apply_filter(tweets, do_filter, config, rich_output=rich_output) if output_file: Path(output_file).write_text(tweets_to_json(filtered), encoding="utf-8") - console.print("💾 Saved filtered tweets to %s\n" % output_file) + if rich_output: + console.print("💾 Saved filtered tweets to %s\n" % output_file) if compact: click.echo(tweets_to_compact_json(filtered)) return - if as_json: - click.echo(tweets_to_json(filtered)) + if emit_structured(tweets_to_data(filtered), as_json=as_json, as_yaml=as_yaml): return title = "👥 Following" if feed_type == "following" else "📱 Twitter" @@ -297,46 +318,46 @@ def feed(ctx, feed_type, max_count, as_json, input_file, output_file, do_filter) @cli.command() @click.option("--max", "-n", "max_count", type=int, default=None, help="Max number of tweets to fetch.") -@click.option("--json", "as_json", is_flag=True, help="Output as JSON.") +@structured_output_options @click.option("--output", "-o", "output_file", type=str, default=None, help="Save tweets to JSON file.") @click.option("--filter", "do_filter", is_flag=True, help="Enable score-based filtering.") @click.pass_context -def favorites(ctx, max_count, as_json, output_file, do_filter): - # type: (Any, Optional[int], bool, Optional[str], bool) -> None +def favorites(ctx, max_count, as_json, as_yaml, output_file, do_filter): + # type: (Any, Optional[int], bool, bool, Optional[str], bool) -> None """Fetch bookmarked (favorite) tweets.""" - _run_bookmarks_command(max_count, as_json, output_file, do_filter, compact=ctx.obj.get("compact", False)) + _run_bookmarks_command(max_count, as_json, as_yaml, output_file, do_filter, compact=ctx.obj.get("compact", False)) @cli.command(name="bookmarks") @click.option("--max", "-n", "max_count", type=int, default=None, help="Max number of tweets to fetch.") -@click.option("--json", "as_json", is_flag=True, help="Output as JSON.") +@structured_output_options @click.option("--output", "-o", "output_file", type=str, default=None, help="Save tweets to JSON file.") @click.option("--filter", "do_filter", is_flag=True, help="Enable score-based filtering.") @click.pass_context -def bookmarks(ctx, max_count, as_json, output_file, do_filter): - # type: (Any, Optional[int], bool, Optional[str], bool) -> None +def bookmarks(ctx, max_count, as_json, as_yaml, output_file, do_filter): + # type: (Any, Optional[int], bool, bool, Optional[str], bool) -> None """Fetch bookmarked tweets.""" - _run_bookmarks_command(max_count, as_json, output_file, do_filter, compact=ctx.obj.get("compact", False)) + _run_bookmarks_command(max_count, as_json, as_yaml, output_file, do_filter, compact=ctx.obj.get("compact", False)) @cli.command() @click.argument("screen_name") -@click.option("--json", "as_json", is_flag=True, help="Output as JSON.") -def user(screen_name, as_json): - # type: (str, bool) -> None +@structured_output_options +def user(screen_name, as_json, as_yaml): + # type: (str, bool, bool) -> None """View a user's profile. SCREEN_NAME is the @handle (without @).""" screen_name = screen_name.lstrip("@") config = load_config() try: - client = _get_client(config) - console.print("👤 Fetching user @%s..." % screen_name) + rich_output = use_rich_output(as_json=as_json, as_yaml=as_yaml) + client = _get_client_for_output(config, quiet=not rich_output) + if rich_output: + console.print("👤 Fetching user @%s..." % screen_name) profile = client.fetch_user(screen_name) except RuntimeError as exc: _exit_with_error(exc) - if as_json: - click.echo(json.dumps(user_profile_to_dict(profile), ensure_ascii=False, indent=2)) - else: + if not emit_structured(user_profile_to_dict(profile), as_json=as_json, as_yaml=as_yaml): console.print() print_user_profile(profile, console) @@ -344,22 +365,24 @@ def user(screen_name, as_json): @cli.command("user-posts") @click.argument("screen_name") @click.option("--max", "-n", "max_count", type=int, default=None, help="Max number of tweets to fetch.") -@click.option("--json", "as_json", is_flag=True, help="Output as JSON.") +@structured_output_options @click.option("--output", "-o", "output_file", type=str, default=None, help="Save tweets to JSON file.") @click.pass_context -def user_posts(ctx, screen_name, max_count, as_json, output_file): - # type: (Any, str, int, bool, Optional[str]) -> None +def user_posts(ctx, screen_name, max_count, as_json, as_yaml, output_file): + # type: (Any, str, int, bool, bool, Optional[str]) -> None """List a user's tweets. SCREEN_NAME is the @handle (without @).""" screen_name = screen_name.lstrip("@") compact = ctx.obj.get("compact", False) config = load_config() def _run(): - client = _get_client(config) - console.print("👤 Fetching @%s's profile..." % screen_name) + rich_output = use_rich_output(as_json=as_json, as_yaml=as_yaml, compact=compact) + client = _get_client_for_output(config, quiet=not rich_output) + if rich_output: + console.print("👤 Fetching @%s's profile..." % screen_name) profile = client.fetch_user(screen_name) _fetch_and_display( lambda count: client.fetch_user_tweets(profile.id, count), - "@%s tweets" % screen_name, "📝", max_count, as_json, output_file, False, config, + "@%s tweets" % screen_name, "📝", max_count, as_json, as_yaml, output_file, False, config, compact=compact, ) _run_guarded(_run) @@ -376,20 +399,21 @@ def user_posts(ctx, screen_name, max_count, as_json, output_file): help="Search tab: Top, Latest, Photos, or Videos.", ) @click.option("--max", "-n", "max_count", type=int, default=None, help="Max number of tweets to fetch.") -@click.option("--json", "as_json", is_flag=True, help="Output as JSON.") +@structured_output_options @click.option("--output", "-o", "output_file", type=str, default=None, help="Save tweets to JSON file.") @click.option("--filter", "do_filter", is_flag=True, help="Enable score-based filtering.") @click.pass_context -def search(ctx, query, product, max_count, as_json, output_file, do_filter): - # type: (Any, str, str, int, bool, Optional[str], bool) -> None +def search(ctx, query, product, max_count, as_json, as_yaml, output_file, do_filter): + # type: (Any, str, str, int, bool, bool, Optional[str], bool) -> None """Search tweets by QUERY string.""" compact = ctx.obj.get("compact", False) config = load_config() def _run(): - client = _get_client(config) + rich_output = use_rich_output(as_json=as_json, as_yaml=as_yaml, compact=compact) + client = _get_client_for_output(config, quiet=not rich_output) _fetch_and_display( lambda count: client.fetch_search(query, count, product), - "'%s' (%s)" % (query, product), "🔍", max_count, as_json, output_file, do_filter, config, + "'%s' (%s)" % (query, product), "🔍", max_count, as_json, as_yaml, output_file, do_filter, config, compact=compact, ) _run_guarded(_run) @@ -398,23 +422,25 @@ def search(ctx, query, product, max_count, as_json, output_file, do_filter): @cli.command() @click.argument("screen_name") @click.option("--max", "-n", "max_count", type=int, default=None, help="Max number of tweets to fetch.") -@click.option("--json", "as_json", is_flag=True, help="Output as JSON.") +@structured_output_options @click.option("--output", "-o", "output_file", type=str, default=None, help="Save tweets to JSON file.") @click.option("--filter", "do_filter", is_flag=True, help="Enable score-based filtering.") @click.pass_context -def likes(ctx, screen_name, max_count, as_json, output_file, do_filter): - # type: (Any, str, int, bool, Optional[str], bool) -> None +def likes(ctx, screen_name, max_count, as_json, as_yaml, output_file, do_filter): + # type: (Any, str, int, bool, bool, Optional[str], bool) -> None """Show tweets liked by a user. SCREEN_NAME is the @handle (without @).""" screen_name = screen_name.lstrip("@") compact = ctx.obj.get("compact", False) config = load_config() def _run(): - client = _get_client(config) - console.print("👤 Fetching @%s's profile..." % screen_name) + rich_output = use_rich_output(as_json=as_json, as_yaml=as_yaml, compact=compact) + client = _get_client_for_output(config, quiet=not rich_output) + if rich_output: + console.print("👤 Fetching @%s's profile..." % screen_name) profile = client.fetch_user(screen_name) _fetch_and_display( lambda count: client.fetch_user_likes(profile.id, count), - "@%s likes" % screen_name, "❤️", max_count, as_json, output_file, do_filter, config, + "@%s likes" % screen_name, "❤️", max_count, as_json, as_yaml, output_file, do_filter, config, compact=compact, ) _run_guarded(_run) @@ -423,21 +449,24 @@ def likes(ctx, screen_name, max_count, as_json, output_file, do_filter): @cli.command() @click.argument("tweet_id") @click.option("--max", "-n", "max_count", type=int, default=None, help="Max replies to fetch.") -@click.option("--json", "as_json", is_flag=True, help="Output as JSON.") +@structured_output_options @click.pass_context -def tweet(ctx, tweet_id, max_count, as_json): - # type: (Any, str, int, bool) -> None +def tweet(ctx, tweet_id, max_count, as_json, as_yaml): + # type: (Any, str, int, bool, bool) -> None """View a tweet and its replies. TWEET_ID is the numeric tweet ID or full URL.""" compact = ctx.obj.get("compact", False) tweet_id = _normalize_tweet_id(tweet_id) config = load_config() + rich_output = use_rich_output(as_json=as_json, as_yaml=as_yaml, compact=compact) try: - client = _get_client(config) - console.print("🐦 Fetching tweet %s...\n" % tweet_id) + client = _get_client_for_output(config, quiet=not rich_output) + if rich_output: + console.print("🐦 Fetching tweet %s...\n" % tweet_id) start = time.time() tweets = client.fetch_tweet_detail(tweet_id, _resolve_configured_count(config, max_count)) elapsed = time.time() - start - console.print("✅ Fetched %d tweets in %.1fs\n" % (len(tweets), elapsed)) + if rich_output: + console.print("✅ Fetched %d tweets in %.1fs\n" % (len(tweets), elapsed)) except RuntimeError as exc: _exit_with_error(exc) @@ -445,8 +474,7 @@ def tweet(ctx, tweet_id, max_count, as_json): click.echo(tweets_to_compact_json(tweets)) return - if as_json: - click.echo(tweets_to_json(tweets)) + if emit_structured(tweets_to_data(tweets), as_json=as_json, as_yaml=as_yaml): return if tweets: @@ -460,11 +488,11 @@ def tweet(ctx, tweet_id, max_count, as_json): @cli.command(name="list") @click.argument("list_id") @click.option("--max", "-n", "max_count", type=int, default=None, help="Max tweets to fetch.") -@click.option("--json", "as_json", is_flag=True, help="Output as JSON.") +@structured_output_options @click.option("--filter", "do_filter", is_flag=True, help="Enable score-based filtering.") @click.pass_context -def list_timeline(ctx, list_id, max_count, as_json, do_filter): - # type: (Any, str, int, bool, bool) -> None +def list_timeline(ctx, list_id, max_count, as_json, as_yaml, do_filter): + # type: (Any, str, int, bool, bool, bool) -> None """Fetch tweets from a Twitter List. LIST_ID is the numeric list ID.""" compact = ctx.obj.get("compact", False) config = load_config() @@ -472,7 +500,7 @@ def list_timeline(ctx, list_id, max_count, as_json, do_filter): client = _get_client(config) _fetch_and_display( lambda count: client.fetch_list_timeline(list_id, count), - "list %s" % list_id, "📋", max_count, as_json, None, do_filter, config, + "list %s" % list_id, "📋", max_count, as_json, as_yaml, None, do_filter, config, compact=compact, ) _run_guarded(_run) @@ -481,27 +509,30 @@ def list_timeline(ctx, list_id, max_count, as_json, do_filter): @cli.command() @click.argument("screen_name") @click.option("--max", "-n", "max_count", type=int, default=None, help="Max users to fetch.") -@click.option("--json", "as_json", is_flag=True, help="Output as JSON.") -def followers(screen_name, max_count, as_json): - # type: (str, int, bool) -> None +@structured_output_options +def followers(screen_name, max_count, as_json, as_yaml): + # type: (str, int, bool, bool) -> None """List followers of a user. SCREEN_NAME is the @handle (without @).""" screen_name = screen_name.lstrip("@") config = load_config() try: - client = _get_client(config) - console.print("👤 Fetching @%s's profile..." % screen_name) + rich_output = use_rich_output(as_json=as_json, as_yaml=as_yaml) + client = _get_client_for_output(config, quiet=not rich_output) + if rich_output: + console.print("👤 Fetching @%s's profile..." % screen_name) profile = client.fetch_user(screen_name) fetch_count = _resolve_configured_count(config, max_count) - console.print("👥 Fetching followers (%d)...\n" % fetch_count) + if rich_output: + console.print("👥 Fetching followers (%d)...\n" % fetch_count) start = time.time() users = client.fetch_followers(profile.id, fetch_count) elapsed = time.time() - start - console.print("✅ Fetched %d followers in %.1fs\n" % (len(users), elapsed)) + if rich_output: + console.print("✅ Fetched %d followers in %.1fs\n" % (len(users), elapsed)) except RuntimeError as exc: _exit_with_error(exc) - if as_json: - click.echo(users_to_json(users)) + if emit_structured(users_to_data(users), as_json=as_json, as_yaml=as_yaml): return print_user_table(users, console, title="👥 @%s followers — %d" % (screen_name, len(users))) @@ -511,27 +542,30 @@ def followers(screen_name, max_count, as_json): @cli.command() @click.argument("screen_name") @click.option("--max", "-n", "max_count", type=int, default=None, help="Max users to fetch.") -@click.option("--json", "as_json", is_flag=True, help="Output as JSON.") -def following(screen_name, max_count, as_json): - # type: (str, int, bool) -> None +@structured_output_options +def following(screen_name, max_count, as_json, as_yaml): + # type: (str, int, bool, bool) -> None """List accounts a user is following. SCREEN_NAME is the @handle (without @).""" screen_name = screen_name.lstrip("@") config = load_config() try: - client = _get_client(config) - console.print("👤 Fetching @%s's profile..." % screen_name) + rich_output = use_rich_output(as_json=as_json, as_yaml=as_yaml) + client = _get_client_for_output(config, quiet=not rich_output) + if rich_output: + console.print("👤 Fetching @%s's profile..." % screen_name) profile = client.fetch_user(screen_name) fetch_count = _resolve_configured_count(config, max_count) - console.print("👥 Fetching following (%d)...\n" % fetch_count) + if rich_output: + console.print("👥 Fetching following (%d)...\n" % fetch_count) start = time.time() users = client.fetch_following(profile.id, fetch_count) elapsed = time.time() - start - console.print("✅ Fetched %d following in %.1fs\n" % (len(users), elapsed)) + if rich_output: + console.print("✅ Fetched %d following in %.1fs\n" % (len(users), elapsed)) except RuntimeError as exc: _exit_with_error(exc) - if as_json: - click.echo(users_to_json(users)) + if emit_structured(users_to_data(users), as_json=as_json, as_yaml=as_yaml): return print_user_table(users, console, title="👥 @%s following — %d" % (screen_name, len(users))) @@ -542,14 +576,28 @@ def following(screen_name, max_count, as_json): def _write_action(emoji, action_desc, client_method, tweet_id): # type: (str, str, str, str) -> None - """Generic write action helper to reduce CLI command boilerplate.""" + """Generic write action helper to reduce CLI command boilerplate. + + Emits structured JSON/YAML when piped or when OUTPUT env is set. + """ try: config = load_config() client = _get_client(config) - console.print("%s %s %s..." % (emoji, action_desc, tweet_id)) + structured = default_structured_format(as_json=False, as_yaml=False) + if not structured: + console.print("%s %s %s..." % (emoji, action_desc, tweet_id)) getattr(client, client_method)(tweet_id) - console.print("[green]✅ Done.[/green]") + result = {"success": True, "action": action_desc.lower().replace(" ", "_"), "id": tweet_id} + if structured: + emit_structured(result, as_json=(structured == "json"), as_yaml=(structured == "yaml")) + else: + console.print("[green]✅ Done.[/green]") except RuntimeError as exc: + result = {"success": False, "action": action_desc.lower().replace(" ", "_"), "id": tweet_id, "error": str(exc)} + structured = default_structured_format(as_json=False, as_yaml=False) + if structured: + emit_structured(result, as_json=(structured == "json"), as_yaml=(structured == "yaml")) + sys.exit(1) _exit_with_error(exc) @@ -562,11 +610,17 @@ def post(text, reply_to): config = load_config() try: client = _get_client(config) - action = "Replying to %s" % reply_to if reply_to else "Posting tweet" - console.print("✏️ %s..." % action) + structured = default_structured_format(as_json=False, as_yaml=False) + if not structured: + action = "Replying to %s" % reply_to if reply_to else "Posting tweet" + console.print("✏️ %s..." % action) tweet_id = client.create_tweet(text, reply_to_id=reply_to) - console.print("[green]✅ Tweet posted![/green]") - console.print("🔗 https://x.com/i/status/%s" % tweet_id) + result = {"success": True, "action": "post", "id": tweet_id, "url": "https://x.com/i/status/%s" % tweet_id} + if structured: + emit_structured(result, as_json=(structured == "json"), as_yaml=(structured == "yaml")) + else: + console.print("[green]✅ Tweet posted![/green]") + console.print("🔗 https://x.com/i/status/%s" % tweet_id) except RuntimeError as exc: _exit_with_error(exc) @@ -581,10 +635,16 @@ def reply_tweet(tweet_id, text): config = load_config() try: client = _get_client(config) - console.print("💬 Replying to %s..." % tweet_id) + structured = default_structured_format(as_json=False, as_yaml=False) + if not structured: + console.print("💬 Replying to %s..." % tweet_id) new_id = client.create_tweet(text, reply_to_id=tweet_id) - console.print("[green]✅ Reply posted![/green]") - console.print("🔗 https://x.com/i/status/%s" % new_id) + result = {"success": True, "action": "reply", "id": new_id, "replyTo": tweet_id, "url": "https://x.com/i/status/%s" % new_id} + if structured: + emit_structured(result, as_json=(structured == "json"), as_yaml=(structured == "yaml")) + else: + console.print("[green]✅ Reply posted![/green]") + console.print("🔗 https://x.com/i/status/%s" % new_id) except RuntimeError as exc: _exit_with_error(exc) @@ -599,30 +659,61 @@ def quote_tweet(tweet_id, text): config = load_config() try: client = _get_client(config) - console.print("🔄 Quoting tweet %s..." % tweet_id) + structured = default_structured_format(as_json=False, as_yaml=False) + if not structured: + console.print("🔄 Quoting tweet %s..." % tweet_id) new_id = client.quote_tweet(tweet_id, text) - console.print("[green]✅ Quote tweet posted![/green]") - console.print("🔗 https://x.com/i/status/%s" % new_id) + result = {"success": True, "action": "quote", "id": new_id, "quotedId": tweet_id, "url": "https://x.com/i/status/%s" % new_id} + if structured: + emit_structured(result, as_json=(structured == "json"), as_yaml=(structured == "yaml")) + else: + console.print("[green]✅ Quote tweet posted![/green]") + console.print("🔗 https://x.com/i/status/%s" % new_id) except RuntimeError as exc: _exit_with_error(exc) +@cli.command(name="status") +@structured_output_options +def status(as_json, as_yaml): + # type: (bool, bool) -> None + """Check whether the current Twitter/X session is authenticated.""" + config = load_config() + try: + rich_output = use_rich_output(as_json=as_json, as_yaml=as_yaml) + client = _get_client_for_output(config, quiet=not rich_output) + profile = client.fetch_me() + except RuntimeError as exc: + payload = {"authenticated": False, "error": str(exc)} + if emit_structured(payload, as_json=as_json, as_yaml=as_yaml): + sys.exit(1) + _exit_with_error(exc) + return + + payload = {"authenticated": True, "user": user_profile_to_dict(profile)} + if emit_structured(payload, as_json=as_json, as_yaml=as_yaml): + return + + console.print("[green]✅ Authenticated.[/green]") + console.print("👤 @%s" % profile.screen_name) + + @cli.command(name="whoami") -@click.option("--json", "as_json", is_flag=True, help="Output as JSON.") -def whoami(as_json): - # type: (bool,) -> None +@structured_output_options +def whoami(as_json, as_yaml): + # type: (bool, bool) -> None """Show the currently authenticated user's profile.""" config = load_config() try: - client = _get_client(config) - console.print("👤 Fetching current user...") + rich_output = use_rich_output(as_json=as_json, as_yaml=as_yaml) + client = _get_client_for_output(config, quiet=not rich_output) + if rich_output: + console.print("👤 Fetching current user...") profile = client.fetch_me() except RuntimeError as exc: _exit_with_error(exc) - if as_json: - click.echo(json.dumps(user_profile_to_dict(profile), ensure_ascii=False, indent=2)) - else: + if not emit_structured(user_profile_to_dict(profile), as_json=as_json, as_yaml=as_yaml): console.print() print_user_profile(profile, console) @@ -636,11 +727,18 @@ def follow_user(screen_name): config = load_config() try: client = _get_client(config) - console.print("👤 Looking up @%s..." % screen_name) - profile = client.fetch_user(screen_name) - console.print("➕ Following @%s..." % screen_name) - client.follow_user(profile.id) - console.print("[green]✅ Now following @%s[/green]" % screen_name) + structured = default_structured_format(as_json=False, as_yaml=False) + if not structured: + console.print("👤 Looking up @%s..." % screen_name) + user_id = client.resolve_user_id(screen_name) + if not structured: + console.print("➕ Following @%s..." % screen_name) + client.follow_user(user_id) + result = {"success": True, "action": "follow", "screenName": screen_name, "userId": user_id} + if structured: + emit_structured(result, as_json=(structured == "json"), as_yaml=(structured == "yaml")) + else: + console.print("[green]✅ Now following @%s[/green]" % screen_name) except RuntimeError as exc: _exit_with_error(exc) @@ -654,11 +752,18 @@ def unfollow_user(screen_name): config = load_config() try: client = _get_client(config) - console.print("👤 Looking up @%s..." % screen_name) - profile = client.fetch_user(screen_name) - console.print("➖ Unfollowing @%s..." % screen_name) - client.unfollow_user(profile.id) - console.print("[green]✅ Unfollowed @%s[/green]" % screen_name) + structured = default_structured_format(as_json=False, as_yaml=False) + if not structured: + console.print("👤 Looking up @%s..." % screen_name) + user_id = client.resolve_user_id(screen_name) + if not structured: + console.print("➖ Unfollowing @%s..." % screen_name) + client.unfollow_user(user_id) + result = {"success": True, "action": "unfollow", "screenName": screen_name, "userId": user_id} + if structured: + emit_structured(result, as_json=(structured == "json"), as_yaml=(structured == "yaml")) + else: + console.print("[green]✅ Unfollowed @%s[/green]" % screen_name) except RuntimeError as exc: _exit_with_error(exc) diff --git a/twitter_cli/client.py b/twitter_cli/client.py index 9c4d7c6..4b96245 100644 --- a/twitter_cli/client.py +++ b/twitter_cli/client.py @@ -17,9 +17,15 @@ from x_client_transaction.utils import generate_headers as _gen_ct_headers, get_ from .constants import ( BEARER_TOKEN, + SEC_CH_UA_ARCH, + SEC_CH_UA_BITNESS, SEC_CH_UA_MOBILE, + SEC_CH_UA_MODEL, + SEC_CH_UA_PLATFORM_VERSION, get_accept_language, get_sec_ch_ua, + get_sec_ch_ua_full_version, + get_sec_ch_ua_full_version_list, get_sec_ch_ua_platform, get_twitter_client_language, get_user_agent, @@ -342,6 +348,17 @@ class TwitterClient: return self._fetch_timeline("Bookmarks", count, get_instructions) + def resolve_user_id(self, identifier): + # type: (str) -> str + """Resolve a user identifier (screen_name or numeric user_id) to numeric user_id. + + If identifier is all digits, returns it as-is. Otherwise fetches the user profile. + """ + if identifier.isdigit(): + return identifier + profile = self.fetch_user(identifier) + return profile.id + def fetch_user(self, screen_name): # type: (str) -> UserProfile """Fetch user profile by screen name.""" @@ -621,7 +638,7 @@ class TwitterClient: # type: (str) -> bool """Follow a user by user ID. Returns True on success.""" url = "https://x.com/i/api/1.1/friendships/create.json" - body = {"user_id": user_id} + body = {"user_id": user_id, "include_profile_interstitial_type": "1"} headers = self._build_headers(url=url, method="POST") headers["Content-Type"] = "application/x-www-form-urlencoded" session = _get_cffi_session() @@ -635,7 +652,7 @@ class TwitterClient: # type: (str) -> bool """Unfollow a user by user ID. Returns True on success.""" url = "https://x.com/i/api/1.1/friendships/destroy.json" - body = {"user_id": user_id} + body = {"user_id": user_id, "include_profile_interstitial_type": "1"} headers = self._build_headers(url=url, method="POST") headers["Content-Type"] = "application/x-www-form-urlencoded" session = _get_cffi_session() @@ -727,15 +744,74 @@ class TwitterClient: return self._api_get(retry_url) raise RuntimeError(str(exc)) + @staticmethod + def _ct_cache_path(): + # type: () -> str + """Return path for transaction cache file.""" + home = os.path.expanduser("~") + return os.path.join(home, ".twitter-cli", "transaction_cache.json") + + def _load_ct_cache(self): + # type: () -> bool + """Try to load ClientTransaction from cache. Returns True on success.""" + try: + cache_path = self._ct_cache_path() + if not os.path.exists(cache_path): + return False + with open(cache_path, "r", encoding="utf-8") as f: + cache = json.load(f) + # Check TTL (1 hour) + if time.time() - cache.get("created_at", 0) > 3600: + return False + home_html = cache.get("home_html", "") + ondemand_text = cache.get("ondemand_text", "") + if not home_html or not ondemand_text: + return False + home_page_response = bs4.BeautifulSoup(home_html, "html.parser") + self._client_transaction = ClientTransaction( + home_page_response=home_page_response, + ondemand_file_response=ondemand_text, + ) + _update_features_from_html(home_html) + logger.info("ClientTransaction loaded from cache") + return True + except Exception as exc: + logger.debug("Failed to load CT cache: %s", exc) + return False + + def _save_ct_cache(self, home_html, ondemand_text): + # type: (str, str) -> None + """Save transaction data to cache file.""" + try: + cache_path = self._ct_cache_path() + cache_dir = os.path.dirname(cache_path) + os.makedirs(cache_dir, exist_ok=True) + cache = { + "home_html": home_html, + "ondemand_text": ondemand_text, + "created_at": time.time(), + } + with open(cache_path, "w", encoding="utf-8") as f: + json.dump(cache, f) + logger.debug("Saved CT cache to %s", cache_path) + except Exception as exc: + logger.debug("Failed to save CT cache: %s", exc) + def _ensure_client_transaction(self): # type: () -> None """Initialize ClientTransaction for x-client-transaction-id header. + Tries cache first (1h TTL), then fetches fresh data from x.com. Also attempts to extract live feature flags from JS bundles. """ if self._ct_init_attempted: return self._ct_init_attempted = True + + # Try loading from cache first + if self._load_ct_cache(): + return + try: # Use curl_cffi for ClientTransaction init to maintain consistent # Chrome TLS fingerprint. Using Python requests here would leak @@ -758,6 +834,9 @@ class TwitterClient: # Try to extract live FEATURES from the homepage JS bundles _update_features_from_html(home_page.text) + + # Save to cache for future use + self._save_ct_cache(home_page.text, ondemand_file.text) except Exception as exc: logger.warning("Failed to init ClientTransaction: %s", exc) @@ -773,18 +852,26 @@ class TwitterClient: "X-Twitter-Client-Language": get_twitter_client_language(), "User-Agent": get_user_agent(), "Origin": "https://x.com", - "Referer": "https://x.com", + "Referer": "https://x.com/", "Accept": "*/*", "Accept-Language": get_accept_language(), "sec-ch-ua": get_sec_ch_ua(), "sec-ch-ua-mobile": SEC_CH_UA_MOBILE, "sec-ch-ua-platform": get_sec_ch_ua_platform(), + "sec-ch-ua-arch": SEC_CH_UA_ARCH, + "sec-ch-ua-bitness": SEC_CH_UA_BITNESS, + "sec-ch-ua-full-version": get_sec_ch_ua_full_version(), + "sec-ch-ua-full-version-list": get_sec_ch_ua_full_version_list(), + "sec-ch-ua-model": SEC_CH_UA_MODEL, + "sec-ch-ua-platform-version": SEC_CH_UA_PLATFORM_VERSION, "Sec-Fetch-Dest": "empty", "Sec-Fetch-Mode": "cors", "Sec-Fetch-Site": "same-origin", } if method == "POST": headers["Content-Type"] = "application/json" + headers["Referer"] = "https://x.com/compose/post" + headers["Priority"] = "u=1, i" # Generate x-client-transaction-id if available if self._client_transaction and url: try: @@ -1100,9 +1187,63 @@ class TwitterClient: retweeted_by=retweeted_by, quoted_tweet=quoted_tweet, lang=actual_legacy.get("lang", ""), + **_parse_article(actual_data), ) +def _parse_article(tweet_data): + # type: (Dict[str, Any]) -> Dict[str, Any] + """Extract Twitter Article data (long-form content) from a tweet. + + Returns dict with 'article_title' and 'article_text' keys (None if not an article). + Converts draft.js content blocks to Markdown. + """ + article_results = _deep_get(tweet_data, "article", "article_results", "result") + if not article_results: + return {"article_title": None, "article_text": None} + + title = article_results.get("title") # type: Optional[str] + content_state = article_results.get("content_state", {}) + blocks = content_state.get("blocks", []) + if not blocks: + return {"article_title": title, "article_text": None} + + # Convert draft.js blocks to Markdown + parts = [] # type: List[str] + ordered_counter = 0 + for block in blocks: + block_type = block.get("type", "unstyled") # type: str + if block_type == "atomic": + continue + text = block.get("text", "") # type: str + if not text: + continue + if block_type != "ordered-list-item": + ordered_counter = 0 + if block_type == "header-one": + parts.append("# %s" % text) + elif block_type == "header-two": + parts.append("## %s" % text) + elif block_type == "header-three": + parts.append("### %s" % text) + elif block_type == "blockquote": + parts.append("> %s" % text) + elif block_type == "unordered-list-item": + parts.append("- %s" % text) + elif block_type == "ordered-list-item": + ordered_counter += 1 + parts.append("%d. %s" % (ordered_counter, text)) + elif block_type == "code-block": + parts.append("```\n%s\n```" % text) + else: + parts.append(text) + + return { + "article_title": title, + "article_text": "\n\n".join(parts) if parts else None, + } + + def _extract_media(legacy): # type: (Dict[str, Any]) -> List[TweetMedia] """Extract media items from tweet legacy data.""" diff --git a/twitter_cli/constants.py b/twitter_cli/constants.py index 5c50474..3899a51 100644 --- a/twitter_cli/constants.py +++ b/twitter_cli/constants.py @@ -48,6 +48,18 @@ def get_sec_ch_ua(): ) +def get_sec_ch_ua_full_version(): + # type: () -> str + return '"%s.0.0.0"' % _chrome_version + + +def get_sec_ch_ua_full_version_list(): + # type: () -> str + return '"Google Chrome";v="%s.0.0.0", "Chromium";v="%s.0.0.0", "Not.A/Brand";v="99.0.0.0"' % ( + _chrome_version, _chrome_version, + ) + + def _get_locale_tag(): # type: () -> str raw = ( @@ -86,6 +98,10 @@ def get_sec_ch_ua_platform(): # Static Client Hints SEC_CH_UA_MOBILE = "?0" SEC_CH_UA_PLATFORM = get_sec_ch_ua_platform() +SEC_CH_UA_ARCH = '"arm"' if sys.platform == "darwin" else '"x86"' +SEC_CH_UA_BITNESS = '"64"' +SEC_CH_UA_MODEL = '""' +SEC_CH_UA_PLATFORM_VERSION = '"15.0.0"' if sys.platform == "darwin" else '"10.0.0"' # Legacy aliases — modules that import these get the default value. # _build_headers() should use get_user_agent() / get_sec_ch_ua() instead. diff --git a/twitter_cli/models.py b/twitter_cli/models.py index 0f9dce0..6a4c660 100644 --- a/twitter_cli/models.py +++ b/twitter_cli/models.py @@ -50,6 +50,8 @@ class Tweet: retweeted_by: Optional[str] = None quoted_tweet: Optional[Tweet] = None score: Optional[float] = None + article_title: Optional[str] = None + article_text: Optional[str] = None @dataclass diff --git a/twitter_cli/output.py b/twitter_cli/output.py new file mode 100644 index 0000000..b31006c --- /dev/null +++ b/twitter_cli/output.py @@ -0,0 +1,68 @@ +"""Shared structured output helpers for twitter-cli.""" + +from __future__ import annotations + +import json +import os +import sys +from typing import Any, Callable + +import click +import yaml + +_OUTPUT_ENV = "OUTPUT" + + +def default_structured_format(*, as_json: bool, as_yaml: bool) -> str | None: + """Resolve explicit flags first, then env override, then TTY default.""" + if as_json and as_yaml: + raise click.UsageError("Use only one of --json or --yaml.") + if as_yaml: + return "yaml" + if as_json: + return "json" + + output_mode = os.getenv(_OUTPUT_ENV, "auto").strip().lower() + if output_mode == "yaml": + return "yaml" + if output_mode == "json": + return "json" + if output_mode == "rich": + return None + + if not sys.stdout.isatty(): + return "yaml" + return None + + +def use_rich_output(*, as_json: bool, as_yaml: bool, compact: bool = False) -> bool: + """Return True when human-readable rich output should be used.""" + if compact: + return False + return default_structured_format(as_json=as_json, as_yaml=as_yaml) is None + + +def structured_output_options(command: Callable) -> Callable: + """Add --json/--yaml options to a Click command.""" + command = click.option("--yaml", "as_yaml", is_flag=True, help="Output as YAML.")(command) + command = click.option("--json", "as_json", is_flag=True, help="Output as JSON.")(command) + return command + + +def emit_structured(data: Any, *, as_json: bool, as_yaml: bool) -> bool: + """Emit structured output and return True when used.""" + fmt = default_structured_format(as_json=as_json, as_yaml=as_yaml) + if not fmt: + return False + if fmt == "json": + click.echo(json.dumps(data, ensure_ascii=False, indent=2)) + else: + click.echo( + yaml.safe_dump( + data, + allow_unicode=True, + sort_keys=False, + default_flow_style=False, + ) + ) + return True diff --git a/twitter_cli/serialization.py b/twitter_cli/serialization.py index 429a668..91a1542 100644 --- a/twitter_cli/serialization.py +++ b/twitter_cli/serialization.py @@ -44,6 +44,10 @@ def tweet_to_dict(tweet: Tweet) -> Dict[str, Any]: "lang": tweet.lang, "score": tweet.score, } + if tweet.article_title is not None: + data["articleTitle"] = tweet.article_title + if tweet.article_text is not None: + data["articleText"] = tweet.article_text if tweet.quoted_tweet: data["quotedTweet"] = { "id": tweet.quoted_tweet.id, @@ -113,6 +117,8 @@ def tweet_from_dict(data: Dict[str, Any]) -> Tweet: retweeted_by=_optional_str(data.get("retweetedBy")), quoted_tweet=quoted_tweet, score=float(data["score"]) if data.get("score") is not None else None, + article_title=_optional_str(data.get("articleTitle")), + article_text=_optional_str(data.get("articleText")), ) @@ -129,6 +135,11 @@ def tweets_to_json(tweets: Iterable[Tweet]) -> str: return json.dumps([tweet_to_dict(tweet) for tweet in tweets], ensure_ascii=False, indent=2) +def tweets_to_data(tweets: Iterable[Tweet]) -> List[Dict[str, Any]]: + """Serialize Tweet objects to Python dicts.""" + return [tweet_to_dict(tweet) for tweet in tweets] + + def tweet_to_compact_dict(tweet: Tweet) -> Dict[str, Any]: """Convert a Tweet into a compact dict with minimal fields for LLM consumption.""" text = tweet.text.replace("\n", " ").strip() @@ -187,6 +198,11 @@ def users_to_json(users: Iterable[UserProfile]) -> str: ) +def users_to_data(users: Iterable[UserProfile]) -> List[Dict[str, Any]]: + """Serialize UserProfile objects to Python dicts.""" + return [user_profile_to_dict(user) for user in users] + + def _optional_int(value: Any) -> Optional[int]: """Parse an optional integer value.""" if value is None: