-
Notifications
You must be signed in to change notification settings - Fork 4
Expand file tree
/
Copy pathorgformat.html
More file actions
408 lines (371 loc) · 28.5 KB
/
Copy pathorgformat.html
File metadata and controls
408 lines (371 loc) · 28.5 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
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
<!DOCTYPE html>
<html lang="en">
<head>
<meta charset="utf-8">
<title>Python: module orgformat</title>
</head><body>
<table class="heading">
<tr class="heading-text decor">
<td class="title"> <br><strong class="title">orgformat</strong></td>
<td class="extra"><a href=".">index</a><br><a href="file:orgformat/orgformat.py">orgformat/orgformat.py</a></td></tr></table>
<p><span class="code"># Find much more example calls in the unit test file orgformat_test.py<br>
# -*- coding: utf-8; mode: python; -*-</span></p>
<p>
<table class="section">
<tr class="decor pkg-content-decor heading-text">
<td class="section-title" colspan=3> <br><strong class="bigsection">Modules</strong></td></tr>
<tr><td class="decor pkg-content-decor"><span class="code"> </span></td><td> </td>
<td class="singlecolumn"><table><tr><td class="multicolumn"><a href="calendar.html">calendar</a><br>
<a href="datetime.html">datetime</a><br>
</td><td class="multicolumn"><a href="logging.html">logging</a><br>
<a href="re.html">re</a><br>
</td><td class="multicolumn"><a href="time.html">time</a><br>
</td><td class="multicolumn"></td></tr></table></td></tr></table><p>
<table class="section">
<tr class="decor index-decor heading-text">
<td class="section-title" colspan=3> <br><strong class="bigsection">Classes</strong></td></tr>
<tr><td class="decor index-decor"><span class="code"> </span></td><td> </td>
<td class="singlecolumn"><dl>
<dt class="heading-text"><a href="builtins.html#Exception">builtins.Exception</a>(<a href="builtins.html#BaseException">builtins.BaseException</a>)
</dt><dd>
<dl>
<dt class="heading-text"><a href="orgformat.html#TimestampParseException">TimestampParseException</a>
</dt></dl>
</dd>
<dt class="heading-text"><a href="builtins.html#object">builtins.object</a>
</dt><dd>
<dl>
<dt class="heading-text"><a href="orgformat.html#OrgFormat">OrgFormat</a>
</dt></dl>
</dd>
</dl>
<p>
<table class="section">
<tr class="decor title-decor heading-text">
<td class="section-title" colspan=3> <br><a name="OrgFormat">class <strong>OrgFormat</strong></a>(<a href="builtins.html#object">builtins.object</a>)</td></tr>
<tr><td class="decor title-decor" rowspan=2><span class="code"> </span></td>
<td class="decor title-decor" colspan=2><span class="code">Utility library for providing functions to generate and modify Org<br>
mode syntax elements like links, time-stamps, or date-stamps.<br> </span></td></tr>
<tr><td> </td>
<td class="singlecolumn">Static methods defined here:<br>
<dl><dt><a name="OrgFormat-apply_timedelta_to_org_timestamp"><strong>apply_timedelta_to_org_timestamp</strong></a>(orgtime: str, deltahours: Union[int, float]) -> str</dt><dd><span class="code">Returns a string containing an Org mode time-stamp<br>
with the given delta hours added.<br>
Also works for a time-stamp range which uses two strings <YYYY-MM-DD Sun HH:MM><br>
concatenated with one or two dashes.<br>
<br>
<a href="#OrgFormat">OrgFormat</a>.<a href="#OrgFormat-apply_timedelta_to_org_timestamp">apply_timedelta_to_org_timestamp</a>('<2019-11-05 Tue 23:59>', 1)<br>
-> '<2019-11-06 Wed 00:59>'<br>
<br>
<a href="#OrgFormat">OrgFormat</a>.<a href="#OrgFormat-apply_timedelta_to_org_timestamp">apply_timedelta_to_org_timestamp</a>('<2020-01-01 Wed 01:30>--<2020-01-01 Wed 02:00>', -2.5)<br>
-> '<2019-12-31 Tue 23:00>--<2019-12-31 Tue 23:30>'<br>
<br>
FIXXME: implement support for inactive date/time ranges<br>
<br>
@param orgtime: '<YYYY-MM-DD Sun HH:MM>'<br>
@param deltahours: integer/float like, e.g., 3 or -2.5 (in hours)<br>
@param return: '<YYYY-MM-DD Sun HH:MM>'</span></dd></dl>
<dl><dt><a name="OrgFormat-date"><strong>date</strong></a>(
tuple_date: Union[time.struct_time, datetime.datetime],
show_time: Optional[bool] = False,
inactive: Optional[bool] = False,
repeater_or_delay: Optional[str] = None
) -> str</dt><dd><span class="code">Converts a given time.struct_time or datetime.datetime to an Org date- or time-stamp.<br>
<br>
<a href="#OrgFormat">OrgFormat</a>.<a href="#OrgFormat-date">date</a>(time.strptime("2011-11-02T20:38:42", "%Y-%m-%dT%H:%M:%S"))<br>
-> "<2011-11-02 Wed>"<br>
<br>
<a href="#OrgFormat">OrgFormat</a>.<a href="#OrgFormat-date">date</a>(time.strptime("2011-11-02T20:38:42", "%Y-%m-%dT%H:%M:%S"), show_time=True)<br>
-> "<2011-11-02 Wed 20:38>"<br>
<br>
@param tuple_date: has to be of type time.struct_time or datetime.datetime<br>
@param show_time: optional show time<br>
@param inactive: (boolean) True: use inactive time-stamp; else use active<br>
@param repeater_or_delay: string holding a repeater or a delay; e.g., '+2w' or '--5d'</span></dd></dl>
<dl><dt><a name="OrgFormat-daterange"><strong>daterange</strong></a>(
begin: time.struct_time,
end: time.struct_time,
show_time: bool = False,
inactive: bool = False
) -> str</dt><dd><span class="code">Converts two given time.struct_time or datetime.datetime to an Org range of date- or time-stamps.<br>
<br>
<a href="#OrgFormat">OrgFormat</a>.<a href="#OrgFormat-daterange">daterange</a>(<br>
time.strptime("2011-11-29", "%Y-%m-%d"),<br>
time.strptime("2011-11-30", "%Y-%m-%d"))<br>
-> "<2011-11-29 Tue>--<2011-11-30 Wed>")<br>
<br>
<a href="#OrgFormat">OrgFormat</a>.<a href="#OrgFormat-daterange">daterange</a>(<br>
time.strptime("2011-11-29T20:38:42", "%Y-%m-%dT%H:%M:%S"),<br>
time.strptime("2011-11-30T23:59:58", "%Y-%m-%dT%H:%M:%S"), show_time=True, inactive=True)<br>
-> "[2011-11-29 Tue 00:00]--[2011-11-30 Wed 00:00]"<br>
<br>
@param begin, end: have to be time.struct_time<br>
@param show_time: optional show time<br>
@param inactive: (boolean) True: use inactive time-stamps; else return active time-stamps</span></dd></dl>
<dl><dt><a name="OrgFormat-daterange_autodetect_time"><strong>daterange_autodetect_time</strong></a>(
begin_tuple: time.struct_time,
end_tuple: time.struct_time,
inactive: bool = False
) -> str</dt><dd><span class="code">Converts two given time.struct_time or datetime.datetime to an Org range of date- or time-stamps.<br>
<br>
If both time parameters do not contain time information,<br>
result is a range of dates, else it results in time-ranges.<br>
<br>
<a href="#OrgFormat">OrgFormat</a>.<a href="#OrgFormat-daterange_autodetect_time">daterange_autodetect_time</a>(<br>
time.strptime("2011-11-29", "%Y-%m-%d"),<br>
time.strptime("2011-11-30T23:59", "%Y-%m-%dT%H:%M"), inactive=True)<br>
-> "[2011-11-29 Tue 00:00]--[2011-11-30 Wed 23:59]"<br>
<br>
<a href="#OrgFormat">OrgFormat</a>.<a href="#OrgFormat-daterange_autodetect_time">daterange_autodetect_time</a>(<br>
time.strptime("2011-11-29", "%Y-%m-%d"),<br>
time.strptime("2011-11-30", "%Y-%m-%d"), inactive=True)<br>
-> "[2011-11-29 Tue]--[2011-11-30 Wed]"<br>
<br>
@param begin,end: has to be a a time.struct_time<br>
@param inactive: (boolean) True: use inactive time-stamps; else return active time-stamps</span></dd></dl>
<dl><dt><a name="OrgFormat-datetime_to_struct_time"><strong>datetime_to_struct_time</strong></a>(tuple_date: datetime.datetime) -> time.struct_time</dt><dd><span class="code">Converts a datetime.datetime argument to a time.struct_time <a href="builtins.html#object">object</a><br>
<br>
<a href="#OrgFormat">OrgFormat</a>.<a href="#OrgFormat-datetime_to_struct_time">datetime_to_struct_time</a>(datetime.datetime(2019, 12, 31, 23, 59, 0, tzinfo=None))<br>
-> time.strptime("31 Dec 2019 23:59:00", "%d %b %Y %H:%M:%S"))<br>
<br>
returns time.struct_time which was generated from the datetime.datetime parameter<br>
@param datetime <a href="builtins.html#object">object</a></span></dd></dl>
<dl><dt><a name="OrgFormat-dhms_from_sec"><strong>dhms_from_sec</strong></a>(sec: int) -> str</dt><dd><span class="code">Returns a string of days hours:minutes:seconds (like<br>
"9d 13:59:59") from the seconds given. If days is zero, omit<br>
the part of the days (like "13:59:59").<br>
<br>
<a href="#OrgFormat">OrgFormat</a>.<a href="#OrgFormat-dhms_from_sec">dhms_from_sec</a>(123)<br>
-> '0:02:03'<br>
<br>
<a href="#OrgFormat">OrgFormat</a>.<a href="#OrgFormat-dhms_from_sec">dhms_from_sec</a>(99999)<br>
-> '1d 3:46:39'<br>
<br>
@param sec: seconds<br>
@param return: xd h:mm:ss as string</span></dd></dl>
<dl><dt><a name="OrgFormat-fix_struct_time_wday"><strong>fix_struct_time_wday</strong></a>(tuple_date: time.struct_time) -> time.struct_time</dt><dd><span class="code">Correcting the given time.struct_time with the correct day of the week.<br>
<br>
<a href="#OrgFormat">OrgFormat</a>.<a href="#OrgFormat-fix_struct_time_wday">fix_struct_time_wday</a>(time.struct_time([2013, 4, 3, 10, 54, 0, 0, 0, 0]))<br>
-> time.struct_time([2013, 4, 3, 10, 54, 0, 2, 0, 0]) # Notice the different tm_wday.<br>
<br>
returns struct_time timestamp with correct day of week<br>
@param struct_time with potential false day of week</span></dd></dl>
<dl><dt><a name="OrgFormat-generate_heading"><strong>generate_heading</strong></a>(
level: int,
keyword: Optional[str] = None,
priority: Optional[str] = None,
title: Optional[str] = None,
tags: Optional[List[str]] = None,
scheduled_timestamp: Optional[str] = None,
deadline_timestamp: Optional[str] = None,
properties: Optional[List[Tuple[str, str]]] = None,
section: Optional[str] = None
) -> str</dt><dd><span class="code">Returns a (potential multi-line) string with an Org mode heading that is generated<br>
from the data within the parameters given.<br>
<br>
The only mandatory parameter is the level of the heading since '** ' is a valid heading.<br>
<br>
No content or syntax validation is done here yet (FIXXME).<br>
<br>
Note: There is a Python wrapper script to use this method from command line:<br>
<a href="https://github.com/novoid/appendorgheading">https://github.com/novoid/appendorgheading</a><br>
<br>
Parameter names are taken from <a href="https://orgmode.org/worg/dev/org-syntax.html">https://orgmode.org/worg/dev/org-syntax.html</a> if applicable:<br>
<br>
@param level: the level of the heading which is the amount of asterisks used<br>
@param keyword: is a TODO keyword, which has to belong to the list defined in org-todo-keywords-1. Case is significant.<br>
@param priority: is a priority cookie, a single letter - which will then preceded by a hash sign # and enclosed within square brackets.<br>
@param title: can be made of any character but a new line.<br>
@param tags: a list of valid tags without colons<br>
@param scheduled_timestamp: a string with a formatted date- or time-stamp<br>
@param deadline_timestamp: a string with a formatted date- or time-stamp<br>
@param properties: a list of name/value tuples<br>
@param section: the body of this heading<br>
@param return: the generated Org mode heading</span></dd></dl>
<dl><dt><a name="OrgFormat-hms_from_sec"><strong>hms_from_sec</strong></a>(sec: int) -> str</dt><dd><span class="code">Returns a string of hours:minutes:seconds from the seconds given.<br>
<br>
<a href="#OrgFormat">OrgFormat</a>.<a href="#OrgFormat-hms_from_sec">hms_from_sec</a>(9999)<br>
-> '2:46:39'<br>
<br>
@param sec: seconds<br>
@param return: h:mm:ss as string</span></dd></dl>
<dl><dt><a name="OrgFormat-link"><strong>link</strong></a>(
link: str,
description: Optional[str] = None,
replacespaces: Optional[bool] = True
) -> str</dt><dd><span class="code">returns link-string as an Org mode link<br>
<br>
FIXXME: rename to a better function name<br>
<br>
<a href="#OrgFormat">OrgFormat</a>.<a href="#OrgFormat-link">link</a>('file:foo/bar/some file.pdf'),<br>
-> '[[file:foo/bar/some%20file.pdf]]'<br>
<br>
<a href="#OrgFormat">OrgFormat</a>.<a href="#OrgFormat-link">link</a>('file:foo/bar/some file.pdf', 'my description')<br>
-> '[[file:foo/bar/some%20file.pdf][my description]]'<br>
<br>
<a href="#OrgFormat">OrgFormat</a>.<a href="#OrgFormat-link">link</a>('file:foo/bar/some file.pdf', 'my description', replacespaces=False),<br>
-> '[[file:foo/bar/some file.pdf][my description]]'<br>
<br>
@param link: link to, i.e., file which should end up such as '[[file:description]]'<br>
@param description: optional<br>
@param replacespaces: if True (default), spaces within link are being sanitized</span></dd></dl>
<dl><dt><a name="OrgFormat-mailto_link"><strong>mailto_link</strong></a>(contact_mail_string: str) -> str</dt><dd><span class="code">Takes an email address within optional angle brackets and<br>
optional name and generates an Org mode mailto email link.<br>
<br>
- "Bob Bobby <[email protected]>" or<br>
- <[email protected]>" or<br>
- [email protected]<br>
<br>
<a href="#OrgFormat">OrgFormat</a>.<a href="#OrgFormat-mailto_link">mailto_link</a>('Bob Bobby <[email protected]>'<br>
-> '[[mailto:[email protected]][Bob Bobby]]'<br>
<br>
<a href="#OrgFormat">OrgFormat</a>.<a href="#OrgFormat-mailto_link">mailto_link</a>('<[email protected]>'<br>
-> '[[mailto:[email protected]][[email protected]]]'<br>
<br>
Note that there is no check on the validy of the<br>
email address format.<br>
<br>
@param contact_mailto_string: the email information of a contact<br>
@return: Org mode mailto email link</span></dd></dl>
<dl><dt><a name="OrgFormat-newsgroup_link"><strong>newsgroup_link</strong></a>(newsgroup_string: str) -> str</dt><dd><span class="code"><a href="#OrgFormat">OrgFormat</a>.<a href="#OrgFormat-newsgroup_link">newsgroup_link</a>('foo')<br>
-> '[[news:foo][foo]]'<br>
<br>
Note that there is no check on the validy or content of the<br>
input string.<br>
<br>
@param newsgroup_string: Usenet name<br>
i.e: news:comp.emacs<br>
@param return: [[news:comp.emacs][comp.emacs]]</span></dd></dl>
<dl><dt><a name="OrgFormat-orgmode_timestamp_to_datetime"><strong>orgmode_timestamp_to_datetime</strong></a>(orgtime: str) -> datetime.datetime</dt><dd><span class="code">Returns a datetime <a href="builtins.html#object">object</a> containing the time-stamp of an Org mode time-stamp:<br>
<br>
<a href="#OrgFormat">OrgFormat</a>.<a href="#OrgFormat-orgmode_timestamp_to_datetime">orgmode_timestamp_to_datetime</a>('<1980-12-31 Wed 23:59>')<br>
-> datetime.datetime(1980, 12, 31, 23, 59, 0, tzinfo=None)<br>
<br>
FIXXME: this function should be modified so that '<1980-12-31 23:59>'<br>
with a missing day of week is accepted as well.<br>
<br>
@param orgtime: '<YYYY-MM-DD Sun HH:MM>' or an inactive one<br>
@param return: date time <a href="builtins.html#object">object</a></span></dd></dl>
<dl><dt><a name="OrgFormat-parse_basic_iso_datetime"><strong>parse_basic_iso_datetime</strong></a>(datetime_string: str) -> time.struct_time</dt><dd><span class="code">Converts an ISO 8601 basic format string with am optional trailing UTC<br>
zone designator ('Z') into a time.struct_time.<br>
<br>
<a href="#OrgFormat">OrgFormat</a>.<a href="#OrgFormat-date">date</a>(<br>
<a href="#OrgFormat">OrgFormat</a>.<a href="#OrgFormat-parse_basic_iso_datetime">parse_basic_iso_datetime</a>('20111219T205510Z'), True<br>
)<br>
-> '<2011-12-19 Mon 21:55>' (for TZ == "Europe/Vienna")<br>
<br>
@param datetime_string: YYYYMMDDTHHMMSSZ or<br>
YYYYMMDDTHHMMSS or<br>
YYYYMMDD</span></dd></dl>
<dl><dt><a name="OrgFormat-parse_extended_iso_datetime"><strong>parse_extended_iso_datetime</strong></a>(datetime_string: str) -> time.struct_time</dt><dd><span class="code">Parses any string containing date or time and return it as time.struct_time.<br>
<br>
<a href="#OrgFormat">OrgFormat</a>.<a href="#OrgFormat-parse_extended_iso_datetime">parse_extended_iso_datetime</a>("2011-1-2")<br>
-> time.strptime('2011-01-02', '%Y-%m-%d')<br>
<br>
<a href="#OrgFormat">OrgFormat</a>.<a href="#OrgFormat-parse_extended_iso_datetime">parse_extended_iso_datetime</a>("2011-1-2T3.4.5")<br>
-> time.strptime('2011-01-02 03.04.05', '%Y-%m-%d %H.%M.%S')<br>
<br>
<a href="#OrgFormat">OrgFormat</a>.<a href="#OrgFormat-parse_extended_iso_datetime">parse_extended_iso_datetime</a>("2011-1-2 3:4")<br>
-> time.strptime('2011-01-02 03.04', '%Y-%m-%d %H.%M')<br>
<br>
@param datetime_string: YYYY-MM-DD([T ]HH[.:]MM([.:]SS)?)?</span></dd></dl>
<dl><dt><a name="OrgFormat-strdate"><strong>strdate</strong></a>(
date_string: str,
show_time: Optional[bool] = False,
inactive: Optional[bool] = False,
repeater_or_delay: Optional[str] = None
) -> str</dt><dd><span class="code">Converts a ISO 8601 like time- or date-stamp into a time- or date-stamp in org format.<br>
<br>
<a href="#OrgFormat">OrgFormat</a>.<a href="#OrgFormat-strdate">strdate</a>('2011-11-3')<br>
-> '<2011-11-03 Thu>'<br>
<br>
<a href="#OrgFormat">OrgFormat</a>.<a href="#OrgFormat-strdate">strdate</a>('2011-11-03 23:59', inactive=True, show_time=True)<br>
-> '[2011-11-03 Thu 23:59]'<br>
<br>
@param date-string: has to be a str of the required format: '%Y-%M-%D (%H:%M(:%S))'<br>
@param show_time: optional show time<br>
@param inactive: (boolean) True: use inactive time-stamp; else use active<br>
@param repeater_or_delay: string holding a repeater or a delay; e.g., '+2w' or '--5d'</span></dd></dl>
<dl><dt><a name="OrgFormat-struct_time_to_datetime"><strong>struct_time_to_datetime</strong></a>(tuple_date: time.struct_time) -> datetime.datetime</dt><dd><span class="code">Converts a time.struct_time argument to a datetime.datetime <a href="builtins.html#object">object</a><br>
<br>
<a href="#OrgFormat">OrgFormat</a>.<a href="#OrgFormat-struct_time_to_datetime">struct_time_to_datetime</a>(time.struct_time((2019, 12, 31, 23, 59, 0, 0, 0, 0)))<br>
-> datetime.datetime(2019, 12, 31, 23, 59, 0, tzinfo=None)<br>
<br>
@param struct_time with potential wrong day of week</span></dd></dl>
<hr>
Data descriptors defined here:<br>
<dl><dt><strong>__dict__</strong></dt>
<dd><span class="code">dictionary for instance variables</span></dd>
</dl>
<dl><dt><strong>__weakref__</strong></dt>
<dd><span class="code">list of weak references to the object</span></dd>
</dl>
<hr>
Data and other attributes defined here:<br>
<dl><dt><strong>ISODATETIME_REGEX</strong> = re.compile('([12]\\d\\d\\d-[012345]\\d?-([012345...(\\d\\d?[:.][012345]\\d?)([:.][012345]\\d?)?))?')</dl>
<dl><dt><strong>ORGMODE_TIMESTAMP_RANGE_REGEX</strong> = re.compile('([<\\[]([12]\\d\\d\\d)-([012345]\\d)...|22|23)):([012345]\\d))?[>\\]])-(-)?([<\\[]([12])</dl>
<dl><dt><strong>ORGMODE_TIMESTAMP_REGEX</strong> = re.compile('([<\\[]([12]\\d\\d\\d)-([012345]\\d)...[01]\\d)|(20|21|22|23)):([012345]\\d))?[>\\]])$')</dl>
<dl><dt><strong>SINGLE_ORGMODE_TIMESTAMP</strong> = r'([<\[]([12]\d\d\d)-([012345]\d)-([012345]\d)( (M...)?( (([01]\d)|(20|21|22|23)):([012345]\d))?[>\]])'</dl>
<dl><dt><strong>TIMESTAMP_MATCH_GROUPS</strong> = 12</dl>
</td></tr></table> <p>
<table class="section">
<tr class="decor title-decor heading-text">
<td class="section-title" colspan=3> <br><a name="TimestampParseException">class <strong>TimestampParseException</strong></a>(<a href="builtins.html#Exception">builtins.Exception</a>)</td></tr>
<tr><td class="decor title-decor" rowspan=2><span class="code"> </span></td>
<td class="decor title-decor" colspan=2><span class="code"><a href="#TimestampParseException">TimestampParseException</a>(value: Union[ValueError, str]) -&gt; None<br>
<br>
Own exception should be raised when<br>
strptime fails<br> </span></td></tr>
<tr><td> </td>
<td class="singlecolumn"><dl><dt>Method resolution order:</dt>
<dd><a href="orgformat.html#TimestampParseException">TimestampParseException</a></dd>
<dd><a href="builtins.html#Exception">builtins.Exception</a></dd>
<dd><a href="builtins.html#BaseException">builtins.BaseException</a></dd>
<dd><a href="builtins.html#object">builtins.object</a></dd>
</dl>
<hr>
Methods defined here:<br>
<dl><dt><a name="TimestampParseException-__init__"><strong>__init__</strong></a>(self, value: Union[ValueError, str]) -> None</dt><dd><span class="code">Initialize self. See help(type(self)) for accurate signature.</span></dd></dl>
<dl><dt><a name="TimestampParseException-__str__"><strong>__str__</strong></a>(self) -> str</dt><dd><span class="code">Return str(self).</span></dd></dl>
<hr>
Data descriptors defined here:<br>
<dl><dt><strong>__weakref__</strong></dt>
<dd><span class="code">list of weak references to the object</span></dd>
</dl>
<hr>
Static methods inherited from <a href="builtins.html#Exception">builtins.Exception</a>:<br>
<dl><dt><a name="TimestampParseException-__new__"><strong>__new__</strong></a>(*args, **kwargs)<span class="grey"><span class="heading-text"> class method of <a href="builtins.html#Exception">builtins.Exception</a></span></span></dt><dd><span class="code">Create and return a new <a href="builtins.html#object">object</a>. See help(type) for accurate signature.</span></dd></dl>
<hr>
Methods inherited from <a href="builtins.html#BaseException">builtins.BaseException</a>:<br>
<dl><dt><a name="TimestampParseException-__getattribute__"><strong>__getattribute__</strong></a>(self, name, /)</dt><dd><span class="code">Return getattr(self, name).</span></dd></dl>
<dl><dt><a name="TimestampParseException-__reduce__"><strong>__reduce__</strong></a>(self, /)</dt><dd><span class="code">Helper for pickle.</span></dd></dl>
<dl><dt><a name="TimestampParseException-__repr__"><strong>__repr__</strong></a>(self, /)</dt><dd><span class="code">Return repr(self).</span></dd></dl>
<dl><dt><a name="TimestampParseException-__setstate__"><strong>__setstate__</strong></a>(self, object, /)</dt></dl>
<dl><dt><a name="TimestampParseException-add_note"><strong>add_note</strong></a>(self, object, /)</dt><dd><span class="code"><a href="builtins.html#Exception">Exception</a>.<a href="#TimestampParseException-add_note">add_note</a>(note) --<br>
add a note to the exception</span></dd></dl>
<dl><dt><a name="TimestampParseException-with_traceback"><strong>with_traceback</strong></a>(self, object, /)</dt><dd><span class="code"><a href="builtins.html#Exception">Exception</a>.<a href="#TimestampParseException-with_traceback">with_traceback</a>(tb) --<br>
set self.<strong>__traceback__</strong> to tb and return self.</span></dd></dl>
<hr>
Data descriptors inherited from <a href="builtins.html#BaseException">builtins.BaseException</a>:<br>
<dl><dt><strong>__cause__</strong></dt>
<dd><span class="code">exception cause</span></dd>
</dl>
<dl><dt><strong>__context__</strong></dt>
<dd><span class="code">exception context</span></dd>
</dl>
<dl><dt><strong>__dict__</strong></dt>
</dl>
<dl><dt><strong>__suppress_context__</strong></dt>
</dl>
<dl><dt><strong>__traceback__</strong></dt>
</dl>
<dl><dt><strong>args</strong></dt>
</dl>
</td></tr></table></td></tr></table><p>
<table class="section">
<tr class="decor data-decor heading-text">
<td class="section-title" colspan=3> <br><strong class="bigsection">Data</strong></td></tr>
<tr><td class="decor data-decor"><span class="code"> </span></td><td> </td>
<td class="singlecolumn"><strong>List</strong> = typing.List<br>
<strong>Optional</strong> = typing.Optional<br>
<strong>Tuple</strong> = typing.Tuple<br>
<strong>Union</strong> = typing.Union</td></tr></table>
</body></html>