Falcon 4.0.0 adds possibly unintended directories when installed

[LenardJensen]

Hello,
after the update to Falcon 4.0.0 I noticed my venv site-packages contained directories that I could not match to a specific library. After checking my different dependencies I managed to connect those directories to the new Falcon update and wanted to ask if these changes were intended.

Expected Behavior

When installing Falcon using pip, a falcon and falcon-xxx.dist-info directory gets created in the site-packages directory.

Actual Behavior

Falcon 4.0.0a1 and Falcon 4.0.0 also installs their docs, e2e-tests, examples, tests and tools directories into the site-packages of a virtualenv.

Steps to Reproduce the Problem

1. Create a new venv using python -m venv my-venv
2. Install either Falcon 4.0.0 or 4.0.0a1 using pip install "falcon==4.0.0"
3. Navigate into my-venv/Lib/site-packages/ which contains the additional directories. falcon-4.0.0.dist-info\RECORD will contain the paths to those additional directories

Specifications

• Version: Tested using Python 3.11 and pip 22.2.1
• Platform: Windows 11

[CaselIT]

Hi,

Looking at the created wheels that seems to be the case.
@vytas7 can you look at it? It looks like a 4.0.1 candidate (also not connected to this, what is the milestone for 4.0.x?)

[vytas7]

Hi @LenardJensen!
This is absolutely not intended. It seems to be a bug or unwanted artefact of cibuildwheel, PEP 517-build process or something like that now that we got rid of setup.cfg.

We'll take a look and get a fix out.

[CaselIT]

IIRC MANIFEST.in is still used to define what's included.

It's actually strange since for example tests have no files, but includes test/asgi and that folder includes all the test files, so it seems there is some file filtering going on, but it's likely failing for some reason

[vytas7]

It is some trickery of the new mode of Setuptools, MANIFEST.in is used to define what is included in the sdist, but the wheels used to only include modules and package data. I'll check what our options are...

I've also checked our older builds prior to removing setup.cfg, and they look as expected.

Edit: it seems the new mode happily finds non-modules as modules too (i.e. directories not containing any __init__.py). I'll probably simply change from exclude to include.

[vytas7]

Thanks once again for reporting @LenardJensen , we have now released Falcon 4.0.1 that hopefully addresses this issue.