refactor: use custom types

.github/workflows/unit.yaml

@@ -19,17 +19,17 @@ jobs:
           python-version: "3.10"
       - uses: pre-commit/[email protected]
 
-  #mypy:
-  #  runs-on: ubuntu-latest
-  #  steps:
-  #    - uses: actions/checkout@v3
-  #    - uses: actions/setup-python@v4
-  #      with:
-  #        python-version: "3.10"
-  #    - name: Install nox
-  #      run: pip install nox
-  #    - name: run mypy checks
-  #      run: nox -s mypy
+  mypy:
+    runs-on: ubuntu-latest
+    steps:
+      - uses: actions/checkout@v3
+      - uses: actions/setup-python@v4
+        with:
+          python-version: "3.10"
+      - name: Install nox
+        run: pip install nox
+      - name: run mypy checks
+        run: nox -s mypy
 
   #docs:
   #  needs: [lint] #, mypy]
@@ -45,7 +45,7 @@ jobs:
   #      run: nox -s docs
 
   build:
-    needs: [lint] #, mypy]
+    needs: [lint, mypy]
     strategy:
       fail-fast: false
       matrix:

geetools/Array/__init__.py

@@ -1,11 +1,10 @@
 """Extra methods for the ``ee.Array`` class."""
 from __future__ import annotations
 
-from typing import Union
-
 import ee
 
 from geetools.accessors import geetools_accessor
+from geetools.types import ee_int, ee_number
 
 # hack to have the generated Array class available
 # it might create issues in the future with libs that have exotic init methods
@@ -23,9 +22,9 @@
     # -- alternative constructor -----------------------------------------------
     def full(
         self,
-        width: Union[int, float, ee.Number],
-        height: Union[int, float, ee.Number],
-        value: Union[int, ee.Number, float],
+        width: ee_number,
+        height: ee_number,
+        value: ee_number,
     ) -> ee.Array:
         """Create an array with the given dimensions, initialized to the given value.
 
@@ -53,9 +52,9 @@
     # -- data maniputlation ----------------------------------------------------
     def set(
         self,
-        x: Union[int, ee.number],
-        y: Union[int, ee.number],
-        value: Union[int, float, ee.Number],
+        x: ee_int,
+        y: ee_int,
+        value: ee_number,
     ) -> ee.Array:
         """Set the value of a cell in an array.
 

geetools/ComputedObject/__init__.py

@@ -3,11 +3,12 @@
 
 import json
 from pathlib import Path
-from typing import Type, Union
+from typing import Type
 
 import ee
 
 from geetools.accessors import geetools_extend
+from geetools.types import pathlike
 
 
 # -- types management ----------------------------------------------------------
@@ -36,7 +37,7 @@
 
 # -- .gee files ----------------------------------------------------------------
 @geetools_extend(ee.ComputedObject)
-def save(self, path: Union[str, Path]) -> Path:
+def save(self, path: pathlike) -> Path:
     """Save a ``ComputedObject`` to a .gee file.
 
     The file contains the JSON representation of the object. it still need to be computed via ``getInfo()`` to be used.
@@ -67,9 +68,9 @@
     return path
 
 
-@geetools_extend(ee.ComputedObject)
+@geetools_extend(ee.ComputedObject)  # type: ignore
 @classmethod
-def open(cls, path: Union[str, Path]) -> ee.ComputedObject:
+def open(cls, path: pathlike) -> ee.ComputedObject:
     """Open a .gee file as a ComputedObject.
 
     Parameters:

geetools/Date/__init__.py

@@ -64,8 +64,8 @@
                 d = ee.Date.geetools.fromDOY(1, 2020)
                 d.getInfo()
         """
-        doy, year = ee.Number(doy).toInt(), ee.Number(year).toInt()
-        return ee.Date.fromYMD(year, 1, 1).advance(doy.subtract(1), "day")
+        d, y = ee.Number(doy).toInt(), ee.Number(year).toInt()
+        return ee.Date.fromYMD(y, 1, 1).advance(d.subtract(1), "day")
 
     # -- export date -----------------------------------------------------------
     def to_datetime(self) -> datetime:

geetools/DateRange/__init__.py

@@ -1,11 +1,10 @@
 """Extra tools for the ``ee.DateRange`` class."""
 from __future__ import annotations
 
-from typing import Union
-
 import ee
 
 from geetools.accessors import geetools_accessor
+from geetools.types import ee_int
 
 
 @geetools_accessor(ee.DateRange)
@@ -17,7 +16,7 @@
         self._obj = obj
 
     # -- date range operations -------------------------------------------------
-    def split(self, interval: Union[int, ee.Number], unit: str = "day") -> ee.List:
+    def split(self, interval: ee_int, unit: str = "day") -> ee.List:
         """Convert a ``ee.DateRange`` to a list of ``ee.DateRange``.
 
         The DateRange will be split in multiple DateRanges of the specified interval and Unit.

geetools/Dictionary/__init__.py

@@ -1,11 +1,10 @@
 """Extra methods for the ``ee.Dictionary`` class."""
 from __future__ import annotations
 
-from typing import Union
-
 import ee
 
 from geetools.accessors import geetools_accessor
+from geetools.types import ee_list
 
 
 @geetools_accessor(ee.Dictionary)
@@ -17,7 +16,7 @@
         self._obj = obj
 
     # -- alternative constructor -----------------------------------------------
-    def fromPairs(self, list: Union[list, ee.List]) -> ee.Dictionary:
+    def fromPairs(self, list: ee_list) -> ee.Dictionary:
         """Create a dictionary from a list of [[key, value], ...]] pairs.
 
         Parameters:
@@ -62,7 +61,7 @@
         values = orderededKeys.map(lambda key: self._obj.get(key))
         return ee.Dictionary.fromLists(orderededKeys, values)
 
-    def getMany(self, list: Union[ee.List, list]) -> ee.List:
+    def getMany(self, list: ee_list) -> ee.List:
         """Extract values from a list of keys.
 
         Parameters:

geetools/FeatureCollection/__init__.py

@@ -6,6 +6,7 @@
 import ee
 
 from geetools.accessors import geetools_accessor
+from geetools.types import ee_int, ee_str
 
 
 @geetools_accessor(ee.FeatureCollection)
@@ -18,8 +19,8 @@
 
     def toImage(
         self,
-        color: Union[ee.String, str, ee.Number, int] = 0,
-        width: Union[ee.String, str, ee.Number, int] = "",
+        color: Union[ee_str, ee_int] = 0,
+        width: Union[ee_str, ee_int] = "",
     ) -> ee.Image:
         """Paint the current FeatureCollection to an Image.
 
@@ -33,9 +34,7 @@
         width == "" or params.update(width=width)
         return ee.Image().paint(self._obj, **params)
 
-    def addId(
-        self, name: Union[str, ee.String] = "id", start: Union[int, ee.Number] = 1
-    ) -> ee.FeatureCollection:
+    def addId(self, name: ee_str = "id", start: ee_int = 1) -> ee.FeatureCollection:
         """Add a unique numeric identifier, starting from parameter ``start``.
 
         Returns: