ReST ファイル作成のガイドライン

私達は、 ReST ドキュメントを作成するときに、以下のガイドラインに従っていま す:

• 章や節の題名では、最初の文字と適切な名前のみ大文字で書きます．
• ドキュメントは幅 80 文字以内で折り返します．ただし，コード例を示す際に 複数行に分けると著しく読みにくくなる場合や，その他妥当な理由がある場合 は例外です．

よく使う用語

ドキュメント中でよく使われる用語の書き方を以下に示します:

• Django -- フレームワークそのものを指す場合には，頭文字を大文字にし ます． Python コード中や djangoproject.com のロゴでは小文字です．
• e-mail -- ハイフンを入れます．(和訳では「メール」と書いています)
• MySQL
• PostgreSQL
• Python -- 言語そのものを指す場合には頭文字を大文字にします．
• realize, customize, initialize, etc. -- "-ise" ではなく，ア メリカ語表記です．
• SQLite
• subclass -- 動詞，名詞を問わず，ハイフンを入れず一つの単語で表しま す．
• Web, World Wide Web, the Web -- ワールドワイドウェブを指す 場合には，常に Web の W は大文字です．
  • Web site -- Web を大文字にして，二つの単語を繋げません．

Django 固有の用語

• model -- 頭文字は小文字です．
• template -- 頭文字は小文字です．
• URLconf -- "URL" は大文字， "conf" は小文字です．
• view -- 頭文字は小文字です．

メールメッセージクラス

EmailMessage クラスは以下のパラメタ (固定引数を使う場合には以下に示す順 番に指定します) で初期化します．パラメタは全て省略可能で， send() メソッ ドを呼び出す前であればいつでも設定しなおせます．

• subject: メールの題名です．
• body: メール本文です．平文テキストのメッセージでなければなりませ ん．
• from_email: 送信者のアドレスです． fred@example.com 形式でも Fred <fred@example.com> 形式でもかまいません．省略すると， DEFAULT_FROM_EMAIL の設定値を使います．
• to: 受信者アドレスのリストまたはタプルです．
• bcc: メールを送信する際に "Bcc" ヘッダに指定するアドレスのリスト またはタプルです．
• connection: SMTPConnection のインスタンスです．一つの SMTP 接 続を使い回して複数のメッセージを送信したい場合に指定します．省略する と， send() を呼び出す瞬間に新しい接続を生成します．
• attachments: メールに添付するデータのリストです．リストの各要素は， email.MIMEBase.MIMEBase のインスタンスか， (filename, content, mimetype) からなるタプルです．
• headers: メッセージに追加するヘッダの辞書です．ヘッダ名をキーに， ヘッダ値を値にします．このパラメタを使うのなら，指定したヘッダがメー ルメッセージ中で正しいヘッダとして扱われるように気をつけねばなりませ ん．

例を示します

email = EmailMessage('Hello', 'Body goes here', 'from@example.com',
            ['to1@example.com', 'to2@example.com'], ['bcc@example.com'],
            headers = {'Reply-To': 'another@example.com'})

EmailMessage クラスのインスタンスには以下のようなメソッドがあります:

• message() は django.core.mail.SafeMIMEText クラス (Python の email.MIMEText.MIMEText クラスのサブクラス) または ``django.core.mail.SafeMIMEMultipart`` クラスのインスタンスを生成します． このオブジェクトには送信するメッセージが入っています． EmailMessage クラスを拡張する必要がある場合，おそらくこのメソッドを オーバライドして，所望の内容を MIME オブジェクト内に配置することになるで しょう．

• attach() を呼び出すと，新たなファイル添付用パートを生成してメッセー ジに追加します． attach() の呼び出しかたは 2 通りあります:

  • attach() に引数を一つだけ指定し， email.MIMBase.MIMEBase のインスタンスを渡します．このインスタンスの内容は最終的なメッセージ に直接挿入されます．

  • 別の方法として， attach() に 3 つの引数， filename, content および mimetype を渡します． filename は添付する ファイルの名前で，これはメール中で表示される添付ファイルの名前になり ます． content は添付パート中に入るデータで， mimetype は添 付内容の MIME タイプです． mimetype を省略すると，ファイル名を元 に推測を行います．

    例を示します

    message.attach('design.png', img_data, 'image/png')
    

• attach_file() を呼び出すと，ファイルシステム上のファイルから添付パー トを生成します． attach_file() の引数には添付したいファイルのパスを 指定します．オプションとして，添付ファイルの MIME タイプも指定できます． MIME タイプを省略すると，ファイル名をもとに推測を行います．簡単な使い方 を示すと，以下のようになります

  message.attach_file('/images/weather_map.png')
  

from django.core.mail import EmailMultiAlternatives

subject, from_email, to = 'hello', 'from@example.com', 'to@example.com'
text_content = 'This is an important message.'
html_content = '<p>This is an <strong>important</strong> message.'
msg = EmailMultiAlternatives(subject, text_content, from_email, to)
msg.attach_alternative(html_content, "text/html")
msg.send()

msg = EmailMessage(subject, html_content, from_email, to)
msg.content_subtype = "html"  # Main content is now text/html
msg.send()

Entry.objects.get(title__regex=r'^(An?|The) +')

SELECT ... WHERE title REGEXP BINARY '^(An?|The) +'; -- MySQL

SELECT ... WHERE REGEXP_LIKE(title, '^(an?|the) +', 'c'); -- Oracle

SELECT ... WHERE title ~ '^(An?|The) +'; -- PostgreSQL

SELECT ... WHERE title REGEXP '^(An?|The) +'; -- SQLite

Entry.objects.get(title__iregex=r'^(an?|the) +')

SELECT ... WHERE title REGEXP '^(an?|the) +'; -- MySQL

SELECT ... WHERE REGEXP_LIKE(title, '^(an?|the) +', 'i'); -- Oracle

SELECT ... WHERE title ~* '^(an?|the) +'; -- PostgreSQL

SELECT ... WHERE title REGEXP '(?i)^(an?|the) +'; -- SQLite