Skip to content

Switch Flask library from flask_restful to flask_restx in app.py #50

Switch Flask library from flask_restful to flask_restx in app.py

Switch Flask library from flask_restful to flask_restx in app.py #50

GitHub Actions / flake8 completed May 25, 2024 in 1s

reviewdog [flake8] report

reported by reviewdog 🐶

Findings (3)

resources/Login.py|1 col 1| Missing docstring in public module
resources/QuickSearch.py|1 col 1| Missing docstring in public module
resources/ResetPassword.py|1 col 1| Missing docstring in public module

Filtered Findings (296)

app.py|1 col 1| Missing docstring in public module
app.py|24 col 1| Missing docstring in public function
app.py|28 col 1| Missing docstring in public function
conftest.py|1 col 1| Missing docstring in public module
conftest.py|17 col 1| Missing docstring in public function
conftest.py|32 col 1| Missing docstring in public function
gunicorn_config.py|1 col 1| Missing docstring in public module
middleware/init.py|1 col 1| Missing docstring in public package
middleware/archives_queries.py|1 col 1| Missing docstring in public module
middleware/archives_queries.py|1 col 1| 'typing.Tuple' imported but unused
middleware/archives_queries.py|15 col 1| First line should end with a period
middleware/archives_queries.py|15 col 1| First line should be in imperative mood
middleware/archives_queries.py|43 col 1| First line should be in imperative mood
middleware/archives_queries.py|66 col 1| First line should be in imperative mood
middleware/archives_queries.py|83 col 1| First line should be in imperative mood
middleware/custom_exceptions.py|1 col 1| Missing docstring in public module
middleware/custom_exceptions.py|4 col 1| Missing docstring in init
middleware/data_source_queries.py|1 col 1| Missing docstring in public module
middleware/data_source_queries.py|1 col 1| 'typing.Tuple' imported but unused
middleware/data_source_queries.py|94 col 1| First line should be in imperative mood
middleware/data_source_queries.py|143 col 1| First line should be in imperative mood
middleware/data_source_queries.py|174 col 1| First line should be in imperative mood
middleware/data_source_queries.py|211 col 1| One-line docstring should fit on one line with quotes
middleware/data_source_queries.py|211 col 1| First line should end with a period
middleware/data_source_queries.py|211 col 1| First line should be in imperative mood
middleware/data_source_queries.py|235 col 1| One-line docstring should fit on one line with quotes
middleware/data_source_queries.py|235 col 1| First line should end with a period
middleware/data_source_queries.py|235 col 1| First line should be in imperative mood
middleware/data_source_queries.py|270 col 1| 1 blank line required between summary line and description
middleware/data_source_queries.py|270 col 1| First line should end with a period
middleware/initialize_psycopg2_connection.py|1 col 1| Missing docstring in public module
middleware/initialize_psycopg2_connection.py|4 col 1| 'typing.Union' imported but unused
middleware/initialize_psycopg2_connection.py|4 col 1| 'typing.Dict' imported but unused
middleware/initialize_psycopg2_connection.py|4 col 1| 'typing.List' imported but unused
middleware/initialize_psycopg2_connection.py|8 col 1| One-line docstring should fit on one line with quotes
middleware/initialize_psycopg2_connection.py|12 col 1| Missing docstring in init
middleware/initialize_psycopg2_connection.py|18 col 1| 1 blank line required between summary line and description
middleware/initialize_psycopg2_connection.py|18 col 1| First line should end with a period
middleware/initialize_psycopg2_connection.py|18 col 1| First line should be in imperative mood
middleware/login_queries.py|1 col 1| Missing docstring in public module
middleware/login_queries.py|11 col 1| First line should be in imperative mood
middleware/login_queries.py|32 col 1| First line should be in imperative mood
middleware/login_queries.py|51 col 1| First line should be in imperative mood
middleware/login_queries.py|74 col 1| First line should be in imperative mood
middleware/models.py|1 col 1| Missing docstring in public module
middleware/models.py|17 col 1| Missing docstring in public class
middleware/quick_search_query.py|1 col 1| Missing docstring in public module
middleware/quick_search_query.py|61 col 1| First line should be in imperative mood
middleware/quick_search_query.py|79 col 1| First line should be in imperative mood
middleware/quick_search_query.py|112 col 1| First line should be in imperative mood
middleware/quick_search_query.py|123 col 8| do not compare types, for exact checks use is / is not, for instance checks use isinstance()
middleware/reset_token_queries.py|1 col 1| Missing docstring in public module
middleware/reset_token_queries.py|8 col 1| First line should be in imperative mood
middleware/reset_token_queries.py|29 col 1| First line should be in imperative mood
middleware/reset_token_queries.py|44 col 1| First line should be in imperative mood
middleware/security.py|1 col 1| Missing docstring in public module
middleware/security.py|2 col 1| 'flask.jsonify' imported but unused
middleware/security.py|13 col 1| First line should be in imperative mood
middleware/security.py|70 col 1| 1 blank line required between summary line and description
middleware/security.py|70 col 1| First line should end with a period
middleware/security.py|70 col 1| First line should be in imperative mood; try rephrasing
middleware/user_queries.py|1 col 1| Missing docstring in public module
middleware/user_queries.py|9 col 1| First line should be in imperative mood
middleware/user_queries.py|24 col 1| First line should be in imperative mood
regular_api_checks.py|1 col 1| Missing docstring in public module
regular_api_checks.py|12 col 1| Missing docstring in public function
regular_api_checks.py|22 col 1| Missing docstring in public function
regular_api_checks.py|32 col 1| Missing docstring in public function
regular_api_checks.py|42 col 1| Missing docstring in public function
regular_api_checks.py|52 col 1| Missing docstring in public function
regular_api_checks.py|62 col 1| Missing docstring in public function
regular_api_checks.py|73 col 1| Missing docstring in public function
regular_api_checks.py|82 col 1| Missing docstring in public function
regular_api_checks.py|88 col 1| Missing docstring in public function
regular_api_checks.py|95 col 28| comparison to True should be 'if cond is True:' or 'if cond:'
regular_api_checks.py|98 col 1| Missing docstring in public function
regular_api_checks.py|108 col 1| Missing docstring in public function
regular_api_checks.py|114 col 9| line break before binary operator
regular_api_checks.py|118 col 1| Missing docstring in public function
regular_api_checks.py|127 col 1| Missing docstring in public function
regular_api_checks.py|134 col 1| Missing docstring in public function
regular_api_checks.py|140 col 1| Missing docstring in public function
regular_api_checks.py|148 col 1| Missing docstring in public function
regular_api_checks.py|158 col 1| Missing docstring in public function
regular_api_checks.py|169 col 1| Missing docstring in public function
regular_api_checks.py|179 col 1| Missing docstring in public function
regular_api_checks.py|194 col 1| Missing docstring in public function
regular_api_checks.py|210 col 1| Missing docstring in public function
regular_api_checks.py|227 col 1| Missing docstring in public function
regular_api_checks.py|238 col 1| Missing docstring in public function
regular_api_checks.py|244 col 1| Missing docstring in public function
regular_api_checks.py|262 col 1| Missing docstring in public function
regular_api_checks.py|281 col 1| Missing docstring in public function
regular_api_checks.py|287 col 1| Missing docstring in public function
regular_api_checks.py|294 col 1| Missing docstring in public function
regular_api_checks.py|325 col 30| comparison to True should be 'if cond is True:' or 'if cond:'
resources/Agencies.py|1 col 1| Missing docstring in public module
resources/Agencies.py|42 col 1| First line should be in imperative mood
resources/ApiKey.py|1 col 1| Missing docstring in public module
resources/ApiKey.py|15 col 1| First line should be in imperative mood
resources/Archives.py|1 col 1| Missing docstring in public module
resources/Archives.py|16 col 1| One-line docstring should fit on one line with quotes
resources/Archives.py|23 col 1| First line should be in imperative mood
resources/Archives.py|40 col 1| First line should be in imperative mood
resources/DataSources.py|1 col 1| Missing docstring in public module
resources/DataSources.py|18 col 1| 1 blank line required between summary line and description
resources/DataSources.py|26 col 1| First line should be in imperative mood
resources/DataSources.py|50 col 1| First line should be in imperative mood
resources/DataSources.py|73 col 20| do not compare types, for exact checks use is / is not, for instance checks use isinstance()
resources/DataSources.py|94 col 1| 1 blank line required between summary line and description
resources/DataSources.py|102 col 1| First line should be in imperative mood
resources/DataSources.py|120 col 1| First line should be in imperative mood
resources/DataSources.py|142 col 20| do not compare types, for exact checks use is / is not, for instance checks use isinstance()
resources/DataSources.py|161 col 1| Missing docstring in public class
resources/DataSources.py|165 col 1| Missing docstring in public method
resources/DataSources.py|179 col 1| 1 blank line required between summary line and description
resources/DataSources.py|187 col 1| First line should be in imperative mood
resources/Login.py|9 col 1| One-line docstring should fit on one line with quotes
resources/Login.py|15 col 1| 1 blank line required between summary line and description
resources/Login.py|15 col 1| First line should end with a period
resources/Login.py|15 col 1| First line should be in imperative mood
resources/PsycopgResource.py|1 col 1| Missing docstring in public module
resources/PsycopgResource.py|10 col 1| First line should be in imperative mood; try rephrasing
resources/PsycopgResource.py|44 col 1| Missing docstring in public class
resources/PsycopgResource.py|46 col 1| 1 blank line required between summary line and description
resources/PsycopgResource.py|46 col 1| First line should be in imperative mood
resources/PsycopgResource.py|54 col 1| One-line docstring should fit on one line with quotes
resources/PsycopgResource.py|54 col 1| First line should be in imperative mood; try rephrasing
resources/PsycopgResource.py|60 col 1| One-line docstring should fit on one line with quotes
resources/PsycopgResource.py|60 col 1| First line should be in imperative mood; try rephrasing
resources/QuickSearch.py|19 col 1| 1 blank line required between summary line and description
resources/QuickSearch.py|19 col 1| First line should end with a period
resources/QuickSearch.py|28 col 1| 1 blank line required between summary line and description
resources/QuickSearch.py|28 col 1| First line should end with a period
resources/QuickSearch.py|28 col 1| First line should be in imperative mood
resources/QuickSearch.py|43 col 9| do not use bare 'except'
resources/QuickSearch.py|75 col 17| line break before binary operator
resources/QuickSearch.py|76 col 17| line break before binary operator
resources/QuickSearch.py|77 col 17| line break before binary operator
resources/QuickSearch.py|78 col 17| line break before binary operator
resources/QuickSearch.py|79 col 17| line break before binary operator
resources/RefreshSession.py|1 col 1| Missing docstring in public module
resources/RefreshSession.py|12 col 1| 1 blank line required between summary line and description
resources/RefreshSession.py|19 col 1| 1 blank line required between summary line and description
resources/RefreshSession.py|19 col 1| First line should end with a period
resources/RefreshSession.py|19 col 1| First line should be in imperative mood
resources/RequestResetPassword.py|1 col 1| Missing docstring in public module
resources/RequestResetPassword.py|13 col 1| 1 blank line required between summary line and description
resources/RequestResetPassword.py|13 col 1| First line should end with a period
resources/RequestResetPassword.py|20 col 1| 1 blank line required between summary line and description
resources/RequestResetPassword.py|20 col 1| First line should end with a period
resources/RequestResetPassword.py|20 col 1| First line should be in imperative mood
resources/RequestResetPassword.py|31 col 9| local variable 'id' is assigned to but never used
resources/RequestResetPassword.py|37 col 9| local variable 'r' is assigned to but never used
resources/ResetPassword.py|15 col 1| 1 blank line required between summary line and description
resources/ResetPassword.py|22 col 1| 1 blank line required between summary line and description
resources/ResetPassword.py|22 col 1| First line should end with a period
resources/ResetPassword.py|22 col 1| First line should be in imperative mood
resources/ResetTokenValidation.py|1 col 1| Missing docstring in public module
resources/ResetTokenValidation.py|12 col 1| Missing docstring in public class
resources/ResetTokenValidation.py|15 col 1| Missing docstring in public method
resources/SearchTokens.py|1 col 1| Missing docstring in public module
resources/SearchTokens.py|24 col 1| 1 blank line required between summary line and description
resources/SearchTokens.py|31 col 1| First line should be in imperative mood
resources/SearchTokens.py|49 col 12| do not compare types, for exact checks use is / is not, for instance checks use isinstance()
resources/SearchTokens.py|56 col 13| f-string is missing placeholders
resources/SearchTokens.py|65 col 13| do not use bare 'except'
resources/SearchTokens.py|81 col 21| line break before binary operator
resources/SearchTokens.py|82 col 21| line break before binary operator
resources/SearchTokens.py|83 col 21| line break before binary operator
resources/SearchTokens.py|84 col 21| line break before binary operator
resources/SearchTokens.py|85 col 21| line break before binary operator
resources/User.py|1 col 1| Missing docstring in public module
resources/User.py|11 col 1| One-line docstring should fit on one line with quotes
resources/User.py|17 col 1| First line should be in imperative mood
resources/User.py|39 col 1| First line should be in imperative mood
resources/init.py|1 col 1| Missing docstring in public package
tests/init.py|1 col 1| Missing docstring in public package
tests/middleware/init.py|1 col 1| Missing docstring in public package
tests/middleware/helper_functions.py|173 col 1| First line should be in imperative mood
tests/middleware/test_archives_queries.py|1 col 1| Missing docstring in public module
tests/middleware/test_archives_queries.py|8 col 1| 'tests.middleware.helper_functions.insert_test_agencies_and_sources' imported but unused
tests/middleware/test_archives_queries.py|12 col 1| 'tests.middleware.fixtures.dev_db_connection' imported but unused
tests/middleware/test_archives_queries.py|12 col 1| 'tests.middleware.fixtures.db_cursor' imported but unused
tests/middleware/test_archives_queries.py|12 col 1| 'tests.middleware.fixtures.connection_with_test_data' imported but unused
tests/middleware/test_archives_queries.py|20 col 5| redefinition of unused 'dev_db_connection' from line 12
tests/middleware/test_archives_queries.py|21 col 5| redefinition of unused 'db_cursor' from line 12
tests/middleware/test_archives_queries.py|23 col 1| 1 blank line required between summary line and description
tests/middleware/test_archives_queries.py|52 col 5| redefinition of unused 'connection_with_test_data' from line 12
tests/middleware/test_archives_queries.py|54 col 1| 1 blank line required between summary line and description
tests/middleware/test_archives_queries.py|54 col 1| First line should end with a period
tests/middleware/test_data_source_queries.py|1 col 1| Missing docstring in public module
tests/middleware/test_data_source_queries.py|15 col 1| 'tests.middleware.fixtures.connection_with_test_data' imported but unused
tests/middleware/test_data_source_queries.py|15 col 1| 'tests.middleware.fixtures.dev_db_connection' imported but unused
tests/middleware/test_data_source_queries.py|20 col 1| 1 blank line required between summary line and description
tests/middleware/test_data_source_queries.py|20 col 1| First line should end with a period
tests/middleware/test_data_source_queries.py|20 col 1| First line should be in imperative mood; try rephrasing
tests/middleware/test_data_source_queries.py|29 col 5| redefinition of unused 'connection_with_test_data' from line 15
tests/middleware/test_data_source_queries.py|32 col 1| 1 blank line required between summary line and description
tests/middleware/test_data_source_queries.py|32 col 1| First line should end with a period
tests/middleware/test_data_source_queries.py|51 col 5| redefinition of unused 'connection_with_test_data' from line 15
tests/middleware/test_data_source_queries.py|54 col 1| 1 blank line required between summary line and description
tests/middleware/test_data_source_queries.py|54 col 1| First line should end with a period
tests/middleware/test_data_source_queries.py|72 col 5| redefinition of unused 'connection_with_test_data' from line 15
tests/middleware/test_data_source_queries.py|74 col 1| 1 blank line required between summary line and description
tests/middleware/test_data_source_queries.py|74 col 1| First line should end with a period
tests/middleware/test_data_source_queries.py|93 col 5| redefinition of unused 'connection_with_test_data' from line 15
tests/middleware/test_data_source_queries.py|95 col 1| 1 blank line required between summary line and description
tests/middleware/test_data_source_queries.py|95 col 1| First line should end with a period
tests/middleware/test_data_source_queries.py|108 col 5| redefinition of unused 'connection_with_test_data' from line 15
tests/middleware/test_data_source_queries.py|111 col 1| 1 blank line required between summary line and description
tests/middleware/test_data_source_queries.py|111 col 1| First line should end with a period
tests/middleware/test_data_source_queries.py|132 col 1| No blank lines allowed after function docstring
tests/middleware/test_data_source_queries.py|132 col 1| 1 blank line required between summary line and description
tests/middleware/test_data_source_queries.py|132 col 1| First line should end with a period
tests/middleware/test_data_source_queries.py|154 col 13| line break before binary operator
tests/middleware/test_initialize_psycopg2_connection.py|1 col 1| Missing docstring in public module
tests/middleware/test_initialize_psycopg2_connection.py|2 col 1| 1 blank line required between summary line and description
tests/middleware/test_initialize_psycopg2_connection.py|2 col 1| First line should end with a period
tests/middleware/test_initialize_psycopg2_connection.py|12 col 1| 1 blank line required between summary line and description
tests/middleware/test_initialize_psycopg2_connection.py|12 col 1| First line should end with a period
tests/middleware/test_login_queries.py|1 col 1| Missing docstring in public module
tests/middleware/test_login_queries.py|15 col 1| 'tests.middleware.fixtures.dev_db_connection' imported but unused
tests/middleware/test_login_queries.py|15 col 1| 'tests.middleware.fixtures.db_cursor' imported but unused
tests/middleware/test_login_queries.py|18 col 22| redefinition of unused 'db_cursor' from line 15
tests/middleware/test_login_queries.py|19 col 1| 1 blank line required between summary line and description
tests/middleware/test_login_queries.py|19 col 1| First line should end with a period
tests/middleware/test_login_queries.py|33 col 39| redefinition of unused 'db_cursor' from line 15
tests/middleware/test_login_queries.py|34 col 1| First line should end with a period
tests/middleware/test_login_queries.py|34 col 1| First word of the first line should be properly capitalized
tests/middleware/test_login_queries.py|39 col 39| redefinition of unused 'db_cursor' from line 15
tests/middleware/test_login_queries.py|40 col 1| 1 blank line required between summary line and description
tests/middleware/test_login_queries.py|40 col 1| First line should end with a period
tests/middleware/test_login_queries.py|49 col 60| local variable 'mock_getenv' is assigned to but never used
tests/middleware/test_login_queries.py|56 col 19| redefinition of unused 'db_cursor' from line 15
tests/middleware/test_login_queries.py|57 col 1| 1 blank line required between summary line and description
tests/middleware/test_login_queries.py|57 col 1| First line should end with a period
tests/middleware/test_login_queries.py|71 col 51| redefinition of unused 'db_cursor' from line 15
tests/middleware/test_login_queries.py|72 col 1| 1 blank line required between summary line and description
tests/middleware/test_login_queries.py|72 col 1| First line should end with a period
tests/middleware/test_login_queries.py|81 col 53| redefinition of unused 'db_cursor' from line 15
tests/middleware/test_login_queries.py|82 col 1| First line should end with a period
tests/middleware/test_quick_search_query.py|1 col 1| Missing docstring in public module
tests/middleware/test_quick_search_query.py|1 col 1| 'datetime.datetime' imported but unused
tests/middleware/test_quick_search_query.py|4 col 1| 'pytz' imported but unused
tests/middleware/test_quick_search_query.py|11 col 1| 'tests.middleware.helper_functions.insert_test_agencies_and_sources' imported but unused
tests/middleware/test_quick_search_query.py|16 col 1| 'tests.middleware.fixtures.dev_db_connection' imported but unused
tests/middleware/test_quick_search_query.py|16 col 1| 'tests.middleware.fixtures.db_cursor' imported but unused
tests/middleware/test_quick_search_query.py|16 col 1| 'tests.middleware.fixtures.connection_with_test_data' imported but unused
tests/middleware/test_quick_search_query.py|24 col 5| redefinition of unused 'connection_with_test_data' from line 16
tests/middleware/test_quick_search_query.py|26 col 1| 1 blank line required between summary line and description
tests/middleware/test_quick_search_query.py|40 col 5| redefinition of unused 'connection_with_test_data' from line 16
tests/middleware/test_quick_search_query.py|42 col 1| First line should end with a period
tests/middleware/test_quick_search_query.py|66 col 5| redefinition of unused 'connection_with_test_data' from line 16
tests/middleware/test_quick_search_query.py|68 col 1| First line should end with a period
tests/middleware/test_reset_token_queries.py|1 col 1| Missing docstring in public module
tests/middleware/test_reset_token_queries.py|17 col 1| 'tests.middleware.fixtures.dev_db_connection' imported but unused
tests/middleware/test_reset_token_queries.py|17 col 1| 'tests.middleware.fixtures.db_cursor' imported but unused
tests/middleware/test_reset_token_queries.py|20 col 28| redefinition of unused 'db_cursor' from line 17
tests/middleware/test_reset_token_queries.py|21 col 1| 1 blank line required between summary line and description
tests/middleware/test_reset_token_queries.py|21 col 1| First line should end with a period
tests/middleware/test_reset_token_queries.py|33 col 1| Missing docstring in public function
tests/middleware/test_reset_token_queries.py|34 col 5| redefinition of unused 'db_cursor' from line 17
... (Too many findings. Dropped some findings)

Annotations

Check warning on line 1 in resources/Login.py

See this annotation in the file changed.

@github-actions github-actions / flake8

[flake8] resources/Login.py#L1 <100>

Missing docstring in public module
Raw output
./resources/Login.py:1:1: D100 Missing docstring in public module

Check warning on line 1 in resources/QuickSearch.py

See this annotation in the file changed.

@github-actions github-actions / flake8

[flake8] resources/QuickSearch.py#L1 <100>

Missing docstring in public module
Raw output
./resources/QuickSearch.py:1:1: D100 Missing docstring in public module

Check warning on line 1 in resources/ResetPassword.py

See this annotation in the file changed.

@github-actions github-actions / flake8

[flake8] resources/ResetPassword.py#L1 <100>

Missing docstring in public module
Raw output
./resources/ResetPassword.py:1:1: D100 Missing docstring in public module