4869.3.27
by Andrew Bennetts
Move news_merge plugin from contrib to bzrlib/plugins, change it to be enabled via a 'news_merge_files' config option, move more code out of the __init__ to minimise overhead, and add lots of docstrings, add NEWS entry. |
1 |
# Copyright (C) 2010 Canonical Ltd
|
2 |
#
|
|
3 |
# This program is free software; you can redistribute it and/or modify
|
|
4 |
# it under the terms of the GNU General Public License as published by
|
|
5 |
# the Free Software Foundation; either version 2 of the License, or
|
|
6 |
# (at your option) any later version.
|
|
7 |
#
|
|
8 |
# This program is distributed in the hope that it will be useful,
|
|
9 |
# but WITHOUT ANY WARRANTY; without even the implied warranty of
|
|
10 |
# MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
|
|
11 |
# GNU General Public License for more details.
|
|
12 |
#
|
|
13 |
# You should have received a copy of the GNU General Public License
|
|
14 |
# along with this program; if not, write to the Free Software
|
|
15 |
# Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301 USA
|
|
16 |
||
17 |
"""Simple parser for bzr's NEWS file.
|
|
18 |
||
19 |
Simple as this is, it's a bit over-powered for news_merge's needs, which only
|
|
20 |
cares about 'bullet' and 'everything else'.
|
|
21 |
||
22 |
This module can be run as a standalone Python program; pass it a filename and
|
|
23 |
it will print the parsed form of a file (a series of 2-tuples, see
|
|
24 |
simple_parse's docstring).
|
|
25 |
"""
|
|
4869.4.1
by Andrew Bennetts
Add plugin for merging bzr's NEWS file to contrib/. |
26 |
|
6379.6.7
by Jelmer Vernooij
Move importing from future until after doc string, otherwise the doc string will disappear. |
27 |
from __future__ import absolute_import |
28 |
||
4869.4.1
by Andrew Bennetts
Add plugin for merging bzr's NEWS file to contrib/. |
29 |
|
5158.5.1
by Andrew Bennetts
Allow Merge3 to work with objects, not just lists of strs. This removes a lot of cruft from news_merge. |
30 |
def simple_parse_lines(lines): |
31 |
"""Same as simple_parse, but takes an iterable of strs rather than a single
|
|
32 |
str.
|
|
33 |
"""
|
|
34 |
return simple_parse(''.join(lines)) |
|
35 |
||
36 |
||
4869.4.1
by Andrew Bennetts
Add plugin for merging bzr's NEWS file to contrib/. |
37 |
def simple_parse(content): |
4869.3.27
by Andrew Bennetts
Move news_merge plugin from contrib to bzrlib/plugins, change it to be enabled via a 'news_merge_files' config option, move more code out of the __init__ to minimise overhead, and add lots of docstrings, add NEWS entry. |
38 |
"""Returns blocks, where each block is a 2-tuple (kind, text).
|
39 |
|
|
40 |
:kind: one of 'heading', 'release', 'section', 'empty' or 'text'.
|
|
41 |
:text: a str, including newlines.
|
|
42 |
"""
|
|
4869.4.1
by Andrew Bennetts
Add plugin for merging bzr's NEWS file to contrib/. |
43 |
blocks = content.split('\n\n') |
44 |
for block in blocks: |
|
45 |
if block.startswith('###'): |
|
46 |
# First line is ###...: Top heading
|
|
47 |
yield 'heading', block |
|
48 |
continue
|
|
49 |
last_line = block.rsplit('\n', 1)[-1] |
|
50 |
if last_line.startswith('###'): |
|
51 |
# last line is ###...: 2nd-level heading
|
|
52 |
yield 'release', block |
|
53 |
elif last_line.startswith('***'): |
|
54 |
# last line is ***...: 3rd-level heading
|
|
55 |
yield 'section', block |
|
56 |
elif block.startswith('* '): |
|
57 |
# bullet
|
|
58 |
yield 'bullet', block |
|
59 |
elif block.strip() == '': |
|
60 |
# empty
|
|
61 |
yield 'empty', block |
|
62 |
else: |
|
63 |
# plain text
|
|
64 |
yield 'text', block |
|
65 |
||
66 |
||
67 |
if __name__ == '__main__': |
|
68 |
import sys |
|
69 |
content = open(sys.argv[1], 'rb').read() |
|
70 |
for result in simple_parse(content): |
|
71 |
print result |