Better implementation of timezone

Author: k1o0

alyx/data/management/commands/check_dataset_type.py

@@ -0,0 +1,75 @@
+import logging
+
+from one.registration import get_dataset_type, Bunch
+
+from django.core.management import BaseCommand
+
+from data.models import Dataset, DatasetType
+logging.getLogger(__name__).setLevel(logging.WARNING)
+
+
+class Command(BaseCommand):
+    """
+        ./manage.py check_dataset_type --pattern '_*_object.attribute.*'
+        ./manage.py check_dataset_type --pattern '_*_object.attribute.*' --filename '_m1_object.attribute.json'
+        ./manage.py check_dataset_type --name 'object.attribute' --filename '_m1_object.attribute.json'
+        ./manage.py check_dataset_type --pattern '_*_object.attribute.*' --strict
+    """
+    help = "Check dataset type patterns against existing datasets."
+
+    def add_arguments(self, parser):
+        parser.add_argument('--name', help='Dataset type name', default='__new_dataset_type__')
+        parser.add_argument('--pattern', help='Pattern to match dataset types', type=str)
+        parser.add_argument('--filename', help='A filename that should match the pattern')
+        parser.add_argument(
+            '--strict', help='Whether to check other dataset types strictly', action='store_true')
+
+    def handle(self, *args, **options):
+        name = options.get('name')
+        pattern = options.get('pattern')
+        filename = options.get('filename')
+        # Fetch one dataset for each dataset type
+        self.stdout.write('Fetching one dataset for each dataset type...')
+        dsets = (
+            Dataset.objects
+            .order_by('dataset_type', '-auto_datetime')
+            .distinct('dataset_type')
+            .values_list('name', 'dataset_type')
+        )
+        dtypes = list(map(Bunch, DatasetType.objects.values('id', 'name', 'filename_pattern')))
+        assert name not in [d['name'] for d in dtypes], \
+            f'Dataset type name {name} already exists.'
+        assert pattern not in [d['filename_pattern'] for d in dtypes], \
+            f'Pattern {pattern} already exists.'
+        dtypes.append(Bunch({'id': name, 'name': name, 'filename_pattern': pattern}))
+        # If example filename provided, check it against all patterns
+        if filename:
+            self.stdout.write(f'Checking filename "{filename}" against all patterns...')
+            dtype = get_dataset_type(filename, dtypes)
+            assert dtype == dtypes[-1], (
+                f'Filename "{filename}" did not match the expected pattern "{pattern}". '
+                f'Got dataset type: {dtype}'
+            )
+
+        # Check dataset types for existing datasets
+        for dset, expected_dtype in dsets:
+            try:
+                dtype = get_dataset_type(dset, dtypes)
+            except ValueError as e:
+                if not options.get('strict') and 'No dataset type found' in str(e):
+                    dtype = DatasetType.objects.get(id=expected_dtype)
+                    self.stdout.write(
+                        self.style.WARNING(
+                            f'Skipping dataset "{dset}" as no matching dataset type found '
+                            f'(expected {dtype.name} {expected_dtype}).'
+                        )
+                    )
+                    continue
+                else:
+                    raise
+            assert dtype['id'] == expected_dtype, (
+                f'Dataset type mismatch for dataset: {dset}. '
+                f'Expected: {expected_dtype}, Found: {dtype["id"]}'
+            )
+
+        self.stdout.write(self.style.SUCCESS('All dataset type patterns appear valid.'))

alyx/data/management/one_django.py

@@ -0,0 +1 @@
+/home/ters0n/PYTHON/iblalyx/management/one_django.py

alyx/data/migrations/0022_alter_datarepository_timezone.py

@@ -1,5 +1,6 @@
-# Generated by Django 5.2.8 on 2025-11-05 23:51
+# Generated by Django 5.2.8 on 2025-11-07 17:44
 
+import data.models
 from django.db import migrations, models
 
 
@@ -13,6 +14,6 @@ class Migration(migrations.Migration):
         migrations.AlterField(
             model_name='datarepository',
             name='timezone',
-            field=models.CharField(blank=True, default='Africa/Djibouti', help_text='Timezone of the server (see https://en.wikipedia.org/wiki/List_of_tz_database_time_zones)', max_length=64),
+            field=models.CharField(blank=True, default=data.models.default_timezone, help_text='Timezone of the server (see https://en.wikipedia.org/wiki/List_of_tz_database_time_zones)', max_length=64),
         ),
     ]

alyx/data/models.py

@@ -3,11 +3,11 @@
 
 from django.core.validators import RegexValidator
 from django.db import models
+from django.conf import settings
 from django.utils import timezone
 from django.contrib.contenttypes.fields import GenericForeignKey
 from django.contrib.contenttypes.models import ContentType
 
-from alyx.settings import TIME_ZONE, AUTH_USER_MODEL
 from actions.models import Session
 from alyx.base import BaseModel, modify_fields, BaseManager, CharNullField, BaseQuerySet, ALF_SPEC
 
@@ -18,6 +18,10 @@ def _related_string(field):
     return "%(app_label)s_%(class)s_" + field + "_related"
 
 
+def default_timezone():
+    return settings.TIME_ZONE
+
+
 # Data repositories
 # ------------------------------------------------------------------------------------------------
 
@@ -67,7 +71,7 @@ class DataRepository(BaseModel):
         blank=True, null=True,
         help_text="URL of the data repository, if it is accessible via HTTP")
     timezone = models.CharField(
-        max_length=64, blank=True, default=TIME_ZONE,
+        max_length=64, blank=True, default=default_timezone,
         help_text="Timezone of the server "
         "(see https://en.wikipedia.org/wiki/List_of_tz_database_time_zones)")
     globus_path = models.CharField(
@@ -147,7 +151,7 @@ class DatasetType(BaseModel):
         help_text="Short identifying nickname, e.g. 'spikes.times'")
 
     created_by = models.ForeignKey(
-        AUTH_USER_MODEL, blank=True, null=True,
+        settings.AUTH_USER_MODEL, blank=True, null=True,
         on_delete=models.CASCADE,
         related_name=_related_string('created_by'),
         help_text="The creator of the data.")
@@ -194,7 +198,7 @@ class BaseExperimentalData(BaseModel):
         help_text="The Session to which this data belongs")
 
     created_by = models.ForeignKey(
-        AUTH_USER_MODEL, blank=True, null=True,
+        settings.AUTH_USER_MODEL, blank=True, null=True,
         on_delete=models.CASCADE,
         related_name=_related_string('created_by'),
         help_text="The creator of the data.")
@@ -470,7 +474,7 @@ def __str__(self):
 # ------------------------------------------------------------------------------------------------
 
 class Download(BaseModel):
-    user = models.ForeignKey(AUTH_USER_MODEL, on_delete=models.CASCADE)
+    user = models.ForeignKey(settings.AUTH_USER_MODEL, on_delete=models.CASCADE)
     dataset = models.ForeignKey(Dataset, on_delete=models.CASCADE)
     first_download = models.DateTimeField(auto_now_add=True)
     last_download = models.DateTimeField(auto_now=True)

alyx/misc/admin.py

@@ -3,7 +3,6 @@
 from django import forms
 from django.db import models
 from django.db.models import Q
-from django.conf import settings
 from django.contrib import admin
 from django.contrib.admin.widgets import AdminFileWidget
 from django.contrib.contenttypes.admin import GenericTabularInline
@@ -71,12 +70,6 @@ def local(self, obj):
     def server(self, obj):
         return ','.join([p.name for p in obj.repositories.filter(globus_is_personal=False)])
 
-    def get_form(self, request, obj=None, **kwargs):
-        form = super().get_form(request, obj, **kwargs)
-        if not obj:
-            form.base_fields['timezone'].initial = settings.TIME_ZONE
-        return form
-
 
 class LabMembershipAdmin(BaseAdmin):
     fields = ['user', 'lab', 'role', 'start_date', 'end_date']

alyx/misc/migrations/0012_alter_lab_timezone.py

@@ -1,5 +1,6 @@
-# Generated by Django 5.2.8 on 2025-11-05 23:51
+# Generated by Django 5.2.8 on 2025-11-07 17:44
 
+import misc.models
 from django.db import migrations, models
 
 
@@ -13,6 +14,6 @@ class Migration(migrations.Migration):
         migrations.AlterField(
             model_name='lab',
             name='timezone',
-            field=models.CharField(blank=True, help_text='Timezone of the server (see https://en.wikipedia.org/wiki/List_of_tz_database_time_zones)', max_length=64),
+            field=models.CharField(blank=True, default=misc.models.default_timezone, help_text='Timezone of the server (see https://en.wikipedia.org/wiki/List_of_tz_database_time_zones)', max_length=64),
         ),
     ]

alyx/misc/models.py

@@ -25,6 +25,10 @@ def default_lab():
     return settings.DEFAULT_LAB_PK
 
 
+def default_timezone():
+    return settings.TIME_ZONE
+
+
 class LabMember(AbstractUser):
     id = models.UUIDField(primary_key=True, default=uuid.uuid4, editable=False)
     is_stock_manager = models.BooleanField(default=False)
@@ -77,7 +81,7 @@ class Lab(BaseModel):
     institution = models.CharField(max_length=255, blank=True)
     address = models.CharField(max_length=255, blank=True)
     timezone = models.CharField(
-        max_length=64, blank=True,
+        max_length=64, blank=True, default=default_timezone,
         help_text="Timezone of the server "
         "(see https://en.wikipedia.org/wiki/List_of_tz_database_time_zones)")
 
@@ -105,10 +109,6 @@ class Lab(BaseModel):
     def __str__(self):
         return self.name
 
-    def save(self, *args, timezone=None, **kwargs):
-        self.timezone = timezone or self.timezone or settings.TIME_ZONE
-        super().save(*args, **kwargs)
-
 
 class LabMembership(BaseModel):
     user = models.ForeignKey(settings.AUTH_USER_MODEL, on_delete=models.CASCADE)

alyx/misc/tests_admin.py

@@ -36,7 +36,10 @@ def test_admin_add_form_view(self):
         LabForm = la.get_form(request)
         # Check initial value of timezone field
         form = LabForm(data={})
-        self.assertEqual(form.fields['timezone'].initial, 'Africa/Djibouti')
+        initial = form.fields['timezone'].initial
+        if callable(initial):
+            initial = initial()
+        self.assertEqual(initial, 'Africa/Djibouti')
         # Check form cleaning
         data = {
             'timezone': 'Africa/Djibouti',