Upgrade template

[pacrob]

What was wrong?

Pull in updates from the python project template, notably:

• drop python 3.7 support
• use pre-commit for linting
• change the name of the master branch to main

Related to Issue #
Closes #1856 <- needs manual closing
Closes #1942

How was it fixed?

Todo:

• Clean up commit history

• Add or update documentation related to these changes

• Add entry to the release notes

Cute Animal Picture

[reedsa]

This all looks in order, lgtm!

[kclowes]

thanks for taking this on! A few things I noticed:

• It doesn't look like the core, database, difficulty, or vm tests are running
• It looks like some upper pins were removed. I think I'd rather remove them all at the same time, so if that's too much for this PR, let's put those back in setup.py and make an issue to do that another time.
• nit: it looks like precommit gets installed in the make lint section, so I don't think you need the separate build step for all the test runs
• there are a few doc errors that could very well be user error :)

[kclowes]

It may be user error, but I'm not able to get pytest tests to run. We could either do pytest tests/core here, or pick a different command. I'm not sure what the best command to pick would be. I'm also not opposed to removing it altogether since I don't think it's super useful, but would want to check with @fselmo first since he's in here most often.

[pacrob]

It needs the fixtures installed. CI does it with git submodule update --init --recursive, but the dev docs don't appear to mention it. Will add. It's in the contributing docs, git clone --recursive .... Installing Cloning that way allows make test run for me. You? Takes forever though 😄

Also, I'm seeing the tests you mention running in the CI "All checks have passed" list below. Where are you seeing that they didn't run?

[kclowes]

Ah, that was likely my problem. I knew there was something funky to do with the submodule, but couldn't remember how to fix that.

If you look at the output in the run tox step here: https://app.circleci.com/pipelines/github/ethereum/py-evm/2555/workflows/fd9eaa7a-2157-4416-bda6-eaea85711132/jobs/172217
It's running in 17s, and I don't see the actual command for the tests (pytest tests/json-fixtures/test_difficulty.py). Looks like it usually takes ~2 minutes.

[pacrob]

tests running correctly again!

[kclowes]

This may also be user error/not having the right things installed, but I'm seeing a bunch of warnings when I run make build-docs. For example:

• WARNING: autodoc: failed to import module 'run' from module 'scripts.benchmark'; the following exception was raised: No module named 'checks'
• ~/ef/py-evm/docs/tests.rst: WARNING: document isn't included in any toctree
  And:

Document: guides/building_an_app_that_uses_pyevm
------------------------------------------------
**********************************************************************
File "guides/building_an_app_that_uses_pyevm.rst", line 100, in default
Failed example:
    print(f"The balance of address {encode_hex(MOCK_ADDRESS)} is {mock_address_balance} wei"
Exception raised:
    Traceback (most recent call last):
      File "/opt/homebrew/Cellar/python@3.11/3.11.4_1/Frameworks/Python.framework/Versions/3.11/lib/python3.11/doctest.py", line 1351, in __run
        exec(compile(example.source, filename, "single",
             ^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
      File "/Users/eve/ef/py-evm/venv-upgrade-template/lib/python3.11/site-packages/sphinx/ext/doctest.py", line 484, in compile
        return compile(code, name, self.type, flags, dont_inherit)
               ^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
      File "<doctest default[10]>", line 1
        print(f"The balance of address {encode_hex(MOCK_ADDRESS)} is {mock_address_balance} wei"
             ^
    SyntaxError: '(' was never closed
**********************************************************************

Are you seeing those too?

[pacrob]

I get the same errors, which makes me wonder why CI docs tests are passing. Looking into.

[pacrob]

Once tests got running again, this turned out to indeed be a ( I didn't close.

[kclowes]

Do we need the upper bound here?

[kclowes]

Do we want to drop upper pins in this section too for consistency?

[pacrob]

All upper pins gone except for towncrier and hypothesis.

[fselmo]

I'd wait to see if @kclowes' comments are all addressed before merging but lgtm 👍🏼

[pacrob]

I think I've addressed everything you noted, but I'm not sure about:

• nit: it looks like precommit gets installed in the make lint section, so I don't think you need the separate build step for all the test runs

Could you clarify?

[kclowes]

You're installing precommit on all test runs, but I think we just need it for the lint runs? And it looks like it may already get installed.
From the core tests, which shouldn't(?) need precommit:

From the lint tests - looks like a separate step isn't necessary? Not 100% sure on on that point though:
https://app.circleci.com/pipelines/github/ethereum/py-evm/2567/workflows/ea6769c2-b8f2-461b-9153-1aaea76ecb1c/jobs/172736?invite=true#step-109-57_61

[kclowes]

!