oncall-engine/engine/apps/schedules/tasks/drop_cached_ical.py
Vadim Stepanov b2f4ffb98a
apps.get_model -> import (#2619)
# What this PR does

Remove
[`apps.get_model`](https://docs.djangoproject.com/en/3.2/ref/applications/#django.apps.apps.get_model)
invocations and use inline `import` statements in places where models
are imported within functions/methods to avoid circular imports.

I believe `import` statements are more appropriate for most use cases as
they allow for better static code analysis & formatting, and solve the
issue of circular imports without being unnecessarily dynamic as
`apps.get_model`. With `import` statements, it's possible to:

- Jump to model definitions in most IDEs
- Automatically sort inline imports with `isort`
- Find import errors faster/easier (most IDEs highlight broken imports)
- Have more consistency across regular & inline imports when importing
models

This PR also adds a flake8 rule to ban imports of `django.apps.apps`, so
it's harder to use `apps.get_model` by mistake (it's possible to ignore
this rule by using `# noqa: I251`). The rule is not enforced on
directories with migration files, because `apps.get_model` is often used
to get a historical state of a model, which is useful when writing
migrations ([see this SO answer for more
details](https://stackoverflow.com/a/37769213)). So `apps.get_model` is
considered OK in migrations (even necessary in some cases).

## Checklist

- [x] Unit, integration, and e2e (if applicable) tests updated
- [x] Documentation added (or `pr:no public docs` PR label added if not
required)
- [x] `CHANGELOG.md` updated (or `pr:no changelog` PR label added if not
required)
2023-07-25 09:43:23 +00:00

34 lines
1.4 KiB
Python

from celery.utils.log import get_task_logger
from common.custom_celery_tasks import shared_dedicated_queue_retry_task
from .refresh_ical_files import refresh_ical_final_schedule
task_logger = get_task_logger(__name__)
@shared_dedicated_queue_retry_task(autoretry_for=(Exception,), retry_backoff=True, max_retries=1)
def drop_cached_ical_task(schedule_pk):
from apps.schedules.models import OnCallSchedule
task_logger.info(f"Start drop_cached_ical_task for schedule {schedule_pk}")
try:
schedule = OnCallSchedule.objects.get(pk=schedule_pk)
schedule.drop_cached_ical()
except OnCallSchedule.DoesNotExist:
task_logger.info(f"Tried to drop_cached_ical_task for non-existing schedule {schedule_pk}")
else:
# queue a refresh for final schedule
refresh_ical_final_schedule.apply_async((schedule_pk,))
task_logger.info(f"Finish drop_cached_ical_task for schedule {schedule_pk}")
@shared_dedicated_queue_retry_task(autoretry_for=(Exception,), retry_backoff=True, max_retries=1)
def drop_cached_ical_for_custom_events_for_organization(organization_id):
from apps.schedules.models import OnCallScheduleCalendar
for schedule in OnCallScheduleCalendar.objects.filter(organization_id=organization_id):
drop_cached_ical_task.apply_async(
(schedule.pk,),
)
task_logger.info(f"drop cached ica for org_id {organization_id}")