Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Split Up _testsinglephase.c and _testmultiphase.c #124983

Open
ericsnowcurrently opened this issue Oct 4, 2024 · 2 comments
Open

Split Up _testsinglephase.c and _testmultiphase.c #124983

ericsnowcurrently opened this issue Oct 4, 2024 · 2 comments
Labels
3.14 new features, bugs and security fixes extension-modules C modules in the Modules dir tests Tests in the Lib/test dir

Comments

@ericsnowcurrently
Copy link
Member

ericsnowcurrently commented Oct 4, 2024

(low priority)

Modules/_testsinglephase.c and Modules/_testmultiphase.c both contain the implementations of multiple modules. We should consider splitting up both files, so each contained module has its own file.

Here are several reasons why this may be worth doing:

  • testing with a module hidden in another's .so file is awkward and makes those tests harder to understand
  • it's easier to accidentally leak C-module global data between modules when they are implemented in the same file
  • when adding a new module, it's trickier (less familiar) to implement it in an existing file than in a new file 1

Furthermore, both files were added to test specific import functionality. As far as I can tell2, that never included any need for the multiple-modules-in-one-file approach. However, currently they are the only place where we're testing the feature, regardless of how unintentionally or superficially. gh-124978 targets fixing that lack of explicit testing, including moving away from _testsinglephase.c and _testmultiphase.c (e.g. using the dedicated Modules/_testimportmultiple.c).

All that said, splitting up the files is a fairly low priority task. The status quo isn't ideal but it isn't that bad either.


Here's how I see us taking care of this:

  1. make sure multiple-modules-in-one-file is tested via the dedicated Modules/_testimportmultiple.c 2 (see gh-124978)
  2. create the Modules/_testsinglephase directory
  3. move each module from _testsinglephase.c to its own file (see the devguide)
  4. update the relevant tests
  5. delete Modules/_testsinglephase.c
  6. repeat steps 2-5 for Modules/_testmultiphase.c

Footnotes

  1. However, adding it to an existing file is also simpler in how adding a new file involves tweaking the build. See the devguide.

  2. I personally added Modules/_testsinglephase.c and @encukou added _testmultiphase.c. 2

@ericsnowcurrently ericsnowcurrently added tests Tests in the Lib/test dir extension-modules C modules in the Modules dir 3.14 new features, bugs and security fixes labels Oct 4, 2024
@ericsnowcurrently
Copy link
Member Author

CC @encukou

@encukou
Copy link
Member

encukou commented Oct 7, 2024

I'm honestly a bit surprised that you'd prefer dealing with multiple .so/.dll files.
Similar code split/repeated across several files is also hard to understand, and tests are exactly where leaking C globals is least dangerous.

But, that's all vibes. If you care strongly enough, go ahead and refactor.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
3.14 new features, bugs and security fixes extension-modules C modules in the Modules dir tests Tests in the Lib/test dir
Projects
None yet
Development

No branches or pull requests

2 participants