From 022f14c0ebc757eae6eefacb5b5ccb140a443e0f Mon Sep 17 00:00:00 2001 From: =?UTF-8?q?Kamil=20Krzy=C5=9Bk=C3=B3w?= Date: Sun, 17 Mar 2024 04:43:34 +0100 Subject: [PATCH] Fixed UTF-8 with BOM encoding support --- material/plugins/blog/plugin.py | 2 +- material/plugins/blog/structure/__init__.py | 2 +- material/plugins/info/plugin.py | 4 ++-- material/plugins/privacy/plugin.py | 4 ++-- src/plugins/blog/plugin.py | 2 +- src/plugins/blog/structure/__init__.py | 2 +- src/plugins/info/plugin.py | 4 ++-- src/plugins/privacy/plugin.py | 4 ++-- 8 files changed, 12 insertions(+), 12 deletions(-) diff --git a/material/plugins/blog/plugin.py b/material/plugins/blog/plugin.py index 2ab8e87ed..a99e93cc9 100644 --- a/material/plugins/blog/plugin.py +++ b/material/plugins/blog/plugin.py @@ -460,7 +460,7 @@ class BlogPlugin(BasePlugin[BlogConfig]): return config.authors # Open file and parse as YAML - with open(file, encoding = "utf-8") as f: + with open(file, encoding = "utf-8-sig") as f: config.config_file_path = os.path.abspath(file) try: config.load_dict(yaml.load(f, SafeLoader) or {}) diff --git a/material/plugins/blog/structure/__init__.py b/material/plugins/blog/structure/__init__.py index 255a26934..0285f3a9b 100644 --- a/material/plugins/blog/structure/__init__.py +++ b/material/plugins/blog/structure/__init__.py @@ -57,7 +57,7 @@ class Post(Page): path = os.path.relpath(file.abs_src_path, docs) # Read contents and metadata immediately - with open(file.abs_src_path, encoding = "utf-8") as f: + with open(file.abs_src_path, encoding = "utf-8-sig") as f: self.markdown = f.read() # Sadly, MkDocs swallows any exceptions that occur during parsing. diff --git a/material/plugins/info/plugin.py b/material/plugins/info/plugin.py index 4479dd59d..806ca4864 100644 --- a/material/plugins/info/plugin.py +++ b/material/plugins/info/plugin.py @@ -437,7 +437,7 @@ def _convert_to_abs(path: str, abs_prefix: str = None) -> str: # logic. Side effect: It converts the INHERIT path to absolute. def _load_yaml(abs_src_path: str): - with open(abs_src_path, "r", encoding ="utf-8-sig") as file: + with open(abs_src_path, encoding ="utf-8-sig") as file: source = file.read() try: @@ -479,7 +479,7 @@ def _resolve_pattern(abspath: str, return_path: bool = False): # Get project configuration with resolved absolute paths for validation def _get_project_config(project_config_file: str): - with open(project_config_file, encoding="utf-8") as file: + with open(project_config_file, encoding="utf-8-sig") as file: config = MkDocsConfig(config_file_path = project_config_file) config.load_file(file) diff --git a/material/plugins/privacy/plugin.py b/material/plugins/privacy/plugin.py index e6a87203e..f7c6fd5b7 100644 --- a/material/plugins/privacy/plugin.py +++ b/material/plugins/privacy/plugin.py @@ -254,7 +254,7 @@ class PrivacyPlugin(BasePlugin[PrivacyConfig]): # Find and extract all external asset URLs expr = re.compile(self.assets_expr_map[extension], flags = re.I | re.M) - with open(initiator.abs_src_path, encoding = "utf-8") as f: + with open(initiator.abs_src_path, encoding = "utf-8-sig") as f: return [urlparse(url) for url in re.findall(expr, f.read())] # Parse template or page HTML and find all external links that need to be @@ -437,7 +437,7 @@ class PrivacyPlugin(BasePlugin[PrivacyConfig]): # Patch all links to external assets in the given file def _patch(self, initiator: File): - with open(initiator.abs_src_path, encoding = "utf-8") as f: + with open(initiator.abs_src_path, encoding = "utf-8-sig") as f: # Replace callback def replace(match: Match): diff --git a/src/plugins/blog/plugin.py b/src/plugins/blog/plugin.py index 2ab8e87ed..a99e93cc9 100644 --- a/src/plugins/blog/plugin.py +++ b/src/plugins/blog/plugin.py @@ -460,7 +460,7 @@ class BlogPlugin(BasePlugin[BlogConfig]): return config.authors # Open file and parse as YAML - with open(file, encoding = "utf-8") as f: + with open(file, encoding = "utf-8-sig") as f: config.config_file_path = os.path.abspath(file) try: config.load_dict(yaml.load(f, SafeLoader) or {}) diff --git a/src/plugins/blog/structure/__init__.py b/src/plugins/blog/structure/__init__.py index 255a26934..0285f3a9b 100644 --- a/src/plugins/blog/structure/__init__.py +++ b/src/plugins/blog/structure/__init__.py @@ -57,7 +57,7 @@ class Post(Page): path = os.path.relpath(file.abs_src_path, docs) # Read contents and metadata immediately - with open(file.abs_src_path, encoding = "utf-8") as f: + with open(file.abs_src_path, encoding = "utf-8-sig") as f: self.markdown = f.read() # Sadly, MkDocs swallows any exceptions that occur during parsing. diff --git a/src/plugins/info/plugin.py b/src/plugins/info/plugin.py index 4479dd59d..806ca4864 100644 --- a/src/plugins/info/plugin.py +++ b/src/plugins/info/plugin.py @@ -437,7 +437,7 @@ def _convert_to_abs(path: str, abs_prefix: str = None) -> str: # logic. Side effect: It converts the INHERIT path to absolute. def _load_yaml(abs_src_path: str): - with open(abs_src_path, "r", encoding ="utf-8-sig") as file: + with open(abs_src_path, encoding ="utf-8-sig") as file: source = file.read() try: @@ -479,7 +479,7 @@ def _resolve_pattern(abspath: str, return_path: bool = False): # Get project configuration with resolved absolute paths for validation def _get_project_config(project_config_file: str): - with open(project_config_file, encoding="utf-8") as file: + with open(project_config_file, encoding="utf-8-sig") as file: config = MkDocsConfig(config_file_path = project_config_file) config.load_file(file) diff --git a/src/plugins/privacy/plugin.py b/src/plugins/privacy/plugin.py index e6a87203e..f7c6fd5b7 100644 --- a/src/plugins/privacy/plugin.py +++ b/src/plugins/privacy/plugin.py @@ -254,7 +254,7 @@ class PrivacyPlugin(BasePlugin[PrivacyConfig]): # Find and extract all external asset URLs expr = re.compile(self.assets_expr_map[extension], flags = re.I | re.M) - with open(initiator.abs_src_path, encoding = "utf-8") as f: + with open(initiator.abs_src_path, encoding = "utf-8-sig") as f: return [urlparse(url) for url in re.findall(expr, f.read())] # Parse template or page HTML and find all external links that need to be @@ -437,7 +437,7 @@ class PrivacyPlugin(BasePlugin[PrivacyConfig]): # Patch all links to external assets in the given file def _patch(self, initiator: File): - with open(initiator.abs_src_path, encoding = "utf-8") as f: + with open(initiator.abs_src_path, encoding = "utf-8-sig") as f: # Replace callback def replace(match: Match):