forked from Arachnid/aetycoon
/
__init__.py
803 lines (627 loc) · 24.7 KB
/
__init__.py
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
318
319
320
321
322
323
324
325
326
327
328
329
330
331
332
333
334
335
336
337
338
339
340
341
342
343
344
345
346
347
348
349
350
351
352
353
354
355
356
357
358
359
360
361
362
363
364
365
366
367
368
369
370
371
372
373
374
375
376
377
378
379
380
381
382
383
384
385
386
387
388
389
390
391
392
393
394
395
396
397
398
399
400
401
402
403
404
405
406
407
408
409
410
411
412
413
414
415
416
417
418
419
420
421
422
423
424
425
426
427
428
429
430
431
432
433
434
435
436
437
438
439
440
441
442
443
444
445
446
447
448
449
450
451
452
453
454
455
456
457
458
459
460
461
462
463
464
465
466
467
468
469
470
471
472
473
474
475
476
477
478
479
480
481
482
483
484
485
486
487
488
489
490
491
492
493
494
495
496
497
498
499
500
501
502
503
504
505
506
507
508
509
510
511
512
513
514
515
516
517
518
519
520
521
522
523
524
525
526
527
528
529
530
531
532
533
534
535
536
537
538
539
540
541
542
543
544
545
546
547
548
549
550
551
552
553
554
555
556
557
558
559
560
561
562
563
564
565
566
567
568
569
570
571
572
573
574
575
576
577
578
579
580
581
582
583
584
585
586
587
588
589
590
591
592
593
594
595
596
597
598
599
600
601
602
603
604
605
606
607
608
609
610
611
612
613
614
615
616
617
618
619
620
621
622
623
624
625
626
627
628
629
630
631
632
633
634
635
636
637
638
639
640
641
642
643
644
645
646
647
648
649
650
651
652
653
654
655
656
657
658
659
660
661
662
663
664
665
666
667
668
669
670
671
672
673
674
675
676
677
678
679
680
681
682
683
684
685
686
687
688
689
690
691
692
693
694
695
696
697
698
699
700
701
702
703
704
705
706
707
708
709
710
711
712
713
714
715
716
717
718
719
720
721
722
723
724
725
726
727
728
729
730
731
732
733
734
735
736
737
738
739
740
741
742
743
744
745
746
747
748
749
750
751
752
753
754
755
756
757
758
759
760
761
762
763
764
765
766
767
768
769
770
771
772
773
774
775
776
777
778
779
780
781
782
783
784
785
786
787
788
789
790
791
792
793
794
795
796
797
798
799
800
801
802
803
import copy
import datetime
import hashlib
import logging
import os
import pickle
import zlib
from google.appengine.api import users
from google.appengine.ext import db
def DerivedProperty(func=None, *args, **kwargs):
"""Implements a 'derived' datastore property.
Derived properties are not set directly, but are instead generated by a
function when required. They are useful to provide fields in the datastore
that can be used for filtering or sorting in ways that are not otherwise
possible with unmodified data - for example, filtering by the length of a
BlobProperty, or case insensitive matching by querying the lower cased version
of a string.
DerivedProperty can be declared as a regular property, passing a function as
the first argument, or it can be used as a decorator for the function that
does the calculation, either with or without arguments.
Example:
>>> class DatastoreFile(db.Model):
... name = db.StringProperty(required=True)
... name_lower = DerivedProperty(lambda self: self.name.lower())
...
... data = db.BlobProperty(required=True)
... @DerivedProperty
... def size(self):
... return len(self.data)
...
... @DerivedProperty(name='sha1')
... def hash(self):
... return hashlib.sha1(self.data).hexdigest()
You can read derived properties the same way you would regular ones:
>>> file = DatastoreFile(name='Test.txt', data='Hello, world!')
>>> file.name_lower
'test.txt'
>>> file.hash
'943a702d06f34599aee1f8da8ef9f7296031d699'
Attempting to set a derived property will throw an error:
>>> file.name_lower = 'foobar'
Traceback (most recent call last):
...
DerivedPropertyError: Cannot assign to a DerivedProperty
When persisted, derived properties are stored to the datastore, and can be
filtered on and sorted by:
>>> file.put() # doctest: +ELLIPSIS
datastore_types.Key.from_path(u'DatastoreFile', ...)
>>> DatastoreFile.all().filter('size =', 13).get().name
u'Test.txt'
"""
if func:
# Regular invocation, or used as a decorator without arguments
return _DerivedProperty(func, *args, **kwargs)
else:
# We're being called as a decorator with arguments
def decorate(decorated_func):
return _DerivedProperty(decorated_func, *args, **kwargs)
return decorate
class _DerivedProperty(db.Property):
def __init__(self, derive_func, *args, **kwargs):
"""Constructor.
Args:
func: A function that takes one argument, the model instance, and
returns a calculated value.
"""
super(_DerivedProperty, self).__init__(*args, **kwargs)
self.derive_func = derive_func
def __get__(self, model_instance, model_class):
if model_instance is None:
return self
return self.derive_func(model_instance)
def __set__(self, model_instance, value):
raise db.DerivedPropertyError("Cannot assign to a DerivedProperty")
class LowerCaseProperty(_DerivedProperty):
"""A convenience class for generating lower-cased fields for filtering.
Example usage:
>>> class Pet(db.Model):
... name = db.StringProperty(required=True)
... name_lower = LowerCaseProperty(name)
>>> pet = Pet(name='Fido')
>>> pet.name_lower
'fido'
"""
def __init__(self, property, *args, **kwargs):
"""Constructor.
Args:
property: The property to lower-case.
"""
super(LowerCaseProperty, self).__init__(
lambda self: property.__get__(self, type(self)).lower(),
*args, **kwargs)
class LengthProperty(_DerivedProperty):
"""A convenience class for recording the length of another field
Example usage:
>>> class TagList(db.Model):
... tags = db.ListProperty(unicode, required=True)
... num_tags = LengthProperty(tags)
>>> tags = TagList(tags=[u'cool', u'zany'])
>>> tags.num_tags
2
"""
def __init__(self, property, *args, **kwargs):
"""Constructor.
Args:
property: The property to lower-case.
"""
super(LengthProperty, self).__init__(
lambda self: len(property.__get__(self, type(self))),
*args, **kwargs)
def TransformProperty(source, transform_func=None, *args, **kwargs):
"""Implements a 'transform' datastore property.
TransformProperties are similar to DerivedProperties, but with two main
differences:
- Instead of acting on the whole model, the transform function is passed the
current value of a single property which was specified in the constructor.
- Property values are calculated when the property being derived from is set,
not when the TransformProperty is fetched. This is more efficient for
properties that have significant expense to calculate.
TransformProperty can be declared as a regular property, passing the property
to operate on and a function as the first arguments, or it can be used as a
decorator for the function that does the calculation, with the property to
operate on passed as an argument.
Example:
>>> class DatastoreFile(db.Model):
... name = db.StringProperty(required=True)
...
... data = db.BlobProperty(required=True)
... size = TransformProperty(data, len)
...
... @TransformProperty(data)
... def hash(val):
... return hashlib.sha1(val).hexdigest()
You can read transform properties the same way you would regular ones:
>>> file = DatastoreFile(name='Test.txt', data='Hello, world!')
>>> file.size
13
>>> file.data
'Hello, world!'
>>> file.hash
'943a702d06f34599aee1f8da8ef9f7296031d699'
Updating the property being transformed automatically updates any
TransformProperties depending on it:
>>> file.data = 'Fubar'
>>> file.data
'Fubar'
>>> file.size
5
>>> file.hash
'df5fc9389a7567ddae2dd29267421c05049a6d31'
Attempting to set a transform property directly will throw an error:
>>> file.size = 123
Traceback (most recent call last):
...
DerivedPropertyError: Cannot assign to a TransformProperty
When persisted, transform properties are stored to the datastore, and can be
filtered on and sorted by:
>>> file.put() # doctest: +ELLIPSIS
datastore_types.Key.from_path(u'DatastoreFile', ...)
>>> DatastoreFile.all().filter('size =', 13).get().hash
'943a702d06f34599aee1f8da8ef9f7296031d699'
"""
if transform_func:
# Regular invocation
return _TransformProperty(source, transform_func, *args, **kwargs)
else:
# We're being called as a decorator with arguments
def decorate(decorated_func):
return _TransformProperty(source, decorated_func, *args, **kwargs)
return decorate
class _TransformProperty(db.Property):
def __init__(self, source, transform_func, *args, **kwargs):
"""Constructor.
Args:
source: The property the transformation acts on.
transform_func: A function that takes the value of source and transforms
it in some way.
"""
super(_TransformProperty, self).__init__(*args, **kwargs)
self.source = source
self.transform_func = transform_func
def __orig_attr_name(self):
return '_ORIGINAL' + self._attr_name()
def __transformed_attr_name(self):
return self._attr_name()
def __get__(self, model_instance, model_class):
if model_instance is None:
return self
last_val = getattr(model_instance, self.__orig_attr_name(), None)
current_val = self.source.__get__(model_instance, model_class)
if last_val == current_val:
return getattr(model_instance, self.__transformed_attr_name())
transformed_val = self.transform_func(current_val)
setattr(model_instance, self.__orig_attr_name(), current_val)
setattr(model_instance, self.__transformed_attr_name(), transformed_val)
return transformed_val
def __set__(self, model_instance, value):
raise db.DerivedPropertyError("Cannot assign to a TransformProperty")
class KeyProperty(db.Property):
"""A property that stores a key, without automatically dereferencing it.
Example usage:
>>> class SampleModel(db.Model):
... sample_key = KeyProperty()
>>> model = SampleModel()
>>> model.sample_key = db.Key.from_path("Foo", "bar")
>>> model.put() # doctest: +ELLIPSIS
datastore_types.Key.from_path(u'SampleModel', ...)
>>> model.sample_key # doctest: +ELLIPSIS
datastore_types.Key.from_path(u'Foo', u'bar', ...)
"""
def validate(self, value):
"""Validate the value.
Args:
value: The value to validate.
Returns:
A valid key.
"""
if isinstance(value, basestring):
value = db.Key(value)
if value is not None:
if not isinstance(value, db.Key):
raise TypeError("Property %s must be an instance of db.Key"
% (self.name,))
return super(KeyProperty, self).validate(value)
class PickleProperty(db.Property):
"""A property for storing complex objects in the datastore in pickled form.
Example usage:
>>> class PickleModel(db.Model):
... data = PickleProperty()
>>> model = PickleModel()
>>> model.data = {"foo": "bar"}
>>> model.data
{'foo': 'bar'}
>>> model.put() # doctest: +ELLIPSIS
datastore_types.Key.from_path(u'PickleModel', ...)
>>> model2 = PickleModel.all().get()
>>> model2.data
{'foo': 'bar'}
"""
data_type = db.Blob
def get_value_for_datastore(self, model_instance):
value = self.__get__(model_instance, model_instance.__class__)
if value is not None:
return db.Blob(pickle.dumps(value))
def make_value_from_datastore(self, value):
if value is not None:
return pickle.loads(str(value))
def default_value(self):
"""If possible, copy the value passed in the default= keyword argument.
This prevents mutable objects such as dictionaries from being shared across
instances."""
return copy.copy(self.default)
class SetProperty(db.ListProperty):
"""A property that stores a set of things.
This is a parameterized property; the parameter must be a valid
non-list data type, and all items must conform to this type.
Example usage:
>>> class SetModel(db.Model):
... a_set = SetProperty(int)
>>> model = SetModel()
>>> model.a_set = set([1, 2, 3])
>>> model.a_set
set([1, 2, 3])
>>> model.a_set.add(4)
>>> model.a_set
set([1, 2, 3, 4])
>>> model.put() # doctest: +ELLIPSIS
datastore_types.Key.from_path(u'SetModel', ...)
>>> model2 = SetModel.all().get()
>>> model2.a_set
set([1L, 2L, 3L, 4L])
"""
def validate(self, value):
value = db.Property.validate(self, value)
if value is not None:
if not isinstance(value, (set, frozenset)):
raise db.BadValueError('Property %s must be a set' % self.name)
value = self.validate_list_contents(value)
return value
def default_value(self):
return set(db.Property.default_value(self))
def get_value_for_datastore(self, model_instance):
return list(super(SetProperty, self).get_value_for_datastore(model_instance))
def make_value_from_datastore(self, value):
if value is not None:
return set(super(SetProperty, self).make_value_from_datastore(value))
def get_form_field(self, **kwargs):
from django import newforms as forms
defaults = {'widget': forms.Textarea,
'initial': ''}
defaults.update(kwargs)
return super(SetProperty, self).get_form_field(**defaults)
def get_value_for_form(self, instance):
value = super(SetProperty, self).get_value_for_form(instance)
if not value:
return None
if isinstance(value, set):
value = '\n'.join(value)
return value
def make_value_from_form(self, value):
if not value:
return []
if isinstance(value, basestring):
value = value.splitlines()
return set(value)
class InvalidDomainError(Exception):
"""Raised when something attempts to access data belonging to another domain."""
class CurrentDomainProperty(db.Property):
"""A property that restricts access to the current domain.
Example usage:
>>> class DomainModel(db.Model):
... domain = CurrentDomainProperty()
>>> os.environ['HTTP_HOST'] = 'domain1'
>>> model = DomainModel()
The domain is set automatically:
>>> model.domain
u'domain1'
You cannot change the domain:
>>> model.domain = 'domain2' # doctest: +ELLIPSIS
Traceback (most recent call last):
...
InvalidDomainError: Domain 'domain1' attempting to illegally access data for domain 'domain2'
>>> key = model.put()
>>> model = DomainModel.get(key)
>>> model.domain
u'domain1'
You cannot write the data from another domain:
>>> os.environ['HTTP_HOST'] = 'domain2'
>>> model.put() # doctest: +ELLIPSIS
Traceback (most recent call last):
...
InvalidDomainError: Domain 'domain2' attempting to allegally modify data for domain 'domain1'
Nor can you read it:
>>> DomainModel.get(key) # doctest: +ELLIPSIS
Traceback (most recent call last):
...
InvalidDomainError: Domain 'domain2' attempting to illegally access data for domain 'domain1'
Admin users can read and write data for other domains:
>>> os.environ['USER_IS_ADMIN'] = '1'
>>> model = DomainModel.get(key)
>>> model.put() # doctest: +ELLIPSIS
datastore_types.Key.from_path(u'DomainModel', ...)
You can also define models that should permit read or write access from
other domains:
>>> os.environ['USER_IS_ADMIN'] = '0'
>>> class DomainModel2(db.Model):
... domain = CurrentDomainProperty(allow_read=True, allow_write=True)
>>> model = DomainModel2()
>>> model.domain
u'domain2'
>>> key = model.put()
>>> os.environ['HTTP_HOST'] = 'domain3'
>>> model = DomainModel2.get(key)
>>> model.put() # doctest: +ELLIPSIS
datastore_types.Key.from_path(u'DomainModel2', ...)
"""
def __init__(self, allow_read=False, allow_write=False, *args, **kwargs):
"""Constructor.
Args:
allow_read: If True, allow entities with this property to be read, but not
written, from other domains.
allow_write: If True, allow entities with this property to be modified
from other domains.
"""
self.allow_read = allow_read
self.allow_write = allow_write
super(CurrentDomainProperty, self).__init__(*args, **kwargs)
def __set__(self, model_instance, value):
if not value:
value = unicode(os.environ['HTTP_HOST'])
elif (value != os.environ['HTTP_HOST'] and not self.allow_read
and not users.is_current_user_admin()):
raise InvalidDomainError(
"Domain '%s' attempting to illegally access data for domain '%s'"
% (os.environ['HTTP_HOST'], value))
super(CurrentDomainProperty, self).__set__(model_instance, value)
def get_value_for_datastore(self, model_instance):
value = super(CurrentDomainProperty, self).get_value_for_datastore(
model_instance)
if (value != os.environ['HTTP_HOST'] and not users.is_current_user_admin()
and not self.allow_write):
raise InvalidDomainError(
"Domain '%s' attempting to allegally modify data for domain '%s'"
% (os.environ['HTTP_HOST'], value))
return value
class ChoiceProperty(db.IntegerProperty):
"""A property for efficiently storing choices made from a finite set.
This works by mapping each choice to an integer. The choices must be hashable
(so that they can be efficiently mapped back to their corresponding index).
Example usage:
>>> class ChoiceModel(db.Model):
... a_choice = ChoiceProperty(enumerate(['red', 'green', 'blue']))
... b_choice = ChoiceProperty([(0,None), (1,'alpha'), (4,'beta')])
You interact with choice properties using the choice values:
>>> model = ChoiceModel(a_choice='green')
>>> model.a_choice
'green'
>>> model.b_choice == None
True
>>> model.b_choice = 'beta'
>>> model.b_choice
'beta'
>>> model.put() # doctest: +ELLIPSIS
datastore_types.Key.from_path(u'ChoiceModel', ...)
>>> model2 = ChoiceModel.all().get()
>>> model2.a_choice
'green'
>>> model.b_choice
'beta'
To get the int representation of a choice, you may use either access the
choice's corresponding attribute or use the c2i method:
>>> green = ChoiceModel.a_choice.GREEN
>>> none = ChoiceModel.b_choice.c2i(None)
>>> (green == 1) and (none == 0)
True
The int representation of a choice is needed to filter on a choice property:
>>> ChoiceModel.gql("WHERE a_choice = :1", green).count()
1
"""
def __init__(self, choices, make_choice_attrs=True, *args, **kwargs):
"""Constructor.
Args:
choices: A non-empty list of 2-tuples of the form (id, choice). id must be
the int to store in the database. choice may be any hashable value.
make_choice_attrs: If True, the uppercase version of each string choice is
set as an attribute whose value is the choice's int representation.
"""
super(ChoiceProperty, self).__init__(*args, **kwargs)
self.index_to_choice = dict(choices)
self.choice_to_index = dict((c,i) for i,c in self.index_to_choice.iteritems())
if make_choice_attrs:
for i,c in self.index_to_choice.iteritems():
if isinstance(c, basestring):
setattr(self, c.upper(), i)
def get_choices(self):
"""Gets a list of values which may be assigned to this property."""
return self.choice_to_index.keys()
def c2i(self, choice):
"""Converts a choice to its datastore representation."""
return self.choice_to_index[choice]
def __get__(self, model_instance, model_class):
if model_instance is None:
return self
index = super(ChoiceProperty, self).__get__(model_instance, model_class)
return self.index_to_choice[index]
def __set__(self, model_instance, value):
try:
index = self.c2i(value)
except KeyError:
raise db.BadValueError('Property %s must be one of the allowed choices: %s' %
(self.name, self.get_choices()))
super(ChoiceProperty, self).__set__(model_instance, index)
def get_value_for_datastore(self, model_instance):
# just use the underlying value from the parent
return super(ChoiceProperty, self).__get__(model_instance, model_instance.__class__)
def make_value_from_datastore(self, value):
if value is None:
return None
return self.index_to_choice[value]
class CompressedProperty(db.UnindexedProperty):
"""A unindexed property that is stored in a compressed form.
CompressedTextProperty and CompressedBlobProperty derive from this class.
"""
def __init__(self, level, *args, **kwargs):
"""Constructor.
Args:
level: Controls the level of zlib's compression (between 1 and 9).
"""
super(CompressedProperty, self).__init__(*args, **kwargs)
self.level = level
def get_value_for_datastore(self, model_instance):
value = self.value_to_str(model_instance)
if value is not None:
return db.Blob(zlib.compress(value, self.level))
def make_value_from_datastore(self, value):
if value is not None:
ds_value = zlib.decompress(value)
return self.str_to_value(ds_value)
# override value_to_str and str_to_value to implement a new CompressedProperty
def value_to_str(self, model_instance):
"""Returns the value stored by this property encoded as a (byte) string,
or None if value is None. This string will be stored in the datastore.
By default, returns the value unchanged."""
return self.__get__(model_instance, model_instance.__class__)
@staticmethod
def str_to_value(s):
"""Reverse of value_to_str. By default, returns s unchanged."""
return s
class CompressedBlobProperty(CompressedProperty):
"""A byte string that will be stored in a compressed form.
Example usage:
>>> class CompressedBlobModel(db.Model):
... v = CompressedBlobProperty()
You can create a CompressedBlobProperty and set its value with your raw byte
string (anything of type str). You can also retrieve the (decompressed) value
by accessing the field.
>>> model = CompressedBlobModel(v='\x041\x9f\x11')
>>> model.v = 'green'
>>> model.v
'green'
>>> model.put() # doctest: +ELLIPSIS
datastore_types.Key.from_path(u'CompressedBlobModel', ...)
>>> model2 = CompressedBlobModel.all().get()
>>> model2.v
'green'
Compressed blobs are not indexed and therefore cannot be filtered on:
>>> CompressedBlobModel.gql("WHERE v = :1", 'green').count()
0
"""
data_type = db.Blob
def __init__(self, level=6, *args, **kwargs):
super(CompressedBlobProperty, self).__init__(level, *args, **kwargs)
class CompressedTextProperty(CompressedProperty):
"""A string that will be stored in a compressed form (encoded as UTF-8).
Example usage:
>>> class CompressedTextModel(db.Model):
... v = CompressedTextProperty()
You can create a CompressedTextProperty and set its value with your string.
You can also retrieve the (decompressed) value by accessing the field.
>>> ustr = u'\u043f\u0440\u043e\u0440\u0438\u0446\u0430\u0442\u0435\u043b\u044c'
>>> model = CompressedTextModel(v=ustr)
>>> model.put() # doctest: +ELLIPSIS
datastore_types.Key.from_path(u'CompressedTextModel', ...)
>>> model2 = CompressedTextModel.all().get()
>>> model2.v == ustr
True
Compressed text is not indexed and therefore cannot be filtered on:
>>> CompressedTextModel.gql("WHERE v = :1", ustr).count()
0
"""
data_type = db.Text
def __init__(self, level=6, *args, **kwargs):
super(CompressedTextProperty, self).__init__(level, *args, **kwargs)
def value_to_str(self, model_instance):
v = self.__get__(model_instance, model_instance.__class__)
if v is None:
return v
return v.encode('utf-8')
@staticmethod
def str_to_value(s):
if s is None:
return None
return s.decode('utf-8')
class DerivedDateProperty(db.DateProperty):
"""A date which is derived from a datetime property on the same model.
This is useful when you want to denormalize by storing a plain date which can
be queried for equality (while also preserving the more detailed time
information in the original datetime property).
This could also be accomplished with a normal DerivedProperty, though the
return type would be datetime rather than a plain date.
"""
def __init__(self, dt_prop_name, *args, **kwargs):
super(DerivedDateProperty, self).__init__(*args, **kwargs)
self.dt_prop_name = dt_prop_name
def __get__(self, model_instance, model_class):
if model_instance is None:
return self
return getattr(model_instance, self.dt_prop_name).date()
def __set__(self, model_instance, value):
raise db.DerivedPropertyError("Cannot assign to a DerivedProperty")
class UTC_tzinfo(datetime.tzinfo):
def utcoffset(self, dt):
return datetime.timedelta(0)
def dst(self, dt):
return datetime.timedelta(0)
def tzname(self, dt):
return "UTC"
# source: http://code.google.com/appengine/docs/python/datastore/typesandpropertyclasses.html
class PT_tzinfo(datetime.tzinfo):
"""Implementation of the Pacific timezone."""
def utcoffset(self, dt):
return datetime.timedelta(hours=-8) + self.dst(dt)
def _FirstSunday(self, dt):
"""First Sunday on or after dt."""
return dt + datetime.timedelta(days=(6-dt.weekday()))
def dst(self, dt):
# 2 am on the second Sunday in March
dst_start = self._FirstSunday(datetime.datetime(dt.year, 3, 8, 2))
# 1 am on the first Sunday in November
dst_end = self._FirstSunday(datetime.datetime(dt.year, 11, 1, 1))
if dst_start <= dt.replace(tzinfo=None) < dst_end:
return datetime.timedelta(hours=1)
else:
return datetime.timedelta(hours=0)
def tzname(self, dt):
if self.dst(dt) == datetime.timedelta(hours=0):
return "PST"
else:
return "PDT"
TZ_UTC = UTC_tzinfo()
TZ_PT = PT_tzinfo()
def naive_dt_to_pt(naive_dt):
"""
Takes a naive datetime object, assigns UTC timezone to it, and then
converts it to pacific time. This is appropriate for datetime objects
which are retrieved from the datastore (they never include TZ info and
are ALWAYS in UTC, even if the object being put had other TZ info attached).
"""
utc_dt = naive_dt.replace(tzinfo=TZ_UTC)
return utc_dt.astimezone(TZ_PT)
class PacificDateTimeProperty(db.DateTimeProperty):
"""A DateTimeProperty whose value is always returned in Pacific time.
Example usage:
>>> class TestModel(db.Model):
... dt = PacificDateTimeProperty()
... date = DerivedDateProperty('dt')
>>> dt = datetime.datetime(2010, 03, 25, 4, 0, 0) # 4am UTC on 2010-Mar-25
>>> e = TestModel(dt=dt)
>>> e.put() # doctest: +ELLIPSIS
datastore_types.Key.from_path(u'TestModel', ...)
>>> print e.dt
2010-03-24 21:00:00-07:00
>>> print e.date
2010-03-24
"""
def __get__(self, model_instance, model_class):
if model_instance is None:
return self
dt = super(PacificDateTimeProperty, self).__get__(model_instance, model_class)
if dt.tzinfo is None or dt.tzinfo.utcoffset(dt) is None:
return naive_dt_to_pt(dt)
else:
return dt # don't convert it if it has already been converted
def make_value_from_datastore(self, value):
if value is None:
return None
return naive_dt_to_pt(value)