Add CI linting & tests

Author: anitagraser

.github/workflows/tests.yaml

@@ -0,0 +1,58 @@
+name: Tests
+
+on:
+  push:
+    branches: [main, 0.**]
+  pull_request:
+  schedule:
+    - cron: "0 0 * * *"
+
+concurrency:
+  group: ${{ github.workflow }}-${{ github.ref }}
+  cancel-in-progress: true
+
+jobs:
+  Linting:
+    runs-on: ubuntu-latest
+
+    steps:
+      - uses: actions/checkout@v2
+      - uses: actions/setup-python@v2
+      - uses: pre-commit/[email protected]
+
+  Test:
+    #needs: Linting
+    name: ${{ matrix.os }}, ${{ matrix.env }}
+    runs-on: ${{ matrix.os }}
+    defaults:
+      run:
+        shell: bash -l {0}
+    strategy:
+      fail-fast: false
+      matrix:
+        os: [ubuntu-latest]
+        env:
+          - environment.yml
+        include:
+          - env: environment.yml
+            os: ubuntu-latest
+
+    steps:
+      - uses: actions/checkout@v4
+
+      - name: Install Conda environment with Micromamba
+        uses: mamba-org/setup-micromamba@v2
+        with:
+          environment-file: ${{ matrix.env }}
+
+      - name: Check and Log Environment
+        run: |
+          python -V
+          micromamba info
+          micromamba list
+          
+      - name: Test
+        run: |
+          pytest -v -r s --color=yes .
+
+      - uses: codecov/codecov-action@v5

.gitignore

@@ -116,3 +116,4 @@ venv.bak/
 .vscode/
 .vscode/settings.json
 tests/sandbox.ipynb
+symbology-style.db

__init__.py

@@ -17,24 +17,24 @@
 ***************************************************************************
 """
 
-__author__ = 'Anita Graser'
-__date__ = 'Sep 2025'
-__copyright__ = '(c) 2025, Anita Graser'
+__author__ = "Anita Graser"
+__date__ = "Sep 2025"
+__copyright__ = "(c) 2025, Anita Graser"
 
 # This will get replaced with a git SHA1 when you do a git archive
 
-__revision__ = '$Format:%H$'
-
+__revision__ = "$Format:%H$"
 
 
 from packaging.version import Version
 from movingpandas import __version__ as mpd_version
 
-MIN_MPD_VERSION = '0.22.3'
+MIN_MPD_VERSION = "0.22.3"
 if Version(mpd_version) < Version(MIN_MPD_VERSION):
-    raise(RuntimeError(f'Please update MovingPandas to >={MIN_MPD_VERSION}'))
+    raise (RuntimeError(f"Please update MovingPandas to >={MIN_MPD_VERSION}"))
 
 from .qgis_processing.trajectoolsProviderPlugin import TrajectoryProviderPlugin
 
+
 def classFactory(iface):
     return TrajectoryProviderPlugin()

environment.yml

@@ -0,0 +1,10 @@
+name: trajectools
+channels:
+  - conda-forge
+dependencies:
+  - python=3.12
+  - black
+  - movingpandas
+  - pre-commit
+  - pytest
+  - qgis

qgis_processing/cleaningAlgorithm.py

@@ -1,9 +1,7 @@
 import sys
 import pandas as pd
 
-from movingpandas import (
-    OutlierCleaner
-)
+from movingpandas import OutlierCleaner
 
 from qgis.core import (
     QgsProcessingParameterString,
@@ -13,7 +11,11 @@
 
 sys.path.append("..")
 
-from .trajectoriesAlgorithm import TrajectoryManipulationAlgorithm, help_str_base, help_str_traj
+from .trajectoriesAlgorithm import (
+    TrajectoryManipulationAlgorithm,
+    help_str_base,
+    help_str_traj,
+)
 
 
 class CleaningAlgorithm(TrajectoryManipulationAlgorithm):
@@ -57,12 +59,14 @@ def shortHelpString(self):
             "the speed exceeds the provided <b>Speed threshold</b> value </p>"
             "<p>For more info see: "
             "https://movingpandas.readthedocs.io/en/main/api/trajectorycleaner.html</p>"
-            ""+help_str_base+help_str_traj
+            "" + help_str_base + help_str_traj
         )
 
     def processTc(self, tc, parameters, context):
         v_max = self.parameterAsDouble(parameters, self.TOLERANCE, context)
-        generalized = OutlierCleaner(tc).clean(v_max=v_max, units=tuple(self.speed_units))
+        generalized = OutlierCleaner(tc).clean(
+            v_max=v_max, units=tuple(self.speed_units)
+        )
         self.tc_to_sink(generalized)
         for traj in generalized:
             self.traj_to_sink(traj)

qgis_processing/createTrajectoriesAlgorithm.py

@@ -2,7 +2,11 @@
 
 sys.path.append("..")
 
-from .trajectoriesAlgorithm import TrajectoryManipulationAlgorithm, help_str_base, help_str_traj
+from .trajectoriesAlgorithm import (
+    TrajectoryManipulationAlgorithm,
+    help_str_base,
+    help_str_traj,
+)
 
 
 class CreateTrajectoriesAlgorithm(TrajectoryManipulationAlgorithm):
@@ -24,7 +28,7 @@ def groupId(self):
     def shortHelpString(self):
         return self.tr(
             "<p>Creates a trajectory point layers with speed and direction information "
-            "as well as a trajectory line layer.</p>"+help_str_base+help_str_traj
+            "as well as a trajectory line layer.</p>" + help_str_base + help_str_traj
         )
 
     def helpUrl(self):

qgis_processing/extractPtsAlgorithm.py

@@ -62,7 +62,9 @@ def displayName(self):
         return self.tr("Extract OD points")
 
     def shortHelpString(self):
-        return self.tr("<p>Extracts start and/or end points of trajectories.</p>"+help_str_base)
+        return self.tr(
+            "<p>Extracts start and/or end points of trajectories.</p>" + help_str_base
+        )
 
     def processAlgorithm(self, parameters, context, feedback):
         tc, crs = self.create_tc(parameters, context)
@@ -107,7 +109,7 @@ def processTc(self, tc, parameters, context):
         names.append("geometry")
         gdf = gdf[names]
         # QgsMessageLog.logMessage(str(gdf), "Trajectools", level=Qgis.Info )
-                
+
         for _, row in gdf.iterrows():
             f = feature_from_gdf_row(row)
             self.sink_orig.addFeature(f, QgsFeatureSink.FastInsert)
@@ -172,7 +174,7 @@ def displayName(self):
         return self.tr("Extract stop points")
 
     def shortHelpString(self):
-        return self.tr("<p>Extracts stop points from trajectories.</p>"+help_str_base)
+        return self.tr("<p>Extracts stop points from trajectories.</p>" + help_str_base)
 
     def processAlgorithm(self, parameters, context, feedback):
         tc, crs = self.create_tc(parameters, context)
@@ -202,13 +204,15 @@ def processTc(self, tc, parameters, context):
         min_duration = self.parameterAsString(parameters, self.MIN_DURATION, context)
         min_duration = pd.Timedelta(min_duration).to_pytimedelta()
 
-        try: 
-            gdf = TrajectoryStopDetector(tc, n_processes=self.cpu_count).get_stop_points(
-                max_diameter=max_diameter, min_duration=min_duration
-            )
+        try:
+            gdf = TrajectoryStopDetector(
+                tc, n_processes=self.cpu_count
+            ).get_stop_points(max_diameter=max_diameter, min_duration=min_duration)
         except TypeError:
-            raise TypeError("TypeError: cannot pickle 'QVariant' object. This error is usually caused by None values in input layer fields. Try to remove None values or run without Add movement metrics.")
-          
+            raise TypeError(
+                "TypeError: cannot pickle 'QVariant' object. This error is usually caused by None values in input layer fields. Try to remove None values or run without Add movement metrics."
+            )
+
         gdf = gdf.convert_dtypes()
         gdf["stop_id"] = gdf.index.astype(str)
 

qgis_processing/generalizationAlgorithm.py

@@ -16,7 +16,11 @@
 
 sys.path.append("..")
 
-from .trajectoriesAlgorithm import TrajectoryManipulationAlgorithm, help_str_base, help_str_traj
+from .trajectoriesAlgorithm import (
+    TrajectoryManipulationAlgorithm,
+    help_str_base,
+    help_str_traj,
+)
 
 
 class GeneralizeTrajectoriesAlgorithm(TrajectoryManipulationAlgorithm):
@@ -59,7 +63,7 @@ def shortHelpString(self):
             "(as implemented in shapely/Geos). </p>"
             "<p>For more info see: "
             "https://movingpandas.readthedocs.io/en/main/api/trajectorygeneralizer.html</p>"
-            ""+help_str_base+help_str_traj
+            "" + help_str_base + help_str_traj
         )
 
     def processTc(self, tc, parameters, context):
@@ -99,7 +103,7 @@ def shortHelpString(self):
             "(e.g. EPSG:4326 WGS84) then distance is calculated in metres. </p>"
             "<p>For more info see: "
             "https://movingpandas.readthedocs.io/en/main/api/trajectorygeneralizer.html</p>"
-            ""+help_str_base+help_str_traj
+            "" + help_str_base + help_str_traj
         )
 
     def processTc(self, tc, parameters, context):
@@ -139,7 +143,7 @@ def shortHelpString(self):
             "timedelta apart. </p>"
             "<p>For more info see: "
             "https://movingpandas.readthedocs.io/en/main/api/trajectorygeneralizer.html</p>"
-            ""+help_str_base+help_str_traj
+            "" + help_str_base + help_str_traj
         )
 
     def processTc(self, tc, parameters, context):
@@ -184,7 +188,7 @@ def shortHelpString(self):
             "the segment start and end times and the point time. </p>"
             "<p>For more info see: "
             "https://movingpandas.readthedocs.io/en/main/api/trajectorygeneralizer.html</p>"
-            ""+help_str_base+help_str_traj
+            "" + help_str_base + help_str_traj
         )
 
     def processTc(self, tc, parameters, context):

qgis_processing/gtfsAlgorithm.py

@@ -39,7 +39,7 @@
 
 class GtfsStopsAlgorithm(QgsProcessingAlgorithm):
     INPUT = "INPUT"
-    OUTPUT = "OUTPUT"  
+    OUTPUT = "OUTPUT"
 
     def __init__(self):
         super().__init__()
@@ -104,12 +104,12 @@ def processAlgorithm(self, parameters, context, feedback):
             f = QgsFeature()
             f.setGeometry(pt)
             attrs = [stop.stop_id]
-            if hasattr(stop, 'stop_code'):
+            if hasattr(stop, "stop_code"):
                 attrs.append(stop.stop_code)
             else:
-                attrs.append('')
+                attrs.append("")
             attrs.append(stop.stop_name)
-            
+
             f.setAttributes(attrs)
             self.sink_stops.addFeature(f, QgsFeatureSink.FastInsert)
 
@@ -195,9 +195,7 @@ def processAlgorithm(self, parameters, context, feedback):
             line = QgsGeometry.fromWkt(shape.geometry.wkt)
             f = QgsFeature()
             f.setGeometry(line)
-            attrs = [
-                shape.shape_id
-            ]
+            attrs = [shape.shape_id]
             f.setAttributes(attrs)
             self.sink_shapes.addFeature(f, QgsFeatureSink.FastInsert)
 
@@ -343,5 +341,7 @@ def get_fields(self, add_avg_speed):
 
     def postProcessAlgorithm(self, context, feedback):
         seg_layer = QgsProcessingUtils.mapLayerFromString(self.dest_segments, context)
-        seg_layer.loadNamedStyle(os.path.join(pluginPath, "styles", "gtfs-segments.qml"))
+        seg_layer.loadNamedStyle(
+            os.path.join(pluginPath, "styles", "gtfs-segments.qml")
+        )
         return {self.OUTPUT: self.dest_segments}