isort does not skip files

[nikitagashkov]

Describe the bug

isort does not respect skip and skip_glob configuration options.

To Reproduce

Steps to reproduce the behavior:

1. Create file.py with the following content:

   import os, \
       sys

2. Create .isort.cfg with the following content:

   [settings]
   skip_glob = file.py
   

3. Run isort file.py.
4. Open file.py and check out it's content to become:

   import os
   import sys

Expected behavior

A file.py is skipped and is not touched.

Screenshots

—

Environment (please complete the following information):

• OS: Linux
• Python version: 3.7.2
• isort version: 4.3.11

Additional context

isort 4.3.10 is working correctly. Issue can be reproduced with skip option as well.

[timothycrosley]

Hi @nickgashkov,

Can you tell me more about your use case for this?

The updated behavior basically makes files you explicitly pass from the command line, assumed non skipped - in all other cases they are skipped (such as when doing recursive sorting).

If you do not explicitly pass in that file, but rather a directory it will be skipped. If you pass it in using the API it will also be skipped. I'm curious about the use case where you want to skip files based on a config, but then explicitly pass them in? The reason for this change was that with the old behavior if you say, skipped "build" because you had a build directory inside your project, but then ran in travis which put all your code inside a build directory - you would suddenly be skipping all your files unintentionally.

[nikitagashkov]

Hello @timothycrosley,

Thanks for a fast reply. Sorry for unclear description, I didn't know about the behavior of explicitly passed files. The issue can be reproduced with isort -rc . as well.

Given the following project structure...

...and the contents of file.py as in the original issue description and .isort.cfg contents like:

[settings]
skip_glob = **/*.py

isort 4.3.11 does not skip file.py while isort 4.3.10 does.

I've tested the following config...

[settings]
skip_glob = *.py

...and the file.py is correctly skipped. Maybe something's wrong with the glob...

[silasary]

Following up on this, we have an .isort.cnf in a subfolder of our project, as we only want to skip a file in that particular directory.

Moving the .isort.cfg to the root folder fixes the problem, but incidentally skips a similarly named file in a different subdirectory.

This setup worked with 4.3.4 but not 4.3.11

[brianmay]

I think, rightly or wrongly, skip_glob only matches the filename, not the complete path. Meaning components like */ or **/ don't work right now - and are not required either.

[brianmay]

I think the skip option might also be only matching the filename, however I am not sure if this is expected behavior or not. e.g.

skip=migrations

Will skip all directories called migrations not just one directory at the top level. Looking at other examples would suggest it is only suppose to match the exact directory I specified.

[brianmay]

There does appear to be a regression here. In version 4.3.10 the following works:

skip_glob = */migrations/*.py

In version 4.3.11 it now processes files such as karaage/migrations/0002_auto_20140924_1111.py. Will try to narrow it down to the commit.

[brianmay]

Forget what I just said (and deleted). Me confused.

First bad commit is 2c59158 in #878.

Note this commit was hard to test, because it contained unrelated errors fixed in subsequent commits.

[timothycrosley]

I'm sorry for letting this regression slip in the last release! It took a while for me to untangle, but it should be fixed in the latest release (4.3.13) of isort, with additional testing put in place to try to ensure the regression is not reintroduced on the future.

Thanks!

~Timothy

[brianmay]

Extra testing -> sounds great!