Changeset 31adfa5 in OpenWorkouts-current

Timestamp:

Dec 21, 2018, 11:00:25 AM (5 years ago)

Author:

borja <borja@…>

Branches:

current, feature/docs, master

Children:

fe6089a

Parents:

d507f75

Message:

(#14) Timezones support:

• Added pytz as a new dependency, please install it in your existing envs:

pip install pytz

• Added a timezone attribute to users, to store in which timezone they are, defaults to 'UTC'. Ensure any users you could have in your database have such attribute. You can add it in pshell:

for user in root.users:

user.timezone = 'UTC'

request.tm.commit()

• Modified schemas/templates/views to let users choose their timezone based on a list of "common" timezones provided by pytz

• Added two methods to the Workout model so we can get the start and end dates formatted in the appropiate timezone (all datetime objects are stored in UTC)

• Modified the templates where we show workout dates and times so the new timezone-formatting methods are used.

Files:

• ow/models/user.py (modified) (1 diff)
• ow/models/workout.py (modified) (2 diffs)
• ow/schemas/user.py (modified) (2 diffs)
• ow/templates/dashboard.pt (modified) (1 diff)
• ow/templates/delete_workout.pt (modified) (1 diff)
• ow/templates/edit_profile.pt (modified) (1 diff)
• ow/templates/workout.pt (modified) (1 diff)
• ow/tests/models/test_workout.py (modified) (1 diff)
• ow/tests/views/test_user.py (modified) (1 diff)
• ow/views/user.py (modified) (2 diffs)
• setup.py (modified) (1 diff)

ow/models/user.py

@@ -33 +33 @@
         self.gender = kw.get('gender', 'female')
         self.picture = kw.get('picture', None)  # blob
+        self.timezone = kw.get('timezone', 'UTC')
         self.__password = None
         self.last_workout_id = 0

ow/models/workout.py

@@ -3 +3 @@
 from decimal import Decimal
 
+import pytz
 import gpxpy
 from repoze.folder import Folder
@@ -74 +75 @@
         return self.start.strftime('%H:%M')
 
+    def start_in_timezone(self, timezone):
+        """
+        Return a string representation of the start date and time,
+        localized into the given timezone
+        """
+        _start = self.start.astimezone(pytz.timezone(timezone))
+        return _start.strftime('%d/%m/%Y %H:%M (%Z)')
+
+    def end_in_timezone(self, timezone):
+        """
+        Return a string representation of the end date and time,
+        localized into the given timezone
+        """
+        _end = self.end.astimezone(pytz.timezone(timezone))
+        return _end.strftime('%d/%m/%Y %H:%M (%Z)')
+
     def split_duration(self):
         hours, remainder = divmod(int(self.duration.total_seconds()), 3600)

ow/schemas/user.py

@@ -1 +1 @@
 from pyramid.i18n import TranslationStringFactory
 from formencode import Schema, validators
+from pytz import common_timezones
 
 from ow.schemas.blob import FieldStorageBlob
@@ -74 +75 @@
     picture = FieldStorageBlob(if_emtpy=None, if_missing=None,
                                whitelist=['jpg', 'jpeg', 'png', 'gif'])
+    timezone = validators.OneOf(common_timezones, if_missing='UTC')
 
 

ow/templates/dashboard.pt

@@ -38 +38 @@
             <ul class="workout-info">
               <li>
-                <tal:c tal:content="workout.start"></tal:c>
+                <tal:c tal:content="workout.start_in_timezone(context.timezone)"></tal:c>
               </li>
               <li>

ow/templates/delete_workout.pt

@@ -25 +25 @@
         <input id="delete" name="delete" type="hidden" value="yes" />
 
-      <div id="workout">
+        <div id="workout"
+             tal:define="timezone request.root[request.authenticated_userid].timezone">
         <h3 tal:content="context.title"></h3>
         <ul id="" tal:attributes="id 'workout-' + context.workout_id + '-details'">
           <li>
             <tal:t i18n:translate="">Start:</tal:t>
-            <tal:c tal:content="context.start"></tal:c>
+            <tal:c tal:content="context.start_in_timezone(timezone)"></tal:c>
           </li>
           <li>
             <tal:t i18n:translate="">End:</tal:t>
-            <tal:c tal:content="context.end"></tal:c>
+            <tal:c tal:content="context.end_in_timezone(timezone)"></tal:c>
           </li>
           <li>

ow/templates/edit_profile.pt

@@ -99 +99 @@
         </fieldset>
 
+        <fieldset>
+            <p>
+                <label for="timezone" i18n:translate="">Timezone:</label>
+                <small i18n:translate="">
+                    All dates and times will be formatted for this timezone
+                </small>
+                ${form.errorlist('timezone')}
+                ${form.select('timezone', timezones)}
+            </p>
+        </fieldset>
+
         <p>
             ${form.submit("submit", "Save",  **{'class':"button button-normal"})}

ow/templates/workout.pt

@@ -78 +78 @@
 
       <ul id="" tal:attributes="id 'workout-' + context.workout_id + '-details'"
-          tal:define="hr context.hr; cad context.cad">
+          tal:define="hr context.hr; cad context.cad; timezone context.owner.timezone">
         <li>
           <tal:t i18n:translate="">Start:</tal:t>
-          <tal:c tal:content="context.start"></tal:c>
+          <tal:c tal:content="context.start_in_timezone(timezone)"></tal:c>
         </li>
         <li>
           <tal:t i18n:translate="">End:</tal:t>
-          <tal:c tal:content="context.end"></tal:c>
+          <tal:c tal:content="context.end_in_timezone(timezone)"></tal:c>
         </li>
         <li>

ow/tests/models/test_workout.py

@@ -77 +77 @@
         workout = Workout(start=start_date)
         assert workout.start_time == start_date.strftime('%H:%M')
+
+    def test_start_in_timezone(self):
+        start_date = datetime.now(tz=timezone.utc)
+        str_start_date = start_date.strftime('%d/%m/%Y %H:%M (%Z)')
+        workout = Workout(start=start_date)
+        assert workout.start_in_timezone('UTC') == str_start_date
+        assert workout.start_in_timezone('Europe/Madrid') != str_start_date
+        assert workout.start_in_timezone('America/Vancouver') != str_start_date
+
+    def test_end_in_timezone(self):
+        start_date = datetime.now(tz=timezone.utc)
+        end_date = start_date + timedelta(minutes=60)
+        str_end_date = end_date.strftime('%d/%m/%Y %H:%M (%Z)')
+        workout = Workout(start=start_date, duration=timedelta(minutes=60))
+        assert workout.end_in_timezone('UTC') == str_end_date
+        assert workout.end_in_timezone('Europe/Madrid') != str_end_date
+        assert workout.end_in_timezone('America/Vancouver') != str_end_date
 
     def test_split_duration(self):

ow/tests/views/test_user.py

@@ -259 +259 @@
         # loaded user profile
         data = ['firstname', 'lastname', 'email', 'nickname', 'bio',
-                'birth_date', 'height', 'weight', 'gender']
+                'birth_date', 'height', 'weight', 'gender', 'timezone']
         assert list(response['form'].data.keys()) == data
         # and check the email to see data is properly loaded

ow/views/user.py

@@ -5 +5 @@
 from pyramid.i18n import TranslationStringFactory
 from pyramid_simpleform import Form, State
+from pytz import common_timezones
 
 from ..models.user import User
@@ -167 +168 @@
         # Saved, send the user to the public view of her profile
         return HTTPFound(location=request.resource_url(context, 'profile'))
+
     # prevent crashes on the form
     if 'picture' in form.data:
         del form.data['picture']
-    return {'form': OWFormRenderer(form)}
+
+    return {'form': OWFormRenderer(form),
+            'timezones': common_timezones}
 
 

setup.py

@@ -27 +27 @@
     'unidecode',
     'gpxpy',
-    'lxml'
+    'lxml',
+    'pytz'
 ]