Ensure type annotations are backwards compatible

Related: https://github.com/pimutils/todoman/issues/544

contrib/conflict_resolution/resolve_interactively.py

@@ -16,6 +16,8 @@ SPDX-License-Identifier: BSD-3-Clause
 SPDX-FileCopyrightText: 2021 Intevation GmbH <https://intevation.de>
 Author: <bernhard.reiter@intevation.de>
 """
+from __future__ import annotations
+
 import re
 import subprocess
 import sys

docs/conf.py

@@ -1,3 +1,5 @@
+from __future__ import annotations
+
 import datetime
 import os
 

pyproject.toml

@@ -14,6 +14,7 @@ target-version = "py37"
 
 [tool.ruff.isort]
 force-single-line = true
+required-imports = ["from __future__ import annotations"]
 
 [tool.pytest.ini_options]
 addopts = """

setup.py

@@ -4,6 +4,8 @@ Vdirsyncer synchronizes calendars and contacts.
 Please refer to https://vdirsyncer.pimutils.org/en/stable/packaging.html for
 how to package vdirsyncer.
 """
+from __future__ import annotations
+
 from setuptools import Command
 from setuptools import find_packages
 from setuptools import setup

tests/__init__.py

@@ -1,6 +1,8 @@
 """
 Test suite for vdirsyncer.
 """
+from __future__ import annotations
+
 import hypothesis.strategies as st
 import urllib3.exceptions
 

tests/conftest.py

@@ -1,6 +1,8 @@
 """
 General-purpose fixtures for vdirsyncer's testsuite.
 """
+from __future__ import annotations
+
 import logging
 import os
 

tests/storage/__init__.py

@@ -1,3 +1,5 @@
+from __future__ import annotations
+
 import random
 import textwrap
 import uuid

tests/storage/conftest.py

@@ -1,9 +1,10 @@
+from __future__ import annotations
+
 import asyncio
 import contextlib
 import subprocess
 import time
 import uuid
-from typing import Type
 
 import aiostream
 import pytest
@@ -90,7 +91,7 @@ async def slow_create_collection(request, aio_connector):
     # storage limits.
     to_delete = []
 
-    async def inner(cls: Type, args: dict, collection_name: str) -> dict:
+    async def inner(cls: type, args: dict, collection_name: str) -> dict:
         """Create a collection
 
         Returns args necessary to create a Storage instance pointing to it.

tests/storage/dav/__init__.py

@@ -1,3 +1,5 @@
+from __future__ import annotations
+
 import os
 import uuid
 

tests/storage/dav/test_caldav.py

@@ -1,3 +1,5 @@
+from __future__ import annotations
+
 import datetime
 from textwrap import dedent
 

tests/storage/dav/test_carddav.py

@@ -1,3 +1,5 @@
+from __future__ import annotations
+
 import pytest
 
 from vdirsyncer.storage.dav import CardDAVStorage

tests/storage/dav/test_main.py

@@ -1,3 +1,5 @@
+from __future__ import annotations
+
 import pytest
 
 from vdirsyncer.storage.dav import _BAD_XML_CHARS

tests/storage/servers/baikal/__init__.py

@@ -1,3 +1,5 @@
+from __future__ import annotations
+
 import pytest
 
 

tests/storage/servers/davical/__init__.py

@@ -1,3 +1,5 @@
+from __future__ import annotations
+
 import os
 import uuid
 

tests/storage/servers/fastmail/__init__.py

@@ -1,3 +1,5 @@
+from __future__ import annotations
+
 import os
 
 import pytest

tests/storage/servers/icloud/__init__.py

@@ -1,3 +1,5 @@
+from __future__ import annotations
+
 import os
 
 import pytest

tests/storage/servers/radicale/__init__.py

@@ -1,3 +1,5 @@
+from __future__ import annotations
+
 import pytest
 
 

tests/storage/servers/skip/__init__.py

@@ -1,3 +1,5 @@
+from __future__ import annotations
+
 import pytest
 
 

tests/storage/servers/xandikos/__init__.py

@@ -1,3 +1,5 @@
+from __future__ import annotations
+
 import pytest
 
 

tests/storage/test_filesystem.py

@@ -1,3 +1,5 @@
+from __future__ import annotations
+
 import subprocess
 
 import aiostream

tests/storage/test_http.py

@@ -1,3 +1,5 @@
+from __future__ import annotations
+
 import pytest
 from aiohttp import BasicAuth
 from aioresponses import CallbackResult

tests/storage/test_http_with_singlefile.py

@@ -1,3 +1,5 @@
+from __future__ import annotations
+
 import aiostream
 import pytest
 from aioresponses import CallbackResult

tests/storage/test_memory.py

@@ -1,3 +1,5 @@
+from __future__ import annotations
+
 import pytest
 
 from vdirsyncer.storage.memory import MemoryStorage

tests/storage/test_singlefile.py

@@ -1,3 +1,5 @@
+from __future__ import annotations
+
 import pytest
 
 from vdirsyncer.storage.singlefile import SingleFileStorage

tests/system/cli/conftest.py

@@ -1,3 +1,5 @@
+from __future__ import annotations
+
 from textwrap import dedent
 
 import pytest

tests/system/cli/test_config.py

@@ -1,3 +1,5 @@
+from __future__ import annotations
+
 import io
 from textwrap import dedent
 

tests/system/cli/test_discover.py

@@ -1,6 +1,7 @@
+from __future__ import annotations
+
 import json
 from textwrap import dedent
-from typing import List
 
 import pytest
 
@@ -210,7 +211,7 @@ def test_collection_required(a_requires, b_requires, tmpdir, runner, monkeypatch
         async def get(self, href: str):
             raise NotImplementedError
 
-        async def list(self) -> List[tuple]:
+        async def list(self) -> list[tuple]:
             raise NotImplementedError
 
     from vdirsyncer.cli.utils import storage_names

tests/system/cli/test_fetchparams.py

@@ -1,3 +1,5 @@
+from __future__ import annotations
+
 from textwrap import dedent
 
 

tests/system/cli/test_repair.py

@@ -1,3 +1,5 @@
+from __future__ import annotations
+
 from textwrap import dedent
 
 import pytest

tests/system/cli/test_sync.py

@@ -1,3 +1,5 @@
+from __future__ import annotations
+
 import json
 import sys
 from textwrap import dedent

tests/system/cli/test_utils.py

@@ -1,3 +1,5 @@
+from __future__ import annotations
+
 import pytest
 
 from vdirsyncer import exceptions

tests/system/conftest.py

@@ -1,3 +1,5 @@
+from __future__ import annotations
+
 import ssl
 
 import pytest

tests/system/utils/test_main.py

@@ -1,3 +1,5 @@
+from __future__ import annotations
+
 import logging
 
 import aiohttp

tests/unit/cli/test_config.py

@@ -1,3 +1,5 @@
+from __future__ import annotations
+
 import os
 
 from vdirsyncer.cli.config import _resolve_conflict_via_command

tests/unit/cli/test_discover.py

@@ -1,3 +1,5 @@
+from __future__ import annotations
+
 import aiostream
 import pytest
 

tests/unit/cli/test_fetchparams.py

@@ -1,3 +1,5 @@
+from __future__ import annotations
+
 from contextlib import contextmanager
 from unittest.mock import patch
 

tests/unit/sync/test_status.py

@@ -1,3 +1,5 @@
+from __future__ import annotations
+
 import hypothesis.strategies as st
 from hypothesis import assume
 from hypothesis import given

tests/unit/sync/test_sync.py

@@ -1,3 +1,5 @@
+from __future__ import annotations
+
 import asyncio
 from copy import deepcopy
 

tests/unit/test_exceptions.py

@@ -1,3 +1,5 @@
+from __future__ import annotations
+
 from vdirsyncer import exceptions
 
 

tests/unit/test_metasync.py

@@ -1,3 +1,5 @@
+from __future__ import annotations
+
 import hypothesis.strategies as st
 import pytest
 import pytest_asyncio

tests/unit/test_repair.py

@@ -1,3 +1,5 @@
+from __future__ import annotations
+
 import aiostream
 import pytest
 from hypothesis import HealthCheck

tests/unit/utils/test_vobject.py

@@ -1,3 +1,5 @@
+from __future__ import annotations
+
 from textwrap import dedent
 
 import hypothesis.strategies as st

vdirsyncer/__init__.py

@@ -1,7 +1,7 @@
 """
 Vdirsyncer synchronizes calendars and contacts.
 """
-
+from __future__ import annotations
 
 PROJECT_HOME = "https://github.com/pimutils/vdirsyncer"
 BUGTRACKER_HOME = PROJECT_HOME + "/issues"

vdirsyncer/__main__.py

@@ -1,3 +1,5 @@
+from __future__ import annotations
+
 if __name__ == "__main__":
     from vdirsyncer.cli import app
 

vdirsyncer/cli/__init__.py

@@ -1,3 +1,5 @@
+from __future__ import annotations
+
 import asyncio
 import functools
 import json

vdirsyncer/cli/discover.py

@@ -1,3 +1,5 @@
+from __future__ import annotations
+
 import asyncio
 import hashlib
 import json

vdirsyncer/cli/fetchparams.py

@@ -1,3 +1,5 @@
+from __future__ import annotations
+
 import logging
 
 import click

vdirsyncer/cli/tasks.py

@@ -1,3 +1,5 @@
+from __future__ import annotations
+
 import json
 
 import aiohttp

vdirsyncer/exceptions.py

@@ -2,6 +2,7 @@
 Contains exception classes used by vdirsyncer. Not all exceptions are here,
 only the most commonly used ones.
 """
+from __future__ import annotations
 
 
 class Error(Exception):

vdirsyncer/http.py

@@ -1,3 +1,5 @@
+from __future__ import annotations
+
 import logging
 from ssl import create_default_context
 

vdirsyncer/metasync.py

@@ -1,3 +1,5 @@
+from __future__ import annotations
+
 import logging
 
 from . import exceptions

vdirsyncer/repair.py

@@ -1,3 +1,5 @@
+from __future__ import annotations
+
 import logging
 from os.path import basename
 

vdirsyncer/storage/base.py

@@ -1,10 +1,10 @@
+from __future__ import annotations
+
 import contextlib
 import functools
 from abc import ABCMeta
 from abc import abstractmethod
 from typing import Iterable
-from typing import List
-from typing import Optional
 
 from vdirsyncer.vobject import Item
 
@@ -73,7 +73,7 @@ class Storage(metaclass=StorageMeta):
     read_only = False
 
     # The attribute values to show in the representation of the storage.
-    _repr_attributes: List[str] = []
+    _repr_attributes: list[str] = []
 
     def __init__(self, instance_name=None, read_only=None, collection=None):
         if read_only is None:
@@ -132,7 +132,7 @@ class Storage(metaclass=StorageMeta):
         )
 
     @abstractmethod
-    async def list(self) -> List[tuple]:
+    async def list(self) -> list[tuple]:
         """
         :returns: list of (href, etag)
         """
@@ -227,7 +227,7 @@ class Storage(metaclass=StorageMeta):
         """
         yield
 
-    async def get_meta(self, key: str) -> Optional[str]:
+    async def get_meta(self, key: str) -> str | None:
         """Get metadata value for collection/storage.
 
         See the vdir specification for the keys that *have* to be accepted.
@@ -237,7 +237,7 @@ class Storage(metaclass=StorageMeta):
         """
         raise NotImplementedError("This storage does not support metadata.")
 
-    async def set_meta(self, key: str, value: Optional[str]):
+    async def set_meta(self, key: str, value: str | None):
         """Set metadata value for collection/storage.
 
         :param key: The metadata key.
@@ -246,7 +246,7 @@ class Storage(metaclass=StorageMeta):
         raise NotImplementedError("This storage does not support metadata.")
 
 
-def normalize_meta_value(value) -> Optional[str]:
+def normalize_meta_value(value) -> str | None:
     # `None` is returned by iCloud for empty properties.
     if value is None or value == "None":
         return None

vdirsyncer/storage/dav.py

@@ -1,3 +1,5 @@
+from __future__ import annotations
+
 import datetime
 import logging
 import urllib.parse as urlparse
@@ -5,8 +7,6 @@ import xml.etree.ElementTree as etree
 from abc import abstractmethod
 from inspect import getfullargspec
 from inspect import signature
-from typing import Optional
-from typing import Type
 
 import aiohttp
 import aiostream
@@ -127,7 +127,7 @@ class Discover:
 
     @property
     @abstractmethod
-    def _resourcetype(self) -> Optional[str]:
+    def _resourcetype(self) -> str | None:
         pass
 
     @property
@@ -339,7 +339,7 @@ class CalDiscover(Discover):
 
 class CardDiscover(Discover):
     _namespace = "urn:ietf:params:xml:ns:carddav"
-    _resourcetype: Optional[str] = "{%s}addressbook" % _namespace
+    _resourcetype: str | None = "{%s}addressbook" % _namespace
     _homeset_xml = b"""
     <propfind xmlns="DAV:" xmlns:c="urn:ietf:params:xml:ns:carddav">
         <prop>
@@ -448,7 +448,7 @@ class DAVStorage(Storage):
 
     @property
     @abstractmethod
-    def discovery_class(self) -> Type[Discover]:
+    def discovery_class(self) -> type[Discover]:
         """Discover subclass to use."""
 
     # The DAVSession class to use
@@ -681,7 +681,7 @@ class DAVStorage(Storage):
         for href, etag, _prop in rv:
             yield href, etag
 
-    async def get_meta(self, key) -> Optional[str]:
+    async def get_meta(self, key) -> str | None:
         try:
             tagname, namespace = self._property_table[key]
         except KeyError:

vdirsyncer/storage/filesystem.py

@@ -1,3 +1,5 @@
+from __future__ import annotations
+
 import errno
 import logging
 import os

vdirsyncer/storage/google.py

@@ -1,3 +1,5 @@
+from __future__ import annotations
+
 import json
 import logging
 import os

vdirsyncer/storage/google_helpers.py

@@ -2,15 +2,14 @@
 #
 # Based on:
 # https://github.com/googleapis/google-auth-library-python-oauthlib/blob/1fb16be1bad9050ee29293541be44e41e82defd7/google_auth_oauthlib/flow.py#L513
+from __future__ import annotations
 
 import logging
 import wsgiref.simple_server
 import wsgiref.util
 from typing import Any
 from typing import Callable
-from typing import Dict
 from typing import Iterable
-from typing import Optional
 
 logger = logging.getLogger(__name__)
 
@@ -29,7 +28,7 @@ class _RedirectWSGIApp:
     Stores the request URI and displays the given success message.
     """
 
-    last_request_uri: Optional[str]
+    last_request_uri: str | None
 
     def __init__(self, success_message: str):
         """
@@ -41,7 +40,7 @@ class _RedirectWSGIApp:
 
     def __call__(
         self,
-        environ: Dict[str, Any],
+        environ: dict[str, Any],
         start_response: Callable[[str, list], None],
     ) -> Iterable[bytes]:
         """WSGI Callable.

vdirsyncer/storage/http.py

@@ -1,3 +1,5 @@
+from __future__ import annotations
+
 import urllib.parse as urlparse
 
 import aiohttp
@@ -34,7 +36,7 @@ class HttpStorage(Storage):
         auth_cert=None,
         *,
         connector,
-        **kwargs
+        **kwargs,
     ) -> None:
         super().__init__(**kwargs)
 

vdirsyncer/storage/memory.py

@@ -1,3 +1,5 @@
+from __future__ import annotations
+
 import random
 
 from .. import exceptions

vdirsyncer/storage/singlefile.py

@@ -1,3 +1,5 @@
+from __future__ import annotations
+
 import collections
 import contextlib
 import functools

vdirsyncer/sync/__init__.py

@@ -9,6 +9,8 @@ Yang: http://blog.ezyang.com/2012/08/how-offlineimap-works/
 Some modifications to it are explained in
 https://unterwaditzer.net/2016/sync-algorithm.html
 """
+from __future__ import annotations
+
 import contextlib
 import itertools
 import logging

vdirsyncer/sync/exceptions.py

@@ -1,3 +1,5 @@
+from __future__ import annotations
+
 from .. import exceptions
 
 

vdirsyncer/sync/status.py

@@ -1,3 +1,5 @@
+from __future__ import annotations
+
 import abc
 import contextlib
 import sqlite3

vdirsyncer/utils.py

@@ -1,3 +1,5 @@
+from __future__ import annotations
+
 import functools
 import os
 import sys

vdirsyncer/vobject.py

@@ -1,3 +1,5 @@
+from __future__ import annotations
+
 import hashlib
 from itertools import chain
 from itertools import tee