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

pythonPackages.slither-analyzer: fixed dependencies (+1 package) #82346

Closed
wants to merge 3 commits into from
Closed

pythonPackages.slither-analyzer: fixed dependencies (+1 package) #82346

wants to merge 3 commits into from

Conversation

@jerengie
Copy link

@jerengie jerengie commented Mar 11, 2020

Motivation for this change

pythonPackage.slither-analyzer can not be built at this moment.
This is due to missing / unlisted dependencies in the package formula.
This PR provides a fix for this and updates the formula to include the existing pythonPackage.pysha3 package.
Additionally, another dependency, crytic-compile, is packaged as pythonPackage.crytic-compile in this PR.

Things done
  • Tested using sandboxing (nix.useSandbox on NixOS, or option sandbox in nix.conf on non-NixOS linux)
  • Built on platform(s)
    • NixOS
    • macOS
    • other Linux distributions
  • Tested via one or more NixOS test(s) if existing and applicable for the change (look inside nixos/tests)
  • Tested compilation of all pkgs that depend on this change using nix-shell -p nixpkgs-review --run "nixpkgs-review wip"
  • Tested execution of all binary files (usually in ./result/bin/)
  • Determined the impact on package closure size (by running nix path-info -S before and after)
  • Ensured that relevant documentation is up to date
  • Fits CONTRIBUTING.md.
postFixup = ''
wrapProgram $out/bin/crytic-compile \
--prefix PATH : "${lib.makeBinPath [ solc ]}"
'';
Copy link
Contributor

@jonringer jonringer Mar 12, 2020

does the package also shell out to solc? if it does, then this wont work if someone imports this as a package.

Copy link
Author

@jerengie jerengie Mar 12, 2020

If used as a standalone tool, yes.
I am not aware of any nix package that depends on this besides slither-analyzer, which also includes this postFixup.

Copy link
Contributor

@asymmetric asymmetric Mar 24, 2020

does the package also shell out to solc? if it does, then this wont work if someone imports this as a package.

@jonringer why is that?

Copy link
Contributor

@jonringer jonringer Mar 24, 2020

because you only wrap the executable, and the python package package has no knowledge of it.

If i had another package which has propagatedBuildInputs = [ cryptic-compile ]; as a dependenccy, then when I call $ my_package_exe and it eventually calls cryptic-compile, which will do something to the effect of subprocess.check_call("solc" ...), then solc won't be present.

If you want the package to do the right thing, you need to patch the call sights inside of only wrapping the entry_points.

Copy link
Contributor

@jonringer jonringer left a comment

there should be 3 commits:

maintainers: add jerengie
pythonPackages.slither-analyzer: fix dependencies
pythonPackages.crytic-compile: init at 0.1.6

maintainers/maintainer-list.nix Show resolved Hide resolved
Copy link
Contributor

@asymmetric asymmetric left a comment

@jerengie thanks, this looks good! (modulo the changes outlined by @jonringer)

Would you consider adding yourself to the maintainers? I'm not using this anymore.

postFixup = ''
wrapProgram $out/bin/crytic-compile \
--prefix PATH : "${lib.makeBinPath [ solc ]}"
'';
Copy link
Contributor

@asymmetric asymmetric Mar 24, 2020

does the package also shell out to solc? if it does, then this wont work if someone imports this as a package.

@jonringer why is that?

pkgs/development/python-modules/crytic-compile/default.nix Outdated Show resolved Hide resolved
@@ -1552,6 +1552,8 @@ in

crudini = callPackage ../tools/misc/crudini { };

crytic-compile = with python3Packages; toPythonApplication crytic-compile;
Copy link
Contributor

@asymmetric asymmetric Mar 24, 2020

Does it make sense to have this in all-packages? Seems like it will mostly be used as a dependency of other packages, so not sure users will want to install it directly very often.

Copy link
Author

@jerengie jerengie Mar 24, 2020

Thanks for this suggestion.
To be honest, I have no idea if users would like to install crytic-compile in a standalone way.
But if desired, it is nice to have the opportunity to do so, isn't it?

Copy link
Member

@FRidh FRidh Mar 29, 2020

No we shouldn't pollute the top-level unnecessarily.

Copy link
Contributor

@asymmetric asymmetric Mar 29, 2020

@jerengie it will still be available under python3Packages, so it can still be installed, just not from the top-level namespace.

@FRidh the manual does say though:

A distinction is made between applications and libraries, however, sometimes a package is used as both. In this case the package is added as a library to python-packages.nix and as an application to all-packages.nix.

Copy link
Member

@FRidh FRidh Mar 29, 2020

@asymmetric yes but if the author of the PR isn't going to use it like that to begin with, should we then add it just for potential users?

Copy link
Contributor

@asymmetric asymmetric Mar 29, 2020

I guess not. Maybe the manual should mention that the package may be added to all-packages.nix.

jerengie added 3 commits Mar 24, 2020
This package can not be build in the current state.
Adding pysha3 and the new crytic-compile package as a dependency fixes this.
Copy link
Member

@FRidh FRidh left a comment

  • patch code to executable
  • remove top-level attribute

@stale
Copy link

@stale stale bot commented Sep 25, 2020

Hello, I'm a bot and I thank you in the name of the community for your contributions.

Nixpkgs is a busy repository, and unfortunately sometimes PRs get left behind for too long. Nevertheless, we'd like to help committers reach the PRs that are still important. This PR has had no activity for 180 days, and so I marked it as stale, but you can rest assured it will never be closed by a non-human.

If this is still important to you and you'd like to remove the stale label, we ask that you leave a comment. Your comment can be as simple as "still important to me". But there's a bit more you can do:

If you received an approval by an unprivileged maintainer and you are just waiting for a merge, you can @ mention someone with merge permissions and ask them to help. You might be able to find someone relevant by using Git blame on the relevant files, or via GitHub's web interface. You can see if someone's a member of the nixpkgs-committers team, by hovering with the mouse over their username on the web interface, or by searching them directly on the list.

If your PR wasn't reviewed at all, it might help to find someone who's perhaps a user of the package or module you are changing, or alternatively, ask once more for a review by the maintainer of the package/module this is about. If you don't know any, you can use Git blame on the relevant files, or GitHub's web interface to find someone who touched the relevant files in the past.

If your PR has had reviews and nevertheless got stale, make sure you've responded to all of the reviewer's requests / questions. Usually when PR authors show responsibility and dedication, reviewers (privileged or not) show dedication as well. If you've pushed a change, it's possible the reviewer wasn't notified about your push via email, so you can always officially request them for a review, or just @ mention them and say you've addressed their comments.

Lastly, you can always ask for help at our Discourse Forum, or more specifically, at this thread or at #nixos' IRC channel.

@jonringer
Copy link
Contributor

@jonringer jonringer commented Sep 29, 2020

stale, and conflicts

I'm closing this PR due to lack of activity, if the PR author would like to pursue this matter again, please re-open the PR and address the concerns.

@jonringer jonringer closed this Sep 29, 2020
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Projects
None yet
Linked issues

Successfully merging this pull request may close these issues.

None yet

4 participants