Add type hints

Delgan · Dec 7, 2024 · 311b698 · 311b698
1 parent 1fc9d21
commit 311b698
Show file tree

Hide file tree

Showing 3 changed files with 8 additions and 1 deletion.
diff --git a/setup.py b/setup.py
@@ -17,6 +17,7 @@
     version=version,
     packages=["win32_setctime"],
     package_dir={"": "src"},
+    package_data={"win32_setctime": ["py.typed"]},
     description="A small Python utility to set file creation time on Windows",
     long_description=readme,
     long_description_content_type="text/markdown",

diff --git a/src/win32_setctime/_setctime.py b/src/win32_setctime/_setctime.py
@@ -1,4 +1,5 @@
 import os
+import sys
 
 try:
     from ctypes import byref, get_last_error, wintypes, FormatError, WinDLL, WinError
@@ -36,7 +37,12 @@
     SUPPORTED = os.name == "nt"
 
 
-def setctime(filepath, timestamp, *, follow_symlinks=True):
+from typing import Union
+
+
+def setctime(
+    filepath: Union[str, os.PathLike[str]], timestamp: float, *, follow_symlinks: bool = True
+) -> None:
     """Set the "ctime" (creation time) attribute of a file given an unix timestamp (Windows only)."""
     if not SUPPORTED:
         raise OSError("This function is only available for the Windows platform.")

diff --git a/src/win32_setctime/py.typed b/src/win32_setctime/py.typed