forked from readthedocs/readthedocs.org
/
managers.py
182 lines (128 loc) · 4.82 KB
/
managers.py
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
# -*- coding: utf-8 -*-
"""Build and Version class model Managers."""
import logging
from django.db import models
from django.core.exceptions import ObjectDoesNotExist
from readthedocs.core.utils.extend import (
SettingsOverrideObject,
get_override_class,
)
from .constants import (
BRANCH,
LATEST,
LATEST_VERBOSE_NAME,
STABLE,
STABLE_VERBOSE_NAME,
TAG,
EXTERNAL,
)
from .querysets import VersionQuerySet, BuildQuerySet
log = logging.getLogger(__name__)
__all__ = ['VersionManager']
class VersionManagerBase(models.Manager):
"""
Version manager for manager only queries.
For queries not suitable for the :py:class:`VersionQuerySet`, such as create
queries.
"""
@classmethod
def from_queryset(cls, queryset_class, class_name=None):
# This is overridden because :py:meth:`models.Manager.from_queryset`
# uses `inspect` to retrieve the class methods, and the proxy class has
# no direct members.
queryset_class = get_override_class(
VersionQuerySet,
VersionQuerySet._default_class, # pylint: disable=protected-access
)
return super().from_queryset(queryset_class, class_name)
def create_stable(self, **kwargs):
defaults = {
'slug': STABLE,
'verbose_name': STABLE_VERBOSE_NAME,
'machine': True,
'active': True,
'identifier': STABLE,
'type': TAG,
}
defaults.update(kwargs)
return self.create(**defaults)
def create_latest(self, **kwargs):
defaults = {
'slug': LATEST,
'verbose_name': LATEST_VERBOSE_NAME,
'machine': True,
'active': True,
'identifier': LATEST,
'type': BRANCH,
}
defaults.update(kwargs)
return self.create(**defaults)
def get_object_or_log(self, **kwargs):
"""
Returns Version object or log.
It will return the Version object if found for the given kwargs,
otherwise it will log a warning along with all provided kwargs.
"""
try:
return super().get(**kwargs)
except ObjectDoesNotExist:
log.warning('Version not found for given kwargs. %s' % kwargs)
class InternalVersionManagerBase(VersionManagerBase):
"""
Version manager that only includes internal version.
It will exclude pull request/merge request versions from the queries
and only include BRANCH, TAG, UNKONWN type Versions.
"""
def get_queryset(self):
return super().get_queryset().exclude(type=EXTERNAL)
class ExternalVersionManagerBase(VersionManagerBase):
"""
Version manager that only includes external version.
It will only include pull request/merge request Versions in the queries.
"""
def get_queryset(self):
return super().get_queryset().filter(type=EXTERNAL)
class VersionManager(SettingsOverrideObject):
_default_class = VersionManagerBase
_override_setting = 'VERSION_MANAGER'
class InternalVersionManager(SettingsOverrideObject):
_default_class = InternalVersionManagerBase
class ExternalVersionManager(SettingsOverrideObject):
_default_class = ExternalVersionManagerBase
class BuildManagerBase(models.Manager):
"""
Build manager for manager only queries.
For creating different Managers.
"""
@classmethod
def from_queryset(cls, queryset_class, class_name=None):
# This is overridden because :py:meth:`models.Manager.from_queryset`
# uses `inspect` to retrieve the class methods, and the proxy class has
# no direct members.
queryset_class = get_override_class(
BuildQuerySet,
BuildQuerySet._default_class, # pylint: disable=protected-access
)
return super().from_queryset(queryset_class, class_name)
class InternalBuildManagerBase(BuildManagerBase):
"""
Build manager that only includes internal version builds.
It will exclude pull request/merge request version builds from the queries
and only include BRANCH, TAG, UNKONWN type Version builds.
"""
def get_queryset(self):
return super().get_queryset().exclude(version__type=EXTERNAL)
class ExternalBuildManagerBase(BuildManagerBase):
"""
Build manager that only includes external version builds.
It will only include pull request/merge request version builds in the queries.
"""
def get_queryset(self):
return super().get_queryset().filter(version__type=EXTERNAL)
class BuildManager(SettingsOverrideObject):
_default_class = BuildManagerBase
_override_setting = 'BUILD_MANAGER'
class InternalBuildManager(SettingsOverrideObject):
_default_class = InternalBuildManagerBase
class ExternalBuildManager(SettingsOverrideObject):
_default_class = ExternalBuildManagerBase