From 7b2f75c3499e36924caca6a12698e64def8117c1 Mon Sep 17 00:00:00 2001 From: burnettk Date: Tue, 30 May 2023 12:21:50 -0400 Subject: [PATCH] remove useless comments matching filenames --- .../bin/python_comment_cleanup.sh | 41 +++++++++++++++++++ .../src/spiffworkflow_backend/__init__.py | 1 - .../spiffworkflow_backend/config/default.py | 1 - .../helpers/api_version.py | 1 - .../helpers/db_helper.py | 1 - .../src/spiffworkflow_backend/interfaces.py | 1 - .../spiffworkflow_backend/models/__init__.py | 1 - .../src/spiffworkflow_backend/models/db.py | 1 - .../src/spiffworkflow_backend/models/group.py | 1 - .../models/human_task.py | 1 - .../models/human_task_user.py | 1 - .../models/message_instance.py | 1 - .../spiffworkflow_backend/models/principal.py | 1 - .../models/process_group.py | 1 - .../models/process_instance.py | 1 - .../models/process_instance_file_data.py | 1 - .../models/process_instance_queue.py | 1 - .../models/process_model.py | 1 - .../models/refresh_token.py | 1 - .../models/secret_model.py | 1 - .../src/spiffworkflow_backend/models/task.py | 1 - .../src/spiffworkflow_backend/models/user.py | 1 - .../spiffworkflow_backend/routes/__init__.py | 1 - .../routes/openid_blueprint/__init__.py | 1 - .../src/spiffworkflow_backend/routes/user.py | 1 - .../routes/users_controller.py | 1 - .../delete_process_instances_with_criteria.py | 1 - .../scripts/fact_service.py | 1 - .../scripts/get_data_sizes.py | 1 - .../scripts/get_encoded_file_data.py | 1 - .../spiffworkflow_backend/scripts/get_env.py | 1 - .../scripts/get_localtime.py | 1 - .../scripts/get_secret.py | 1 - .../scripts/markdown_file_download_link.py | 1 - .../spiffworkflow_backend/scripts/script.py | 1 - .../services/acceptance_test_fixtures.py | 1 - .../services/assertion_service.py | 1 - .../services/background_processing_service.py | 1 - .../services/custom_parser.py | 1 - .../services/data_setup_service.py | 1 - .../services/email_service.py | 1 - .../services/file_system_service.py | 1 - .../services/git_service.py | 1 - .../services/logging_service.py | 1 - .../services/message_service.py | 1 - .../services/process_instance_processor.py | 1 - .../process_instance_report_service.py | 1 - .../services/process_instance_service.py | 1 - .../services/process_model_service.py | 1 - .../services/secret_service.py | 1 - .../services/spec_file_service.py | 1 - .../services/user_service.py | 1 - .../services/workflow_service.py | 1 - .../tests/spiffworkflow_backend/__init__.py | 1 - .../helpers/base_test.py | 1 - .../helpers/example_data.py | 1 - .../integration/__init__.py | 1 - .../integration/test_authentication.py | 1 - .../integration/test_authorization.py | 1 - .../integration/test_logging_service.py | 1 - .../integration/test_nested_groups.py | 1 - .../integration/test_secret_service.py | 1 - .../integration/test_user_blueprint.py | 1 - .../integration/test_users_controller.py | 1 - .../unit/test_acceptance_test_fixtures.py | 1 - .../spiffworkflow_backend/unit/test_file.py | 1 - .../unit/test_message_instance.py | 1 - .../unit/test_process_instance_processor.py | 1 - .../test_process_instance_queue_service.py | 1 - .../test_process_instance_report_service.py | 1 - .../unit/test_process_model_service.py | 1 - .../unit/test_various_bpmn_constructs.py | 1 - .../unit/test_workflow_service.py | 1 - 73 files changed, 41 insertions(+), 72 deletions(-) create mode 100755 spiffworkflow-backend/bin/python_comment_cleanup.sh diff --git a/spiffworkflow-backend/bin/python_comment_cleanup.sh b/spiffworkflow-backend/bin/python_comment_cleanup.sh new file mode 100755 index 00000000..94a0f694 --- /dev/null +++ b/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 diff --git a/spiffworkflow-backend/src/spiffworkflow_backend/__init__.py b/spiffworkflow-backend/src/spiffworkflow_backend/__init__.py index e0d7cacf..5ea32a4e 100644 --- a/spiffworkflow-backend/src/spiffworkflow_backend/__init__.py +++ b/spiffworkflow-backend/src/spiffworkflow_backend/__init__.py @@ -1,4 +1,3 @@ -"""__init__.""" import base64 import faulthandler import json diff --git a/spiffworkflow-backend/src/spiffworkflow_backend/config/default.py b/spiffworkflow-backend/src/spiffworkflow_backend/config/default.py index 59bb742d..cc44f62b 100644 --- a/spiffworkflow-backend/src/spiffworkflow_backend/config/default.py +++ b/spiffworkflow-backend/src/spiffworkflow_backend/config/default.py @@ -1,4 +1,3 @@ -"""Default.""" import re from os import environ diff --git a/spiffworkflow-backend/src/spiffworkflow_backend/helpers/api_version.py b/spiffworkflow-backend/src/spiffworkflow_backend/helpers/api_version.py index 607b6c16..5935aa87 100644 --- a/spiffworkflow-backend/src/spiffworkflow_backend/helpers/api_version.py +++ b/spiffworkflow-backend/src/spiffworkflow_backend/helpers/api_version.py @@ -1,2 +1 @@ -"""Api_version.""" V1_API_PATH_PREFIX = "/v1.0" diff --git a/spiffworkflow-backend/src/spiffworkflow_backend/helpers/db_helper.py b/spiffworkflow-backend/src/spiffworkflow_backend/helpers/db_helper.py index ac21ebab..db556cb0 100644 --- a/spiffworkflow-backend/src/spiffworkflow_backend/helpers/db_helper.py +++ b/spiffworkflow-backend/src/spiffworkflow_backend/helpers/db_helper.py @@ -1,4 +1,3 @@ -"""Db_helper.""" import time import sqlalchemy diff --git a/spiffworkflow-backend/src/spiffworkflow_backend/interfaces.py b/spiffworkflow-backend/src/spiffworkflow_backend/interfaces.py index 6f0d5c56..6bfc5e06 100644 --- a/spiffworkflow-backend/src/spiffworkflow_backend/interfaces.py +++ b/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 diff --git a/spiffworkflow-backend/src/spiffworkflow_backend/models/__init__.py b/spiffworkflow-backend/src/spiffworkflow_backend/models/__init__.py index f520b09d..e69de29b 100644 --- a/spiffworkflow-backend/src/spiffworkflow_backend/models/__init__.py +++ b/spiffworkflow-backend/src/spiffworkflow_backend/models/__init__.py @@ -1 +0,0 @@ -"""__init__.""" diff --git a/spiffworkflow-backend/src/spiffworkflow_backend/models/db.py b/spiffworkflow-backend/src/spiffworkflow_backend/models/db.py index a91ab83e..67a2df80 100644 --- a/spiffworkflow-backend/src/spiffworkflow_backend/models/db.py +++ b/spiffworkflow-backend/src/spiffworkflow_backend/models/db.py @@ -1,4 +1,3 @@ -"""Db.""" from __future__ import annotations import enum diff --git a/spiffworkflow-backend/src/spiffworkflow_backend/models/group.py b/spiffworkflow-backend/src/spiffworkflow_backend/models/group.py index 79f6934e..1fd41580 100644 --- a/spiffworkflow-backend/src/spiffworkflow_backend/models/group.py +++ b/spiffworkflow-backend/src/spiffworkflow_backend/models/group.py @@ -1,4 +1,3 @@ -"""Group.""" from __future__ import annotations from typing import TYPE_CHECKING diff --git a/spiffworkflow-backend/src/spiffworkflow_backend/models/human_task.py b/spiffworkflow-backend/src/spiffworkflow_backend/models/human_task.py index 71dc778f..a7e70b71 100644 --- a/spiffworkflow-backend/src/spiffworkflow_backend/models/human_task.py +++ b/spiffworkflow-backend/src/spiffworkflow_backend/models/human_task.py @@ -1,4 +1,3 @@ -"""Human_task.""" from __future__ import annotations from dataclasses import dataclass diff --git a/spiffworkflow-backend/src/spiffworkflow_backend/models/human_task_user.py b/spiffworkflow-backend/src/spiffworkflow_backend/models/human_task_user.py index 83ac34c6..58acffe3 100644 --- a/spiffworkflow-backend/src/spiffworkflow_backend/models/human_task_user.py +++ b/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 diff --git a/spiffworkflow-backend/src/spiffworkflow_backend/models/message_instance.py b/spiffworkflow-backend/src/spiffworkflow_backend/models/message_instance.py index 5eef8324..203c02e6 100644 --- a/spiffworkflow-backend/src/spiffworkflow_backend/models/message_instance.py +++ b/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 diff --git a/spiffworkflow-backend/src/spiffworkflow_backend/models/principal.py b/spiffworkflow-backend/src/spiffworkflow_backend/models/principal.py index 87801289..82dd1457 100644 --- a/spiffworkflow-backend/src/spiffworkflow_backend/models/principal.py +++ b/spiffworkflow-backend/src/spiffworkflow_backend/models/principal.py @@ -1,4 +1,3 @@ -"""Principal.""" from dataclasses import dataclass from sqlalchemy import ForeignKey diff --git a/spiffworkflow-backend/src/spiffworkflow_backend/models/process_group.py b/spiffworkflow-backend/src/spiffworkflow_backend/models/process_group.py index d3748e58..fa0aa3e7 100644 --- a/spiffworkflow-backend/src/spiffworkflow_backend/models/process_group.py +++ b/spiffworkflow-backend/src/spiffworkflow_backend/models/process_group.py @@ -1,4 +1,3 @@ -"""Process_group.""" from __future__ import annotations import dataclasses diff --git a/spiffworkflow-backend/src/spiffworkflow_backend/models/process_instance.py b/spiffworkflow-backend/src/spiffworkflow_backend/models/process_instance.py index 50dc2f1b..782db23c 100644 --- a/spiffworkflow-backend/src/spiffworkflow_backend/models/process_instance.py +++ b/spiffworkflow-backend/src/spiffworkflow_backend/models/process_instance.py @@ -1,4 +1,3 @@ -"""Process_instance.""" from __future__ import annotations from typing import Any diff --git a/spiffworkflow-backend/src/spiffworkflow_backend/models/process_instance_file_data.py b/spiffworkflow-backend/src/spiffworkflow_backend/models/process_instance_file_data.py index 90c072e8..e2d0fcb4 100644 --- a/spiffworkflow-backend/src/spiffworkflow_backend/models/process_instance_file_data.py +++ b/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 diff --git a/spiffworkflow-backend/src/spiffworkflow_backend/models/process_instance_queue.py b/spiffworkflow-backend/src/spiffworkflow_backend/models/process_instance_queue.py index d37ce9a6..11b41293 100644 --- a/spiffworkflow-backend/src/spiffworkflow_backend/models/process_instance_queue.py +++ b/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 diff --git a/spiffworkflow-backend/src/spiffworkflow_backend/models/process_model.py b/spiffworkflow-backend/src/spiffworkflow_backend/models/process_model.py index a5a6a924..f0ce47cd 100644 --- a/spiffworkflow-backend/src/spiffworkflow_backend/models/process_model.py +++ b/spiffworkflow-backend/src/spiffworkflow_backend/models/process_model.py @@ -1,4 +1,3 @@ -"""Process_model.""" from __future__ import annotations import enum diff --git a/spiffworkflow-backend/src/spiffworkflow_backend/models/refresh_token.py b/spiffworkflow-backend/src/spiffworkflow_backend/models/refresh_token.py index 326ecabd..b2ac40aa 100644 --- a/spiffworkflow-backend/src/spiffworkflow_backend/models/refresh_token.py +++ b/spiffworkflow-backend/src/spiffworkflow_backend/models/refresh_token.py @@ -1,4 +1,3 @@ -"""Refresh_token.""" from dataclasses import dataclass from sqlalchemy import ForeignKey diff --git a/spiffworkflow-backend/src/spiffworkflow_backend/models/secret_model.py b/spiffworkflow-backend/src/spiffworkflow_backend/models/secret_model.py index 9ecfe534..927c084b 100644 --- a/spiffworkflow-backend/src/spiffworkflow_backend/models/secret_model.py +++ b/spiffworkflow-backend/src/spiffworkflow_backend/models/secret_model.py @@ -1,4 +1,3 @@ -"""Secret_model.""" from dataclasses import dataclass from marshmallow import Schema diff --git a/spiffworkflow-backend/src/spiffworkflow_backend/models/task.py b/spiffworkflow-backend/src/spiffworkflow_backend/models/task.py index 23a3b729..618c677f 100644 --- a/spiffworkflow-backend/src/spiffworkflow_backend/models/task.py +++ b/spiffworkflow-backend/src/spiffworkflow_backend/models/task.py @@ -1,4 +1,3 @@ -"""Task.""" import enum from dataclasses import dataclass from typing import TYPE_CHECKING diff --git a/spiffworkflow-backend/src/spiffworkflow_backend/models/user.py b/spiffworkflow-backend/src/spiffworkflow_backend/models/user.py index 7474993e..a3ed4200 100644 --- a/spiffworkflow-backend/src/spiffworkflow_backend/models/user.py +++ b/spiffworkflow-backend/src/spiffworkflow_backend/models/user.py @@ -1,4 +1,3 @@ -"""User.""" from __future__ import annotations from dataclasses import dataclass diff --git a/spiffworkflow-backend/src/spiffworkflow_backend/routes/__init__.py b/spiffworkflow-backend/src/spiffworkflow_backend/routes/__init__.py index f520b09d..e69de29b 100644 --- a/spiffworkflow-backend/src/spiffworkflow_backend/routes/__init__.py +++ b/spiffworkflow-backend/src/spiffworkflow_backend/routes/__init__.py @@ -1 +0,0 @@ -"""__init__.""" diff --git a/spiffworkflow-backend/src/spiffworkflow_backend/routes/openid_blueprint/__init__.py b/spiffworkflow-backend/src/spiffworkflow_backend/routes/openid_blueprint/__init__.py index f520b09d..e69de29b 100644 --- a/spiffworkflow-backend/src/spiffworkflow_backend/routes/openid_blueprint/__init__.py +++ b/spiffworkflow-backend/src/spiffworkflow_backend/routes/openid_blueprint/__init__.py @@ -1 +0,0 @@ -"""__init__.""" diff --git a/spiffworkflow-backend/src/spiffworkflow_backend/routes/user.py b/spiffworkflow-backend/src/spiffworkflow_backend/routes/user.py index 521f92af..3e451882 100644 --- a/spiffworkflow-backend/src/spiffworkflow_backend/routes/user.py +++ b/spiffworkflow-backend/src/spiffworkflow_backend/routes/user.py @@ -1,4 +1,3 @@ -"""User.""" import ast import base64 import json diff --git a/spiffworkflow-backend/src/spiffworkflow_backend/routes/users_controller.py b/spiffworkflow-backend/src/spiffworkflow_backend/routes/users_controller.py index b772aa33..d0592931 100644 --- a/spiffworkflow-backend/src/spiffworkflow_backend/routes/users_controller.py +++ b/spiffworkflow-backend/src/spiffworkflow_backend/routes/users_controller.py @@ -1,4 +1,3 @@ -"""Users_controller.""" from typing import Any import flask diff --git a/spiffworkflow-backend/src/spiffworkflow_backend/scripts/delete_process_instances_with_criteria.py b/spiffworkflow-backend/src/spiffworkflow_backend/scripts/delete_process_instances_with_criteria.py index 823d67c3..83cb4697 100644 --- a/spiffworkflow-backend/src/spiffworkflow_backend/scripts/delete_process_instances_with_criteria.py +++ b/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 diff --git a/spiffworkflow-backend/src/spiffworkflow_backend/scripts/fact_service.py b/spiffworkflow-backend/src/spiffworkflow_backend/scripts/fact_service.py index 3bf8c1d5..02277983 100644 --- a/spiffworkflow-backend/src/spiffworkflow_backend/scripts/fact_service.py +++ b/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 diff --git a/spiffworkflow-backend/src/spiffworkflow_backend/scripts/get_data_sizes.py b/spiffworkflow-backend/src/spiffworkflow_backend/scripts/get_data_sizes.py index 7199613a..c21f7961 100644 --- a/spiffworkflow-backend/src/spiffworkflow_backend/scripts/get_data_sizes.py +++ b/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 diff --git a/spiffworkflow-backend/src/spiffworkflow_backend/scripts/get_encoded_file_data.py b/spiffworkflow-backend/src/spiffworkflow_backend/scripts/get_encoded_file_data.py index 21cc71b0..d5ee4db8 100644 --- a/spiffworkflow-backend/src/spiffworkflow_backend/scripts/get_encoded_file_data.py +++ b/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 diff --git a/spiffworkflow-backend/src/spiffworkflow_backend/scripts/get_env.py b/spiffworkflow-backend/src/spiffworkflow_backend/scripts/get_env.py index 7015239e..954a8388 100644 --- a/spiffworkflow-backend/src/spiffworkflow_backend/scripts/get_env.py +++ b/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 diff --git a/spiffworkflow-backend/src/spiffworkflow_backend/scripts/get_localtime.py b/spiffworkflow-backend/src/spiffworkflow_backend/scripts/get_localtime.py index 80edf59a..7a189187 100644 --- a/spiffworkflow-backend/src/spiffworkflow_backend/scripts/get_localtime.py +++ b/spiffworkflow-backend/src/spiffworkflow_backend/scripts/get_localtime.py @@ -1,4 +1,3 @@ -"""Get_localtime.""" from datetime import datetime from typing import Any diff --git a/spiffworkflow-backend/src/spiffworkflow_backend/scripts/get_secret.py b/spiffworkflow-backend/src/spiffworkflow_backend/scripts/get_secret.py index ed85d258..c5b87f0c 100644 --- a/spiffworkflow-backend/src/spiffworkflow_backend/scripts/get_secret.py +++ b/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 diff --git a/spiffworkflow-backend/src/spiffworkflow_backend/scripts/markdown_file_download_link.py b/spiffworkflow-backend/src/spiffworkflow_backend/scripts/markdown_file_download_link.py index e470ced5..18b27b13 100644 --- a/spiffworkflow-backend/src/spiffworkflow_backend/scripts/markdown_file_download_link.py +++ b/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 diff --git a/spiffworkflow-backend/src/spiffworkflow_backend/scripts/script.py b/spiffworkflow-backend/src/spiffworkflow_backend/scripts/script.py index 3f3a94bb..5992bff0 100644 --- a/spiffworkflow-backend/src/spiffworkflow_backend/scripts/script.py +++ b/spiffworkflow-backend/src/spiffworkflow_backend/scripts/script.py @@ -1,4 +1,3 @@ -"""Script.""" from __future__ import annotations import importlib diff --git a/spiffworkflow-backend/src/spiffworkflow_backend/services/acceptance_test_fixtures.py b/spiffworkflow-backend/src/spiffworkflow_backend/services/acceptance_test_fixtures.py index 7c9cfb79..c91177e9 100644 --- a/spiffworkflow-backend/src/spiffworkflow_backend/services/acceptance_test_fixtures.py +++ b/spiffworkflow-backend/src/spiffworkflow_backend/services/acceptance_test_fixtures.py @@ -1,4 +1,3 @@ -"""Acceptance_test_fixtures.""" import time from flask import current_app diff --git a/spiffworkflow-backend/src/spiffworkflow_backend/services/assertion_service.py b/spiffworkflow-backend/src/spiffworkflow_backend/services/assertion_service.py index 27a1564e..76d50de0 100644 --- a/spiffworkflow-backend/src/spiffworkflow_backend/services/assertion_service.py +++ b/spiffworkflow-backend/src/spiffworkflow_backend/services/assertion_service.py @@ -1,4 +1,3 @@ -"""Assertion_service.""" import contextlib from collections.abc import Generator diff --git a/spiffworkflow-backend/src/spiffworkflow_backend/services/background_processing_service.py b/spiffworkflow-backend/src/spiffworkflow_backend/services/background_processing_service.py index 58e8c2e4..d5922158 100644 --- a/spiffworkflow-backend/src/spiffworkflow_backend/services/background_processing_service.py +++ b/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 diff --git a/spiffworkflow-backend/src/spiffworkflow_backend/services/custom_parser.py b/spiffworkflow-backend/src/spiffworkflow_backend/services/custom_parser.py index b632b1cf..a65482f7 100644 --- a/spiffworkflow-backend/src/spiffworkflow_backend/services/custom_parser.py +++ b/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 diff --git a/spiffworkflow-backend/src/spiffworkflow_backend/services/data_setup_service.py b/spiffworkflow-backend/src/spiffworkflow_backend/services/data_setup_service.py index bcd5e238..09aee73d 100644 --- a/spiffworkflow-backend/src/spiffworkflow_backend/services/data_setup_service.py +++ b/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 diff --git a/spiffworkflow-backend/src/spiffworkflow_backend/services/email_service.py b/spiffworkflow-backend/src/spiffworkflow_backend/services/email_service.py index 89eb7efa..7108dc58 100644 --- a/spiffworkflow-backend/src/spiffworkflow_backend/services/email_service.py +++ b/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 diff --git a/spiffworkflow-backend/src/spiffworkflow_backend/services/file_system_service.py b/spiffworkflow-backend/src/spiffworkflow_backend/services/file_system_service.py index 8d2a9135..16f0875e 100644 --- a/spiffworkflow-backend/src/spiffworkflow_backend/services/file_system_service.py +++ b/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 diff --git a/spiffworkflow-backend/src/spiffworkflow_backend/services/git_service.py b/spiffworkflow-backend/src/spiffworkflow_backend/services/git_service.py index d2dba332..d173eefb 100644 --- a/spiffworkflow-backend/src/spiffworkflow_backend/services/git_service.py +++ b/spiffworkflow-backend/src/spiffworkflow_backend/services/git_service.py @@ -1,4 +1,3 @@ -"""Git_service.""" import os import re import shutil diff --git a/spiffworkflow-backend/src/spiffworkflow_backend/services/logging_service.py b/spiffworkflow-backend/src/spiffworkflow_backend/services/logging_service.py index 3c8845c3..182eb0a4 100644 --- a/spiffworkflow-backend/src/spiffworkflow_backend/services/logging_service.py +++ b/spiffworkflow-backend/src/spiffworkflow_backend/services/logging_service.py @@ -1,4 +1,3 @@ -"""Logging_service.""" import json import logging import re diff --git a/spiffworkflow-backend/src/spiffworkflow_backend/services/message_service.py b/spiffworkflow-backend/src/spiffworkflow_backend/services/message_service.py index 70948042..ce7240f5 100644 --- a/spiffworkflow-backend/src/spiffworkflow_backend/services/message_service.py +++ b/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 diff --git a/spiffworkflow-backend/src/spiffworkflow_backend/services/process_instance_processor.py b/spiffworkflow-backend/src/spiffworkflow_backend/services/process_instance_processor.py index 06156baa..cd0ddaad 100644 --- a/spiffworkflow-backend/src/spiffworkflow_backend/services/process_instance_processor.py +++ b/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 diff --git a/spiffworkflow-backend/src/spiffworkflow_backend/services/process_instance_report_service.py b/spiffworkflow-backend/src/spiffworkflow_backend/services/process_instance_report_service.py index a6d78caa..f64a4d32 100644 --- a/spiffworkflow-backend/src/spiffworkflow_backend/services/process_instance_report_service.py +++ b/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 diff --git a/spiffworkflow-backend/src/spiffworkflow_backend/services/process_instance_service.py b/spiffworkflow-backend/src/spiffworkflow_backend/services/process_instance_service.py index d9a81e16..4a8606ca 100644 --- a/spiffworkflow-backend/src/spiffworkflow_backend/services/process_instance_service.py +++ b/spiffworkflow-backend/src/spiffworkflow_backend/services/process_instance_service.py @@ -1,4 +1,3 @@ -"""Process_instance_service.""" import base64 import hashlib import time diff --git a/spiffworkflow-backend/src/spiffworkflow_backend/services/process_model_service.py b/spiffworkflow-backend/src/spiffworkflow_backend/services/process_model_service.py index 37a9433c..6cdcaa83 100644 --- a/spiffworkflow-backend/src/spiffworkflow_backend/services/process_model_service.py +++ b/spiffworkflow-backend/src/spiffworkflow_backend/services/process_model_service.py @@ -1,4 +1,3 @@ -"""Process_model_service.""" import json import os import shutil diff --git a/spiffworkflow-backend/src/spiffworkflow_backend/services/secret_service.py b/spiffworkflow-backend/src/spiffworkflow_backend/services/secret_service.py index bac2cb23..da0f5c36 100644 --- a/spiffworkflow-backend/src/spiffworkflow_backend/services/secret_service.py +++ b/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 diff --git a/spiffworkflow-backend/src/spiffworkflow_backend/services/spec_file_service.py b/spiffworkflow-backend/src/spiffworkflow_backend/services/spec_file_service.py index 6086161b..c311ce30 100644 --- a/spiffworkflow-backend/src/spiffworkflow_backend/services/spec_file_service.py +++ b/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 diff --git a/spiffworkflow-backend/src/spiffworkflow_backend/services/user_service.py b/spiffworkflow-backend/src/spiffworkflow_backend/services/user_service.py index 848e7ee1..ffc7519b 100644 --- a/spiffworkflow-backend/src/spiffworkflow_backend/services/user_service.py +++ b/spiffworkflow-backend/src/spiffworkflow_backend/services/user_service.py @@ -1,4 +1,3 @@ -"""User_service.""" from typing import Any from flask import current_app diff --git a/spiffworkflow-backend/src/spiffworkflow_backend/services/workflow_service.py b/spiffworkflow-backend/src/spiffworkflow_backend/services/workflow_service.py index 5b8a9714..5668226d 100644 --- a/spiffworkflow-backend/src/spiffworkflow_backend/services/workflow_service.py +++ b/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 diff --git a/spiffworkflow-backend/tests/spiffworkflow_backend/__init__.py b/spiffworkflow-backend/tests/spiffworkflow_backend/__init__.py index f520b09d..e69de29b 100644 --- a/spiffworkflow-backend/tests/spiffworkflow_backend/__init__.py +++ b/spiffworkflow-backend/tests/spiffworkflow_backend/__init__.py @@ -1 +0,0 @@ -"""__init__.""" diff --git a/spiffworkflow-backend/tests/spiffworkflow_backend/helpers/base_test.py b/spiffworkflow-backend/tests/spiffworkflow_backend/helpers/base_test.py index 2fb346fe..faec5c1b 100644 --- a/spiffworkflow-backend/tests/spiffworkflow_backend/helpers/base_test.py +++ b/spiffworkflow-backend/tests/spiffworkflow_backend/helpers/base_test.py @@ -1,4 +1,3 @@ -"""Base_test.""" import io import json import os diff --git a/spiffworkflow-backend/tests/spiffworkflow_backend/helpers/example_data.py b/spiffworkflow-backend/tests/spiffworkflow_backend/helpers/example_data.py index 4941a2d3..c0ce8af7 100644 --- a/spiffworkflow-backend/tests/spiffworkflow_backend/helpers/example_data.py +++ b/spiffworkflow-backend/tests/spiffworkflow_backend/helpers/example_data.py @@ -1,4 +1,3 @@ -"""Example_data.""" import glob import os diff --git a/spiffworkflow-backend/tests/spiffworkflow_backend/integration/__init__.py b/spiffworkflow-backend/tests/spiffworkflow_backend/integration/__init__.py index f520b09d..e69de29b 100644 --- a/spiffworkflow-backend/tests/spiffworkflow_backend/integration/__init__.py +++ b/spiffworkflow-backend/tests/spiffworkflow_backend/integration/__init__.py @@ -1 +0,0 @@ -"""__init__.""" diff --git a/spiffworkflow-backend/tests/spiffworkflow_backend/integration/test_authentication.py b/spiffworkflow-backend/tests/spiffworkflow_backend/integration/test_authentication.py index 7fddd735..fde21c7b 100644 --- a/spiffworkflow-backend/tests/spiffworkflow_backend/integration/test_authentication.py +++ b/spiffworkflow-backend/tests/spiffworkflow_backend/integration/test_authentication.py @@ -1,4 +1,3 @@ -"""Test_authentication.""" import ast import base64 diff --git a/spiffworkflow-backend/tests/spiffworkflow_backend/integration/test_authorization.py b/spiffworkflow-backend/tests/spiffworkflow_backend/integration/test_authorization.py index 51eae72e..7f211a67 100644 --- a/spiffworkflow-backend/tests/spiffworkflow_backend/integration/test_authorization.py +++ b/spiffworkflow-backend/tests/spiffworkflow_backend/integration/test_authorization.py @@ -1,4 +1,3 @@ -"""Test_authorization.""" from tests.spiffworkflow_backend.helpers.base_test import BaseTest diff --git a/spiffworkflow-backend/tests/spiffworkflow_backend/integration/test_logging_service.py b/spiffworkflow-backend/tests/spiffworkflow_backend/integration/test_logging_service.py index 44c1fbf1..04874d51 100644 --- a/spiffworkflow-backend/tests/spiffworkflow_backend/integration/test_logging_service.py +++ b/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 diff --git a/spiffworkflow-backend/tests/spiffworkflow_backend/integration/test_nested_groups.py b/spiffworkflow-backend/tests/spiffworkflow_backend/integration/test_nested_groups.py index 001d4b12..177db5d7 100644 --- a/spiffworkflow-backend/tests/spiffworkflow_backend/integration/test_nested_groups.py +++ b/spiffworkflow-backend/tests/spiffworkflow_backend/integration/test_nested_groups.py @@ -1,4 +1,3 @@ -"""Test_nested_groups.""" import json from flask.app import Flask diff --git a/spiffworkflow-backend/tests/spiffworkflow_backend/integration/test_secret_service.py b/spiffworkflow-backend/tests/spiffworkflow_backend/integration/test_secret_service.py index 14b2f046..47e3afe2 100644 --- a/spiffworkflow-backend/tests/spiffworkflow_backend/integration/test_secret_service.py +++ b/spiffworkflow-backend/tests/spiffworkflow_backend/integration/test_secret_service.py @@ -1,4 +1,3 @@ -"""Test_secret_service.""" import json import pytest diff --git a/spiffworkflow-backend/tests/spiffworkflow_backend/integration/test_user_blueprint.py b/spiffworkflow-backend/tests/spiffworkflow_backend/integration/test_user_blueprint.py index ce142f1c..2aad2f40 100644 --- a/spiffworkflow-backend/tests/spiffworkflow_backend/integration/test_user_blueprint.py +++ b/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 diff --git a/spiffworkflow-backend/tests/spiffworkflow_backend/integration/test_users_controller.py b/spiffworkflow-backend/tests/spiffworkflow_backend/integration/test_users_controller.py index 588e43e1..a3186c20 100644 --- a/spiffworkflow-backend/tests/spiffworkflow_backend/integration/test_users_controller.py +++ b/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 diff --git a/spiffworkflow-backend/tests/spiffworkflow_backend/unit/test_acceptance_test_fixtures.py b/spiffworkflow-backend/tests/spiffworkflow_backend/unit/test_acceptance_test_fixtures.py index 94bf70d1..04dd29f9 100644 --- a/spiffworkflow-backend/tests/spiffworkflow_backend/unit/test_acceptance_test_fixtures.py +++ b/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 diff --git a/spiffworkflow-backend/tests/spiffworkflow_backend/unit/test_file.py b/spiffworkflow-backend/tests/spiffworkflow_backend/unit/test_file.py index c8b350f4..f4696631 100644 --- a/spiffworkflow-backend/tests/spiffworkflow_backend/unit/test_file.py +++ b/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 diff --git a/spiffworkflow-backend/tests/spiffworkflow_backend/unit/test_message_instance.py b/spiffworkflow-backend/tests/spiffworkflow_backend/unit/test_message_instance.py index 3d512b91..c4967588 100644 --- a/spiffworkflow-backend/tests/spiffworkflow_backend/unit/test_message_instance.py +++ b/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 diff --git a/spiffworkflow-backend/tests/spiffworkflow_backend/unit/test_process_instance_processor.py b/spiffworkflow-backend/tests/spiffworkflow_backend/unit/test_process_instance_processor.py index d3d14d5f..0487c755 100644 --- a/spiffworkflow-backend/tests/spiffworkflow_backend/unit/test_process_instance_processor.py +++ b/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 diff --git a/spiffworkflow-backend/tests/spiffworkflow_backend/unit/test_process_instance_queue_service.py b/spiffworkflow-backend/tests/spiffworkflow_backend/unit/test_process_instance_queue_service.py index ec5e8dca..61a434e7 100644 --- a/spiffworkflow-backend/tests/spiffworkflow_backend/unit/test_process_instance_queue_service.py +++ b/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 diff --git a/spiffworkflow-backend/tests/spiffworkflow_backend/unit/test_process_instance_report_service.py b/spiffworkflow-backend/tests/spiffworkflow_backend/unit/test_process_instance_report_service.py index b1aca344..737b1614 100644 --- a/spiffworkflow-backend/tests/spiffworkflow_backend/unit/test_process_instance_report_service.py +++ b/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 diff --git a/spiffworkflow-backend/tests/spiffworkflow_backend/unit/test_process_model_service.py b/spiffworkflow-backend/tests/spiffworkflow_backend/unit/test_process_model_service.py index f7f29b88..62613438 100644 --- a/spiffworkflow-backend/tests/spiffworkflow_backend/unit/test_process_model_service.py +++ b/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 diff --git a/spiffworkflow-backend/tests/spiffworkflow_backend/unit/test_various_bpmn_constructs.py b/spiffworkflow-backend/tests/spiffworkflow_backend/unit/test_various_bpmn_constructs.py index 077c8904..0011a7cd 100644 --- a/spiffworkflow-backend/tests/spiffworkflow_backend/unit/test_various_bpmn_constructs.py +++ b/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 diff --git a/spiffworkflow-backend/tests/spiffworkflow_backend/unit/test_workflow_service.py b/spiffworkflow-backend/tests/spiffworkflow_backend/unit/test_workflow_service.py index 10bcd95d..3428c60c 100644 --- a/spiffworkflow-backend/tests/spiffworkflow_backend/unit/test_workflow_service.py +++ b/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