Clearer diagnostic when an API Key SID is passed without `account_sid`

オープン 初心者向け
#985 コメント 1 件 リアクション 0 件 担当者 0 名 GitHub で見る

メンテナーはふだん 1 日以内に返信

@saryeljaramany がすでに取り組んでいます。

2026年11月14日 から。

  • #990 @saryeljaramany による — オープン

評価

難易度
2/5
見積もり時間
1〜3時間
初心者へのやさしさ
82/100
issue の種類
バグ
明瞭さ
明確に書かれている
活発さ
活発
技術スタック
python
領域
api

調査の方向性

twilio/base/client_base.pyのaccount_sidフォールバックから始め、tests/unitにある関連する単体テストを確認します。account_sidのないAPI Key SIDのテストを追加し、明示的なaccount_sidと既存のトークン設定が引き続き機能することも確認します。Account SIDがない場合に対処方法がわかるエラーが返され、関連するテストが通れば完了です。

索引モデルが issue の本文から書いたものです。

説明

Location (twilio/twilio-python @ default branch 74b9629):

        self.account_sid = account_sid or self.username

Problem

The README shows API-key authentication as Client(api_key, api_secret, account_sid). If the third argument is forgotten, e.g. Client("SKxxxx...", "secret"), the constructor accepts it and ClientBase.__init__ falls back to self.account_sid = account_sid or self.username, so the API Key SID is used as the account SID in account-scoped resource paths. The fallback is silent: there is no validation or hint in the constructor, and the mistake only surfaces later as an authentication/not-found error from the API, which does not point at the missing account_sid.

Reproduction

from twilio.rest import Client

client = Client("SK" + "a" * 32, "my-api-secret")   # no error
print(client.account_sid)                            # 'SKaaaa...'
client.messages.create(...)                          # fails later with an API error

Environment:

  • Commit: 74b96296b0805986252b798bda4bca90341487ee (main, twilio 9.12.0)
  • Toolchain: Python 3.13.18

Workaround: always pass account_sid= explicitly when authenticating with API keys.

Already fixed in twilio/twilio-node

PR: https://github.com/twilio/twilio-node/pull/828 — "fix: give more descriptive error for accountSid init issues" (merged 2022-11-28T17:54:36Z, merge commit e18440d317c). When the SID used as accountSid starts with SK, the constructor error now says that an API Key requires the accountSid to be passed as an additional option. twilio-node already rejects non-AC account SIDs; that check is not being proposed here, only the API Key hint.

How twilio-node fixed it:

--- a/lib/base/BaseTwilio.ts
+++ b/lib/base/BaseTwilio.ts
@@ -88,7 +88,11 @@ export class BaseTwilio {
...
     if (!this.accountSid?.startsWith("AC")) {
-      throw new Error("accountSid must start with AC");
+      const apiKeyMsg = this.accountSid.startsWith("SK")
+        ? ". The given SID indicates an API Key which requires the accountSid to be passed as an additional option"
+        : "";
+
+      throw new Error("accountSid must start with AC" + apiKeyMsg);

Suggested fix

Mirroring twilio-node's API Key hint, ClientBase.__init__ raises a TwilioException with an actionable message when username starts with SK and neither account_sid nor a credential_provider is given; no AC prefix is enforced and other setups are unchanged:

diff --git a/twilio/base/client_base.py b/twilio/base/client_base.py
--- a/twilio/base/client_base.py
+++ b/twilio/base/client_base.py
@@ -4,6 +4,7 @@ from typing import Dict, List, MutableMapping, Optional, Tuple
 from urllib.parse import urlparse, urlunparse
 
 from twilio import __version__
+from twilio.base.exceptions import TwilioException
 from twilio.http import HttpClient
 from twilio.http.http_client import TwilioHttpClient
 from twilio.http.response import Response
@@ -54,6 +55,17 @@ class ClientBase(object):
         self.credential_provider = credential_provider or None
         """ :type : CredentialProvider """
 
+        if (
+            not account_sid
+            and not self.credential_provider
+            and self.username
+            and self.username.startswith("SK")
+        ):
+            raise TwilioException(
+                "The given username indicates an API Key SID, which requires "
+                "your Account SID to be passed via account_sid"
+            )
+
         self.account_sid = account_sid or self.username
         """ :type : str """
         self.auth = (self.username, self.password)

Verified on 74b9629 (Python 3.13.18, pytest 9.2.0): a unit test for the reproduction above (Client("SK...", "my-api-secret") must raise an error mentioning the API Key and account_sid, while Client("SK...", secret, account_sid="AC...") and Client("AC...", token) keep working) fails without this patch and passes with it; no other test results change in tests/unit.

I can submit a PR for this.

Checked: #259 / #286 (2016) were about API-key auth not being supported/how to pass the account SID; they predate the current account_sid parameter and don't cover diagnosing the omission.

主要言語
Python
スター
2.1k
フォーク
821
平均マージ
9時間 33分
マージ済み PR(30日)
3

環境構築

はじめの一歩

  1. issue を最後まで読み、次にプロジェクトのコントリビューションガイドを読みます。
  2. 着手することを issue にコメントします — 二人が同じ作業をするのを防げます。
  3. リポジトリをフォークし、ブランチを切って変更します。
  4. issue 番号を参照したプルリクエストを送ります。

twilio/twilio-python のほかの issue

twilio/twilio-python の issue をすべて見る

似ている issue

Python の issue をもっと見る

新しい issue をメールで受け取る

初心者向けの GitHub issue を短くまとめたダイジェスト。