Skip to content

[py] Remove deprecated FirefoxBinary class#16811

Merged
cgoldberg merged 7 commits intoSeleniumHQ:trunkfrom
cgoldberg:py-remove-firefox-binary
Dec 30, 2025
Merged

[py] Remove deprecated FirefoxBinary class#16811
cgoldberg merged 7 commits intoSeleniumHQ:trunkfrom
cgoldberg:py-remove-firefox-binary

Conversation

@cgoldberg
Copy link
Member

@cgoldberg cgoldberg commented Dec 30, 2025 •
edited by qodo-code-review bot
Loading

User description

💥 What does this PR do?

This FirefoxBinary class and FirefoxOptions.binary property were deprecated in #13476.

This PR removes the entire firefox_binary module and all tests and attributes that reference it.

🔧 Implementation Notes

This code has been deprecated for 2 years, and most of it doesn't even work correctly because of incorrect platform detection logic. It also does some crazy stuff with windows registry lookups and weird platform-specific stuff that just isn't relevant on modern systems. Rather than fix and maintain it, it's time to remove it.

💡 Additional Considerations

The modern way to specify a custom Firefox location is via binary_location on the Options class or make it available in your system PATH.

🔄 Types of changes

  • Breaking change (fix or feature that would cause existing functionality to change)

PR Type

Enhancement

Description

  • Removes deprecated FirefoxBinary class and entire module

  • Removes binary property from FirefoxOptions class

  • Removes related tests and documentation references

  • Cleans up mypy configuration for Windows registry imports

Diagram Walkthrough

flowchart LR
  A["FirefoxBinary Module"] -->|Removed| B["firefox_binary.py deleted"]
  C["FirefoxOptions.binary"] -->|Removed| D["Use binary_location instead"]
  E["Tests & Docs"] -->|Cleaned up| F["References removed"]
  G["mypy config"] -->|Simplified| H["_winreg entry removed"]
Loading

File Walkthrough
Relevant files
Cleanup
firefox_binary.py
Complete removal of deprecated FirefoxBinary module           

py/selenium/webdriver/firefox/firefox_binary.py

  • Entire file deleted (225 lines removed)
  • Removes deprecated FirefoxBinary class with platform detection logic
  • Removes Windows registry lookup and profile management functionality
  • Removes Linux library path modification code
 +0/-225 
options.py
Remove deprecated binary property from Options                     

py/selenium/webdriver/firefox/options.py

  • Removes import of FirefoxBinary class
  • Removes deprecated binary property getter and setter
  • Keeps binary_location property as the modern alternative
  • Simplifies Options class by removing legacy binary handling
 +0/-15   
Tests
firefox_options_tests.py
Remove deprecated binary property test                                     

py/test/unit/selenium/webdriver/firefox/firefox_options_tests.py

  • Removes import of FirefoxBinary class
  • Removes test test_set_binary_with_firefox_binary that tested
    deprecated property
  • Keeps test_set_binary_with_path test for modern approach
 +0/-5     
Documentation
api.rst
Remove FirefoxBinary from API documentation                           

py/docs/source/api.rst

  • Removes selenium.webdriver.firefox.firefox_binary from autosummary
    documentation
  • Keeps references to firefox_profile, options, and other modules
 +0/-1     
Configuration changes
pyproject.toml
Remove _winreg mypy configuration                                               

py/pyproject.toml

  • Removes mypy configuration section for _winreg module
  • Simplifies mypy configuration by removing Windows registry import
    suppression
 +0/-4     

@selenium-ci selenium-ci added the C-py Python Bindings label Dec 30, 2025
@qodo-code-review
Copy link
Contributor

qodo-code-review bot commented Dec 30, 2025 •
edited
Loading

PR Compliance Guide 🔍

Below is a summary of compliance checks for this PR:

Security Compliance
🟢
No security concerns identified No security vulnerabilities detected by AI analysis. Human verification advised for critical code.
Ticket Compliance
⚪
🎫 No ticket provided
  • Create ticket/issue
Codebase Duplication Compliance
⚪
Codebase context is not defined

Follow the guide to enable codebase context checks.

Custom Compliance
🟢
Generic: Comprehensive Audit Trails

Objective: To create a detailed and reliable record of critical system actions for security analysis
and compliance.

Status: Passed

Learn more about managing compliance generic rules or creating your own custom rules

Generic: Meaningful Naming and Self-Documenting Code

Objective: Ensure all identifiers clearly express their purpose and intent, making code
self-documenting

Status: Passed

Learn more about managing compliance generic rules or creating your own custom rules

Generic: Robust Error Handling and Edge Case Management

Objective: Ensure comprehensive error handling that provides meaningful context and graceful
degradation

Status: Passed

Learn more about managing compliance generic rules or creating your own custom rules

Generic: Secure Error Handling

Objective: To prevent the leakage of sensitive system information through error messages while
providing sufficient detail for internal debugging.

Status: Passed

Learn more about managing compliance generic rules or creating your own custom rules

Generic: Secure Logging Practices

Objective: To ensure logs are useful for debugging and auditing without exposing sensitive
information like PII, PHI, or cardholder data.

Status: Passed

Learn more about managing compliance generic rules or creating your own custom rules

Generic: Security-First Input Validation and Data Handling

Objective: Ensure all data inputs are validated, sanitized, and handled securely to prevent
vulnerabilities

Status: Passed

Learn more about managing compliance generic rules or creating your own custom rules

  • Update
Compliance status legend 🟢 - Fully Compliant
🟡 - Partial Compliant
🔴 - Not Compliant
⚪ - Requires Further Human Verification
🏷️ - Compliance label

@qodo-code-review
Copy link
Contributor

qodo-code-review bot commented Dec 30, 2025 •
edited
Loading

PR Code Suggestions ✨

No code suggestions found for the PR.

navin772
navin772 approved these changes Dec 30, 2025
View reviewed changes
Copy link
Member

@navin772 navin772 left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

LGTM!

@cgoldberg cgoldberg merged commit 3713943 into SeleniumHQ:trunk Dec 30, 2025
42 of 43 checks passed
@cgoldberg cgoldberg deleted the py-remove-firefox-binary branch December 30, 2025 19:26
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Reviewers

@titusfortner titusfortner titusfortner approved these changes

@navin772 navin772 navin772 approved these changes

Assignees

No one assigned

Labels

C-py Python Bindings Review effort 2/5

Projects

None yet

Milestone

No milestone

Development

Successfully merging this pull request may close these issues.

4 participants

@cgoldberg @titusfortner @navin772 @selenium-ci