PyCQA / PyCQA/isort

isort is not explicit about skipping directories

Open
#1,968 2 comments 1 reaction 0 assignees View on GitHub

Nobody has claimed this yet.

Dominant language
Python
Stars
7k
Forks
687
Avg merge
4h 56m
Merged PRs (30d)
2

Description

Problem

isort has default directory skips listed here

I was working on a project where I actually had a module named venv in my source code. isort skipped it completely without any kind of warning.

Example:

app/
  venv/
    __init__.py
    some_file.py

isort skips the content of app/venv and does nothing on it.

Workaround

I renamed my venv module to virtualenv.

Question

Should isort ignores the default_skip when they are python modules ?

Contributor guide

No contributing guide indexed for this repository

First steps

  1. Read the whole issue, then the project's contributing guide.
  2. Comment on the issue to say you are picking it up — it saves two people doing the same work.
  3. Fork the repository and make your change on a branch.
  4. Open a pull request that references the issue number.

Research direction

Start with the default directory skips in isort/settings.py around line 73, then reproduce the reported app/venv example with a module named venv. Determine the expected handling for directories that are also Python modules and document or test the resulting behavior so the skip is no longer silent or ambiguous.

Written by the indexing model from the issue text.

Assessment

Tech stack
python
Domain
cli, tooling
Issue type
Bug
Difficulty
4/5
Estimated time
3-5 days
Activity status
Stale
Clarity
Needs clarification
Newbie friendliness
35/100

Get new issues in your inbox

A short digest of beginner-friendly GitHub issues.