Added optional encoding to dump and load functions (#77)

src/pytomlpp/_io.py

@@ -1,71 +1,72 @@
-"""Python wrapper for Toml++ IO methods."""
-
-import os
-from typing import Any, BinaryIO, Dict, TextIO, Union
-
-from . import _impl
-
-FilePathOrObject = Union[str, TextIO, BinaryIO, os.PathLike]
-
-
-def dumps(data: Dict[Any, Any]) -> str:
-    """Serialise data to TOML string.
-
-    Args:
-        data (Dict[Any, Any]): input data
-
-    Returns:
-        str: seralised data
-    """
-    return _impl.dumps(data)
-
-
-def dump(data: Dict[Any, Any], fl: FilePathOrObject, mode: str = "w") -> None:
-    """Serialise data to TOML file
-
-    Args:
-        data (Dict[Any, Any]): input data
-        fl (FilePathOrObject): file like object or path
-        mode (str, optional): mode to write the file, support "w", "wt" (text) or "wb" (binary). Defaults to "w".
-    """
-    data = _impl.dumps(data)
-    if mode == "wb":
-        data = data.encode("utf-8")
-    if hasattr(fl, "write"):
-        fl.write(data)
-        return
-    with open(fl, mode=mode) as fh:
-        fh.write(data)
-
-
-def loads(data: str) -> Dict[Any, Any]:
-    """Deserialise from TOML string to python dict.
-
-    Args:
-        data (str): TOML string
-
-    Returns:
-        Dict[Any, Any]: deserialised data
-    """
-    return _impl.loads(data)
-
-
-def load(fl: FilePathOrObject, mode: str = "r") -> Dict[Any, Any]:
-    """Deserialise from TOML file to python dict.
-
-    Args:
-        fl (FilePathOrObject): file like object or path
-        mode (str, optional): mode to read the file, support "r", "rt" (text) or "rb" (binary). Defaults to "r".
-
-    Returns:
-        Dict[Any, Any]: deserialised data
-    """
-
-    if hasattr(fl, "read"):
-        data = fl.read()
-    else:
-        with open(fl, mode=mode) as fh:
-            data = fh.read()
-    if isinstance(data, bytes):
-        return _impl.loads(data.decode("utf-8"))
-    return _impl.loads(data)
+"""Python wrapper for Toml++ IO methods."""
+
+import os
+from typing import Any, BinaryIO, Dict, TextIO, Union, Optional
+
+from . import _impl
+
+FilePathOrObject = Union[str, TextIO, BinaryIO, os.PathLike]
+
+
+def dumps(data: Dict[Any, Any]) -> str:
+    """Serialise data to TOML string.
+
+    Args:
+        data (Dict[Any, Any]): input data
+
+    Returns:
+        str: seralised data
+    """
+    return _impl.dumps(data)
+
+
+def dump(data: Dict[Any, Any], fl: FilePathOrObject, mode: str = "w", encoding: Optional[str] = "utf-8") -> None:
+    """Serialise data to TOML file
+
+    Args:
+        data (Dict[Any, Any]): input data
+        fl (FilePathOrObject): file like object or path
+        mode (str, optional): mode to write the file, support "w", "wt" (text) or "wb" (binary). Defaults to "w".
+        encoding (str): defaults to utf-8, if None, local encoding is selected.
+    """
+    data = _impl.dumps(data)
+    if mode == "wb":
+        data = data.encode("utf-8")
+    if hasattr(fl, "write"):
+        fl.write(data)
+        return
+    with open(fl, mode=mode, encoding=encoding or None) as fh:
+        fh.write(data)
+
+
+def loads(data: str) -> Dict[Any, Any]:
+    """Deserialise from TOML string to python dict.
+
+    Args:
+        data (str): TOML string
+
+    Returns:
+        Dict[Any, Any]: deserialised data
+    """
+    return _impl.loads(data)
+
+
+def load(fl: FilePathOrObject, mode: str = "r", encoding: Optional[str] = "utf-8") -> Dict[Any, Any]:
+    """Deserialise from TOML file to python dict.
+
+    Args:
+        fl (FilePathOrObject): file like object or path
+        mode (str, optional): mode to read the file, support "r", "rt" (text) or "rb" (binary). Defaults to "r".
+
+    Returns:
+        Dict[Any, Any]: deserialised data
+    """
+
+    if hasattr(fl, "read"):
+        data = fl.read()
+    else:
+        with open(fl, mode=mode, encoding=encoding or None) as fh:
+            data = fh.read()
+    if isinstance(data, bytes):
+        return _impl.loads(data.decode("utf-8"))
+    return _impl.loads(data)