oncall-engine/engine/apps/api/views
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
alert_group.py remove references to AlertGroup.is_archived and AlertGroup.unarchived_objects (#2524) 2023-07-18 11:48:34 +00:00
alert_receive_channel.py Improve APIs for creating/updating direct paging integrations (#2603) 2023-07-21 10:01:58 +00:00
alert_receive_channel_template.py Fix resource duplication caused by available_teams_lookup_args (#1593) 2023-03-22 15:43:32 +08:00
alerts.py Add alert detail view (#385) 2022-08-19 14:03:07 +05:00
auth.py Reworked slack login pipeline errors (#2526) 2023-07-18 13:31:11 +00:00
channel_filter.py Fix duplicate orders on routes and escalation policies (#2568) 2023-07-18 17:17:53 +00:00
custom_button.py Fix MultipleObjectsReturned error on webhook endpoints (#1996) 2023-05-23 16:23:06 +00:00
escalation_chain.py Make viewset actions more consistent (#2120) 2023-06-07 12:10:53 +00:00
escalation_policy.py Fix duplicate orders on routes and escalation policies (#2568) 2023-07-18 17:17:53 +00:00
features.py apps.get_model -> import (#2619) 2023-07-25 09:43:23 +00:00
integration_heartbeat.py Fix resource duplication caused by available_teams_lookup_args (#1593) 2023-03-22 15:43:32 +08:00
live_setting.py Fix Telegram ratelimit on live setting change (#2100) 2023-06-06 15:18:12 +00:00
on_call_shifts.py Add support to update web schedule rotations in-place (#2102) 2023-06-05 17:24:59 +00:00
organization.py apps.get_model -> import (#2619) 2023-07-25 09:43:23 +00:00
paging.py Teams redesign (#1528) 2023-03-22 00:57:20 +08:00
preview_template_options.py Fix of templates api behaviour for public and private api (#1408) 2023-03-01 16:32:15 +08:00
public_api_tokens.py Add RBAC Support (#777) 2022-11-29 09:41:56 +01:00
resolution_note.py Fix resource duplication caused by available_teams_lookup_args (#1593) 2023-03-22 15:43:32 +08:00
route_regex_debugger.py remove references to AlertGroup.is_archived and AlertGroup.unarchived_objects (#2524) 2023-07-18 11:48:34 +00:00
schedule.py fix pagination next and previous links for schedules and integrations GET endpoints (#2467) 2023-07-07 12:24:21 -04:00
shift_swap.py shift swap requests model + CRUD endpoints (#2597) 2023-07-21 19:35:19 +00:00
slack_channel.py make make test command much more robust + address several more backend test warnings (#2115) 2023-06-07 10:51:58 +00:00
slack_team_settings.py Add RBAC Support (#777) 2022-11-29 09:41:56 +01:00
team.py Fix team update (#1794) 2023-04-19 15:22:14 +00:00
telegram_channels.py apps.get_model -> import (#2619) 2023-07-25 09:43:23 +00:00
user.py apps.get_model -> import (#2619) 2023-07-25 09:43:23 +00:00
user_group.py World, meet OnCall! 2022-06-03 08:09:47 -06:00
user_notification_policy.py Fix duplicate orders on routes and escalation policies (#2568) 2023-07-18 17:17:53 +00:00
webhooks.py Webhooks 2 Release (#1830) 2023-07-13 13:53:06 -06:00