1 #!/usr/bin/env python 2 3 """ 4 Output 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 class Output: 23 24 "A common output context abstraction." 25 26 default_encoding = "utf-8" 27 28 def __init__(self, parameters=None): 29 30 "Initialise the output context with the optional 'parameters'." 31 32 self.parameters = parameters 33 self.encoding = parameters and parameters.get("encoding") or self.default_encoding 34 35 # Set up an output collector. 36 37 self.output = [] 38 39 def encode(self, text): 40 41 "Encode 'text' using the configured encoding." 42 43 return encode(text, self.encoding) 44 45 def out(self, text): 46 47 "Add 'text' to the output collector." 48 49 self.output.append(self.encode(text)) 50 51 def to_string(self): 52 53 "Return the output as a plain string." 54 55 return "".join(self.output) 56 57 def encode(s, encoding): 58 59 "Encode 's' using 'encoding' if Unicode." 60 61 if isinstance(s, unicode): 62 return s.encode(encoding) 63 else: 64 return s 65 66 # vim: tabstop=4 expandtab shiftwidth=4