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
|
<?xml version="1.0" standalone="no"?>
<!DOCTYPE refentry PUBLIC "-//OASIS//DTD DocBook XML V4.1.2//EN"
"http://www.oasis-open.org/docbook/xml/4.1.2/docbookx.dtd">
<refentry id="class-gnomevfs-uri">
<refnamediv>
<refname>gnomevfs.URI</refname>
<refpurpose>Object encapsulating a URI</refpurpose>
</refnamediv>
<refsect1>
<title>Synopsis</title>
<classsynopsis language="python">
<ooclass><classname>gnomevfs.URI</classname></ooclass>
<constructorsynopsis language="python">
<methodname><link linkend="constructor-gnomevfs-uri">gnomevfs.URI</link></methodname>
<methodparam><parameter role="keyword">text_uri</parameter></methodparam>
</constructorsynopsis>
<methodsynopsis>
<methodname><link linkend="method-gnomevfs-uri--append_file_name">append_file_name</link></methodname>
<methodparam><parameter role="keyword">file_name</parameter></methodparam>
</methodsynopsis>
<methodsynopsis>
<methodname><link linkend="method-gnomevfs-uri--append_path">append_path</link></methodname>
<methodparam><parameter role="keyword">path</parameter></methodparam>
</methodsynopsis>
<methodsynopsis>
<methodname><link linkend="method-gnomevfs-uri--append_string">append_string</link></methodname>
<methodparam><parameter role="keyword">path</parameter></methodparam>
</methodsynopsis>
<methodsynopsis>
<methodname><link linkend="method-gnomevfs-uri--copy">copy</link></methodname>
<methodparam></methodparam>
</methodsynopsis>
<methodsynopsis>
<methodname><link linkend="method-gnomevfs-uri--is_parent">is_parent</link></methodname>
<methodparam><parameter role="keyword">item</parameter></methodparam>
<methodparam><parameter role="keyword">recursive</parameter></methodparam>
</methodsynopsis>
<methodsynopsis>
<methodname><link linkend="method-gnomevfs-uri--resolve_relative">resolve_relative</link></methodname>
<methodparam><parameter role="keyword">relative_reference</parameter></methodparam>
</methodsynopsis>
</classsynopsis>
</refsect1>
<refsect1>
<title>Description</title>
<para></para>
</refsect1>
<refsect1>
<title>Attributes</title>
<blockquote role="properties">
<informaltable pgwide="1" frame="none">
<tgroup cols="3">
<colspec column="1" colwidth="1in"/>
<colspec column="1" colwidth="1in"/>
<colspec column="3" colwidth="3.5in"/>
<tbody>
<row valign="top">
<entry>dirname</entry>
<entry>Read/Write</entry>
<entry>The name of the directory in which the file pointed to by this URI is located.</entry>
</row>
<row valign="top">
<entry>fragment_identifier</entry>
<entry>Read/Write</entry>
<entry></entry>
</row>
<row valign="top">
<entry>host_name</entry>
<entry>Read</entry>
<entry>Server hostname (for remote schemes).</entry>
</row>
<row valign="top">
<entry>host_port</entry>
<entry>Read</entry>
<entry>Server port (for remote schemes).</entry>
</row>
<row valign="top">
<entry>is_local</entry>
<entry>Read/Write</entry>
<entry>Whether the URI is a local filesystem.</entry>
</row>
<row valign="top">
<entry>parent</entry>
<entry>Read/Write</entry>
<entry>The parent URI.</entry>
</row>
<row valign="top">
<entry>password</entry>
<entry>Read</entry>
<entry>Password (for schemes which require authorization).</entry>
</row>
<row valign="top">
<entry>path</entry>
<entry>Read/Write</entry>
<entry>The full path name.</entry>
</row>
<row valign="top">
<entry>scheme</entry>
<entry>Read/Write</entry>
<entry>The URI scheme (`gzip', `tar', `http', etc).</entry>
</row>
<row valign="top">
<entry>short_name</entry>
<entry>Read/Write</entry>
<entry>The base name for the file referred to by this URI. This matches the XPG definition of a basename. This is useful when you want the name of the URI target, but don't care whether the URI points to a file or directory. If the URI points to the root of a domain, this is the host name.</entry>
</row>
<row valign="top">
<entry>short_path_name</entry>
<entry>Read/Write</entry>
<entry>Same as short_name, but if the URI points to the root of a domain, this is equal to /</entry>
</row>
<row valign="top">
<entry>toplevel</entry>
<entry>Read/Write</entry>
<entry>The toplevel URI</entry>
</row>
<row valign="top">
<entry>user_name</entry>
<entry>Read</entry>
<entry>User name (for schemes which require authorization).</entry>
</row>
</tbody>
</tgroup>
</informaltable>
</blockquote>
</refsect1>
<refsect1>
<title>Constructor</title>
<refsect2 id="constructor-gnomevfs-uri">
<programlisting>
<constructorsynopsis language="python">
<methodname>gnomevfs.URI</methodname>
<methodparam><parameter role="keyword">text_uri</parameter></methodparam>
</constructorsynopsis>
</programlisting>
<variablelist>
<varlistentry>
<term><parameter role="keyword">text_uri</parameter>:</term>
<listitem><simpara>A string representing the URI.</simpara></listitem>
</varlistentry>
<varlistentry>
<term><emphasis>Returns</emphasis>:</term>
<listitem><simpara>the new <link linkend="class-gnomevfs-uri">gnomevfs.URI</link></simpara></listitem>
</varlistentry>
</variablelist>
<para></para>
</refsect2>
</refsect1>
<refsect1>
<title>Methods</title>
<refsect2 id="method-gnomevfs-uri--append_file_name">
<title>gnomevfs.URI.append_file_name</title>
<programlisting>
<methodsynopsis language="python">
<methodname>append_file_name</methodname>
<methodparam><parameter role="keyword">file_name</parameter></methodparam>
</methodsynopsis>
</programlisting>
<variablelist>
<varlistentry>
<term><parameter role="keyword">file_name</parameter>:</term>
<listitem><simpara>The file name to append.</simpara></listitem>
</varlistentry>
<varlistentry>
<term><emphasis>Returns</emphasis>:</term>
<listitem><simpara>The new URI.</simpara></listitem>
</varlistentry>
</variablelist>
<para>Create a new URI by appending <parameter role="keyword">file_name</parameter>. This will add the appropriate directory separator if necessary.</para>
</refsect2>
<refsect2 id="method-gnomevfs-uri--append_path">
<title>gnomevfs.URI.append_path</title>
<programlisting>
<methodsynopsis language="python">
<methodname>append_path</methodname>
<methodparam><parameter role="keyword">path</parameter></methodparam>
</methodsynopsis>
</programlisting>
<variablelist>
<varlistentry>
<term><parameter role="keyword">path</parameter>:</term>
<listitem><simpara>The path to append (unescaped)</simpara></listitem>
</varlistentry>
<varlistentry>
<term><emphasis>Returns</emphasis>:</term>
<listitem><simpara>The new URI.</simpara></listitem>
</varlistentry>
</variablelist>
<para>Create a new URI by appending <parameter role="keyword">path</parameter>. This will add the appropriate directory separator if necessary.</para>
</refsect2>
<refsect2 id="method-gnomevfs-uri--append_string">
<title>gnomevfs.URI.append_string</title>
<programlisting>
<methodsynopsis language="python">
<methodname>append_string</methodname>
<methodparam><parameter role="keyword">path</parameter></methodparam>
</methodsynopsis>
</programlisting>
<variablelist>
<varlistentry>
<term><parameter role="keyword">path</parameter>:</term>
<listitem><simpara>The path to append (fully escaped)</simpara></listitem>
</varlistentry>
<varlistentry>
<term><emphasis>Returns</emphasis>:</term>
<listitem><simpara>The new URI.</simpara></listitem>
</varlistentry>
</variablelist>
<para>Create a new URI by appending <parameter role="keyword">path</parameter>. This will add the appropriate directory separator if necessary.</para>
</refsect2>
<refsect2 id="method-gnomevfs-uri--copy">
<title>gnomevfs.URI.copy</title>
<programlisting>
<methodsynopsis language="python">
<methodname>copy</methodname>
<methodparam></methodparam>
</methodsynopsis>
</programlisting>
<variablelist>
<varlistentry>
<term><emphasis>Returns</emphasis>:</term>
<listitem><simpara>A copy of this URI.</simpara></listitem>
</varlistentry>
</variablelist>
<para>Create a copy of this URI.</para>
</refsect2>
<refsect2 id="method-gnomevfs-uri--is_parent">
<title>gnomevfs.URI.is_parent</title>
<programlisting>
<methodsynopsis language="python">
<methodname>is_parent</methodname>
<methodparam><parameter role="keyword">item</parameter></methodparam>
<methodparam><parameter role="keyword">recursive</parameter></methodparam>
</methodsynopsis>
</programlisting>
<variablelist>
<varlistentry>
<term><parameter role="keyword">item</parameter>:</term>
<listitem><simpara>The item to search for.</simpara></listitem>
</varlistentry>
<varlistentry>
<term><parameter role="keyword">recursive</parameter>:</term>
<listitem><simpara>Whether to check the entire hierarchy.</simpara></listitem>
</varlistentry>
<varlistentry>
<term><emphasis>Returns</emphasis>:</term>
<listitem><simpara>True if <parameter role="keyword">item</parameter> is a child of self.</simpara></listitem>
</varlistentry>
</variablelist>
<para>Check if this URI is a parent of <parameter role="keyword">item</parameter>. If <parameter role="keyword">recursive</parameter> is True, check the entire hierarchy.</para>
</refsect2>
<refsect2 id="method-gnomevfs-uri--resolve_relative">
<title>gnomevfs.URI.resolve_relative</title>
<programlisting>
<methodsynopsis language="python">
<methodname>resolve_relative</methodname>
<methodparam><parameter role="keyword">relative_reference</parameter></methodparam>
</methodsynopsis>
</programlisting>
<variablelist>
<varlistentry>
<term><parameter role="keyword">relative_reference</parameter>:</term>
<listitem><simpara>A string representing the (possibly) relative URI.</simpara></listitem>
</varlistentry>
<varlistentry>
<term><emphasis>Returns</emphasis>:</term>
<listitem><simpara>The new URI.</simpara></listitem>
</varlistentry>
</variablelist>
<para>Create a new URI from <parameter role="keyword">relative_reference</parameter> relative to self. The resolution algorithm follows RFC 2396. For details, see section 5.2 of http://www.ietf.org/rfc/rfc2396.txt .</para>
<para>In short, if the base uri ends in '/', relative_reference is appended to base, otherwise it replaces the part of base after the last '/'.</para>
</refsect2>
</refsect1>
</refentry>
|
