mirror of
https://github.com/encode/django-rest-framework.git
synced 2024-11-30 13:34:00 +03:00
360 lines
36 KiB
HTML
360 lines
36 KiB
HTML
<!doctype html PUBLIC "-//W3C//DTD html 4.01//EN" "http://www.w3.org/TR/html4/strict.dtd">
|
|
<html>
|
|
<head>
|
|
<meta http-equiv='Content-Type' content='text/html; charset=utf-8'>
|
|
|
|
|
|
<meta http-equiv='X-UA-Compatible' content='IE=emulateIE7' />
|
|
<title>Coverage for rest_framework/viewsets: 95%</title>
|
|
<link rel='stylesheet' href='style.css' type='text/css'>
|
|
<script type='text/javascript' src='jquery-1.4.3.min.js'></script>
|
|
<script type='text/javascript' src='jquery.hotkeys.js'></script>
|
|
<script type='text/javascript' src='jquery.isonscreen.js'></script>
|
|
<script type='text/javascript' src='coverage_html.js'></script>
|
|
<script type='text/javascript' charset='utf-8'>
|
|
jQuery(document).ready(coverage.pyfile_ready);
|
|
</script>
|
|
</head>
|
|
<body id='pyfile'>
|
|
|
|
<div id='header'>
|
|
<div class='content'>
|
|
<h1>Coverage for <b>rest_framework/viewsets</b> :
|
|
<span class='pc_cov'>95%</span>
|
|
</h1>
|
|
<img id='keyboard_icon' src='keybd_closed.png'>
|
|
<h2 class='stats'>
|
|
39 statements
|
|
<span class='run hide_run shortkey_r' onclick='coverage.toggle_lines(this, "run")'>37 run</span>
|
|
<span class='mis shortkey_m' onclick='coverage.toggle_lines(this, "mis")'>2 missing</span>
|
|
<span class='exc shortkey_x' onclick='coverage.toggle_lines(this, "exc")'>0 excluded</span>
|
|
|
|
</h2>
|
|
</div>
|
|
</div>
|
|
|
|
<div class='help_panel'>
|
|
<img id='panel_icon' src='keybd_open.png'>
|
|
<p class='legend'>Hot-keys on this page</p>
|
|
<div>
|
|
<p class='keyhelp'>
|
|
<span class='key'>r</span>
|
|
<span class='key'>m</span>
|
|
<span class='key'>x</span>
|
|
<span class='key'>p</span> toggle line displays
|
|
</p>
|
|
<p class='keyhelp'>
|
|
<span class='key'>j</span>
|
|
<span class='key'>k</span> next/prev highlighted chunk
|
|
</p>
|
|
<p class='keyhelp'>
|
|
<span class='key'>0</span> (zero) top of page
|
|
</p>
|
|
<p class='keyhelp'>
|
|
<span class='key'>1</span> (one) first highlighted chunk
|
|
</p>
|
|
</div>
|
|
</div>
|
|
|
|
<div id='source'>
|
|
<table cellspacing='0' cellpadding='0'>
|
|
<tr>
|
|
<td class='linenos' valign='top'>
|
|
<p id='n1' class='pln'><a href='#n1'>1</a></p>
|
|
<p id='n2' class='pln'><a href='#n2'>2</a></p>
|
|
<p id='n3' class='pln'><a href='#n3'>3</a></p>
|
|
<p id='n4' class='pln'><a href='#n4'>4</a></p>
|
|
<p id='n5' class='pln'><a href='#n5'>5</a></p>
|
|
<p id='n6' class='pln'><a href='#n6'>6</a></p>
|
|
<p id='n7' class='pln'><a href='#n7'>7</a></p>
|
|
<p id='n8' class='pln'><a href='#n8'>8</a></p>
|
|
<p id='n9' class='pln'><a href='#n9'>9</a></p>
|
|
<p id='n10' class='pln'><a href='#n10'>10</a></p>
|
|
<p id='n11' class='pln'><a href='#n11'>11</a></p>
|
|
<p id='n12' class='pln'><a href='#n12'>12</a></p>
|
|
<p id='n13' class='pln'><a href='#n13'>13</a></p>
|
|
<p id='n14' class='pln'><a href='#n14'>14</a></p>
|
|
<p id='n15' class='pln'><a href='#n15'>15</a></p>
|
|
<p id='n16' class='pln'><a href='#n16'>16</a></p>
|
|
<p id='n17' class='pln'><a href='#n17'>17</a></p>
|
|
<p id='n18' class='pln'><a href='#n18'>18</a></p>
|
|
<p id='n19' class='stm run hide_run'><a href='#n19'>19</a></p>
|
|
<p id='n20' class='pln'><a href='#n20'>20</a></p>
|
|
<p id='n21' class='stm run hide_run'><a href='#n21'>21</a></p>
|
|
<p id='n22' class='stm run hide_run'><a href='#n22'>22</a></p>
|
|
<p id='n23' class='stm run hide_run'><a href='#n23'>23</a></p>
|
|
<p id='n24' class='pln'><a href='#n24'>24</a></p>
|
|
<p id='n25' class='pln'><a href='#n25'>25</a></p>
|
|
<p id='n26' class='stm run hide_run'><a href='#n26'>26</a></p>
|
|
<p id='n27' class='pln'><a href='#n27'>27</a></p>
|
|
<p id='n28' class='pln'><a href='#n28'>28</a></p>
|
|
<p id='n29' class='pln'><a href='#n29'>29</a></p>
|
|
<p id='n30' class='pln'><a href='#n30'>30</a></p>
|
|
<p id='n31' class='pln'><a href='#n31'>31</a></p>
|
|
<p id='n32' class='pln'><a href='#n32'>32</a></p>
|
|
<p id='n33' class='pln'><a href='#n33'>33</a></p>
|
|
<p id='n34' class='pln'><a href='#n34'>34</a></p>
|
|
<p id='n35' class='pln'><a href='#n35'>35</a></p>
|
|
<p id='n36' class='pln'><a href='#n36'>36</a></p>
|
|
<p id='n37' class='pln'><a href='#n37'>37</a></p>
|
|
<p id='n38' class='pln'><a href='#n38'>38</a></p>
|
|
<p id='n39' class='stm run hide_run'><a href='#n39'>39</a></p>
|
|
<p id='n40' class='stm run hide_run'><a href='#n40'>40</a></p>
|
|
<p id='n41' class='pln'><a href='#n41'>41</a></p>
|
|
<p id='n42' class='pln'><a href='#n42'>42</a></p>
|
|
<p id='n43' class='pln'><a href='#n43'>43</a></p>
|
|
<p id='n44' class='pln'><a href='#n44'>44</a></p>
|
|
<p id='n45' class='pln'><a href='#n45'>45</a></p>
|
|
<p id='n46' class='pln'><a href='#n46'>46</a></p>
|
|
<p id='n47' class='pln'><a href='#n47'>47</a></p>
|
|
<p id='n48' class='stm run hide_run'><a href='#n48'>48</a></p>
|
|
<p id='n49' class='pln'><a href='#n49'>49</a></p>
|
|
<p id='n50' class='pln'><a href='#n50'>50</a></p>
|
|
<p id='n51' class='stm run hide_run'><a href='#n51'>51</a></p>
|
|
<p id='n52' class='stm run hide_run'><a href='#n52'>52</a></p>
|
|
<p id='n53' class='stm mis'><a href='#n53'>53</a></p>
|
|
<p id='n54' class='pln'><a href='#n54'>54</a></p>
|
|
<p id='n55' class='pln'><a href='#n55'>55</a></p>
|
|
<p id='n56' class='stm run hide_run'><a href='#n56'>56</a></p>
|
|
<p id='n57' class='stm mis'><a href='#n57'>57</a></p>
|
|
<p id='n58' class='pln'><a href='#n58'>58</a></p>
|
|
<p id='n59' class='pln'><a href='#n59'>59</a></p>
|
|
<p id='n60' class='stm run hide_run'><a href='#n60'>60</a></p>
|
|
<p id='n61' class='stm run hide_run'><a href='#n61'>61</a></p>
|
|
<p id='n62' class='pln'><a href='#n62'>62</a></p>
|
|
<p id='n63' class='pln'><a href='#n63'>63</a></p>
|
|
<p id='n64' class='pln'><a href='#n64'>64</a></p>
|
|
<p id='n65' class='stm run hide_run'><a href='#n65'>65</a></p>
|
|
<p id='n66' class='pln'><a href='#n66'>66</a></p>
|
|
<p id='n67' class='pln'><a href='#n67'>67</a></p>
|
|
<p id='n68' class='pln'><a href='#n68'>68</a></p>
|
|
<p id='n69' class='stm run hide_run'><a href='#n69'>69</a></p>
|
|
<p id='n70' class='stm run hide_run'><a href='#n70'>70</a></p>
|
|
<p id='n71' class='stm run hide_run'><a href='#n71'>71</a></p>
|
|
<p id='n72' class='pln'><a href='#n72'>72</a></p>
|
|
<p id='n73' class='pln'><a href='#n73'>73</a></p>
|
|
<p id='n74' class='stm run hide_run'><a href='#n74'>74</a></p>
|
|
<p id='n75' class='stm run hide_run'><a href='#n75'>75</a></p>
|
|
<p id='n76' class='pln'><a href='#n76'>76</a></p>
|
|
<p id='n77' class='pln'><a href='#n77'>77</a></p>
|
|
<p id='n78' class='stm run hide_run'><a href='#n78'>78</a></p>
|
|
<p id='n79' class='pln'><a href='#n79'>79</a></p>
|
|
<p id='n80' class='pln'><a href='#n80'>80</a></p>
|
|
<p id='n81' class='stm run hide_run'><a href='#n81'>81</a></p>
|
|
<p id='n82' class='pln'><a href='#n82'>82</a></p>
|
|
<p id='n83' class='pln'><a href='#n83'>83</a></p>
|
|
<p id='n84' class='pln'><a href='#n84'>84</a></p>
|
|
<p id='n85' class='stm run hide_run'><a href='#n85'>85</a></p>
|
|
<p id='n86' class='pln'><a href='#n86'>86</a></p>
|
|
<p id='n87' class='pln'><a href='#n87'>87</a></p>
|
|
<p id='n88' class='pln'><a href='#n88'>88</a></p>
|
|
<p id='n89' class='pln'><a href='#n89'>89</a></p>
|
|
<p id='n90' class='stm run hide_run'><a href='#n90'>90</a></p>
|
|
<p id='n91' class='stm run hide_run'><a href='#n91'>91</a></p>
|
|
<p id='n92' class='stm run hide_run'><a href='#n92'>92</a></p>
|
|
<p id='n93' class='pln'><a href='#n93'>93</a></p>
|
|
<p id='n94' class='stm run hide_run'><a href='#n94'>94</a></p>
|
|
<p id='n95' class='pln'><a href='#n95'>95</a></p>
|
|
<p id='n96' class='pln'><a href='#n96'>96</a></p>
|
|
<p id='n97' class='pln'><a href='#n97'>97</a></p>
|
|
<p id='n98' class='pln'><a href='#n98'>98</a></p>
|
|
<p id='n99' class='stm run hide_run'><a href='#n99'>99</a></p>
|
|
<p id='n100' class='stm run hide_run'><a href='#n100'>100</a></p>
|
|
<p id='n101' class='stm run hide_run'><a href='#n101'>101</a></p>
|
|
<p id='n102' class='pln'><a href='#n102'>102</a></p>
|
|
<p id='n103' class='pln'><a href='#n103'>103</a></p>
|
|
<p id='n104' class='stm run hide_run'><a href='#n104'>104</a></p>
|
|
<p id='n105' class='pln'><a href='#n105'>105</a></p>
|
|
<p id='n106' class='pln'><a href='#n106'>106</a></p>
|
|
<p id='n107' class='pln'><a href='#n107'>107</a></p>
|
|
<p id='n108' class='stm run hide_run'><a href='#n108'>108</a></p>
|
|
<p id='n109' class='pln'><a href='#n109'>109</a></p>
|
|
<p id='n110' class='pln'><a href='#n110'>110</a></p>
|
|
<p id='n111' class='stm run hide_run'><a href='#n111'>111</a></p>
|
|
<p id='n112' class='pln'><a href='#n112'>112</a></p>
|
|
<p id='n113' class='pln'><a href='#n113'>113</a></p>
|
|
<p id='n114' class='pln'><a href='#n114'>114</a></p>
|
|
<p id='n115' class='pln'><a href='#n115'>115</a></p>
|
|
<p id='n116' class='pln'><a href='#n116'>116</a></p>
|
|
<p id='n117' class='stm run hide_run'><a href='#n117'>117</a></p>
|
|
<p id='n118' class='pln'><a href='#n118'>118</a></p>
|
|
<p id='n119' class='pln'><a href='#n119'>119</a></p>
|
|
<p id='n120' class='stm run hide_run'><a href='#n120'>120</a></p>
|
|
<p id='n121' class='pln'><a href='#n121'>121</a></p>
|
|
<p id='n122' class='pln'><a href='#n122'>122</a></p>
|
|
<p id='n123' class='pln'><a href='#n123'>123</a></p>
|
|
<p id='n124' class='pln'><a href='#n124'>124</a></p>
|
|
<p id='n125' class='pln'><a href='#n125'>125</a></p>
|
|
<p id='n126' class='stm run hide_run'><a href='#n126'>126</a></p>
|
|
<p id='n127' class='pln'><a href='#n127'>127</a></p>
|
|
<p id='n128' class='pln'><a href='#n128'>128</a></p>
|
|
<p id='n129' class='stm run hide_run'><a href='#n129'>129</a></p>
|
|
<p id='n130' class='pln'><a href='#n130'>130</a></p>
|
|
<p id='n131' class='pln'><a href='#n131'>131</a></p>
|
|
<p id='n132' class='pln'><a href='#n132'>132</a></p>
|
|
<p id='n133' class='pln'><a href='#n133'>133</a></p>
|
|
<p id='n134' class='pln'><a href='#n134'>134</a></p>
|
|
<p id='n135' class='pln'><a href='#n135'>135</a></p>
|
|
<p id='n136' class='pln'><a href='#n136'>136</a></p>
|
|
<p id='n137' class='pln'><a href='#n137'>137</a></p>
|
|
<p id='n138' class='pln'><a href='#n138'>138</a></p>
|
|
<p id='n139' class='stm run hide_run'><a href='#n139'>139</a></p>
|
|
|
|
</td>
|
|
<td class='text' valign='top'>
|
|
<p id='t1' class='pln'><span class='str'>"""</span><span class='strut'> </span></p>
|
|
<p id='t2' class='pln'><span class='str'>ViewSets are essentially just a type of class based view, that doesn't provide</span><span class='strut'> </span></p>
|
|
<p id='t3' class='pln'><span class='str'>any method handlers, such as `get()`, `post()`, etc... but instead has actions,</span><span class='strut'> </span></p>
|
|
<p id='t4' class='pln'><span class='str'>such as `list()`, `retrieve()`, `create()`, etc...</span><span class='strut'> </span></p>
|
|
<p id='t5' class='pln'><span class='strut'> </span></p>
|
|
<p id='t6' class='pln'><span class='str'>Actions are only bound to methods at the point of instantiating the views.</span><span class='strut'> </span></p>
|
|
<p id='t7' class='pln'><span class='strut'> </span></p>
|
|
<p id='t8' class='pln'><span class='str'> user_list = UserViewSet.as_view({'get': 'list'})</span><span class='strut'> </span></p>
|
|
<p id='t9' class='pln'><span class='str'> user_detail = UserViewSet.as_view({'get': 'retrieve'})</span><span class='strut'> </span></p>
|
|
<p id='t10' class='pln'><span class='strut'> </span></p>
|
|
<p id='t11' class='pln'><span class='str'>Typically, rather than instantiate views from viewsets directly, you'll</span><span class='strut'> </span></p>
|
|
<p id='t12' class='pln'><span class='str'>regsiter the viewset with a router and let the URL conf be determined</span><span class='strut'> </span></p>
|
|
<p id='t13' class='pln'><span class='str'>automatically.</span><span class='strut'> </span></p>
|
|
<p id='t14' class='pln'><span class='strut'> </span></p>
|
|
<p id='t15' class='pln'><span class='str'> router = DefaultRouter()</span><span class='strut'> </span></p>
|
|
<p id='t16' class='pln'><span class='str'> router.register(r'users', UserViewSet, 'user')</span><span class='strut'> </span></p>
|
|
<p id='t17' class='pln'><span class='str'> urlpatterns = router.urls</span><span class='strut'> </span></p>
|
|
<p id='t18' class='pln'><span class='str'>"""</span><span class='strut'> </span></p>
|
|
<p id='t19' class='stm run hide_run'><span class='key'>from</span> <span class='nam'>__future__</span> <span class='key'>import</span> <span class='nam'>unicode_literals</span><span class='strut'> </span></p>
|
|
<p id='t20' class='pln'><span class='strut'> </span></p>
|
|
<p id='t21' class='stm run hide_run'><span class='key'>from</span> <span class='nam'>functools</span> <span class='key'>import</span> <span class='nam'>update_wrapper</span><span class='strut'> </span></p>
|
|
<p id='t22' class='stm run hide_run'><span class='key'>from</span> <span class='nam'>django</span><span class='op'>.</span><span class='nam'>utils</span><span class='op'>.</span><span class='nam'>decorators</span> <span class='key'>import</span> <span class='nam'>classonlymethod</span><span class='strut'> </span></p>
|
|
<p id='t23' class='stm run hide_run'><span class='key'>from</span> <span class='nam'>rest_framework</span> <span class='key'>import</span> <span class='nam'>views</span><span class='op'>,</span> <span class='nam'>generics</span><span class='op'>,</span> <span class='nam'>mixins</span><span class='strut'> </span></p>
|
|
<p id='t24' class='pln'><span class='strut'> </span></p>
|
|
<p id='t25' class='pln'><span class='strut'> </span></p>
|
|
<p id='t26' class='stm run hide_run'><span class='key'>class</span> <span class='nam'>ViewSetMixin</span><span class='op'>(</span><span class='nam'>object</span><span class='op'>)</span><span class='op'>:</span><span class='strut'> </span></p>
|
|
<p id='t27' class='pln'> <span class='str'>"""</span><span class='strut'> </span></p>
|
|
<p id='t28' class='pln'><span class='str'> This is the magic.</span><span class='strut'> </span></p>
|
|
<p id='t29' class='pln'><span class='strut'> </span></p>
|
|
<p id='t30' class='pln'><span class='str'> Overrides `.as_view()` so that it takes an `actions` keyword that performs</span><span class='strut'> </span></p>
|
|
<p id='t31' class='pln'><span class='str'> the binding of HTTP methods to actions on the Resource.</span><span class='strut'> </span></p>
|
|
<p id='t32' class='pln'><span class='strut'> </span></p>
|
|
<p id='t33' class='pln'><span class='str'> For example, to create a concrete view binding the 'GET' and 'POST' methods</span><span class='strut'> </span></p>
|
|
<p id='t34' class='pln'><span class='str'> to the 'list' and 'create' actions...</span><span class='strut'> </span></p>
|
|
<p id='t35' class='pln'><span class='strut'> </span></p>
|
|
<p id='t36' class='pln'><span class='str'> view = MyViewSet.as_view({'get': 'list', 'post': 'create'})</span><span class='strut'> </span></p>
|
|
<p id='t37' class='pln'><span class='str'> """</span><span class='strut'> </span></p>
|
|
<p id='t38' class='pln'><span class='strut'> </span></p>
|
|
<p id='t39' class='stm run hide_run'> <span class='op'>@</span><span class='nam'>classonlymethod</span><span class='strut'> </span></p>
|
|
<p id='t40' class='stm run hide_run'> <span class='key'>def</span> <span class='nam'>as_view</span><span class='op'>(</span><span class='nam'>cls</span><span class='op'>,</span> <span class='nam'>actions</span><span class='op'>=</span><span class='nam'>None</span><span class='op'>,</span> <span class='op'>**</span><span class='nam'>initkwargs</span><span class='op'>)</span><span class='op'>:</span><span class='strut'> </span></p>
|
|
<p id='t41' class='pln'> <span class='str'>"""</span><span class='strut'> </span></p>
|
|
<p id='t42' class='pln'><span class='str'> Because of the way class based views create a closure around the</span><span class='strut'> </span></p>
|
|
<p id='t43' class='pln'><span class='str'> instantiated view, we need to totally reimplement `.as_view`,</span><span class='strut'> </span></p>
|
|
<p id='t44' class='pln'><span class='str'> and slightly modify the view function that is created and returned.</span><span class='strut'> </span></p>
|
|
<p id='t45' class='pln'><span class='str'> """</span><span class='strut'> </span></p>
|
|
<p id='t46' class='pln'> <span class='com'># The suffix initkwarg is reserved for identifing the viewset type</span><span class='strut'> </span></p>
|
|
<p id='t47' class='pln'> <span class='com'># eg. 'List' or 'Instance'.</span><span class='strut'> </span></p>
|
|
<p id='t48' class='stm run hide_run'> <span class='nam'>cls</span><span class='op'>.</span><span class='nam'>suffix</span> <span class='op'>=</span> <span class='nam'>None</span><span class='strut'> </span></p>
|
|
<p id='t49' class='pln'><span class='strut'> </span></p>
|
|
<p id='t50' class='pln'> <span class='com'># sanitize keyword arguments</span><span class='strut'> </span></p>
|
|
<p id='t51' class='stm run hide_run'> <span class='key'>for</span> <span class='nam'>key</span> <span class='key'>in</span> <span class='nam'>initkwargs</span><span class='op'>:</span><span class='strut'> </span></p>
|
|
<p id='t52' class='stm run hide_run'> <span class='key'>if</span> <span class='nam'>key</span> <span class='key'>in</span> <span class='nam'>cls</span><span class='op'>.</span><span class='nam'>http_method_names</span><span class='op'>:</span><span class='strut'> </span></p>
|
|
<p id='t53' class='stm mis'> <span class='key'>raise</span> <span class='nam'>TypeError</span><span class='op'>(</span><span class='str'>"You tried to pass in the %s method name as a "</span><span class='strut'> </span></p>
|
|
<p id='t54' class='pln'> <span class='str'>"keyword argument to %s(). Don't do that."</span><span class='strut'> </span></p>
|
|
<p id='t55' class='pln'> <span class='op'>%</span> <span class='op'>(</span><span class='nam'>key</span><span class='op'>,</span> <span class='nam'>cls</span><span class='op'>.</span><span class='nam'>__name__</span><span class='op'>)</span><span class='op'>)</span><span class='strut'> </span></p>
|
|
<p id='t56' class='stm run hide_run'> <span class='key'>if</span> <span class='key'>not</span> <span class='nam'>hasattr</span><span class='op'>(</span><span class='nam'>cls</span><span class='op'>,</span> <span class='nam'>key</span><span class='op'>)</span><span class='op'>:</span><span class='strut'> </span></p>
|
|
<p id='t57' class='stm mis'> <span class='key'>raise</span> <span class='nam'>TypeError</span><span class='op'>(</span><span class='str'>"%s() received an invalid keyword %r"</span> <span class='op'>%</span> <span class='op'>(</span><span class='strut'> </span></p>
|
|
<p id='t58' class='pln'> <span class='nam'>cls</span><span class='op'>.</span><span class='nam'>__name__</span><span class='op'>,</span> <span class='nam'>key</span><span class='op'>)</span><span class='op'>)</span><span class='strut'> </span></p>
|
|
<p id='t59' class='pln'><span class='strut'> </span></p>
|
|
<p id='t60' class='stm run hide_run'> <span class='key'>def</span> <span class='nam'>view</span><span class='op'>(</span><span class='nam'>request</span><span class='op'>,</span> <span class='op'>*</span><span class='nam'>args</span><span class='op'>,</span> <span class='op'>**</span><span class='nam'>kwargs</span><span class='op'>)</span><span class='op'>:</span><span class='strut'> </span></p>
|
|
<p id='t61' class='stm run hide_run'> <span class='nam'>self</span> <span class='op'>=</span> <span class='nam'>cls</span><span class='op'>(</span><span class='op'>**</span><span class='nam'>initkwargs</span><span class='op'>)</span><span class='strut'> </span></p>
|
|
<p id='t62' class='pln'> <span class='com'># We also store the mapping of request methods to actions,</span><span class='strut'> </span></p>
|
|
<p id='t63' class='pln'> <span class='com'># so that we can later set the action attribute.</span><span class='strut'> </span></p>
|
|
<p id='t64' class='pln'> <span class='com'># eg. `self.action = 'list'` on an incoming GET request.</span><span class='strut'> </span></p>
|
|
<p id='t65' class='stm run hide_run'> <span class='nam'>self</span><span class='op'>.</span><span class='nam'>action_map</span> <span class='op'>=</span> <span class='nam'>actions</span><span class='strut'> </span></p>
|
|
<p id='t66' class='pln'><span class='strut'> </span></p>
|
|
<p id='t67' class='pln'> <span class='com'># Bind methods to actions</span><span class='strut'> </span></p>
|
|
<p id='t68' class='pln'> <span class='com'># This is the bit that's different to a standard view</span><span class='strut'> </span></p>
|
|
<p id='t69' class='stm run hide_run'> <span class='key'>for</span> <span class='nam'>method</span><span class='op'>,</span> <span class='nam'>action</span> <span class='key'>in</span> <span class='nam'>actions</span><span class='op'>.</span><span class='nam'>items</span><span class='op'>(</span><span class='op'>)</span><span class='op'>:</span><span class='strut'> </span></p>
|
|
<p id='t70' class='stm run hide_run'> <span class='nam'>handler</span> <span class='op'>=</span> <span class='nam'>getattr</span><span class='op'>(</span><span class='nam'>self</span><span class='op'>,</span> <span class='nam'>action</span><span class='op'>)</span><span class='strut'> </span></p>
|
|
<p id='t71' class='stm run hide_run'> <span class='nam'>setattr</span><span class='op'>(</span><span class='nam'>self</span><span class='op'>,</span> <span class='nam'>method</span><span class='op'>,</span> <span class='nam'>handler</span><span class='op'>)</span><span class='strut'> </span></p>
|
|
<p id='t72' class='pln'><span class='strut'> </span></p>
|
|
<p id='t73' class='pln'> <span class='com'># Patch this in as it's otherwise only present from 1.5 onwards</span><span class='strut'> </span></p>
|
|
<p id='t74' class='stm run hide_run'> <span class='key'>if</span> <span class='nam'>hasattr</span><span class='op'>(</span><span class='nam'>self</span><span class='op'>,</span> <span class='str'>'get'</span><span class='op'>)</span> <span class='key'>and</span> <span class='key'>not</span> <span class='nam'>hasattr</span><span class='op'>(</span><span class='nam'>self</span><span class='op'>,</span> <span class='str'>'head'</span><span class='op'>)</span><span class='op'>:</span><span class='strut'> </span></p>
|
|
<p id='t75' class='stm run hide_run'> <span class='nam'>self</span><span class='op'>.</span><span class='nam'>head</span> <span class='op'>=</span> <span class='nam'>self</span><span class='op'>.</span><span class='nam'>get</span><span class='strut'> </span></p>
|
|
<p id='t76' class='pln'><span class='strut'> </span></p>
|
|
<p id='t77' class='pln'> <span class='com'># And continue as usual</span><span class='strut'> </span></p>
|
|
<p id='t78' class='stm run hide_run'> <span class='key'>return</span> <span class='nam'>self</span><span class='op'>.</span><span class='nam'>dispatch</span><span class='op'>(</span><span class='nam'>request</span><span class='op'>,</span> <span class='op'>*</span><span class='nam'>args</span><span class='op'>,</span> <span class='op'>**</span><span class='nam'>kwargs</span><span class='op'>)</span><span class='strut'> </span></p>
|
|
<p id='t79' class='pln'><span class='strut'> </span></p>
|
|
<p id='t80' class='pln'> <span class='com'># take name and docstring from class</span><span class='strut'> </span></p>
|
|
<p id='t81' class='stm run hide_run'> <span class='nam'>update_wrapper</span><span class='op'>(</span><span class='nam'>view</span><span class='op'>,</span> <span class='nam'>cls</span><span class='op'>,</span> <span class='nam'>updated</span><span class='op'>=</span><span class='op'>(</span><span class='op'>)</span><span class='op'>)</span><span class='strut'> </span></p>
|
|
<p id='t82' class='pln'><span class='strut'> </span></p>
|
|
<p id='t83' class='pln'> <span class='com'># and possible attributes set by decorators</span><span class='strut'> </span></p>
|
|
<p id='t84' class='pln'> <span class='com'># like csrf_exempt from dispatch</span><span class='strut'> </span></p>
|
|
<p id='t85' class='stm run hide_run'> <span class='nam'>update_wrapper</span><span class='op'>(</span><span class='nam'>view</span><span class='op'>,</span> <span class='nam'>cls</span><span class='op'>.</span><span class='nam'>dispatch</span><span class='op'>,</span> <span class='nam'>assigned</span><span class='op'>=</span><span class='op'>(</span><span class='op'>)</span><span class='op'>)</span><span class='strut'> </span></p>
|
|
<p id='t86' class='pln'><span class='strut'> </span></p>
|
|
<p id='t87' class='pln'> <span class='com'># We need to set these on the view function, so that breadcrumb</span><span class='strut'> </span></p>
|
|
<p id='t88' class='pln'> <span class='com'># generation can pick out these bits of information from a</span><span class='strut'> </span></p>
|
|
<p id='t89' class='pln'> <span class='com'># resolved URL.</span><span class='strut'> </span></p>
|
|
<p id='t90' class='stm run hide_run'> <span class='nam'>view</span><span class='op'>.</span><span class='nam'>cls</span> <span class='op'>=</span> <span class='nam'>cls</span><span class='strut'> </span></p>
|
|
<p id='t91' class='stm run hide_run'> <span class='nam'>view</span><span class='op'>.</span><span class='nam'>suffix</span> <span class='op'>=</span> <span class='nam'>initkwargs</span><span class='op'>.</span><span class='nam'>get</span><span class='op'>(</span><span class='str'>'suffix'</span><span class='op'>,</span> <span class='nam'>None</span><span class='op'>)</span><span class='strut'> </span></p>
|
|
<p id='t92' class='stm run hide_run'> <span class='key'>return</span> <span class='nam'>view</span><span class='strut'> </span></p>
|
|
<p id='t93' class='pln'><span class='strut'> </span></p>
|
|
<p id='t94' class='stm run hide_run'> <span class='key'>def</span> <span class='nam'>initialize_request</span><span class='op'>(</span><span class='nam'>self</span><span class='op'>,</span> <span class='nam'>request</span><span class='op'>,</span> <span class='op'>*</span><span class='nam'>args</span><span class='op'>,</span> <span class='op'>**</span><span class='nam'>kargs</span><span class='op'>)</span><span class='op'>:</span><span class='strut'> </span></p>
|
|
<p id='t95' class='pln'> <span class='str'>"""</span><span class='strut'> </span></p>
|
|
<p id='t96' class='pln'><span class='str'> Set the `.action` attribute on the view,</span><span class='strut'> </span></p>
|
|
<p id='t97' class='pln'><span class='str'> depending on the request method.</span><span class='strut'> </span></p>
|
|
<p id='t98' class='pln'><span class='str'> """</span><span class='strut'> </span></p>
|
|
<p id='t99' class='stm run hide_run'> <span class='nam'>request</span> <span class='op'>=</span> <span class='nam'>super</span><span class='op'>(</span><span class='nam'>ViewSetMixin</span><span class='op'>,</span> <span class='nam'>self</span><span class='op'>)</span><span class='op'>.</span><span class='nam'>initialize_request</span><span class='op'>(</span><span class='nam'>request</span><span class='op'>,</span> <span class='op'>*</span><span class='nam'>args</span><span class='op'>,</span> <span class='op'>**</span><span class='nam'>kargs</span><span class='op'>)</span><span class='strut'> </span></p>
|
|
<p id='t100' class='stm run hide_run'> <span class='nam'>self</span><span class='op'>.</span><span class='nam'>action</span> <span class='op'>=</span> <span class='nam'>self</span><span class='op'>.</span><span class='nam'>action_map</span><span class='op'>.</span><span class='nam'>get</span><span class='op'>(</span><span class='nam'>request</span><span class='op'>.</span><span class='nam'>method</span><span class='op'>.</span><span class='nam'>lower</span><span class='op'>(</span><span class='op'>)</span><span class='op'>)</span><span class='strut'> </span></p>
|
|
<p id='t101' class='stm run hide_run'> <span class='key'>return</span> <span class='nam'>request</span><span class='strut'> </span></p>
|
|
<p id='t102' class='pln'><span class='strut'> </span></p>
|
|
<p id='t103' class='pln'><span class='strut'> </span></p>
|
|
<p id='t104' class='stm run hide_run'><span class='key'>class</span> <span class='nam'>ViewSet</span><span class='op'>(</span><span class='nam'>ViewSetMixin</span><span class='op'>,</span> <span class='nam'>views</span><span class='op'>.</span><span class='nam'>APIView</span><span class='op'>)</span><span class='op'>:</span><span class='strut'> </span></p>
|
|
<p id='t105' class='pln'> <span class='str'>"""</span><span class='strut'> </span></p>
|
|
<p id='t106' class='pln'><span class='str'> The base ViewSet class does not provide any actions by default.</span><span class='strut'> </span></p>
|
|
<p id='t107' class='pln'><span class='str'> """</span><span class='strut'> </span></p>
|
|
<p id='t108' class='stm run hide_run'> <span class='key'>pass</span><span class='strut'> </span></p>
|
|
<p id='t109' class='pln'><span class='strut'> </span></p>
|
|
<p id='t110' class='pln'><span class='strut'> </span></p>
|
|
<p id='t111' class='stm run hide_run'><span class='key'>class</span> <span class='nam'>GenericViewSet</span><span class='op'>(</span><span class='nam'>ViewSetMixin</span><span class='op'>,</span> <span class='nam'>generics</span><span class='op'>.</span><span class='nam'>GenericAPIView</span><span class='op'>)</span><span class='op'>:</span><span class='strut'> </span></p>
|
|
<p id='t112' class='pln'> <span class='str'>"""</span><span class='strut'> </span></p>
|
|
<p id='t113' class='pln'><span class='str'> The GenericViewSet class does not provide any actions by default,</span><span class='strut'> </span></p>
|
|
<p id='t114' class='pln'><span class='str'> but does include the base set of generic view behavior, such as</span><span class='strut'> </span></p>
|
|
<p id='t115' class='pln'><span class='str'> the `get_object` and `get_queryset` methods.</span><span class='strut'> </span></p>
|
|
<p id='t116' class='pln'><span class='str'> """</span><span class='strut'> </span></p>
|
|
<p id='t117' class='stm run hide_run'> <span class='key'>pass</span><span class='strut'> </span></p>
|
|
<p id='t118' class='pln'><span class='strut'> </span></p>
|
|
<p id='t119' class='pln'><span class='strut'> </span></p>
|
|
<p id='t120' class='stm run hide_run'><span class='key'>class</span> <span class='nam'>ReadOnlyModelViewSet</span><span class='op'>(</span><span class='nam'>mixins</span><span class='op'>.</span><span class='nam'>RetrieveModelMixin</span><span class='op'>,</span><span class='strut'> </span></p>
|
|
<p id='t121' class='pln'> <span class='nam'>mixins</span><span class='op'>.</span><span class='nam'>ListModelMixin</span><span class='op'>,</span><span class='strut'> </span></p>
|
|
<p id='t122' class='pln'> <span class='nam'>GenericViewSet</span><span class='op'>)</span><span class='op'>:</span><span class='strut'> </span></p>
|
|
<p id='t123' class='pln'> <span class='str'>"""</span><span class='strut'> </span></p>
|
|
<p id='t124' class='pln'><span class='str'> A viewset that provides default `list()` and `retrieve()` actions.</span><span class='strut'> </span></p>
|
|
<p id='t125' class='pln'><span class='str'> """</span><span class='strut'> </span></p>
|
|
<p id='t126' class='stm run hide_run'> <span class='key'>pass</span><span class='strut'> </span></p>
|
|
<p id='t127' class='pln'><span class='strut'> </span></p>
|
|
<p id='t128' class='pln'><span class='strut'> </span></p>
|
|
<p id='t129' class='stm run hide_run'><span class='key'>class</span> <span class='nam'>ModelViewSet</span><span class='op'>(</span><span class='nam'>mixins</span><span class='op'>.</span><span class='nam'>CreateModelMixin</span><span class='op'>,</span><span class='strut'> </span></p>
|
|
<p id='t130' class='pln'> <span class='nam'>mixins</span><span class='op'>.</span><span class='nam'>RetrieveModelMixin</span><span class='op'>,</span><span class='strut'> </span></p>
|
|
<p id='t131' class='pln'> <span class='nam'>mixins</span><span class='op'>.</span><span class='nam'>UpdateModelMixin</span><span class='op'>,</span><span class='strut'> </span></p>
|
|
<p id='t132' class='pln'> <span class='nam'>mixins</span><span class='op'>.</span><span class='nam'>DestroyModelMixin</span><span class='op'>,</span><span class='strut'> </span></p>
|
|
<p id='t133' class='pln'> <span class='nam'>mixins</span><span class='op'>.</span><span class='nam'>ListModelMixin</span><span class='op'>,</span><span class='strut'> </span></p>
|
|
<p id='t134' class='pln'> <span class='nam'>GenericViewSet</span><span class='op'>)</span><span class='op'>:</span><span class='strut'> </span></p>
|
|
<p id='t135' class='pln'> <span class='str'>"""</span><span class='strut'> </span></p>
|
|
<p id='t136' class='pln'><span class='str'> A viewset that provides default `create()`, `retrieve()`, `update()`,</span><span class='strut'> </span></p>
|
|
<p id='t137' class='pln'><span class='str'> `partial_update()`, `destroy()` and `list()` actions.</span><span class='strut'> </span></p>
|
|
<p id='t138' class='pln'><span class='str'> """</span><span class='strut'> </span></p>
|
|
<p id='t139' class='stm run hide_run'> <span class='key'>pass</span><span class='strut'> </span></p>
|
|
|
|
</td>
|
|
</tr>
|
|
</table>
|
|
</div>
|
|
|
|
<div id='footer'>
|
|
<div class='content'>
|
|
<p>
|
|
<a class='nav' href='index.html'>« index</a> <a class='nav' href='http://nedbatchelder.com/code/coverage'>coverage.py v3.5.1</a>
|
|
</p>
|
|
</div>
|
|
</div>
|
|
|
|
</body>
|
|
</html>
|