Add typing (#59)

Author: bobfang1992

.github/workflows/dists.yml

@@ -3,7 +3,13 @@
 # Publish runs only on a tag push
 name: Dists
 
-on: [push, pull_request]
+on:
+  push:
+    branches:
+      - master
+  pull_request:
+    branches:
+      - master
 
 jobs:
   build:
@@ -78,7 +84,6 @@ jobs:
         with:
           python-version: 3.9
 
-
       - name: Build sdist
         run: |
           ./setup.py sdist

MANIFEST.in

@@ -1,2 +1,3 @@
+global-include *.pyi
 recursive-include include *
 recursive-include third_party *

setup.cfg

@@ -35,4 +35,7 @@ package_dir = =src
 [options.packages.find]
 where = src
 
+[options.package_data]
+* = *.pyi
+
 [tool:pytest]

src/pytomlpp/__init__.py

@@ -2,9 +2,5 @@
 
 __all__ = ["DecodeError", "dumps", "loads", "dump", "load"]
 
-from ._impl import DecodeError
-from ._impl import dumps
-from ._impl import loads
-from ._impl import lib_version
-from ._io import dump
-from ._io import load
+from ._impl import DecodeError, lib_version
+from ._io import dump, dumps, load, loads

src/pytomlpp/_impl.pyi

@@ -0,0 +1,7 @@
+
+lib_version: str = ...
+
+
+class DecodeError(Exception):
+    """Error raised when decoding fails."""
+    ...

src/pytomlpp/_io.py

@@ -1,9 +1,26 @@
 """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 as string.
+
+    Args:
+        data: data to serialise
+
+    Returns:
+        serialised data
+    """
+    return _impl.dumps(data)
+
 
-def dump(data, fl, mode="w"):
+def dump(data: Dict[Any, Any], fl: FilePathOrObject, mode: str = "w") -> None:
     """Serialise data to TOML.
 
     Args:
@@ -24,8 +41,19 @@ def dump(data, fl, mode="w"):
         fh.write(data)
 
 
+def loads(data: str) -> Dict[Any, Any]:
+    """Deserialise from TOML as dictionary.
+
+    Args:
+        data (str): data to deserialise
+
+        Returns:
+            deserialised data
+    """
+    return _impl.loads(data)
+
 
-def load(fl, mode="r"):
+def load(fl: FilePathOrObject, mode: str = "r") -> Dict[Any, Any]:
     """Deserialise from TOML.
 
     Args: