Add support for 'Self' type in type hints for compatibility with Python 3.10+

Author: myui

rtrec/models/base.py

@@ -2,7 +2,15 @@
 import pickle
 from abc import ABC, abstractmethod
 from io import BytesIO
-from typing import Any, Iterable, List, Optional, Self, Tuple, Union
+from typing import Any, Iterable, List, Optional, Tuple, Union, TYPE_CHECKING
+
+if TYPE_CHECKING:  # static analyzers
+    from typing import Self
+else:  # runtime on 3.10
+    try:
+        from typing import Self  # 3.11+
+    except ImportError:
+        from typing_extensions import Self
 
 from rtrec.utils.features import FeatureStore
 from rtrec.utils.identifiers import Identifier

rtrec/models/hybrid.py

@@ -1,6 +1,14 @@
 import logging
 from collections import defaultdict
-from typing import Any, Dict, Iterable, List, Optional, Self, Tuple, override
+from typing import Any, Dict, Iterable, List, Optional, Tuple, override, TYPE_CHECKING
+
+if TYPE_CHECKING:  # static analyzers
+    from typing import Self
+else:  # runtime on 3.10
+    try:
+        from typing import Self  # 3.11+
+    except ImportError:
+        from typing_extensions import Self
 
 import implicit.cpu.topk as implicit
 import numpy as np

rtrec/models/internal/slim_elastic.py

@@ -3,7 +3,15 @@
 import warnings
 from functools import partial
 from multiprocessing import Pool, shared_memory
-from typing import Any, Dict, List, Optional, Self, Tuple
+from typing import Any, Dict, List, Optional, Tuple, TYPE_CHECKING
+
+if TYPE_CHECKING:  # static analyzers
+    from typing import Self
+else:  # runtime on 3.10
+    try:
+        from typing import Self  # 3.11+
+    except ImportError:
+        from typing_extensions import Self
 
 import numpy as np
 import scipy.sparse as sp

rtrec/models/lightfm.py

@@ -1,5 +1,13 @@
 import logging
-from typing import Any, Iterable, List, Optional, Self, Tuple, override
+from typing import Any, Iterable, List, Optional, Tuple, override, TYPE_CHECKING
+
+if TYPE_CHECKING:  # static analyzers
+    from typing import Self
+else:  # runtime on 3.10
+    try:
+        from typing import Self  # 3.11+
+    except ImportError:
+        from typing_extensions import Self
 
 import implicit.cpu.topk as implicit
 import numpy as np

rtrec/models/slim.py

@@ -1,5 +1,13 @@
 import logging
-from typing import Any, Iterable, List, Optional, Self, Tuple, override
+from typing import Any, Iterable, List, Optional, Tuple, override, TYPE_CHECKING
+
+if TYPE_CHECKING:  # static analyzers
+    from typing import Self
+else:  # runtime on 3.10
+    try:
+        from typing import Self  # 3.11+
+    except ImportError:
+        from typing_extensions import Self
 
 from ..models.internal.slim_elastic import SLIMElastic
 from .base import BaseModel

rtrec/recommender.py

@@ -1,6 +1,14 @@
 import math
 import time
-from typing import Any, Dict, Iterable, Iterator, List, Optional, Self, Tuple
+from typing import Any, Dict, Iterable, Iterator, List, Optional, Tuple, TYPE_CHECKING
+
+if TYPE_CHECKING:  # static analyzers
+    from typing import Self
+else:  # runtime on 3.10
+    try:
+        from typing import Self  # 3.11+
+    except ImportError:
+        from typing_extensions import Self
 
 import pandas as pd
 from tqdm import tqdm