ruff modernization, documentation fixes

ParkenDD · Oct 29, 2024 · b6c3214 · b6c3214
1 parent 2b8a42d
commit b6c3214
Show file tree

Hide file tree

Showing 41 changed files with 354 additions and 122 deletions.
diff --git a/.github/workflows/lint.yml b/.github/workflows/lint.yml
@@ -33,10 +33,10 @@ jobs:
       # We could also use the official GitHub Actions integration.
       # https://beta.ruff.rs/docs/usage/#github-action
       # uses: chartboost/ruff-action@v1
-      run: ruff check --output-format github ./webapp ./tests
+      run: ruff check --output-format github ./webapp ./tests ./migrations
 
     - name: format using ruff formatter
       # We could also use the official GitHub Actions integration.
       # https://beta.ruff.rs/docs/usage/#github-action
       # uses: chartboost/ruff-action@v1
-      run: ruff check ./webapp ./tests
+      run: ruff check ./webapp ./tests ./migrations
diff --git a/.pre-commit-config.yaml b/.pre-commit-config.yaml
@@ -0,0 +1,15 @@
+repos:
+  - repo: https://github.com/pre-commit/pre-commit-hooks
+    rev: v5.0.0
+    hooks:
+      - id: trailing-whitespace
+      - id: end-of-file-fixer
+      - id: check-yaml
+
+  - repo: https://github.com/astral-sh/ruff-pre-commit
+    # Ruff version.
+    rev: v0.7.1
+    hooks:
+      - id: ruff-format
+      - id: ruff
+        args: [ --fix, --exit-non-zero-on-fix ]
diff --git a/Makefile b/Makefile
@@ -179,9 +179,9 @@ open-coverage:
 .PHONY: lint-fix
 lint-fix:
 	$(FLASK_RUN) ruff format ./webapp
-	$(FLASK_RUN) ruff check --fix ./webapp
+	$(FLASK_RUN) ruff check --fix ./webapp ./tests ./migrations
 
 .PHONY: lint-check
 lint-check:
 	$(FLASK_RUN) ruff format --check --diff webapp
-	$(FLASK_RUN) ruff check ./webapp
+	$(FLASK_RUN) ruff check ./webapp ./tests ./migrations
diff --git a/migrations/versions/2023-10-25-12-33-52_687daced5384_init.py b/migrations/versions/2023-10-25-12-33-52_687daced5384_init.py
@@ -34,7 +34,11 @@ def upgrade():
         sa.Column('attribution_license', sa.Text(), nullable=True),
         sa.Column('attribution_contributor', sa.String(length=256), nullable=True),
         sa.Column('attribution_url', sa.String(length=256), nullable=True),
-        sa.Column('status', sa.Enum('DISABLED', 'ACTIVE', 'FAILED', 'PROVISIONED', name='sourcestatus'), nullable=False),
+        sa.Column(
+            'status',
+            sa.Enum('DISABLED', 'ACTIVE', 'FAILED', 'PROVISIONED', name='sourcestatus'),
+            nullable=False,
+        ),
         sa.Column('static_parking_site_error_count', sa.Integer(), nullable=False),
         sa.Column('realtime_parking_site_error_count', sa.Integer(), nullable=False),
         sa.PrimaryKeyConstraint('id', name=op.f('pk_source')),
@@ -59,7 +63,14 @@ def upgrade():
         sa.Column('description', sa.String(length=4096), nullable=True),
         sa.Column(
             'type',
-            sa.Enum('ON_STREET', 'OFF_STREET_PARKING_GROUND', 'UNDERGROUND', 'CAR_PARK', 'OTHER', name='parkingsitetype'),
+            sa.Enum(
+                'ON_STREET',
+                'OFF_STREET_PARKING_GROUND',
+                'UNDERGROUND',
+                'CAR_PARK',
+                'OTHER',
+                name='parkingsitetype',
+            ),
             nullable=True,
         ),
         sa.Column('max_stay', sa.Integer(), nullable=True),
@@ -71,7 +82,11 @@ def upgrade():
         sa.Column('has_realtime_data', sa.Boolean(), nullable=False),
         sa.Column('static_data_updated_at', sqlalchemy_utc.sqltypes.UtcDateTime(timezone=True), nullable=True),
         sa.Column('realtime_data_updated_at', sqlalchemy_utc.sqltypes.UtcDateTime(timezone=True), nullable=True),
-        sa.Column('realtime_opening_status', sa.Enum('OPEN', 'CLOSED', 'UNKNOWN', name='openingstatus'), nullable=False),
+        sa.Column(
+            'realtime_opening_status',
+            sa.Enum('OPEN', 'CLOSED', 'UNKNOWN', name='openingstatus'),
+            nullable=False,
+        ),
         sa.Column('lat', sa.Numeric(precision=10, scale=7), nullable=False),
         sa.Column('lon', sa.Numeric(precision=10, scale=7), nullable=False),
         sa.Column('capacity', sa.Integer(), nullable=True),

diff --git a/migrations/versions/2024-03-18-11-59-44_2dd84bdad484_longer_fee_description.py b/migrations/versions/2024-03-18-11-59-44_2dd84bdad484_longer_fee_description.py
@@ -19,14 +19,24 @@
 def upgrade():
     # ### commands auto generated by Alembic - please adjust! ###
     with op.batch_alter_table('parking_site', schema=None) as batch_op:
-        batch_op.alter_column('fee_description', existing_type=sa.VARCHAR(length=256), type_=sa.String(length=4096), existing_nullable=True)
+        batch_op.alter_column(
+            'fee_description',
+            existing_type=sa.VARCHAR(length=256),
+            type_=sa.String(length=4096),
+            existing_nullable=True,
+        )
 
     # ### end Alembic commands ###
 
 
 def downgrade():
     # ### commands auto generated by Alembic - please adjust! ###
     with op.batch_alter_table('parking_site', schema=None) as batch_op:
-        batch_op.alter_column('fee_description', existing_type=sa.String(length=4096), type_=sa.VARCHAR(length=256), existing_nullable=True)
+        batch_op.alter_column(
+            'fee_description',
+            existing_type=sa.String(length=4096),
+            type_=sa.VARCHAR(length=256),
+            existing_nullable=True,
+        )
 
     # ### end Alembic commands ###
diff --git a/migrations/versions/2024-03-22-18-26-42_6be2c2aa3637_more_fields_biking_support.py b/migrations/versions/2024-03-22-18-26-42_6be2c2aa3637_more_fields_biking_support.py
@@ -44,7 +44,11 @@ def upgrade():
         sa.Column('id', sa.BigInteger(), nullable=False),
         sa.Column('created_at', sqlalchemy_utc.sqltypes.UtcDateTime(timezone=True), nullable=False),
         sa.Column('modified_at', sqlalchemy_utc.sqltypes.UtcDateTime(timezone=True), nullable=False),
-        sa.ForeignKeyConstraint(['parking_site_id'], ['parking_site.id'], name=op.f('fk_external_identifier_parking_site_id')),
+        sa.ForeignKeyConstraint(
+            ['parking_site_id'],
+            ['parking_site.id'],
+            name=op.f('fk_external_identifier_parking_site_id'),
+        ),
         sa.PrimaryKeyConstraint('id', name=op.f('pk_external_identifier')),
         mysql_charset='utf8mb4',
         mysql_collate='utf8mb4_unicode_ci',
@@ -65,9 +69,22 @@ def upgrade():
         sa.Enum(*old_parking_site_types, name='_parkingsitetype').drop(op.get_bind())
 
     with op.batch_alter_table('parking_site', schema=None) as batch_op:
-        batch_op.add_column(sa.Column('purpose', sa.Enum('CAR', 'BIKE', 'ITEM', name='purposetype'), server_default='CAR', nullable=False))
+        batch_op.add_column(
+            sa.Column(
+                'purpose',
+                sa.Enum('CAR', 'BIKE', 'ITEM', name='purposetype'),
+                server_default='CAR',
+                nullable=False,
+            ),
+        )
         batch_op.add_column(sa.Column('is_covered', sa.Boolean(), nullable=True))
-        batch_op.add_column(sa.Column('supervision_type', sa.Enum('YES', 'NO', 'VIDEO', 'ATTENDED', name='supervisiontype'), nullable=True))
+        batch_op.add_column(
+            sa.Column(
+                'supervision_type',
+                sa.Enum('YES', 'NO', 'VIDEO', 'ATTENDED', name='supervisiontype'),
+                nullable=True,
+            ),
+        )
         batch_op.add_column(sa.Column('related_location', sa.String(length=256), nullable=True))
         batch_op.drop_column('is_supervised')
         batch_op.alter_column(

diff --git a/...ations/versions/2024-05-14-06-46-51_9ad8cd0f3b0d_photo_url_duplicate_id_new_types_tags.py b/...ations/versions/2024-05-14-06-46-51_9ad8cd0f3b0d_photo_url_duplicate_id_new_types_tags.py
@@ -88,7 +88,10 @@ def upgrade():
         batch_op.add_column(sa.Column('duplicate_of_parking_site_id', sa.BigInteger(), nullable=True))
         batch_op.add_column(sa.Column('photo_url', sa.String(length=4096), nullable=True))
         batch_op.create_foreign_key(
-            batch_op.f('fk_parking_site_duplicate_of_parking_site_id'), 'parking_site', ['duplicate_of_parking_site_id'], ['id']
+            batch_op.f('fk_parking_site_duplicate_of_parking_site_id'),
+            'parking_site',
+            ['duplicate_of_parking_site_id'],
+            ['id'],
         )
 
     # ### end Alembic commands ###

diff --git a/migrations/versions/2024-07-28-11-38-03_0c34a8561ddb_parking_site_history.py b/migrations/versions/2024-07-28-11-38-03_0c34a8561ddb_parking_site_history.py
@@ -24,7 +24,11 @@ def upgrade():
         sa.Column('parking_site_id', sa.BigInteger(), nullable=False),
         sa.Column('static_data_updated_at', sqlalchemy_utc.sqltypes.UtcDateTime(timezone=True), nullable=True),
         sa.Column('realtime_data_updated_at', sqlalchemy_utc.sqltypes.UtcDateTime(timezone=True), nullable=True),
-        sa.Column('realtime_opening_status', sa.Enum('OPEN', 'CLOSED', 'UNKNOWN', name='history_openingstatus'), nullable=False),
+        sa.Column(
+            'realtime_opening_status',
+            sa.Enum('OPEN', 'CLOSED', 'UNKNOWN', name='history_openingstatus'),
+            nullable=False,
+        ),
         sa.Column('capacity', sa.Integer(), nullable=True),
         sa.Column('capacity_disabled', sa.Integer(), nullable=True),
         sa.Column('capacity_woman', sa.Integer(), nullable=True),
@@ -52,7 +56,11 @@ def upgrade():
         sa.Column('id', sa.BigInteger(), nullable=False),
         sa.Column('created_at', sqlalchemy_utc.sqltypes.UtcDateTime(timezone=True), nullable=False),
         sa.Column('modified_at', sqlalchemy_utc.sqltypes.UtcDateTime(timezone=True), nullable=False),
-        sa.ForeignKeyConstraint(['parking_site_id'], ['parking_site.id'], name=op.f('fk_parking_site_history_parking_site_id')),
+        sa.ForeignKeyConstraint(
+            ['parking_site_id'],
+            ['parking_site.id'],
+            name=op.f('fk_parking_site_history_parking_site_id'),
+        ),
         sa.PrimaryKeyConstraint('id', name=op.f('pk_parking_site_history')),
         mysql_charset='utf8mb4',
         mysql_collate='utf8mb4_unicode_ci',

diff --git a/migrations/versions/2024-08-23-10-50-44_3e92c13d297e_max_width.py b/migrations/versions/2024-08-23-10-50-44_3e92c13d297e_max_width.py
@@ -5,9 +5,9 @@
 Create Date: 2024-08-23 10:50:44.402057
 
 """
-from alembic import op
+
 import sqlalchemy as sa
-from sqlalchemy.dialects import postgresql
+from alembic import op
 
 # revision identifiers, used by Alembic.
 revision = '3e92c13d297e'

diff --git a/migrations/versions/2024-09-22-16-53-00_95992608c5d1_remove_generic_bike.py b/migrations/versions/2024-09-22-16-53-00_95992608c5d1_remove_generic_bike.py
@@ -5,9 +5,9 @@
 Create Date: 2024-09-22 16:53:00.630618
 
 """
-from alembic import op
+
 import sqlalchemy as sa
-from sqlalchemy.dialects import postgresql
+from alembic import op
 
 # revision identifiers, used by Alembic.
 revision = '95992608c5d1'
@@ -50,6 +50,7 @@
     'OTHER',
 ]
 
+
 def upgrade():
     # Set all generic bike to other
     op.execute("UPDATE parking_site SET type = 'OTHER' WHERE type = 'GENERIC_BIKE'")
@@ -87,4 +88,3 @@ def downgrade():
             type_=sa.Enum(*old_parking_site_types, name='parkingsitetype'),
             existing_nullable=True,
         )
-
diff --git a/pyproject.toml b/pyproject.toml
@@ -1,20 +1,26 @@
 [tool.ruff]
 lint.select = [
-    "E", # pycodestyle errors
-    "W", # pycodestyle warnings
     "F", # pyflakes
-    "Q", # pydocstyle
-    "T", # mypy
-    "R", # pylint
-    "S", # flake8
     "I", # isort
-    "C", # flake8-comprehensions
-    "B", # flake8-bugbear
+    "S", # flake8-bandit
+    "ASYNC", # flake8-async
+    "ISC", # flake8-implicit-str-concat
+    "LOG", # flake8-logging
+    "INP", # flake8-no-pep420 (missing __init__.py)
+    "PIE", # flake8-pie
+    "T20", # flake8-print
+    "Q", # flake8-quotes
+    "TID", # flake8-tidy-imports
+    "FLY", # flynt (use f-string instead of static join)
 ]
 
+# Enable preview rules since a lot of basic pycodestyle rules are in preview mode for some reason
+preview = true
+
 lint.ignore = [
     "B008", # do not perform function calls in argument defaults
     "C901", # too complex
+    "ISC001", # single-line-implicit-string-concatenation - conflicts with formatter
 ]
 
 
@@ -41,11 +47,23 @@ exclude = [
     "venv",
 ]
 
-line-length = 140
+line-length = 120
 
 [tool.ruff.lint.per-file-ignores]
 "__init__.py" = ["F401"]
-"tests/*" = ["S101", "S105", "S106"]
+"tests/*" = [
+    # Allow assert
+    "S101",
+    # Ignore unsafe practices like hardcoded passwords
+    "S101", "S105", "S106",
+    # Don't require __init__.py files
+    "INP",
+]
+"migrations/*" = [
+    # Don't require __init__.py files
+    "INP",
+]
+
 
 [tool.ruff.lint.flake8-quotes]
 inline-quotes = "single"

diff --git a/requirements-dev.txt b/requirements-dev.txt
@@ -1,2 +1,2 @@
 pytest~=8.3.3
-ruff~=0.6.5
+ruff~=0.7.1
diff --git a/requirements.txt b/requirements.txt
@@ -2,25 +2,25 @@ Flask~=3.0.3
 Flask-Failsafe~=0.2
 Flask-Migrate~=4.0.7
 Flask-SQLAlchemy~=3.1.1
-SQLAlchemy~=2.0.35
+SQLAlchemy~=2.0.36
 SQLAlchemy-Utc~=0.14.0
 pytz~=2024.2
-psycopg2-binary~=2.9.9
+psycopg2-binary~=2.9.10
 pymysql~=1.1.1
 requests~=2.32.3
 alembic~=1.13.3
 gunicorn~=23.0.0
 pyyaml~=6.0.2
 celery~=5.4.0
-werkzeug~=3.0.4
+werkzeug~=3.0.6
 validataclass~=0.11.0
 python-dotenv~=1.0.1
 click~=8.1.7
 openpyxl~=3.1.5
 opening-hours-py~=0.6.18
-kombu~=5.4.1
+kombu~=5.4.2
 lxml~=5.3.0
-parkapi-sources~=0.14.0
+parkapi-sources~=0.14.1
 
 # required for converters
 beautifulsoup4~=4.12.3

diff --git a/webapp/admin_rest_api/generic_parking_sites/generic_parking_sites_handler.py b/webapp/admin_rest_api/generic_parking_sites/generic_parking_sites_handler.py
@@ -47,7 +47,9 @@ def handle_json_data(
         data: dict | list,
     ) -> tuple[list[StaticParkingSiteInput | RealtimeParkingSiteInput], list[ImportParkingSiteException]]:
         source = self.parking_site_generic_import_service.get_upserted_source(source_uid)
-        import_service: JsonConverter = self.parking_site_generic_import_service.park_api_sources.converter_by_uid[source_uid]  # type: ignore
+        import_service: JsonConverter = self.parking_site_generic_import_service.park_api_sources.converter_by_uid[
+            source_uid
+        ]  # type: ignore
 
         parking_site_inputs, parking_site_errors = import_service.handle_json(data)
 
@@ -59,7 +61,9 @@ def handle_xml_data(
         self, source_uid: str, data: bytes
     ) -> tuple[list[StaticParkingSiteInput | RealtimeParkingSiteInput], list[ImportParkingSiteException]]:
         source = self.parking_site_generic_import_service.get_upserted_source(source_uid)
-        import_service: XmlConverter = self.parking_site_generic_import_service.park_api_sources.converter_by_uid[source_uid]  # type: ignore
+        import_service: XmlConverter = self.parking_site_generic_import_service.park_api_sources.converter_by_uid[
+            source_uid
+        ]  # type: ignore
 
         try:
             root_element = etree.fromstring(data, parser=etree.XMLParser(resolve_entities=False))  # noqa: S320
@@ -76,7 +80,9 @@ def handle_csv_data(
         self, source_uid: str, data: str
     ) -> tuple[list[StaticParkingSiteInput | RealtimeParkingSiteInput], list[ImportParkingSiteException]]:
         source = self.parking_site_generic_import_service.get_upserted_source(source_uid)
-        import_service: CsvConverter = self.parking_site_generic_import_service.park_api_sources.converter_by_uid[source_uid]  # type: ignore
+        import_service: CsvConverter = self.parking_site_generic_import_service.park_api_sources.converter_by_uid[
+            source_uid
+        ]  # type: ignore
 
         try:
             parking_site_inputs, parking_site_errors = import_service.handle_csv_string(StringIO(data))
@@ -93,7 +99,9 @@ def handle_xlsx_data(
         data: bytes,
     ) -> tuple[list[StaticParkingSiteInput | RealtimeParkingSiteInput], list[ImportParkingSiteException]]:
         source = self.parking_site_generic_import_service.get_upserted_source(source_uid)
-        import_service: XlsxConverter = self.parking_site_generic_import_service.park_api_sources.converter_by_uid[source_uid]  # type: ignore
+        import_service: XlsxConverter = self.parking_site_generic_import_service.park_api_sources.converter_by_uid[
+            source_uid
+        ]  # type: ignore
 
         try:
             workbook = load_workbook(filename=BytesIO(data))
@@ -121,9 +129,15 @@ def _handle_import_results(
         static_parking_site_inputs = [item for item in parking_site_inputs if isinstance(item, StaticParkingSiteInput)]
 
         if len(static_parking_site_inputs):
-            self.parking_site_generic_import_service.handle_static_import_results(source, static_parking_site_inputs, parking_site_errors)
+            self.parking_site_generic_import_service.handle_static_import_results(
+                source,
+                static_parking_site_inputs,
+                parking_site_errors,
+            )
 
-        realtime_parking_site_inputs = [item for item in parking_site_inputs if isinstance(item, RealtimeParkingSiteInput)]
+        realtime_parking_site_inputs = [
+            item for item in parking_site_inputs if isinstance(item, RealtimeParkingSiteInput)
+        ]
 
         if len(realtime_parking_site_inputs):
             self.parking_site_generic_import_service.handle_realtime_import_results(

diff --git a/webapp/admin_rest_api/generic_parking_sites/generic_parking_sites_rest_api.py b/webapp/admin_rest_api/generic_parking_sites/generic_parking_sites_rest_api.py
@@ -77,7 +77,9 @@ def _generate_response(
         parking_site_errors: list[ImportParkingSiteException],
     ) -> dict:
         static_parking_site_inputs = [item for item in parking_site_inputs if isinstance(item, StaticParkingSiteInput)]
-        realtime_parking_site_inputs = [item for item in parking_site_inputs if isinstance(item, RealtimeParkingSiteInput)]
+        realtime_parking_site_inputs = [
+            item for item in parking_site_inputs if isinstance(item, RealtimeParkingSiteInput)
+        ]
 
         return {
             'summary': {