Skip to content

clean up packages dir with every tool version check #238

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.

Sign up for GitHub

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

Jump to bottom
Merged
merged 1 commit into from
Jul 31, 2025
Merged

clean up packages dir with every tool version check #238

merged 1 commit into from
Jul 31, 2025

Conversation

Jason2866
Copy link

@Jason2866 Jason2866 commented Jul 31, 2025 •
edited by coderabbitai bot
Loading

Description:

by removing all folder containing a @

Checklist:

  • The pull request is done against the latest develop branch
  • Only relevant files were touched
  • Only one feature/fix was added per PR, more changes are allowed when changing boards.json
  • I accept the CLA

Summary by CodeRabbit

  • Refactor
    • Improved and centralized the cleanup of versioned tool directories for more consistent and reliable tool management.
    • Enhanced error handling and logging during directory cleanup.
    • Minor corrections to spelling in comments for improved clarity.

@coderabbitai coderabbitai
Copy link

coderabbitai bot commented Jul 31, 2025 •
edited
Loading

Walkthrough

The update refactors the Espressif32Platform class in platform.py by introducing a dedicated method to clean up versioned tool directories. This method is now used consistently before tool version checks and reinstallations, replacing previously scattered cleanup logic. Minor comment corrections are also included.

Changes

Cohort / File(s) Change Summary
Tool Directory Cleanup Refactor
platform.py		 Introduced _cleanup_versioned_tool_directories method; centralized and unified tool directory cleanup; removed redundant cleanup code; corrected comment spelling.

Sequence Diagram(s)

sequenceDiagram
    participant User
    participant Espressif32Platform

    User->>Espressif32Platform: Initiate tool version check or installation
    Espressif32Platform->>Espressif32Platform: _cleanup_versioned_tool_directories(tool_name)
    Espressif32Platform->>Espressif32Platform: _check_tool_version(tool_name)
    alt Tool needs reinstall
        Espressif32Platform->>Espressif32Platform: _handle_existing_tool(tool_name)
        Espressif32Platform->>Espressif32Platform: Remove main tool directory
    end
    Espressif32Platform->>User: Continue with tool usage
Loading

Estimated code review effort

🎯 2 (Simple) | ⏱️ ~8 minutes

Possibly related PRs

Poem

In the warren of code, a tidy-up spree,
Old tool versions swept out, as neat as can be.
A single new method, to clean with great care—
No more cluttered corners, just fresh, open air!
🐇✨

Note

⚡️ Unit Test Generation is now available in beta!

Learn more here, or try it out under "Finishing Touches" below.

📜 Recent review details

Configuration used: CodeRabbit UI
Review profile: CHILL
Plan: Pro

📥 Commits

Reviewing files that changed from the base of the PR and between f2ba45c and 11b9040.

📒 Files selected for processing (1)
  • platform.py (5 hunks)
🧰 Additional context used
🧠 Learnings (2)
📓 Common learnings 
Learnt from: Jason2866
PR: pioarduino/platform-espressif32#225
File: builder/main.py:99-108
Timestamp: 2025-07-13T20:03:29.695Z
Learning: In the ESP32 platform builder, the subprocess call to get site-packages directory in setup_python_paths() function is intentionally left without error handling because if this basic Python operation fails, it indicates a fundamental system issue that would cause the entire build process to fail anyway.

Learnt from: Jason2866
PR: pioarduino/platform-espressif32#237
File: platform.py:200-201
Timestamp: 2025-07-29T11:35:26.182Z
Learning: In platform.py, the `tool-esp_install` package intentionally transitions from mandatory to optional status after successful installation. Initially it's needed and mandatory for installation, but becomes optional once installed since it's no longer required for subsequent operations. Setting `self.packages[tl_install_name]["optional"] = True` after version verification is the intended design pattern.
platform.py (2)

Learnt from: Jason2866
PR: #237
File: platform.py:200-201
Timestamp: 2025-07-29T11:35:26.182Z
Learning: In platform.py, the tool-esp_install package intentionally transitions from mandatory to optional status after successful installation. Initially it's needed and mandatory for installation, but becomes optional once installed since it's no longer required for subsequent operations. Setting self.packages[tl_install_name]["optional"] = True after version verification is the intended design pattern.

Learnt from: Jason2866
PR: #225
File: builder/main.py:99-108
Timestamp: 2025-07-13T20:03:29.695Z
Learning: In the ESP32 platform builder, the subprocess call to get site-packages directory in setup_python_paths() function is intentionally left without error handling because if this basic Python operation fails, it indicates a fundamental system issue that would cause the entire build process to fail anyway.

⏰ Context from checks skipped due to timeout of 90000ms. You can increase the timeout in your CodeRabbit configuration to a maximum of 15 minutes (900000ms). (20)
  • GitHub Check: build (macos-15, examples/espidf-arduino-littlefs)
  • GitHub Check: build (macos-15, examples/arduino-NimBLE-ext_client)
  • GitHub Check: build (macos-15, examples/arduino-wifiscan)
  • GitHub Check: build (macos-15, examples/tasmota)
  • GitHub Check: build (windows-latest, examples/espidf-peripherals-usb)
  • GitHub Check: build (macos-15, examples/arduino-blink)
  • GitHub Check: build (windows-latest, examples/espidf-hello-world)
  • GitHub Check: build (windows-latest, examples/espidf-arduino-blink)
  • GitHub Check: build (windows-latest, examples/espidf-coap-server)
  • GitHub Check: build (windows-latest, examples/espidf-exceptions)
  • GitHub Check: build (windows-latest, examples/arduino-zigbee-switch)
  • GitHub Check: build (windows-latest, examples/espidf-arduino-littlefs)
  • GitHub Check: build (windows-latest, examples/arduino-matter-light)
  • GitHub Check: build (windows-latest, examples/arduino-NimBLE-ext_client)
  • GitHub Check: build (windows-latest, examples/arduino-wifiscan)
  • GitHub Check: build (windows-latest, examples/arduino-blink)
  • GitHub Check: build (ubuntu-latest, examples/espidf-ulp)
  • GitHub Check: build (ubuntu-latest, examples/espidf-arduino-blink)
  • GitHub Check: build (ubuntu-latest, examples/tasmota)
  • GitHub Check: build (ubuntu-latest, examples/espidf-arduino-matter-light)
🔇 Additional comments (4)
platform.py (4)

276-276: LGTM! Spelling corrections improve consistency.

The corrections from "backwards" to "backward" improve terminology consistency throughout the codebase.

Also applies to: 301-301, 309-309

325-352: Excellent refactoring! Cleanup logic is now centralized and consistent.

The new _cleanup_versioned_tool_directories method effectively consolidates previously scattered cleanup logic. The implementation:

  • Uses existing safe file operation patterns
  • Includes comprehensive error handling and logging
  • Covers all relevant directory patterns (@ symbols and version suffixes)
  • Follows the established code style and conventions

This improves maintainability and ensures consistent cleanup behavior across the codebase.

417-418: Strategic placement ensures cleanup happens before version checks.

Calling _cleanup_versioned_tool_directories at the start of _check_tool_version is well-positioned to ensure cleanup occurs before any version verification, which aligns with the PR objective of cleaning up packages directory with every tool version check.

511-515: Good refactoring eliminates redundant cleanup operations.

The simplified logic correctly relies on the cleanup already performed in _check_tool_version, avoiding code duplication while maintaining the necessary directory removal before reinstallation.

✨ Finishing Touches
  • 📝 Generate Docstrings
🧪 Generate unit tests
  • Create PR with unit tests
  • Post copyable unit tests in a comment
  • Commit unit tests in branch remove_at_dirs

Thanks for using CodeRabbit! It's free for OSS, and your support helps us grow. If you like it, consider giving us a shout-out.

❤️ Share
🪧 Tips

Chat

There are 3 ways to chat with CodeRabbit:

  • Review comments: Directly reply to a review comment made by CodeRabbit. Example:
    • I pushed a fix in commit <commit_id>, please review it.
    • Explain this complex logic.
    • Open a follow-up GitHub issue for this discussion.
  • Files and specific lines of code (under the "Files changed" tab): Tag @coderabbitai in a new review comment at the desired location with your query. Examples:
    • @coderabbitai explain this code block.
    • @coderabbitai modularize this function.
  • PR comments: Tag @coderabbitai in a new PR comment to ask questions about the PR branch. For the best results, please provide a very specific query, as very limited context is provided in this mode. Examples:
    • @coderabbitai gather interesting stats about this repository and render them as a table. Additionally, render a pie chart showing the language distribution in the codebase.
    • @coderabbitai read src/utils.ts and explain its main purpose.
    • @coderabbitai read the files in the src/scheduler package and generate a class diagram using mermaid and a README in the markdown format.
    • @coderabbitai help me debug CodeRabbit configuration file.

Support

Need help? Create a ticket on our support page for assistance with any issues or questions.

Note: Be mindful of the bot's finite context window. It's strongly recommended to break down tasks such as reading entire modules into smaller chunks. For a focused discussion, use review comments to chat about specific files and their changes, instead of using the PR comments.

CodeRabbit Commands (Invoked using PR comments)

  • @coderabbitai pause to pause the reviews on a PR.
  • @coderabbitai resume to resume the paused reviews.
  • @coderabbitai review to trigger an incremental review. This is useful when automatic reviews are disabled for the repository.
  • @coderabbitai full review to do a full review from scratch and review all the files again.
  • @coderabbitai summary to regenerate the summary of the PR.
  • @coderabbitai generate docstrings to generate docstrings for this PR.
  • @coderabbitai generate sequence diagram to generate a sequence diagram of the changes in this PR.
  • @coderabbitai generate unit tests to generate unit tests for this PR.
  • @coderabbitai resolve resolve all the CodeRabbit review comments.
  • @coderabbitai configuration to show the current CodeRabbit configuration for the repository.
  • @coderabbitai help to get help.

Other keywords and placeholders

  • Add @coderabbitai ignore anywhere in the PR description to prevent this PR from being reviewed.
  • Add @coderabbitai summary to generate the high-level summary at a specific location in the PR description.
  • Add @coderabbitai anywhere in the PR title to generate the title automatically.

CodeRabbit Configuration File (.coderabbit.yaml)

  • You can programmatically configure CodeRabbit by adding a .coderabbit.yaml file to the root of your repository.
  • Please see the configuration documentation for more information.
  • If your editor has YAML language server enabled, you can add the path at the top of this file to enable auto-completion and validation: # yaml-language-server: $schema=https://coderabbit.ai/integrations/schema.v2.json

Documentation and Community

  • Visit our Documentation for detailed information on how to use CodeRabbit.
  • Join our Discord Community to get help, request features, and share feedback.
  • Follow us on X/Twitter for updates and announcements.

@Jason2866
Copy link
Author

@coderabbitai full review

@coderabbitai coderabbitai
Copy link

coderabbitai bot commented Jul 31, 2025

✅ Actions performed

Full review triggered.

@Jason2866 Jason2866 merged commit 1d14f77 into develop Jul 31, 2025
68 checks passed
@Jason2866 Jason2866 deleted the remove_at_dirs branch July 31, 2025 17:37
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Reviewers
No reviews
Assignees
No one assigned
Labels
None yet
Projects
None yet
Milestone
No milestone
Development

Successfully merging this pull request may close these issues.
1 participant
@Jason2866