oncall-engine/engine/apps/public_api/serializers
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
..
__init__.py World, meet OnCall! 2022-06-03 08:09:47 -06:00
action.py add mypy static type checker to backend codebase (#2151) 2023-06-12 12:50:33 -04:00
alerts.py add several new database columns + emit two new Django signals (#1522) 2023-04-14 09:15:57 +02:00
escalation_chains.py Allow editing assigned team via public api (#1619) 2023-04-05 06:39:30 +00:00
escalation_policies.py Remove unnecessary team checks (#2606) 2023-07-21 15:55:57 +01:00
incidents.py add mypy static type checker to backend codebase (#2151) 2023-06-12 12:50:33 -04:00
integrations.py Improve APIs for creating/updating direct paging integrations (#2603) 2023-07-21 10:01:58 +00:00
integtration_heartbeat.py World, meet OnCall! 2022-06-03 08:09:47 -06:00
maintenance.py add mypy static type checker to backend codebase (#2151) 2023-06-12 12:50:33 -04:00
on_call_shifts.py shift swap requests model + CRUD endpoints (#2597) 2023-07-21 19:35:19 +00:00
organizations.py remove organization maintenance mode + fix integration maintenance mode (#2511) 2023-07-12 16:41:44 -04:00
personal_notification_rules.py Fix duplicate orders on routes and escalation policies (#2568) 2023-07-18 17:17:53 +00:00
resolution_notes.py remove references to AlertGroup.is_archived and AlertGroup.unarchived_objects (#2524) 2023-07-18 11:48:34 +00:00
routes.py apps.get_model -> import (#2619) 2023-07-25 09:43:23 +00:00
schedules_base.py apps.get_model -> import (#2619) 2023-07-25 09:43:23 +00:00
schedules_calendar.py shift swap requests model + CRUD endpoints (#2597) 2023-07-21 19:35:19 +00:00
schedules_ical.py Allow editing assigned team via public api (#1619) 2023-04-05 06:39:30 +00:00
schedules_polymorphic.py Initial web schedule model and serializers. Add override shift type. 2022-07-05 12:41:55 -03:00
schedules_web.py shift swap requests model + CRUD endpoints (#2597) 2023-07-21 19:35:19 +00:00
slack_channel.py World, meet OnCall! 2022-06-03 08:09:47 -06:00
teams.py World, meet OnCall! 2022-06-03 08:09:47 -06:00
user_groups.py World, meet OnCall! 2022-06-03 08:09:47 -06:00
users.py Add RBAC Support (#777) 2022-11-29 09:41:56 +01:00