Move to src-layout. #2798

apollo13 · 2023-09-13T14:14:20Z

The intention of this is better isolation. trio is no longer accidentally on the (python) path and as such requires an explicit installation for usage, this helps uncover issues in packaging data etc early on (see
https://packaging.python.org/en/latest/discussions/src-layout-vs-flat-layout/).

This serves as the basis for switching to another build system as well; refs #2790.

codecov · 2023-09-13T14:16:53Z

Codecov Report

Merging #2798 (3b582ca) into master (b7d2054) will not change coverage.
The diff coverage is n/a.

Additional details and impacted files

@@           Coverage Diff           @@
##           master    #2798   +/-   ##
=======================================
  Coverage   99.18%   99.18%           
=======================================
  Files         115      115           
  Lines       17551    17551           
  Branches     3149     3149           
=======================================
  Hits        17408    17408           
  Misses         99       99           
  Partials       44       44

Files	Coverage Δ
src/trio/__init__.py	`100.00% <ø> (ø)`
src/trio/_abc.py	`100.00% <ø> (ø)`
src/trio/_channel.py	`100.00% <ø> (ø)`
src/trio/_core/__init__.py	`100.00% <ø> (ø)`
src/trio/_core/_asyncgens.py	`100.00% <ø> (ø)`
src/trio/_core/_entry_queue.py	`100.00% <ø> (ø)`
src/trio/_core/_exceptions.py	`100.00% <ø> (ø)`
src/trio/_core/_instrumentation.py	`100.00% <ø> (ø)`
src/trio/_core/_io_common.py	`100.00% <ø> (ø)`
src/trio/_core/_io_epoll.py	`100.00% <ø> (ø)`
... and 105 more

altendky · 2023-09-13T14:45:02Z

In CI this is already addressed by changing into a subdirectory when testing. I personally prefer src/, but not doing that has been an intentional decision thus far. Though, I forget where I saw this discussed. :[ I'm just suggesting that the discussion is had since I don't see a reference from here to it..

altendky · 2023-09-13T14:45:58Z

trio/ci.sh

Lines 106 to 110 in c16003f

    
           # We run the tests from inside an empty directory, to make sure Python 
        
           # doesn't pick up any .py files from our working dir. Might have been 
        
           # pre-created by some of the code above. 
        
           mkdir empty || true 
        
           cd empty

apollo13 · 2023-09-13T14:49:12Z

@altendky I see, I will still finish this for now and put it up for discussion, because while CI might address it, it can still be pretty much an annoyance. Let's see what the rest says :)

The intention of this is better isolation. `trio` is no longer accidentally on the (python) path and as such requires an explicit installation for usage, this helps uncover issues in packaging data etc early on (see https://packaging.python.org/en/latest/discussions/src-layout-vs-flat-layout/). This serves as the basis for switching to another build system as well; refs python-trio#2790.

jakkdl · 2023-09-13T14:58:35Z

I think #274 is the only place where it's been discussed.

I personally think the pro's outweigh the cons though, and give another +1 on the src/ train.

CoolCat467 · 2023-10-01T04:01:27Z

I definitely agree, a src/ based layout would be much nicer, +1

jakkdl · 2023-10-01T12:25:20Z

@njsmith do you want to weigh in on the matter?

jakkdl · 2023-10-10T10:58:19Z

@A5rocks any opinion on the matter?

A5rocks · 2023-10-10T13:20:19Z

I'm neutral on this change cause while it does align with what most people do, so would e.g. not shipping tests... so I don't think that's a very convincing argument.

And while it would take a bit of magic away from the tests it would also mean having an extra "src" folder in the path for every file in trio. (Then of course, I already have to type out trio/trio for the folder...)

So yeah arguments for and against but none of them feel strong, so neutral.

jakkdl · 2023-10-15T09:10:16Z

if this makes switching packaging system easier, I think we can just go ahead with it. The PRs been open a month and the only issue that has been brought up are minor workflow ones.

CoolCat467 · 2023-10-20T05:20:50Z

@apollo13 I would be glad to finish working on getting this merged this if you would like

apollo13 · 2023-10-20T10:30:03Z

@CoolCat467 That would be great, I am currently blocked by personal things. My goal with the PR was to be as minimal as possible. Ie moving _tests (if wanted at all) into another top level package would be something done after this PR (same for switching to whatever other tooling). I can give you access to my repo if you want to work on that branch directly or we close this PR and you open your own.

apollo13 · 2023-10-20T10:31:25Z

if this makes switching packaging system easier, I think we can just go ahead with it. The PRs been open a month and the only issue that has been brought up are minor workflow ones.

I guess it doesn't make switching much easier (if at all), tooling can usually handle both.

altendky · 2023-10-20T12:01:28Z

Ie moving _tests (if wanted at all) into another top level package

I don't want that. :] I like the stuff I import to have been installed so it's not all fiddly about how you launch Python or what your cwd is. Also, why not be able to run tests on deployed packages? Also also, fewer directories to both including and excluding from all the myriad of tools and packaging definitions etc.

CoolCat467 · 2023-10-21T03:32:53Z

@CoolCat467 That would be great, I am currently blocked by personal things. My goal with the PR was to be as minimal as possible. Ie moving _tests (if wanted at all) into another top level package would be something done after this PR (same for switching to whatever other tooling). I can give you access to my repo if you want to work on that branch directly or we close this PR and you open your own.

If I could have access to the repo that would be great, I would prefer not creating another PR if it could be avoided.

apollo13 · 2023-10-21T10:53:32Z

Sent an invite

…

On Sat, Oct 21, 2023, at 05:33, CoolCat467 wrote: > @CoolCat467 <https://github.com/CoolCat467> That would be great, I am currently blocked by personal things. My goal with the PR was to be as minimal as possible. Ie moving `_tests` (if wanted at all) into another top level package would be something done after this PR (same for switching to whatever other tooling). I can give you access to my repo if you want to work on that branch directly or we close this PR and you open your own. > If I could have access to the repo that would be great, I would prefer not creating another PR if it could be avoided. — Reply to this email directly, view it on GitHub <#2798 (comment)>, or unsubscribe <https://github.com/notifications/unsubscribe-auth/AAAT5C6RZN5VGIK6EIMJQPLYAM67DAVCNFSM6AAAAAA4WQHM42VHI2DSMVQWIX3LMV43OSLTON2WKQ3PNVWWK3TUHMYTONZTGYZTQNBXGA>. You are receiving this because you were mentioned.Message ID: ***@***.***>

…ollo13-src-layout

A5rocks · 2023-11-03T05:38:39Z

OK release is out. Still ambivalent but if people think this would better and there isn't dissent I guess this should happen? Even if we don't end up using a pep 621 backend that requires the src/ dir, it still might be better to stick to the beaten path here.

(Obviously conflicts need to be fixed)

CoolCat467

Slightly maybe in warning of "don't review your own PRs" since I've taken over continued work on this, but all the important changes were already made before that point and the tests are passing.

jakkdl

we might want to wait a day to see if anybody else pipes up about trio 0.23 being broken and needing a hotfix patch, but otherwise I don't see any problems with merging this.

A5rocks

Conflicts again :(

But mainly just that new exciting pyproject.toml changes mean you have to migrate some of the changes here.

A5rocks · 2023-11-05T23:39:42Z

.coveragerc

We'll need to move this to pyproject.toml

Oops, you're still creating .coveragerc

setup.py

Ruff infers what version to enable rules for and autofixes for based on the project supported python versions

CoolCat467 · 2023-11-06T00:42:10Z

@A5rocks How do we fix this error?

  + coverage report -m --rcfile ../pyproject.toml
  No data to report.
  Error: Process completed with exit code 1.

All the tests pass, but this doesn't.

A5rocks · 2023-11-06T00:46:10Z

Make sure that coverage is outputting its data files in the cwd, maybe? Not sure tbh

This reverts commit b03ffe9.

CoolCat467 · 2023-11-10T22:40:17Z

@A5rocks I fixed the coverage report and resolved conflicts

A5rocks

~~GitHub says I have a pending review so let's see what it is...~~

Huh posting that before I reloaded was erroring. Strange. But whatever.

Just one concern then let's merge this!

pyproject.toml

jakkdl · 2023-11-11T11:50:31Z

let's not delay this any further and fix any other potential errors as they crop up. 🚀

trio-bot · 2023-11-11T11:50:58Z

Hey @apollo13, it looks like that was the first time we merged one of your PRs! Thanks so much! 🎉 🎂

If you want to keep contributing, we'd love to have you. So, I just sent you an invitation to join the python-trio organization on Github! If you accept, then here's what will happen:

Github will automatically subscribe you to notifications on all our repositories. (But you can unsubscribe again if you don't want the spam.)
You'll be able to help us manage issues (add labels, close them, etc.)
You'll be able to review and merge other people's pull requests
You'll get a [member] badge next to your name when participating in the Trio repos, and you'll have the option of adding your name to our member's page and putting our icon on your Github profile (details)

If you want to read more, here's the relevant section in our contributing guide.

Alternatively, you're free to decline or ignore the invitation. You'll still be able to contribute as much or as little as you like, and I won't hassle you about joining again. But if you ever change your mind, just let us know and we'll send another invitation. We'd love to have you, but more importantly we want you to do whatever's best for you.

If you have any questions, well... I am just a humble Python script, so I probably can't help. But please do post a comment here, or in our chat, or on our forum, whatever's easiest, and someone will help you out!

apollo13 force-pushed the src-layout branch from 153dc7e to d8f152f Compare September 13, 2023 14:16

apollo13 force-pushed the src-layout branch 7 times, most recently from 3476c36 to 80ef0d6 Compare September 13, 2023 14:44

apollo13 force-pushed the src-layout branch from 80ef0d6 to b813917 Compare September 13, 2023 14:49

jakkdl added the project meta label Sep 13, 2023

CoolCat467 added 3 commits October 21, 2023 15:49

Merge branch 'src-layout' of https://github.com/apollo13/trio into ap…

68ace3a

…ollo13-src-layout

Merge branch 'apollo13-src-layout' into src-layout

8bb2b84

Fix missing src changes I missed

9055147

CoolCat467 added 2 commits October 26, 2023 17:50

Merge remote-tracking branch 'origin/master' into src-layout

f911587

Merge branch 'master' into src-layout

61476f7

CoolCat467 added 2 commits November 3, 2023 15:39

Merge remote-tracking branch 'origin/master' into src-layout

5226321

Merge remote-tracking branch 'origin/master' into src-layout

dda9935

CoolCat467 approved these changes Nov 4, 2023

View reviewed changes

CoolCat467 force-pushed the src-layout branch from a6651cb to dda9935 Compare November 4, 2023 04:13

Merge remote-tracking branch 'origin/master' into src-layout

fe66133

jakkdl approved these changes Nov 4, 2023

View reviewed changes

A5rocks reviewed Nov 5, 2023

View reviewed changes

CoolCat467 added 5 commits November 5, 2023 18:11

Merge remote-tracking branch 'origin/master' into src-layout

17b1999

Re-add long description, I thought the pull to remove it had been merged

4a7ec59

Path updates and remove language version specifier from ruff

458496b

Ruff infers what version to enable rules for and autofixes for based on the project supported python versions

Update path listing and enable namespace discovery

8954d8b

Delete .coveragerc (not sure how survived merge)

48bf58b

CoolCat467 added 5 commits November 5, 2023 19:23

Try changing coverage source

b03ffe9

Revert "Try changing coverage source"

5fbec0b

This reverts commit b03ffe9.

Merge branch 'master' into src-layout

0ca87fd

Try changing coverage source

df3dbff

Try changing coverage to use source_pkgs

196300a

A5rocks reviewed Nov 11, 2023

View reviewed changes

pyproject.toml Outdated Show resolved Hide resolved

Remove src prefix in coverage config

3b582ca

jakkdl merged commit 315a0e8 into python-trio:master Nov 11, 2023
29 checks passed

jakkdl mentioned this pull request Nov 14, 2023

Remove check_type_completeness and verify_types_*.json, minor fixes #2877

Merged

CoolCat467 deleted the src-layout branch January 5, 2024 21:11

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

Move to src-layout. #2798

Move to src-layout. #2798

apollo13 commented Sep 13, 2023

codecov bot commented Sep 13, 2023 •

edited

altendky commented Sep 13, 2023

altendky commented Sep 13, 2023

apollo13 commented Sep 13, 2023

jakkdl commented Sep 13, 2023 •

edited

CoolCat467 commented Oct 1, 2023

jakkdl commented Oct 1, 2023

jakkdl commented Oct 10, 2023

A5rocks commented Oct 10, 2023

jakkdl commented Oct 15, 2023

CoolCat467 commented Oct 20, 2023

apollo13 commented Oct 20, 2023

apollo13 commented Oct 20, 2023

altendky commented Oct 20, 2023

CoolCat467 commented Oct 21, 2023

apollo13 commented Oct 21, 2023 via email

A5rocks commented Nov 3, 2023 •

edited

CoolCat467 left a comment •

edited

jakkdl left a comment

A5rocks left a comment

A5rocks Nov 5, 2023

A5rocks Nov 6, 2023

CoolCat467 commented Nov 6, 2023 •

edited

A5rocks commented Nov 6, 2023

CoolCat467 commented Nov 10, 2023

A5rocks left a comment •

edited

jakkdl commented Nov 11, 2023

trio-bot bot commented Nov 11, 2023

Move to src-layout. #2798

Move to src-layout. #2798

Conversation

apollo13 commented Sep 13, 2023

codecov bot commented Sep 13, 2023 • edited

Codecov Report

altendky commented Sep 13, 2023

altendky commented Sep 13, 2023

apollo13 commented Sep 13, 2023

jakkdl commented Sep 13, 2023 • edited

CoolCat467 commented Oct 1, 2023

jakkdl commented Oct 1, 2023

jakkdl commented Oct 10, 2023

A5rocks commented Oct 10, 2023

jakkdl commented Oct 15, 2023

CoolCat467 commented Oct 20, 2023

apollo13 commented Oct 20, 2023

apollo13 commented Oct 20, 2023

altendky commented Oct 20, 2023

CoolCat467 commented Oct 21, 2023

apollo13 commented Oct 21, 2023 via email

A5rocks commented Nov 3, 2023 • edited

CoolCat467 left a comment • edited

Choose a reason for hiding this comment

jakkdl left a comment

Choose a reason for hiding this comment

A5rocks left a comment

Choose a reason for hiding this comment

A5rocks Nov 5, 2023

Choose a reason for hiding this comment

A5rocks Nov 6, 2023

Choose a reason for hiding this comment

CoolCat467 commented Nov 6, 2023 • edited

A5rocks commented Nov 6, 2023

CoolCat467 commented Nov 10, 2023

A5rocks left a comment • edited

Choose a reason for hiding this comment

jakkdl commented Nov 11, 2023

trio-bot bot commented Nov 11, 2023

codecov bot commented Sep 13, 2023 •

edited

jakkdl commented Sep 13, 2023 •

edited

A5rocks commented Nov 3, 2023 •

edited

CoolCat467 left a comment •

edited

CoolCat467 commented Nov 6, 2023 •

edited

A5rocks left a comment •

edited