Adjust workflows to new python (#221)

* Use Python 3.9 as minimum requirement as 3.8 is EOL

* adjust CIs to new Python versions

* split flake8 and flake8_nb

* Apparently annotating local "counter" variables ahead of a for loop is not favored anymore

* Ignore too-many-positional-arguments - leave it to the programmers

* Ignore E231 for Jupyter Notebooks - currently a false positive, re-enable when f-strings are no issue anymore

Author: 1kastner

.flake8_nb

@@ -13,5 +13,6 @@ ignore =
     E501  # Allow long lines
     W503  # Long lines need to be broken somewhere and otherwise W504 is violated
     E402  # Module level imports are decided on by developers
+    E231  # Ignore missing white space after ':' because it also affects f-string expressions which in fact haven't changed, see https://docs.python.org/3/tutorial/inputoutput.html#formatted-string-literals
 
 show_source = True

.github/workflows/citation.yml

@@ -21,10 +21,10 @@ jobs:
 
     - uses: actions/checkout@v3
 
-    - name: Set up Python 3.8
+    - name: Set up Python 3.9
       uses: actions/setup-python@v4
       with:
-        python-version: 3.8
+        python-version: 3.9
 
     - name: Install cffconvert
       run: |

.github/workflows/demo.yaml

@@ -17,7 +17,7 @@ jobs:
     strategy:
       fail-fast: false
       matrix:
-        python-version: [3.8, 3.9, "3.10"]
+        python-version: [3.9, "3.10", "3.13"]
         inplace: ["-e", ""]  # "pip install -e ." installs in place; "pip install ." installs to the default directory
 
     steps:

.github/workflows/docs.yaml

@@ -17,7 +17,7 @@ jobs:
     strategy:
       fail-fast: false
       matrix:
-        python-version: [3.8, "3.10"]  # Check the oldest and newest currently supported Python versions
+        python-version: [3.9, "3.10", "3.13"]  # Check the oldest and newest currently supported Python versions
 
     steps:
 
@@ -28,12 +28,11 @@ jobs:
       run: |
         sudo apt-get update && sudo apt-get upgrade && sudo apt-get install pandoc
 
-    - uses: actions/checkout@v3
+    - uses: actions/checkout@v4
+      with:
+        lfs: false
+        fetch-depth: 0
 
-    jobs:
-      post_checkout:
-        - git fetch --unshallow || true
-        
     - run: |
         curl -LJO "https://media.tuhh.de/mls/software/conflowgen/docs/data/prepared_dbs/demo_poc.sqlite"
         curl -LJO "https://media.tuhh.de/mls/software/conflowgen/docs/data/prepared_dbs/demo_deham_cta.sqlite"

.github/workflows/linting.yml

@@ -17,7 +17,7 @@ jobs:
     strategy:
       fail-fast: false
       matrix:
-        python-version: [3.8, 3.9, "3.10"]
+        python-version: [3.9, "3.10", "3.12"]
 
     steps:
 
@@ -43,9 +43,16 @@ jobs:
         pylint setup.py
         pylint conflowgen.tests
 
-    - name: Check code quality with flake8 and flake8_nb
+    - name: Check code quality with flake8
       run: |
         flake8 --version
         flake8
+
+    - name: Install flake8_nb - this downgrades flake8 as of 07.02.2025!
+      run: |
+        pip3 install --user flake8_nb
+
+    - name: Check code quality with flake8_nb
+      run: |
         flake8_nb --version
         flake8_nb

.pylintrc

@@ -54,6 +54,7 @@ disable=
     W0612, # pylint cannot detect that some variables are type-hinted before a for-loop
     R0903, # too-few-public-methods -- this hits e.g. the peewee BaseModels
     R0913, # too-many-arguments -- leave it up to the programmers to decide this
+    R0917, # too-many-positional-arguments -- leave it up to the programmers to decide this
     W0107, # unnecessary-pass -- leave it up to the programmers to decide this
     R1710, # inconsistent-return-statements -- leave it up to the programmers to decide this
     W0511, # fixme - allow todos in the code -- this should be eventually changed but it is not top priority

LICENSE

@@ -1,6 +1,6 @@
 MIT License
 
-Copyright (c) 2022 Marvin Kastner
+Copyright (c) 2025 Marvin Kastner
 
 Permission is hereby granted, free of charge, to any person obtaining a copy
 of this software and associated documentation files (the "Software"), to deal

conflowgen/domain_models/distribution_repositories/container_destination_distribution_repository.py

@@ -52,8 +52,6 @@ def _get_fraction(
     @classmethod
     def get_distribution(cls) -> Dict[Schedule, Dict[Destination, float]]:
         """Loads a distribution for all schedules that have destinations associated with them"""
-        destination: Destination
-        schedule: Schedule
         distributions = {
             schedule: {
                 destination: cls._get_fraction(

conflowgen/domain_models/distribution_repositories/container_length_distribution_repository.py

@@ -38,7 +38,6 @@ def _verify_container_lengths(container_lengths: Dict[ContainerLength, float]):
 
     @classmethod
     def get_distribution(cls) -> Dict[ContainerLength, float]:
-        container_length_distribution_entry: ContainerLengthDistribution
         return {
             container_length_distribution_entry.container_length:  # pylint: disable=undefined-variable
             container_length_distribution_entry.fraction  # pylint: disable=undefined-variable

conflowgen/domain_models/distribution_repositories/truck_arrival_distribution_repository.py

@@ -31,7 +31,6 @@ def _verify_truck_arrival_distribution(truck_arrivals: Dict[int, float]):
 
     @classmethod
     def get_distribution(cls) -> Dict[int, float]:
-        truck_arrival_entry: TruckArrivalDistribution
         return {
             truck_arrival_entry.hour_in_the_week:  # pylint: disable=undefined-variable
             truck_arrival_entry.fraction  # pylint: disable=undefined-variable

conflowgen/tools/continuous_distribution.py

@@ -207,7 +207,7 @@ def __repr__(self) -> str:
 
 def multiply_discretized_probability_densities(*probabilities: typing.Collection[float]) -> typing.Sequence[float]:
     assert len({len(p) for p in probabilities}) == 1, "All probability vectors have the same length, but found these:" \
-                                                      f"'{ [len(p) for p in probabilities] } "
+                                                      f"'{[len(p) for p in probabilities]}"
     for i, probability_vector in enumerate(probabilities):
         assert not np.isnan(probability_vector).any(), \
             f"All probability vector should contain only numbers, but found a NaN in vector {i}: {probability_vector}"

requirements.txt

@@ -1,5 +1,3 @@
-# requirements.txt
-
 # This file installs the package defined in setup.py and its dependencies.
 # The single dot (.) below refers to the current directory, indicating
 # that pip should install the package specified in setup.py.

setup.py

@@ -61,15 +61,14 @@
             'sphinx-toolbox >=3',  # additional dependency of enum_tools - restrict version to improve pip resolution
             'myst-parser',  # for Contributing.md
             'sphinxcontrib-bibtex >=2.4',  # a good help for citing - restrict version to improve pip resolution
-            'sphinx-last-updated-by-git',
+            'sphinx-last-updated-by-git',  # add a timestamp into the documentation indicating the last changes
             'nbsphinx',  # use Jupyter Notebooks in the documentation
             'ipython',  # for setting up the pygments_lexer
             'ipykernel',  # for allowing nbsphinx to execute the Jupyter Notebooks
 
             # checking code quality
             'pylint',  # lint Python code
             'flake8',  # lint Python code
-            'flake8_nb',  # lint code in Jupyter Notebooks
 
             # publish at PyPI
             'wheel',  # use command 'bdist_wheel'