Skip to content

Fix discovery for trampoline files - #230

Merged
vzhurba01 merged 1 commit into
NVIDIA:mainfrom
vzhurba01:package-data-fix
Nov 9, 2024
Merged

Fix discovery for trampoline files#230
vzhurba01 merged 1 commit into
NVIDIA:mainfrom
vzhurba01:package-data-fix

Conversation

@vzhurba01

Copy link
Copy Markdown
Contributor

Fixes#226

@vzhurba01vzhurba01 self-assigned this Nov 9, 2024
@copy-pr-bot

Copy link
Copy Markdown
Contributor

This pull request requires additional validation before any workflows can run on NVIDIA's runners.

Pull request vetters can view their responsibilities here.

Contributors can view more details about this message here.

@vzhurba01vzhurba01 added bug Something isn't working P0 High priority - Must do! cuda.bindings Everything related to the cuda.bindings module labels Nov 9, 2024
@leofang
leofang self-requested a review November 9, 2024 00:32
@leofang

Copy link
Copy Markdown
Member

Thanks, Vlad! 🙏 Let me test it again on both platforms before merging.

@leofangleofang added this to the cuda-python 12.6.3 & 11.8.6 milestone Nov 9, 2024
@leofang

Copy link
Copy Markdown
Member

Tested on both Windows & Linux, all files (pxd/pyx/cpp/h) are included in the wheel 🎉

Q: I noticed this line as I was wondering how version is bumped with versioneer:

cfg.versionfile_source="cuda/_version.py"

Do we need to change it to accommodate for new layout?

@leofangleofang added the packaging Anything related to wheels or Conda packages label Nov 9, 2024
@vzhurba01
vzhurba01 merged commit a855762 into NVIDIA:mainNov 9, 2024
@vzhurba01

Copy link
Copy Markdown
ContributorAuthor

Tested on both Windows & Linux, all files (pxd/pyx/cpp/h) are included in the wheel 🎉

Q: I noticed this line as I was wondering how version is bumped with versioneer:

cfg.versionfile_source="cuda/_version.py"

Do we need to change it to accommodate for new layout?

Using tags, I'm not sure how that snippet there is used for. I recall we wanted to remove versioneers all together.

@leofang

Copy link
Copy Markdown
Member

I recall we wanted to remove versioneers all together.

Yes! Thanks for reminder, I created #233.

@leofangleofang modified the milestones: cuda-python 12.6.3 & 11.8.6, cuda-python 12.6.2 & 11.8.5Nov 13, 2024
Comment on lines 2 to +4
# at least with setuptools 75.0.0 this folder was added erroneously
# to the payload, causing file copying to the build environment failed
exclude cuda/bindings
exclude cuda/bindings cuda?bindings

@leofangleofangNov 13, 2024

Copy link
Copy Markdown
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

To be clear this is NOT a bug fix (the one-liner change below is), just a really unpleasant workaround for presumably two (2) potentially correlated setuptools bugs. Many engineering hours are wasted only to find this WAR in order to accommodate for both Linux and Windows. Yes, we need both; can't just pick either of them.

What happened is (paraphrasing @vzhurba01's comment from the internal discussion): We need to fix pyproject.toml to find all extension modules starting with cuda (which was missed in the hot fix 12.6.2/11.8.5), so that all modules' Cython sources can be included in the package.

However, once we do this we see a very strange error on both platforms at build time

error: can't copy 'cuda/bindings': doesn't exist or not a regular file

which suggests that setuptools tries to copy this folder as a regular file. This is likely the first bug.

What's happening here is that as part of egg_info source file discovery, it fetches files directly from build_ext. Files found use a mix of Linux and Windows path separators (/ and \\, respectively). One of the paths found is cuda/bindings (which should not have happened in the first place).

To work it around, we rely on MANIFEST.in letting us specify which path/file to exclude, and so we added exclude cuda/bindings when we worked on the layout change #137. Since setuptools' docs clearly stated that

File & directory names in MANIFEST.in should be /-separated; setuptools will automatically convert the slashes to the local platform’s appropriate directory separator.

this should have been a cross-platform WAR.

The next bug that bites us is that egg_info tries to be "smart" by converting all Linux separators to Windows, therefore our exclude only applies to cuda\\bindings and thus failing the Windows build later on. This is the second bug, and the WAR is to rely on this documented little trick (same setuptools page as linked above):

? matches a single regular filename character

Copy link
Copy Markdown
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

@thomasjpfan in case you're still interested in knowing what happened 🙂

Sign up for freeto join this conversation on GitHub. Already have an account? Sign in to comment

Labels

bugSomething isn't workingcuda.bindingsEverything related to the cuda.bindings moduleP0High priority - Must do!packagingAnything related to wheels or Conda packages

Projects

None yet

Development

Successfully merging this pull request may close these issues.

cuda-python 11.8.5/12.6.2 package content issues

2 participants

@vzhurba01@leofang