[py] improve driver logging

[titusfortner]

Description

• Deprecate the current log_file or log_path Service class constructor parameters, which only accepts strings as filenames
• Create new log_output (which matches Java's withLogOutput()) constructor parameter. This parameter that accepts:
  • String for name of file to create (so just like the current methods)
  • TextIOWrapper as an already open file (addresses [🐛 Bug]: PySelenium doesn't support a named pipe as a log file #10703)
  • int (for explicitly specifying subprocess.STDOUT or subprocess.DEVNULL)
• Default for Firefox is now null output instead of geckodriver.log ([🚀 Feature]: Default All Driver Log Output to dev/null #12016)
• If log file selected, Chromium and IE now pipe the whole process output to a file rather than using driver argument (this matches what Java and Ruby do, and captures all driver related output which is nice)
  • EXCEPT - if --append-log or --readable-timestamp are passed (chromium) because those only work with log-file driver argument
• Safari - quiet parameter does not do anything in Apple's driver; it was never removed from prior implementation

Motivation and Context

Make things consistent between drivers and with Java & Ruby

One thing I'm not sure of....
This currently deprecates and warns about the change in default Firefox behavior; I think I'd prefer just changing it and maybe logging a message about the change with a link to the docs (https://www.selenium.dev/documentation/webdriver/drivers/service/#setting-log-output)

Also, I'm not sure I have the typing exactly right? I'm not sure what typing.IO[typing.Any] actually includes.

[codecov-commenter]

Codecov Report

Patch coverage: 96.72% and project coverage change: +0.32 🎉

Comparison is base (7cfd137) 56.56% compared to head (01b90d2) 56.89%.

❗ Current head 01b90d2 differs from pull request most recent head 7ef54af. Consider uploading reports for the commit 7ef54af to get more accurate results

❗ Your organization is not using the GitHub App Integration. As a result you may experience degraded service beginning May 15th. Please install the Github App Integration for your organization. Read more.

Additional details and impacted files

@@ Coverage Diff @@ ## trunk #12103 +/- ## ========================================== + Coverage 56.56% 56.89% +0.32%  ========================================== Files 86 86 Lines 5450 5494 +44 Branches 223 223 ========================================== + Hits 3083 3126 +43  - Misses 2144 2145 +1  Partials 223 223 

Impacted Files	Coverage Δ
py/selenium/types.py	75.00% <0.00%> (ø)
py/selenium/webdriver/common/service.py	89.92% <94.11%> (+0.09%)	⬆️
py/selenium/webdriver/chrome/service.py	85.71% <100.00%> (+2.38%)	⬆️
py/selenium/webdriver/chromium/service.py	90.90% <100.00%> (+5.90%)	⬆️
py/selenium/webdriver/edge/service.py	90.00% <100.00%> (+1.11%)	⬆️
py/selenium/webdriver/firefox/service.py	91.66% <100.00%> (+3.20%)	⬆️
py/selenium/webdriver/ie/service.py	90.00% <100.00%> (+2.00%)	⬆️
py/selenium/webdriver/safari/service.py	73.68% <100.00%> (-0.68%)	⬇️

☔ View full report in Codecov by Sentry.
📢 Do you have feedback about the report comment? Let us know in this issue.

[diemol]

Thank you, @titusfortner!

[vringar]

Thanks for implementing this!
As this got merged in the 4.11 merge window, will it get released on July 21? And are there any beta/preview/nightly artifacts published somewhere to use this immediately?

[titusfortner]

@vringar take a look at #12207

[asottile-sentry]

these file descriptors are never closed leading to ResourceWarnings when this is garbage collected (and leaked fds)