# 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)
45 lines
1.6 KiB
Python
45 lines
1.6 KiB
Python
import logging
|
|
|
|
from django.db import models
|
|
|
|
logger = logging.getLogger(__name__)
|
|
|
|
|
|
def sync_regions(regions: list[dict]):
|
|
from apps.user_management.models import Region
|
|
|
|
gcom_regions = {region["slug"]: region for region in regions}
|
|
existing_region_slugs = set(Region.objects.all().values_list("slug", flat=True))
|
|
|
|
# create new regions
|
|
regions_to_create = tuple(
|
|
Region(
|
|
name=region["name"],
|
|
slug=region["slug"],
|
|
oncall_backend_url=region["oncallApiUrl"],
|
|
)
|
|
for region in gcom_regions.values()
|
|
if region["slug"] not in existing_region_slugs
|
|
)
|
|
Region.objects.bulk_create(regions_to_create, batch_size=5000)
|
|
|
|
# delete excess regions
|
|
regions_to_delete = existing_region_slugs - gcom_regions.keys()
|
|
Region.objects.filter(slug__in=regions_to_delete).delete()
|
|
|
|
# update existing regions
|
|
regions_to_update = []
|
|
for region in Region.objects.filter(slug__in=existing_region_slugs):
|
|
gcom_region = gcom_regions[region.slug]
|
|
if region.name != gcom_region["name"] or region.oncall_backend_url != gcom_region["oncallApiUrl"]:
|
|
region.name = gcom_region["name"]
|
|
region.oncall_backend_url = gcom_region["oncallApiUrl"]
|
|
regions_to_update.append(region)
|
|
|
|
Region.objects.bulk_update(regions_to_update, ["name", "oncall_backend_url"], batch_size=5000)
|
|
|
|
|
|
class Region(models.Model):
|
|
name = models.CharField(max_length=300)
|
|
slug = models.CharField(max_length=50, unique=True)
|
|
oncall_backend_url = models.URLField(null=True)
|