1 #!/usr/bin/env python 2 3 """ 4 Input context common functionality. 5 6 Copyright (C) 2018 Paul Boddie <paul@boddie.org.uk> 7 8 This program is free software; you can redistribute it and/or modify it under 9 the terms of the GNU General Public License as published by the Free Software 10 Foundation; either version 3 of the License, or (at your option) any later 11 version. 12 13 This program is distributed in the hope that it will be useful, but WITHOUT 14 ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or FITNESS 15 FOR A PARTICULAR PURPOSE. See the GNU General Public License for more 16 details. 17 18 You should have received a copy of the GNU General Public License along with 19 this program. If not, see <http://www.gnu.org/licenses/>. 20 """ 21 22 import codecs 23 24 class Input: 25 26 "A common input context abstraction." 27 28 default_encoding = "utf-8" 29 30 def __init__(self, parameters=None): 31 32 "Initialise the input context with the optional 'parameters'." 33 34 self.parameters = parameters 35 self.encoding = parameters and parameters.get("encoding") or self.default_encoding 36 37 def readfile(self, filename, encoding=None): 38 39 """ 40 Return the contents of the file having the given 'filename'. If the 41 optional 'encoding' is specified, override the general encoding. 42 """ 43 44 f = codecs.open(filename, encoding=encoding or self.encoding) 45 try: 46 return f.read() 47 finally: 48 f.close() 49 50 # vim: tabstop=4 expandtab shiftwidth=4