kaggle 1.8.0__py3-none-any.whl → 1.8.3__py3-none-any.whl

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
Files changed (128) hide show
  1. kaggle/__init__.py +1 -1
  2. kaggle/api/kaggle_api_extended.py +24 -2
  3. {kaggle-1.8.0.dist-info → kaggle-1.8.3.dist-info}/METADATA +4 -3
  4. kaggle-1.8.3.dist-info/RECORD +28 -0
  5. {kaggle-1.8.0.dist-info → kaggle-1.8.3.dist-info}/WHEEL +1 -1
  6. kaggle-1.8.0.dist-info/RECORD +0 -148
  7. kagglesdk/LICENSE +0 -201
  8. kagglesdk/__init__.py +0 -6
  9. kagglesdk/admin/__init__.py +0 -0
  10. kagglesdk/admin/services/__init__.py +0 -0
  11. kagglesdk/admin/services/inbox_file_service.py +0 -22
  12. kagglesdk/admin/types/__init__.py +0 -0
  13. kagglesdk/admin/types/inbox_file_service.py +0 -74
  14. kagglesdk/benchmarks/__init__.py +0 -0
  15. kagglesdk/benchmarks/services/__init__.py +0 -0
  16. kagglesdk/benchmarks/services/benchmarks_api_service.py +0 -19
  17. kagglesdk/benchmarks/types/__init__.py +0 -0
  18. kagglesdk/benchmarks/types/benchmark_types.py +0 -307
  19. kagglesdk/benchmarks/types/benchmarks_api_service.py +0 -243
  20. kagglesdk/blobs/__init__.py +0 -0
  21. kagglesdk/blobs/services/__init__.py +0 -0
  22. kagglesdk/blobs/services/blob_api_service.py +0 -25
  23. kagglesdk/blobs/types/__init__.py +0 -0
  24. kagglesdk/blobs/types/blob_api_service.py +0 -177
  25. kagglesdk/common/__init__.py +0 -0
  26. kagglesdk/common/services/__init__.py +0 -0
  27. kagglesdk/common/services/operations_service.py +0 -46
  28. kagglesdk/common/types/__init__.py +0 -0
  29. kagglesdk/common/types/file_download.py +0 -102
  30. kagglesdk/common/types/http_redirect.py +0 -105
  31. kagglesdk/common/types/operations.py +0 -194
  32. kagglesdk/common/types/operations_service.py +0 -48
  33. kagglesdk/community/__init__.py +0 -0
  34. kagglesdk/community/types/__init__.py +0 -0
  35. kagglesdk/community/types/content_enums.py +0 -44
  36. kagglesdk/community/types/organization.py +0 -410
  37. kagglesdk/competitions/__init__.py +0 -0
  38. kagglesdk/competitions/services/__init__.py +0 -0
  39. kagglesdk/competitions/services/competition_api_service.py +0 -178
  40. kagglesdk/competitions/types/__init__.py +0 -0
  41. kagglesdk/competitions/types/competition.py +0 -14
  42. kagglesdk/competitions/types/competition_api_service.py +0 -2393
  43. kagglesdk/competitions/types/competition_enums.py +0 -53
  44. kagglesdk/competitions/types/search_competitions.py +0 -28
  45. kagglesdk/competitions/types/submission_status.py +0 -9
  46. kagglesdk/datasets/__init__.py +0 -0
  47. kagglesdk/datasets/databundles/__init__.py +0 -0
  48. kagglesdk/datasets/databundles/types/__init__.py +0 -0
  49. kagglesdk/datasets/databundles/types/databundle_api_types.py +0 -540
  50. kagglesdk/datasets/services/__init__.py +0 -0
  51. kagglesdk/datasets/services/dataset_api_service.py +0 -195
  52. kagglesdk/datasets/types/__init__.py +0 -0
  53. kagglesdk/datasets/types/dataset_api_service.py +0 -3047
  54. kagglesdk/datasets/types/dataset_enums.py +0 -103
  55. kagglesdk/datasets/types/dataset_service.py +0 -145
  56. kagglesdk/datasets/types/dataset_types.py +0 -646
  57. kagglesdk/datasets/types/search_datasets.py +0 -6
  58. kagglesdk/discussions/__init__.py +0 -0
  59. kagglesdk/discussions/types/__init__.py +0 -0
  60. kagglesdk/discussions/types/search_discussions.py +0 -43
  61. kagglesdk/discussions/types/writeup_enums.py +0 -11
  62. kagglesdk/education/__init__.py +0 -0
  63. kagglesdk/education/services/__init__.py +0 -0
  64. kagglesdk/education/services/education_api_service.py +0 -19
  65. kagglesdk/education/types/__init__.py +0 -0
  66. kagglesdk/education/types/education_api_service.py +0 -248
  67. kagglesdk/education/types/education_service.py +0 -139
  68. kagglesdk/kaggle_client.py +0 -101
  69. kagglesdk/kaggle_creds.py +0 -148
  70. kagglesdk/kaggle_env.py +0 -104
  71. kagglesdk/kaggle_http_client.py +0 -261
  72. kagglesdk/kaggle_oauth.py +0 -200
  73. kagglesdk/kaggle_object.py +0 -344
  74. kagglesdk/kernels/__init__.py +0 -0
  75. kagglesdk/kernels/services/__init__.py +0 -0
  76. kagglesdk/kernels/services/kernels_api_service.py +0 -146
  77. kagglesdk/kernels/types/__init__.py +0 -0
  78. kagglesdk/kernels/types/kernels_api_service.py +0 -2451
  79. kagglesdk/kernels/types/kernels_enums.py +0 -39
  80. kagglesdk/kernels/types/search_kernels.py +0 -6
  81. kagglesdk/licenses/__init__.py +0 -0
  82. kagglesdk/licenses/types/__init__.py +0 -0
  83. kagglesdk/licenses/types/licenses_types.py +0 -182
  84. kagglesdk/models/__init__.py +0 -0
  85. kagglesdk/models/services/__init__.py +0 -0
  86. kagglesdk/models/services/model_api_service.py +0 -280
  87. kagglesdk/models/services/model_service.py +0 -19
  88. kagglesdk/models/types/__init__.py +0 -0
  89. kagglesdk/models/types/model_api_service.py +0 -4069
  90. kagglesdk/models/types/model_enums.py +0 -68
  91. kagglesdk/models/types/model_service.py +0 -275
  92. kagglesdk/models/types/model_types.py +0 -1338
  93. kagglesdk/models/types/search_models.py +0 -8
  94. kagglesdk/search/__init__.py +0 -0
  95. kagglesdk/search/services/__init__.py +0 -0
  96. kagglesdk/search/services/search_api_service.py +0 -19
  97. kagglesdk/search/types/__init__.py +0 -0
  98. kagglesdk/search/types/search_api_service.py +0 -2435
  99. kagglesdk/search/types/search_content_shared.py +0 -50
  100. kagglesdk/search/types/search_enums.py +0 -45
  101. kagglesdk/search/types/search_service.py +0 -303
  102. kagglesdk/security/__init__.py +0 -0
  103. kagglesdk/security/services/__init__.py +0 -0
  104. kagglesdk/security/services/iam_service.py +0 -31
  105. kagglesdk/security/services/oauth_service.py +0 -58
  106. kagglesdk/security/types/__init__.py +0 -0
  107. kagglesdk/security/types/authentication.py +0 -171
  108. kagglesdk/security/types/iam_service.py +0 -496
  109. kagglesdk/security/types/oauth_service.py +0 -1181
  110. kagglesdk/security/types/roles.py +0 -8
  111. kagglesdk/security/types/security_types.py +0 -159
  112. kagglesdk/test/__init__.py +0 -0
  113. kagglesdk/test/test_client.py +0 -41
  114. kagglesdk/users/__init__.py +0 -0
  115. kagglesdk/users/services/__init__.py +0 -0
  116. kagglesdk/users/services/account_service.py +0 -31
  117. kagglesdk/users/services/group_api_service.py +0 -31
  118. kagglesdk/users/types/__init__.py +0 -0
  119. kagglesdk/users/types/account_service.py +0 -345
  120. kagglesdk/users/types/group_api_service.py +0 -315
  121. kagglesdk/users/types/group_types.py +0 -165
  122. kagglesdk/users/types/groups_enum.py +0 -8
  123. kagglesdk/users/types/progression_service.py +0 -9
  124. kagglesdk/users/types/search_users.py +0 -23
  125. kagglesdk/users/types/user_avatar.py +0 -226
  126. kagglesdk/users/types/users_enums.py +0 -22
  127. {kaggle-1.8.0.dist-info → kaggle-1.8.3.dist-info}/entry_points.txt +0 -0
  128. {kaggle-1.8.0.dist-info → kaggle-1.8.3.dist-info}/licenses/LICENSE.txt +0 -0
@@ -1,2393 +0,0 @@
1
- from datetime import datetime
2
- from kagglesdk.competitions.types.competition_enums import CompetitionListTab, CompetitionSortBy, HostSegment, SubmissionGroup, SubmissionSortBy
3
- from kagglesdk.competitions.types.submission_status import SubmissionStatus
4
- from kagglesdk.kaggle_object import *
5
- from typing import Optional, List
6
-
7
- class ApiCategory(KaggleObject):
8
- r"""
9
- TODO(erdalsivri): Consider reusing with Kaggle.Sdk.Datasets.ApiCategory.
10
-
11
- Attributes:
12
- ref (str)
13
- name (str)
14
- description (str)
15
- full_path (str)
16
- competition_count (int)
17
- dataset_count (int)
18
- script_count (int)
19
- total_count (int)
20
- """
21
-
22
- def __init__(self):
23
- self._ref = ""
24
- self._name = None
25
- self._description = None
26
- self._full_path = None
27
- self._competition_count = 0
28
- self._dataset_count = 0
29
- self._script_count = 0
30
- self._total_count = 0
31
- self._freeze()
32
-
33
- @property
34
- def ref(self) -> str:
35
- return self._ref
36
-
37
- @ref.setter
38
- def ref(self, ref: str):
39
- if ref is None:
40
- del self.ref
41
- return
42
- if not isinstance(ref, str):
43
- raise TypeError('ref must be of type str')
44
- self._ref = ref
45
-
46
- @property
47
- def name(self) -> str:
48
- return self._name or ""
49
-
50
- @name.setter
51
- def name(self, name: Optional[str]):
52
- if name is None:
53
- del self.name
54
- return
55
- if not isinstance(name, str):
56
- raise TypeError('name must be of type str')
57
- self._name = name
58
-
59
- @property
60
- def description(self) -> str:
61
- return self._description or ""
62
-
63
- @description.setter
64
- def description(self, description: Optional[str]):
65
- if description is None:
66
- del self.description
67
- return
68
- if not isinstance(description, str):
69
- raise TypeError('description must be of type str')
70
- self._description = description
71
-
72
- @property
73
- def full_path(self) -> str:
74
- return self._full_path or ""
75
-
76
- @full_path.setter
77
- def full_path(self, full_path: Optional[str]):
78
- if full_path is None:
79
- del self.full_path
80
- return
81
- if not isinstance(full_path, str):
82
- raise TypeError('full_path must be of type str')
83
- self._full_path = full_path
84
-
85
- @property
86
- def competition_count(self) -> int:
87
- return self._competition_count
88
-
89
- @competition_count.setter
90
- def competition_count(self, competition_count: int):
91
- if competition_count is None:
92
- del self.competition_count
93
- return
94
- if not isinstance(competition_count, int):
95
- raise TypeError('competition_count must be of type int')
96
- self._competition_count = competition_count
97
-
98
- @property
99
- def dataset_count(self) -> int:
100
- return self._dataset_count
101
-
102
- @dataset_count.setter
103
- def dataset_count(self, dataset_count: int):
104
- if dataset_count is None:
105
- del self.dataset_count
106
- return
107
- if not isinstance(dataset_count, int):
108
- raise TypeError('dataset_count must be of type int')
109
- self._dataset_count = dataset_count
110
-
111
- @property
112
- def script_count(self) -> int:
113
- return self._script_count
114
-
115
- @script_count.setter
116
- def script_count(self, script_count: int):
117
- if script_count is None:
118
- del self.script_count
119
- return
120
- if not isinstance(script_count, int):
121
- raise TypeError('script_count must be of type int')
122
- self._script_count = script_count
123
-
124
- @property
125
- def total_count(self) -> int:
126
- return self._total_count
127
-
128
- @total_count.setter
129
- def total_count(self, total_count: int):
130
- if total_count is None:
131
- del self.total_count
132
- return
133
- if not isinstance(total_count, int):
134
- raise TypeError('total_count must be of type int')
135
- self._total_count = total_count
136
-
137
-
138
- class ApiCompetition(KaggleObject):
139
- r"""
140
- Attributes:
141
- id (int)
142
- ref (str)
143
- title (str)
144
- url (str)
145
- description (str)
146
- organization_name (str)
147
- organization_ref (str)
148
- category (str)
149
- reward (str)
150
- tags (ApiCategory)
151
- deadline (datetime)
152
- kernel_count (int)
153
- team_count (int)
154
- user_has_entered (bool)
155
- user_rank (int)
156
- merger_deadline (datetime)
157
- new_entrant_deadline (datetime)
158
- enabled_date (datetime)
159
- max_daily_submissions (int)
160
- max_team_size (int)
161
- evaluation_metric (str)
162
- awards_points (bool)
163
- is_kernels_submissions_only (bool)
164
- submissions_disabled (bool)
165
- thumbnail_image_url (str)
166
- host_name (str)
167
- """
168
-
169
- def __init__(self):
170
- self._id = 0
171
- self._ref = ""
172
- self._title = None
173
- self._url = None
174
- self._description = None
175
- self._organization_name = None
176
- self._organization_ref = None
177
- self._category = None
178
- self._reward = None
179
- self._tags = []
180
- self._deadline = None
181
- self._kernel_count = 0
182
- self._team_count = 0
183
- self._user_has_entered = False
184
- self._user_rank = None
185
- self._merger_deadline = None
186
- self._new_entrant_deadline = None
187
- self._enabled_date = None
188
- self._max_daily_submissions = 0
189
- self._max_team_size = None
190
- self._evaluation_metric = None
191
- self._awards_points = False
192
- self._is_kernels_submissions_only = False
193
- self._submissions_disabled = False
194
- self._thumbnail_image_url = None
195
- self._host_name = ""
196
- self._freeze()
197
-
198
- @property
199
- def id(self) -> int:
200
- return self._id
201
-
202
- @id.setter
203
- def id(self, id: int):
204
- if id is None:
205
- del self.id
206
- return
207
- if not isinstance(id, int):
208
- raise TypeError('id must be of type int')
209
- self._id = id
210
-
211
- @property
212
- def ref(self) -> str:
213
- return self._ref
214
-
215
- @ref.setter
216
- def ref(self, ref: str):
217
- if ref is None:
218
- del self.ref
219
- return
220
- if not isinstance(ref, str):
221
- raise TypeError('ref must be of type str')
222
- self._ref = ref
223
-
224
- @property
225
- def title(self) -> str:
226
- return self._title or ""
227
-
228
- @title.setter
229
- def title(self, title: Optional[str]):
230
- if title is None:
231
- del self.title
232
- return
233
- if not isinstance(title, str):
234
- raise TypeError('title must be of type str')
235
- self._title = title
236
-
237
- @property
238
- def url(self) -> str:
239
- return self._url or ""
240
-
241
- @url.setter
242
- def url(self, url: Optional[str]):
243
- if url is None:
244
- del self.url
245
- return
246
- if not isinstance(url, str):
247
- raise TypeError('url must be of type str')
248
- self._url = url
249
-
250
- @property
251
- def description(self) -> str:
252
- return self._description or ""
253
-
254
- @description.setter
255
- def description(self, description: Optional[str]):
256
- if description is None:
257
- del self.description
258
- return
259
- if not isinstance(description, str):
260
- raise TypeError('description must be of type str')
261
- self._description = description
262
-
263
- @property
264
- def organization_name(self) -> str:
265
- return self._organization_name or ""
266
-
267
- @organization_name.setter
268
- def organization_name(self, organization_name: Optional[str]):
269
- if organization_name is None:
270
- del self.organization_name
271
- return
272
- if not isinstance(organization_name, str):
273
- raise TypeError('organization_name must be of type str')
274
- self._organization_name = organization_name
275
-
276
- @property
277
- def organization_ref(self) -> str:
278
- return self._organization_ref or ""
279
-
280
- @organization_ref.setter
281
- def organization_ref(self, organization_ref: Optional[str]):
282
- if organization_ref is None:
283
- del self.organization_ref
284
- return
285
- if not isinstance(organization_ref, str):
286
- raise TypeError('organization_ref must be of type str')
287
- self._organization_ref = organization_ref
288
-
289
- @property
290
- def category(self) -> str:
291
- return self._category or ""
292
-
293
- @category.setter
294
- def category(self, category: Optional[str]):
295
- if category is None:
296
- del self.category
297
- return
298
- if not isinstance(category, str):
299
- raise TypeError('category must be of type str')
300
- self._category = category
301
-
302
- @property
303
- def reward(self) -> str:
304
- return self._reward or ""
305
-
306
- @reward.setter
307
- def reward(self, reward: Optional[str]):
308
- if reward is None:
309
- del self.reward
310
- return
311
- if not isinstance(reward, str):
312
- raise TypeError('reward must be of type str')
313
- self._reward = reward
314
-
315
- @property
316
- def tags(self) -> Optional[List[Optional['ApiCategory']]]:
317
- return self._tags
318
-
319
- @tags.setter
320
- def tags(self, tags: Optional[List[Optional['ApiCategory']]]):
321
- if tags is None:
322
- del self.tags
323
- return
324
- if not isinstance(tags, list):
325
- raise TypeError('tags must be of type list')
326
- if not all([isinstance(t, ApiCategory) for t in tags]):
327
- raise TypeError('tags must contain only items of type ApiCategory')
328
- self._tags = tags
329
-
330
- @property
331
- def deadline(self) -> datetime:
332
- return self._deadline
333
-
334
- @deadline.setter
335
- def deadline(self, deadline: datetime):
336
- if deadline is None:
337
- del self.deadline
338
- return
339
- if not isinstance(deadline, datetime):
340
- raise TypeError('deadline must be of type datetime')
341
- self._deadline = deadline
342
-
343
- @property
344
- def kernel_count(self) -> int:
345
- return self._kernel_count
346
-
347
- @kernel_count.setter
348
- def kernel_count(self, kernel_count: int):
349
- if kernel_count is None:
350
- del self.kernel_count
351
- return
352
- if not isinstance(kernel_count, int):
353
- raise TypeError('kernel_count must be of type int')
354
- self._kernel_count = kernel_count
355
-
356
- @property
357
- def team_count(self) -> int:
358
- return self._team_count
359
-
360
- @team_count.setter
361
- def team_count(self, team_count: int):
362
- if team_count is None:
363
- del self.team_count
364
- return
365
- if not isinstance(team_count, int):
366
- raise TypeError('team_count must be of type int')
367
- self._team_count = team_count
368
-
369
- @property
370
- def user_has_entered(self) -> bool:
371
- return self._user_has_entered
372
-
373
- @user_has_entered.setter
374
- def user_has_entered(self, user_has_entered: bool):
375
- if user_has_entered is None:
376
- del self.user_has_entered
377
- return
378
- if not isinstance(user_has_entered, bool):
379
- raise TypeError('user_has_entered must be of type bool')
380
- self._user_has_entered = user_has_entered
381
-
382
- @property
383
- def user_rank(self) -> int:
384
- return self._user_rank or 0
385
-
386
- @user_rank.setter
387
- def user_rank(self, user_rank: Optional[int]):
388
- if user_rank is None:
389
- del self.user_rank
390
- return
391
- if not isinstance(user_rank, int):
392
- raise TypeError('user_rank must be of type int')
393
- self._user_rank = user_rank
394
-
395
- @property
396
- def merger_deadline(self) -> datetime:
397
- return self._merger_deadline
398
-
399
- @merger_deadline.setter
400
- def merger_deadline(self, merger_deadline: datetime):
401
- if merger_deadline is None:
402
- del self.merger_deadline
403
- return
404
- if not isinstance(merger_deadline, datetime):
405
- raise TypeError('merger_deadline must be of type datetime')
406
- self._merger_deadline = merger_deadline
407
-
408
- @property
409
- def new_entrant_deadline(self) -> datetime:
410
- return self._new_entrant_deadline
411
-
412
- @new_entrant_deadline.setter
413
- def new_entrant_deadline(self, new_entrant_deadline: datetime):
414
- if new_entrant_deadline is None:
415
- del self.new_entrant_deadline
416
- return
417
- if not isinstance(new_entrant_deadline, datetime):
418
- raise TypeError('new_entrant_deadline must be of type datetime')
419
- self._new_entrant_deadline = new_entrant_deadline
420
-
421
- @property
422
- def enabled_date(self) -> datetime:
423
- return self._enabled_date
424
-
425
- @enabled_date.setter
426
- def enabled_date(self, enabled_date: datetime):
427
- if enabled_date is None:
428
- del self.enabled_date
429
- return
430
- if not isinstance(enabled_date, datetime):
431
- raise TypeError('enabled_date must be of type datetime')
432
- self._enabled_date = enabled_date
433
-
434
- @property
435
- def max_daily_submissions(self) -> int:
436
- return self._max_daily_submissions
437
-
438
- @max_daily_submissions.setter
439
- def max_daily_submissions(self, max_daily_submissions: int):
440
- if max_daily_submissions is None:
441
- del self.max_daily_submissions
442
- return
443
- if not isinstance(max_daily_submissions, int):
444
- raise TypeError('max_daily_submissions must be of type int')
445
- self._max_daily_submissions = max_daily_submissions
446
-
447
- @property
448
- def max_team_size(self) -> int:
449
- return self._max_team_size or 0
450
-
451
- @max_team_size.setter
452
- def max_team_size(self, max_team_size: Optional[int]):
453
- if max_team_size is None:
454
- del self.max_team_size
455
- return
456
- if not isinstance(max_team_size, int):
457
- raise TypeError('max_team_size must be of type int')
458
- self._max_team_size = max_team_size
459
-
460
- @property
461
- def evaluation_metric(self) -> str:
462
- return self._evaluation_metric or ""
463
-
464
- @evaluation_metric.setter
465
- def evaluation_metric(self, evaluation_metric: Optional[str]):
466
- if evaluation_metric is None:
467
- del self.evaluation_metric
468
- return
469
- if not isinstance(evaluation_metric, str):
470
- raise TypeError('evaluation_metric must be of type str')
471
- self._evaluation_metric = evaluation_metric
472
-
473
- @property
474
- def awards_points(self) -> bool:
475
- return self._awards_points
476
-
477
- @awards_points.setter
478
- def awards_points(self, awards_points: bool):
479
- if awards_points is None:
480
- del self.awards_points
481
- return
482
- if not isinstance(awards_points, bool):
483
- raise TypeError('awards_points must be of type bool')
484
- self._awards_points = awards_points
485
-
486
- @property
487
- def is_kernels_submissions_only(self) -> bool:
488
- return self._is_kernels_submissions_only
489
-
490
- @is_kernels_submissions_only.setter
491
- def is_kernels_submissions_only(self, is_kernels_submissions_only: bool):
492
- if is_kernels_submissions_only is None:
493
- del self.is_kernels_submissions_only
494
- return
495
- if not isinstance(is_kernels_submissions_only, bool):
496
- raise TypeError('is_kernels_submissions_only must be of type bool')
497
- self._is_kernels_submissions_only = is_kernels_submissions_only
498
-
499
- @property
500
- def submissions_disabled(self) -> bool:
501
- return self._submissions_disabled
502
-
503
- @submissions_disabled.setter
504
- def submissions_disabled(self, submissions_disabled: bool):
505
- if submissions_disabled is None:
506
- del self.submissions_disabled
507
- return
508
- if not isinstance(submissions_disabled, bool):
509
- raise TypeError('submissions_disabled must be of type bool')
510
- self._submissions_disabled = submissions_disabled
511
-
512
- @property
513
- def thumbnail_image_url(self) -> str:
514
- return self._thumbnail_image_url or ""
515
-
516
- @thumbnail_image_url.setter
517
- def thumbnail_image_url(self, thumbnail_image_url: Optional[str]):
518
- if thumbnail_image_url is None:
519
- del self.thumbnail_image_url
520
- return
521
- if not isinstance(thumbnail_image_url, str):
522
- raise TypeError('thumbnail_image_url must be of type str')
523
- self._thumbnail_image_url = thumbnail_image_url
524
-
525
- @property
526
- def host_name(self) -> str:
527
- return self._host_name
528
-
529
- @host_name.setter
530
- def host_name(self, host_name: str):
531
- if host_name is None:
532
- del self.host_name
533
- return
534
- if not isinstance(host_name, str):
535
- raise TypeError('host_name must be of type str')
536
- self._host_name = host_name
537
-
538
-
539
- class ApiCreateCodeSubmissionRequest(KaggleObject):
540
- r"""
541
- Attributes:
542
- competition_name (str)
543
- kernel_owner (str)
544
- kernel_slug (str)
545
- kernel_version (int)
546
- file_name (str)
547
- submission_description (str)
548
- """
549
-
550
- def __init__(self):
551
- self._competition_name = ""
552
- self._kernel_owner = ""
553
- self._kernel_slug = ""
554
- self._kernel_version = None
555
- self._file_name = None
556
- self._submission_description = None
557
- self._freeze()
558
-
559
- @property
560
- def competition_name(self) -> str:
561
- return self._competition_name
562
-
563
- @competition_name.setter
564
- def competition_name(self, competition_name: str):
565
- if competition_name is None:
566
- del self.competition_name
567
- return
568
- if not isinstance(competition_name, str):
569
- raise TypeError('competition_name must be of type str')
570
- self._competition_name = competition_name
571
-
572
- @property
573
- def kernel_owner(self) -> str:
574
- return self._kernel_owner
575
-
576
- @kernel_owner.setter
577
- def kernel_owner(self, kernel_owner: str):
578
- if kernel_owner is None:
579
- del self.kernel_owner
580
- return
581
- if not isinstance(kernel_owner, str):
582
- raise TypeError('kernel_owner must be of type str')
583
- self._kernel_owner = kernel_owner
584
-
585
- @property
586
- def kernel_slug(self) -> str:
587
- return self._kernel_slug
588
-
589
- @kernel_slug.setter
590
- def kernel_slug(self, kernel_slug: str):
591
- if kernel_slug is None:
592
- del self.kernel_slug
593
- return
594
- if not isinstance(kernel_slug, str):
595
- raise TypeError('kernel_slug must be of type str')
596
- self._kernel_slug = kernel_slug
597
-
598
- @property
599
- def kernel_version(self) -> int:
600
- return self._kernel_version or 0
601
-
602
- @kernel_version.setter
603
- def kernel_version(self, kernel_version: Optional[int]):
604
- if kernel_version is None:
605
- del self.kernel_version
606
- return
607
- if not isinstance(kernel_version, int):
608
- raise TypeError('kernel_version must be of type int')
609
- self._kernel_version = kernel_version
610
-
611
- @property
612
- def file_name(self) -> str:
613
- return self._file_name or ""
614
-
615
- @file_name.setter
616
- def file_name(self, file_name: Optional[str]):
617
- if file_name is None:
618
- del self.file_name
619
- return
620
- if not isinstance(file_name, str):
621
- raise TypeError('file_name must be of type str')
622
- self._file_name = file_name
623
-
624
- @property
625
- def submission_description(self) -> str:
626
- return self._submission_description or ""
627
-
628
- @submission_description.setter
629
- def submission_description(self, submission_description: Optional[str]):
630
- if submission_description is None:
631
- del self.submission_description
632
- return
633
- if not isinstance(submission_description, str):
634
- raise TypeError('submission_description must be of type str')
635
- self._submission_description = submission_description
636
-
637
- def endpoint(self):
638
- path = '/api/v1/competitions/submissions/submit-notebook/{competition_name}'
639
- return path.format_map(self.to_field_map(self))
640
-
641
-
642
- @staticmethod
643
- def method():
644
- return 'POST'
645
-
646
-
647
- class ApiCreateCodeSubmissionResponse(KaggleObject):
648
- r"""
649
- Attributes:
650
- message (str)
651
- ref (int)
652
- """
653
-
654
- def __init__(self):
655
- self._message = ""
656
- self._ref = 0
657
- self._freeze()
658
-
659
- @property
660
- def message(self) -> str:
661
- return self._message
662
-
663
- @message.setter
664
- def message(self, message: str):
665
- if message is None:
666
- del self.message
667
- return
668
- if not isinstance(message, str):
669
- raise TypeError('message must be of type str')
670
- self._message = message
671
-
672
- @property
673
- def ref(self) -> int:
674
- return self._ref
675
-
676
- @ref.setter
677
- def ref(self, ref: int):
678
- if ref is None:
679
- del self.ref
680
- return
681
- if not isinstance(ref, int):
682
- raise TypeError('ref must be of type int')
683
- self._ref = ref
684
-
685
-
686
- class ApiCreateSubmissionRequest(KaggleObject):
687
- r"""
688
- Attributes:
689
- competition_name (str)
690
- Competition name. Example: 'titanic'.
691
- blob_file_tokens (str)
692
- Token identifying location of uploaded submission file.
693
- submission_description (str)
694
- Description of competition submission.
695
- """
696
-
697
- def __init__(self):
698
- self._competition_name = ""
699
- self._blob_file_tokens = ""
700
- self._submission_description = None
701
- self._freeze()
702
-
703
- @property
704
- def competition_name(self) -> str:
705
- """Competition name. Example: 'titanic'."""
706
- return self._competition_name
707
-
708
- @competition_name.setter
709
- def competition_name(self, competition_name: str):
710
- if competition_name is None:
711
- del self.competition_name
712
- return
713
- if not isinstance(competition_name, str):
714
- raise TypeError('competition_name must be of type str')
715
- self._competition_name = competition_name
716
-
717
- @property
718
- def blob_file_tokens(self) -> str:
719
- """Token identifying location of uploaded submission file."""
720
- return self._blob_file_tokens
721
-
722
- @blob_file_tokens.setter
723
- def blob_file_tokens(self, blob_file_tokens: str):
724
- if blob_file_tokens is None:
725
- del self.blob_file_tokens
726
- return
727
- if not isinstance(blob_file_tokens, str):
728
- raise TypeError('blob_file_tokens must be of type str')
729
- self._blob_file_tokens = blob_file_tokens
730
-
731
- @property
732
- def submission_description(self) -> str:
733
- """Description of competition submission."""
734
- return self._submission_description or ""
735
-
736
- @submission_description.setter
737
- def submission_description(self, submission_description: Optional[str]):
738
- if submission_description is None:
739
- del self.submission_description
740
- return
741
- if not isinstance(submission_description, str):
742
- raise TypeError('submission_description must be of type str')
743
- self._submission_description = submission_description
744
-
745
- def endpoint(self):
746
- path = '/api/v1/competitions/submissions/submit/{competition_name}'
747
- return path.format_map(self.to_field_map(self))
748
-
749
-
750
- @staticmethod
751
- def method():
752
- return 'POST'
753
-
754
-
755
- class ApiCreateSubmissionResponse(KaggleObject):
756
- r"""
757
- Attributes:
758
- message (str)
759
- ref (int)
760
- """
761
-
762
- def __init__(self):
763
- self._message = ""
764
- self._ref = 0
765
- self._freeze()
766
-
767
- @property
768
- def message(self) -> str:
769
- return self._message
770
-
771
- @message.setter
772
- def message(self, message: str):
773
- if message is None:
774
- del self.message
775
- return
776
- if not isinstance(message, str):
777
- raise TypeError('message must be of type str')
778
- self._message = message
779
-
780
- @property
781
- def ref(self) -> int:
782
- return self._ref
783
-
784
- @ref.setter
785
- def ref(self, ref: int):
786
- if ref is None:
787
- del self.ref
788
- return
789
- if not isinstance(ref, int):
790
- raise TypeError('ref must be of type int')
791
- self._ref = ref
792
-
793
-
794
- class ApiDataFile(KaggleObject):
795
- r"""
796
- Attributes:
797
- ref (str)
798
- name (str)
799
- description (str)
800
- total_bytes (int)
801
- url (str)
802
- creation_date (datetime)
803
- """
804
-
805
- def __init__(self):
806
- self._ref = ""
807
- self._name = None
808
- self._description = None
809
- self._total_bytes = 0
810
- self._url = None
811
- self._creation_date = None
812
- self._freeze()
813
-
814
- @property
815
- def ref(self) -> str:
816
- return self._ref
817
-
818
- @ref.setter
819
- def ref(self, ref: str):
820
- if ref is None:
821
- del self.ref
822
- return
823
- if not isinstance(ref, str):
824
- raise TypeError('ref must be of type str')
825
- self._ref = ref
826
-
827
- @property
828
- def name(self) -> str:
829
- return self._name or ""
830
-
831
- @name.setter
832
- def name(self, name: Optional[str]):
833
- if name is None:
834
- del self.name
835
- return
836
- if not isinstance(name, str):
837
- raise TypeError('name must be of type str')
838
- self._name = name
839
-
840
- @property
841
- def description(self) -> str:
842
- return self._description or ""
843
-
844
- @description.setter
845
- def description(self, description: Optional[str]):
846
- if description is None:
847
- del self.description
848
- return
849
- if not isinstance(description, str):
850
- raise TypeError('description must be of type str')
851
- self._description = description
852
-
853
- @property
854
- def total_bytes(self) -> int:
855
- return self._total_bytes
856
-
857
- @total_bytes.setter
858
- def total_bytes(self, total_bytes: int):
859
- if total_bytes is None:
860
- del self.total_bytes
861
- return
862
- if not isinstance(total_bytes, int):
863
- raise TypeError('total_bytes must be of type int')
864
- self._total_bytes = total_bytes
865
-
866
- @property
867
- def url(self) -> str:
868
- return self._url or ""
869
-
870
- @url.setter
871
- def url(self, url: Optional[str]):
872
- if url is None:
873
- del self.url
874
- return
875
- if not isinstance(url, str):
876
- raise TypeError('url must be of type str')
877
- self._url = url
878
-
879
- @property
880
- def creation_date(self) -> datetime:
881
- return self._creation_date
882
-
883
- @creation_date.setter
884
- def creation_date(self, creation_date: datetime):
885
- if creation_date is None:
886
- del self.creation_date
887
- return
888
- if not isinstance(creation_date, datetime):
889
- raise TypeError('creation_date must be of type datetime')
890
- self._creation_date = creation_date
891
-
892
-
893
- class ApiDownloadDataFileRequest(KaggleObject):
894
- r"""
895
- Attributes:
896
- competition_name (str)
897
- Competition name. Example: 'titanic'.
898
- file_name (str)
899
- Name of the file to download. Example: 'train/foo/bar.png'.
900
- """
901
-
902
- def __init__(self):
903
- self._competition_name = ""
904
- self._file_name = ""
905
- self._freeze()
906
-
907
- @property
908
- def competition_name(self) -> str:
909
- """Competition name. Example: 'titanic'."""
910
- return self._competition_name
911
-
912
- @competition_name.setter
913
- def competition_name(self, competition_name: str):
914
- if competition_name is None:
915
- del self.competition_name
916
- return
917
- if not isinstance(competition_name, str):
918
- raise TypeError('competition_name must be of type str')
919
- self._competition_name = competition_name
920
-
921
- @property
922
- def file_name(self) -> str:
923
- """Name of the file to download. Example: 'train/foo/bar.png'."""
924
- return self._file_name
925
-
926
- @file_name.setter
927
- def file_name(self, file_name: str):
928
- if file_name is None:
929
- del self.file_name
930
- return
931
- if not isinstance(file_name, str):
932
- raise TypeError('file_name must be of type str')
933
- self._file_name = file_name
934
-
935
- def endpoint(self):
936
- path = '/api/v1/competitions/data/download/{competition_name}/{file_name}'
937
- return path.format_map(self.to_field_map(self))
938
-
939
- @staticmethod
940
- def endpoint_path():
941
- return '/api/v1/competitions/data/download/{competition_name}/{file_name}'
942
-
943
-
944
- class ApiDownloadDataFilesRequest(KaggleObject):
945
- r"""
946
- Attributes:
947
- competition_name (str)
948
- Competition name. Example: 'titanic'.
949
- """
950
-
951
- def __init__(self):
952
- self._competition_name = ""
953
- self._freeze()
954
-
955
- @property
956
- def competition_name(self) -> str:
957
- """Competition name. Example: 'titanic'."""
958
- return self._competition_name
959
-
960
- @competition_name.setter
961
- def competition_name(self, competition_name: str):
962
- if competition_name is None:
963
- del self.competition_name
964
- return
965
- if not isinstance(competition_name, str):
966
- raise TypeError('competition_name must be of type str')
967
- self._competition_name = competition_name
968
-
969
- def endpoint(self):
970
- path = '/api/v1/competitions/data/download-all/{competition_name}'
971
- return path.format_map(self.to_field_map(self))
972
-
973
- @staticmethod
974
- def endpoint_path():
975
- return '/api/v1/competitions/data/download-all/{competition_name}'
976
-
977
-
978
- class ApiDownloadLeaderboardRequest(KaggleObject):
979
- r"""
980
- Attributes:
981
- competition_name (str)
982
- """
983
-
984
- def __init__(self):
985
- self._competition_name = ""
986
- self._freeze()
987
-
988
- @property
989
- def competition_name(self) -> str:
990
- return self._competition_name
991
-
992
- @competition_name.setter
993
- def competition_name(self, competition_name: str):
994
- if competition_name is None:
995
- del self.competition_name
996
- return
997
- if not isinstance(competition_name, str):
998
- raise TypeError('competition_name must be of type str')
999
- self._competition_name = competition_name
1000
-
1001
- def endpoint(self):
1002
- path = '/api/v1/competitions/{competition_name}/leaderboard/download'
1003
- return path.format_map(self.to_field_map(self))
1004
-
1005
- @staticmethod
1006
- def endpoint_path():
1007
- return '/api/v1/competitions/{competition_name}/leaderboard/download'
1008
-
1009
-
1010
- class ApiGetCompetitionDataFilesSummaryRequest(KaggleObject):
1011
- r"""
1012
- Attributes:
1013
- competition_name (str)
1014
- """
1015
-
1016
- def __init__(self):
1017
- self._competition_name = ""
1018
- self._freeze()
1019
-
1020
- @property
1021
- def competition_name(self) -> str:
1022
- return self._competition_name
1023
-
1024
- @competition_name.setter
1025
- def competition_name(self, competition_name: str):
1026
- if competition_name is None:
1027
- del self.competition_name
1028
- return
1029
- if not isinstance(competition_name, str):
1030
- raise TypeError('competition_name must be of type str')
1031
- self._competition_name = competition_name
1032
-
1033
- def endpoint(self):
1034
- path = '/api/v1/competitions/data/summary/{competition_name}'
1035
- return path.format_map(self.to_field_map(self))
1036
-
1037
- @staticmethod
1038
- def endpoint_path():
1039
- return '/api/v1/competitions/data/summary/{competition_name}'
1040
-
1041
-
1042
- class ApiGetCompetitionRequest(KaggleObject):
1043
- r"""
1044
- Attributes:
1045
- competition_name (str)
1046
- """
1047
-
1048
- def __init__(self):
1049
- self._competition_name = ""
1050
- self._freeze()
1051
-
1052
- @property
1053
- def competition_name(self) -> str:
1054
- return self._competition_name
1055
-
1056
- @competition_name.setter
1057
- def competition_name(self, competition_name: str):
1058
- if competition_name is None:
1059
- del self.competition_name
1060
- return
1061
- if not isinstance(competition_name, str):
1062
- raise TypeError('competition_name must be of type str')
1063
- self._competition_name = competition_name
1064
-
1065
- def endpoint(self):
1066
- path = '/api/v1/competitions/get/{competition_name}'
1067
- return path.format_map(self.to_field_map(self))
1068
-
1069
- @staticmethod
1070
- def endpoint_path():
1071
- return '/api/v1/competitions/get/{competition_name}'
1072
-
1073
-
1074
- class ApiGetLeaderboardRequest(KaggleObject):
1075
- r"""
1076
- Attributes:
1077
- competition_name (str)
1078
- Competition name. Example: 'titanic'.
1079
- override_public (bool)
1080
- By default we return the private leaderboard if it's available, otherwise
1081
- the public LB. This flag lets you override to get public even if private
1082
- is available.
1083
- page_size (int)
1084
- page_token (str)
1085
- """
1086
-
1087
- def __init__(self):
1088
- self._competition_name = ""
1089
- self._override_public = None
1090
- self._page_size = None
1091
- self._page_token = None
1092
- self._freeze()
1093
-
1094
- @property
1095
- def competition_name(self) -> str:
1096
- """Competition name. Example: 'titanic'."""
1097
- return self._competition_name
1098
-
1099
- @competition_name.setter
1100
- def competition_name(self, competition_name: str):
1101
- if competition_name is None:
1102
- del self.competition_name
1103
- return
1104
- if not isinstance(competition_name, str):
1105
- raise TypeError('competition_name must be of type str')
1106
- self._competition_name = competition_name
1107
-
1108
- @property
1109
- def override_public(self) -> bool:
1110
- r"""
1111
- By default we return the private leaderboard if it's available, otherwise
1112
- the public LB. This flag lets you override to get public even if private
1113
- is available.
1114
- """
1115
- return self._override_public or False
1116
-
1117
- @override_public.setter
1118
- def override_public(self, override_public: Optional[bool]):
1119
- if override_public is None:
1120
- del self.override_public
1121
- return
1122
- if not isinstance(override_public, bool):
1123
- raise TypeError('override_public must be of type bool')
1124
- self._override_public = override_public
1125
-
1126
- @property
1127
- def page_size(self) -> int:
1128
- return self._page_size or 0
1129
-
1130
- @page_size.setter
1131
- def page_size(self, page_size: Optional[int]):
1132
- if page_size is None:
1133
- del self.page_size
1134
- return
1135
- if not isinstance(page_size, int):
1136
- raise TypeError('page_size must be of type int')
1137
- self._page_size = page_size
1138
-
1139
- @property
1140
- def page_token(self) -> str:
1141
- return self._page_token or ""
1142
-
1143
- @page_token.setter
1144
- def page_token(self, page_token: Optional[str]):
1145
- if page_token is None:
1146
- del self.page_token
1147
- return
1148
- if not isinstance(page_token, str):
1149
- raise TypeError('page_token must be of type str')
1150
- self._page_token = page_token
1151
-
1152
- def endpoint(self):
1153
- path = '/api/v1/competitions/{competition_name}/leaderboard/view'
1154
- return path.format_map(self.to_field_map(self))
1155
-
1156
- @staticmethod
1157
- def endpoint_path():
1158
- return '/api/v1/competitions/{competition_name}/leaderboard/view'
1159
-
1160
-
1161
- class ApiGetLeaderboardResponse(KaggleObject):
1162
- r"""
1163
- Attributes:
1164
- submissions (ApiLeaderboardSubmission)
1165
- next_page_token (str)
1166
- """
1167
-
1168
- def __init__(self):
1169
- self._submissions = []
1170
- self._next_page_token = ""
1171
- self._freeze()
1172
-
1173
- @property
1174
- def submissions(self) -> Optional[List[Optional['ApiLeaderboardSubmission']]]:
1175
- return self._submissions
1176
-
1177
- @submissions.setter
1178
- def submissions(self, submissions: Optional[List[Optional['ApiLeaderboardSubmission']]]):
1179
- if submissions is None:
1180
- del self.submissions
1181
- return
1182
- if not isinstance(submissions, list):
1183
- raise TypeError('submissions must be of type list')
1184
- if not all([isinstance(t, ApiLeaderboardSubmission) for t in submissions]):
1185
- raise TypeError('submissions must contain only items of type ApiLeaderboardSubmission')
1186
- self._submissions = submissions
1187
-
1188
- @property
1189
- def next_page_token(self) -> str:
1190
- return self._next_page_token
1191
-
1192
- @next_page_token.setter
1193
- def next_page_token(self, next_page_token: str):
1194
- if next_page_token is None:
1195
- del self.next_page_token
1196
- return
1197
- if not isinstance(next_page_token, str):
1198
- raise TypeError('next_page_token must be of type str')
1199
- self._next_page_token = next_page_token
1200
-
1201
- @property
1202
- def nextPageToken(self):
1203
- return self.next_page_token
1204
-
1205
-
1206
- class ApiGetSubmissionRequest(KaggleObject):
1207
- r"""
1208
- Attributes:
1209
- ref (int)
1210
- SubmissionId.
1211
- """
1212
-
1213
- def __init__(self):
1214
- self._ref = 0
1215
- self._freeze()
1216
-
1217
- @property
1218
- def ref(self) -> int:
1219
- """SubmissionId."""
1220
- return self._ref
1221
-
1222
- @ref.setter
1223
- def ref(self, ref: int):
1224
- if ref is None:
1225
- del self.ref
1226
- return
1227
- if not isinstance(ref, int):
1228
- raise TypeError('ref must be of type int')
1229
- self._ref = ref
1230
-
1231
- def endpoint(self):
1232
- path = '/api/v1/competitions/submissions/get/{ref}'
1233
- return path.format_map(self.to_field_map(self))
1234
-
1235
-
1236
- @staticmethod
1237
- def method():
1238
- return 'POST'
1239
-
1240
-
1241
- class ApiLeaderboardSubmission(KaggleObject):
1242
- r"""
1243
- Attributes:
1244
- team_id (int)
1245
- team_name (str)
1246
- submission_date (datetime)
1247
- score (str)
1248
- """
1249
-
1250
- def __init__(self):
1251
- self._team_id = 0
1252
- self._team_name = None
1253
- self._submission_date = None
1254
- self._score = None
1255
- self._freeze()
1256
-
1257
- @property
1258
- def team_id(self) -> int:
1259
- return self._team_id
1260
-
1261
- @team_id.setter
1262
- def team_id(self, team_id: int):
1263
- if team_id is None:
1264
- del self.team_id
1265
- return
1266
- if not isinstance(team_id, int):
1267
- raise TypeError('team_id must be of type int')
1268
- self._team_id = team_id
1269
-
1270
- @property
1271
- def team_name(self) -> str:
1272
- return self._team_name or ""
1273
-
1274
- @team_name.setter
1275
- def team_name(self, team_name: Optional[str]):
1276
- if team_name is None:
1277
- del self.team_name
1278
- return
1279
- if not isinstance(team_name, str):
1280
- raise TypeError('team_name must be of type str')
1281
- self._team_name = team_name
1282
-
1283
- @property
1284
- def submission_date(self) -> datetime:
1285
- return self._submission_date
1286
-
1287
- @submission_date.setter
1288
- def submission_date(self, submission_date: datetime):
1289
- if submission_date is None:
1290
- del self.submission_date
1291
- return
1292
- if not isinstance(submission_date, datetime):
1293
- raise TypeError('submission_date must be of type datetime')
1294
- self._submission_date = submission_date
1295
-
1296
- @property
1297
- def score(self) -> str:
1298
- return self._score or ""
1299
-
1300
- @score.setter
1301
- def score(self, score: Optional[str]):
1302
- if score is None:
1303
- del self.score
1304
- return
1305
- if not isinstance(score, str):
1306
- raise TypeError('score must be of type str')
1307
- self._score = score
1308
-
1309
-
1310
- class ApiListCompetitionsRequest(KaggleObject):
1311
- r"""
1312
- Attributes:
1313
- group (CompetitionListTab)
1314
- Filter competitions by a particular group (default is 'general').
1315
- One of 'general', 'entered' and 'inClass'.
1316
- category (HostSegment)
1317
- Filter competitions by a particular category (default is 'all').
1318
- One of 'all', 'featured', 'research', 'recruitment', 'gettingStarted',
1319
- 'masters', 'playground'.
1320
- sort_by (CompetitionSortBy)
1321
- Sort the results (default is 'latestDeadline').
1322
- One of 'grouped', 'prize', 'earliestDeadline', 'latestDeadline',
1323
- 'numberOfTeams', 'recentlyCreated'.
1324
- search (str)
1325
- Filter competitions by search terms.
1326
- page (int)
1327
- Page number (default is 1).
1328
- page_token (str)
1329
- page_size (int)
1330
- """
1331
-
1332
- def __init__(self):
1333
- self._group = None
1334
- self._category = None
1335
- self._sort_by = None
1336
- self._search = None
1337
- self._page = None
1338
- self._page_token = None
1339
- self._page_size = None
1340
- self._freeze()
1341
-
1342
- @property
1343
- def group(self) -> 'CompetitionListTab':
1344
- r"""
1345
- Filter competitions by a particular group (default is 'general').
1346
- One of 'general', 'entered' and 'inClass'.
1347
- """
1348
- return self._group or CompetitionListTab.COMPETITION_LIST_TAB_GENERAL
1349
-
1350
- @group.setter
1351
- def group(self, group: Optional['CompetitionListTab']):
1352
- if group is None:
1353
- del self.group
1354
- return
1355
- if not isinstance(group, CompetitionListTab):
1356
- raise TypeError('group must be of type CompetitionListTab')
1357
- self._group = group
1358
-
1359
- @property
1360
- def category(self) -> 'HostSegment':
1361
- r"""
1362
- Filter competitions by a particular category (default is 'all').
1363
- One of 'all', 'featured', 'research', 'recruitment', 'gettingStarted',
1364
- 'masters', 'playground'.
1365
- """
1366
- return self._category or HostSegment.HOST_SEGMENT_UNSPECIFIED
1367
-
1368
- @category.setter
1369
- def category(self, category: Optional['HostSegment']):
1370
- if category is None:
1371
- del self.category
1372
- return
1373
- if not isinstance(category, HostSegment):
1374
- raise TypeError('category must be of type HostSegment')
1375
- self._category = category
1376
-
1377
- @property
1378
- def sort_by(self) -> 'CompetitionSortBy':
1379
- r"""
1380
- Sort the results (default is 'latestDeadline').
1381
- One of 'grouped', 'prize', 'earliestDeadline', 'latestDeadline',
1382
- 'numberOfTeams', 'recentlyCreated'.
1383
- """
1384
- return self._sort_by or CompetitionSortBy.COMPETITION_SORT_BY_GROUPED
1385
-
1386
- @sort_by.setter
1387
- def sort_by(self, sort_by: Optional['CompetitionSortBy']):
1388
- if sort_by is None:
1389
- del self.sort_by
1390
- return
1391
- if not isinstance(sort_by, CompetitionSortBy):
1392
- raise TypeError('sort_by must be of type CompetitionSortBy')
1393
- self._sort_by = sort_by
1394
-
1395
- @property
1396
- def search(self) -> str:
1397
- """Filter competitions by search terms."""
1398
- return self._search or ""
1399
-
1400
- @search.setter
1401
- def search(self, search: Optional[str]):
1402
- if search is None:
1403
- del self.search
1404
- return
1405
- if not isinstance(search, str):
1406
- raise TypeError('search must be of type str')
1407
- self._search = search
1408
-
1409
- @property
1410
- def page(self) -> int:
1411
- """Page number (default is 1)."""
1412
- return self._page or 0
1413
-
1414
- @page.setter
1415
- def page(self, page: Optional[int]):
1416
- if page is None:
1417
- del self.page
1418
- return
1419
- if not isinstance(page, int):
1420
- raise TypeError('page must be of type int')
1421
- self._page = page
1422
-
1423
- @property
1424
- def page_token(self) -> str:
1425
- return self._page_token or ""
1426
-
1427
- @page_token.setter
1428
- def page_token(self, page_token: Optional[str]):
1429
- if page_token is None:
1430
- del self.page_token
1431
- return
1432
- if not isinstance(page_token, str):
1433
- raise TypeError('page_token must be of type str')
1434
- self._page_token = page_token
1435
-
1436
- @property
1437
- def page_size(self) -> int:
1438
- return self._page_size or 0
1439
-
1440
- @page_size.setter
1441
- def page_size(self, page_size: Optional[int]):
1442
- if page_size is None:
1443
- del self.page_size
1444
- return
1445
- if not isinstance(page_size, int):
1446
- raise TypeError('page_size must be of type int')
1447
- self._page_size = page_size
1448
-
1449
- def endpoint(self):
1450
- path = '/api/v1/competitions/list'
1451
- return path.format_map(self.to_field_map(self))
1452
-
1453
-
1454
- class ApiListCompetitionsResponse(KaggleObject):
1455
- r"""
1456
- Attributes:
1457
- competitions (ApiCompetition)
1458
- next_page_token (str)
1459
- """
1460
-
1461
- def __init__(self):
1462
- self._competitions = []
1463
- self._next_page_token = ""
1464
- self._freeze()
1465
-
1466
- @property
1467
- def competitions(self) -> Optional[List[Optional['ApiCompetition']]]:
1468
- return self._competitions
1469
-
1470
- @competitions.setter
1471
- def competitions(self, competitions: Optional[List[Optional['ApiCompetition']]]):
1472
- if competitions is None:
1473
- del self.competitions
1474
- return
1475
- if not isinstance(competitions, list):
1476
- raise TypeError('competitions must be of type list')
1477
- if not all([isinstance(t, ApiCompetition) for t in competitions]):
1478
- raise TypeError('competitions must contain only items of type ApiCompetition')
1479
- self._competitions = competitions
1480
-
1481
- @property
1482
- def next_page_token(self) -> str:
1483
- return self._next_page_token
1484
-
1485
- @next_page_token.setter
1486
- def next_page_token(self, next_page_token: str):
1487
- if next_page_token is None:
1488
- del self.next_page_token
1489
- return
1490
- if not isinstance(next_page_token, str):
1491
- raise TypeError('next_page_token must be of type str')
1492
- self._next_page_token = next_page_token
1493
-
1494
- @property
1495
- def nextPageToken(self):
1496
- return self.next_page_token
1497
-
1498
-
1499
- class ApiListDataFilesRequest(KaggleObject):
1500
- r"""
1501
- Attributes:
1502
- competition_name (str)
1503
- Competition name. Example: 'titanic'.
1504
- page_size (int)
1505
- page_token (str)
1506
- """
1507
-
1508
- def __init__(self):
1509
- self._competition_name = ""
1510
- self._page_size = None
1511
- self._page_token = None
1512
- self._freeze()
1513
-
1514
- @property
1515
- def competition_name(self) -> str:
1516
- """Competition name. Example: 'titanic'."""
1517
- return self._competition_name
1518
-
1519
- @competition_name.setter
1520
- def competition_name(self, competition_name: str):
1521
- if competition_name is None:
1522
- del self.competition_name
1523
- return
1524
- if not isinstance(competition_name, str):
1525
- raise TypeError('competition_name must be of type str')
1526
- self._competition_name = competition_name
1527
-
1528
- @property
1529
- def page_size(self) -> int:
1530
- return self._page_size or 0
1531
-
1532
- @page_size.setter
1533
- def page_size(self, page_size: Optional[int]):
1534
- if page_size is None:
1535
- del self.page_size
1536
- return
1537
- if not isinstance(page_size, int):
1538
- raise TypeError('page_size must be of type int')
1539
- self._page_size = page_size
1540
-
1541
- @property
1542
- def page_token(self) -> str:
1543
- return self._page_token or ""
1544
-
1545
- @page_token.setter
1546
- def page_token(self, page_token: Optional[str]):
1547
- if page_token is None:
1548
- del self.page_token
1549
- return
1550
- if not isinstance(page_token, str):
1551
- raise TypeError('page_token must be of type str')
1552
- self._page_token = page_token
1553
-
1554
- def endpoint(self):
1555
- path = '/api/v1/competitions/data/list/{competition_name}'
1556
- return path.format_map(self.to_field_map(self))
1557
-
1558
- @staticmethod
1559
- def endpoint_path():
1560
- return '/api/v1/competitions/data/list/{competition_name}'
1561
-
1562
-
1563
- class ApiListDataFilesResponse(KaggleObject):
1564
- r"""
1565
- Attributes:
1566
- files (ApiDataFile)
1567
- next_page_token (str)
1568
- children_fetch_time_ms (int)
1569
- """
1570
-
1571
- def __init__(self):
1572
- self._files = []
1573
- self._next_page_token = ""
1574
- self._children_fetch_time_ms = 0
1575
- self._freeze()
1576
-
1577
- @property
1578
- def files(self) -> Optional[List[Optional['ApiDataFile']]]:
1579
- return self._files
1580
-
1581
- @files.setter
1582
- def files(self, files: Optional[List[Optional['ApiDataFile']]]):
1583
- if files is None:
1584
- del self.files
1585
- return
1586
- if not isinstance(files, list):
1587
- raise TypeError('files must be of type list')
1588
- if not all([isinstance(t, ApiDataFile) for t in files]):
1589
- raise TypeError('files must contain only items of type ApiDataFile')
1590
- self._files = files
1591
-
1592
- @property
1593
- def next_page_token(self) -> str:
1594
- return self._next_page_token
1595
-
1596
- @next_page_token.setter
1597
- def next_page_token(self, next_page_token: str):
1598
- if next_page_token is None:
1599
- del self.next_page_token
1600
- return
1601
- if not isinstance(next_page_token, str):
1602
- raise TypeError('next_page_token must be of type str')
1603
- self._next_page_token = next_page_token
1604
-
1605
- @property
1606
- def children_fetch_time_ms(self) -> int:
1607
- return self._children_fetch_time_ms
1608
-
1609
- @children_fetch_time_ms.setter
1610
- def children_fetch_time_ms(self, children_fetch_time_ms: int):
1611
- if children_fetch_time_ms is None:
1612
- del self.children_fetch_time_ms
1613
- return
1614
- if not isinstance(children_fetch_time_ms, int):
1615
- raise TypeError('children_fetch_time_ms must be of type int')
1616
- self._children_fetch_time_ms = children_fetch_time_ms
1617
-
1618
- @property
1619
- def nextPageToken(self):
1620
- return self.next_page_token
1621
-
1622
- @property
1623
- def childrenFetchTimeMs(self):
1624
- return self.children_fetch_time_ms
1625
-
1626
-
1627
- class ApiListDataTreeFilesRequest(KaggleObject):
1628
- r"""
1629
- Attributes:
1630
- competition_name (str)
1631
- Competition name. Example: 'titanic'.
1632
- path (str)
1633
- The path of the directory to list files from. If not provided, the root
1634
- directory will be listed.
1635
- page_size (int)
1636
- page_token (str)
1637
- """
1638
-
1639
- def __init__(self):
1640
- self._competition_name = ""
1641
- self._path = None
1642
- self._page_size = None
1643
- self._page_token = None
1644
- self._freeze()
1645
-
1646
- @property
1647
- def competition_name(self) -> str:
1648
- """Competition name. Example: 'titanic'."""
1649
- return self._competition_name
1650
-
1651
- @competition_name.setter
1652
- def competition_name(self, competition_name: str):
1653
- if competition_name is None:
1654
- del self.competition_name
1655
- return
1656
- if not isinstance(competition_name, str):
1657
- raise TypeError('competition_name must be of type str')
1658
- self._competition_name = competition_name
1659
-
1660
- @property
1661
- def path(self) -> str:
1662
- r"""
1663
- The path of the directory to list files from. If not provided, the root
1664
- directory will be listed.
1665
- """
1666
- return self._path or ""
1667
-
1668
- @path.setter
1669
- def path(self, path: Optional[str]):
1670
- if path is None:
1671
- del self.path
1672
- return
1673
- if not isinstance(path, str):
1674
- raise TypeError('path must be of type str')
1675
- self._path = path
1676
-
1677
- @property
1678
- def page_size(self) -> int:
1679
- return self._page_size or 0
1680
-
1681
- @page_size.setter
1682
- def page_size(self, page_size: Optional[int]):
1683
- if page_size is None:
1684
- del self.page_size
1685
- return
1686
- if not isinstance(page_size, int):
1687
- raise TypeError('page_size must be of type int')
1688
- self._page_size = page_size
1689
-
1690
- @property
1691
- def page_token(self) -> str:
1692
- return self._page_token or ""
1693
-
1694
- @page_token.setter
1695
- def page_token(self, page_token: Optional[str]):
1696
- if page_token is None:
1697
- del self.page_token
1698
- return
1699
- if not isinstance(page_token, str):
1700
- raise TypeError('page_token must be of type str')
1701
- self._page_token = page_token
1702
-
1703
- def endpoint(self):
1704
- path = '/api/v1/competitions/{competition_name}/data-tree/list/'
1705
- return path.format_map(self.to_field_map(self))
1706
-
1707
- @staticmethod
1708
- def endpoint_path():
1709
- return '/api/v1/competitions/{competition_name}/data-tree/list/'
1710
-
1711
-
1712
- class ApiListSubmissionsRequest(KaggleObject):
1713
- r"""
1714
- Attributes:
1715
- competition_name (str)
1716
- sort_by (SubmissionSortBy)
1717
- group (SubmissionGroup)
1718
- page (int)
1719
- page_token (str)
1720
- page_size (int)
1721
- """
1722
-
1723
- def __init__(self):
1724
- self._competition_name = ""
1725
- self._sort_by = SubmissionSortBy.SUBMISSION_SORT_BY_DATE
1726
- self._group = SubmissionGroup.SUBMISSION_GROUP_ALL
1727
- self._page = None
1728
- self._page_token = None
1729
- self._page_size = None
1730
- self._freeze()
1731
-
1732
- @property
1733
- def competition_name(self) -> str:
1734
- return self._competition_name
1735
-
1736
- @competition_name.setter
1737
- def competition_name(self, competition_name: str):
1738
- if competition_name is None:
1739
- del self.competition_name
1740
- return
1741
- if not isinstance(competition_name, str):
1742
- raise TypeError('competition_name must be of type str')
1743
- self._competition_name = competition_name
1744
-
1745
- @property
1746
- def sort_by(self) -> 'SubmissionSortBy':
1747
- return self._sort_by
1748
-
1749
- @sort_by.setter
1750
- def sort_by(self, sort_by: 'SubmissionSortBy'):
1751
- if sort_by is None:
1752
- del self.sort_by
1753
- return
1754
- if not isinstance(sort_by, SubmissionSortBy):
1755
- raise TypeError('sort_by must be of type SubmissionSortBy')
1756
- self._sort_by = sort_by
1757
-
1758
- @property
1759
- def group(self) -> 'SubmissionGroup':
1760
- return self._group
1761
-
1762
- @group.setter
1763
- def group(self, group: 'SubmissionGroup'):
1764
- if group is None:
1765
- del self.group
1766
- return
1767
- if not isinstance(group, SubmissionGroup):
1768
- raise TypeError('group must be of type SubmissionGroup')
1769
- self._group = group
1770
-
1771
- @property
1772
- def page(self) -> int:
1773
- return self._page or 0
1774
-
1775
- @page.setter
1776
- def page(self, page: Optional[int]):
1777
- if page is None:
1778
- del self.page
1779
- return
1780
- if not isinstance(page, int):
1781
- raise TypeError('page must be of type int')
1782
- self._page = page
1783
-
1784
- @property
1785
- def page_token(self) -> str:
1786
- return self._page_token or ""
1787
-
1788
- @page_token.setter
1789
- def page_token(self, page_token: Optional[str]):
1790
- if page_token is None:
1791
- del self.page_token
1792
- return
1793
- if not isinstance(page_token, str):
1794
- raise TypeError('page_token must be of type str')
1795
- self._page_token = page_token
1796
-
1797
- @property
1798
- def page_size(self) -> int:
1799
- return self._page_size or 0
1800
-
1801
- @page_size.setter
1802
- def page_size(self, page_size: Optional[int]):
1803
- if page_size is None:
1804
- del self.page_size
1805
- return
1806
- if not isinstance(page_size, int):
1807
- raise TypeError('page_size must be of type int')
1808
- self._page_size = page_size
1809
-
1810
- def endpoint(self):
1811
- path = '/api/v1/competitions/submissions/list/{competition_name}'
1812
- return path.format_map(self.to_field_map(self))
1813
-
1814
- @staticmethod
1815
- def endpoint_path():
1816
- return '/api/v1/competitions/submissions/list/{competition_name}'
1817
-
1818
-
1819
- class ApiListSubmissionsResponse(KaggleObject):
1820
- r"""
1821
- Attributes:
1822
- submissions (ApiSubmission)
1823
- next_page_token (str)
1824
- """
1825
-
1826
- def __init__(self):
1827
- self._submissions = []
1828
- self._next_page_token = ""
1829
- self._freeze()
1830
-
1831
- @property
1832
- def submissions(self) -> Optional[List[Optional['ApiSubmission']]]:
1833
- return self._submissions
1834
-
1835
- @submissions.setter
1836
- def submissions(self, submissions: Optional[List[Optional['ApiSubmission']]]):
1837
- if submissions is None:
1838
- del self.submissions
1839
- return
1840
- if not isinstance(submissions, list):
1841
- raise TypeError('submissions must be of type list')
1842
- if not all([isinstance(t, ApiSubmission) for t in submissions]):
1843
- raise TypeError('submissions must contain only items of type ApiSubmission')
1844
- self._submissions = submissions
1845
-
1846
- @property
1847
- def next_page_token(self) -> str:
1848
- return self._next_page_token
1849
-
1850
- @next_page_token.setter
1851
- def next_page_token(self, next_page_token: str):
1852
- if next_page_token is None:
1853
- del self.next_page_token
1854
- return
1855
- if not isinstance(next_page_token, str):
1856
- raise TypeError('next_page_token must be of type str')
1857
- self._next_page_token = next_page_token
1858
-
1859
- @property
1860
- def nextPageToken(self):
1861
- return self.next_page_token
1862
-
1863
-
1864
- class ApiStartSubmissionUploadRequest(KaggleObject):
1865
- r"""
1866
- Attributes:
1867
- competition_name (str)
1868
- content_length (int)
1869
- last_modified_epoch_seconds (int)
1870
- file_name (str)
1871
- Comes from form upload
1872
- """
1873
-
1874
- def __init__(self):
1875
- self._competition_name = None
1876
- self._content_length = 0
1877
- self._last_modified_epoch_seconds = 0
1878
- self._file_name = ""
1879
- self._freeze()
1880
-
1881
- @property
1882
- def competition_name(self) -> str:
1883
- return self._competition_name or ""
1884
-
1885
- @competition_name.setter
1886
- def competition_name(self, competition_name: Optional[str]):
1887
- if competition_name is None:
1888
- del self.competition_name
1889
- return
1890
- if not isinstance(competition_name, str):
1891
- raise TypeError('competition_name must be of type str')
1892
- self._competition_name = competition_name
1893
-
1894
- @property
1895
- def content_length(self) -> int:
1896
- return self._content_length
1897
-
1898
- @content_length.setter
1899
- def content_length(self, content_length: int):
1900
- if content_length is None:
1901
- del self.content_length
1902
- return
1903
- if not isinstance(content_length, int):
1904
- raise TypeError('content_length must be of type int')
1905
- self._content_length = content_length
1906
-
1907
- @property
1908
- def last_modified_epoch_seconds(self) -> int:
1909
- return self._last_modified_epoch_seconds
1910
-
1911
- @last_modified_epoch_seconds.setter
1912
- def last_modified_epoch_seconds(self, last_modified_epoch_seconds: int):
1913
- if last_modified_epoch_seconds is None:
1914
- del self.last_modified_epoch_seconds
1915
- return
1916
- if not isinstance(last_modified_epoch_seconds, int):
1917
- raise TypeError('last_modified_epoch_seconds must be of type int')
1918
- self._last_modified_epoch_seconds = last_modified_epoch_seconds
1919
-
1920
- @property
1921
- def file_name(self) -> str:
1922
- """Comes from form upload"""
1923
- return self._file_name
1924
-
1925
- @file_name.setter
1926
- def file_name(self, file_name: str):
1927
- if file_name is None:
1928
- del self.file_name
1929
- return
1930
- if not isinstance(file_name, str):
1931
- raise TypeError('file_name must be of type str')
1932
- self._file_name = file_name
1933
-
1934
- def endpoint(self):
1935
- path = '/api/v1/competitions/submission-url'
1936
- return path.format_map(self.to_field_map(self))
1937
-
1938
-
1939
- @staticmethod
1940
- def method():
1941
- return 'POST'
1942
-
1943
-
1944
- class ApiStartSubmissionUploadResponse(KaggleObject):
1945
- r"""
1946
- Currently identical to StartBlobUploadResponse, but keeping separate since
1947
- they could change independently and this is a legacy V1 type.
1948
-
1949
- Attributes:
1950
- token (str)
1951
- create_url (str)
1952
- """
1953
-
1954
- def __init__(self):
1955
- self._token = ""
1956
- self._create_url = ""
1957
- self._freeze()
1958
-
1959
- @property
1960
- def token(self) -> str:
1961
- return self._token
1962
-
1963
- @token.setter
1964
- def token(self, token: str):
1965
- if token is None:
1966
- del self.token
1967
- return
1968
- if not isinstance(token, str):
1969
- raise TypeError('token must be of type str')
1970
- self._token = token
1971
-
1972
- @property
1973
- def create_url(self) -> str:
1974
- return self._create_url
1975
-
1976
- @create_url.setter
1977
- def create_url(self, create_url: str):
1978
- if create_url is None:
1979
- del self.create_url
1980
- return
1981
- if not isinstance(create_url, str):
1982
- raise TypeError('create_url must be of type str')
1983
- self._create_url = create_url
1984
-
1985
- @property
1986
- def createUrl(self):
1987
- return self.create_url
1988
-
1989
-
1990
- class ApiSubmission(KaggleObject):
1991
- r"""
1992
- Attributes:
1993
- ref (int)
1994
- total_bytes (int)
1995
- date (datetime)
1996
- description (str)
1997
- error_description (str)
1998
- file_name (str)
1999
- public_score (str)
2000
- private_score (str)
2001
- status (SubmissionStatus)
2002
- submitted_by (str)
2003
- submitted_by_ref (str)
2004
- team_name (str)
2005
- url (str)
2006
- Minor note: ListSubmissions and GetSubmission may differ in setting this
2007
- field.
2008
- """
2009
-
2010
- def __init__(self):
2011
- self._ref = 0
2012
- self._total_bytes = None
2013
- self._date = None
2014
- self._description = None
2015
- self._error_description = None
2016
- self._file_name = None
2017
- self._public_score = None
2018
- self._private_score = None
2019
- self._status = SubmissionStatus.PENDING
2020
- self._submitted_by = None
2021
- self._submitted_by_ref = None
2022
- self._team_name = None
2023
- self._url = None
2024
- self._freeze()
2025
-
2026
- @property
2027
- def ref(self) -> int:
2028
- return self._ref
2029
-
2030
- @ref.setter
2031
- def ref(self, ref: int):
2032
- if ref is None:
2033
- del self.ref
2034
- return
2035
- if not isinstance(ref, int):
2036
- raise TypeError('ref must be of type int')
2037
- self._ref = ref
2038
-
2039
- @property
2040
- def total_bytes(self) -> int:
2041
- return self._total_bytes or 0
2042
-
2043
- @total_bytes.setter
2044
- def total_bytes(self, total_bytes: Optional[int]):
2045
- if total_bytes is None:
2046
- del self.total_bytes
2047
- return
2048
- if not isinstance(total_bytes, int):
2049
- raise TypeError('total_bytes must be of type int')
2050
- self._total_bytes = total_bytes
2051
-
2052
- @property
2053
- def date(self) -> datetime:
2054
- return self._date
2055
-
2056
- @date.setter
2057
- def date(self, date: datetime):
2058
- if date is None:
2059
- del self.date
2060
- return
2061
- if not isinstance(date, datetime):
2062
- raise TypeError('date must be of type datetime')
2063
- self._date = date
2064
-
2065
- @property
2066
- def description(self) -> str:
2067
- return self._description or ""
2068
-
2069
- @description.setter
2070
- def description(self, description: Optional[str]):
2071
- if description is None:
2072
- del self.description
2073
- return
2074
- if not isinstance(description, str):
2075
- raise TypeError('description must be of type str')
2076
- self._description = description
2077
-
2078
- @property
2079
- def error_description(self) -> str:
2080
- return self._error_description or ""
2081
-
2082
- @error_description.setter
2083
- def error_description(self, error_description: Optional[str]):
2084
- if error_description is None:
2085
- del self.error_description
2086
- return
2087
- if not isinstance(error_description, str):
2088
- raise TypeError('error_description must be of type str')
2089
- self._error_description = error_description
2090
-
2091
- @property
2092
- def file_name(self) -> str:
2093
- return self._file_name or ""
2094
-
2095
- @file_name.setter
2096
- def file_name(self, file_name: Optional[str]):
2097
- if file_name is None:
2098
- del self.file_name
2099
- return
2100
- if not isinstance(file_name, str):
2101
- raise TypeError('file_name must be of type str')
2102
- self._file_name = file_name
2103
-
2104
- @property
2105
- def public_score(self) -> str:
2106
- return self._public_score or ""
2107
-
2108
- @public_score.setter
2109
- def public_score(self, public_score: Optional[str]):
2110
- if public_score is None:
2111
- del self.public_score
2112
- return
2113
- if not isinstance(public_score, str):
2114
- raise TypeError('public_score must be of type str')
2115
- self._public_score = public_score
2116
-
2117
- @property
2118
- def private_score(self) -> str:
2119
- return self._private_score or ""
2120
-
2121
- @private_score.setter
2122
- def private_score(self, private_score: Optional[str]):
2123
- if private_score is None:
2124
- del self.private_score
2125
- return
2126
- if not isinstance(private_score, str):
2127
- raise TypeError('private_score must be of type str')
2128
- self._private_score = private_score
2129
-
2130
- @property
2131
- def status(self) -> 'SubmissionStatus':
2132
- return self._status
2133
-
2134
- @status.setter
2135
- def status(self, status: 'SubmissionStatus'):
2136
- if status is None:
2137
- del self.status
2138
- return
2139
- if not isinstance(status, SubmissionStatus):
2140
- raise TypeError('status must be of type SubmissionStatus')
2141
- self._status = status
2142
-
2143
- @property
2144
- def submitted_by(self) -> str:
2145
- return self._submitted_by or ""
2146
-
2147
- @submitted_by.setter
2148
- def submitted_by(self, submitted_by: Optional[str]):
2149
- if submitted_by is None:
2150
- del self.submitted_by
2151
- return
2152
- if not isinstance(submitted_by, str):
2153
- raise TypeError('submitted_by must be of type str')
2154
- self._submitted_by = submitted_by
2155
-
2156
- @property
2157
- def submitted_by_ref(self) -> str:
2158
- return self._submitted_by_ref or ""
2159
-
2160
- @submitted_by_ref.setter
2161
- def submitted_by_ref(self, submitted_by_ref: Optional[str]):
2162
- if submitted_by_ref is None:
2163
- del self.submitted_by_ref
2164
- return
2165
- if not isinstance(submitted_by_ref, str):
2166
- raise TypeError('submitted_by_ref must be of type str')
2167
- self._submitted_by_ref = submitted_by_ref
2168
-
2169
- @property
2170
- def team_name(self) -> str:
2171
- return self._team_name or ""
2172
-
2173
- @team_name.setter
2174
- def team_name(self, team_name: Optional[str]):
2175
- if team_name is None:
2176
- del self.team_name
2177
- return
2178
- if not isinstance(team_name, str):
2179
- raise TypeError('team_name must be of type str')
2180
- self._team_name = team_name
2181
-
2182
- @property
2183
- def url(self) -> str:
2184
- r"""
2185
- Minor note: ListSubmissions and GetSubmission may differ in setting this
2186
- field.
2187
- """
2188
- return self._url or ""
2189
-
2190
- @url.setter
2191
- def url(self, url: Optional[str]):
2192
- if url is None:
2193
- del self.url
2194
- return
2195
- if not isinstance(url, str):
2196
- raise TypeError('url must be of type str')
2197
- self._url = url
2198
-
2199
-
2200
- ApiCategory._fields = [
2201
- FieldMetadata("ref", "ref", "_ref", str, "", PredefinedSerializer()),
2202
- FieldMetadata("name", "name", "_name", str, None, PredefinedSerializer(), optional=True),
2203
- FieldMetadata("description", "description", "_description", str, None, PredefinedSerializer(), optional=True),
2204
- FieldMetadata("fullPath", "full_path", "_full_path", str, None, PredefinedSerializer(), optional=True),
2205
- FieldMetadata("competitionCount", "competition_count", "_competition_count", int, 0, PredefinedSerializer()),
2206
- FieldMetadata("datasetCount", "dataset_count", "_dataset_count", int, 0, PredefinedSerializer()),
2207
- FieldMetadata("scriptCount", "script_count", "_script_count", int, 0, PredefinedSerializer()),
2208
- FieldMetadata("totalCount", "total_count", "_total_count", int, 0, PredefinedSerializer()),
2209
- ]
2210
-
2211
- ApiCompetition._fields = [
2212
- FieldMetadata("id", "id", "_id", int, 0, PredefinedSerializer()),
2213
- FieldMetadata("ref", "ref", "_ref", str, "", PredefinedSerializer()),
2214
- FieldMetadata("title", "title", "_title", str, None, PredefinedSerializer(), optional=True),
2215
- FieldMetadata("url", "url", "_url", str, None, PredefinedSerializer(), optional=True),
2216
- FieldMetadata("description", "description", "_description", str, None, PredefinedSerializer(), optional=True),
2217
- FieldMetadata("organizationName", "organization_name", "_organization_name", str, None, PredefinedSerializer(), optional=True),
2218
- FieldMetadata("organizationRef", "organization_ref", "_organization_ref", str, None, PredefinedSerializer(), optional=True),
2219
- FieldMetadata("category", "category", "_category", str, None, PredefinedSerializer(), optional=True),
2220
- FieldMetadata("reward", "reward", "_reward", str, None, PredefinedSerializer(), optional=True),
2221
- FieldMetadata("tags", "tags", "_tags", ApiCategory, [], ListSerializer(KaggleObjectSerializer())),
2222
- FieldMetadata("deadline", "deadline", "_deadline", datetime, None, DateTimeSerializer()),
2223
- FieldMetadata("kernelCount", "kernel_count", "_kernel_count", int, 0, PredefinedSerializer()),
2224
- FieldMetadata("teamCount", "team_count", "_team_count", int, 0, PredefinedSerializer()),
2225
- FieldMetadata("userHasEntered", "user_has_entered", "_user_has_entered", bool, False, PredefinedSerializer()),
2226
- FieldMetadata("userRank", "user_rank", "_user_rank", int, None, PredefinedSerializer(), optional=True),
2227
- FieldMetadata("mergerDeadline", "merger_deadline", "_merger_deadline", datetime, None, DateTimeSerializer()),
2228
- FieldMetadata("newEntrantDeadline", "new_entrant_deadline", "_new_entrant_deadline", datetime, None, DateTimeSerializer()),
2229
- FieldMetadata("enabledDate", "enabled_date", "_enabled_date", datetime, None, DateTimeSerializer()),
2230
- FieldMetadata("maxDailySubmissions", "max_daily_submissions", "_max_daily_submissions", int, 0, PredefinedSerializer()),
2231
- FieldMetadata("maxTeamSize", "max_team_size", "_max_team_size", int, None, PredefinedSerializer(), optional=True),
2232
- FieldMetadata("evaluationMetric", "evaluation_metric", "_evaluation_metric", str, None, PredefinedSerializer(), optional=True),
2233
- FieldMetadata("awardsPoints", "awards_points", "_awards_points", bool, False, PredefinedSerializer()),
2234
- FieldMetadata("isKernelsSubmissionsOnly", "is_kernels_submissions_only", "_is_kernels_submissions_only", bool, False, PredefinedSerializer()),
2235
- FieldMetadata("submissionsDisabled", "submissions_disabled", "_submissions_disabled", bool, False, PredefinedSerializer()),
2236
- FieldMetadata("thumbnailImageUrl", "thumbnail_image_url", "_thumbnail_image_url", str, None, PredefinedSerializer(), optional=True),
2237
- FieldMetadata("hostName", "host_name", "_host_name", str, "", PredefinedSerializer()),
2238
- ]
2239
-
2240
- ApiCreateCodeSubmissionRequest._fields = [
2241
- FieldMetadata("competitionName", "competition_name", "_competition_name", str, "", PredefinedSerializer()),
2242
- FieldMetadata("kernelOwner", "kernel_owner", "_kernel_owner", str, "", PredefinedSerializer()),
2243
- FieldMetadata("kernelSlug", "kernel_slug", "_kernel_slug", str, "", PredefinedSerializer()),
2244
- FieldMetadata("kernelVersion", "kernel_version", "_kernel_version", int, None, PredefinedSerializer(), optional=True),
2245
- FieldMetadata("fileName", "file_name", "_file_name", str, None, PredefinedSerializer(), optional=True),
2246
- FieldMetadata("submissionDescription", "submission_description", "_submission_description", str, None, PredefinedSerializer(), optional=True),
2247
- ]
2248
-
2249
- ApiCreateCodeSubmissionResponse._fields = [
2250
- FieldMetadata("message", "message", "_message", str, "", PredefinedSerializer()),
2251
- FieldMetadata("ref", "ref", "_ref", int, 0, PredefinedSerializer()),
2252
- ]
2253
-
2254
- ApiCreateSubmissionRequest._fields = [
2255
- FieldMetadata("competitionName", "competition_name", "_competition_name", str, "", PredefinedSerializer()),
2256
- FieldMetadata("blobFileTokens", "blob_file_tokens", "_blob_file_tokens", str, "", PredefinedSerializer()),
2257
- FieldMetadata("submissionDescription", "submission_description", "_submission_description", str, None, PredefinedSerializer(), optional=True),
2258
- ]
2259
-
2260
- ApiCreateSubmissionResponse._fields = [
2261
- FieldMetadata("message", "message", "_message", str, "", PredefinedSerializer()),
2262
- FieldMetadata("ref", "ref", "_ref", int, 0, PredefinedSerializer()),
2263
- ]
2264
-
2265
- ApiDataFile._fields = [
2266
- FieldMetadata("ref", "ref", "_ref", str, "", PredefinedSerializer()),
2267
- FieldMetadata("name", "name", "_name", str, None, PredefinedSerializer(), optional=True),
2268
- FieldMetadata("description", "description", "_description", str, None, PredefinedSerializer(), optional=True),
2269
- FieldMetadata("totalBytes", "total_bytes", "_total_bytes", int, 0, PredefinedSerializer()),
2270
- FieldMetadata("url", "url", "_url", str, None, PredefinedSerializer(), optional=True),
2271
- FieldMetadata("creationDate", "creation_date", "_creation_date", datetime, None, DateTimeSerializer()),
2272
- ]
2273
-
2274
- ApiDownloadDataFileRequest._fields = [
2275
- FieldMetadata("competitionName", "competition_name", "_competition_name", str, "", PredefinedSerializer()),
2276
- FieldMetadata("fileName", "file_name", "_file_name", str, "", PredefinedSerializer()),
2277
- ]
2278
-
2279
- ApiDownloadDataFilesRequest._fields = [
2280
- FieldMetadata("competitionName", "competition_name", "_competition_name", str, "", PredefinedSerializer()),
2281
- ]
2282
-
2283
- ApiDownloadLeaderboardRequest._fields = [
2284
- FieldMetadata("competitionName", "competition_name", "_competition_name", str, "", PredefinedSerializer()),
2285
- ]
2286
-
2287
- ApiGetCompetitionDataFilesSummaryRequest._fields = [
2288
- FieldMetadata("competitionName", "competition_name", "_competition_name", str, "", PredefinedSerializer()),
2289
- ]
2290
-
2291
- ApiGetCompetitionRequest._fields = [
2292
- FieldMetadata("competitionName", "competition_name", "_competition_name", str, "", PredefinedSerializer()),
2293
- ]
2294
-
2295
- ApiGetLeaderboardRequest._fields = [
2296
- FieldMetadata("competitionName", "competition_name", "_competition_name", str, "", PredefinedSerializer()),
2297
- FieldMetadata("overridePublic", "override_public", "_override_public", bool, None, PredefinedSerializer(), optional=True),
2298
- FieldMetadata("pageSize", "page_size", "_page_size", int, None, PredefinedSerializer(), optional=True),
2299
- FieldMetadata("pageToken", "page_token", "_page_token", str, None, PredefinedSerializer(), optional=True),
2300
- ]
2301
-
2302
- ApiGetLeaderboardResponse._fields = [
2303
- FieldMetadata("submissions", "submissions", "_submissions", ApiLeaderboardSubmission, [], ListSerializer(KaggleObjectSerializer())),
2304
- FieldMetadata("nextPageToken", "next_page_token", "_next_page_token", str, "", PredefinedSerializer()),
2305
- ]
2306
-
2307
- ApiGetSubmissionRequest._fields = [
2308
- FieldMetadata("ref", "ref", "_ref", int, 0, PredefinedSerializer()),
2309
- ]
2310
-
2311
- ApiLeaderboardSubmission._fields = [
2312
- FieldMetadata("teamId", "team_id", "_team_id", int, 0, PredefinedSerializer()),
2313
- FieldMetadata("teamName", "team_name", "_team_name", str, None, PredefinedSerializer(), optional=True),
2314
- FieldMetadata("submissionDate", "submission_date", "_submission_date", datetime, None, DateTimeSerializer()),
2315
- FieldMetadata("score", "score", "_score", str, None, PredefinedSerializer(), optional=True),
2316
- ]
2317
-
2318
- ApiListCompetitionsRequest._fields = [
2319
- FieldMetadata("group", "group", "_group", CompetitionListTab, None, EnumSerializer(), optional=True),
2320
- FieldMetadata("category", "category", "_category", HostSegment, None, EnumSerializer(), optional=True),
2321
- FieldMetadata("sortBy", "sort_by", "_sort_by", CompetitionSortBy, None, EnumSerializer(), optional=True),
2322
- FieldMetadata("search", "search", "_search", str, None, PredefinedSerializer(), optional=True),
2323
- FieldMetadata("page", "page", "_page", int, None, PredefinedSerializer(), optional=True),
2324
- FieldMetadata("pageToken", "page_token", "_page_token", str, None, PredefinedSerializer(), optional=True),
2325
- FieldMetadata("pageSize", "page_size", "_page_size", int, None, PredefinedSerializer(), optional=True),
2326
- ]
2327
-
2328
- ApiListCompetitionsResponse._fields = [
2329
- FieldMetadata("competitions", "competitions", "_competitions", ApiCompetition, [], ListSerializer(KaggleObjectSerializer())),
2330
- FieldMetadata("nextPageToken", "next_page_token", "_next_page_token", str, "", PredefinedSerializer()),
2331
- ]
2332
-
2333
- ApiListDataFilesRequest._fields = [
2334
- FieldMetadata("competitionName", "competition_name", "_competition_name", str, "", PredefinedSerializer()),
2335
- FieldMetadata("pageSize", "page_size", "_page_size", int, None, PredefinedSerializer(), optional=True),
2336
- FieldMetadata("pageToken", "page_token", "_page_token", str, None, PredefinedSerializer(), optional=True),
2337
- ]
2338
-
2339
- ApiListDataFilesResponse._fields = [
2340
- FieldMetadata("files", "files", "_files", ApiDataFile, [], ListSerializer(KaggleObjectSerializer())),
2341
- FieldMetadata("nextPageToken", "next_page_token", "_next_page_token", str, "", PredefinedSerializer()),
2342
- FieldMetadata("childrenFetchTimeMs", "children_fetch_time_ms", "_children_fetch_time_ms", int, 0, PredefinedSerializer()),
2343
- ]
2344
-
2345
- ApiListDataTreeFilesRequest._fields = [
2346
- FieldMetadata("competitionName", "competition_name", "_competition_name", str, "", PredefinedSerializer()),
2347
- FieldMetadata("path", "path", "_path", str, None, PredefinedSerializer(), optional=True),
2348
- FieldMetadata("pageSize", "page_size", "_page_size", int, None, PredefinedSerializer(), optional=True),
2349
- FieldMetadata("pageToken", "page_token", "_page_token", str, None, PredefinedSerializer(), optional=True),
2350
- ]
2351
-
2352
- ApiListSubmissionsRequest._fields = [
2353
- FieldMetadata("competitionName", "competition_name", "_competition_name", str, "", PredefinedSerializer()),
2354
- FieldMetadata("sortBy", "sort_by", "_sort_by", SubmissionSortBy, SubmissionSortBy.SUBMISSION_SORT_BY_DATE, EnumSerializer()),
2355
- FieldMetadata("group", "group", "_group", SubmissionGroup, SubmissionGroup.SUBMISSION_GROUP_ALL, EnumSerializer()),
2356
- FieldMetadata("page", "page", "_page", int, None, PredefinedSerializer(), optional=True),
2357
- FieldMetadata("pageToken", "page_token", "_page_token", str, None, PredefinedSerializer(), optional=True),
2358
- FieldMetadata("pageSize", "page_size", "_page_size", int, None, PredefinedSerializer(), optional=True),
2359
- ]
2360
-
2361
- ApiListSubmissionsResponse._fields = [
2362
- FieldMetadata("submissions", "submissions", "_submissions", ApiSubmission, [], ListSerializer(KaggleObjectSerializer())),
2363
- FieldMetadata("nextPageToken", "next_page_token", "_next_page_token", str, "", PredefinedSerializer()),
2364
- ]
2365
-
2366
- ApiStartSubmissionUploadRequest._fields = [
2367
- FieldMetadata("competitionName", "competition_name", "_competition_name", str, None, PredefinedSerializer(), optional=True),
2368
- FieldMetadata("contentLength", "content_length", "_content_length", int, 0, PredefinedSerializer()),
2369
- FieldMetadata("lastModifiedEpochSeconds", "last_modified_epoch_seconds", "_last_modified_epoch_seconds", int, 0, PredefinedSerializer()),
2370
- FieldMetadata("fileName", "file_name", "_file_name", str, "", PredefinedSerializer()),
2371
- ]
2372
-
2373
- ApiStartSubmissionUploadResponse._fields = [
2374
- FieldMetadata("token", "token", "_token", str, "", PredefinedSerializer()),
2375
- FieldMetadata("createUrl", "create_url", "_create_url", str, "", PredefinedSerializer()),
2376
- ]
2377
-
2378
- ApiSubmission._fields = [
2379
- FieldMetadata("ref", "ref", "_ref", int, 0, PredefinedSerializer()),
2380
- FieldMetadata("totalBytes", "total_bytes", "_total_bytes", int, None, PredefinedSerializer(), optional=True),
2381
- FieldMetadata("date", "date", "_date", datetime, None, DateTimeSerializer()),
2382
- FieldMetadata("description", "description", "_description", str, None, PredefinedSerializer(), optional=True),
2383
- FieldMetadata("errorDescription", "error_description", "_error_description", str, None, PredefinedSerializer(), optional=True),
2384
- FieldMetadata("fileName", "file_name", "_file_name", str, None, PredefinedSerializer(), optional=True),
2385
- FieldMetadata("publicScore", "public_score", "_public_score", str, None, PredefinedSerializer(), optional=True),
2386
- FieldMetadata("privateScore", "private_score", "_private_score", str, None, PredefinedSerializer(), optional=True),
2387
- FieldMetadata("status", "status", "_status", SubmissionStatus, SubmissionStatus.PENDING, EnumSerializer()),
2388
- FieldMetadata("submittedBy", "submitted_by", "_submitted_by", str, None, PredefinedSerializer(), optional=True),
2389
- FieldMetadata("submittedByRef", "submitted_by_ref", "_submitted_by_ref", str, None, PredefinedSerializer(), optional=True),
2390
- FieldMetadata("teamName", "team_name", "_team_name", str, None, PredefinedSerializer(), optional=True),
2391
- FieldMetadata("url", "url", "_url", str, None, PredefinedSerializer(), optional=True),
2392
- ]
2393
-