Folder name and case sensitivity on repo checkout directory and src layout

[cgravill]

When using fawltydeps with a repo using a src layout and mixed case folder it seems that imports in /tests don't find the package directory according to fawltydeps. We can workaround this by using --base-dir src .

To Reproduce
https://github.com/cgravill/DependenciesAndCasingReproduction

Unexpected:

/DependenciesAndCasingReproduction$ uv run fawltydeps

These imports appear to be undeclared dependencies:
- 'dependenciesandcasingreproduction'

Workaround:

/DependenciesAndCasingReproduction$ uv run fawltydeps --base-dir src

No undeclared or unused dependencies detected.

Success (copy to lower case directory that matches):

/dependenciesandcasingreproduction$ uv run fawltydeps

No undeclared or unused dependencies detected.

Environment

• OS name + version: Ubuntu 24.04
• Version of the code: 0.20.0

[jherland]

Thanks for reporting, and for providing a reproduction case. I do wonder, though, if this is not the expected behavior with the src/ layout? For example, when I try to run pytest in your example repo, it fails for the same reason:

ERROR collecting tests/test_example.py ImportError while importing test module '/home/jherland/code/DependenciesAndCasingReproduction/tests/test_example.py'.
Hint: make sure your test modules/packages have valid Python names.
Traceback:
/nix/store/sd81bvmch7njdpwx3lkjslixcbj5mivz-python3-3.13.4/lib/python3.13/importlib/__init__.py:88: in import_module
    return _bootstrap._gcd_import(name[level:], package, level)
tests/test_example.py:3: in <module>
    from dependenciesandcasingreproduction.example import hello
E   ModuleNotFoundError: No module named 'dependenciesandcasingreproduction'

The expectation - from the test code's POV - is that the module being tested must already be available in the test's Python environment, and that means either installing the package built from the project, or running the test with src/ added to $PYTHONPATH. For FawltyDeps, the latter is equivalent to passing --base-dir src.

Thus, I think FawltyDeps is behaving as we expect here, and that your best option is to configure FawltyDeps with a base directory, e.g. by putting this in your pyproject.toml:

[tool.fawltydeps]
base_dir = 'src'

Have I missed something, or are there specific reasons you think that FawltyDeps should auto-detect the src layout and adjust its default behavior?

[cgravill]

That's curious, I see quite different results, what command are you running?

/DependenciesAndCasingReproduction$ uv run -m unittest discover -s tests
.
----------------------------------------------------------------------
Ran 1 test in 0.000s

OK

If I add pytest locally it also passes locally:

/DependenciesAndCasingReproduction$ uv add pytest --quiet
badger:/AAABBBCCC/DependenciesAndCasingReproduction$ uv run pytest
=========================================== test session starts ============================================
platform linux -- Python 3.13.6, pytest-8.4.2, pluggy-1.6.0
rootdir: AAABBBCCC/DependenciesAndCasingReproduction
configfile: pyproject.toml
collected 1 item

tests/test_example.py .                                                                              [100%]

============================================ 1 passed in 0.00s =============================================

Just to check adding things hasn't made a change, I still get the issue:

/DependenciesAndCasingReproduction$ uv run fawltydeps

These imports appear to be undeclared dependencies:
- 'dependenciesandcasingreproduction'

For a more verbose report re-run with the `--detailed` option.

Putting the the base_dir in our pyproject.toml would be OK too, thanks for the pointer.