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
|
#!/usr/bin/env python3
#******************************************************************************
# numbering.py, provides classes to format node numbering
#
# TreeLine, an information storage program
# Copyright (C) 2019, Douglas W. Bell
#
# This is free software; you can redistribute it and/or modify it under the
# terms of the GNU General Public License, either Version 2 or any later
# version. This program is distributed in the hope that it will be useful,
# but WITHOUT ANY WARRANTY. See the included LICENSE file for details.
#******************************************************************************
import re
class NumberingGroup:
"""Class to store a multi-level numbering format and apply it.
"""
def __init__(self, numFormat=''):
"""Initialize a multi-level numbering format.
Arguments:
numFormat -- a string describing the format
"""
self.basicFormats = []
self.sectionStyle = False
if numFormat:
self.setFormat(numFormat)
def setFormat(self, numFormat):
"""Set a new number format.
Arguments:
numFormat -- a string describing the format
"""
self.sectionStyle = False
formats = _splitText(numFormat.replace('..', '.'), '/')
if len(formats) < 2:
formats = _splitText(numFormat.replace('//', '/'), '.')
if len(formats) > 1:
self.sectionStyle = True
self.basicFormats = [BasicNumbering(numFormat) for numFormat in
formats]
def numString(self, inputNumStr):
"""Return a number string for the given level and input.
The current numbering level is the segment length of the input.
Raises ValueError on a bad input string.
Arguments:
inputNumStr -- a dot-separated string of integers
"""
if not inputNumStr:
return ''
inputNums = [int(num) for num in inputNumStr.split('.')]
if self.sectionStyle:
basicFormats = self.basicFormats[:]
if len(basicFormats) < len(inputNums):
basicFormats.extend([basicFormats[-1]] * (len(inputNums) -
len(basicFormats)))
results = [basicFormat.numString(num) for basicFormat, num in
zip(basicFormats, inputNums)]
return '.'.join(results)
else:
level = len(inputNums) - 1
try:
basicFormat = self.basicFormats[level]
except IndexError:
basicFormat = self.basicFormats[-1]
return basicFormat.numString(inputNums[level])
_formatRegEx = re.compile(r'(.*?)([1AaIi]{1,2})(\W*)$')
class BasicNumbering:
"""Class to store an individaul numbering format and apply it.
"""
def __init__(self, numFormat=''):
"""Initialize a basic numbering format.
Arguments:
numFormat -- a string describing the format
"""
self.numFunction = _stringFromNum
self.upperCase = True
self.prefix = ''
self.suffix = ''
if numFormat:
self.setFormat(numFormat)
def setFormat(self, numFormat):
"""Set a new number format.
Arguments:
numFormat -- a string describing the format
"""
match = _formatRegEx.match(numFormat)
if match:
self.prefix, series, self.suffix = match.groups()
if series == '1':
self.numFunction = _stringFromNum
elif series in 'Aa':
self.numFunction = _alphaFromNum
elif series in 'AAaa':
self.numFunction = _alpha2FromNum
else:
self.numFunction = _romanFromNum
self.upperCase = series.isupper()
else:
self.prefix = numFormat
self.numFunction = _stringFromNum
def numString(self, num):
"""Return a number string for the given integer.
Arguments:
num -- the integer to convert
"""
return '{0}{1}{2}'.format(self.prefix,
self.numFunction(num, self.upperCase),
self.suffix)
def _stringFromNum(num, case=None):
"""Return a number string from an integer.
Arguments:
num -- the integer to convert
case -- an unused placeholder
"""
if num > 0:
return repr(num)
return ''
def _alphaFromNum(num, upperCase=True):
"""Return an alphabetic string from an integer.
Sequence is 'A', 'B' ... 'Z', 'AA', 'BB' ... 'ZZ', 'AAA', 'BBB' ...
Arguments:
num -- the integer to convert
upperCase -- return an upper case string if true
"""
if num <= 0:
return ''
result = ''
charPos = (num - 1) % 26
char = chr(charPos + ord('A'))
qty = (num - 1) // 26 + 1
result = char * qty
if not upperCase:
result = result.lower()
return result
def _alpha2FromNum(num, upperCase=True):
"""Return an alphabetic string from an integer.
Sequence is 'AA', 'BB' ... 'ZZ', 'AAA', 'BBB' ... 'ZZZ', 'AAAA', 'BBBB' ...
Arguments:
num -- the integer to convert
upperCase -- return an upper case string if true
"""
if num <= 0:
return ''
result = ''
charPos = (num - 1) % 26
char = chr(charPos + ord('A'))
qty = (num - 1) // 26 + 2
result = char * qty
if not upperCase:
result = result.lower()
return result
_romanDict = {0: '', 1: 'I', 2: 'II', 3: 'III', 4: 'IV', 5: 'V', 6: 'VI',
7: 'VII', 8: 'VIII', 9: 'IX', 10: 'X', 20: 'XX', 30: 'XXX',
40: 'XL', 50: 'L', 60: 'LX', 70: 'LXX', 80: 'LXXX',
90: 'XC', 100: 'C', 200: 'CC', 300: 'CCC', 400: 'CD',
500: 'D', 600: 'DC', 700: 'DCC', 800: 'DCCC', 900: 'CM',
1000: 'M', 2000: 'MM', 3000: 'MMM'}
def _romanFromNum(num, upperCase=True):
"""Return a roman numeral string from an integer.
Arguments:
num -- the integer to convert
upperCase -- return an upper case string if true
"""
if num <= 0 or num >= 4000:
return ''
result = ''
factor = 1000
while num:
digit = num - (num % factor)
result += _romanDict[digit]
factor = factor // 10
num -= digit
if not upperCase:
result = result.lower()
return result
def _splitText(textStr, delimitChar):
"""Split text using the given delimitter and return a list.
Double delimitters are not split and empty parts are ignored.
Arguments:
textStr -- the text to split
delimitChar -- the delimitter
"""
result = []
textStr = textStr.replace(delimitChar * 2, '\0')
for text in textStr.split(delimitChar):
text = text.replace('\0', delimitChar)
if text:
result.append(text)
return result
|
