Debian Codegraph @

django/contrib/sites/managers.py

raw
1 from django.conf import settings
2 from django.core import checks
3 from django.core.exceptions import FieldDoesNotExist
4 from django.db import models
5
6
7 class CurrentSiteManager(models.Manager):
8 "Use this to limit objects to those associated with the current site."
9
10 use_in_migrations = True
11
12 def __init__(self, field_name=None):
13 super().__init__()
14 self.__field_name = field_name
15
16 def check(self, **kwargs):
17 errors = super().check(**kwargs)
18 errors.extend(self._check_field_name())
19 return errors
20
21 def _check_field_name(self):
22 field_name = self._get_field_name()
23 try:
24 field = self.model._meta.get_field(field_name)
25 except FieldDoesNotExist:
26 return [
27 checks.Error(
28 "CurrentSiteManager could not find a field named '%s'."
29 % field_name,
30 obj=self,
31 id="sites.E001",
32 )
33 ]
34
35 if not field.many_to_many and not isinstance(field, (models.ForeignKey)):
36 return [
37 checks.Error(
38 "CurrentSiteManager cannot use '%s.%s' as it is not a foreign key "
39 "or a many-to-many field."
40 % (self.model._meta.object_name, field_name),
41 obj=self,
42 id="sites.E002",
43 )
44 ]
45
46 return []
47
48 def _get_field_name(self):
49 """Return self.__field_name or 'site' or 'sites'."""
50
51 if not self.__field_name:
52 try:
53 self.model._meta.get_field("site")
54 except FieldDoesNotExist:
55 self.__field_name = "sites"
56 else:
57 self.__field_name = "site"
58 return self.__field_name
59
60 def get_queryset(self):
61 return (
62 super()
63 .get_queryset()
64 .filter(**{self._get_field_name() + "__id": settings.SITE_ID})
65 )