Update version number and add Black lint (#65)

* Update version number

* Add black lint workflow

* Format code with black

Author: Diviloper

.github/workflows/black.yml

@@ -0,0 +1,20 @@
+name: Lint code with Black
+
+on:
+  push:
+    branches: [ "master", "stable-[0-9]+.[0-9]+" ]
+  pull_request:
+    branches: [ "master", "stable-[0-9]+.[0-9]+" ]
+
+jobs:
+  lint:
+    name: Lint code with Black
+    runs-on: ubuntu-latest
+    steps:
+      - name: Checkout sources
+        uses: actions/checkout@v4
+
+      - name: Run Black
+        uses: psf/black@stable
+        with:
+          version: "~= 24.0"

docs/conf.py

@@ -6,47 +6,52 @@
 # -- Project information -----------------------------------------------------
 # https://www.sphinx-doc.org/en/master/usage/configuration.html#project-information
 
-project = 'PyMEOS'
-copyright = '2023, Víctor Diví'
-author = 'Víctor Diví'
-release = '1.1.3'
+project = "PyMEOS"
+copyright = "2023, Víctor Diví"
+author = "Víctor Diví"
+release = "1.1.4"
 
 # -- General configuration ---------------------------------------------------
 # https://www.sphinx-doc.org/en/master/usage/configuration.html#general-configuration
 import os
 import sys
 
-sys.path.insert(0, os.path.abspath('../pymeos_cffi'))
-sys.path.insert(0, os.path.abspath('../pymeos'))
+sys.path.insert(0, os.path.abspath("../pymeos_cffi"))
+sys.path.insert(0, os.path.abspath("../pymeos"))
 
 extensions = [
-    'sphinx.ext.autodoc',
-    'sphinx.ext.napoleon',
-    'sphinx.ext.intersphinx',
-    'myst_nb',
+    "sphinx.ext.autodoc",
+    "sphinx.ext.napoleon",
+    "sphinx.ext.intersphinx",
+    "myst_nb",
 ]
 
 nb_execution_mode = "off"
 
-templates_path = ['_templates']
-exclude_patterns = ['_build', 'Thumbs.db', '.DS_Store', '_build',
-                    '**.ipynb_checkpoints']
-autodoc_member_order = 'bysource'
+templates_path = ["_templates"]
+exclude_patterns = [
+    "_build",
+    "Thumbs.db",
+    ".DS_Store",
+    "_build",
+    "**.ipynb_checkpoints",
+]
+autodoc_member_order = "bysource"
 
 # -- Intersphinx config --------
 intersphinx_mapping = {
-    'asyncpg': ('https://magicstack.github.io/asyncpg/current/', None),
-    'psycopg': ('https://www.psycopg.org/psycopg3/docs/', None),
-    'psycopg2': ('https://www.psycopg.org/docs/', None),
-    'shapely': ('https://shapely.readthedocs.io/en/stable/', None),
-    'python': ('https://docs.python.org/3', None)
+    "asyncpg": ("https://magicstack.github.io/asyncpg/current/", None),
+    "psycopg": ("https://www.psycopg.org/psycopg3/docs/", None),
+    "psycopg2": ("https://www.psycopg.org/docs/", None),
+    "shapely": ("https://shapely.readthedocs.io/en/stable/", None),
+    "python": ("https://docs.python.org/3", None),
 }
 
 # -- Options for HTML output -------------------------------------------------
 # https://www.sphinx-doc.org/en/master/usage/configuration.html#options-for-html-output
 
-html_theme = 'sphinx_book_theme'
-html_static_path = ['_static']
+html_theme = "sphinx_book_theme"
+html_static_path = ["_static"]
 
 import requests
 
@@ -58,15 +63,13 @@ def download_file(url, dest_path):
     # Ensure folder for destination file exists
     os.makedirs(os.path.dirname(dest_path), exist_ok=True)
 
-    with open(dest_path, 'wb') as file:
+    with open(dest_path, "wb") as file:
         for chunk in response.iter_content(chunk_size=8192):
             file.write(chunk)
 
 
 prefix = "https://raw.githubusercontent.com/MobilityDB/PyMEOS-Examples/main/"
+download_file(f"{prefix}PyMEOS_Examples/AIS.ipynb", "src/examples/AIS.ipynb")
 download_file(
-    f"{prefix}PyMEOS_Examples/AIS.ipynb",
-    "src/examples/AIS.ipynb")
-download_file(
-    f"{prefix}PyMEOS_Examples/BerlinMOD.ipynb",
-    "src/examples/BerlinMOD.ipynb")
+    f"{prefix}PyMEOS_Examples/BerlinMOD.ipynb", "src/examples/BerlinMOD.ipynb"
+)

pymeos/__init__.py

@@ -29,7 +29,7 @@
     MeosGeoJsonOutputError,
 )
 
-__version__ = "1.1.3"
+__version__ = "1.1.4"
 __all__ = [
     # initialization
     "pymeos_initialize",

pymeos/aggregators/aggregator.py

@@ -244,9 +244,7 @@ def _add(
         interval_converted = (
             timedelta_to_interval(interval)
             if isinstance(interval, timedelta)
-            else pg_interval_in(interval, -1)
-            if isinstance(interval, str)
-            else None
+            else pg_interval_in(interval, -1) if isinstance(interval, str) else None
         )
         origin_converted = (
             datetime_to_timestamptz(origin)

pymeos/boxes/stbox.py

@@ -41,10 +41,10 @@ class STBox:
     _mobilitydb_name = "stbox"
 
     def _get_box(
-            self,
-            other: Union[shp.BaseGeometry, STBox, Temporal, Time],
-            allow_space_only: bool = True,
-            allow_time_only: bool = False,
+        self,
+        other: Union[shp.BaseGeometry, STBox, Temporal, Time],
+        allow_space_only: bool = True,
+        allow_time_only: bool = False,
     ) -> STBox:
         if allow_space_only and isinstance(other, shp.BaseGeometry):
             other_box = geo_to_stbox(geo_to_gserialized(other, self.geodetic()))
@@ -68,31 +68,31 @@ def _get_box(
 
     # ------------------------- Constructors ----------------------------------
     def __init__(
-            self,
-            string: Optional[str] = None,
-            *,
-            xmin: Optional[Union[str, float]] = None,
-            xmax: Optional[Union[str, float]] = None,
-            ymin: Optional[Union[str, float]] = None,
-            ymax: Optional[Union[str, float]] = None,
-            zmin: Optional[Union[str, float]] = None,
-            zmax: Optional[Union[str, float]] = None,
-            tmin: Optional[Union[str, datetime]] = None,
-            tmax: Optional[Union[str, datetime]] = None,
-            tmin_inc: bool = True,
-            tmax_inc: bool = True,
-            geodetic: bool = False,
-            srid: Optional[int] = None,
-            _inner=None,
+        self,
+        string: Optional[str] = None,
+        *,
+        xmin: Optional[Union[str, float]] = None,
+        xmax: Optional[Union[str, float]] = None,
+        ymin: Optional[Union[str, float]] = None,
+        ymax: Optional[Union[str, float]] = None,
+        zmin: Optional[Union[str, float]] = None,
+        zmax: Optional[Union[str, float]] = None,
+        tmin: Optional[Union[str, datetime]] = None,
+        tmax: Optional[Union[str, datetime]] = None,
+        tmin_inc: bool = True,
+        tmax_inc: bool = True,
+        geodetic: bool = False,
+        srid: Optional[int] = None,
+        _inner=None,
     ):
         assert (_inner is not None) or (string is not None) != (
-                (
-                        xmin is not None
-                        and xmax is not None
-                        and ymin is not None
-                        and ymax is not None
-                )
-                or (tmin is not None and tmax is not None)
+            (
+                xmin is not None
+                and xmax is not None
+                and ymin is not None
+                and ymax is not None
+            )
+            or (tmin is not None and tmax is not None)
         ), (
             "Either string must be not None or at least a bound pair (xmin/max"
             " and ymin/max, or tmin/max) must be not None"
@@ -106,10 +106,10 @@ def __init__(
             tstzspan = None
             hast = tmin is not None and tmax is not None
             hasx = (
-                    xmin is not None
-                    and xmax is not None
-                    and ymin is not None
-                    and ymax is not None
+                xmin is not None
+                and xmax is not None
+                and ymin is not None
+                and ymax is not None
             )
             hasz = zmin is not None and zmax is not None
             if hast:
@@ -224,9 +224,9 @@ def from_time(time: Time) -> STBox:
 
     @staticmethod
     def from_geometry_time(
-            geometry: shp.BaseGeometry,
-            time: Union[datetime, TsTzSpan],
-            geodetic: bool = False,
+        geometry: shp.BaseGeometry,
+        time: Union[datetime, TsTzSpan],
+        geodetic: bool = False,
     ) -> STBox:
         """
         Returns a `STBox` from a space and time dimension.
@@ -272,9 +272,9 @@ def from_tpoint(temporal: TPoint) -> STBox:
 
     @staticmethod
     def from_expanding_bounding_box(
-            value: Union[shp.BaseGeometry, TPoint, STBox],
-            expansion: float,
-            geodetic: Optional[bool] = False,
+        value: Union[shp.BaseGeometry, TPoint, STBox],
+        expansion: float,
+        geodetic: Optional[bool] = False,
     ) -> STBox:
         """
         Returns a `STBox` from a `shp.BaseGeometry`, `TPoint` or `STBox` instance,
@@ -661,7 +661,7 @@ def scale_time(self, duration: timedelta) -> STBox:
         return self.shift_scale_time(duration=duration)
 
     def shift_scale_time(
-            self, shift: Optional[timedelta] = None, duration: Optional[timedelta] = None
+        self, shift: Optional[timedelta] = None, duration: Optional[timedelta] = None
     ) -> STBox:
         """
         Returns a new `STBox` with the time dimension shifted by `shift` and
@@ -681,7 +681,7 @@ def shift_scale_time(
             :meth:`TsTzSpan.shift_scale`
         """
         assert (
-                shift is not None or duration is not None
+            shift is not None or duration is not None
         ), "shift and scale deltas must not be both None"
         result = stbox_shift_scale_time(
             self._inner,
@@ -792,7 +792,7 @@ def __mul__(self, other):
 
     # ------------------------- Topological Operations ------------------------
     def is_adjacent(
-            self, other: Union[shp.BaseGeometry, STBox, Temporal, Time]
+        self, other: Union[shp.BaseGeometry, STBox, Temporal, Time]
     ) -> bool:
         """
         Returns whether ``self`` and `other` are adjacent. Two spatiotemporal
@@ -815,7 +815,7 @@ def is_adjacent(
         )
 
     def is_contained_in(
-            self, container: Union[shp.BaseGeometry, STBox, Temporal, Time]
+        self, container: Union[shp.BaseGeometry, STBox, Temporal, Time]
     ) -> bool:
         """
         Returns whether ``self`` is contained in `container`. Note that for
@@ -1177,7 +1177,7 @@ def is_over_or_after(self, other: Union[Box, Temporal, Time]) -> bool:
 
     # ------------------------- Distance Operations ---------------------------
     def nearest_approach_distance(
-            self, other: Union[shp.BaseGeometry, STBox, TPoint]
+        self, other: Union[shp.BaseGeometry, STBox, TPoint]
     ) -> float:
         """
         Returns the distance between the nearest points of ``self`` and `other`.
@@ -1277,11 +1277,11 @@ def quad_split(self) -> Union[List[List[STBox]], List[List[List[STBox]]]]:
             ]
 
     def tile(
-            self,
-            size: Optional[float] = None,
-            duration: Optional[Union[timedelta, str]] = None,
-            origin: Optional[shp.BaseGeometry] = None,
-            start: Union[datetime, str, None] = None,
+        self,
+        size: Optional[float] = None,
+        duration: Optional[Union[timedelta, str]] = None,
+        origin: Optional[shp.BaseGeometry] = None,
+        start: Union[datetime, str, None] = None,
     ) -> List[STBox]:
         """
         Returns a list of `STBox` instances representing the tiles of
@@ -1306,35 +1306,35 @@ def tile(
             stbox_tile_list
         """
         sz = size or (
-                max(
-                    self.xmax() - self.xmin(),
-                    self.ymax() - self.ymin(),
-                    (self.zmax() - self.zmin() if self.has_z() else 0),
-                )
-                + 1
+            max(
+                self.xmax() - self.xmin(),
+                self.ymax() - self.ymin(),
+                (self.zmax() - self.zmin() if self.has_z() else 0),
+            )
+            + 1
         )
         dt = (
             timedelta_to_interval(duration)
             if isinstance(duration, timedelta)
-            else pg_interval_in(duration, -1)
-            if isinstance(duration, str)
-            else None
+            else pg_interval_in(duration, -1) if isinstance(duration, str) else None
         )
         st = (
             datetime_to_timestamptz(start)
             if isinstance(start, datetime)
-            else pg_timestamptz_in(start, -1)
-            if isinstance(start, str)
-            else pg_timestamptz_in("2000-01-03", -1)
-            if self.has_t()
-            else 0
+            else (
+                pg_timestamptz_in(start, -1)
+                if isinstance(start, str)
+                else pg_timestamptz_in("2000-01-03", -1) if self.has_t() else 0
+            )
         )
         gs = (
             geo_to_gserialized(origin, self.geodetic())
             if origin is not None
-            else pgis_geography_in("Point(0 0 0)", -1)
-            if self.geodetic()
-            else pgis_geometry_in("Point(0 0 0)", -1)
+            else (
+                pgis_geography_in("Point(0 0 0)", -1)
+                if self.geodetic()
+                else pgis_geometry_in("Point(0 0 0)", -1)
+            )
         )
         tiles, count = stbox_tile_list(self._inner, sz, sz, sz, dt, gs, st)
         return [STBox(_inner=tiles + i) for i in range(count)]

pymeos/boxes/tbox.py

@@ -1124,9 +1124,11 @@ def tile(
         st = (
             datetime_to_timestamptz(start)
             if isinstance(start, datetime)
-            else pg_timestamptz_in(start, -1)
-            if isinstance(start, str)
-            else pg_timestamptz_in("2000-01-03", -1)
+            else (
+                pg_timestamptz_in(start, -1)
+                if isinstance(start, str)
+                else pg_timestamptz_in("2000-01-03", -1)
+            )
         )
         if self._is_float():
             tiles, count = tfloatbox_tile_list(self._inner, size, dt, origin, st)