google.appengine.api.capabilities パッケージ

概要

アプリが API の停止と計画的ダウンタイムを識別するようにします。

例:

def StoreUploadedProfileImage(self):
  uploaded_image = self.request.get('img')
  # If the images API is unavailable, we'll just skip the resize.
  if CapabilitySet('images').is_enabled():
    uploaded_image = images.resize(uploaded_image, 64, 64)
  store(uploaded_image)

def RenderHTMLForm(self):
  datastore_readonly = CapabilitySet('datastore_v3', capabilities=['write'])
  if datastore_readonly.is_enabled():
    # ...render form normally...
  else:
    # self.response.out('<p>Not accepting submissions right now: %s</p>' %
                        datastore_readonly.admin_message())
    # ...render form with form elements disabled...

個別の API ラッパー モジュールは、ユーザーによる作成に依存するのではなく、CapabilitySet オブジェクトをユーザーに公開します。関連する CapabilitySet に委任するコンビニエンス メソッドも作成します。たとえば、db.IsReadOnly() などです。

内容

class google.appengine.api.capabilities.CapabilitySet(package, capabilities=None, methods=None, stub_map=google.appengine.api.apiproxy_stub_map) ソース

ベース: オブジェクト

1 つ以上の機能をカプセル化します。

機能は明示的に名前が付けられるか、あるいは提供されたメソッドのリストから推定されます。機能やメソッドが提供されない場合、パッケージ全体が有効になっているかどうかを確認します。

admin_message()ソース

これらの機能に対する管理者の注記メッセージを取得します。

戻り値

1 つ以上の管理者メッセージを含む文字列、または空の文字列。

発生

UnknownCapabilityError – 指定された機能が認識されなかった場合。

is_enabled()ソース

機能が現在有効になっているかどうかをテストします。

戻り値

これらの機能を必要とする API の呼び出しが成功した場合は True

発生

UnknownCapabilityError – 指定された機能が認識されなかった場合。

will_remain_enabled_for(time=60) ソース

引き続き機能が有効になっているかどうかを返します。

DEPRECATED: このメソッドは完全に実装されたことはなく、非推奨とみなされています。代わりに is_enabled() を使用してください。

パラメータ

time – 計画的ダウンタイムを確認するときに見える残りの秒数。

戻り値

指定された期間内に指定された機能に計画的ダウンタイムが存在しない場合は True

発生

UnknownCapabilityError – 指定された機能が認識されなかった場合。

exception google.appengine.api.capabilities.UnknownCapabilityError ソース

ベース: exceptions.Exception

不明な機能がリクエストされました。

このページは役立ちましたか?評価をお願いいたします。

フィードバックを送信...

Python の App Engine スタンダード環境