v0.8.2: Fix file encoding issue on Windows

* Closes #41

Python uses system default encoding to open files.  On Windows the default
encoding is latin-1.  As a result dactyl will crash on Windows.

- added explicit utf-8 encoding parameter to all open() calls

* Set version to 0.8.2

Author: iroskam

dactyl/common.py

@@ -45,7 +45,7 @@ def guess_title_from_md_file(filepath):
     If the first two lines look like a Markdown header, use that.
     Otherwise, return the filename."""
     try:
-        with open(filepath, "r") as f:
+        with open(filepath, "r", encoding="utf-8") as f:
             line1 = f.readline()
             line2 = f.readline()
 

dactyl/config.py

@@ -51,7 +51,7 @@ def set_logging(self):
     def load_config_from_file(self, config_file):
         logger.debug("loading config file %s..." % config_file)
         try:
-            with open(config_file, "r") as f:
+            with open(config_file, "r", encoding="utf-8") as f:
                 loaded_config = yaml.load(f)
         except FileNotFoundError as e:
             if config_file == DEFAULT_CONFIG_FILE:
@@ -165,14 +165,14 @@ def load_filters(self):
     def load_style_rules(self):
         """Reads word and phrase substitution files into the config"""
         if "word_substitutions_file" in self.config:
-            with open(self.config["word_substitutions_file"], "r") as f:
+            with open(self.config["word_substitutions_file"], "r", endoding="utf-8") as f:
                 self.config["disallowed_words"] = yaml.load(f)
         else:
             logger.warning("No 'word_substitutions_file' found in config.")
             self.config["disallowed_words"] = {}
 
         if "phrase_substitutions_file" in self.config:
-            with open(self.config["phrase_substitutions_file"], "r") as f:
+            with open(self.config["phrase_substitutions_file"], "r", encoding="utf-8") as f:
                 self.config["disallowed_phrases"] = yaml.load(f)
         else:
             logger.warning("No 'phrase_substitutions_file' found in config.")
@@ -210,7 +210,7 @@ def get_es_template(self, filename):
         """Loads an ElasticSearch template (as JSON)"""
         template_path = os.path.join(self.config["template_path"], filename)
         try:
-            with open(template_path) as f:
+            with open(template_path, encoding="utf-8") as f:
                 es_template = json.load(f)
         except (FileNotFoundError, json.decoder.JSONDecodeError) as e:
             if type(e) == FileNotFoundError:

dactyl/dactyl_build.py

@@ -314,7 +314,7 @@ def preprocess_markdown(page, target=None, categories=[], page_filters=[],
             md = read_markdown_remote(page["md"])
         else:
             logger.info("... reading markdown from file")
-            with open(page["md"], "r") as f:
+            with open(page["md"], "r", encoding="utf-8") as f:
                 md = f.read()
 
     else:
@@ -887,7 +887,7 @@ def write_page(page_text, filepath, out_path):
         logger.info("creating output folder %s" % out_folder)
         os.makedirs(out_folder)
     fileout = os.path.join(out_path, filepath)
-    with open(fileout, "w") as f:
+    with open(fileout, "w", encoding="utf-8") as f:
         logger.info("writing to file: %s..." % fileout)
         f.write(page_text)
 
@@ -1010,7 +1010,7 @@ def main(cli_args):
     if cli_args.vars:
         try:
             if cli_args.vars[-5:] in (".json",".yaml"):
-                with open(cli_args.vars, "r") as f:
+                with open(cli_args.vars, "r", encoding="utf-8") as f:
                     custom_keys = yaml.load(f)
             else:
                 custom_keys = yaml.load(cli_args.vars)

dactyl/dactyl_link_checker.py

@@ -17,7 +17,7 @@ def getSoup(fullPath):
     if fullPath in soupsCache.keys():
         soup = soupsCache[fullPath]
     else:
-        with open(fullPath, 'r') as f:
+        with open(fullPath, 'r', encoding="utf-8") as f:
             soup = BeautifulSoup(f.read(), "html.parser")
             soupsCache[fullPath] = soup
     return soup

dactyl/version.py

@@ -1 +1 @@
-__version__ = '0.8.1'
+__version__ = '0.8.2'

examples/custom_filters/filter_include_code.py

@@ -1,6 +1,6 @@
 def include_code(filename, lines="", mark_disjoint="", language=""):
     #TO-DO: Add "start_after" and "end_before" as an alternative to lines
-    with open(filename) as f:
+    with open(filename, encoding="utf-8") as f:
         s = f.read()
 
     # mark_disjoint

setup.py

@@ -9,9 +9,9 @@
     import pypandoc
     long_description = pypandoc.convert('README.md', 'rst')
 except ImportError:
-    long_description = open('README.md').read()
+    long_description = open('README.md', encoding="utf-8").read()
 
-with open("dactyl/version.py") as versionfile:
+with open("dactyl/version.py", encoding="utf-8") as versionfile:
     exec(versionfile.read())
 
 setup(