fix: use UTF-8 encoding by default when dealing with text files (close …

…#267)

CHANGELOG

@@ -1,3 +1,5 @@
+1.0.5
+ - fix: use UTF-8 encoding by default when dealing with text files (#267)
 1.0.4
  - fix: minor issue with converting pos_y feature in sessions from
    before 0.7.6

shapeout/gui/batch.py

@@ -212,7 +212,7 @@ def OnBatch(self, e=None):
 
         head = ["data file", "Title"] + head
 
-        with io.open(self.out_tsv_file, "w") as fd:
+        with io.open(self.out_tsv_file, "w", encoding='utf-8') as fd:
             header = u"\t".join([ h for h in head ])
             fd.write("# "+header+"\n")
 

shapeout/gui/confparms.py

@@ -91,7 +91,7 @@ def GetConfigurationKeys(cfgfilename, capitalize=True):
     Load the configuration file and return the list of variables
     in the order they appear.
     """
-    with io.open(cfgfilename, 'r') as f:
+    with io.open(cfgfilename, 'r', encoding='utf-8') as f:
         code = f.readlines()
 
     cfglist = list()

shapeout/gui/controls_analyze.py

@@ -244,7 +244,7 @@ def OnApply(self, e=None):
             "",
             ]
 
-        with io.open(outf, "w") as fd:
+        with io.open(outf, "w", encoding='utf-8') as fd:
             fd.writelines([ll + "\r\n" for ll in citreq])
             fd.writelines(result["Full Summary"].replace("\n", "\r\n"))
 

shapeout/gui/export.py

@@ -276,5 +276,5 @@ def export_statistics_tsv(parent):
         if path.lower().endswith(".tsv") is not True:
             path = path+".tsv"
         parent.config.set_path(os.path.dirname(path), "TSV")
-        with io.open(path, 'w') as fd:
+        with io.open(path, 'w', encoding='utf-8') as fd:
             fd.writelines(exp)

shapeout/gui/update.py

@@ -28,7 +28,7 @@ def check_release(
     except:
         msg = "Timeout or wrong URL."
         try:
-            with open("check_update_error.log", "w") as fe:
+            with open("check_update_error.log", "w", encoding='utf-8') as fe:
                 fe.writelines(str(traceback.format_exc()))
         except:
             pass

shapeout/meta_tool.py

@@ -148,7 +148,7 @@ def get_event_count(fname):
         avif = mdir / (mid + "_imaq.avi")
         if logf.exists():
             # 1. The MX_log.ini file "Events" tag
-            with logf.open() as fd:
+            with logf.open(encoding='utf-8') as fd:
                 logd = fd.readlines()
             for l in logd:
                 if l.strip().startswith("Events:"):

shapeout/session/conversion.py

@@ -235,7 +235,7 @@ def compatibilitize_session(tempdir, hash_update=True, search_path="."):
         index.index_save(tempdir, index_dict)
 
     for cc in change_configs:
-        with cc.open() as fd:
+        with cc.open(encoding='utf-8') as fd:
             data = fd.read()
 
         if version < LooseVersion("0.7.1"):
@@ -307,20 +307,20 @@ def compatibilitize_session(tempdir, hash_update=True, search_path="."):
                                   pattern.format(old),
                                   pattern.format(new))
 
-        with cc.open("w") as fd:
+        with cc.open("w", encoding='utf-8') as fd:
             fd.write(data)
 
     # Change polygon filters as well
     pfile = tempdir / "PolygonFilters.poly"
     if pfile.exists():
-        with pfile.open() as fd:
+        with pfile.open(encoding='utf-8') as fd:
             datap = fd.read()
 
         if version < LooseVersion("0.7.6"):
             datap = compatibilitize_polygon(pdata=datap,
                                             version=version)
 
-        with pfile.open("w") as fd:
+        with pfile.open("w", encoding='utf-8') as fd:
             fd.write(datap)
     # load polygon filters here, because they are needed when computing
     # the hashes (RTDCBase.apply_filter is called for hierarchies)
@@ -397,11 +397,11 @@ def convert_polygon(infile, outfile=None, version=None):
                                         suffix=".poly")
     outfile = pathlib.Path(outfile)
 
-    with infile.open() as fd:
+    with infile.open(encoding='utf-8') as fd:
         pdata = fd.read()
     pdata = compatibilitize_polygon(pdata=pdata, version=version)
 
-    with outfile.open("w") as fd:
+    with outfile.open("w", encoding='utf-8') as fd:
         fd.write(pdata)
 
     return outfile

shapeout/session/index.py

@@ -112,7 +112,7 @@ def index_load(index_file):
 
     if index_file.is_dir():
         index_file = index_file / "index.txt"
-    with index_file.open() as f:
+    with index_file.open(encoding='utf-8') as f:
         code = f.readlines()
 
     for line in code:
@@ -165,7 +165,7 @@ def index_save(index_file, index_dict, save_version=version):
 
     for i in range(len(out)):
         out[i] = out[i]+"\n"
-    with index_file.open("w") as f:
+    with index_file.open("w", encoding='utf-8') as f:
         f.writelines(out)
 
 
@@ -200,7 +200,7 @@ def index_version(index_file):
     if index_file.is_dir():
         index_file = index_file / "index.txt"
     # Obtain version of session
-    with index_file.open("r") as fd:
+    with index_file.open("r", encoding='utf-8') as fd:
         data = fd.readlines()
 
     for line in data:

shapeout/settings.py

@@ -37,15 +37,15 @@ def __init__(self, name=NAME, defaults=DEFAULTS, directory=None):
         # create file if not existent
         if not fname.exists():
             # Create the file
-            fname.open("w").close()
+            fname.open("w", encoding='utf-8').close()
 
         self.cfgfile = fname
         self.defaults = defaults
         self.working_directories = {}
 
     def load(self):
         """Loads the settings file returning a dictionary"""
-        with self.cfgfile.open() as fop:
+        with self.cfgfile.open(encoding='utf-8') as fop:
             fc = fop.readlines()
         cdict = {}
         for line in fc:
@@ -115,7 +115,7 @@ def save(self, cdict):
                 sval = str(sval).decode("utf-8")
             outlist.append(u"{} = {}\n".format(sk, sval))
 
-        with self.cfgfile.open('w') as fop:
+        with self.cfgfile.open('w', encoding='utf-8') as fop:
             fop.writelines(outlist)
 
     def set_bool(self, key, value):

tests/test_gui_batch.py

@@ -46,7 +46,7 @@ def test_batch(self):
         batch.data_files = [tdms_path]
         batch.OnBatch()
 
-        with io.open(batch.out_tsv_file) as fd:
+        with io.open(batch.out_tsv_file, encoding='utf-8') as fd:
             data = fd.readlines()
 
         header = [d.strip().lower() for d in data[0].strip("# ").split("\t")]