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

pyton312Packages.arelle: 18.3 -> 2.30.25, unbreak, refactor #337284

Open
wants to merge 2 commits into
base: master
Choose a base branch
from

Conversation

TomaSajt
Copy link
Contributor

@TomaSajt TomaSajt commented Aug 25, 2024

Description of changes

The arelle python package was very outdated, the src.rev used no longer existed and the tests were failing on python 3.12 due to imp being used, so bumped the package version, refactored it and updated its dependencies.

For generating the doc output, I had to add another dependency to nixpkgs: sphinx-autodoc2.

For some reason arelle's pyproject.toml uses ~= when specifying the build-system deps, which is unfortunate, since we need to patch those out.

Since this is a bigger change, I added myself as a maintainer.

Things done

  • Built on platform(s)
    • x86_64-linux
    • aarch64-linux
    • x86_64-darwin
    • aarch64-darwin
  • For non-Linux: Is sandboxing enabled in nix.conf? (See Nix manual)
    • sandbox = relaxed
    • sandbox = true
  • 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/)
  • 24.11 Release Notes (or backporting 23.11 and 24.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.

Add a 👍 reaction to pull requests you find important.

@ofborg ofborg bot added 8.has: clean-up 8.has: package (new) This PR adds a new package labels Aug 25, 2024
@ofborg ofborg bot requested a review from roberth August 25, 2024 17:40
@ofborg ofborg bot added 11.by: package-maintainer This PR was created by the maintainer of the package it changes 10.rebuild-darwin: 1-10 10.rebuild-linux: 1-10 labels Aug 25, 2024
@roberth
Copy link
Member

roberth commented Aug 26, 2024

It's been ages since I've used this, so I haven't been a great maintainer for it. I hope you've fixed this because you need it, not because it was on a list of failed packages.

I had to remove arelle-headless package variant, since this newer version doesn't allow separating the gui and non-gui functionality cleanly.

It wasn't very clean in the first place, so this is not a big loss.

Copy link
Member

@roberth roberth left a comment

Choose a reason for hiding this comment

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

Looks like I need to study how python packaging has progressed, but it all looks reasonable.
Also, I'm surprised to see snake-case attributes, but I'm sure they had a reason for that.

Thank you for picking this up!

pkgs/development/python-modules/arelle/default.nix Outdated Show resolved Hide resolved
@wegank wegank added 12.approvals: 1 This PR was reviewed and approved by one reputable person 12.approved-by: package-maintainer This PR was reviewed and approved by a maintainer listed in the package labels Aug 31, 2024
@TomaSajt TomaSajt force-pushed the arelle branch 3 times, most recently from c3fad98 to 4b98052 Compare October 26, 2024 21:01
@ofborg ofborg bot requested a review from roberth October 26, 2024 23:49
@wegank wegank removed 12.approved-by: package-maintainer This PR was reviewed and approved by a maintainer listed in the package 12.approvals: 1 This PR was reviewed and approved by one reputable person labels Oct 29, 2024
@itepastra
Copy link
Member

Result of nixpkgs-review pr 337284 run on x86_64-linux 1

16 packages built:
  • arelle (python312Packages.arelle)
  • arelle.dist (python312Packages.arelle.dist)
  • arelle.doc (python312Packages.arelle.doc)
  • python311Packages.arelle
  • python311Packages.arelle-headless
  • python311Packages.arelle-headless.dist
  • python311Packages.arelle-headless.doc
  • python311Packages.arelle.dist
  • python311Packages.arelle.doc
  • python311Packages.sphinx-autodoc2
  • python311Packages.sphinx-autodoc2.dist
  • python312Packages.arelle-headless
  • python312Packages.arelle-headless.dist
  • python312Packages.arelle-headless.doc
  • python312Packages.sphinx-autodoc2
  • python312Packages.sphinx-autodoc2.dist

@itepastra
Copy link
Member

relevant for ZHF: #352882

@wegank
Copy link
Member

wegank commented Nov 4, 2024

@ofborg build python312Packages.arelle python312Packages.arelle.passthru.tests

Copy link
Member

@natsukium natsukium left a comment

Choose a reason for hiding this comment

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

LGTM

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
Projects
None yet
Development

Successfully merging this pull request may close these issues.

5 participants