remove useless comments matching filenames

spiffworkflow-backend/bin/python_comment_cleanup.sh

@@ -0,0 +1,41 @@
+#!/usr/bin/env bash
+
+function error_handler() {
+  >&2 echo "Exited with BAD EXIT CODE '${2}' in ${0} script at line: ${1}."
+  exit "$2"
+}
+trap 'error_handler ${LINENO} $?' ERR
+set -o errtrace -o errexit -o nounset -o pipefail
+
+# Function to check if a string matches the file name pattern
+matches_filename_pattern() {
+  local file_name="$1"
+  local comment_line="$2"
+
+  # Remove file extension and capitalize the first letter
+  local expected_comment=$(basename "$file_name" .py)
+
+  expected_comment_with_first_letter_capitalized="${expected_comment^}"
+
+  if grep -Eq "\"\"\"${expected_comment}\.\"\"\"" <<< "$comment_line"; then
+    return 0
+  else
+    if grep -Eq "\"\"\"${expected_comment_with_first_letter_capitalized}\.\"\"\"" <<< "$comment_line"; then
+      return 0
+    else
+      return 1
+    fi
+  fi
+}
+
+# Process each Python file in the "src" and "tests" directories
+for file in $(find src tests -type f -name '*.py'); do
+  # Read the first line of the file
+  read -r first_line < "$file"
+
+  # Check if the first line matches the expected comment pattern
+  if matches_filename_pattern "$file" "$first_line"; then
+    # Remove the comment from the file
+    hot_sed -i '1d' "$file"
+  fi
+done

spiffworkflow-backend/src/spiffworkflow_backend/__init__.py

@@ -1,4 +1,3 @@
-"""__init__."""
 import base64
 import faulthandler
 import json

spiffworkflow-backend/src/spiffworkflow_backend/config/default.py

@@ -1,4 +1,3 @@
-"""Default."""
 import re
 from os import environ
 

spiffworkflow-backend/src/spiffworkflow_backend/helpers/api_version.py

@@ -1,2 +1 @@
-"""Api_version."""
 V1_API_PATH_PREFIX = "/v1.0"

spiffworkflow-backend/src/spiffworkflow_backend/helpers/db_helper.py

@@ -1,4 +1,3 @@
-"""Db_helper."""
 import time
 
 import sqlalchemy

spiffworkflow-backend/src/spiffworkflow_backend/interfaces.py

@@ -1,4 +1,3 @@
-"""Interfaces."""
 from typing import TYPE_CHECKING
 from typing import NewType
 from typing import TypedDict

spiffworkflow-backend/src/spiffworkflow_backend/models/__init__.py

@@ -1 +0,0 @@
-"""__init__."""

spiffworkflow-backend/src/spiffworkflow_backend/models/db.py

@@ -1,4 +1,3 @@
-"""Db."""
 from __future__ import annotations
 
 import enum

spiffworkflow-backend/src/spiffworkflow_backend/models/group.py

@@ -1,4 +1,3 @@
-"""Group."""
 from __future__ import annotations
 
 from typing import TYPE_CHECKING

spiffworkflow-backend/src/spiffworkflow_backend/models/human_task.py

@@ -1,4 +1,3 @@
-"""Human_task."""
 from __future__ import annotations
 
 from dataclasses import dataclass

spiffworkflow-backend/src/spiffworkflow_backend/models/human_task_user.py

@@ -1,4 +1,3 @@
-"""Human_task_user."""
 from __future__ import annotations
 
 from dataclasses import dataclass

spiffworkflow-backend/src/spiffworkflow_backend/models/message_instance.py

@@ -1,4 +1,3 @@
-"""Message_instance."""
 import enum
 from dataclasses import dataclass
 from typing import TYPE_CHECKING

spiffworkflow-backend/src/spiffworkflow_backend/models/principal.py

@@ -1,4 +1,3 @@
-"""Principal."""
 from dataclasses import dataclass
 
 from sqlalchemy import ForeignKey

spiffworkflow-backend/src/spiffworkflow_backend/models/process_group.py

@@ -1,4 +1,3 @@
-"""Process_group."""
 from __future__ import annotations
 
 import dataclasses

spiffworkflow-backend/src/spiffworkflow_backend/models/process_instance.py

@@ -1,4 +1,3 @@
-"""Process_instance."""
 from __future__ import annotations
 
 from typing import Any

spiffworkflow-backend/src/spiffworkflow_backend/models/process_instance_file_data.py

@@ -1,4 +1,3 @@
-"""Process_instance_file_data."""
 from dataclasses import dataclass
 
 from sqlalchemy import ForeignKey

spiffworkflow-backend/src/spiffworkflow_backend/models/process_instance_queue.py

@@ -1,4 +1,3 @@
-"""Process_instance_queue."""
 from dataclasses import dataclass
 
 from sqlalchemy import ForeignKey

spiffworkflow-backend/src/spiffworkflow_backend/models/process_model.py

@@ -1,4 +1,3 @@
-"""Process_model."""
 from __future__ import annotations
 
 import enum

spiffworkflow-backend/src/spiffworkflow_backend/models/refresh_token.py

@@ -1,4 +1,3 @@
-"""Refresh_token."""
 from dataclasses import dataclass
 
 from sqlalchemy import ForeignKey

spiffworkflow-backend/src/spiffworkflow_backend/models/secret_model.py

@@ -1,4 +1,3 @@
-"""Secret_model."""
 from dataclasses import dataclass
 
 from marshmallow import Schema

spiffworkflow-backend/src/spiffworkflow_backend/models/task.py

@@ -1,4 +1,3 @@
-"""Task."""
 import enum
 from dataclasses import dataclass
 from typing import TYPE_CHECKING

spiffworkflow-backend/src/spiffworkflow_backend/models/user.py

@@ -1,4 +1,3 @@
-"""User."""
 from __future__ import annotations
 
 from dataclasses import dataclass

spiffworkflow-backend/src/spiffworkflow_backend/routes/__init__.py

@@ -1 +0,0 @@
-"""__init__."""

spiffworkflow-backend/src/spiffworkflow_backend/routes/openid_blueprint/__init__.py

@@ -1 +0,0 @@
-"""__init__."""

spiffworkflow-backend/src/spiffworkflow_backend/routes/user.py

@@ -1,4 +1,3 @@
-"""User."""
 import ast
 import base64
 import json

spiffworkflow-backend/src/spiffworkflow_backend/routes/users_controller.py

@@ -1,4 +1,3 @@
-"""Users_controller."""
 from typing import Any
 
 import flask

spiffworkflow-backend/src/spiffworkflow_backend/scripts/delete_process_instances_with_criteria.py

@@ -1,4 +1,3 @@
-"""Delete_process_instances_with_criteria."""
 from time import time
 from typing import Any
 

spiffworkflow-backend/src/spiffworkflow_backend/scripts/fact_service.py

@@ -1,4 +1,3 @@
-"""Fact_service."""
 from typing import Any
 
 from spiffworkflow_backend.models.script_attributes_context import ScriptAttributesContext

spiffworkflow-backend/src/spiffworkflow_backend/scripts/get_data_sizes.py

@@ -1,4 +1,3 @@
-"""Get_data_sizes."""
 from typing import Any
 
 from spiffworkflow_backend.models.script_attributes_context import ScriptAttributesContext

spiffworkflow-backend/src/spiffworkflow_backend/scripts/get_encoded_file_data.py

@@ -1,4 +1,3 @@
-"""Get_encoded_file_data."""
 import base64
 from typing import Any
 

spiffworkflow-backend/src/spiffworkflow_backend/scripts/get_env.py

@@ -1,4 +1,3 @@
-"""Get_env."""
 from typing import Any
 
 from spiffworkflow_backend.models.script_attributes_context import ScriptAttributesContext

spiffworkflow-backend/src/spiffworkflow_backend/scripts/get_localtime.py

@@ -1,4 +1,3 @@
-"""Get_localtime."""
 from datetime import datetime
 from typing import Any
 

spiffworkflow-backend/src/spiffworkflow_backend/scripts/get_secret.py

@@ -1,4 +1,3 @@
-"""Get_secret."""
 from typing import Any
 
 from spiffworkflow_backend.models.script_attributes_context import ScriptAttributesContext

spiffworkflow-backend/src/spiffworkflow_backend/scripts/markdown_file_download_link.py

@@ -1,4 +1,3 @@
-"""Markdown_file_download_link."""
 from typing import Any
 
 from flask import current_app

spiffworkflow-backend/src/spiffworkflow_backend/scripts/script.py

@@ -1,4 +1,3 @@
-"""Script."""
 from __future__ import annotations
 
 import importlib

spiffworkflow-backend/src/spiffworkflow_backend/services/acceptance_test_fixtures.py

@@ -1,4 +1,3 @@
-"""Acceptance_test_fixtures."""
 import time
 
 from flask import current_app

spiffworkflow-backend/src/spiffworkflow_backend/services/assertion_service.py

@@ -1,4 +1,3 @@
-"""Assertion_service."""
 import contextlib
 from collections.abc import Generator
 

spiffworkflow-backend/src/spiffworkflow_backend/services/background_processing_service.py

@@ -1,4 +1,3 @@
-"""Background_processing_service."""
 import flask
 from spiffworkflow_backend.models.process_instance import ProcessInstanceStatus
 from spiffworkflow_backend.services.message_service import MessageService

spiffworkflow-backend/src/spiffworkflow_backend/services/custom_parser.py

@@ -1,4 +1,3 @@
-"""Custom_parser."""
 from SpiffWorkflow.dmn.parser.BpmnDmnParser import BpmnDmnParser  # type: ignore
 from SpiffWorkflow.spiff.parser.process import SpiffBpmnParser  # type: ignore
 from spiffworkflow_backend.specs.start_event import StartEvent

spiffworkflow-backend/src/spiffworkflow_backend/services/data_setup_service.py

@@ -1,4 +1,3 @@
-"""Data_setup_service."""
 from flask import current_app
 from spiffworkflow_backend.models.db import db
 from spiffworkflow_backend.services.process_model_service import ProcessModelService

spiffworkflow-backend/src/spiffworkflow_backend/services/email_service.py

@@ -1,4 +1,3 @@
-"""Email_service."""
 
 from flask import current_app
 from flask_mail import Message  # type: ignore

spiffworkflow-backend/src/spiffworkflow_backend/services/file_system_service.py

@@ -1,4 +1,3 @@
-"""File_system_service."""
 import os
 from collections.abc import Generator
 from contextlib import contextmanager

spiffworkflow-backend/src/spiffworkflow_backend/services/git_service.py

@@ -1,4 +1,3 @@
-"""Git_service."""
 import os
 import re
 import shutil

spiffworkflow-backend/src/spiffworkflow_backend/services/logging_service.py

@@ -1,4 +1,3 @@
-"""Logging_service."""
 import json
 import logging
 import re

spiffworkflow-backend/src/spiffworkflow_backend/services/message_service.py

@@ -1,4 +1,3 @@
-"""Message_service."""
 
 from spiffworkflow_backend.models.db import db
 from spiffworkflow_backend.models.message_instance import MessageInstanceModel

spiffworkflow-backend/src/spiffworkflow_backend/services/process_instance_processor.py

@@ -1,4 +1,3 @@
-"""Process_instance_processor."""
 # TODO: clean up this service for a clear distinction between it and the process_instance_service
 #   where this points to the pi service
 import decimal

spiffworkflow-backend/src/spiffworkflow_backend/services/process_instance_report_service.py

@@ -1,4 +1,3 @@
-"""Process_instance_report_service."""
 import copy
 import re
 from collections.abc import Generator

spiffworkflow-backend/src/spiffworkflow_backend/services/process_instance_service.py

@@ -1,4 +1,3 @@
-"""Process_instance_service."""
 import base64
 import hashlib
 import time

spiffworkflow-backend/src/spiffworkflow_backend/services/process_model_service.py

@@ -1,4 +1,3 @@
-"""Process_model_service."""
 import json
 import os
 import shutil

spiffworkflow-backend/src/spiffworkflow_backend/services/secret_service.py

@@ -1,4 +1,3 @@
-"""Secret_service."""
 
 from flask import current_app
 from spiffworkflow_backend.exceptions.api_error import ApiError

spiffworkflow-backend/src/spiffworkflow_backend/services/spec_file_service.py

@@ -1,4 +1,3 @@
-"""Spec_file_service."""
 import os
 import shutil
 from datetime import datetime

spiffworkflow-backend/src/spiffworkflow_backend/services/user_service.py

@@ -1,4 +1,3 @@
-"""User_service."""
 from typing import Any
 
 from flask import current_app

spiffworkflow-backend/src/spiffworkflow_backend/services/workflow_service.py

@@ -1,4 +1,3 @@
-"""workflow_service."""
 from datetime import datetime
 
 from SpiffWorkflow.bpmn.workflow import BpmnWorkflow  # type: ignore

spiffworkflow-backend/tests/spiffworkflow_backend/__init__.py

@@ -1 +0,0 @@
-"""__init__."""

spiffworkflow-backend/tests/spiffworkflow_backend/helpers/base_test.py

@@ -1,4 +1,3 @@
-"""Base_test."""
 import io
 import json
 import os

spiffworkflow-backend/tests/spiffworkflow_backend/helpers/example_data.py

@@ -1,4 +1,3 @@
-"""Example_data."""
 import glob
 import os
 

spiffworkflow-backend/tests/spiffworkflow_backend/integration/__init__.py

@@ -1 +0,0 @@
-"""__init__."""

spiffworkflow-backend/tests/spiffworkflow_backend/integration/test_authentication.py

@@ -1,4 +1,3 @@
-"""Test_authentication."""
 import ast
 import base64
 

spiffworkflow-backend/tests/spiffworkflow_backend/integration/test_authorization.py

@@ -1,4 +1,3 @@
-"""Test_authorization."""
 from tests.spiffworkflow_backend.helpers.base_test import BaseTest
 
 

spiffworkflow-backend/tests/spiffworkflow_backend/integration/test_logging_service.py

@@ -1,4 +1,3 @@
-"""Test_logging_service."""
 from uuid import UUID
 
 from flask.app import Flask

spiffworkflow-backend/tests/spiffworkflow_backend/integration/test_nested_groups.py

@@ -1,4 +1,3 @@
-"""Test_nested_groups."""
 import json
 
 from flask.app import Flask

spiffworkflow-backend/tests/spiffworkflow_backend/integration/test_secret_service.py

@@ -1,4 +1,3 @@
-"""Test_secret_service."""
 import json
 
 import pytest

spiffworkflow-backend/tests/spiffworkflow_backend/integration/test_user_blueprint.py

@@ -1,4 +1,3 @@
-"""Test_user_blueprint."""
 # TODO: fix these tests for new authing system
 # """Test User Blueprint."""
 # import json

spiffworkflow-backend/tests/spiffworkflow_backend/integration/test_users_controller.py

@@ -1,4 +1,3 @@
-"""Test_users_controller."""
 from flask.app import Flask
 from flask.testing import FlaskClient
 from spiffworkflow_backend.models.user import UserModel

spiffworkflow-backend/tests/spiffworkflow_backend/unit/test_acceptance_test_fixtures.py

@@ -1,4 +1,3 @@
-"""Test_acceptance_test_fixtures."""
 import os
 
 from flask.app import Flask

spiffworkflow-backend/tests/spiffworkflow_backend/unit/test_file.py

@@ -1,4 +1,3 @@
-"""Test_file."""
 from datetime import datetime
 
 from spiffworkflow_backend.models.file import File

spiffworkflow-backend/tests/spiffworkflow_backend/unit/test_message_instance.py

@@ -1,4 +1,3 @@
-"""Test_message_instance."""
 import pytest
 from flask import Flask
 from flask.testing import FlaskClient

spiffworkflow-backend/tests/spiffworkflow_backend/unit/test_process_instance_processor.py

@@ -1,4 +1,3 @@
-"""Test_process_instance_processor."""
 from uuid import UUID
 
 import pytest

spiffworkflow-backend/tests/spiffworkflow_backend/unit/test_process_instance_queue_service.py

@@ -1,4 +1,3 @@
-"""Test_process_instance_queue_service."""
 import time
 from contextlib import suppress
 

spiffworkflow-backend/tests/spiffworkflow_backend/unit/test_process_instance_report_service.py

@@ -1,4 +1,3 @@
-"""Test_process_instance_report_service."""
 import pytest
 from flask import Flask
 from flask.testing import FlaskClient

spiffworkflow-backend/tests/spiffworkflow_backend/unit/test_process_model_service.py

@@ -1,4 +1,3 @@
-"""Test_process_model_service."""
 from flask import Flask
 from spiffworkflow_backend.services.process_model_service import ProcessModelService
 

spiffworkflow-backend/tests/spiffworkflow_backend/unit/test_various_bpmn_constructs.py

@@ -1,4 +1,3 @@
-"""Test_various_bpmn_constructs."""
 from flask.app import Flask
 from flask.testing import FlaskClient
 from spiffworkflow_backend.services.process_instance_processor import ProcessInstanceProcessor

spiffworkflow-backend/tests/spiffworkflow_backend/unit/test_workflow_service.py

@@ -1,4 +1,3 @@
-"""Test_workflow_service."""
 from collections.abc import Generator
 from datetime import datetime
 from datetime import timedelta