2008年4月13日日曜日

Google App Engine APIクイックリファレンス

このブログ記事をはてなブックマークに追加

Developer's Guideより。自分用メモ。

    Datastore API: google.appengine.ext.db

    Modelクラス: データモデルの定義を扱う基底クラス。
    • class Model(parent=None, key_name=None, **kw)
    • クラスメソッド
      • Model.get(keys)
      • Model.get_by_id()
      • Model.get_by_key_name(key_names, parent=None)
      • Model.get_or_insert(key_name, **kwds)
      • Model.all()
      • Model.gql(query_string, *args, **kwds)
      • Model.kind()
      • Model.properties()
    • インスタンスメソッド
      • key()
      • put()
      • delete()
      • is_saved()
      • parent()
      • parent_key()
      • to_xml()
    Expandoクラス: インスタンスが任意の属性を追加できるModelクラス。
    • class Expando(parent=None, key_name=None, **kw)
    Propertyクラス: データモデルのプロパティ定義を扱う基底クラス。
    • class Property(verbose_name=None, name=None, default=None, required=False, validator=None, choices=None)
    • 属性
      • data_type
    • インスタンスメソッド
      • default_value()
      • validate(value)
      • empty(value)
      • get_value_for_datastore(model_instance)
      • make_value_from_datastore(value)
    Queryクラス: データストアのクエリインターフェイス。
    • class Query(model_class)
    • インスタンスメソッド
      • filter(property_operator, value)
      • order(property)
      • ancestor(ancestor)
      • get()
      • fetch(limit, offset=0)
      • count(limit)
    GqlQueryクラス: GQLによるデータストアのクエリインターフェイス。
    • GqlQuery(query_string, *args, **kwds)
    • インスタンスメソッド
      • bind(*args, **kwds)
      • get()
      • fetch(limit, offset=0)
      • count(limit)
    Keyクラス: データストアのエンティティのためのユニークキーを表す。
    • class Key(encoded=None)
    • クラスメソッド
      • Key.from_path(*args, **kwds)
    • インスタンスメソッド
      • app()
      • kind()
      • id()
      • name()
      • id_or_name()
      • has_id_or_name()
      • parent()
    関数
    • get(keys)
    • put(models)
    • delete(models)
    • run_in_transaction(function, *args, **kwargs)
    (クラス : 値の型 : ソート順)
    • StringProperty : str, unicode : Unicode
    • BooleanProperty : bool : False < True
    • IntegerProperty : int, long : Numeric
    • FloatProperty : float : Numeric
    • DateTimeProperty, DateProperty, TimeProperty : datetime.datetime : 時間順
    • ListProperty : list : 昇順/降順
    • ReferenceProperty, SelfReferenceProperty : db.Key :
    • UserProperty : users.User : 電子メールアドレス順
    • BlobProperty : db.Blob : -
    • TextProperty : db.Text : -
    • CategoryProperty : db.Category : Unicode
    • LinkProperty : db.Link : Unicode
    • EmailProperty : db.Email : Unicode
    • GeoPtProperty : db.GeoPt : 緯度/経度順
    • IMProperty : db.IM : Unicode
    • PhoneNumberProperty : db.PhoneNumber : Unicode
    • PostalAddressProperty : db.PostalAddress : Unicode
    • RatingProperty : db.RAting : Numeric


    Images API: google.appengine.api.images

    Imageクラス: 画像に対し様々な変換を行うことができる。
    • class Image(image_data)
    • インスタンスメソッド
      • resize(width=0, height=0)
      • crop(left_x, top_y, right_x, bottom_y)
      • rotate(degrees)
      • horizontal_flip()
      • vertical_flip()
      • im_feeling_lucky()
      • execute_transforms(output_encoding=images.PNG)
    関数
    • resize(image_data, width=0, height=0, output_encoding=images.PNG)
    • crop(image_data, left_x, top_y, right_x, bottom_y, output_encoding=images.PNG)
    • rotate(image_data, degrees, output_encoding=images.PNG)
    • horizontal_flip(image_data, output_encoding=images.PNG)
    • vertical_flip(image_data, output_encoding=images.PNG)
    • im_feeling_lucky(image_data, output_encoding=images.PNG)
    • execute_transforms(output_encoding=images.PNG)
    例外
    • exception Error()
    • exception TransformationError()
    • exception BadRequestError()
    • exception NotImageError()
    • exception BadImageError()
    • exception LargeImageError()


    Mail API: google.appengine.api.mail

    EmailMessageクラス: 電子メールメッセージを表す。
    • class EmailMessage(**kw)
    • インスタンスメソッド
      • check_initialized()
      • initialize(**kw)
      • is_initialized()
      • send()
    メッセージフィールド
    • sender
    • to
    • cc
    • bcc
    • reply_to
    • subject
    • body
    • html
    • attachments
    関数
    • check_email_valid(email_address, field)
    • invalid_email_reason(email_address, field)
    • is_email_valid(email_address)
    • send_mail(sender, to, subject, body, **kw)
    • send_mail_to_admins(sender, subject, body, **kw)


    Memcache API: google.appengine.api.memcache

    Clientクラス: Memcacheサービスによるすべての相互作用はClientクラスの実体を使って実行される。
    • class Client()
    • インスタンスメソッド
      • set(key, value, time=0, min_compress_len=0)
      • set_multi(mapping, time=0, key_prefix='', min_compress_len=0)
      • get(key)
      • get_multi(keys, key_prefix='')
      • delete(key, seconds=0)
      • delete_multi(keys, seconds=0, key_prefix='')
      • add(key, value, time=0, min_compress_len=0)
      • replace(key, value, time=0, min_compress_len=0)
      • incr(key, delta=1)
      • decr(key, delta=1)
      • flush_all()
      • get_stats()
    関数
    • set(key, value, time=0, min_compress_len=0)
    • set_multi(mapping, time=0, key_prefix='', min_compress_len=0)
    • get(key)
    • get_multi(keys, key_prefix='')
    • delete(key, seconds=0)
    • delete_multi(keys, seconds=0, key_prefix='')
    • add(key, value, time=0, min_compress_len=0)
    • replace(key, value, time=0, min_compress_len=0)
    • incr(key, delta=1)
    • decr(key, delta=1)
    • flush_all()
    • get_stats()


    URL Fetch API: google.appengine.api.urlfetch

    関数
    • fetch(url, payload=None, method=GET, headers={}, allow_truncated=False)
    レスポンスオブジェクト
    • content
    • content_was_truncated
    • status_code
    • headers


    Users API: google.appengine.api.users

    Userクラス: Googleアカウントによるユーザを表す。
    • class User(email=None)
    • インスタンスメソッド
      • nickname()
      • email()
    関数
    • create_login_url(dest_url)
    • create_logout_url(dest_url)
    • get_current_user()
    • is_current_user_admin()

    0 コメント: