spiffworkflow-backend/.flake8

[flake8]
select = B,B9,C,D,DAR,E,F,N,RST,S,W
ignore = E203,E501,RST201,RST203,RST301,W503,S410,S320
max-line-length = 120
max-complexity = 30
docstring-convention = google
rst-roles = class,const,func,meth,mod,ref
rst-directives = deprecated

per-file-ignores =
    # More specific globs seem to overwrite the more generic ones so we have
    # to split them out by directory
    # So if you have a rule like:
    # tests/*: D102,D103
    # and a rule like:
    # tests/test_hey.py: D102
    # THEN, test_hey.py will NOT be excluding D103

    # asserts are ok in tests
    tests/*:S101,D102,D103

    # prefer naming functions descriptively rather than forcing comments
    src/*:D102,D103

    bin/keycloak_test_server.py:B950,D
    conftest.py:S105
    wsgi.py:S104

    # allow writing to /tmp for throwaway script output
    bin/get_bpmn_json_for_process_instance:S108

    # the exclude=./migrations option doesn't seem to work with pre-commit
    # migrations are autogenerated from "flask db migration" so ignore them
    migrations/*:D
    src/spiffworkflow_backend/config/unit_testing.py:S105
    src/spiffworkflow_backend/load_database_models.py:F401

    # this file overwrites methods from the logging library so we can't change them
    # and ignore long comment line
    src/spiffworkflow_backend/services/logging_service.py:N802,B950

    tests/spiffworkflow_backend/integration/test_process_api.py:S607,S101,S605,D102,D103,D101
initial commit w/ burnettk 2022-05-13 17:42:42 +00:00			`[flake8]`
			`select = B,B9,C,D,DAR,E,F,N,RST,S,W`
pre-commit is passing w/ burnettk 2022-05-31 18:36:47 +00:00			`ignore = E203,E501,RST201,RST203,RST301,W503,S410,S320`
initial commit w/ burnettk 2022-05-13 17:42:42 +00:00			`max-line-length = 120`
			`max-complexity = 30`
			`docstring-convention = google`
			`rst-roles = class,const,func,meth,mod,ref`
			`rst-directives = deprecated`

			`per-file-ignores =`
added locking system for process instances so hopefully background jobs will not take instances currently being run by the user w/ burnettk 2023-01-23 21:45:07 +00:00			`# More specific globs seem to overwrite the more generic ones so we have`
			`# to split them out by directory`
do not allow deleting primary bpmn file and do not allow instantiating models without a primary bpmn file w/ burnettk 2023-01-24 20:15:48 +00:00			`# So if you have a rule like:`
			`# tests/*: D102,D103`
			`# and a rule like:`
			`# tests/test_hey.py: D102`
			`# THEN, test_hey.py will NOT be excluding D103`
added locking system for process instances so hopefully background jobs will not take instances currently being run by the user w/ burnettk 2023-01-23 21:45:07 +00:00
disabled flake8 forcing comments to avoid all of the useless comments but still enforcing the formatting of comments if they exist w/ burnettk 2023-01-19 15:41:26 +00:00			`# asserts are ok in tests`
added locking system for process instances so hopefully background jobs will not take instances currently being run by the user w/ burnettk 2023-01-23 21:45:07 +00:00			`tests/*:S101,D102,D103`
disabled flake8 forcing comments to avoid all of the useless comments but still enforcing the formatting of comments if they exist w/ burnettk 2023-01-19 15:41:26 +00:00
			`# prefer naming functions descriptively rather than forcing comments`
added locking system for process instances so hopefully background jobs will not take instances currently being run by the user w/ burnettk 2023-01-23 21:45:07 +00:00			`src/*:D102,D103`
set process name for api 2022-08-30 22:40:40 +00:00
added process models and cleaned up some of the code w/ burnettk 2022-05-23 20:36:23 +00:00			`bin/keycloak_test_server.py:B950,D`
add process-group endpoint 2022-06-08 16:14:39 +00:00			`conftest.py:S105`
			`wsgi.py:S104`
do not start mysql if using sqlite and fix flake8 with pre-commit to ignore the migrations dir w/ burnettk 2022-05-20 19:04:50 +00:00
set process name for api 2022-08-30 22:40:40 +00:00			`# allow writing to /tmp for throwaway script output`
			`bin/get_bpmn_json_for_process_instance:S108`

do not start mysql if using sqlite and fix flake8 with pre-commit to ignore the migrations dir w/ burnettk 2022-05-20 19:04:50 +00:00			`# the exclude=./migrations option doesn't seem to work with pre-commit`
			`# migrations are autogenerated from "flask db migration" so ignore them`
			`migrations/*:D`
renamed development env to local_development and testing to unit_testing w/ burnettk 2023-02-07 20:02:47 +00:00			`src/spiffworkflow_backend/config/unit_testing.py:S105`
added file to load to all models and add event listeners for create and upate w/ burnettk 2022-06-21 16:10:47 +00:00			`src/spiffworkflow_backend/load_database_models.py:F401`
attempt to log better with gunicorn w/ burnettk 2022-07-07 18:44:19 +00:00
			`# this file overwrites methods from the logging library so we can't change them`
add generate_report and tests 2022-07-10 05:24:12 +00:00			`# and ignore long comment line`
			`src/spiffworkflow_backend/services/logging_service.py:N802,B950`
mypy w/ burnettk cullerton 2022-12-08 22:12:19 +00:00
do not allow deleting primary bpmn file and do not allow instantiating models without a primary bpmn file w/ burnettk 2023-01-24 20:15:48 +00:00			`tests/spiffworkflow_backend/integration/test_process_api.py:S607,S101,S605,D102,D103,D101`