← Back to branch summary

~openerp-commiter/openobject-addons/stable-sja-branch

« back to all changes in this revision

Viewing changes to etl/doc/time-module.html

  • Committer: sja-axelor
  • Date: 2009-10-13 09:52:57 UTC
  • Revision ID: suniljagyasi@gmail.com-20091013095257-8u26ww0r20z9y6ey
add

Show diffs side-by-side

added added

removed removed

Lines of Context:
etl/doc/time-module.html
 
1
<?xml version="1.0" encoding="ascii"?>
 
2
<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN"
 
3
          "DTD/xhtml1-transitional.dtd">
 
4
<html xmlns="http://www.w3.org/1999/xhtml" xml:lang="en" lang="en">
 
5
<head>
 
6
  <title>time</title>
 
7
  <link rel="stylesheet" href="epydoc.css" type="text/css" />
 
8
  <script type="text/javascript" src="epydoc.js"></script>
 
9
</head>
 
10
 
 
11
<body bgcolor="white" text="black" link="blue" vlink="#204080"
 
12
      alink="#204080">
 
13
<!-- ==================== NAVIGATION BAR ==================== -->
 
14
<table class="navbar" border="0" width="100%" cellpadding="0"
 
15
       bgcolor="#a0c0ff" cellspacing="0">
 
16
  <tr valign="middle">
 
17
  <!-- Home link -->
 
18
      <th>&nbsp;&nbsp;&nbsp;<a
 
19
        href="etl-module.html">Home</a>&nbsp;&nbsp;&nbsp;</th>
 
20
 
 
21
  <!-- Tree link -->
 
22
      <th>&nbsp;&nbsp;&nbsp;<a
 
23
        href="module-tree.html">Trees</a>&nbsp;&nbsp;&nbsp;</th>
 
24
 
 
25
  <!-- Index link -->
 
26
      <th>&nbsp;&nbsp;&nbsp;<a
 
27
        href="identifier-index.html">Indices</a>&nbsp;&nbsp;&nbsp;</th>
 
28
 
 
29
  <!-- Help link -->
 
30
      <th>&nbsp;&nbsp;&nbsp;<a
 
31
        href="help.html">Help</a>&nbsp;&nbsp;&nbsp;</th>
 
32
 
 
33
      <th class="navbar" width="100%"></th>
 
34
  </tr>
 
35
</table>
 
36
<table width="100%" cellpadding="0" cellspacing="0">
 
37
  <tr valign="top">
 
38
    <td width="100%">
 
39
      <span class="breadcrumbs">
 
40
        Module&nbsp;time
 
41
      </span>
 
42
    </td>
 
43
    <td>
 
44
      <table cellpadding="0" cellspacing="0">
 
45
        <!-- hide/show private -->
 
46
        <tr><td align="right"><span class="options">[<a href="javascript:void(0);" class="privatelink"
 
47
    onclick="toggle_private();">hide&nbsp;private</a>]</span></td></tr>
 
48
        <tr><td align="right"><span class="options"
 
49
            >[<a href="frames.html" target="_top">frames</a
 
50
            >]&nbsp;|&nbsp;<a href="time-module.html"
 
51
            target="_top">no&nbsp;frames</a>]</span></td></tr>
 
52
      </table>
 
53
    </td>
 
54
  </tr>
 
55
</table>
 
56
<!-- ==================== MODULE DESCRIPTION ==================== -->
 
57
<h1 class="epydoc">Module time</h1><br /><br />
 
58
<pre class="literalblock">
 
59
This module provides various functions to manipulate time values.
 
60
 
 
61
There are two standard representations of time.  One is the number
 
62
of seconds since the Epoch, in UTC (a.k.a. GMT).  It may be an integer
 
63
or a floating point number (to represent fractions of seconds).
 
64
The Epoch is system-defined; on Unix, it is generally January 1st, 1970.
 
65
The actual value can be retrieved by calling gmtime(0).
 
66
 
 
67
The other representation is a tuple of 9 integers giving local time.
 
68
The tuple items are:
 
69
  year (four digits, e.g. 1998)
 
70
  month (1-12)
 
71
  day (1-31)
 
72
  hours (0-23)
 
73
  minutes (0-59)
 
74
  seconds (0-59)
 
75
  weekday (0-6, Monday is 0)
 
76
  Julian day (day in the year, 1-366)
 
77
  DST (Daylight Savings Time) flag (-1, 0 or 1)
 
78
If the DST flag is 0, the time is given in the regular time zone;
 
79
if it is 1, the time is given in the DST time zone;
 
80
if it is -1, mktime() should guess based on the date and time.
 
81
 
 
82
Variables:
 
83
 
 
84
timezone -- difference in seconds between UTC and local standard time
 
85
altzone -- difference in  seconds between UTC and local DST time
 
86
daylight -- whether local time should reflect DST
 
87
tzname -- tuple of (standard time zone name, DST time zone name)
 
88
 
 
89
Functions:
 
90
 
 
91
time() -- return current time in seconds since the Epoch as a float
 
92
clock() -- return CPU time since process start as a float
 
93
sleep() -- delay for a number of seconds given as a float
 
94
gmtime() -- convert seconds since Epoch to UTC tuple
 
95
localtime() -- convert seconds since Epoch to local time tuple
 
96
asctime() -- convert time tuple to string
 
97
ctime() -- convert time in seconds to string
 
98
mktime() -- convert local time tuple to seconds since Epoch
 
99
strftime() -- convert time tuple to string according to format specification
 
100
strptime() -- parse string to time tuple according to format specification
 
101
tzset() -- change the local timezone
 
102
 
 
103
</pre><br /><br />
 
104
 
 
105
<!-- ==================== CLASSES ==================== -->
 
106
<a name="section-Classes"></a>
 
107
<table class="summary" border="1" cellpadding="3"
 
108
       cellspacing="0" width="100%" bgcolor="white">
 
109
<tr bgcolor="#70b0f0" class="table-header">
 
110
  <td colspan="2" class="table-header">
 
111
    <table border="0" cellpadding="0" cellspacing="0" width="100%">
 
112
      <tr valign="top">
 
113
        <td align="left"><span class="table-header">Classes</span></td>
 
114
        <td align="right" valign="top"
 
115
         ><span class="options">[<a href="#section-Classes"
 
116
         class="privatelink" onclick="toggle_private();"
 
117
         >hide private</a>]</span></td>
 
118
      </tr>
 
119
    </table>
 
120
  </td>
 
121
</tr>
 
122
<tr>
 
123
    <td width="15%" align="right" valign="top" class="summary">
 
124
      <span class="summary-type">&nbsp;</span>
 
125
    </td><td class="summary">
 
126
        <a href="time.struct_time-class.html" class="summary-name">struct_time</a>
 
127
    </td>
 
128
  </tr>
 
129
</table>
 
130
<!-- ==================== FUNCTIONS ==================== -->
 
131
<a name="section-Functions"></a>
 
132
<table class="summary" border="1" cellpadding="3"
 
133
       cellspacing="0" width="100%" bgcolor="white">
 
134
<tr bgcolor="#70b0f0" class="table-header">
 
135
  <td colspan="2" class="table-header">
 
136
    <table border="0" cellpadding="0" cellspacing="0" width="100%">
 
137
      <tr valign="top">
 
138
        <td align="left"><span class="table-header">Functions</span></td>
 
139
        <td align="right" valign="top"
 
140
         ><span class="options">[<a href="#section-Functions"
 
141
         class="privatelink" onclick="toggle_private();"
 
142
         >hide private</a>]</span></td>
 
143
      </tr>
 
144
    </table>
 
145
  </td>
 
146
</tr>
 
147
<tr>
 
148
    <td width="15%" align="right" valign="top" class="summary">
 
149
      <span class="summary-type">&nbsp;</span>
 
150
    </td><td class="summary">
 
151
      <table width="100%" cellpadding="0" cellspacing="0" border="0">
 
152
        <tr>
 
153
          <td><span class="summary-sig"><a href="time-module.html#asctime" class="summary-sig-name">asctime</a>(<span class="summary-sig-arg">tuple</span>=<span class="summary-sig-default">...</span>)</span><br />
 
154
      Convert a time tuple to a string, e.g.</td>
 
155
          <td align="right" valign="top">
 
156
            
 
157
            
 
158
          </td>
 
159
        </tr>
 
160
      </table>
 
161
      
 
162
    </td>
 
163
  </tr>
 
164
<tr>
 
165
    <td width="15%" align="right" valign="top" class="summary">
 
166
      <span class="summary-type">&nbsp;</span>
 
167
    </td><td class="summary">
 
168
      <table width="100%" cellpadding="0" cellspacing="0" border="0">
 
169
        <tr>
 
170
          <td><span class="summary-sig"><a href="time-module.html#clock" class="summary-sig-name">clock</a>()</span><br />
 
171
      Return the CPU time or real time since the start of the process or
 
172
      since the first call to clock().</td>
 
173
          <td align="right" valign="top">
 
174
            
 
175
            
 
176
          </td>
 
177
        </tr>
 
178
      </table>
 
179
      
 
180
    </td>
 
181
  </tr>
 
182
<tr>
 
183
    <td width="15%" align="right" valign="top" class="summary">
 
184
      <span class="summary-type">&nbsp;</span>
 
185
    </td><td class="summary">
 
186
      <table width="100%" cellpadding="0" cellspacing="0" border="0">
 
187
        <tr>
 
188
          <td><span class="summary-sig"><a href="time-module.html#ctime" class="summary-sig-name">ctime</a>(<span class="summary-sig-arg">seconds</span>)</span><br />
 
189
      Convert a time in seconds since the Epoch to a string in local 
 
190
      time.</td>
 
191
          <td align="right" valign="top">
 
192
            
 
193
            
 
194
          </td>
 
195
        </tr>
 
196
      </table>
 
197
      
 
198
    </td>
 
199
  </tr>
 
200
<tr>
 
201
    <td width="15%" align="right" valign="top" class="summary">
 
202
      <span class="summary-type">&nbsp;</span>
 
203
    </td><td class="summary">
 
204
      <table width="100%" cellpadding="0" cellspacing="0" border="0">
 
205
        <tr>
 
206
          <td><span class="summary-sig"><a href="time-module.html#gmtime" class="summary-sig-name">gmtime</a>(<span class="summary-sig-arg">seconds</span>=<span class="summary-sig-default">...</span>)</span><br />
 
207
      tm_sec, tm_wday, tm_yday, tm_isdst)
 
208
 
 
209
Convert seconds since the Epoch to a time tuple expressing UTC (a.k.a.</td>
 
210
          <td align="right" valign="top">
 
211
            
 
212
            
 
213
          </td>
 
214
        </tr>
 
215
      </table>
 
216
      
 
217
    </td>
 
218
  </tr>
 
219
<tr>
 
220
    <td width="15%" align="right" valign="top" class="summary">
 
221
      <span class="summary-type">&nbsp;</span>
 
222
    </td><td class="summary">
 
223
      <table width="100%" cellpadding="0" cellspacing="0" border="0">
 
224
        <tr>
 
225
          <td><span class="summary-sig"><a href="time-module.html#localtime" class="summary-sig-name">localtime</a>(<span class="summary-sig-arg">seconds</span>=<span class="summary-sig-default">...</span>)</span><br />
 
226
      Convert seconds since the Epoch to a time tuple expressing local 
 
227
      time.</td>
 
228
          <td align="right" valign="top">
 
229
            
 
230
            
 
231
          </td>
 
232
        </tr>
 
233
      </table>
 
234
      
 
235
    </td>
 
236
  </tr>
 
237
<tr>
 
238
    <td width="15%" align="right" valign="top" class="summary">
 
239
      <span class="summary-type">&nbsp;</span>
 
240
    </td><td class="summary">
 
241
      <table width="100%" cellpadding="0" cellspacing="0" border="0">
 
242
        <tr>
 
243
          <td><span class="summary-sig"><a href="time-module.html#mktime" class="summary-sig-name">mktime</a>(<span class="summary-sig-arg">tuple</span>)</span><br />
 
244
      Convert a time tuple in local time to seconds since the Epoch.</td>
 
245
          <td align="right" valign="top">
 
246
            
 
247
            
 
248
          </td>
 
249
        </tr>
 
250
      </table>
 
251
      
 
252
    </td>
 
253
  </tr>
 
254
<tr>
 
255
    <td width="15%" align="right" valign="top" class="summary">
 
256
      <span class="summary-type">&nbsp;</span>
 
257
    </td><td class="summary">
 
258
      <table width="100%" cellpadding="0" cellspacing="0" border="0">
 
259
        <tr>
 
260
          <td><span class="summary-sig"><a href="time-module.html#sleep" class="summary-sig-name">sleep</a>(<span class="summary-sig-arg">seconds</span>)</span><br />
 
261
      Delay execution for a given number of seconds.</td>
 
262
          <td align="right" valign="top">
 
263
            
 
264
            
 
265
          </td>
 
266
        </tr>
 
267
      </table>
 
268
      
 
269
    </td>
 
270
  </tr>
 
271
<tr>
 
272
    <td width="15%" align="right" valign="top" class="summary">
 
273
      <span class="summary-type">&nbsp;</span>
 
274
    </td><td class="summary">
 
275
      <table width="100%" cellpadding="0" cellspacing="0" border="0">
 
276
        <tr>
 
277
          <td><span class="summary-sig"><a href="time-module.html#strftime" class="summary-sig-name">strftime</a>(<span class="summary-sig-arg">format</span>,
 
278
        <span class="summary-sig-arg">tuple</span>=<span class="summary-sig-default">...</span>)</span><br />
 
279
      Convert a time tuple to a string according to a format 
 
280
      specification.</td>
 
281
          <td align="right" valign="top">
 
282
            
 
283
            
 
284
          </td>
 
285
        </tr>
 
286
      </table>
 
287
      
 
288
    </td>
 
289
  </tr>
 
290
<tr>
 
291
    <td width="15%" align="right" valign="top" class="summary">
 
292
      <span class="summary-type">&nbsp;</span>
 
293
    </td><td class="summary">
 
294
      <table width="100%" cellpadding="0" cellspacing="0" border="0">
 
295
        <tr>
 
296
          <td><span class="summary-sig"><a href="time-module.html#strptime" class="summary-sig-name">strptime</a>(<span class="summary-sig-arg">string</span>,
 
297
        <span class="summary-sig-arg">format</span>)</span><br />
 
298
      Parse a string to a time tuple according to a format 
 
299
      specification.</td>
 
300
          <td align="right" valign="top">
 
301
            
 
302
            
 
303
          </td>
 
304
        </tr>
 
305
      </table>
 
306
      
 
307
    </td>
 
308
  </tr>
 
309
<tr>
 
310
    <td width="15%" align="right" valign="top" class="summary">
 
311
      <span class="summary-type">&nbsp;</span>
 
312
    </td><td class="summary">
 
313
      <table width="100%" cellpadding="0" cellspacing="0" border="0">
 
314
        <tr>
 
315
          <td><span class="summary-sig"><a href="time-module.html#time" class="summary-sig-name">time</a>()</span><br />
 
316
      Return the current time in seconds since the Epoch.</td>
 
317
          <td align="right" valign="top">
 
318
            
 
319
            
 
320
          </td>
 
321
        </tr>
 
322
      </table>
 
323
      
 
324
    </td>
 
325
  </tr>
 
326
<tr>
 
327
    <td width="15%" align="right" valign="top" class="summary">
 
328
      <span class="summary-type">&nbsp;</span>
 
329
    </td><td class="summary">
 
330
      <table width="100%" cellpadding="0" cellspacing="0" border="0">
 
331
        <tr>
 
332
          <td><span class="summary-sig"><a href="time-module.html#tzset" class="summary-sig-name">tzset</a>(<span class="summary-sig-arg">zone</span>)</span><br />
 
333
      Initialize, or reinitialize, the local timezone to the value 
 
334
      stored in os.environ['TZ'].</td>
 
335
          <td align="right" valign="top">
 
336
            
 
337
            
 
338
          </td>
 
339
        </tr>
 
340
      </table>
 
341
      
 
342
    </td>
 
343
  </tr>
 
344
</table>
 
345
<!-- ==================== VARIABLES ==================== -->
 
346
<a name="section-Variables"></a>
 
347
<table class="summary" border="1" cellpadding="3"
 
348
       cellspacing="0" width="100%" bgcolor="white">
 
349
<tr bgcolor="#70b0f0" class="table-header">
 
350
  <td colspan="2" class="table-header">
 
351
    <table border="0" cellpadding="0" cellspacing="0" width="100%">
 
352
      <tr valign="top">
 
353
        <td align="left"><span class="table-header">Variables</span></td>
 
354
        <td align="right" valign="top"
 
355
         ><span class="options">[<a href="#section-Variables"
 
356
         class="privatelink" onclick="toggle_private();"
 
357
         >hide private</a>]</span></td>
 
358
      </tr>
 
359
    </table>
 
360
  </td>
 
361
</tr>
 
362
<tr>
 
363
    <td width="15%" align="right" valign="top" class="summary">
 
364
      <span class="summary-type">&nbsp;</span>
 
365
    </td><td class="summary">
 
366
        <a name="accept2dyear"></a><span class="summary-name">accept2dyear</span> = <code title="1">1</code>
 
367
    </td>
 
368
  </tr>
 
369
<tr>
 
370
    <td width="15%" align="right" valign="top" class="summary">
 
371
      <span class="summary-type">&nbsp;</span>
 
372
    </td><td class="summary">
 
373
        <a name="altzone"></a><span class="summary-name">altzone</span> = <code title="-19800">-19800</code>
 
374
    </td>
 
375
  </tr>
 
376
<tr>
 
377
    <td width="15%" align="right" valign="top" class="summary">
 
378
      <span class="summary-type">&nbsp;</span>
 
379
    </td><td class="summary">
 
380
        <a name="daylight"></a><span class="summary-name">daylight</span> = <code title="0">0</code>
 
381
    </td>
 
382
  </tr>
 
383
<tr>
 
384
    <td width="15%" align="right" valign="top" class="summary">
 
385
      <span class="summary-type">&nbsp;</span>
 
386
    </td><td class="summary">
 
387
        <a name="timezone"></a><span class="summary-name">timezone</span> = <code title="-19800">-19800</code>
 
388
    </td>
 
389
  </tr>
 
390
<tr>
 
391
    <td width="15%" align="right" valign="top" class="summary">
 
392
      <span class="summary-type">&nbsp;</span>
 
393
    </td><td class="summary">
 
394
        <a name="tzname"></a><span class="summary-name">tzname</span> = <code title="('IST', 'IST')"><code class="variable-group">(</code><code class="variable-quote">'</code><code class="variable-string">IST</code><code class="variable-quote">'</code><code class="variable-op">, </code><code class="variable-quote">'</code><code class="variable-string">IST</code><code class="variable-quote">'</code><code class="variable-group">)</code></code>
 
395
    </td>
 
396
  </tr>
 
397
</table>
 
398
<!-- ==================== FUNCTION DETAILS ==================== -->
 
399
<a name="section-FunctionDetails"></a>
 
400
<table class="details" border="1" cellpadding="3"
 
401
       cellspacing="0" width="100%" bgcolor="white">
 
402
<tr bgcolor="#70b0f0" class="table-header">
 
403
  <td colspan="2" class="table-header">
 
404
    <table border="0" cellpadding="0" cellspacing="0" width="100%">
 
405
      <tr valign="top">
 
406
        <td align="left"><span class="table-header">Function Details</span></td>
 
407
        <td align="right" valign="top"
 
408
         ><span class="options">[<a href="#section-FunctionDetails"
 
409
         class="privatelink" onclick="toggle_private();"
 
410
         >hide private</a>]</span></td>
 
411
      </tr>
 
412
    </table>
 
413
  </td>
 
414
</tr>
 
415
</table>
 
416
<a name="asctime"></a>
 
417
<div>
 
418
<table class="details" border="1" cellpadding="3"
 
419
       cellspacing="0" width="100%" bgcolor="white">
 
420
<tr><td>
 
421
  <table width="100%" cellpadding="0" cellspacing="0" border="0">
 
422
  <tr valign="top"><td>
 
423
  <h3 class="epydoc"><span class="sig"><span class="sig-name">asctime</span>(<span class="sig-arg">tuple</span>=<span class="sig-default">...</span>)</span>
 
424
  </h3>
 
425
  </td><td align="right" valign="top"
 
426
    >&nbsp;
 
427
    </td>
 
428
  </table>
 
429
  
 
430
  Convert a time tuple to a string, e.g. 'Sat Jun 06 16:26:11 1998'. 
 
431
  When the time tuple is not present, current time as returned by 
 
432
  localtime() is used.
 
433
  <dl class="fields">
 
434
    <dt>Returns:</dt>
 
435
        <dd><pre class="literalblock">
 
436
string
 
437
 
 
438
</pre></dd>
 
439
  </dl>
 
440
</td></tr></table>
 
441
</div>
 
442
<a name="clock"></a>
 
443
<div>
 
444
<table class="details" border="1" cellpadding="3"
 
445
       cellspacing="0" width="100%" bgcolor="white">
 
446
<tr><td>
 
447
  <table width="100%" cellpadding="0" cellspacing="0" border="0">
 
448
  <tr valign="top"><td>
 
449
  <h3 class="epydoc"><span class="sig"><span class="sig-name">clock</span>()</span>
 
450
  </h3>
 
451
  </td><td align="right" valign="top"
 
452
    >&nbsp;
 
453
    </td>
 
454
  </table>
 
455
  
 
456
  Return the CPU time or real time since the start of the process or 
 
457
  since the first call to clock().  This has as much precision as the 
 
458
  system records.
 
459
  <dl class="fields">
 
460
    <dt>Returns:</dt>
 
461
        <dd><pre class="literalblock">
 
462
floating point number
 
463
 
 
464
</pre></dd>
 
465
  </dl>
 
466
</td></tr></table>
 
467
</div>
 
468
<a name="ctime"></a>
 
469
<div>
 
470
<table class="details" border="1" cellpadding="3"
 
471
       cellspacing="0" width="100%" bgcolor="white">
 
472
<tr><td>
 
473
  <table width="100%" cellpadding="0" cellspacing="0" border="0">
 
474
  <tr valign="top"><td>
 
475
  <h3 class="epydoc"><span class="sig"><span class="sig-name">ctime</span>(<span class="sig-arg">seconds</span>)</span>
 
476
  </h3>
 
477
  </td><td align="right" valign="top"
 
478
    >&nbsp;
 
479
    </td>
 
480
  </table>
 
481
  
 
482
  Convert a time in seconds since the Epoch to a string in local time. 
 
483
  This is equivalent to asctime(localtime(seconds)). When the time tuple is
 
484
  not present, current time as returned by localtime() is used.
 
485
  <dl class="fields">
 
486
    <dt>Returns:</dt>
 
487
        <dd><pre class="literalblock">
 
488
string
 
489
 
 
490
</pre></dd>
 
491
  </dl>
 
492
</td></tr></table>
 
493
</div>
 
494
<a name="gmtime"></a>
 
495
<div>
 
496
<table class="details" border="1" cellpadding="3"
 
497
       cellspacing="0" width="100%" bgcolor="white">
 
498
<tr><td>
 
499
  <table width="100%" cellpadding="0" cellspacing="0" border="0">
 
500
  <tr valign="top"><td>
 
501
  <h3 class="epydoc"><span class="sig"><span class="sig-name">gmtime</span>(<span class="sig-arg">seconds</span>=<span class="sig-default">...</span>)</span>
 
502
  </h3>
 
503
  </td><td align="right" valign="top"
 
504
    >&nbsp;
 
505
    </td>
 
506
  </table>
 
507
  
 
508
  <pre class="literalblock">
 
509
                       tm_sec, tm_wday, tm_yday, tm_isdst)
 
510
 
 
511
Convert seconds since the Epoch to a time tuple expressing UTC (a.k.a.
 
512
GMT).  When 'seconds' is not passed in, convert the current time instead.
 
513
 
 
514
</pre>
 
515
  <dl class="fields">
 
516
    <dt>Returns:</dt>
 
517
        <dd><pre class="literalblock">
 
518
(tm_year, tm_mon, tm_mday, tm_hour, tm_min,
 
519
 
 
520
</pre></dd>
 
521
  </dl>
 
522
</td></tr></table>
 
523
</div>
 
524
<a name="localtime"></a>
 
525
<div>
 
526
<table class="details" border="1" cellpadding="3"
 
527
       cellspacing="0" width="100%" bgcolor="white">
 
528
<tr><td>
 
529
  <table width="100%" cellpadding="0" cellspacing="0" border="0">
 
530
  <tr valign="top"><td>
 
531
  <h3 class="epydoc"><span class="sig"><span class="sig-name">localtime</span>(<span class="sig-arg">seconds</span>=<span class="sig-default">...</span>)</span>
 
532
  </h3>
 
533
  </td><td align="right" valign="top"
 
534
    >&nbsp;
 
535
    </td>
 
536
  </table>
 
537
  
 
538
  Convert seconds since the Epoch to a time tuple expressing local time.
 
539
  When 'seconds' is not passed in, convert the current time instead.
 
540
  <dl class="fields">
 
541
    <dt>Returns:</dt>
 
542
        <dd><pre class="literalblock">
 
543
(tm_year,tm_mon,tm_mday,tm_hour,tm_min,tm_sec,tm_wday,tm_yday,tm_isdst)
 
544
 
 
545
</pre></dd>
 
546
  </dl>
 
547
</td></tr></table>
 
548
</div>
 
549
<a name="mktime"></a>
 
550
<div>
 
551
<table class="details" border="1" cellpadding="3"
 
552
       cellspacing="0" width="100%" bgcolor="white">
 
553
<tr><td>
 
554
  <table width="100%" cellpadding="0" cellspacing="0" border="0">
 
555
  <tr valign="top"><td>
 
556
  <h3 class="epydoc"><span class="sig"><span class="sig-name">mktime</span>(<span class="sig-arg">tuple</span>)</span>
 
557
  </h3>
 
558
  </td><td align="right" valign="top"
 
559
    >&nbsp;
 
560
    </td>
 
561
  </table>
 
562
  
 
563
  Convert a time tuple in local time to seconds since the Epoch.
 
564
  <dl class="fields">
 
565
    <dt>Returns:</dt>
 
566
        <dd><pre class="literalblock">
 
567
floating point number
 
568
 
 
569
</pre></dd>
 
570
  </dl>
 
571
</td></tr></table>
 
572
</div>
 
573
<a name="sleep"></a>
 
574
<div>
 
575
<table class="details" border="1" cellpadding="3"
 
576
       cellspacing="0" width="100%" bgcolor="white">
 
577
<tr><td>
 
578
  <table width="100%" cellpadding="0" cellspacing="0" border="0">
 
579
  <tr valign="top"><td>
 
580
  <h3 class="epydoc"><span class="sig"><span class="sig-name">sleep</span>(<span class="sig-arg">seconds</span>)</span>
 
581
  </h3>
 
582
  </td><td align="right" valign="top"
 
583
    >&nbsp;
 
584
    </td>
 
585
  </table>
 
586
  
 
587
  Delay execution for a given number of seconds.  The argument may be a 
 
588
  floating point number for subsecond precision.
 
589
  <dl class="fields">
 
590
  </dl>
 
591
</td></tr></table>
 
592
</div>
 
593
<a name="strftime"></a>
 
594
<div>
 
595
<table class="details" border="1" cellpadding="3"
 
596
       cellspacing="0" width="100%" bgcolor="white">
 
597
<tr><td>
 
598
  <table width="100%" cellpadding="0" cellspacing="0" border="0">
 
599
  <tr valign="top"><td>
 
600
  <h3 class="epydoc"><span class="sig"><span class="sig-name">strftime</span>(<span class="sig-arg">format</span>,
 
601
        <span class="sig-arg">tuple</span>=<span class="sig-default">...</span>)</span>
 
602
  </h3>
 
603
  </td><td align="right" valign="top"
 
604
    >&nbsp;
 
605
    </td>
 
606
  </table>
 
607
  
 
608
  Convert a time tuple to a string according to a format specification. 
 
609
  See the library reference manual for formatting codes. When the time 
 
610
  tuple is not present, current time as returned by localtime() is 
 
611
  used.
 
612
  <dl class="fields">
 
613
    <dt>Returns:</dt>
 
614
        <dd><pre class="literalblock">
 
615
string
 
616
 
 
617
</pre></dd>
 
618
  </dl>
 
619
</td></tr></table>
 
620
</div>
 
621
<a name="strptime"></a>
 
622
<div>
 
623
<table class="details" border="1" cellpadding="3"
 
624
       cellspacing="0" width="100%" bgcolor="white">
 
625
<tr><td>
 
626
  <table width="100%" cellpadding="0" cellspacing="0" border="0">
 
627
  <tr valign="top"><td>
 
628
  <h3 class="epydoc"><span class="sig"><span class="sig-name">strptime</span>(<span class="sig-arg">string</span>,
 
629
        <span class="sig-arg">format</span>)</span>
 
630
  </h3>
 
631
  </td><td align="right" valign="top"
 
632
    >&nbsp;
 
633
    </td>
 
634
  </table>
 
635
  
 
636
  Parse a string to a time tuple according to a format specification. 
 
637
  See the library reference manual for formatting codes (same as 
 
638
  strftime()).
 
639
  <dl class="fields">
 
640
    <dt>Returns:</dt>
 
641
        <dd><pre class="literalblock">
 
642
struct_time
 
643
 
 
644
</pre></dd>
 
645
  </dl>
 
646
</td></tr></table>
 
647
</div>
 
648
<a name="time"></a>
 
649
<div>
 
650
<table class="details" border="1" cellpadding="3"
 
651
       cellspacing="0" width="100%" bgcolor="white">
 
652
<tr><td>
 
653
  <table width="100%" cellpadding="0" cellspacing="0" border="0">
 
654
  <tr valign="top"><td>
 
655
  <h3 class="epydoc"><span class="sig"><span class="sig-name">time</span>()</span>
 
656
  </h3>
 
657
  </td><td align="right" valign="top"
 
658
    >&nbsp;
 
659
    </td>
 
660
  </table>
 
661
  
 
662
  Return the current time in seconds since the Epoch. Fractions of a 
 
663
  second may be present if the system clock provides them.
 
664
  <dl class="fields">
 
665
    <dt>Returns:</dt>
 
666
        <dd><pre class="literalblock">
 
667
floating point number
 
668
 
 
669
</pre></dd>
 
670
  </dl>
 
671
</td></tr></table>
 
672
</div>
 
673
<a name="tzset"></a>
 
674
<div>
 
675
<table class="details" border="1" cellpadding="3"
 
676
       cellspacing="0" width="100%" bgcolor="white">
 
677
<tr><td>
 
678
  <table width="100%" cellpadding="0" cellspacing="0" border="0">
 
679
  <tr valign="top"><td>
 
680
  <h3 class="epydoc"><span class="sig"><span class="sig-name">tzset</span>(<span class="sig-arg">zone</span>)</span>
 
681
  </h3>
 
682
  </td><td align="right" valign="top"
 
683
    >&nbsp;
 
684
    </td>
 
685
  </table>
 
686
  
 
687
  Initialize, or reinitialize, the local timezone to the value stored in
 
688
  os.environ['TZ']. The TZ environment variable should be specified in 
 
689
  standard Unix timezone format as documented in the tzset man page (eg. 
 
690
  'US/Eastern', 'Europe/Amsterdam'). Unknown timezones will silently fall 
 
691
  back to UTC. If the TZ environment variable is not set, the local 
 
692
  timezone is set to the systems best guess of wallclock time. Changing the
 
693
  TZ environment variable without calling tzset *may* change the local 
 
694
  timezone used by methods such as localtime, but this behaviour should not
 
695
  be relied on.
 
696
  <dl class="fields">
 
697
  </dl>
 
698
</td></tr></table>
 
699
</div>
 
700
<br />
 
701
<!-- ==================== NAVIGATION BAR ==================== -->
 
702
<table class="navbar" border="0" width="100%" cellpadding="0"
 
703
       bgcolor="#a0c0ff" cellspacing="0">
 
704
  <tr valign="middle">
 
705
  <!-- Home link -->
 
706
      <th>&nbsp;&nbsp;&nbsp;<a
 
707
        href="etl-module.html">Home</a>&nbsp;&nbsp;&nbsp;</th>
 
708
 
 
709
  <!-- Tree link -->
 
710
      <th>&nbsp;&nbsp;&nbsp;<a
 
711
        href="module-tree.html">Trees</a>&nbsp;&nbsp;&nbsp;</th>
 
712
 
 
713
  <!-- Index link -->
 
714
      <th>&nbsp;&nbsp;&nbsp;<a
 
715
        href="identifier-index.html">Indices</a>&nbsp;&nbsp;&nbsp;</th>
 
716
 
 
717
  <!-- Help link -->
 
718
      <th>&nbsp;&nbsp;&nbsp;<a
 
719
        href="help.html">Help</a>&nbsp;&nbsp;&nbsp;</th>
 
720
 
 
721
      <th class="navbar" width="100%"></th>
 
722
  </tr>
 
723
</table>
 
724
<table border="0" cellpadding="0" cellspacing="0" width="100%%">
 
725
  <tr>
 
726
    <td align="left" class="footer">
 
727
    Generated by Epydoc 3.0beta1 on Wed Apr 29 20:37:21 2009
 
728
    </td>
 
729
    <td align="right" class="footer">
 
730
      <a href="http://epydoc.sourceforge.net">http://epydoc.sourceforge.net</a>
 
731
    </td>
 
732
  </tr>
 
733
</table>
 
734
 
 
735
<script type="text/javascript">
 
736
  <!--
 
737
  // Private objects are initially displayed (because if
 
738
  // javascript is turned off then we want them to be
 
739
  // visible); but by default, we want to hide them.  So hide
 
740
  // them unless we have a cookie that says to show them.
 
741
  checkCookie()
 
742
  // -->
 
743
</script>
 
744
  
 
745
</body>
 
746
</html>