Update isort script to match changes in the new release, isort v5.0.2 #1670

asheux · 2020-07-05T03:10:16Z

Apparently, isort latest release isort v5.0.2 is missing the --recursive or -rc flag and since the project uses the flag in it's script, it causes the tests to fail. An alternative to this is a dot, as in isort ..

Missing flags

--apply
--recursive

Replacement

isort .

For more information on these changes see:
https://github.com/timothycrosley/isort/blob/develop/CHANGELOG.md#500-penny---july-4-2020

With this change, the build should be okay.

codecov · 2020-07-05T03:43:11Z

Codecov Report

Merging #1670 into master will not change coverage.
The diff coverage is 100.00%.

@@            Coverage Diff            @@
##            master     #1670   +/-   ##
=========================================
  Coverage   100.00%   100.00%           
=========================================
  Files          236       236           
  Lines         7150      7152    +2     
=========================================
+ Hits          7150      7152    +2

Impacted Files	Coverage Δ
fastapi/dependencies/utils.py	`100.00% <ø> (ø)`
fastapi/utils.py	`100.00% <ø> (ø)`
fastapi/security/http.py	`100.00% <100.00%> (ø)`
fastapi/security/oauth2.py	`100.00% <100.00%> (ø)`
...rial/test_additional_responses/test_tutorial001.py	`100.00% <100.00%> (ø)`
...rial/test_additional_responses/test_tutorial002.py	`100.00% <100.00%> (ø)`
...rial/test_additional_responses/test_tutorial003.py	`100.00% <100.00%> (ø)`
...rial/test_additional_responses/test_tutorial004.py	`100.00% <100.00%> (ø)`
...l/test_additional_status_codes/test_tutorial001.py	`100.00% <100.00%> (ø)`
...orial/test_advanced_middleware/test_tutorial001.py	`100.00% <100.00%> (ø)`
... and 81 more

Continue to review full report at Codecov.

Legend - Click here to learn more
Δ = absolute <relative> (impact), ø = not affected, ? = missing data
Powered by Codecov. Last update 3ff504f...e2e2920. Read the comment docs.

asheux · 2020-07-05T08:57:04Z

I'm trying to get rid of this error on travis ci build but I can seem to figure out how to make the build pass. Any ideas?

ERROR: /home/travis/build/tiangolo/fastapi/fastapi/utils.py Imports are incorrectly sorted and/or formatted.

ERROR: /home/travis/build/tiangolo/fastapi/fastapi/dependencies/utils.py Imports are incorrectly sorted and/or formatted.

ERROR: /home/travis/build/tiangolo/fastapi/fastapi/openapi/models.py Imports are incorrectly sorted and/or formatted.

ERROR: /home/travis/build/tiangolo/fastapi/tests/test_tutorial/test_additional_status_codes/test_tutorial001.py Imports are incorrectly sorted and/or formatted.

ERROR: /home/travis/build/tiangolo/fastapi/tests/test_tutorial/test_security/test_tutorial006.py Imports are incorrectly sorted and/or formatted.

ERROR: /home/travis/build/tiangolo/fastapi/tests/test_tutorial/test_security/test_tutorial001.py Imports are incorrectly sorted and/or formatted.

ERROR: /home/travis/build/tiangolo/fastapi/tests/test_tutorial/test_security/test_tutorial003.py Imports are incorrectly sorted and/or formatted.

ERROR: /home/travis/build/tiangolo/fastapi/tests/test_tutorial/test_security/test_tutorial005.py Imports are incorrectly sorted and/or formatted.

ERROR: /home/travis/build/tiangolo/fastapi/tests/test_tutorial/test_wsgi/test_tutorial001.py Imports are incorrectly sorted and/or formatted.

ERROR: /home/travis/build/tiangolo/fastapi/tests/test_tutorial/test_extra_models/test_tutorial003.py Imports are incorrectly sorted and/or formatted.

ERROR: /home/travis/build/tiangolo/fastapi/tests/test_tutorial/test_extra_models/test_tutorial004.py Imports are incorrectly sorted and/or formatted.

ERROR: /home/travis/build/tiangolo/fastapi/tests/test_tutorial/test_extra_models/test_tutorial005.py Imports are incorrectly sorted and/or formatted.

ERROR: /home/travis/build/tiangolo/fastapi/tests/test_tutorial/test_additional_responses/test_tutorial001.py Imports are incorrectly sorted and/or formatted.

ERROR: /home/travis/build/tiangolo/fastapi/tests/test_tutorial/test_additional_responses/test_tutorial003.py Imports are incorrectly sorted and/or formatted.

ERROR: /home/travis/build/tiangolo/fastapi/tests/test_tutorial/test_additional_responses/test_tutorial004.py Imports are incorrectly sorted and/or formatted.

asheux · 2020-07-06T01:29:25Z

This was an easy fix. Apparently, with the new update in the command, the travis ci cache was updated so I had to run the formating script on my machine and push the changes to update travis cache.

Kludex

Tutorial files should consider fastapi imports as third party.

Kludex · 2020-07-06T11:34:08Z

fastapi/__init__.py

isort is removing this line? If yes, could you check why?

I'm not sure but looking into it.

This is being fixed by isort team. see PyCQA/isort#1283

Kludex · 2020-07-06T11:35:34Z

docs_src/nosql_databases/tutorial001.py

We don't want to use isort in this tutorial, because fastapi and pydantic are really third party imports here.

This is fixed

Kludex · 2020-07-06T11:37:11Z

tests/test_tutorial/test_additional_responses/test_tutorial001.py

We don't want to use isort in this tutorial, because fastapi are really third party here.

Is this supposed to be in all the tutorials? If so, I can tell isort to ignore the files.

I think all of them use fastapi as third party... If that's true, yes.

That's correct. I've made adjustment in the new isort configuration file. This should be flexible.

otherwise it would try to format venv env directories, I have several with different Python versions

tiangolo · 2020-07-09T18:08:23Z

Thanks for your contribution @asheux ! 🍰

Thanks for the help here @Kludex ☕

I just updated it to use the Black profile and moved the config to pyproject.toml to simplify it.

I also updated the tests for the tutorial examples so that they can detect the sources as first party, without having to disable isort for big sections of code.

Thanks for your contribution! 🚀

asheux added 2 commits July 5, 2020 06:35

Update isort script to match changes in the new release, isort v5.0.2

c84ea7f

Downgrade isort to version v4.3.21

41d847b

Add an alternative flag to --recursive in isort v5.0.2

909282b

Kludex reviewed Jul 6, 2020

View reviewed changes

asheux and others added 8 commits July 6, 2020 21:05

Add isort config file

f1a4a10

🚚 Import from docs_src for tests

eb2a26e

🎨 Format dependencies.utils

b60d64b

🎨 Remove isort combine_as_imports, keep black profile

d77812f

🔧 Update isort config, use pyproject.toml, Black profile

f0d5116

🔧 Update format scripts to use explicit directories to format

019bde4

otherwise it would try to format venv env directories, I have several with different Python versions

🎨 Format NoSQL tutorial after re-sorting imports

919ad82

🎨 Fix format for __init__.py

e2e2920

tiangolo merged commit fe453f8 into fastapi:master Jul 9, 2020

Uh oh!

Update isort script to match changes in the new release, isort v5.0.2 #1670

Update isort script to match changes in the new release, isort v5.0.2 #1670

Conversation

asheux commented Jul 5, 2020 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Missing flags

Replacement

Uh oh!

codecov bot commented Jul 5, 2020 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Codecov Report

Uh oh!

asheux commented Jul 5, 2020

Uh oh!

asheux commented Jul 6, 2020

Uh oh!

Kludex left a comment

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

tiangolo commented Jul 9, 2020

Uh oh!

Reviewers

Assignees

Labels

Projects

Milestone

Development

Uh oh!

3 participants

asheux commented Jul 5, 2020 •

edited

Loading

codecov bot commented Jul 5, 2020 •

edited

Loading