refactor: replace datetime.now and datetime.today with timezone.now (ietf-tools#4211)

* refactor: replace datetime.now with timezone.now

* refactor: migrate model fields to use timezone.now as default

* refactor: replace datetime.today with timezone.now

datetime.datetime.today() is equivalent to datetime.datetime.now(); both
return a naive datetime with the current local time.

* refactor: rephrase datetime.now(tz) as timezone.now().astimezone(tz)

This is effectively the same, but is less likely to encourage accidental
use of naive datetimes.

* refactor: revert datetime.today() change to old migrations

* refactor: change a missed datetime.now to timezone.now

* chore: renumber timezone_now migration

* chore: renumber migrations

Author: jennifer-richards

ietf/api/management/commands/makeresources.py

@@ -3,7 +3,6 @@
 
 
 import os
-import datetime
 import collections
 import io
 
@@ -14,6 +13,7 @@
 from django.core.management.base import AppCommand
 from django.db import models
 from django.template import Template, Context
+from django.utils import timezone
 
 from tastypie.resources import ModelResource
 
@@ -89,7 +89,7 @@ def handle_app_config(self, app, **options):
                     info = dict(
                         app=app.name,
                         app_label=app.label,
-                        date=datetime.datetime.now()
+                        date=timezone.now()
                     )
                     new_models = {}
                     for model, rclass_name in missing_resources:

ietf/bin/send-scheduled-mail

@@ -3,7 +3,7 @@
 # This script requires that the proper virtual python environment has been
 # invoked before start
 
-import datetime, os, sys
+import os, sys
 import syslog
 
 # boilerplate
@@ -16,6 +16,7 @@ syslog.openlog(os.path.basename(__file__), syslog.LOG_PID, syslog.LOG_USER)
 
 import django
 django.setup()
+from django.utils import timezone
 
 from ietf.utils.mail import log_smtp_exception, send_error_email
 from smtplib import SMTPException
@@ -32,7 +33,7 @@ from ietf.message.models import SendQueue
 
 mode = sys.argv[1]
 
-now = datetime.datetime.now()
+now = timezone.now()
 
 needs_sending = SendQueue.objects.filter(sent_at=None).select_related("message")
 if mode == "specific":

ietf/community/views.py

@@ -10,6 +10,7 @@
 from django.http import HttpResponse, HttpResponseRedirect, Http404
 from django.shortcuts import get_object_or_404, render
 from django.contrib.auth.decorators import login_required
+from django.utils import timezone
 from django.utils.html import strip_tags
 
 import debug                            # pyflakes:ignore
@@ -218,7 +219,7 @@ def feed(request, username=None, acronym=None, group_type=None):
     significant = request.GET.get('significant', '') == '1'
 
     documents = docs_tracked_by_community_list(clist).values_list('pk', flat=True)
-    since = datetime.datetime.now() - datetime.timedelta(days=14)
+    since = timezone.now() - datetime.timedelta(days=14)
 
     events = DocEvent.objects.filter(
         doc__id__in=documents,
@@ -243,7 +244,7 @@ def feed(request, username=None, acronym=None, group_type=None):
         'title': title,
         'subtitle': subtitle,
         'id': feed_id.urn,
-        'updated': datetime.datetime.now(),
+        'updated': timezone.now(),
     }, content_type='text/xml')
 
 

ietf/doc/expire.py

@@ -4,6 +4,7 @@
 
 
 from django.conf import settings
+from django.utils import timezone
 
 import datetime, os, shutil, glob, re
 from pathlib import Path
@@ -62,7 +63,7 @@ def get_expired_drafts():
 
 def in_draft_expire_freeze(when=None):
     if when == None:
-        when = datetime.datetime.now()
+        when = timezone.now()
 
     meeting = Meeting.objects.filter(type='ietf', date__gte=when-datetime.timedelta(days=7)).order_by('date').first()
 

ietf/doc/factories.py

@@ -10,6 +10,7 @@
 from typing import Optional         # pyflakes:ignore
 
 from django.conf import settings
+from django.utils import timezone
 
 from ietf.doc.models import ( Document, DocEvent, NewRevisionDocEvent, DocAlias, State, DocumentAuthor,
     StateDocEvent, BallotPositionDocEvent, BallotDocEvent, BallotType, IRSGBallotDocEvent, TelechatDocEvent,
@@ -38,7 +39,7 @@ class Meta:
     rev = '00'
     std_level_id = None                 # type: Optional[str]
     intended_std_level_id = None
-    time = datetime.datetime.now()
+    time = timezone.now()
     expires = factory.LazyAttribute(lambda o: o.time+datetime.timedelta(days=settings.INTERNET_DRAFT_DAYS_TO_EXPIRE))
     pages = factory.fuzzy.FuzzyInteger(2,400)
 
@@ -357,7 +358,8 @@ class TelechatDocEventFactory(DocEventFactory):
     class Meta:
         model = TelechatDocEvent
 
-    telechat_date = datetime.datetime.today()+datetime.timedelta(days=14)
+    # note: this is evaluated at import time and not updated - all events will have the same telechat_date
+    telechat_date = timezone.now()+datetime.timedelta(days=14)
     type = 'scheduled_for_telechat'
 
 class NewRevisionDocEventFactory(DocEventFactory):
@@ -410,7 +412,7 @@ class IRSGBallotDocEventFactory(BallotDocEventFactory):
     class Meta:
         model = IRSGBallotDocEvent
 
-    duedate = datetime.datetime.now() + datetime.timedelta(days=14)
+    duedate = timezone.now() + datetime.timedelta(days=14)
     ballot_type = factory.SubFactory(BallotTypeFactory, slug='irsg-approve')
 
 class BallotPositionDocEventFactory(DocEventFactory):

ietf/doc/feeds.py

@@ -10,6 +10,7 @@
 from django.urls import reverse as urlreverse
 from django.template.defaultfilters import truncatewords, truncatewords_html, date as datefilter
 from django.template.defaultfilters import linebreaks # type: ignore
+from django.utils import timezone
 from django.utils.html import strip_tags
 
 from ietf.doc.models import Document, State, LastCallDocEvent, DocEvent
@@ -135,7 +136,7 @@ def items(self):
         if self.year:
             rfc_events = DocEvent.objects.filter(type='published_rfc',time__year=self.year).order_by('-time')
         else:
-            cutoff = datetime.datetime.now() - datetime.timedelta(days=8)
+            cutoff = timezone.now() - datetime.timedelta(days=8)
             rfc_events = DocEvent.objects.filter(type='published_rfc',time__gte=cutoff).order_by('-time')
         results = [(e.doc, e.time) for e in rfc_events]
         for doc,time in results:

ietf/doc/mails.py

@@ -10,6 +10,7 @@
 from django.utils.html import strip_tags
 from django.conf import settings
 from django.urls import reverse as urlreverse
+from django.utils import timezone
 from django.utils.encoding import force_text
 
 import debug                            # pyflakes:ignore
@@ -418,7 +419,7 @@ def generate_issue_ballot_mail(request, doc, ballot):
 
     e = doc.latest_event(LastCallDocEvent, type="sent_last_call")
     last_call_expires = e.expires if e else None
-    last_call_has_expired = last_call_expires and last_call_expires < datetime.datetime.now()
+    last_call_has_expired = last_call_expires and last_call_expires < timezone.now()
 
     return render_to_string("doc/mail/issue_iesg_ballot_mail.txt",
                             dict(doc=doc,
@@ -437,7 +438,7 @@ def _send_irsg_ballot_email(request, doc, ballot, subject, template):
     (to, cc) = gather_address_lists('irsg_ballot_issued', doc=doc)
     sender = 'IESG Secretary <iesg-secretary@ietf.org>'
 
-    ballot_expired = ballot.duedate < datetime.datetime.now()
+    ballot_expired = ballot.duedate < timezone.now()
     active_ballot = doc.active_ballot()
     if active_ballot is None:
         needed_bps = ''

ietf/doc/management/commands/generate_draft_aliases.py

@@ -16,6 +16,7 @@
 
 from django.conf import settings
 from django.core.management.base import BaseCommand
+from django.utils import timezone
 
 import debug                            # pyflakes:ignore
 
@@ -101,7 +102,7 @@ class Command(BaseCommand):
             'that have seen activity in the last %s years.' % (DEFAULT_YEARS))
 
     def handle(self, *args, **options):
-        show_since = datetime.datetime.now() - datetime.timedelta(DEFAULT_YEARS*365)
+        show_since = timezone.now() - datetime.timedelta(DEFAULT_YEARS*365)
 
         date = time.strftime("%Y-%m-%d_%H:%M:%S")
         signature = '# Generated by %s at %s\n' % (os.path.abspath(__file__), date)

ietf/doc/management/commands/generate_draft_bibxml_files.py

@@ -11,6 +11,7 @@
 from django.conf import settings
 from django.core.management.base import BaseCommand
 from django.template.loader import render_to_string
+from django.utils import timezone
 
 import debug                            # pyflakes:ignore
 
@@ -68,7 +69,7 @@ def handle(self, *args, **options):
         if process_all:
             doc_events = NewRevisionDocEvent.objects.filter(type='new_revision', doc__type_id='draft')
         else:
-            start = datetime.datetime.now() - datetime.timedelta(days=days)
+            start = timezone.now() - datetime.timedelta(days=days)
             doc_events = NewRevisionDocEvent.objects.filter(type='new_revision', doc__type_id='draft', time__gte=start)
         doc_events = doc_events.order_by('time')
 

ietf/doc/migrations/0045_use_timezone_now_for_doc_models.py

@@ -0,0 +1,39 @@
+# Generated by Django 2.2.28 on 2022-07-12 11:24
+
+from django.db import migrations, models
+import django.utils.timezone
+
+
+class Migration(migrations.Migration):
+
+    dependencies = [
+        ('doc', '0044_procmaterials_states'),
+    ]
+
+    operations = [
+        migrations.AlterField(
+            model_name='deletedevent',
+            name='time',
+            field=models.DateTimeField(default=django.utils.timezone.now),
+        ),
+        migrations.AlterField(
+            model_name='docevent',
+            name='time',
+            field=models.DateTimeField(db_index=True, default=django.utils.timezone.now, help_text='When the event happened'),
+        ),
+        migrations.AlterField(
+            model_name='dochistory',
+            name='time',
+            field=models.DateTimeField(default=django.utils.timezone.now),
+        ),
+        migrations.AlterField(
+            model_name='document',
+            name='time',
+            field=models.DateTimeField(default=django.utils.timezone.now),
+        ),
+        migrations.AlterField(
+            model_name='documentactionholder',
+            name='time_added',
+            field=models.DateTimeField(default=django.utils.timezone.now),
+        ),
+    ]