-
Notifications
You must be signed in to change notification settings - Fork 41
/
client.html
703 lines (570 loc) · 65.6 KB
/
client.html
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
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
318
319
320
321
322
323
324
325
326
327
328
329
330
331
332
333
334
335
336
337
338
339
340
341
342
343
344
345
346
347
348
349
350
351
352
353
354
355
356
357
358
359
360
361
362
363
364
365
366
367
368
369
370
371
372
373
374
375
376
377
378
379
380
381
382
383
384
385
386
387
388
389
390
391
392
393
394
395
396
397
398
399
400
401
402
403
404
405
406
407
408
409
410
411
412
413
414
415
416
417
418
419
420
421
422
423
424
425
426
427
428
429
430
431
432
433
434
435
436
437
438
439
440
441
442
443
444
445
446
447
448
449
450
451
452
453
454
455
456
457
458
459
460
461
462
463
464
465
466
467
468
469
470
471
472
473
474
475
476
477
478
479
480
481
482
483
484
485
486
487
488
489
490
491
492
493
494
495
496
497
498
499
500
501
502
503
504
505
506
507
508
509
510
511
512
513
514
515
516
517
518
519
520
521
522
523
524
525
526
527
528
529
530
531
532
533
534
535
536
537
538
539
540
541
542
543
544
545
546
547
548
549
550
551
552
553
554
555
556
557
558
559
560
561
562
563
564
565
566
567
568
569
570
571
572
573
574
575
576
577
578
579
580
581
582
583
584
585
586
587
588
589
590
591
592
593
594
595
596
597
598
599
600
601
602
603
604
605
606
607
608
609
610
611
612
613
614
615
616
617
618
619
620
621
622
623
624
625
626
627
628
629
630
631
632
633
634
635
636
637
638
639
640
641
642
643
644
645
646
647
648
649
650
651
652
653
654
655
656
657
658
659
660
661
662
663
664
665
666
667
668
669
670
671
672
673
674
675
676
677
678
679
680
681
682
683
684
685
686
687
688
689
690
691
692
693
694
695
696
697
698
699
700
701
702
703
<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN"
"http://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd">
<html xmlns="http://www.w3.org/1999/xhtml">
<head>
<meta http-equiv="Content-Type" content="text/html; charset=utf-8" />
<title>contentful.client — Contentful 1.11.4 documentation</title>
<link rel="stylesheet" href="../../_static/alabaster.css" type="text/css" />
<link rel="stylesheet" href="../../_static/pygments.css" type="text/css" />
<script type="text/javascript">
var DOCUMENTATION_OPTIONS = {
URL_ROOT: '../../',
VERSION: '1.11.4',
COLLAPSE_INDEX: false,
FILE_SUFFIX: '.html',
HAS_SOURCE: true,
SOURCELINK_SUFFIX: '.txt'
};
</script>
<script type="text/javascript" src="../../_static/jquery.js"></script>
<script type="text/javascript" src="../../_static/underscore.js"></script>
<script type="text/javascript" src="../../_static/doctools.js"></script>
<link rel="index" title="Index" href="../../genindex.html" />
<link rel="search" title="Search" href="../../search.html" />
<link rel="stylesheet" href="../../_static/custom.css" type="text/css" />
<meta name="viewport" content="width=device-width, initial-scale=0.9, maximum-scale=0.9" />
</head>
<body>
<div class="document">
<div class="documentwrapper">
<div class="bodywrapper">
<div class="body" role="main">
<h1>Source code for contentful.client</h1><div class="highlight"><pre>
<span></span><span class="kn">import</span> <span class="nn">requests</span>
<span class="kn">import</span> <span class="nn">platform</span>
<span class="kn">from</span> <span class="nn">re</span> <span class="k">import</span> <span class="n">sub</span>
<span class="kn">from</span> <span class="nn">.utils</span> <span class="k">import</span> <span class="n">ConfigurationException</span>
<span class="kn">from</span> <span class="nn">.utils</span> <span class="k">import</span> <span class="n">retry_request</span><span class="p">,</span> <span class="n">string_class</span>
<span class="kn">from</span> <span class="nn">.errors</span> <span class="k">import</span> <span class="n">get_error</span><span class="p">,</span> <span class="n">RateLimitExceededError</span><span class="p">,</span> <span class="n">EntryNotFoundError</span>
<span class="kn">from</span> <span class="nn">.resource_builder</span> <span class="k">import</span> <span class="n">ResourceBuilder</span>
<span class="kn">from</span> <span class="nn">.content_type_cache</span> <span class="k">import</span> <span class="n">ContentTypeCache</span>
<span class="sd">"""</span>
<span class="sd">contentful.client</span>
<span class="sd">~~~~~~~~~~~~~~~~~</span>
<span class="sd">This module implements the Contentful Delivery API Client,</span>
<span class="sd">allowing interaction with every method present in it.</span>
<span class="sd">Complete API Documentation: https://www.contentful.com/developers/docs/references/content-delivery-api/</span>
<span class="sd">:copyright: (c) 2016 by Contentful GmbH.</span>
<span class="sd">:license: MIT, see LICENSE for more details.</span>
<span class="sd">"""</span>
<div class="viewcode-block" id="Client"><a class="viewcode-back" href="../../contentful.html#contentful.client.Client">[docs]</a><span class="k">class</span> <span class="nc">Client</span><span class="p">(</span><span class="nb">object</span><span class="p">):</span>
<span class="sd">"""Constructs the API Client.</span>
<span class="sd"> :param space_id: Space ID of your target space.</span>
<span class="sd"> :param access_token: API Access Token (Delivery by default,</span>
<span class="sd"> Preview if overriding api_url).</span>
<span class="sd"> :param api_url: (optional) URL of the Contentful Target API,</span>
<span class="sd"> defaults to Delivery API (can be overriden for Preview API).</span>
<span class="sd"> :param api_version: (optional) Target version of the Contentful API.</span>
<span class="sd"> :param default_locale: (optional) Default Locale for your Space,</span>
<span class="sd"> defaults to 'en-US'.</span>
<span class="sd"> :param environment: (optional) Default Environment for client, defaults</span>
<span class="sd"> to 'master'.</span>
<span class="sd"> :param https: (optional) Boolean determining wether to use https</span>
<span class="sd"> or http, defaults to True.</span>
<span class="sd"> :param authorization_as_header: (optional) Boolean determining wether</span>
<span class="sd"> to send access_token through a header or via GET params,</span>
<span class="sd"> defaults to True.</span>
<span class="sd"> :param raw_mode: (optional) Boolean determining wether to process the</span>
<span class="sd"> response or return it raw after each API call, defaults to True.</span>
<span class="sd"> :param gzip_encoded: (optional) Boolean determining wether to accept</span>
<span class="sd"> gzip encoded results, defaults to True.</span>
<span class="sd"> :param raise_errors: (optional) Boolean determining wether to raise</span>
<span class="sd"> an exception on requests that aren't successful, defaults to True.</span>
<span class="sd"> :param content_type_cache: (optional) Boolean determining wether to</span>
<span class="sd"> store a Cache of the Content Types in order to properly coerce</span>
<span class="sd"> Entry fields, defaults to True.</span>
<span class="sd"> :param reuse_entries: (optional) Boolean determining wether to reuse</span>
<span class="sd"> hydrated Entry and Asset objects within the same request when possible.</span>
<span class="sd"> Defaults to False</span>
<span class="sd"> :param proxy_host: (optional) URL for Proxy, defaults to None.</span>
<span class="sd"> :param proxy_port: (optional) Port for Proxy, defaults to None.</span>
<span class="sd"> :param proxy_username: (optional) Username for Proxy, defaults to None.</span>
<span class="sd"> :param proxy_password: (optional) Password for Proxy, defaults to None.</span>
<span class="sd"> :param max_rate_limit_retries: (optional) Maximum amount of retries</span>
<span class="sd"> after RateLimitError, defaults to 1.</span>
<span class="sd"> :param max_rate_limit_wait: (optional) Timeout (in seconds) for waiting</span>
<span class="sd"> for retry after RateLimitError, defaults to 60.</span>
<span class="sd"> :param max_include_resolution_depth: (optional) Maximum include resolution</span>
<span class="sd"> level for Resources, defaults to 20 (max include level * 2).</span>
<span class="sd"> :param application_name: (optional) User application name, defaults to None.</span>
<span class="sd"> :param application_version: (optional) User application version, defaults to None.</span>
<span class="sd"> :param integration_name: (optional) Integration name, defaults to None.</span>
<span class="sd"> :param integration_version: (optional) Integration version, defaults to None.</span>
<span class="sd"> :return: :class:`Client <Client>` object.</span>
<span class="sd"> :rtype: contentful.Client</span>
<span class="sd"> Usage:</span>
<span class="sd"> >>> import contentful</span>
<span class="sd"> >>> client = contentful.Client('cfexampleapi', 'b4c0n73n7fu1')</span>
<span class="sd"> <contentful.Client space_id="cfexampleapi"</span>
<span class="sd"> access_token="b4c0n73n7fu1"</span>
<span class="sd"> default_locale="en-US"></span>
<span class="sd"> """</span>
<span class="k">def</span> <span class="nf">__init__</span><span class="p">(</span>
<span class="bp">self</span><span class="p">,</span>
<span class="n">space_id</span><span class="p">,</span>
<span class="n">access_token</span><span class="p">,</span>
<span class="n">api_url</span><span class="o">=</span><span class="s1">'cdn.contentful.com'</span><span class="p">,</span>
<span class="n">api_version</span><span class="o">=</span><span class="mi">1</span><span class="p">,</span>
<span class="n">default_locale</span><span class="o">=</span><span class="s1">'en-US'</span><span class="p">,</span>
<span class="n">environment</span><span class="o">=</span><span class="s1">'master'</span><span class="p">,</span>
<span class="n">https</span><span class="o">=</span><span class="kc">True</span><span class="p">,</span>
<span class="n">authorization_as_header</span><span class="o">=</span><span class="kc">True</span><span class="p">,</span>
<span class="n">raw_mode</span><span class="o">=</span><span class="kc">False</span><span class="p">,</span>
<span class="n">gzip_encoded</span><span class="o">=</span><span class="kc">True</span><span class="p">,</span>
<span class="n">raise_errors</span><span class="o">=</span><span class="kc">True</span><span class="p">,</span>
<span class="n">content_type_cache</span><span class="o">=</span><span class="kc">True</span><span class="p">,</span>
<span class="n">reuse_entries</span><span class="o">=</span><span class="kc">False</span><span class="p">,</span>
<span class="n">proxy_host</span><span class="o">=</span><span class="kc">None</span><span class="p">,</span>
<span class="n">proxy_port</span><span class="o">=</span><span class="kc">None</span><span class="p">,</span>
<span class="n">proxy_username</span><span class="o">=</span><span class="kc">None</span><span class="p">,</span>
<span class="n">proxy_password</span><span class="o">=</span><span class="kc">None</span><span class="p">,</span>
<span class="n">max_rate_limit_retries</span><span class="o">=</span><span class="mi">1</span><span class="p">,</span>
<span class="n">max_rate_limit_wait</span><span class="o">=</span><span class="mi">60</span><span class="p">,</span>
<span class="n">max_include_resolution_depth</span><span class="o">=</span><span class="mi">20</span><span class="p">,</span>
<span class="n">application_name</span><span class="o">=</span><span class="kc">None</span><span class="p">,</span>
<span class="n">application_version</span><span class="o">=</span><span class="kc">None</span><span class="p">,</span>
<span class="n">integration_name</span><span class="o">=</span><span class="kc">None</span><span class="p">,</span>
<span class="n">integration_version</span><span class="o">=</span><span class="kc">None</span><span class="p">):</span>
<span class="bp">self</span><span class="o">.</span><span class="n">space_id</span> <span class="o">=</span> <span class="n">space_id</span>
<span class="bp">self</span><span class="o">.</span><span class="n">access_token</span> <span class="o">=</span> <span class="n">access_token</span>
<span class="bp">self</span><span class="o">.</span><span class="n">api_url</span> <span class="o">=</span> <span class="n">api_url</span>
<span class="bp">self</span><span class="o">.</span><span class="n">api_version</span> <span class="o">=</span> <span class="n">api_version</span>
<span class="bp">self</span><span class="o">.</span><span class="n">default_locale</span> <span class="o">=</span> <span class="n">default_locale</span>
<span class="bp">self</span><span class="o">.</span><span class="n">environment</span> <span class="o">=</span> <span class="n">environment</span>
<span class="bp">self</span><span class="o">.</span><span class="n">https</span> <span class="o">=</span> <span class="n">https</span>
<span class="bp">self</span><span class="o">.</span><span class="n">authorization_as_header</span> <span class="o">=</span> <span class="n">authorization_as_header</span>
<span class="bp">self</span><span class="o">.</span><span class="n">raw_mode</span> <span class="o">=</span> <span class="n">raw_mode</span>
<span class="bp">self</span><span class="o">.</span><span class="n">gzip_encoded</span> <span class="o">=</span> <span class="n">gzip_encoded</span>
<span class="bp">self</span><span class="o">.</span><span class="n">raise_errors</span> <span class="o">=</span> <span class="n">raise_errors</span>
<span class="bp">self</span><span class="o">.</span><span class="n">content_type_cache</span> <span class="o">=</span> <span class="n">content_type_cache</span>
<span class="bp">self</span><span class="o">.</span><span class="n">reuse_entries</span> <span class="o">=</span> <span class="n">reuse_entries</span>
<span class="bp">self</span><span class="o">.</span><span class="n">proxy_host</span> <span class="o">=</span> <span class="n">proxy_host</span>
<span class="bp">self</span><span class="o">.</span><span class="n">proxy_port</span> <span class="o">=</span> <span class="n">proxy_port</span>
<span class="bp">self</span><span class="o">.</span><span class="n">proxy_username</span> <span class="o">=</span> <span class="n">proxy_username</span>
<span class="bp">self</span><span class="o">.</span><span class="n">proxy_password</span> <span class="o">=</span> <span class="n">proxy_password</span>
<span class="bp">self</span><span class="o">.</span><span class="n">max_rate_limit_retries</span> <span class="o">=</span> <span class="n">max_rate_limit_retries</span>
<span class="bp">self</span><span class="o">.</span><span class="n">max_rate_limit_wait</span> <span class="o">=</span> <span class="n">max_rate_limit_wait</span>
<span class="bp">self</span><span class="o">.</span><span class="n">max_include_resolution_depth</span> <span class="o">=</span> <span class="n">max_include_resolution_depth</span>
<span class="bp">self</span><span class="o">.</span><span class="n">application_name</span> <span class="o">=</span> <span class="n">application_name</span>
<span class="bp">self</span><span class="o">.</span><span class="n">application_version</span> <span class="o">=</span> <span class="n">application_version</span>
<span class="bp">self</span><span class="o">.</span><span class="n">integration_name</span> <span class="o">=</span> <span class="n">integration_name</span>
<span class="bp">self</span><span class="o">.</span><span class="n">integration_version</span> <span class="o">=</span> <span class="n">integration_version</span>
<span class="bp">self</span><span class="o">.</span><span class="n">_validate_configuration</span><span class="p">()</span>
<span class="k">if</span> <span class="bp">self</span><span class="o">.</span><span class="n">content_type_cache</span><span class="p">:</span>
<span class="bp">self</span><span class="o">.</span><span class="n">_cache_content_types</span><span class="p">()</span>
<div class="viewcode-block" id="Client.space"><a class="viewcode-back" href="../../contentful.html#contentful.client.Client.space">[docs]</a> <span class="k">def</span> <span class="nf">space</span><span class="p">(</span><span class="bp">self</span><span class="p">,</span> <span class="n">query</span><span class="o">=</span><span class="kc">None</span><span class="p">):</span>
<span class="sd">"""Fetches the current Space.</span>
<span class="sd"> API Reference: https://www.contentful.com/developers/docs/references/content-delivery-api/#/reference/spaces/get-a-space</span>
<span class="sd"> :param query: (optional) Dict with API options.</span>
<span class="sd"> :return: :class:`Space <contentful.space.Space>` object.</span>
<span class="sd"> :rtype: contentful.space.Space</span>
<span class="sd"> Usage:</span>
<span class="sd"> >>> space = client.space()</span>
<span class="sd"> <Space[Contentful Example API] id='cfexampleapi'></span>
<span class="sd"> """</span>
<span class="k">return</span> <span class="bp">self</span><span class="o">.</span><span class="n">_get</span><span class="p">(</span><span class="s1">''</span><span class="p">,</span> <span class="n">query</span><span class="p">)</span></div>
<div class="viewcode-block" id="Client.content_type"><a class="viewcode-back" href="../../contentful.html#contentful.client.Client.content_type">[docs]</a> <span class="k">def</span> <span class="nf">content_type</span><span class="p">(</span><span class="bp">self</span><span class="p">,</span> <span class="n">content_type_id</span><span class="p">,</span> <span class="n">query</span><span class="o">=</span><span class="kc">None</span><span class="p">):</span>
<span class="sd">"""Fetches a Content Type by ID.</span>
<span class="sd"> API Reference: https://www.contentful.com/developers/docs/references/content-delivery-api/#/reference/content-types/content-type/get-a-single-content-type</span>
<span class="sd"> :param content_type_id: The ID of the target Content Type.</span>
<span class="sd"> :param query: (optional) Dict with API options.</span>
<span class="sd"> :return: :class:`ContentType <contentful.content_type.ContentType>` object.</span>
<span class="sd"> :rtype: contentful.content_type.ContentType</span>
<span class="sd"> Usage:</span>
<span class="sd"> >>> cat_content_type = client.content_type('cat')</span>
<span class="sd"> <ContentType[Cat] id='cat'></span>
<span class="sd"> """</span>
<span class="k">return</span> <span class="bp">self</span><span class="o">.</span><span class="n">_get</span><span class="p">(</span>
<span class="bp">self</span><span class="o">.</span><span class="n">environment_url</span><span class="p">(</span>
<span class="s1">'/content_types/</span><span class="si">{0}</span><span class="s1">'</span><span class="o">.</span><span class="n">format</span><span class="p">(</span><span class="n">content_type_id</span><span class="p">)</span>
<span class="p">),</span>
<span class="n">query</span>
<span class="p">)</span></div>
<div class="viewcode-block" id="Client.content_types"><a class="viewcode-back" href="../../contentful.html#contentful.client.Client.content_types">[docs]</a> <span class="k">def</span> <span class="nf">content_types</span><span class="p">(</span><span class="bp">self</span><span class="p">,</span> <span class="n">query</span><span class="o">=</span><span class="kc">None</span><span class="p">):</span>
<span class="sd">"""Fetches all Content Types from the Space.</span>
<span class="sd"> API Reference: https://www.contentful.com/developers/docs/references/content-delivery-api/#/reference/content-types/content-model/get-the-content-model-of-a-space</span>
<span class="sd"> :param query: (optional) Dict with API options.</span>
<span class="sd"> :return: List of :class:`ContentType <contentful.content_type.ContentType>` objects.</span>
<span class="sd"> :rtype: List of contentful.content_type.ContentType</span>
<span class="sd"> Usage:</span>
<span class="sd"> >>> content_types = client.content_types()</span>
<span class="sd"> [<ContentType[City] id='1t9IbcfdCk6m04uISSsaIK'>,</span>
<span class="sd"> <ContentType[Human] id='human'>,</span>
<span class="sd"> <ContentType[Dog] id='dog'>,</span>
<span class="sd"> <ContentType[Cat] id='cat'>]</span>
<span class="sd"> """</span>
<span class="k">return</span> <span class="bp">self</span><span class="o">.</span><span class="n">_get</span><span class="p">(</span>
<span class="bp">self</span><span class="o">.</span><span class="n">environment_url</span><span class="p">(</span><span class="s1">'/content_types'</span><span class="p">),</span>
<span class="n">query</span>
<span class="p">)</span></div>
<div class="viewcode-block" id="Client.entry"><a class="viewcode-back" href="../../contentful.html#contentful.client.Client.entry">[docs]</a> <span class="k">def</span> <span class="nf">entry</span><span class="p">(</span><span class="bp">self</span><span class="p">,</span> <span class="n">entry_id</span><span class="p">,</span> <span class="n">query</span><span class="o">=</span><span class="kc">None</span><span class="p">):</span>
<span class="sd">"""Fetches an Entry by ID.</span>
<span class="sd"> API Reference: https://www.contentful.com/developers/docs/references/content-delivery-api/#/reference/entries/entry/get-a-single-entry</span>
<span class="sd"> :param entry_id: The ID of the target Entry.</span>
<span class="sd"> :param query: (optional) Dict with API options.</span>
<span class="sd"> :return: :class:`Entry <contentful.entry.Entry>` object.</span>
<span class="sd"> :rtype: contentful.entry.Entry</span>
<span class="sd"> Usage:</span>
<span class="sd"> >>> nyancat_entry = client.entry('nyancat')</span>
<span class="sd"> <Entry[cat] id='nyancat'></span>
<span class="sd"> """</span>
<span class="k">if</span> <span class="n">query</span> <span class="ow">is</span> <span class="kc">None</span><span class="p">:</span>
<span class="n">query</span> <span class="o">=</span> <span class="p">{}</span>
<span class="bp">self</span><span class="o">.</span><span class="n">_normalize_select</span><span class="p">(</span><span class="n">query</span><span class="p">)</span>
<span class="k">try</span><span class="p">:</span>
<span class="n">query</span><span class="o">.</span><span class="n">update</span><span class="p">({</span><span class="s1">'sys.id'</span><span class="p">:</span> <span class="n">entry_id</span><span class="p">})</span>
<span class="k">return</span> <span class="bp">self</span><span class="o">.</span><span class="n">_get</span><span class="p">(</span>
<span class="bp">self</span><span class="o">.</span><span class="n">environment_url</span><span class="p">(</span><span class="s1">'/entries'</span><span class="p">),</span>
<span class="n">query</span>
<span class="p">)[</span><span class="mi">0</span><span class="p">]</span>
<span class="k">except</span> <span class="ne">IndexError</span><span class="p">:</span>
<span class="k">raise</span> <span class="n">EntryNotFoundError</span><span class="p">(</span>
<span class="s2">"Entry not found for ID: '</span><span class="si">{0}</span><span class="s2">'"</span><span class="o">.</span><span class="n">format</span><span class="p">(</span><span class="n">entry_id</span><span class="p">)</span>
<span class="p">)</span></div>
<div class="viewcode-block" id="Client.entries"><a class="viewcode-back" href="../../contentful.html#contentful.client.Client.entries">[docs]</a> <span class="k">def</span> <span class="nf">entries</span><span class="p">(</span><span class="bp">self</span><span class="p">,</span> <span class="n">query</span><span class="o">=</span><span class="kc">None</span><span class="p">):</span>
<span class="sd">"""Fetches all Entries from the Space (up to the set limit, can be modified in `query`).</span>
<span class="sd"> API Reference: https://www.contentful.com/developers/docs/references/content-delivery-api/#/reference/entries/entries-collection/get-all-entries-of-a-space</span>
<span class="sd"> :param query: (optional) Dict with API options.</span>
<span class="sd"> :return: List of :class:`Entry <contentful.entry.Entry>` objects.</span>
<span class="sd"> :rtype: List of contentful.entry.Entry</span>
<span class="sd"> Usage:</span>
<span class="sd"> >>> entries = client.entries()</span>
<span class="sd"> [<Entry[cat] id='happycat'>,</span>
<span class="sd"> <Entry[1t9IbcfdCk6m04uISSsaIK] id='5ETMRzkl9KM4omyMwKAOki'>,</span>
<span class="sd"> <Entry[dog] id='6KntaYXaHSyIw8M6eo26OK'>,</span>
<span class="sd"> <Entry[1t9IbcfdCk6m04uISSsaIK] id='7qVBlCjpWE86Oseo40gAEY'>,</span>
<span class="sd"> <Entry[cat] id='garfield'>,</span>
<span class="sd"> <Entry[1t9IbcfdCk6m04uISSsaIK] id='4MU1s3potiUEM2G4okYOqw'>,</span>
<span class="sd"> <Entry[cat] id='nyancat'>,</span>
<span class="sd"> <Entry[1t9IbcfdCk6m04uISSsaIK] id='ge1xHyH3QOWucKWCCAgIG'>,</span>
<span class="sd"> <Entry[human] id='finn'>,</span>
<span class="sd"> <Entry[dog] id='jake'>]</span>
<span class="sd"> """</span>
<span class="k">if</span> <span class="n">query</span> <span class="ow">is</span> <span class="kc">None</span><span class="p">:</span>
<span class="n">query</span> <span class="o">=</span> <span class="p">{}</span>
<span class="bp">self</span><span class="o">.</span><span class="n">_normalize_select</span><span class="p">(</span><span class="n">query</span><span class="p">)</span>
<span class="k">return</span> <span class="bp">self</span><span class="o">.</span><span class="n">_get</span><span class="p">(</span>
<span class="bp">self</span><span class="o">.</span><span class="n">environment_url</span><span class="p">(</span><span class="s1">'/entries'</span><span class="p">),</span>
<span class="n">query</span>
<span class="p">)</span></div>
<div class="viewcode-block" id="Client.asset"><a class="viewcode-back" href="../../contentful.html#contentful.client.Client.asset">[docs]</a> <span class="k">def</span> <span class="nf">asset</span><span class="p">(</span><span class="bp">self</span><span class="p">,</span> <span class="n">asset_id</span><span class="p">,</span> <span class="n">query</span><span class="o">=</span><span class="kc">None</span><span class="p">):</span>
<span class="sd">"""Fetches an Asset by ID.</span>
<span class="sd"> API Reference: https://www.contentful.com/developers/docs/references/content-delivery-api/#/reference/assets/asset/get-a-single-asset</span>
<span class="sd"> :param asset_id: The ID of the target Asset.</span>
<span class="sd"> :param query: (optional) Dict with API options.</span>
<span class="sd"> :return: :class:`Asset <Asset>` object.</span>
<span class="sd"> :rtype: contentful.asset.Asset</span>
<span class="sd"> Usage:</span>
<span class="sd"> >>> nyancat_asset = client.asset('nyancat')</span>
<span class="sd"> <Asset id='nyancat' url='//images.contentful.com/cfex...'></span>
<span class="sd"> """</span>
<span class="k">return</span> <span class="bp">self</span><span class="o">.</span><span class="n">_get</span><span class="p">(</span>
<span class="bp">self</span><span class="o">.</span><span class="n">environment_url</span><span class="p">(</span>
<span class="s1">'/assets/</span><span class="si">{0}</span><span class="s1">'</span><span class="o">.</span><span class="n">format</span><span class="p">(</span><span class="n">asset_id</span><span class="p">)</span>
<span class="p">),</span>
<span class="n">query</span>
<span class="p">)</span></div>
<div class="viewcode-block" id="Client.assets"><a class="viewcode-back" href="../../contentful.html#contentful.client.Client.assets">[docs]</a> <span class="k">def</span> <span class="nf">assets</span><span class="p">(</span><span class="bp">self</span><span class="p">,</span> <span class="n">query</span><span class="o">=</span><span class="kc">None</span><span class="p">):</span>
<span class="sd">"""Fetches all Assets from the Space (up to the set limit, can be modified in `query`).</span>
<span class="sd"> API Reference: https://www.contentful.com/developers/docs/references/content-delivery-api/#/reference/assets/assets-collection/get-all-assets-of-a-space</span>
<span class="sd"> :param query: (optional) Dict with API options.</span>
<span class="sd"> :return: List of :class:`Asset <contentful.asset.Asset>` objects.</span>
<span class="sd"> :rtype: List of contentful.asset.Asset</span>
<span class="sd"> Usage:</span>
<span class="sd"> >>> assets = client.assets()</span>
<span class="sd"> [<Asset id='1x0xpXu4pSGS4OukSyWGUK' url='//images.content...'>,</span>
<span class="sd"> <Asset id='happycat' url='//images.contentful.com/cfexam...'>,</span>
<span class="sd"> <Asset id='nyancat' url='//images.contentful.com/cfexamp...'>,</span>
<span class="sd"> <Asset id='jake' url='//images.contentful.com/cfexamplea...'>]</span>
<span class="sd"> """</span>
<span class="k">if</span> <span class="n">query</span> <span class="ow">is</span> <span class="kc">None</span><span class="p">:</span>
<span class="n">query</span> <span class="o">=</span> <span class="p">{}</span>
<span class="bp">self</span><span class="o">.</span><span class="n">_normalize_select</span><span class="p">(</span><span class="n">query</span><span class="p">)</span>
<span class="k">return</span> <span class="bp">self</span><span class="o">.</span><span class="n">_get</span><span class="p">(</span>
<span class="bp">self</span><span class="o">.</span><span class="n">environment_url</span><span class="p">(</span><span class="s1">'/assets'</span><span class="p">),</span>
<span class="n">query</span>
<span class="p">)</span></div>
<div class="viewcode-block" id="Client.locales"><a class="viewcode-back" href="../../contentful.html#contentful.client.Client.locales">[docs]</a> <span class="k">def</span> <span class="nf">locales</span><span class="p">(</span><span class="bp">self</span><span class="p">,</span> <span class="n">query</span><span class="o">=</span><span class="kc">None</span><span class="p">):</span>
<span class="sd">"""Fetches all Locales from the Environment (up to the set limit, can be modified in `query`).</span>
<span class="sd"> # TODO: fix url</span>
<span class="sd"> API Reference: https://www.contentful.com/developers/docs/references/content-delivery-api/#/reference/assets/assets-collection/get-all-assets-of-a-space</span>
<span class="sd"> :param query: (optional) Dict with API options.</span>
<span class="sd"> :return: List of :class:`Locale <contentful.locale.Locale>` objects.</span>
<span class="sd"> :rtype: List of contentful.locale.Locale</span>
<span class="sd"> Usage:</span>
<span class="sd"> >>> locales = client.locales()</span>
<span class="sd"> [<Locale[English (United States)] code='en-US' default=True fallback_code=None optional=False>]</span>
<span class="sd"> """</span>
<span class="k">if</span> <span class="n">query</span> <span class="ow">is</span> <span class="kc">None</span><span class="p">:</span>
<span class="n">query</span> <span class="o">=</span> <span class="p">{}</span>
<span class="k">return</span> <span class="bp">self</span><span class="o">.</span><span class="n">_get</span><span class="p">(</span>
<span class="bp">self</span><span class="o">.</span><span class="n">environment_url</span><span class="p">(</span><span class="s1">'/locales'</span><span class="p">),</span>
<span class="n">query</span>
<span class="p">)</span></div>
<div class="viewcode-block" id="Client.sync"><a class="viewcode-back" href="../../contentful.html#contentful.client.Client.sync">[docs]</a> <span class="k">def</span> <span class="nf">sync</span><span class="p">(</span><span class="bp">self</span><span class="p">,</span> <span class="n">query</span><span class="o">=</span><span class="kc">None</span><span class="p">):</span>
<span class="sd">"""Fetches content from the Sync API.</span>
<span class="sd"> API Reference: https://www.contentful.com/developers/docs/references/content-delivery-api/#/reference/synchronization/initial-synchronization/query-entries</span>
<span class="sd"> :param query: (optional) Dict with API options.</span>
<span class="sd"> :return: :class:`SyncPage <contentful.sync_page.SyncPage>` object.</span>
<span class="sd"> :rtype: contentful.sync_page.SyncPage</span>
<span class="sd"> Usage:</span>
<span class="sd"> >>> sync_page = client.sync({'initial': True})</span>
<span class="sd"> <SyncPage next_sync_token='w5ZGw6JFwqZmVcKsE8Kow4grw45QdybC...'></span>
<span class="sd"> """</span>
<span class="k">if</span> <span class="n">query</span> <span class="ow">is</span> <span class="kc">None</span><span class="p">:</span>
<span class="n">query</span> <span class="o">=</span> <span class="p">{}</span>
<span class="bp">self</span><span class="o">.</span><span class="n">_normalize_sync</span><span class="p">(</span><span class="n">query</span><span class="p">)</span>
<span class="k">return</span> <span class="bp">self</span><span class="o">.</span><span class="n">_get</span><span class="p">(</span>
<span class="bp">self</span><span class="o">.</span><span class="n">environment_url</span><span class="p">(</span><span class="s1">'/sync'</span><span class="p">),</span>
<span class="n">query</span>
<span class="p">)</span></div>
<div class="viewcode-block" id="Client.environment_url"><a class="viewcode-back" href="../../contentful.html#contentful.client.Client.environment_url">[docs]</a> <span class="k">def</span> <span class="nf">environment_url</span><span class="p">(</span><span class="bp">self</span><span class="p">,</span> <span class="n">url</span><span class="p">):</span>
<span class="sd">"""Formats the URL with the environment."""</span>
<span class="k">return</span> <span class="s2">"/environments/</span><span class="si">{0}{1}</span><span class="s2">"</span><span class="o">.</span><span class="n">format</span><span class="p">(</span>
<span class="bp">self</span><span class="o">.</span><span class="n">environment</span><span class="p">,</span>
<span class="n">url</span>
<span class="p">)</span></div>
<span class="k">def</span> <span class="nf">_normalize_select</span><span class="p">(</span><span class="bp">self</span><span class="p">,</span> <span class="n">query</span><span class="p">):</span>
<span class="sd">"""</span>
<span class="sd"> If the query contains the :select operator, we enforce :sys properties.</span>
<span class="sd"> The SDK requires sys.type to function properly, but as other of our</span>
<span class="sd"> SDKs require more parts of the :sys properties, we decided that every</span>
<span class="sd"> SDK should include the complete :sys block to provide consistency</span>
<span class="sd"> accross our SDKs.</span>
<span class="sd"> """</span>
<span class="k">if</span> <span class="s1">'select'</span> <span class="ow">not</span> <span class="ow">in</span> <span class="n">query</span><span class="p">:</span>
<span class="k">return</span>
<span class="k">if</span> <span class="nb">isinstance</span><span class="p">(</span>
<span class="n">query</span><span class="p">[</span><span class="s1">'select'</span><span class="p">],</span>
<span class="n">string_class</span><span class="p">()):</span>
<span class="n">query</span><span class="p">[</span><span class="s1">'select'</span><span class="p">]</span> <span class="o">=</span> <span class="p">[</span><span class="n">s</span><span class="o">.</span><span class="n">strip</span><span class="p">()</span> <span class="k">for</span> <span class="n">s</span> <span class="ow">in</span> <span class="n">query</span><span class="p">[</span><span class="s1">'select'</span><span class="p">]</span><span class="o">.</span><span class="n">split</span><span class="p">(</span><span class="s1">','</span><span class="p">)]</span>
<span class="n">query</span><span class="p">[</span><span class="s1">'select'</span><span class="p">]</span> <span class="o">=</span> <span class="p">[</span><span class="n">s</span> <span class="k">for</span> <span class="n">s</span>
<span class="ow">in</span> <span class="n">query</span><span class="p">[</span><span class="s1">'select'</span><span class="p">]</span>
<span class="k">if</span> <span class="ow">not</span> <span class="n">s</span><span class="o">.</span><span class="n">startswith</span><span class="p">(</span><span class="s1">'sys.'</span><span class="p">)]</span>
<span class="k">if</span> <span class="s1">'sys'</span> <span class="ow">not</span> <span class="ow">in</span> <span class="n">query</span><span class="p">[</span><span class="s1">'select'</span><span class="p">]:</span>
<span class="n">query</span><span class="p">[</span><span class="s1">'select'</span><span class="p">]</span><span class="o">.</span><span class="n">append</span><span class="p">(</span><span class="s1">'sys'</span><span class="p">)</span>
<span class="k">def</span> <span class="nf">_normalize_sync</span><span class="p">(</span><span class="bp">self</span><span class="p">,</span> <span class="n">query</span><span class="p">):</span>
<span class="sd">"""</span>
<span class="sd"> Booleans are not properly serialized for GET params,</span>
<span class="sd"> therefore we enforce it to a truthy value.</span>
<span class="sd"> """</span>
<span class="k">if</span> <span class="s1">'initial'</span> <span class="ow">in</span> <span class="n">query</span><span class="p">:</span>
<span class="n">query</span><span class="p">[</span><span class="s1">'initial'</span><span class="p">]</span> <span class="o">=</span> <span class="s1">'true'</span>
<span class="k">def</span> <span class="nf">_validate_configuration</span><span class="p">(</span><span class="bp">self</span><span class="p">):</span>
<span class="sd">"""</span>
<span class="sd"> Validates that required parameters are present.</span>
<span class="sd"> """</span>
<span class="k">if</span> <span class="ow">not</span> <span class="bp">self</span><span class="o">.</span><span class="n">space_id</span><span class="p">:</span>
<span class="k">raise</span> <span class="n">ConfigurationException</span><span class="p">(</span>
<span class="s1">'You will need to initialize a client with a Space ID'</span>
<span class="p">)</span>
<span class="k">if</span> <span class="ow">not</span> <span class="bp">self</span><span class="o">.</span><span class="n">access_token</span><span class="p">:</span>
<span class="k">raise</span> <span class="n">ConfigurationException</span><span class="p">(</span>
<span class="s1">'You will need to initialize a client with an Access Token'</span>
<span class="p">)</span>
<span class="k">if</span> <span class="ow">not</span> <span class="bp">self</span><span class="o">.</span><span class="n">api_url</span><span class="p">:</span>
<span class="k">raise</span> <span class="n">ConfigurationException</span><span class="p">(</span>
<span class="s1">'The client configuration needs to contain an API URL'</span>
<span class="p">)</span>
<span class="k">if</span> <span class="ow">not</span> <span class="bp">self</span><span class="o">.</span><span class="n">default_locale</span><span class="p">:</span>
<span class="k">raise</span> <span class="n">ConfigurationException</span><span class="p">(</span>
<span class="s1">'The client configuration needs to contain a Default Locale'</span>
<span class="p">)</span>
<span class="k">if</span> <span class="ow">not</span> <span class="bp">self</span><span class="o">.</span><span class="n">api_version</span> <span class="ow">or</span> <span class="bp">self</span><span class="o">.</span><span class="n">api_version</span> <span class="o"><</span> <span class="mi">1</span><span class="p">:</span>
<span class="k">raise</span> <span class="n">ConfigurationException</span><span class="p">(</span>
<span class="s1">'The API Version must be a positive number'</span>
<span class="p">)</span>
<span class="k">def</span> <span class="nf">_cache_content_types</span><span class="p">(</span><span class="bp">self</span><span class="p">):</span>
<span class="sd">"""</span>
<span class="sd"> Updates the Content Type Cache.</span>
<span class="sd"> """</span>
<span class="n">ContentTypeCache</span><span class="o">.</span><span class="n">update_cache</span><span class="p">(</span><span class="bp">self</span><span class="p">)</span>
<span class="k">def</span> <span class="nf">_contentful_user_agent</span><span class="p">(</span><span class="bp">self</span><span class="p">):</span>
<span class="sd">"""</span>
<span class="sd"> Sets the X-Contentful-User-Agent header.</span>
<span class="sd"> """</span>
<span class="n">header</span> <span class="o">=</span> <span class="p">{}</span>
<span class="kn">from</span> <span class="nn">.</span> <span class="k">import</span> <span class="n">__version__</span>
<span class="n">header</span><span class="p">[</span><span class="s1">'sdk'</span><span class="p">]</span> <span class="o">=</span> <span class="p">{</span>
<span class="s1">'name'</span><span class="p">:</span> <span class="s1">'contentful.py'</span><span class="p">,</span>
<span class="s1">'version'</span><span class="p">:</span> <span class="n">__version__</span>
<span class="p">}</span>
<span class="n">header</span><span class="p">[</span><span class="s1">'app'</span><span class="p">]</span> <span class="o">=</span> <span class="p">{</span>
<span class="s1">'name'</span><span class="p">:</span> <span class="bp">self</span><span class="o">.</span><span class="n">application_name</span><span class="p">,</span>
<span class="s1">'version'</span><span class="p">:</span> <span class="bp">self</span><span class="o">.</span><span class="n">application_version</span>
<span class="p">}</span>
<span class="n">header</span><span class="p">[</span><span class="s1">'integration'</span><span class="p">]</span> <span class="o">=</span> <span class="p">{</span>
<span class="s1">'name'</span><span class="p">:</span> <span class="bp">self</span><span class="o">.</span><span class="n">integration_name</span><span class="p">,</span>
<span class="s1">'version'</span><span class="p">:</span> <span class="bp">self</span><span class="o">.</span><span class="n">integration_version</span>
<span class="p">}</span>
<span class="n">header</span><span class="p">[</span><span class="s1">'platform'</span><span class="p">]</span> <span class="o">=</span> <span class="p">{</span>
<span class="s1">'name'</span><span class="p">:</span> <span class="s1">'python'</span><span class="p">,</span>
<span class="s1">'version'</span><span class="p">:</span> <span class="n">platform</span><span class="o">.</span><span class="n">python_version</span><span class="p">()</span>
<span class="p">}</span>
<span class="n">os_name</span> <span class="o">=</span> <span class="n">platform</span><span class="o">.</span><span class="n">system</span><span class="p">()</span>
<span class="k">if</span> <span class="n">os_name</span> <span class="o">==</span> <span class="s1">'Darwin'</span><span class="p">:</span>
<span class="n">os_name</span> <span class="o">=</span> <span class="s1">'macOS'</span>
<span class="k">elif</span> <span class="ow">not</span> <span class="n">os_name</span> <span class="ow">or</span> <span class="n">os_name</span> <span class="o">==</span> <span class="s1">'Java'</span><span class="p">:</span>
<span class="n">os_name</span> <span class="o">=</span> <span class="kc">None</span>
<span class="k">elif</span> <span class="n">os_name</span> <span class="ow">and</span> <span class="n">os_name</span> <span class="ow">not</span> <span class="ow">in</span> <span class="p">[</span><span class="s1">'macOS'</span><span class="p">,</span> <span class="s1">'Windows'</span><span class="p">]:</span>
<span class="n">os_name</span> <span class="o">=</span> <span class="s1">'Linux'</span>
<span class="n">header</span><span class="p">[</span><span class="s1">'os'</span><span class="p">]</span> <span class="o">=</span> <span class="p">{</span>
<span class="s1">'name'</span><span class="p">:</span> <span class="n">os_name</span><span class="p">,</span>
<span class="s1">'version'</span><span class="p">:</span> <span class="n">platform</span><span class="o">.</span><span class="n">release</span><span class="p">()</span>
<span class="p">}</span>
<span class="k">def</span> <span class="nf">format_header</span><span class="p">(</span><span class="n">key</span><span class="p">,</span> <span class="n">values</span><span class="p">):</span>
<span class="n">header</span> <span class="o">=</span> <span class="s2">"</span><span class="si">{0}</span><span class="s2"> </span><span class="si">{1}</span><span class="s2">"</span><span class="o">.</span><span class="n">format</span><span class="p">(</span><span class="n">key</span><span class="p">,</span> <span class="n">values</span><span class="p">[</span><span class="s1">'name'</span><span class="p">])</span>
<span class="k">if</span> <span class="n">values</span><span class="p">[</span><span class="s1">'version'</span><span class="p">]</span> <span class="ow">is</span> <span class="ow">not</span> <span class="kc">None</span><span class="p">:</span>
<span class="n">header</span> <span class="o">=</span> <span class="s2">"</span><span class="si">{0}</span><span class="s2">/</span><span class="si">{1}</span><span class="s2">"</span><span class="o">.</span><span class="n">format</span><span class="p">(</span><span class="n">header</span><span class="p">,</span> <span class="n">values</span><span class="p">[</span><span class="s1">'version'</span><span class="p">])</span>
<span class="k">return</span> <span class="s2">"</span><span class="si">{0}</span><span class="s2">;"</span><span class="o">.</span><span class="n">format</span><span class="p">(</span><span class="n">header</span><span class="p">)</span>
<span class="n">result</span> <span class="o">=</span> <span class="p">[]</span>
<span class="k">for</span> <span class="n">k</span><span class="p">,</span> <span class="n">values</span> <span class="ow">in</span> <span class="n">header</span><span class="o">.</span><span class="n">items</span><span class="p">():</span>
<span class="k">if</span> <span class="ow">not</span> <span class="n">values</span><span class="p">[</span><span class="s1">'name'</span><span class="p">]:</span>
<span class="k">continue</span>
<span class="n">result</span><span class="o">.</span><span class="n">append</span><span class="p">(</span><span class="n">format_header</span><span class="p">(</span><span class="n">k</span><span class="p">,</span> <span class="n">values</span><span class="p">))</span>
<span class="k">return</span> <span class="s1">' '</span><span class="o">.</span><span class="n">join</span><span class="p">(</span><span class="n">result</span><span class="p">)</span>
<span class="k">def</span> <span class="nf">_request_headers</span><span class="p">(</span><span class="bp">self</span><span class="p">):</span>
<span class="sd">"""</span>
<span class="sd"> Sets the default Request Headers.</span>
<span class="sd"> """</span>
<span class="n">headers</span> <span class="o">=</span> <span class="p">{</span>
<span class="s1">'X-Contentful-User-Agent'</span><span class="p">:</span> <span class="bp">self</span><span class="o">.</span><span class="n">_contentful_user_agent</span><span class="p">(),</span>
<span class="s1">'Content-Type'</span><span class="p">:</span> <span class="s1">'application/vnd.contentful.delivery.v</span><span class="si">{0}</span><span class="s1">+json'</span><span class="o">.</span><span class="n">format</span><span class="p">(</span> <span class="c1"># noqa: E501</span>
<span class="bp">self</span><span class="o">.</span><span class="n">api_version</span>
<span class="p">)</span>
<span class="p">}</span>
<span class="k">if</span> <span class="bp">self</span><span class="o">.</span><span class="n">authorization_as_header</span><span class="p">:</span>
<span class="n">headers</span><span class="p">[</span><span class="s1">'Authorization'</span><span class="p">]</span> <span class="o">=</span> <span class="s1">'Bearer </span><span class="si">{0}</span><span class="s1">'</span><span class="o">.</span><span class="n">format</span><span class="p">(</span><span class="bp">self</span><span class="o">.</span><span class="n">access_token</span><span class="p">)</span>
<span class="n">headers</span><span class="p">[</span><span class="s1">'Accept-Encoding'</span><span class="p">]</span> <span class="o">=</span> <span class="s1">'gzip'</span> <span class="k">if</span> <span class="bp">self</span><span class="o">.</span><span class="n">gzip_encoded</span> <span class="k">else</span> <span class="s1">'identity'</span>
<span class="k">return</span> <span class="n">headers</span>
<span class="k">def</span> <span class="nf">_url</span><span class="p">(</span><span class="bp">self</span><span class="p">,</span> <span class="n">url</span><span class="p">):</span>
<span class="sd">"""</span>
<span class="sd"> Creates the Request URL.</span>
<span class="sd"> """</span>
<span class="n">protocol</span> <span class="o">=</span> <span class="s1">'https'</span> <span class="k">if</span> <span class="bp">self</span><span class="o">.</span><span class="n">https</span> <span class="k">else</span> <span class="s1">'http'</span>
<span class="k">return</span> <span class="s1">'</span><span class="si">{0}</span><span class="s1">://</span><span class="si">{1}</span><span class="s1">/spaces/</span><span class="si">{2}{3}</span><span class="s1">'</span><span class="o">.</span><span class="n">format</span><span class="p">(</span>
<span class="n">protocol</span><span class="p">,</span>
<span class="bp">self</span><span class="o">.</span><span class="n">api_url</span><span class="p">,</span>
<span class="bp">self</span><span class="o">.</span><span class="n">space_id</span><span class="p">,</span>
<span class="n">url</span>
<span class="p">)</span>
<span class="k">def</span> <span class="nf">_normalize_query</span><span class="p">(</span><span class="bp">self</span><span class="p">,</span> <span class="n">query</span><span class="p">):</span>
<span class="sd">"""</span>
<span class="sd"> Converts Arrays in the query to comma</span>
<span class="sd"> separaters lists for proper API handling.</span>
<span class="sd"> """</span>
<span class="k">for</span> <span class="n">k</span><span class="p">,</span> <span class="n">v</span> <span class="ow">in</span> <span class="n">query</span><span class="o">.</span><span class="n">items</span><span class="p">():</span>
<span class="k">if</span> <span class="nb">isinstance</span><span class="p">(</span><span class="n">v</span><span class="p">,</span> <span class="nb">list</span><span class="p">):</span>
<span class="n">query</span><span class="p">[</span><span class="n">k</span><span class="p">]</span> <span class="o">=</span> <span class="s1">','</span><span class="o">.</span><span class="n">join</span><span class="p">([</span><span class="nb">str</span><span class="p">(</span><span class="n">e</span><span class="p">)</span> <span class="k">for</span> <span class="n">e</span> <span class="ow">in</span> <span class="n">v</span><span class="p">])</span>
<span class="k">def</span> <span class="nf">_http_get</span><span class="p">(</span><span class="bp">self</span><span class="p">,</span> <span class="n">url</span><span class="p">,</span> <span class="n">query</span><span class="p">):</span>
<span class="sd">"""</span>
<span class="sd"> Performs the HTTP GET Request.</span>
<span class="sd"> """</span>
<span class="k">if</span> <span class="ow">not</span> <span class="bp">self</span><span class="o">.</span><span class="n">authorization_as_header</span><span class="p">:</span>
<span class="n">query</span><span class="o">.</span><span class="n">update</span><span class="p">({</span><span class="s1">'access_token'</span><span class="p">:</span> <span class="bp">self</span><span class="o">.</span><span class="n">access_token</span><span class="p">})</span>
<span class="n">response</span> <span class="o">=</span> <span class="kc">None</span>
<span class="bp">self</span><span class="o">.</span><span class="n">_normalize_query</span><span class="p">(</span><span class="n">query</span><span class="p">)</span>
<span class="n">kwargs</span> <span class="o">=</span> <span class="p">{</span>
<span class="s1">'params'</span><span class="p">:</span> <span class="n">query</span><span class="p">,</span>
<span class="s1">'headers'</span><span class="p">:</span> <span class="bp">self</span><span class="o">.</span><span class="n">_request_headers</span><span class="p">()</span>
<span class="p">}</span>
<span class="k">if</span> <span class="bp">self</span><span class="o">.</span><span class="n">_has_proxy</span><span class="p">():</span>
<span class="n">kwargs</span><span class="p">[</span><span class="s1">'proxies'</span><span class="p">]</span> <span class="o">=</span> <span class="bp">self</span><span class="o">.</span><span class="n">_proxy_parameters</span><span class="p">()</span>
<span class="n">response</span> <span class="o">=</span> <span class="n">requests</span><span class="o">.</span><span class="n">get</span><span class="p">(</span>
<span class="bp">self</span><span class="o">.</span><span class="n">_url</span><span class="p">(</span><span class="n">url</span><span class="p">),</span>
<span class="o">**</span><span class="n">kwargs</span>
<span class="p">)</span>
<span class="k">if</span> <span class="n">response</span><span class="o">.</span><span class="n">status_code</span> <span class="o">==</span> <span class="mi">429</span><span class="p">:</span>
<span class="k">raise</span> <span class="n">RateLimitExceededError</span><span class="p">(</span><span class="n">response</span><span class="p">)</span>
<span class="k">return</span> <span class="n">response</span>
<span class="k">def</span> <span class="nf">_get</span><span class="p">(</span><span class="bp">self</span><span class="p">,</span> <span class="n">url</span><span class="p">,</span> <span class="n">query</span><span class="o">=</span><span class="kc">None</span><span class="p">):</span>
<span class="sd">"""</span>
<span class="sd"> Wrapper for the HTTP Request,</span>
<span class="sd"> Rate Limit Backoff is handled here,</span>
<span class="sd"> Responses are Processed with ResourceBuilder.</span>
<span class="sd"> """</span>
<span class="k">if</span> <span class="n">query</span> <span class="ow">is</span> <span class="kc">None</span><span class="p">:</span>
<span class="n">query</span> <span class="o">=</span> <span class="p">{}</span>
<span class="n">response</span> <span class="o">=</span> <span class="n">retry_request</span><span class="p">(</span><span class="bp">self</span><span class="p">)(</span><span class="bp">self</span><span class="o">.</span><span class="n">_http_get</span><span class="p">)(</span><span class="n">url</span><span class="p">,</span> <span class="n">query</span><span class="o">=</span><span class="n">query</span><span class="p">)</span>
<span class="k">if</span> <span class="bp">self</span><span class="o">.</span><span class="n">raw_mode</span><span class="p">:</span>
<span class="k">return</span> <span class="n">response</span>
<span class="k">if</span> <span class="n">response</span><span class="o">.</span><span class="n">status_code</span> <span class="o">!=</span> <span class="mi">200</span><span class="p">:</span>
<span class="n">error</span> <span class="o">=</span> <span class="n">get_error</span><span class="p">(</span><span class="n">response</span><span class="p">)</span>
<span class="k">if</span> <span class="bp">self</span><span class="o">.</span><span class="n">raise_errors</span><span class="p">:</span>
<span class="k">raise</span> <span class="n">error</span>
<span class="k">return</span> <span class="n">error</span>
<span class="n">localized</span> <span class="o">=</span> <span class="n">query</span><span class="o">.</span><span class="n">get</span><span class="p">(</span><span class="s1">'locale'</span><span class="p">,</span> <span class="s1">''</span><span class="p">)</span> <span class="o">==</span> <span class="s1">'*'</span>
<span class="k">return</span> <span class="n">ResourceBuilder</span><span class="p">(</span>
<span class="bp">self</span><span class="o">.</span><span class="n">default_locale</span><span class="p">,</span>
<span class="n">localized</span><span class="p">,</span>
<span class="n">response</span><span class="o">.</span><span class="n">json</span><span class="p">(),</span>
<span class="n">max_depth</span><span class="o">=</span><span class="bp">self</span><span class="o">.</span><span class="n">max_include_resolution_depth</span><span class="p">,</span>
<span class="n">reuse_entries</span><span class="o">=</span><span class="bp">self</span><span class="o">.</span><span class="n">reuse_entries</span>
<span class="p">)</span><span class="o">.</span><span class="n">build</span><span class="p">()</span>
<span class="k">def</span> <span class="nf">_has_proxy</span><span class="p">(</span><span class="bp">self</span><span class="p">):</span>
<span class="sd">"""</span>
<span class="sd"> Checks if a Proxy was set.</span>
<span class="sd"> """</span>
<span class="k">return</span> <span class="bp">self</span><span class="o">.</span><span class="n">proxy_host</span>
<span class="k">def</span> <span class="nf">_proxy_parameters</span><span class="p">(</span><span class="bp">self</span><span class="p">):</span>
<span class="sd">"""</span>
<span class="sd"> Builds Proxy parameters Dict from</span>
<span class="sd"> client options.</span>
<span class="sd"> """</span>
<span class="n">proxy_protocol</span> <span class="o">=</span> <span class="s1">''</span>
<span class="k">if</span> <span class="bp">self</span><span class="o">.</span><span class="n">proxy_host</span><span class="o">.</span><span class="n">startswith</span><span class="p">(</span><span class="s1">'https'</span><span class="p">):</span>
<span class="n">proxy_protocol</span> <span class="o">=</span> <span class="s1">'https'</span>
<span class="k">else</span><span class="p">:</span>
<span class="n">proxy_protocol</span> <span class="o">=</span> <span class="s1">'http'</span>
<span class="n">proxy</span> <span class="o">=</span> <span class="s1">'</span><span class="si">{0}</span><span class="s1">://'</span><span class="o">.</span><span class="n">format</span><span class="p">(</span><span class="n">proxy_protocol</span><span class="p">)</span>
<span class="k">if</span> <span class="bp">self</span><span class="o">.</span><span class="n">proxy_username</span> <span class="ow">and</span> <span class="bp">self</span><span class="o">.</span><span class="n">proxy_password</span><span class="p">:</span>
<span class="n">proxy</span> <span class="o">+=</span> <span class="s1">'</span><span class="si">{0}</span><span class="s1">:</span><span class="si">{1}</span><span class="s1">@'</span><span class="o">.</span><span class="n">format</span><span class="p">(</span><span class="bp">self</span><span class="o">.</span><span class="n">proxy_username</span><span class="p">,</span> <span class="bp">self</span><span class="o">.</span><span class="n">proxy_password</span><span class="p">)</span>
<span class="n">proxy</span> <span class="o">+=</span> <span class="n">sub</span><span class="p">(</span><span class="sa">r</span><span class="s1">'https?(://)?'</span><span class="p">,</span> <span class="s1">''</span><span class="p">,</span> <span class="bp">self</span><span class="o">.</span><span class="n">proxy_host</span><span class="p">)</span>
<span class="k">if</span> <span class="bp">self</span><span class="o">.</span><span class="n">proxy_port</span><span class="p">:</span>
<span class="n">proxy</span> <span class="o">+=</span> <span class="s1">':</span><span class="si">{0}</span><span class="s1">'</span><span class="o">.</span><span class="n">format</span><span class="p">(</span><span class="bp">self</span><span class="o">.</span><span class="n">proxy_port</span><span class="p">)</span>
<span class="k">return</span> <span class="p">{</span>
<span class="s1">'http'</span><span class="p">:</span> <span class="n">proxy</span><span class="p">,</span>
<span class="s1">'https'</span><span class="p">:</span> <span class="n">proxy</span>
<span class="p">}</span>
<span class="k">def</span> <span class="nf">__repr__</span><span class="p">(</span><span class="bp">self</span><span class="p">):</span>
<span class="k">return</span> <span class="s1">'<contentful.Client space_id="</span><span class="si">{0}</span><span class="s1">" access_token="</span><span class="si">{1}</span><span class="s1">" default_locale="</span><span class="si">{2}</span><span class="s1">">'</span><span class="o">.</span><span class="n">format</span><span class="p">(</span> <span class="c1"># noqa: E501</span>
<span class="bp">self</span><span class="o">.</span><span class="n">space_id</span><span class="p">,</span>
<span class="bp">self</span><span class="o">.</span><span class="n">access_token</span><span class="p">,</span>
<span class="bp">self</span><span class="o">.</span><span class="n">default_locale</span>
<span class="p">)</span></div>
</pre></div>
</div>
</div>
</div>
<div class="sphinxsidebar" role="navigation" aria-label="main navigation">
<div class="sphinxsidebarwrapper"><div class="relations">
<h3>Related Topics</h3>
<ul>
<li><a href="../../index.html">Documentation overview</a><ul>
<li><a href="../index.html">Module code</a><ul>
</ul></li>
</ul></li>
</ul>
</div>
<div id="searchbox" style="display: none" role="search">
<h3>Quick search</h3>
<form class="search" action="../../search.html" method="get">
<div><input type="text" name="q" /></div>
<div><input type="submit" value="Go" /></div>
<input type="hidden" name="check_keywords" value="yes" />
<input type="hidden" name="area" value="default" />
</form>
</div>
<script type="text/javascript">$('#searchbox').show(0);</script>
</div>
</div>
<div class="clearer"></div>
</div>
<div class="footer">
©2016, Contentful GmbH.
</div>
<a href="https://github.com/contentful/contentful.py" class="github">
<img style="position: absolute; top: 0; right: 0; border: 0;" src="https://s3.amazonaws.com/github/ribbons/forkme_right_darkblue_121621.png" alt="Fork me on GitHub" class="github"/>
</a>
</body>
</html>