oncall-engine/engine/apps/public_api
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
..
serializers apps.get_model -> import (#2619) 2023-07-25 09:43:23 +00:00
tests Improve APIs for creating/updating direct paging integrations (#2603) 2023-07-21 10:01:58 +00:00
throttlers Add ratelimit for phone number verification (#1354) 2023-02-21 16:47:52 +08:00
views remove references to AlertGroup.is_archived and AlertGroup.unarchived_objects (#2524) 2023-07-18 11:48:34 +00:00
__init__.py World, meet OnCall! 2022-06-03 08:09:47 -06:00
constants.py Remove demo token related code/logic 2022-06-09 09:16:10 -03:00
custom_renderers.py World, meet OnCall! 2022-06-03 08:09:47 -06:00
helpers.py Remove demo token related code/logic 2022-06-09 09:16:10 -03:00
tf_sync.py Sync users and teams on tf requests (#1180) 2023-01-24 13:44:07 +08:00
urls.py First touch on grafana cloud notifications 2022-06-03 19:47:25 +04:00