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

python310Packages.buildPythonPackage: introduce pyproject option #254136

Merged
merged 5 commits into from
Sep 14, 2023

Conversation

figsoda
Copy link
Member

@figsoda figsoda commented Sep 9, 2023

Description of changes

#253154

adds the pyproject option that conflicts with format, where pyproject = true is equivalent to format = "pyproject", and pyproject = false is equivalent to format = "other", and 3 more commits to demonstrate the conversion of format = "pyproject" | "setuptools" | "other" to the pyproject option

Things done

  • Built on platform(s)
    • x86_64-linux
    • aarch64-linux
    • x86_64-darwin
    • aarch64-darwin
  • For non-Linux: Is sandbox = true set in nix.conf? (See Nix manual)
  • Tested, as applicable:
  • Tested compilation of all packages that depend on this change using nix-shell -p nixpkgs-review --run "nixpkgs-review rev HEAD". Note: all changes have to be committed, also see nixpkgs-review usage
  • Tested basic functionality of all binary files (usually in ./result/bin/)
  • 23.11 Release Notes (or backporting 23.05 Release notes)
    • (Package updates) Added a release notes entry if the change is major or breaking
    • (Module updates) Added a release notes entry if the change is significant
    • (Module addition) Added a release notes entry if adding a new NixOS module
  • Fits CONTRIBUTING.md.

@pbsds
Copy link
Member

pbsds commented Sep 9, 2023

The documentation here needs some love

@figsoda figsoda requested a review from mweinelt as a code owner September 9, 2023 14:53
@github-actions github-actions bot added the 8.has: documentation This PR adds or changes documentation label Sep 9, 2023
@figsoda
Copy link
Member Author

figsoda commented Sep 9, 2023

The documentation here needs some love

replaced all the formats in the documentation with pyproject

* `pyproject`: Whether the pyproject format should be used. When set to `true`,
`pypaBuildHook` will be used, and you can add the required build dependencies
from `build-system.requires` to `nativeBuildInputs`. Note that the pyproject
format falls back to using `setuptools`, so you can use `pyproject = true`
Copy link
Member

Choose a reason for hiding this comment

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

How? setuptools is not supposed to be available by default.

Copy link
Member Author

@figsoda figsoda Sep 9, 2023

Choose a reason for hiding this comment

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

by that I mean pypaBuildHook will try to use setuptools even if pyproject.toml doesn't exist, but it still needs to be added to nativeBuildInputs

@figsoda
Copy link
Member Author

figsoda commented Sep 12, 2023

fixed merge conflicts

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
6.topic: python 8.has: documentation This PR adds or changes documentation 10.rebuild-darwin: 1-10 10.rebuild-darwin: 1 10.rebuild-linux: 1-10 10.rebuild-linux: 1 11.by: package-maintainer This PR was created by the maintainer of the package it changes 12.approvals: 1 This PR was reviewed and approved by one reputable person
Projects
None yet
Development

Successfully merging this pull request may close these issues.

5 participants