✨ feat(cli): et clean

[raxhvl]

🗒️ Description

Introduces uv run et clean.

🔗 Related Issues

closes #976.

✅ Checklist

• All: Set appropriate labels for the changes.
• All: Considered squashing commits to improve commit history.
• All: Added an entry to CHANGELOG.md.
• All: Considered updating the online docs in the ./docs/ directory.
• Tests: Ran mkdocs serve locally and verified the auto-generated docs for new tests in the Test Case Reference are correctly formatted.

[danceratopz]

One thing I do delete every once in a while is the __pycache__ folders.

find src/ -name '__pycache__' -exec rm -rf '{}' \;

We could use glob for this.

@raxhvl, @spencer-tb what do you think?

[spencer-tb]

One thing I do delete every once in a while is the __pycache__ folders.

find src/ -name '__pycache__' -exec rm -rf '{}' \;

We could use glob for this.

@raxhvl, @spencer-tb what do you think?

Definitely agree! Starting fresh without having to reclone for me would the ideal scenario for et clean

I think we should delete cached_downloads/ - the fixtures that are downloaded from the consume command when the input is a url. We could also delete .pyspelling_en.dict.

I'm happy with --all deleting .venv too!

LGTM other than that! Thanks for implementing this @raxhvl - I've wanted this feature for while

[raxhvl]

Would we also need a --dry-run command to inspect whats happening?

[danceratopz]

Would we also need a --dry-run command to inspect whats happening?

👍 This would be wonderful tbh.

[danceratopz]

I think we should delete cached_downloads/ - the fixtures that are downloaded from the consume command when the input is a url.

Up for this, but I'd add it to --all :)

[raxhvl]

How does this look for default vs --all?

  items_to_remove = [".pytest_cache", ".mypy_cache", "fixtures", "build", "site", "cached_downloads", ".pyspelling_en.dict"]

    if all:
         # Delete __pycache__ directories using glob
         pycache_dirs = glob.glob("**/__pycache__", recursive=True)
         items_to_remove.extend(pycache_dirs)
         
         # Environment
         items_to_remove.extend([".tox", ".venv"])

[danceratopz]

How does this look for default vs --all?

  items_to_remove = [".pytest_cache", ".mypy_cache", "fixtures", "build", "site", "cached_downloads", ".pyspelling_en.dict"]

    if all:
         # Delete __pycache__ directories using glob
         pycache_dirs = glob.glob("**/__pycache__", recursive=True)
         items_to_remove.extend(pycache_dirs)
         
         # Environment
         items_to_remove.extend([".tox", ".venv"])

Looks good, only suggestion: I would prefer to delete pycache_dirs without all.

I hope I don't need to use --all very often, but will be happy it exists 🙂

[danceratopz]

@raxhvl @spencer-tb one more location that could be helpful to add to all: The directory containing the cached ethereum/execution-specs forks from the ethereum-spec-evm-resolver, cf this value:
https://github.com/petertdavies/ethereum-spec-evm-resolver/blob/c68756230a27709e10426d5fbe4fa1b142a0b0ee/src/ethereum_spec_evm_resolver/main.py#L43-L45

[raxhvl]

The directory containing the cached ethereum/execution-specs forks from the ethereum-spec-evm-resolver.

Is it this dir Path(platformdirs.user_cache_dir("ethereum-spec-evm-resolver"))? I guess we will have to add platformdirs as a dependency.

[danceratopz]

Really nice! Thanks for adding this @raxhvl! Few minor comments below.

[danceratopz]

Looks good to me! As discussed, feel free to refactor the click CLI docs to use #985.

[raxhvl]

Looks good to me! As discussed, feel free to refactor the click CLI docs to use #985.

Done!

[danceratopz]

Thanks @raxhvl! Nearly there 🙂 two minor comments below.

[raxhvl]

Here is the updated help (truncated):

file for Ethereum execution specifications. The user is prompted to select
  the type of test, the fork to use, and to provide the EIP number and name.
  Based on the inputs, a test file is created in the appropriate directory
  with a rendered template.

  Prompts:

  * Choose the type of test to generate (State or Blockchain)

  * Select the fork where this functionality was introduced

  * Enter the EIP number

  * Enter the EIP name

  Example:

      uv run et make test

Options:
  -h, --help  Show this message and exit.

  Further help: https://ethereum.github.io/execution-spec-tests/main/writing_tests/

Docs:

[danceratopz]

Thanks a lot for this @raxhvl. This will very useful to regular and new contributors alike!