forked from pulp/pulp_python
-
Notifications
You must be signed in to change notification settings - Fork 0
Expand file tree
/
Copy pathviewsets.py
More file actions
221 lines (189 loc) · 8.98 KB
/
Copy pathviewsets.py
File metadata and controls
221 lines (189 loc) · 8.98 KB
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
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
from bandersnatch.configuration import BandersnatchConfig
from drf_spectacular.utils import extend_schema
from rest_framework import status
from rest_framework.decorators import action
from rest_framework.response import Response
from pulpcore.plugin import viewsets as core_viewsets
from pulpcore.plugin.actions import ModifyRepositoryActionMixin
from pulpcore.plugin.models import RepositoryVersion
from pulpcore.plugin.serializers import (
AsyncOperationResponseSerializer,
RepositorySyncURLSerializer,
)
from pulpcore.plugin.tasking import dispatch
from pulp_python.app import models as python_models
from pulp_python.app import serializers as python_serializers
from pulp_python.app import tasks
class PythonRepositoryViewSet(core_viewsets.RepositoryViewSet, ModifyRepositoryActionMixin):
"""
PythonRepository represents a single Python repository, to which content can be
synced, added, or removed.
"""
endpoint_name = 'python'
queryset = python_models.PythonRepository.objects.all()
serializer_class = python_serializers.PythonRepositorySerializer
@extend_schema(
summary="Sync from remote",
responses={202: AsyncOperationResponseSerializer}
)
@action(detail=True, methods=['post'], serializer_class=RepositorySyncURLSerializer)
def sync(self, request, pk):
"""
<!-- User-facing documentation, rendered as html-->
Trigger an asynchronous task to sync python content. The sync task will retrieve Python
content from the specified `Remote` and update the specified `Respository`, creating a
new `RepositoryVersion`.
"""
repository = self.get_object()
serializer = RepositorySyncURLSerializer(
data=request.data,
context={'request': request, "repository_pk": pk}
)
serializer.is_valid(raise_exception=True)
remote = serializer.validated_data.get('remote', repository.remote)
mirror = serializer.validated_data.get('mirror')
result = dispatch(
tasks.sync,
[repository, remote],
kwargs={
'remote_pk': str(remote.pk),
'repository_pk': str(repository.pk),
'mirror': mirror
}
)
return core_viewsets.OperationPostponedResponse(result, request)
class PythonRepositoryVersionViewSet(core_viewsets.RepositoryVersionViewSet):
"""
PythonRepositoryVersion represents a single Python repository version.
"""
parent_viewset = PythonRepositoryViewSet
class PythonDistributionViewSet(core_viewsets.DistributionViewSet):
"""
<!-- User-facing documentation, rendered as html-->
Pulp Python Distributions are used to distribute Python content from
<a href="./#tag/Repositories:-Python">Python Repositories</a> or
<a href="./#tag/Publications:-Pypi">Python Publications.</a> <b> Pulp Python
Distributions should not be confused with "Python Distribution" as defined by the Python
community.</b> In Pulp usage, Python content is referred to as <a
href="./#tag/Content:-Packages">Python Package Content.</a>
"""
endpoint_name = 'pypi'
queryset = python_models.PythonDistribution.objects.all()
serializer_class = python_serializers.PythonDistributionSerializer
class PythonPackageContentFilter(core_viewsets.ContentFilter):
"""
FilterSet for PythonPackageContent.
"""
class Meta:
model = python_models.PythonPackageContent
fields = {
'name': ['exact', 'in'],
'author': ['exact', 'in'],
'packagetype': ['exact', 'in'],
'requires_python': ['exact', 'in', "contains"],
'filename': ['exact', 'in', 'contains'],
'keywords': ['in', 'contains'],
}
class PythonPackageSingleArtifactContentUploadViewSet(
core_viewsets.SingleArtifactContentUploadViewSet):
"""
<!-- User-facing documentation, rendered as html-->
PythonPackageContent represents each individually installable Python package. In the Python
ecosystem, this is called a <i>Python Distribution</i>, sometimes (ambiguously) refered to as a
package. In Pulp Python, we refer to it as <i>PythonPackageContent</i>. Each
PythonPackageContent corresponds to a single filename, for example
`pulpcore-3.0.0rc1-py3-none-any.whl` or `pulpcore-3.0.0rc1.tar.gz`.
"""
endpoint_name = 'packages'
queryset = python_models.PythonPackageContent.objects.all()
serializer_class = python_serializers.PythonPackageContentSerializer
minimal_serializer_class = python_serializers.MinimalPythonPackageContentSerializer
filterset_class = PythonPackageContentFilter
class PythonRemoteViewSet(core_viewsets.RemoteViewSet):
"""
<!-- User-facing documentation, rendered as html-->
Python Remotes are representations of an <b>external repository</b> of Python content, eg.
PyPI. Fields include upstream repository config. Python Remotes are also used to `sync` from
upstream repositories, and contains sync settings.
"""
endpoint_name = 'python'
queryset = python_models.PythonRemote.objects.all()
serializer_class = python_serializers.PythonRemoteSerializer
@extend_schema(
summary="Create from Bandersnatch",
responses={201: python_serializers.PythonRemoteSerializer},
)
@action(detail=False, methods=["post"],
serializer_class=python_serializers.PythonBanderRemoteSerializer)
def from_bandersnatch(self, request):
"""
<!-- User-facing documentation, rendered as html-->
Takes the fields specified in the Bandersnatch config and creates a Python Remote from it.
"""
serializer = self.get_serializer(data=request.data)
serializer.is_valid(raise_exception=True)
bander_config_file = serializer.validated_data.get("config")
name = serializer.validated_data.get("name")
policy = serializer.validated_data.get("policy")
bander_config = BandersnatchConfig(bander_config_file.file.name).config
data = {"name": name,
"policy": policy,
"url": bander_config.get("mirror", "master"),
"download_concurrency": bander_config.get("mirror", "workers"),
}
enabled = bander_config.get("plugins", "enabled")
enabled_all = "all" in enabled
data["prereleases"] = not (enabled_all or "prerelease_release" in enabled)
# TODO refactor to use a translation object
plugin_filters = { # plugin : (section_name, bander_option, pulp_option)
"allowlist_project": ("allowlist", "packages", "includes"),
"blocklist_project": ("blocklist", "packages", "excludes"),
"regex_release_file_metadata": (
"regex_release_file_metadata",
"any:release_file.packagetype",
"package_types",
),
"latest_release": ("latest_release", "keep", "keep_latest_packages"),
"exclude_platform": ("blocklist", "platforms", "exclude_platforms"),
}
for plugin, options in plugin_filters.items():
if (enabled_all or plugin in enabled) and \
bander_config.has_option(options[0], options[1]):
data[options[2]] = bander_config.get(options[0], options[1]).split()
remote = python_serializers.PythonRemoteSerializer(data=data, context={"request": request})
remote.is_valid(raise_exception=True)
remote.save()
headers = self.get_success_headers(remote.data)
return Response(remote.data, status=status.HTTP_201_CREATED, headers=headers)
class PythonPublicationViewSet(core_viewsets.PublicationViewSet):
"""
<!-- User-facing documentation, rendered as html-->
Python Publications refer to the Python Package content in a repository version, and include
metadata about that content.
"""
endpoint_name = 'pypi'
queryset = python_models.PythonPublication.objects.exclude(complete=False)
serializer_class = python_serializers.PythonPublicationSerializer
@extend_schema(
responses={202: AsyncOperationResponseSerializer}
)
def create(self, request):
"""
<!-- User-facing documentation, rendered as html-->
Dispatches a publish task, which generates metadata that will be used by pip.
"""
serializer = self.get_serializer(data=request.data)
serializer.is_valid(raise_exception=True)
repository_version = serializer.validated_data.get('repository_version')
# Safe because version OR repository is enforced by serializer.
if not repository_version:
repository = serializer.validated_data.get('repository')
repository_version = RepositoryVersion.latest(repository)
result = dispatch(
tasks.publish,
[repository_version.repository],
kwargs={
'repository_version_pk': str(repository_version.pk)
}
)
return core_viewsets.OperationPostponedResponse(result, request)