Add type annotations to UPath (#79)

* pyproject.toml: add mypy config

* upath: add type annotations and switch to urlsplit/urlunsplit

* upath: fix self._url = None issue in relative_to

* upath: add py.typed file

* upath: linting and formatting

* ci: check typing in ci

* upath: add comment regarding UPath.touch

Author: ap--

.github/workflows/python.yml

@@ -3,13 +3,12 @@ on:
   push:
   pull_request:
 jobs:
-  build:
+  tests:
     runs-on: ${{ matrix.os }}
     strategy:
       matrix:
         python-version: [3.7, 3.8, 3.9, "3.10", "3.11-dev"]
         os: [ubuntu-latest, windows-latest]
-
     steps:
     - uses: actions/checkout@v3
     - name: Set up Python ${{ matrix.python-version }}
@@ -23,9 +22,33 @@ jobs:
     - name: Test with pytest
       run: |
         nox -s smoke
+
+  lint:
+    runs-on: ubuntu-latest
+    steps:
+    - uses: actions/checkout@v3
+    - name: Set up Python ${{ matrix.python-version }}
+      uses: actions/setup-python@v4
+    - name: Install dependencies
+      run: |
+        python -m pip install --upgrade pip nox
     - name: Lint
       run: |
         nox -s lint
+    - name: Type Checking
+      run: |
+        nox -s type_checking
+
+  build:
+    needs: [tests, lint]
+    runs-on: ubuntu-latest
+    steps:
+    - uses: actions/checkout@v3
+    - name: Set up Python ${{ matrix.python-version }}
+      uses: actions/setup-python@v4
+    - name: Install dependencies
+      run: |
+        python -m pip install --upgrade pip nox
     - name: build package
       run: |
         nox -s build

noxfile.py

@@ -22,6 +22,12 @@ def lint(session):
     session.run("flake8", "upath")
 
 
+@nox.session()
+def type_checking(session):
+    session.install("mypy")
+    session.run("mypy", "upath")
+
+
 @nox.session()
 def install(session):
     session.install(".")
@@ -31,9 +37,12 @@ def install(session):
 def smoke(session):
     if (3, 10) < sys.version_info <= (3, 11, 0, "final"):
         # workaround for missing aiohttp wheels for py3.11
-        session.install("aiohttp", "--no-binary", "aiohttp", env={
-            "AIOHTTP_NO_EXTENSIONS": "1"
-        })
+        session.install(
+            "aiohttp",
+            "--no-binary",
+            "aiohttp",
+            env={"AIOHTTP_NO_EXTENSIONS": "1"},
+        )
 
     session.install(
         "pytest",

pyproject.toml

@@ -51,3 +51,21 @@ include = []
 [tool.black]
 line-length = 80
 target-version = ['py38']
+
+[tool.mypy]
+python_version = "3.7"
+warn_return_any = true
+warn_unused_configs = true
+exclude = "^notebooks|^venv.*|tests.*|^noxfile.py"
+
+[[tool.mypy.overrides]]
+module = "fsspec.*"
+ignore_missing_imports = true
+
+[[tool.mypy.overrides]]
+module = "webdav4.fsspec.*"
+ignore_missing_imports = true
+
+[[tool.mypy.overrides]]
+module = "setuptools.*"
+ignore_missing_imports = true