API で遊んでみる

おっと，ちょっと待って下さい． <Poll: Poll object> なんて全然親切な表現 ではありませんね．そこで (polls/models.py ファイルに定義されている) polls 関係のモデルを少し修正して， Poll と Choice に __unicode__() メソッドを追加しましょう

class Poll(models.Model):
    # ...
    def __unicode__(self):
        return self.question

class Choice(models.Model):
    # ...
    def __unicode__(self):
        return self.choice

__unicode__() をモデルに追加しておくのは，対話プロンプトで扱うときに精 神的によいだけでなく，オブジェクトの表現 (representation) は Django 自動 admin のいたるところで使われているという点でも重要です．

__unicode__() は通常の Python メソッドということに注意してください．

モデルのスタイル

• モデルの内部クラスや標準メソッドの順番は以下のようにします (ただし， どれも必須ではないので省略してもかまいません):

  • 全てのデータベースフィールド
  • class Meta
  • class Admin
  • def __unicode__()
  • def __str__()
  • def save()
  • def get_absolute_url()
  • カスタムのメソッド定義

FILE_CHARSET

開発バージョンの Django で新たに追加されました

デフォルト値: 'utf-8'

テンプレートファイルや SQL のデータファイルなどのファイルをファイルシステム から読み出すときに使う文字エンコーディングです．

list_display

• __str__() および __unicode__() メソッドは他のモデルメソッドと 同じように list_display に入れられるので，以下のように書いても全 く問題ありません

  list_display = ('__unicode__', 'some_other_field')
  

__str__

__str__() は，オブジェクトに対して str() を呼び出した際に返す内容を 定義するための Python の特殊メソッドです． Django はそこかしこで str(obj) (または unicode(obj) -- 下記参照) を使っています．ほとんど は， Django の admin サイトでオブジェクトをレンダリングして表示したときの値 として，またオブジェクトを表示するときにテンプレートに挿入される値として使 われています．従って，オブジェクトの``__str__`` は，人間可読なわかりやすい 文字列を返さねばなりません．必須ではありませんが，強く推奨します (ただし， そこかしこに __str__ メソッドを突っ込んでしまう前に __unicode__ の 説明を良く読んでくださいね)．

例えば

class Person(models.Model):
    first_name = models.CharField(maxlength=50)
    last_name = models.CharField(maxlength=50)

    def __str__(self):
        # first_name および last_name は Unicode 文字列なので，
        # django.utils.encoding.smart_str() を使っています．
        return smart_str('%s %s' % (self.first_name, self.last_name))

__unicode__

__unicode__() メソッドは，オブジェクトに対して unicode() を呼び出し た際に呼び出されます．Django のデータベースバックエンドはモデルの属性値とし て Unicode 文字列を返すので，通常はモデルの __unicode__() メソッドを定 義するとよいでしょう．前節の例を __unicode__() を使って書き直すと，以下のように簡単になります

class Person(models.Model):
    first_name = models.CharField(maxlength=50)
    last_name = models.CharField(maxlength=50)

    def __unicode__(self):
        return u'%s %s' % (self.first_name, self.last_name)

モデルに __unicode__() メソッドだけを定義して， __str__() は定義し ないでおくと， Django が自動的に __str__() メソッドをモデルに追加します． この __str__() メソッドは， __unicode()__ を呼び出して，その戻り値 を UTF-8 でエンコードした文字列を返します．開発上はこの仕様に従い， __unicode__() だけを定義して，文字列オブジェクトへの変換は Django 任せにするよう勧めます．

get_absolute_url

文字列の結合: string_concat()

標準の Python 文字列型の join メソッド (''.join([...])) は，遅延翻訳オ ...ブジェクトの入ったリストをうまく扱えません．その代わり， django.utils.translation.string_concat() を使ってください．このメソッド は，全ての内容を結合し， かつ 文字列中に値が取り込まれるまで実際に変換を 行わないような遅延オブジェクトを生成して返します．例えば

from django.utils.translation import string_concat
...
name = ugettext_lazy(u'John Lennon')
instrument = ugettext_lazy(u'guitar')
result = string_concat([name, ': ', instrument])

上のケースでは， result 中の遅延翻訳オブジェクトは， result 自体を 文字列中で使った場合 (テンプレートのレンダリング時など) にしか文字列に変換 されません．

allow_lazy() デコレータ

Django はたくさんのユーティリティ関数を (とりわけ django.utils パッケー ジで) 提供しています．これらの関数の多くは文字列を第一引数にとり，文字列に 対して何らかの処理を行います．関数はテンプレートフィルタ内で使われたり，他 のコードで直接呼び出されたりしています．

同様の関数を自分で作成し，翻訳文字列を扱おうとした場合，第一引数が遅延翻訳 オブジェクトの場合に問題に直面することでしょう．この関数はビューの外側 (つ まり，現在のスレッドのロケール設定が的確でないかもしれない場所) で使われる かもしれないので，関数内で遅延翻訳オブジェクトを文字列に変換したくないはず だからです．

こうした場合のために， django.utils.functional.allow_lazy() デコレータ を使ってください．このデコレータで関数をラップすると，関数の第一引数に遅延 翻訳オブジェクトを渡した場合，関数の評価を文字列に変換する瞬間まで遅延させ られます．

例を示しましょう

from django.utils.functional import allow_lazy

def fancy_utility_function(s, ...):
    # Do some conversion on string 's'
    ...
fancy_utility_function = allow_lazy(fancy_utility_function, unicode)

allow_lazy() デコレータは関数名に加えて追加の引数 (*args) をとりま す．この引数には，デコレーション対象の関数の戻り値の型 (複数可) を指定しま す．通常は， unicode だけを入れておき，関数が必ず Unicode 文字列を返す ようにしておけばよいでしょう．

このデコレータを使えば，適切な文字列を入力として受け取る関数を書いておき， 後で遅延翻訳オブジェクトのサポートを追加できます．