Always specify encoding when opening text files

Author: Cito

webware/Admin/View.py

@@ -24,8 +24,7 @@ def defaultAction(self):
                 self.writeError('File cannot be viewed!')
 
     def writeError(self, message):
-        self.writeln(
-            f'<h3 style="color:red">Error</h3><p>{message}</p>')
+        self.writeln(f'<h3 style="color:red">Error</h3><p>{message}</p>')
 
     def writeContent(self):
         filename = self.request().field('filename', None)
@@ -41,7 +40,7 @@ def writeContent(self):
         self._type = 'text/' + (
             'html' if splitext(filename)[1] in ('.htm', '.html') else 'plain')
         try:
-            with open(filename) as f:
+            with open(filename, encoding='utf-8') as f:
                 self._data = f.read()
         except Exception:
             self.writeError(f'The requested file {filename!r} cannot be read.')

webware/Application.py

@@ -221,7 +221,8 @@ def __init__(self, path=None, settings=None, development=None):
             if '/' not in filename:
                 filename = os.path.join(self._logDir, filename)
             # pylint: disable=consider-using-with
-            sys.stderr = sys.stdout = open(filename, 'a', buffering=1)
+            sys.stderr = sys.stdout = open(
+                filename, 'a', encoding='utf-8', buffering=1)
 
         self.initErrorPage()
         self.printStartUpMessage()
@@ -267,7 +268,7 @@ def initErrorPage(self):
                      os.path.dirname(os.path.abspath(__file__))):
             error404file = os.path.join(path, 'error404.html')
             try:
-                with open(error404file) as f:
+                with open(error404file, encoding='utf-8') as f:
                     self._error404 = f.read()
             except Exception:
                 continue
@@ -611,7 +612,7 @@ def writeActivityLog(self, trans):
             filename = os.path.join(self._logDir, filename)
         filename = self.serverSidePath(filename)
         mode = 'a' if os.path.exists(filename) else 'w'
-        with open(filename, mode) as f:
+        with open(filename, mode, encoding='utf-8') as f:
             if mode == 'w':
                 f.write(','.join(self.setting('ActivityLogColumns')) + '\n')
             values = []

webware/Examples/Colorize.py

@@ -54,7 +54,7 @@ def respond(self, transaction):
         filename = req.field('filename')
         filename = self.request().serverSidePath(os.path.basename(filename))
         try:
-            with open(filename) as f:
+            with open(filename, encoding='utf-8') as f:
                 source = f.read()
         except IOError:
             source = None

webware/Examples/DBUtilsDemo.py

@@ -44,9 +44,8 @@ class DBUtilsDemo(ExamplePage):
     # Initialize the buttons
     _actions = []
     _buttons = []
-    for action in (
-            'create tables', 'list seminars', 'list attendees',
-            'add seminar', 'add attendee'):
+    for action in ('create tables', 'list seminars', 'list attendees',
+                   'add seminar', 'add attendee'):
         value = action.capitalize()
         action = action.split()
         action[1] = action[1].capitalize()

webware/ExceptionHandler.py

@@ -421,7 +421,7 @@ def saveErrorPage(self, html):
         filename = os.path.join(
             self._app._errorMessagesDir, self.errorPageFilename())
         try:
-            with open(filename, 'w') as f:
+            with open(filename, 'w', encoding='utf-8') as f:
                 f.write(html)
         except IOError:
             sys.stderr.write(
@@ -473,10 +473,10 @@ def fixElement(element):
         filename = self._app.setting('ErrorLogFilename')
         try:
             if os.path.exists(filename):
-                with open(filename, 'a') as f:
+                with open(filename, 'a', encoding='utf-8') as f:
                     f.write(logLine)
             else:
-                with open(filename, 'w') as f:
+                with open(filename, 'w', encoding='utf-8') as f:
                     f.write(
                         'time,filename,pathname,exception name,'
                         'exception data,error report filename\n')

webware/HTTPRequest.py

@@ -71,7 +71,7 @@ def __init__(self, requestDict=None):
 
         # Debugging
         if debug:
-            with open('env.text', 'a') as f:
+            with open('env.text', 'a', encoding='utf-8') as f:
                 f.write('>> env for request:\n')
                 for key in sorted(env):
                     f.write(f'{key}: {env[key]!r}\n')

webware/MiscUtils/DataTable.py

@@ -507,8 +507,8 @@ def strip(x):
     def save(self):
         self.writeFileNamed(self._filename)
 
-    def writeFileNamed(self, filename):
-        with open(filename, 'w') as f:
+    def writeFileNamed(self, filename, encoding='utf-8'):
+        with open(filename, 'w', encoding=encoding) as f:
             self.writeFile(f)
 
     def writeFile(self, file):

webware/MiscUtils/PickleCache.py

@@ -92,7 +92,7 @@ def read(self, filename,
         if not os.path.exists(filename):
             if v:
                 print(f'Cannot find {filename!r}.')
-            open(filename)  # to get a properly constructed IOError
+            open(filename, 'rb')  # to get a properly constructed IOError
 
         shouldDeletePickle = False
         data = None

webware/MiscUtils/PropertiesObject.py

@@ -71,7 +71,7 @@ def loadValues(self, *args, **kwargs):
 
     def readFileNamed(self, filename):
         results = {}
-        with open(filename) as f:
+        with open(filename, encoding='utf-8') as f:
             exec(f.read(), results)
         self.update(results)
         self.cleanPrivateItems()

webware/MiscUtils/Tests/BenchCSVParser.py

@@ -44,8 +44,8 @@ def _main(self):
             print("Benchmark using", name, "...")
             self.benchFileNamed(name)
 
-    def benchFileNamed(self, name):
-        with open(name) as f:
+    def benchFileNamed(self, name, encoding='utf-8'):
+        with open(name, encoding=encoding) as f:
             lines = f.readlines()
         for line in lines:
             for _iteration in range(self._iterations):