DateTimeField
クラスは、日時型の値のフィールド定義です。これには、Python の日時オブジェクトがフィールドとして保存されます。タイムゾーン情報が日時オブジェクトに含まれている場合、その情報はエンコード / デコード時にエンコード データに含まれます。
タイムゾーンは、UTC からの分単位のオフセットとしてのみエンコードされます。JSON でシリアル化する場合は、インターネット技術特別調査委員会の RFC 3339 仕様に従ってエンコードされます。これは、想定される夏時間の動作を得るために使用できる実際のタイムゾーン(太平洋標準時(PST)など)ではありません。
DateTimeField
は、protorpc.message_types
モジュールによって提供されます。
コンストラクタ
DateTimeField
クラスのコンストラクタは、次のように定義されます。
- class DateTimeField (number, [required=False | repeated=False])
-
DateTimeField インスタンスを初期化します。
引数- number
- フィールドの番号。メッセージ クラスごとに一意でなければなりません。
- required=False
- このフィールドが必須かどうかを指定します。
repeated
引数と同時に指定することはできません。required=True
を使用する場合、repeated=True
は指定しないでください。 - repeated=False
- このフィールドが反復フィールドかどうかを指定します。
required
引数と同時に指定することはできません。repeated=True
を使用する場合、required=True
は指定しないでください。
インスタンス メソッド
DateTimeField
インスタンスには、次のメソッドがあります。
- value_from_message(message)
DateTimeMessage
をdatetime
に変換します。引数- message
DateTimeMessage
インスタンス。
- value_to_message(value)
-
引数datetime
値をDateTimeMessage
に変換します。- value
- value は
datetime
インスタンスです。