Menu

[r12]: / docs / Connection.html  Maximize  Restore  History

Download this file

207 lines (184 with data), 11.4 kB

  1
  2
  3
  4
  5
  6
  7
  8
  9
 10
 11
 12
 13
 14
 15
 16
 17
 18
 19
 20
 21
 22
 23
 24
 25
 26
 27
 28
 29
 30
 31
 32
 33
 34
 35
 36
 37
 38
 39
 40
 41
 42
 43
 44
 45
 46
 47
 48
 49
 50
 51
 52
 53
 54
 55
 56
 57
 58
 59
 60
 61
 62
 63
 64
 65
 66
 67
 68
 69
 70
 71
 72
 73
 74
 75
 76
 77
 78
 79
 80
 81
 82
 83
 84
 85
 86
 87
 88
 89
 90
 91
 92
 93
 94
 95
 96
 97
 98
 99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
<!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>Connection &mdash; python-webdav v0.1 documentation</title>
<link rel="stylesheet" href="_static/default.css" type="text/css" />
<link rel="stylesheet" href="_static/pygments.css" type="text/css" />
<script type="text/javascript">
var DOCUMENTATION_OPTIONS = {
URL_ROOT: '',
VERSION: '0.1',
COLLAPSE_MODINDEX: false,
FILE_SUFFIX: '.html',
HAS_SOURCE: true
};
</script>
<script type="text/javascript" src="_static/jquery.js"></script>
<script type="text/javascript" src="_static/doctools.js"></script>
<link rel="top" title="python-webdav v0.1 documentation" href="index.html" />
<link rel="up" title="API" href="api.html" />
<link rel="prev" title="Client" href="Client.html" />
</head>
<body>
<div class="related">
<h3>Navigation</h3>
<ul>
<li class="right" style="margin-right: 10px">
<a href="genindex.html" title="General Index"
accesskey="I">index</a></li>
<li class="right" >
<a href="modindex.html" title="Global Module Index"
accesskey="M">modules</a> |</li>
<li class="right" >
<a href="Client.html" title="Client"
accesskey="P">previous</a> |</li>
<li><a href="index.html">python-webdav v0.1 documentation</a> &raquo;</li>
<li><a href="api.html" accesskey="U">API</a> &raquo;</li>
</ul>
</div>
<div class="document">
<div class="documentwrapper">
<div class="bodywrapper">
<div class="body">
<div class="section" id="module-python_webdav.connection">
<h1>Connection<a class="headerlink" href="#module-python_webdav.connection" title="Permalink to this headline"></a></h1>
<p>Connection Module</p>
<dl class="class">
<dt id="python_webdav.connection.Client">
<!--[python_webdav.connection.Client]-->class <tt class="descclassname">python_webdav.connection.</tt><tt class="descname">Client</tt><a class="headerlink" href="#python_webdav.connection.Client" title="Permalink to this definition"></a></dt>
<dd><p>This class is a mid-level class for accessing webdav things</p>
<dl class="method">
<dt id="python_webdav.connection.Client.get_nodes">
<!--[python_webdav.connection.Client.get_nodes]--><tt class="descname">get_nodes</tt><big>(</big><em>nodes</em><big>)</big><a class="headerlink" href="#python_webdav.connection.Client.get_nodes" title="Permalink to this definition"></a></dt>
<dd>Get any DAV nodes</dd></dl>
<dl class="method">
<dt id="python_webdav.connection.Client.get_properties">
<!--[python_webdav.connection.Client.get_properties]--><tt class="descname">get_properties</tt><big>(</big><em>url</em><big>)</big><a class="headerlink" href="#python_webdav.connection.Client.get_properties" title="Permalink to this definition"></a></dt>
<dd><p>Get a list of property objects</p>
<p>&#64;url - the path of the resource / collection minus the host section</p>
<table class="docutils field-list" frame="void" rules="none">
<col class="field-name" />
<col class="field-body" />
<tbody valign="top">
<tr class="field"><th class="field-name">Parameters:</th><td class="field-body"><ul class="first last simple">
<li><em>url</em> (String) &#8211; the path of the resource / collection minus the host section</li>
</ul>
</td>
</tr>
</tbody>
</table>
</dd></dl>
<dl class="method">
<dt id="python_webdav.connection.Client.make_resources">
<!--[python_webdav.connection.Client.make_resources]--><tt class="descname">make_resources</tt><big>(</big><em>element_list</em><big>)</big><a class="headerlink" href="#python_webdav.connection.Client.make_resources" title="Permalink to this definition"></a></dt>
<dd><p>Make any resources</p>
<p>TODO: rename and refactor</p>
</dd></dl>
<dl class="method">
<dt id="python_webdav.connection.Client.parse_xml_prop">
<!--[python_webdav.connection.Client.parse_xml_prop]--><tt class="descname">parse_xml_prop</tt><big>(</big><em>xml</em><big>)</big><a class="headerlink" href="#python_webdav.connection.Client.parse_xml_prop" title="Permalink to this definition"></a></dt>
<dd>Parse the property XML</dd></dl>
</dd></dl>
<dl class="class">
<dt id="python_webdav.connection.Connection">
<!--[python_webdav.connection.Connection]-->class <tt class="descclassname">python_webdav.connection.</tt><tt class="descname">Connection</tt><big>(</big><em>settings</em><big>)</big><a class="headerlink" href="#python_webdav.connection.Connection" title="Permalink to this definition"></a></dt>
<dd><p>Connection object</p>
<dl class="method">
<dt id="python_webdav.connection.Connection.send_copy">
<!--[python_webdav.connection.Connection.send_copy]--><tt class="descname">send_copy</tt><big>(</big><em>path</em>, <em>destination</em><big>)</big><a class="headerlink" href="#python_webdav.connection.Connection.send_copy" title="Permalink to this definition"></a></dt>
<dd>Send a COPY request</dd></dl>
<dl class="method">
<dt id="python_webdav.connection.Connection.send_delete">
<!--[python_webdav.connection.Connection.send_delete]--><tt class="descname">send_delete</tt><big>(</big><em>path</em><big>)</big><a class="headerlink" href="#python_webdav.connection.Connection.send_delete" title="Permalink to this definition"></a></dt>
<dd>Send a DELETE request</dd></dl>
<dl class="method">
<dt id="python_webdav.connection.Connection.send_get">
<!--[python_webdav.connection.Connection.send_get]--><tt class="descname">send_get</tt><big>(</big><em>path</em><big>)</big><a class="headerlink" href="#python_webdav.connection.Connection.send_get" title="Permalink to this definition"></a></dt>
<dd>Send a GET request</dd></dl>
<dl class="method">
<dt id="python_webdav.connection.Connection.send_lock">
<!--[python_webdav.connection.Connection.send_lock]--><tt class="descname">send_lock</tt><big>(</big><em>path</em><big>)</big><a class="headerlink" href="#python_webdav.connection.Connection.send_lock" title="Permalink to this definition"></a></dt>
<dd>Send a LOCK request</dd></dl>
<dl class="method">
<dt id="python_webdav.connection.Connection.send_mkcol">
<!--[python_webdav.connection.Connection.send_mkcol]--><tt class="descname">send_mkcol</tt><big>(</big><em>path</em><big>)</big><a class="headerlink" href="#python_webdav.connection.Connection.send_mkcol" title="Permalink to this definition"></a></dt>
<dd>Send a MKCOL request</dd></dl>
<dl class="method">
<dt id="python_webdav.connection.Connection.send_propfind">
<!--[python_webdav.connection.Connection.send_propfind]--><tt class="descname">send_propfind</tt><big>(</big><em>path</em><big>)</big><a class="headerlink" href="#python_webdav.connection.Connection.send_propfind" title="Permalink to this definition"></a></dt>
<dd>Send a PROPFIND request</dd></dl>
<dl class="method">
<dt id="python_webdav.connection.Connection.send_put">
<!--[python_webdav.connection.Connection.send_put]--><tt class="descname">send_put</tt><big>(</big><em>path</em>, <em>body</em><big>)</big><a class="headerlink" href="#python_webdav.connection.Connection.send_put" title="Permalink to this definition"></a></dt>
<dd>This PUT request will put data files onto a webdav server.
However, please note that due to the way in which httplib2 sends
files, it is not currently possible to break a file up into chunks
and read it in. In other words, the whole file has to be read into
memory for sending. This could be problematic for large files.</dd></dl>
<dl class="method">
<dt id="python_webdav.connection.Connection.send_rmcol">
<!--[python_webdav.connection.Connection.send_rmcol]--><tt class="descname">send_rmcol</tt><big>(</big><em>path</em><big>)</big><a class="headerlink" href="#python_webdav.connection.Connection.send_rmcol" title="Permalink to this definition"></a></dt>
<dd>Send an RMCOL request</dd></dl>
<dl class="method">
<dt id="python_webdav.connection.Connection.send_unlock">
<!--[python_webdav.connection.Connection.send_unlock]--><tt class="descname">send_unlock</tt><big>(</big><em>path</em>, <em>lock_token</em><big>)</big><a class="headerlink" href="#python_webdav.connection.Connection.send_unlock" title="Permalink to this definition"></a></dt>
<dd>Send an UNLOCK request</dd></dl>
</dd></dl>
<dl class="class">
<dt id="python_webdav.connection.LockToken">
<!--[python_webdav.connection.LockToken]-->class <tt class="descclassname">python_webdav.connection.</tt><tt class="descname">LockToken</tt><big>(</big><em>lock_token</em><big>)</big><a class="headerlink" href="#python_webdav.connection.LockToken" title="Permalink to this definition"></a></dt>
<dd>LockToken object</dd></dl>
<dl class="class">
<dt id="python_webdav.connection.Property">
<!--[python_webdav.connection.Property]-->class <tt class="descclassname">python_webdav.connection.</tt><tt class="descname">Property</tt><a class="headerlink" href="#python_webdav.connection.Property" title="Permalink to this definition"></a></dt>
<dd><p>Property object for storing information about WebDAV properties</p>
<dl class="method">
<dt id="python_webdav.connection.Property.set_property">
<!--[python_webdav.connection.Property.set_property]--><tt class="descname">set_property</tt><big>(</big><em>property_name</em>, <em>property_value=None</em><big>)</big><a class="headerlink" href="#python_webdav.connection.Property.set_property" title="Permalink to this definition"></a></dt>
<dd>Set property names</dd></dl>
</dd></dl>
</div>
</div>
</div>
</div>
<div class="sphinxsidebar">
<div class="sphinxsidebarwrapper">
<h4>Previous topic</h4>
<p class="topless"><a href="Client.html" title="previous chapter">Client</a></p>
<h3>This Page</h3>
<ul class="this-page-menu">
<li><a href="_sources/Connection.txt">Show Source</a></li>
</ul>
<h3>Quick search</h3>
<form class="search" action="search.html" method="get">
<input type="text" name="q" size="18" /> <input type="submit" value="Go" />
<input type="hidden" name="check_keywords" value="yes" />
<input type="hidden" name="area" value="default" />
</form>
</div>
</div>
<div class="clearer"></div>
</div>
<div class="related">
<h3>Navigation</h3>
<ul>
<li class="right" style="margin-right: 10px">
<a href="genindex.html" title="General Index"
accesskey="I">index</a></li>
<li class="right" >
<a href="modindex.html" title="Global Module Index"
accesskey="M">modules</a> |</li>
<li class="right" >
<a href="Client.html" title="Client"
accesskey="P">previous</a> |</li>
<li><a href="index.html">python-webdav v0.1 documentation</a> &raquo;</li>
<li><a href="api.html" accesskey="U">API</a> &raquo;</li>
</ul>
</div>
<div class="footer">
&copy; Copyright 2010, scaryclam.
Created using <a href="http://sphinx.pocoo.org/">Sphinx</a> 0.5.2.
</div>
</body>
</html>