web3.py: v6 Breaking Changes

Hey @MartinThoma, we are in a code merge freeze and late testing phase just to make sure we don’t need to make minor adjustments. If there are no complications, v6.0.0 should be right around the corner 🙂.

To clarify, what do you mean by v7 is released? We’ve opened an issue to start capturing future breaking changes that will go into v7 but that is the only v7-related content at the moment.

I see that this is closed and v7 is ~released~ in planning, but web3==6.0.0 is not yet on PyPI: https://pypi.org/project/web3/#history

Do you know when it will be? How is the procedure to decide when this will be?

I’m very excited about it, as web3 is currently blocking one of my projects from moving to Python 3.11 😅

I see all checkmarks here set 🎉🥳

It would be great to integrate pre-commit within tox to make the dev process faster & easier in a way that developers are not required to manually fix linting issues. To do so, The following modifications would be introduced to tox.ini:

[testenv:lint]
basepython=python3
skip_install = true
deps = pre-commit
commands=
    pre-commit run --all-files --show-diff-on-failure

instead of:

[testenv:lint]
basepython=python
extras=linter
commands=
    flake8 {toxinidir}/web3 {toxinidir}/ens {toxinidir}/ethpm {toxinidir}/tests --exclude {toxinidir}/ethpm/ethpm-spec
    isort --recursive --check-only --diff {toxinidir}/web3/ {toxinidir}/ens/ {toxinidir}/ethpm/ {toxinidir}/tests/
    mypy -p web3 -p ethpm -p ens --config-file {toxinidir}/mypy.ini

And then add code formatters and fixers in the pre-commit config file(.pre-commit-config.yaml) as local hooks like:

  - repo: local
    hooks:
      - id: flake8
        name: Check flake8 syntax
        entry: flake8 web3 ens ethpm tests --exclude ethpm/ethpm-spec
        pass_filenames: false
        language: system
        types: [python]
      - id: isort
        name: Sort imports alphabetically
        entry: isort --recursive --check-only --diff web3 ens ethpm tests
        pass_filenames: false
        language: system
        types: [python]
      - id: mypy
        name: Check mypy static types match
        entry: mypy -p web3 -p ethpm -p ens --config-file mypy.ini
        pass_filenames: false
        language: system
        types: [python]

To add black as @kclowes did in PR:#2345, just add a new local hook in a similar fashion to the previous ones:

      - id: black
        name: Run black code formatter
        entry: black ethpm --exclude ethpm/ethpm-spec web3 ens tests --check
        pass_filenames: false
        language: system
        types: [python]

pre-commit is equipped with useful built-in fixers to automatically format files given certain properties such as:

repos:
  - repo: https://github.com/pre-commit/pre-commit-hooks
    rev: v4.1.0
    hooks:
      - id: trailing-whitespace
      - id: end-of-file-fixer
      - id: check-yaml
      - id: check-json
      - id: pretty-format-json
        args: ['--autofix']
      - id: debug-statements
      - id: mixed-line-ending
        args: ['--fix=lf']
        description: Forces to replace line ending by the UNIX 'lf' character.
      - id: forbid-new-submodules

The good news is that these modifications are backward compatible with the current make and tox configurations, running $ make lint , however, would generate something similar to the following:

What do you think about adding pre-commit? If y’all agree, I will be more than happy to open a PR.

Looks like the #1419 plan is to enable strict bytes length checking by default. At which point I think #1154 could be closed.

The code frozen version is up as v6.0.0-beta.11. Let us know if you see anything!

~Whisper is officially out of Geth distros (latest release notes), so we probably ought to drop support too.~

Not necessary to wait for v6. Support removed in #1791.