forked from Freely-Given-org/BibleOrgSys
-
Notifications
You must be signed in to change notification settings - Fork 0
/
ESFMFile.py
executable file
·238 lines (192 loc) · 9.34 KB
/
ESFMFile.py
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
#!/usr/bin/env python3
# -*- coding: utf-8 -*-
#
# ESFMFile.py
#
# ESFM (Enhanced Standard Format Marker) data file reader
#
# Copyright (C) 2010-2017 Robert Hunt
# Author: Robert Hunt <Freely.Given.org@gmail.com>
# License: See gpl-3.0.txt
#
# This program is free software: you can redistribute it and/or modify
# it under the terms of the GNU General Public License as published by
# the Free Software Foundation, either version 3 of the License, or
# (at your option) any later version.
#
# This program is distributed in the hope that it will be useful,
# but WITHOUT ANY WARRANTY; without even the implied warranty of
# MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
# GNU General Public License for more details.
#
# You should have received a copy of the GNU General Public License
# along with this program. If not, see <http://www.gnu.org/licenses/>.
"""
Module for reading UTF-8 ESFM (Enhanced Standard Format Marker) Bible file.
ESFMFile: A "flat" text file, read line by line into a list.
The ESFM and its data field are read into a 2-tuple and saved (in order) in the list.
Raises an IOError error if file doesn't exist.
"""
from gettext import gettext as _
LastModifiedDate = '2017-10-19' # by RJH
ShortProgName = "ESFMFile"
ProgName = "ESFM File loader"
ProgVersion = '0.86'
ProgNameVersion = '{} v{}'.format( ShortProgName, ProgVersion )
ProgNameVersionDate = '{} {} {}'.format( ProgNameVersion, _("last modified"), LastModifiedDate )
debuggingThisModule = False
import logging, sys
import BibleOrgSysGlobals
DUMMY_VALUE = 999999 # Some number bigger than the number of characters in a line
#def splitMarkerText( line ):
#"""
#Given a line of text (may be empty),
#returns a backslash marker and the text.
#Returns None for the backslash marker if there isn't one.
#Returns an empty string for the text if there isn't any.
#"""
#while line and line[0]==' ': line = line[1:] # Remove leading spaces
#if not line: return None, ''
#if line[0] != '\\': return None, line # Not a USFM line
## We have a line that starts with a backslash
## The marker can end with a space, asterisk, or another marker
#lineAfterBackslash = line[1:]
#si1 = lineAfterBackslash.find( ' ' )
#si2 = lineAfterBackslash.find( '*' )
#si3 = lineAfterBackslash.find( '\\' )
#if si1==-1: si1 = DUMMY_VALUE
#if si2==-1: si2 = DUMMY_VALUE
#if si3==-1: si3 = DUMMY_VALUE
#si = min( si1, si2, si3 ) # Find the first terminating character (if any)
#if si == DUMMY_VALUE: # The line is only the marker
#return lineAfterBackslash, ''
#else:
#if si == si3: # Marker stops before a backslash
#marker = lineAfterBackslash[:si3]
#text = lineAfterBackslash[si3:]
#elif si == si2: # Marker stops at an asterisk
#marker = lineAfterBackslash[:si2+1]
#text = lineAfterBackslash[si2+1:]
#elif si == si1: # Marker stops before a space
#marker = lineAfterBackslash[:si1]
#text = lineAfterBackslash[si1+1:] # We drop the space completely
#return marker, text
## end if splitMarkerText
class ESFMFile:
"""
Class holding a list of (non-blank) ESFM lines.
Each line is a tuple consisting of (SFMMarker, SFMValue).
"""
def __init__(self):
self.lines = []
# end of ESFMFile.__init__
def __str__(self):
"""
This method returns the string representation of a SFM lines object.
@return: the name of a ESFM field object formatted as a string
@rtype: string
"""
result = "ESFM File Object"
if BibleOrgSysGlobals.debugFlag or BibleOrgSysGlobals.verbosityLevel>2: result += ' v' + ProgVersion
for line in self.lines:
result += ('\n' if result else '') + str( line )
return result
# end of ESFMFile.__str__
def read( self, esfm_filename, ignoreSFMs=None ):
"""Read a simple ESFM (Enhanced Standard Format Marker) file into a list of tuples.
@param esfm_filename: The filename
@type esfm_filename: string
@param key: The SFM record marker (not including the backslash)
@type encoding: string
@rtype: list
@return: list of lists containing the records
"""
#print( "ESFMFile.read( {}, {}, {} )".format( repr(esfm_filename), repr(ignoreSFMs), repr(encoding) ) )
# Check/handle parameters
if ignoreSFMs is None: ignoreSFMs = ()
lastLine, lineCount, result = '', 0, []
with open( esfm_filename, encoding='utf-8' ) as ourFile: # Automatically closes the file when done
try:
for line in ourFile:
lineCount += 1
if lineCount==1 and line[0]==chr(65279): #U+FEFF or \ufeff
logging.info( "ESFMFile: Detected Unicode Byte Order Marker (BOM) in {}".format( esfm_filename ) )
line = line[1:] # Remove the Unicode Byte Order Marker (BOM)
if line and line[-1]=='\n': line=line[:-1] # Removing trailing newline character
if not line: continue # Just discard blank lines
lastLine = line
#print ( 'ESFM file line is "' + line + '"' )
#if line[0:2]=='\\_': continue # Just discard Toolbox header lines
if line[0]=='#': continue # Just discard comment lines
while line and line[0]==' ': line = line[1:] # Remove leading spaces
if line and line[0]!='\\': # Not a SFM line
if len(result)==0: # We don't have any SFM data lines yet
if BibleOrgSysGlobals.verbosityLevel > 2:
logging.error( "Non-ESFM line in " + esfm_filename + " -- line ignored at #" + str(lineCount) )
#print( "SFMFile.py: XXZXResult is", result, len(line) )
#for x in range(0, min(6,len(line))):
#print( x, "'" + str(ord(line[x])) + "'" )
#raise IOError('Oops: Line break on last line ??? not handled here "' + line + '"')
else: # Append this continuation line
if marker not in ignoreSFMs:
oldmarker, oldtext = result.pop()
#print ("Popped",oldmarker,oldtext)
#print ("Adding", line, "to", oldmarker, oldtext)
result.append( (oldmarker, oldtext+' '+line) )
continue
lineAfterBackslash = line[1:]
si1 = lineAfterBackslash.find( ' ' )
si2 = lineAfterBackslash.find( '*' )
si3 = lineAfterBackslash.find( '\\' )
if si1==-1: si1 = DUMMY_VALUE
if si2==-1: si2 = DUMMY_VALUE
if si3==-1: si3 = DUMMY_VALUE
si = min( si1, si2, si3 )
if si != DUMMY_VALUE:
if si == si3: # Marker stops before a backslash
marker = lineAfterBackslash[:si3]
text = lineAfterBackslash[si3:]
elif si == si2: # Marker stops at an asterisk
marker = lineAfterBackslash[:si2+1]
text = lineAfterBackslash[si2+1:]
elif si == si1: # Marker stops before a space
marker = lineAfterBackslash[:si1]
text = lineAfterBackslash[si1+1:] # We drop the space completely
else: # The line is only the marker
marker = lineAfterBackslash
text = ''
#print( " ", repr(marker), repr(text) )
if marker not in ignoreSFMs:
result.append( (marker, text) )
except UnicodeError as err:
print( "Unicode error:", sys.exc_info()[0], err )
logging.critical( "Invalid line in " + esfm_filename + " -- line ignored at #" + str(lineCount) )
if lineCount > 1: print( 'Previous line was: ', lastLine )
#print( line )
#raise
self.lines = result
# end of ESFMFile.read
# end of class ESFMFile
def demo():
"""
Demonstrate reading and processing some UTF-8 ESFM files.
"""
if BibleOrgSysGlobals.verbosityLevel > 1: print( ProgNameVersion )
import os.path
filepath = os.path.join( 'Tests/DataFilesForTests/', 'MatigsalugDictionaryA.sfm' )
if BibleOrgSysGlobals.verbosityLevel > 2: print( "Using {} as test file…".format( filepath ) )
linesDB = ESFMFile()
linesDB.read( filepath, ignoreSFMs=('mn','aMU','aMW','cu','cp') )
print( len(linesDB.lines), 'lines read from file', filepath )
for i, r in enumerate(linesDB.lines):
print ( i, r)
if i>9: break
print ( '…\n',len(linesDB.lines)-1, linesDB.lines[-1], '\n') # Display the last record
# end of demo
if __name__ == '__main__':
# Configure basic set-up
parser = BibleOrgSysGlobals.setup( ProgName, ProgVersion )
BibleOrgSysGlobals.addStandardOptionsAndProcess( parser )
demo()
BibleOrgSysGlobals.closedown( ProgName, ProgVersion )
# end of ESFMFile.py