Skip to content

[py] Cleanup tox config #15833

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
May 30, 2025
Merged

[py] Cleanup tox config #15833

merged 1 commit into from
May 30, 2025

Conversation

cgoldberg
Copy link
Contributor

@cgoldberg cgoldberg commented May 30, 2025 •
edited
Loading

User description

💥 What does this PR do?

tox is the tool we use in Python for managing various tasks during local development (linting, doc generation, etc). This PR just cleans up the tox.ini file:

  • rename vallidate-pyproject environment to validate since tox does some weird stuff when names contain non-alpha characters
  • change comment style
  • fix indentation and spacing
  • remove missing test environments in envlist
  • update envlist to include only validate and linting. These are the default tasks that are executed when calling tox with no args.

🔄 Types of changes

  • local dev/build infrastructure

PR Type

Enhancement

Description

  • Renamed validate-pyproject environment to validate

  • Cleaned up comments, indentation, and spacing

  • Removed unused test environments from envlist

  • Updated default envlist to only validate and linting

Changes walkthrough 📝

Relevant files
Configuration changes
tox.ini
Refactored tox.ini: environment renaming and formatting cleanup

py/tox.ini

  • Renamed validate-pyproject environment to validate
  • Improved comment style, indentation, and spacing
  • Removed unused test environments from envlist
  • Updated envlist to include only validate and linting
    		• +29/-22 
    Need help?
  • Type /help how to ... in the comments thread for any questions about Qodo Merge usage.
  • Check out the documentation for more information.
    •

    @selenium-ci selenium-ci added the C-py Python Bindings label May 30, 2025
    @qodo-merge-pro qodo-merge-pro bot added Review effort 1/5 and removed C-py Python Bindings labels May 30, 2025
    @qodo-merge-pro Qodo Merge Pro
    Copy link
    Contributor

    PR Reviewer Guide 🔍

    Here are some key observations to aid the review process:

    ⏱️ Estimated effort to review: 1 🔵⚪⚪⚪⚪
    🧪 No relevant tests
    🔒 No security concerns identified
    ⚡ No major issues detected

    @qodo-merge-pro Qodo Merge Pro
    Copy link
    Contributor

    PR Code Suggestions ✨

    Explore these optional code suggestions:

    CategorySuggestion                                                                                                                                    Impact
    General
    Include all defined environments

    The docs and mypy environments are still defined in the configuration but were
    removed from the envlist. This could lead to confusion as these environments
    exist but won't run by default. Either keep them in the envlist or remove their
    definitions if they're no longer needed.

    py/tox.ini [1-4]

     [tox]
 envlist =
   validate
   linting
+  docs
+  mypy
    • Apply / Chat
    Suggestion importance[1-10]: 5

    __

    Why: The suggestion correctly identifies an inconsistency where docs and mypy environments are defined but excluded from envlist. However, this exclusion appears intentional based on the PR summary, which explicitly mentions removing unused environments from envlist.

    		Low
    • More

    @cgoldberg cgoldberg merged commit 0b19300 into SeleniumHQ:trunk May 30, 2025
    12 checks passed
    @cgoldberg cgoldberg deleted the py-tox-cleanup branch May 30, 2025 20:48
    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
    Review effort 1/5
    Projects
    None yet
    Milestone
    No milestone
    Development

    Successfully merging this pull request may close these issues.
    2 participants
    @cgoldberg @selenium-ci