core/jobs/registry.py - develop - githubmirror/oppia

core/jobs/registry.py
146 строк5 KB
NITISH KUMAR
[GSoC 2026] M2.4 - Fix part of #24716: Adds cron job for enforcing web feedback data retention policies. (#26824)
11 авг 2026, 06:06
11 авг 2026, 06:06af6dce7
# coding: utf-8
#
# Copyright 2021 The Oppia Authors. All Rights Reserved.
#
# Licensed under the Apache License, Version 2.0 (the "License");
# you may not use this file except in compliance with the License.
# You may obtain a copy of the License at
#
#      http://www.apache.org/licenses/LICENSE-2.0
#
# Unless required by applicable law or agreed to in writing, software
# distributed under the License is distributed on an "AS-IS" BASIS,
# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
# See the License for the specific language governing permissions and
# limitations under the License.

"""Entry point for accessing the full collection of Apache Beam jobs.

This module imports all of the "jobs.*_jobs" modules so that they can be fetched
from the JobMetaclass which keeps track of them all.

TODO(#11475): Add lint checks that ensure all "jobs.*_jobs" modules are imported
into this file.
"""

from __future__ import annotations

from core.jobs import base_jobs

# IMPORTANT: These modules MUST be imported! DO NOT DELETE!
# We need each module to execute so that the class definitions trigger the
# metaclass logic. That is, the following code:
#
#     class FooJob(base_jobs.JobBase):
#         pass
#
# Will execute the following code:
#
#     JobMetaclass.__new__('FooJob', (base_jobs.JobBase,), {})
#
# We need this to happen for every job in this registry file, because the
# registry depends on JobMetaclass to handle the responsibility of keeping track
# of every job.
from core.jobs.batch_jobs import (  # pylint: disable=unused-import
    audit_non_existent_threads_messages_jobs,
    audit_stories_with_disconnected_node_ids_job,
    audit_threads_with_missing_suggestions_jobs,
    blog_author_details_migration_jobs,
    blog_post_search_indexing_jobs,
    blog_validation_jobs,
    classroom_migration_jobs,
    cleanup_duplicate_translation_suggestions_jobs,
    cloud_task_run_migration_jobs,
    collection_info_jobs,
    contributor_admin_stats_jobs,
    delete_duplicate_content_ids_jobs,
    dummy_jobs,
    email_deletion_jobs,
    exp_migration_jobs,
    exp_search_indexing_jobs,
    exploration_voiceover_sync_jobs,
    firebase_server_sync_jobs,
    math_interactions_audit_jobs,
    model_validation_jobs,
    number_with_units_audit_jobs,
    opportunity_management_jobs,
    pinned_opportunity_backfill_jobs,
    question_migration_jobs,
    recover_orphaned_translations_jobs,
    skill_inspection_jobs,
    skill_migration_jobs,
    story_migration_jobs,
    subtopic_migration_jobs,
    suggestion_migration_jobs,
    suggestion_stats_computation_jobs,
    synthesize_voiceover_by_language_accent_jobs,
    topic_migration_jobs,
    translation_audit_jobs,
    translation_migration_jobs,
    translation_opportunity_backfill_jobs,
    user_bios_change_jobs,
    user_stats_computation_jobs,
    user_validation_jobs,
    voiceover_synthesis_jobs,
    web_feedback_cleanup_jobs,
)

from typing import List, Type

from core.jobs.batch_jobs import (  # pylint: disable=unused-import  # isort: skip
    exp_recommendation_computation_jobs,
)
from core.jobs.batch_jobs import (  # pylint: disable=unused-import  # isort: skip
    suggestion_edit_state_content_deletion_jobs,
)
from core.jobs.batch_jobs import (  # pylint: disable=unused-import  # isort: skip
    exp_version_history_computation_job,
)
from core.jobs.batch_jobs import (  # pylint: disable=unused-import  # isort: skip
    rejecting_suggestion_for_invalid_content_ids_jobs,
)
from core.jobs.batch_jobs import (  # pylint: disable=unused-import  # isort: skip
    remove_profile_picture_data_url_field_jobs,
)
from core.jobs.batch_jobs import (  # pylint: disable=unused-import  # isort: skip
    story_node_jobs,
)
from core.jobs.batch_jobs import (  # pylint: disable=unused-import  # isort: skip
    audit_topic_related_models_relation_jobs,
)
from core.jobs.batch_jobs import (  # pylint: disable=unused-import  # isort: skip
    reject_invalid_suggestion_and_delete_invalid_translation_jobs,
)
from core.jobs.batch_jobs import (  # pylint: disable=unused-import  # isort: skip
    missing_translation_images_repair_jobs,
)


def get_all_jobs() -> List[Type[base_jobs.JobBase]]:
    """Returns all jobs that have inherited from the JobBase class.

    Returns:
        list(class). The classes that have inherited from JobBase.
    """
    return base_jobs.JobMetaclass.get_all_jobs()


def get_all_job_names() -> List[str]:
    """Returns the names of all jobs that have inherited from the JobBase class.

    Returns:
        list(str). The names of all classes that hae inherited from JobBase.
    """
    return base_jobs.JobMetaclass.get_all_job_names()


def get_job_class_by_name(job_name: str) -> Type[base_jobs.JobBase]:
    """Returns the class associated with the given job name.

    Args:
        job_name: str. The name of the job to return.

    Returns:
        class. The class associated to the given job name.
    """
    return base_jobs.JobMetaclass.get_job_class_by_name(job_name)