OLD | NEW |
1 #!/usr/bin/env python | 1 #!/usr/bin/env python |
2 # Copyright (c) 2012 The Chromium Authors. All rights reserved. | 2 # Copyright (c) 2012 The Chromium Authors. All rights reserved. |
3 # Use of this source code is governed by a BSD-style license that can be | 3 # Use of this source code is governed by a BSD-style license that can be |
4 # found in the LICENSE file. | 4 # found in the LICENSE file. |
5 | 5 |
6 '''Base classes for item formatters and file formatters. | 6 '''Base classes for item formatters and file formatters. |
7 ''' | 7 ''' |
8 | 8 |
9 | 9 |
10 import re | 10 import re |
11 | 11 |
12 | 12 |
13 class ItemFormatter(object): | 13 class ItemFormatter(object): |
14 '''Base class for a formatter that knows how to format a single item.''' | 14 """Base class for a formatter that knows how to format a single item.""" |
15 | 15 |
16 def Format(self, item, lang='', begin_item=True, output_dir='.'): | 16 def Format(self, item, lang='', output_dir='.'): |
17 '''Returns a Unicode string representing 'item' in the format known by this | 17 """Format the start of this item. |
18 item formatter, for the language 'lang'. May be called once at the | 18 |
19 start of the item (begin_item == True) and again at the end | 19 Returns a Unicode string representing 'item' in the format known by this |
20 (begin_item == False), or only at the start of the item (begin_item == True) | 20 item formatter, for the language 'lang'. |
| 21 |
| 22 Args: |
| 23 item: anything. |
| 24 lang: 'en' |
| 25 output_dir: '.' |
| 26 |
| 27 Returns: |
| 28 A unicode string. |
| 29 """ |
| 30 return '' |
| 31 |
| 32 def FormatEnd(self, item, lang='', output_dir='.'): |
| 33 """Format the end of this item. |
| 34 |
| 35 Returns a Unicode string representing the closure of 'item' in the |
| 36 format known by this item formatter, for the language 'lang'. |
| 37 Called (optionally) after the children of item have been formatted. |
21 | 38 |
22 Args: | 39 Args: |
23 item: anything | 40 item: anything |
24 lang: 'en' | 41 lang: 'en' |
25 begin_item: True | False | |
26 output_dir: '.' | 42 output_dir: '.' |
27 | 43 |
28 Return: | 44 Returns: |
29 u'hello' | 45 A unicode string. |
30 ''' | 46 """ |
31 raise NotImplementedError() | 47 return '' |
32 | |
OLD | NEW |