From 80fc9abb03d4bf04bfdf2231f5a44807356fb3a7 Mon Sep 17 00:00:00 2001 From: Jeremy Stretch Date: Thu, 1 Aug 2024 13:57:19 -0400 Subject: [PATCH] 16927: Move JobRunner from utilities to netbox --- docs/plugins/development/background-jobs.md | 6 +++--- netbox/core/jobs.py | 2 +- netbox/extras/jobs.py | 2 +- netbox/{utilities => netbox}/jobs.py | 0 netbox/{utilities => netbox}/tests/test_jobs.py | 0 5 files changed, 5 insertions(+), 5 deletions(-) rename netbox/{utilities => netbox}/jobs.py (100%) rename netbox/{utilities => netbox}/tests/test_jobs.py (100%) diff --git a/docs/plugins/development/background-jobs.md b/docs/plugins/development/background-jobs.md index 810435268..873390a58 100644 --- a/docs/plugins/development/background-jobs.md +++ b/docs/plugins/development/background-jobs.md @@ -10,12 +10,12 @@ For example, your plugin might need to fetch data from a remote system. Dependin A background job implements a basic [Job](../../models/core/job.md) executor for all kinds of tasks. It has logic implemented to handle the management of the associated job object, rescheduling of periodic jobs in the given interval and error handling. Adding custom jobs is done by subclassing NetBox's `JobRunner` class. -::: utilities.jobs.JobRunner +::: netbox.jobs.JobRunner #### Example ```python title="jobs.py" -from utilities.jobs import JobRunner +from netbox.jobs import JobRunner class MyTestJob(JobRunner): @@ -47,7 +47,7 @@ As described above, jobs can be scheduled for immediate execution or at any late #### Example ```python title="jobs.py" -from utilities.jobs import JobRunner +from netbox.jobs import JobRunner class MyHousekeepingJob(JobRunner): diff --git a/netbox/core/jobs.py b/netbox/core/jobs.py index 1c38cf61f..d2b846398 100644 --- a/netbox/core/jobs.py +++ b/netbox/core/jobs.py @@ -1,7 +1,7 @@ import logging +from netbox.jobs import JobRunner from netbox.search.backends import search_backend -from utilities.jobs import JobRunner from .choices import DataSourceStatusChoices from .exceptions import SyncError from .models import DataSource diff --git a/netbox/extras/jobs.py b/netbox/extras/jobs.py index 2529e9d2b..e540ef439 100644 --- a/netbox/extras/jobs.py +++ b/netbox/extras/jobs.py @@ -8,8 +8,8 @@ from django.utils.translation import gettext as _ from core.signals import clear_events from extras.models import Script as ScriptModel from netbox.context_managers import event_tracking +from netbox.jobs import JobRunner from utilities.exceptions import AbortScript, AbortTransaction -from utilities.jobs import JobRunner from .utils import is_report diff --git a/netbox/utilities/jobs.py b/netbox/netbox/jobs.py similarity index 100% rename from netbox/utilities/jobs.py rename to netbox/netbox/jobs.py diff --git a/netbox/utilities/tests/test_jobs.py b/netbox/netbox/tests/test_jobs.py similarity index 100% rename from netbox/utilities/tests/test_jobs.py rename to netbox/netbox/tests/test_jobs.py