chore(add-ons): use set to store list of events

This is more straightforward to handle as these are actually
used as sets.

weblate/addons/autotranslate.py

@@ -13,7 +13,10 @@
 
 
 class AutoTranslateAddon(BaseAddon):
-    events = (AddonEvent.EVENT_COMPONENT_UPDATE, AddonEvent.EVENT_DAILY)
+    events: set[AddonEvent] = {
+        AddonEvent.EVENT_COMPONENT_UPDATE,
+        AddonEvent.EVENT_DAILY,
+    }
     name = "weblate.autotranslate.autotranslate"
     verbose = gettext_lazy("Automatic translation")
     description = gettext_lazy(

weblate/addons/base.py

@@ -15,7 +15,7 @@
 from django.utils.functional import cached_property
 from django.utils.translation import gettext
 
-from weblate.addons.events import AddonEvent
+from weblate.addons.events import POST_CONFIGURE_EVENTS, AddonEvent
 from weblate.trans.exceptions import FileParseError
 from weblate.trans.models import Component
 from weblate.trans.util import get_clean_env
@@ -43,7 +43,7 @@ class CompatDict(TypedDict, total=False):
 class BaseAddon:
     """Base class for Weblate add-ons."""
 
-    events: tuple[AddonEvent, ...] = ()
+    events: set[AddonEvent] = set()
     settings_form: type[BaseAddonForm] | None = None
     name = ""
     compat: CompatDict = {}
@@ -185,6 +185,8 @@ def post_configure_run(self) -> None:
     def post_configure_run_component(self, component) -> None:
         # Trigger post configure event for a VCS component
         previous = component.repository.last_revision
+        if not (POST_CONFIGURE_EVENTS & self.events):
+            return
 
         if AddonEvent.EVENT_POST_COMMIT in self.events:
             component.log_debug("running post_commit add-on: %s", self.name)
@@ -421,7 +423,9 @@ class UpdateBaseAddon(BaseAddon):
     It hooks to post update and commits all changed translations.
     """
 
-    events: tuple[AddonEvent, ...] = (AddonEvent.EVENT_POST_UPDATE,)
+    events: set[AddonEvent] = {
+        AddonEvent.EVENT_POST_UPDATE,
+    }
 
     @staticmethod
     def iterate_translations(component: Component):
@@ -445,5 +449,7 @@ def post_update(
 class StoreBaseAddon(BaseAddon):
     """Base class for add-ons tweaking store."""
 
-    events: tuple[AddonEvent, ...] = (AddonEvent.EVENT_STORE_POST_LOAD,)
+    events: set[AddonEvent] = {
+        AddonEvent.EVENT_STORE_POST_LOAD,
+    }
     icon = "wrench.svg"

weblate/addons/cdn.py

@@ -26,11 +26,11 @@
 
 
 class CDNJSAddon(BaseAddon):
-    events = (
+    events = {
         AddonEvent.EVENT_DAILY,
         AddonEvent.EVENT_POST_COMMIT,
         AddonEvent.EVENT_POST_UPDATE,
-    )
+    }
     name = "weblate.cdn.cdnjs"
     verbose = gettext_lazy("JavaScript localization CDN")
     description = gettext_lazy(

weblate/addons/cleanup.py

@@ -39,7 +39,10 @@ class CleanupAddon(BaseCleanupAddon):
         "no longer present in the base file."
     )
     icon = "eraser.svg"
-    events = (AddonEvent.EVENT_PRE_COMMIT, AddonEvent.EVENT_POST_UPDATE)
+    events: set[AddonEvent] = {
+        AddonEvent.EVENT_PRE_COMMIT,
+        AddonEvent.EVENT_POST_UPDATE,
+    }
 
     @classmethod
     def can_install_format(cls, component: Component) -> bool:
@@ -76,7 +79,10 @@ class RemoveBlankAddon(BaseCleanupAddon):
     description = gettext_lazy(
         "Removes strings without a translation from translation files."
     )
-    events = (AddonEvent.EVENT_POST_COMMIT, AddonEvent.EVENT_POST_UPDATE)
+    events: set[AddonEvent] = {
+        AddonEvent.EVENT_POST_COMMIT,
+        AddonEvent.EVENT_POST_UPDATE,
+    }
     icon = "eraser.svg"
 
     def update_translations(self, component: Component, previous_head: str) -> None:

weblate/addons/consistency.py

@@ -12,7 +12,7 @@
 
 
 class LanguageConsistencyAddon(BaseAddon):
-    events = (AddonEvent.EVENT_DAILY, AddonEvent.EVENT_POST_ADD)
+    events: set[AddonEvent] = {AddonEvent.EVENT_DAILY, AddonEvent.EVENT_POST_ADD}
     name = "weblate.consistency.languages"
     verbose = gettext_lazy("Add missing languages")
     description = gettext_lazy(

weblate/addons/discovery.py

@@ -18,7 +18,9 @@
 
 
 class DiscoveryAddon(BaseAddon):
-    events = (AddonEvent.EVENT_POST_UPDATE,)
+    events: set[AddonEvent] = {
+        AddonEvent.EVENT_POST_UPDATE,
+    }
     name = "weblate.discovery.discovery"
     verbose = gettext_lazy("Component discovery")
     description = gettext_lazy(

weblate/addons/events.py

@@ -6,15 +6,24 @@
 
 
 class AddonEvent(IntegerChoices):
-    EVENT_POST_PUSH = 1, "repository post-push"
-    EVENT_POST_UPDATE = 2, "repository post-update"
-    EVENT_PRE_COMMIT = 3, "repository pre-commit"
-    EVENT_POST_COMMIT = 4, "repository post-commit"
-    EVENT_POST_ADD = 5, "repository post-add"
-    EVENT_UNIT_PRE_CREATE = 6, "unit post-create"
-    EVENT_STORE_POST_LOAD = 7, "storage post-load"
-    EVENT_UNIT_POST_SAVE = 8, "unit post-save"
-    EVENT_PRE_UPDATE = 9, "repository pre-update"
-    EVENT_PRE_PUSH = 10, "repository pre-push"
-    EVENT_DAILY = 11, "daily"
-    EVENT_COMPONENT_UPDATE = 12, "component update"
+    EVENT_POST_PUSH = 1, "Repository post-push"
+    EVENT_POST_UPDATE = 2, "Repository post-update"
+    EVENT_PRE_COMMIT = 3, "Repository pre-commit"
+    EVENT_POST_COMMIT = 4, "Repository post-commit"
+    EVENT_POST_ADD = 5, "Repository post-add"
+    EVENT_UNIT_PRE_CREATE = 6, "Unit pre-create"
+    EVENT_STORE_POST_LOAD = 7, "Storage post-load"
+    EVENT_UNIT_POST_SAVE = 8, "Unit post-save"
+    EVENT_PRE_UPDATE = 9, "Repository pre-update"
+    EVENT_PRE_PUSH = 10, "Repository pre-push"
+    EVENT_DAILY = 11, "Daily"
+    EVENT_COMPONENT_UPDATE = 12, "Component update"
+
+
+POST_CONFIGURE_EVENTS = {
+    AddonEvent.EVENT_POST_COMMIT,
+    AddonEvent.EVENT_POST_UPDATE,
+    AddonEvent.EVENT_COMPONENT_UPDATE,
+    AddonEvent.EVENT_POST_PUSH,
+    AddonEvent.EVENT_DAILY,
+}

weblate/addons/example.py

@@ -13,7 +13,9 @@ class ExampleAddon(BaseAddon):
     # matched against property of component
     compat = {"file_format": {"po", "po-mono"}}
     # List of events add-on should receive
-    events = (AddonEvent.EVENT_PRE_COMMIT,)
+    events: set[AddonEvent] = {
+        AddonEvent.EVENT_PRE_COMMIT,
+    }
     # Add-on unique identifier
     name = "weblate.example.example"
     # Verbose name shown in the user interface

weblate/addons/example_pre.py

@@ -12,7 +12,9 @@
 
 class ExamplePreAddon(BaseScriptAddon):
     # Event used to trigger the script
-    events = (AddonEvent.EVENT_PRE_COMMIT,)
+    events: set[AddonEvent] = {
+        AddonEvent.EVENT_PRE_COMMIT,
+    }
     # Name of the addon, has to be unique
     name = "weblate.example.pre"
     # Verbose name and long description

weblate/addons/flags.py

@@ -20,7 +20,9 @@
 
 
 class FlagBase(BaseAddon):
-    events = (AddonEvent.EVENT_UNIT_PRE_CREATE,)
+    events: set[AddonEvent] = {
+        AddonEvent.EVENT_UNIT_PRE_CREATE,
+    }
     icon = "flag.svg"
 
     @classmethod
@@ -91,7 +93,9 @@ def unit_pre_create(self, unit) -> None:
 
 
 class BulkEditAddon(BaseAddon):
-    events = (AddonEvent.EVENT_COMPONENT_UPDATE,)
+    events: set[AddonEvent] = {
+        AddonEvent.EVENT_COMPONENT_UPDATE,
+    }
     name = "weblate.flags.bulk"
     verbose = gettext_lazy("Bulk edit")
     description = gettext_lazy("Bulk edit flags, labels, or states of strings.")

weblate/addons/generate.py

@@ -28,7 +28,9 @@
 
 
 class GenerateFileAddon(BaseAddon):
-    events = (AddonEvent.EVENT_PRE_COMMIT,)
+    events: set[AddonEvent] = {
+        AddonEvent.EVENT_PRE_COMMIT,
+    }
     name = "weblate.generate.generate"
     verbose = gettext_lazy("Statistics generator")
     description = gettext_lazy(
@@ -59,7 +61,10 @@ def pre_commit(self, translation, author: str, store_hash: bool) -> None:
 
 
 class LocaleGenerateAddonBase(BaseAddon):
-    events = (AddonEvent.EVENT_COMPONENT_UPDATE, AddonEvent.EVENT_DAILY)
+    events: set[AddonEvent] = {
+        AddonEvent.EVENT_COMPONENT_UPDATE,
+        AddonEvent.EVENT_DAILY,
+    }
     multiple = True
     icon = "language.svg"
 

weblate/addons/gettext.py

@@ -28,7 +28,9 @@ class GettextBaseAddon(BaseAddon):
 
 
 class GenerateMoAddon(GettextBaseAddon):
-    events = (AddonEvent.EVENT_PRE_COMMIT,)
+    events: set[AddonEvent] = {
+        AddonEvent.EVENT_PRE_COMMIT,
+    }
     name = "weblate.gettext.mo"
     verbose = gettext_lazy("Generate MO files")
     description = gettext_lazy(
@@ -61,7 +63,7 @@ def pre_commit(self, translation, author: str, store_hash: bool) -> None:
 
 
 class UpdateLinguasAddon(GettextBaseAddon):
-    events = (AddonEvent.EVENT_POST_ADD, AddonEvent.EVENT_DAILY)
+    events: set[AddonEvent] = {AddonEvent.EVENT_POST_ADD, AddonEvent.EVENT_DAILY}
     name = "weblate.gettext.linguas"
     verbose = gettext_lazy("Update LINGUAS file")
     description = gettext_lazy(
@@ -154,7 +156,7 @@ def daily(self, component) -> None:
 
 
 class UpdateConfigureAddon(GettextBaseAddon):
-    events = (AddonEvent.EVENT_POST_ADD, AddonEvent.EVENT_DAILY)
+    events: set[AddonEvent] = {AddonEvent.EVENT_POST_ADD, AddonEvent.EVENT_DAILY}
     name = "weblate.gettext.configure"
     verbose = gettext_lazy('Update ALL_LINGUAS variable in the "configure" file')
     description = gettext_lazy(
@@ -343,7 +345,9 @@ def get_msgmerge_args(self, component: Component):
 
 
 class GettextAuthorComments(GettextBaseAddon):
-    events = (AddonEvent.EVENT_PRE_COMMIT,)
+    events: set[AddonEvent] = {
+        AddonEvent.EVENT_PRE_COMMIT,
+    }
     name = "weblate.gettext.authors"
     verbose = gettext_lazy("Contributors in comment")
     description = gettext_lazy(

weblate/addons/git.py

@@ -5,7 +5,7 @@
 
 from collections import defaultdict
 from itertools import chain
-from typing import TYPE_CHECKING
+from typing import TYPE_CHECKING, cast
 
 from django.utils.translation import gettext_lazy
 
@@ -14,11 +14,11 @@
 from weblate.addons.forms import GitSquashForm
 from weblate.utils.errors import report_error
 from weblate.vcs.base import RepositoryError
+from weblate.vcs.git import GitRepository
 from weblate.vcs.models import VCS_REGISTRY
 
 if TYPE_CHECKING:
     from weblate.trans.models import Component
-    from weblate.vcs.git import GitRepository
 
 
 class GitSquashAddon(BaseAddon):
@@ -29,7 +29,9 @@ class GitSquashAddon(BaseAddon):
     compat = {
         "vcs": VCS_REGISTRY.git_based,
     }
-    events = (AddonEvent.EVENT_POST_COMMIT,)
+    events: set[AddonEvent] = {
+        AddonEvent.EVENT_POST_COMMIT,
+    }
     icon = "compress.svg"
     repo_scope = True
 
@@ -237,7 +239,7 @@ def squash_author(self, component: Component, repository: GitRepository) -> None
             repository.delete_branch(tmp)
 
     def post_commit(self, component: Component, store_hash: bool) -> None:
-        repository = component.repository
+        repository = cast(GitRepository, component.repository)
         branch_updated = False
         with repository.lock:
             # Ensure repository is rebased on current remote prior to squash, otherwise

weblate/addons/migrations/0004_alter_addonactivitylog_event_alter_event_event.py

@@ -0,0 +1,56 @@
+# Copyright © Michal Čihař <[email protected]>
+#
+# SPDX-License-Identifier: GPL-3.0-or-later
+
+# Generated by Django 5.1.3 on 2024-11-26 13:51
+
+from django.db import migrations, models
+
+
+class Migration(migrations.Migration):
+    dependencies = [
+        ("addons", "0003_addonactivitylog"),
+    ]
+
+    operations = [
+        migrations.AlterField(
+            model_name="addonactivitylog",
+            name="event",
+            field=models.IntegerField(
+                choices=[
+                    (1, "Repository post-push"),
+                    (2, "Repository post-update"),
+                    (3, "Repository pre-commit"),
+                    (4, "Repository post-commit"),
+                    (5, "Repository post-add"),
+                    (6, "Unit pre-create"),
+                    (7, "Storage post-load"),
+                    (8, "Unit post-save"),
+                    (9, "Repository pre-update"),
+                    (10, "Repository pre-push"),
+                    (11, "Daily"),
+                    (12, "Component update"),
+                ]
+            ),
+        ),
+        migrations.AlterField(
+            model_name="event",
+            name="event",
+            field=models.IntegerField(
+                choices=[
+                    (1, "Repository post-push"),
+                    (2, "Repository post-update"),
+                    (3, "Repository pre-commit"),
+                    (4, "Repository post-commit"),
+                    (5, "Repository post-add"),
+                    (6, "Unit pre-create"),
+                    (7, "Storage post-load"),
+                    (8, "Unit post-save"),
+                    (9, "Repository pre-update"),
+                    (10, "Repository pre-push"),
+                    (11, "Daily"),
+                    (12, "Component update"),
+                ]
+            ),
+        ),
+    ]

weblate/addons/models.py

@@ -148,7 +148,7 @@ def store_change(self, action) -> None:
             details=self.configuration,
         )
 
-    def configure_events(self, events) -> None:
+    def configure_events(self, events: set[AddonEvent]) -> None:
         for event in events:
             Event.objects.get_or_create(addon=self, event=event)
         self.event_set.exclude(event__in=events).delete()

weblate/addons/properties.py

@@ -135,7 +135,9 @@ def format_file(filename: str, case_sensitive: bool) -> bool:
 
 
 class PropertiesSortAddon(BaseAddon):
-    events = (AddonEvent.EVENT_PRE_COMMIT,)
+    events: set[AddonEvent] = {
+        AddonEvent.EVENT_PRE_COMMIT,
+    }
     name = "weblate.properties.sort"
     verbose = gettext_lazy("Format the Java properties file")
     description = gettext_lazy("Formats and sorts the Java properties file.")

weblate/addons/removal.py

@@ -16,7 +16,9 @@
 
 class RemovalAddon(BaseAddon):
     project_scope = True
-    events = (AddonEvent.EVENT_DAILY,)
+    events: set[AddonEvent] = {
+        AddonEvent.EVENT_DAILY,
+    }
     settings_form = RemoveForm
     icon = "delete.svg"