[Bug-Candidate]: Can't install slither on python 3.11

[alephao]

Describe the issue:

One of my CI jobs started failing to install slither and it seems to happen because of the pysha3 dependency when using python > 3.11 : https://github.com/alephao/solidity-template/actions/runs/3440054726/jobs/5738065786

After freezing python to 3.10 it started working again: https://github.com/alephao/solidity-template/actions/runs/3440105452/jobs/5738181105

I had a look on pysha3 repository and looks like it is deprecated and the owner suggests using the sha3 functions from the hashlib module.

Code example to reproduce the issue:

https://github.com/alephao/solidity-template/blob/ff2c556f185275a193b9f07006481ada73eb1c9d/.github/workflows/analyze.yml

Version:

0.9.1

Relevant log output:

Run pip install -r requirements.txt
2
  pip install -r requirements.txt
3
  shell: /usr/bin/bash -e {0}
4
  env:
5
    pythonLocation: /opt/hostedtoolcache/Python/3.11.0/x64
6
    PKG_CONFIG_PATH: /opt/hostedtoolcache/Python/3.11.0/x64/lib/pkgconfig
7
    Python_ROOT_DIR: /opt/hostedtoolcache/Python/3.11.0/x64
8
    Python2_ROOT_DIR: /opt/hostedtoolcache/Python/3.11.0/x64
9
    Python3_ROOT_DIR: /opt/hostedtoolcache/Python/3.11.0/x64
10
    LD_LIBRARY_PATH: /opt/hostedtoolcache/Python/3.11.0/x64/lib
11
Collecting slither-analyzer
12
  Downloading slither_analyzer-0.9.1-py3-none-any.whl (615 kB)
13
     ━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━ 615.0/615.0 kB 49.5 MB/s eta 0:00:00
14
Collecting solc-select
15
  Downloading solc_select-1.0.1-py3-none-any.whl (19 kB)
16
Collecting prettytable>=0.7.2
17
  Downloading prettytable-3.5.0-py3-none-any.whl (26 kB)
18
Collecting pysha3>=1.0.2
19
  Downloading pysha3-1.0.2.tar.gz (829 kB)
20
     ━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━ 829.2/829.2 kB 95.2 MB/s eta 0:00:00
21
  Preparing metadata (setup.py): started
22
  Preparing metadata (setup.py): finished with status 'done'
23
Collecting crytic-compile>=0.2.4
24
  Downloading crytic_compile-0.2.4-py3-none-any.whl (87 kB)
25
     ━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━ 87.7/87.7 kB 30.6 MB/s eta 0:00:00
26
Collecting packaging
27
  Downloading packaging-21.3-py3-none-any.whl (40 kB)
28
     ━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━ 40.8/40.8 kB 7.0 MB/s eta 0:00:00
29
Collecting wcwidth
30
  Downloading wcwidth-0.2.5-py2.py3-none-any.whl (30 kB)
31
Collecting pyparsing!=3.0.5,>=2.0.2
32
  Downloading pyparsing-3.0.9-py3-none-any.whl (98 kB)
33
     ━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━ 98.3/98.3 kB 32.1 MB/s eta 0:00:00
34
Installing collected packages: wcwidth, pysha3, pyparsing, prettytable, crytic-compile, slither-analyzer, packaging, solc-select
35
  DEPRECATION: pysha3 is being installed using the legacy 'setup.py install' method, because it does not have a 'pyproject.toml' and the 'wheel' package is not installed. pip 23.1 will enforce this behaviour change. A possible replacement is to enable the '--use-pep517' option. Discussion can be found at https://github.com/pypa/pip/issues/8559
36
  Running setup.py install for pysha3: started
37
  Running setup.py install for pysha3: finished with status 'error'
38
  error: subprocess-exited-with-error
39
  
40
  × Running setup.py install for pysha3 did not run successfully.
41
  │ exit code: 1
42
  ╰─> [20 lines of output]
43
      running install
44
      /opt/hostedtoolcache/Python/3.11.0/x64/lib/python3.11/site-packages/setuptools/command/install.py:34: SetuptoolsDeprecationWarning: setup.py install is deprecated. Use build and pip and other standards-based tools.
45
        warnings.warn(
46
      running build
47
      running build_py
48
      creating build
49
      creating build/lib.linux-x86_64-cpython-311
50
      copying sha3.py -> build/lib.linux-x86_64-cpython-311
51
      running build_ext
52
      building '_pysha3' extension
53
      creating build/temp.linux-x86_64-cpython-311
54
      creating build/temp.linux-x86_64-cpython-311/Modules
55
      creating build/temp.linux-x86_64-cpython-311/Modules/_sha3
56
      gcc -pthread -Wsign-compare -DNDEBUG -g -fwrapv -O3 -Wall -fPIC -DPY_WITH_KECCAK=1 -I/opt/hostedtoolcache/Python/3.11.0/x64/include/python3.11 -c Modules/_sha3/sha3module.c -o build/temp.linux-x86_64-cpython-311/Modules/_sha3/sha3module.o
57
      In file included from Modules/_sha3/sha3module.c:20:
58
      Modules/_sha3/backport.inc:78:10: fatal error: pystrhex.h: No such file or directory
59
         78 | #include "pystrhex.h"
60
            |          ^~~~~~~~~~~~
61
      compilation terminated.
62
      error: command '/usr/bin/gcc' failed with exit code 1
63
      [end of output]
64
  
65
  note: This error originates from a subprocess, and is likely not a problem with pip.
66
error: legacy-install-failure
67

68
× Encountered error while trying to install package.
69
╰─> pysha3
70

71
note: This is an issue with the package mentioned above, not pip.
72
hint: See above for output from the failure.
73
Error: Process completed with exit code 1.

[elopez]

Thanks for the report @alephao! A PR with a fix is open here: #1454. Many of the crytic tools have this dependency though, so it'll require updating several packages to achieve Python 3.11 compatibility.

Related: #1463, crytic/solc-select#125

[alephao]

Oh, that's great, thanks for the quick reply!

I searched for issues, but did not look into PRs, sorry if it's a duplicate!

If there a list of thing that needs to be updated I'm happy to pick something to help

[Akagi201]

pysha3 is outdated, please use https://docs.python.org/3/library/hashlib.html

[0xalpharush]

We haven't made a release so you will need to install the fix from pip using:
pip install git+https://github.com/crytic/slither@dev
Alternatively, you can downgrade to python 3.10 temporarily.

[0xNadr]

I am having the same issue downgraded python to 3.10.8 but still nothing

[taiyangc]

Is there a plan for a new release to include this fix?

[0xmp]

I ran into a similar issue trying to use slither-read-storage with Python 3.11. In my case it was related to an issue with the web3 package (ethereum/web3.py#2704), and was caught under the following exception
ERROR: in order to use slither-read-storage, you need to install web3.

I don't think there's anything to do here as it will be fixed on its own when the web3 pip package new release gets approved. Downgrading to Python 3.9 worked for me.