oncall-engine/engine
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
..
apps apps.get_model -> import (#2619) 2023-07-25 09:43:23 +00:00
common shift swap requests model + CRUD endpoints (#2597) 2023-07-21 19:35:19 +00:00
config_integrations Unhide direct paging integration (#2483) 2023-07-13 13:41:31 +08:00
engine apps.get_model -> import (#2619) 2023-07-25 09:43:23 +00:00
settings remove deprecated call_ack_url celery task (#2545) 2023-07-25 02:50:18 -04:00
static/images World, meet OnCall! 2022-06-03 08:09:47 -06:00
type_stubs/icalendar continue addressing mypy violations (#2170) 2023-06-27 10:23:08 +00:00
.dockerignore One startup command to rule them all (#760) 2022-11-07 16:34:43 +01:00
.gitignore modify push notification settings + use fcm-django library (#998) 2022-12-20 12:41:34 +01:00
celery_with_exporter.sh Add flag to debug logs (#912) 2022-11-29 11:16:42 +08:00
conftest.py Remove unnecessary signal (#2030) 2023-07-25 07:21:41 +00:00
Dockerfile install requirements-dev.txt dependencies oncall docker image dev target (#2284) 2023-06-19 05:50:59 -04:00
manage.py World, meet OnCall! 2022-06-03 08:09:47 -06:00
pyproject.toml fix import mypy errors (#2407) 2023-07-14 06:00:02 -04:00
requirements-dev.txt re-enable mypy GitHub Actions CI job (#2390) 2023-06-29 14:01:52 +00:00
requirements.txt Fix duplicate orders on routes and escalation policies (#2568) 2023-07-18 17:17:53 +00:00
tox.ini apps.get_model -> import (#2619) 2023-07-25 09:43:23 +00:00
uwsgi.ini Run containers as a non-root user (#2053) 2023-06-08 07:12:00 +00:00
wait_for_test_mysql_start.sh Revert "Revert "speed up ci builds from 15 to <7 minutes"" (#1643) 2023-03-28 09:34:03 +02:00