From b252d9f883b4a25993b7c6f6403735e4488de5ac Mon Sep 17 00:00:00 2001 From: Andreas Hubel <andi@saerdnaer.de> Date: Sun, 15 Dec 2024 00:45:25 +0100 Subject: [PATCH] chore: add some comments --- .pre-commit-config.yaml | 2 +- src/core/models/schedules.py | 1 + src/core/schedules/schedulejson.py | 2 ++ src/core/schedules/schedulejsonfrab.py | 10 ++++++---- 4 files changed, 10 insertions(+), 5 deletions(-) diff --git a/.pre-commit-config.yaml b/.pre-commit-config.yaml index 4ed3a9935..6d0424f22 100644 --- a/.pre-commit-config.yaml +++ b/.pre-commit-config.yaml @@ -48,7 +48,7 @@ repos: - name: Check for uncreated migrations. id: migrations-check language: system - entry: sh -c "src/manage.py makemigrations --check --dry-run" + entry: sh -c "pdm manage makemigrations --check --dry-run" files: "models/.*.py$" types: - python diff --git a/src/core/models/schedules.py b/src/core/models/schedules.py index 3e394cb9c..88caa2d7e 100644 --- a/src/core/models/schedules.py +++ b/src/core/models/schedules.py @@ -473,6 +473,7 @@ class ScheduleSource(models.Model): """ # for the source id use the provided id, uuid or guid field (in order) + # TODO move id to end speaker_id = speaker_info.get('id') or speaker_info.get('uuid') or speaker_info.get('guid') # sanity check: verify that required attributes are present diff --git a/src/core/schedules/schedulejson.py b/src/core/schedules/schedulejson.py index 8af6a9b09..1d757d61d 100644 --- a/src/core/schedules/schedulejson.py +++ b/src/core/schedules/schedulejson.py @@ -15,12 +15,14 @@ class ScheduleJSONSupport(BaseScheduleSupport): identifier = 'schedule-json' readonly = True + # fmt: off configuration_fields = { # 'key': (type, default value, mandatory, translation text) 'feedback': ('bool', True, False, 'Enable/Disable feedback url generation'), 'kind': ('string', 'assembly', False, 'kind of events, either "assembly" or "official" or "sos" or "lightning"'), 'headers': ('dict', {}, False, 'HTTP headers to send with the request e.g. Authorization'), } + # fmt: on def ready(self): r = s.head(self.remote_url) diff --git a/src/core/schedules/schedulejsonfrab.py b/src/core/schedules/schedulejsonfrab.py index 5af35f9cc..642daea7f 100644 --- a/src/core/schedules/schedulejsonfrab.py +++ b/src/core/schedules/schedulejsonfrab.py @@ -19,13 +19,15 @@ class ScheduleJSONFrabSupport(ScheduleJSONSupport): identifier = 'schedule-json-frab' readonly = True + # fmt: off configuration_fields = { - 'feedback': ('bool', True, False, 'Enable/Disable feedback url generation'), - 'kind': ('string', 'assembly', False, 'kind of events, either "assembly" or "official" or "sos" or "lightning"'), + 'feedback': ('bool', True, False, 'Enable/Disable feedback url generation'), + 'kind': ('string', 'assembly', False, 'kind of events, either "assembly" or "official" or "sos" or "lightning"'), 'images_base_url': (['bool', 'str'], False, False, 'Use image urls from origin instead of hub'), - 'host': ('string', 'https://frab.cccv.de/', False, 'overwrite Base URL of the schedule, used for feedback page, images, etc.'), - 'auth': ('string', None, False, 'login data for frab instance, format: user:password'), + 'host': ('string', 'https://frab.cccv.de/', False, 'overwrite Base URL of the schedule, used for feedback page, images, etc.'), + 'auth': ('string', None, False, 'login data for frab instance, format: user:password'), } + # fmt: on origin_base_url = None -- GitLab