[py] Add ruff linter/formatter and fix violations

Author: cgoldberg

py/docs/source/conf.py

@@ -29,100 +29,108 @@
 # -- General configuration -----------------------------------------------------
 
 # If your documentation needs a minimal Sphinx version, state it here.
-#needs_sphinx = '1.0'
+# needs_sphinx = '1.0'
 
 # Add any Sphinx extension module names here, as strings. They can be extensions
 # coming with Sphinx (named 'sphinx.ext.*') or your custom ones.
-extensions = ['sphinx.ext.autodoc', 'sphinx.ext.autosummary', 'sphinx.ext.doctest', 'sphinx.ext.todo', 'sphinx.ext.coverage', 'sphinx.ext.imgmath', 'sphinx.ext.viewcode']
+extensions = [
+    "sphinx.ext.autodoc",
+    "sphinx.ext.autosummary",
+    "sphinx.ext.doctest",
+    "sphinx.ext.todo",
+    "sphinx.ext.coverage",
+    "sphinx.ext.imgmath",
+    "sphinx.ext.viewcode",
+]
 
 # Add any paths that contain templates here, relative to this directory.
-templates_path = ['_templates']
+templates_path = ["_templates"]
 
 # The suffix of source filenames.
-source_suffix = '.rst'
+source_suffix = ".rst"
 
 # The encoding of source files.
-#source_encoding = 'utf-8-sig'
+# source_encoding = 'utf-8-sig'
 
 # The master toctree document.
-master_doc = 'index'
+master_doc = "index"
 
 # General information about the project.
-project = 'Selenium'
-copyright = '2009-2025 Software Freedom Conservancy'
+project = "Selenium"
+copyright = "2009-2025 Software Freedom Conservancy"
 
 # The version info for the project you're documenting, acts as replacement for
 # |version| and |release|, also used in various other places throughout the
 # built documents.
 #
 # The short X.Y version.
-version = '4.33'
+version = "4.33"
 # The full version, including alpha/beta/rc tags.
-release = '4.33.0.202505022255'
+release = "4.33.0.202505022255"
 
 # The language for content autogenerated by Sphinx. Refer to documentation
 # for a list of supported languages.
-#language = None
+# language = None
 
 # There are two options for replacing |today|: either, you set today to some
 # non-false value, then it is used:
-#today = ''
+# today = ''
 # Else, today_fmt is used as the format for a strftime call.
-#today_fmt = '%B %d, %Y'
+# today_fmt = '%B %d, %Y'
 
 # List of patterns, relative to source directory, that match files and
 # directories to ignore when looking for source files.
 exclude_patterns = []
 
 # The reST default role (used for this markup: `text`) to use for all documents.
-#default_role = None
+# default_role = None
 
 # If true, '()' will be appended to :func: etc. cross-reference text.
-#add_function_parentheses = True
+# add_function_parentheses = True
 
 # If true, the current module name will be prepended to all description
 # unit titles (such as .. function::).
-#add_module_names = True
+# add_module_names = True
 
 # If true, sectionauthor and moduleauthor directives will be shown in the
 # output. They are ignored by default.
-#show_authors = False
+# show_authors = False
 
 # The name of the Pygments (syntax highlighting) style to use.
-pygments_style = 'sphinx'
+pygments_style = "sphinx"
 
 # A list of ignored prefixes for module index sorting.
-#modindex_common_prefix = []
+# modindex_common_prefix = []
 
 
 # -- Options for HTML output ---------------------------------------------------
 
 # The theme to use for HTML and HTML Help pages
-html_theme = 'sphinx_material'
+html_theme = "sphinx_material"
 
 # Theme options are theme-specific and customize the look and feel of a theme
 # further.  For a list of options available for each theme, see the
 # documentation.
-#html_theme_options = {}
+# html_theme_options = {}
 
 # Add any paths that contain custom themes here, relative to this directory.
-#html_theme_path = []
+# html_theme_path = []
 
 # The name for this set of Sphinx documents.  If None, it defaults to
 # "<project> v<release> documentation".
-#html_title = None
+# html_title = None
 
 # A shorter title for the navigation bar.  Default is the same as html_title.
-#html_short_title = None
+# html_short_title = None
 
 # The name of an image file (relative to this directory) to place at the top
 # of the sidebar.
-#html_logo = ''
+# html_logo = ''
 
 # The name of an image file (within the static path) to use as favicon of the
 # docs.  This file should be a Windows icon file (.ico) being 16x16 or 32x32
 # pixels large.
-#html_favicon = None
+# html_favicon = None
 
 # Add any paths that contain custom static files (such as style sheets) here,
 # relative to this directory. They are copied after the builtin static files,
@@ -131,18 +139,18 @@
 
 # If not '', a 'Last updated on:' timestamp is inserted at every page bottom,
 # using the given strftime format.
-#html_last_updated_fmt = '%b %d, %Y'
+# html_last_updated_fmt = '%b %d, %Y'
 
 # If true, SmartyPants will be used to convert quotes and dashes to
 # typographically correct entities.
-#html_use_smartypants = True
+# html_use_smartypants = True
 
 # Custom sidebar templates, maps document names to template names.
-#html_sidebars = {}
+# html_sidebars = {}
 
 # Additional templates that should be rendered to pages, maps page names to
 # template names.
-#html_additional_pages = {}
+# html_additional_pages = {}
 
 # If false, no module index is generated.
 html_domain_indices = True
@@ -160,122 +168,126 @@
 html_show_sphinx = False
 
 # If true, "(C) Copyright ..." is shown in the HTML footer. Default is True.
-#html_show_copyright = True
+# html_show_copyright = True
 
 # If true, an OpenSearch description file will be output, and all pages will
 # contain a <link> tag referring to it.  The value of this option must be the
 # base URL from which the finished HTML is served.
-#html_use_opensearch = ''
+# html_use_opensearch = ''
 
 # This is the file name suffix for HTML files (e.g. ".xhtml").
-#html_file_suffix = None
+# html_file_suffix = None
 
 # Output file base name for HTML help builder.
-htmlhelp_basename = 'Seleniumdoc'
+htmlhelp_basename = "Seleniumdoc"
 
 
 # -- Options for LaTeX output --------------------------------------------------
 
 # The paper size ('letter' or 'a4').
-#latex_paper_size = 'letter'
+# latex_paper_size = 'letter'
 
 # The font size ('10pt', '11pt' or '12pt').
-#latex_font_size = '10pt'
+# latex_font_size = '10pt'
 
 # Grouping the document tree into LaTeX files. List of tuples
 # (source start file, target name, title, author, documentclass [howto/manual]).
 latex_documents = [
-    ('index', 'Selenium.tex', 'Selenium Documentation',
-     'plightbo, simon.m.stewart, hbchai, jrhuggins, et al.', 'manual'),
+    (
+        "index",
+        "Selenium.tex",
+        "Selenium Documentation",
+        "plightbo, simon.m.stewart, hbchai, jrhuggins, et al.",
+        "manual",
+    ),
 ]
 
 # The name of an image file (relative to this directory) to place at the top of
 # the title page.
-#latex_logo = None
+# latex_logo = None
 
 # For "manual" documents, if this is true, then toplevel headings are parts,
 # not chapters.
-#latex_use_parts = False
+# latex_use_parts = False
 
 # If true, show page references after internal links.
-#latex_show_pagerefs = False
+# latex_show_pagerefs = False
 
 # If true, show URL addresses after external links.
-#latex_show_urls = False
+# latex_show_urls = False
 
 # Additional stuff for the LaTeX preamble.
-#latex_preamble = ''
+# latex_preamble = ''
 
 # Documents to append as an appendix to all manuals.
-#latex_appendices = []
+# latex_appendices = []
 
 # If false, no module index is generated.
-#latex_domain_indices = True
+# latex_domain_indices = True
 
 
 # -- Options for manual page output --------------------------------------------
 
 # One entry per manual page. List of tuples
 # (source start file, name, description, authors, manual section).
 man_pages = [
-    ('index', 'selenium', 'Selenium Documentation',
-     ['plightbo, simon.m.stewart, hbchai, jrhuggins, et al.'], 1)
+    ("index", "selenium", "Selenium Documentation", ["plightbo, simon.m.stewart, hbchai, jrhuggins, et al."], 1)
 ]
 
 
 # -- Options for Epub output ---------------------------------------------------
 
 # Bibliographic Dublin Core info.
-epub_title = 'Selenium'
-epub_author = 'The Selenium Project'
-epub_publisher = 'The Selenium Project'
-epub_copyright = '2009-2024 Software Freedom Conservancy'
+epub_title = "Selenium"
+epub_author = "The Selenium Project"
+epub_publisher = "The Selenium Project"
+epub_copyright = "2009-2024 Software Freedom Conservancy"
 
 # The language of the text. It defaults to the language option
 # or en if the language is not set.
-#epub_language = ''
+# epub_language = ''
 
 # The scheme of the identifier. Typical schemes are ISBN or URL.
-#epub_scheme = ''
+# epub_scheme = ''
 
 # The unique identifier of the text. This can be a ISBN number
 # or the project homepage.
-#epub_identifier = ''
+# epub_identifier = ''
 
 # A unique identification for the text.
-#epub_uid = ''
+# epub_uid = ''
 
 # HTML files that should be inserted before the pages created by sphinx.
 # The format is a list of tuples containing the path and title.
-#epub_pre_files = []
+# epub_pre_files = []
 
 # HTML files that should be inserted after the pages created by sphinx.
 # The format is a list of tuples containing the path and title.
-#epub_post_files = []
+# epub_post_files = []
 
 # A list of files that should not be packed into the epub file.
-#epub_exclude_files = []
+# epub_exclude_files = []
 
 # The depth of the table of contents in toc.ncx.
-#epub_tocdepth = 3
+# epub_tocdepth = 3
 
 # Allow duplicate toc entries.
-#epub_tocdup = True
+# epub_tocdup = True
 
 
 # Example configuration for intersphinx: refer to the Python standard library.
-intersphinx_mapping = {'http://docs.python.org/': None}
+intersphinx_mapping = {"http://docs.python.org/": None}
 
 # 'members' includes anything that has a docstring, 'undoc-members' includes
 # functions without docstrings.
-autodoc_default_flags = ['members', 'undoc-members']
+autodoc_default_flags = ["members", "undoc-members"]
 
 # configuration for keeping the methods that can be invoked on said classes
 autodoc_default_options = {
-    'members': True,
-    'member-order': 'bysource',
-    'undoc-members': True,
-    'inherited-members': True,
+    "members": True,
+    "member-order": "bysource",
+    "undoc-members": True,
+    "inherited-members": True,
 }
 
 # Include __init__ comments

py/pyproject.toml

@@ -166,6 +166,18 @@ extend-ignore = ["E501", "E203"]
 max-line-length = 120
 min-python-version = "3.9"
 
+[tool.ruff]
+exclude = [
+    "selenium/webdriver/common/devtools/",
+    "private/",
+    "generate.py",
+]
+line-length = 120
+
+[tool.ruff.lint]
+extend-select = ["E501"]
+fixable = ["ALL"]
+
 [tool.docformatter]
 exclude = "selenium/webdriver/common/devtools"
 in-place = true

py/release-selenium.py

@@ -19,9 +19,11 @@
 import sys
 from twine import cli
 
+
 def main():
     cli.configure_output()
     return cli.dispatch(sys.argv[1:])
 
+
 if __name__ == "__main__":
     sys.exit(main())

py/selenium/webdriver/common/action_chains.py

@@ -15,6 +15,7 @@
 # specific language governing permissions and limitations
 # under the License.
 """The ActionChains implementation."""
+
 from __future__ import annotations
 
 from typing import TYPE_CHECKING

py/selenium/webdriver/common/bidi/session.py

@@ -19,7 +19,6 @@
 
 
 class Session:
-
     def __init__(self, conn):
         self.conn = conn
 

py/selenium/webdriver/common/driver_finder.py

@@ -68,11 +68,11 @@ def _binary_paths(self) -> dict:
                 if Path(output["driver_path"]).is_file():
                     self._paths["driver_path"] = output["driver_path"]
                 else:
-                    raise ValueError(f'The driver path is not a valid file: {output["driver_path"]}')
+                    raise ValueError(f"The driver path is not a valid file: {output['driver_path']}")
                 if Path(output["browser_path"]).is_file():
                     self._paths["browser_path"] = output["browser_path"]
                 else:
-                    raise ValueError(f'The browser path is not a valid file: {output["browser_path"]}')
+                    raise ValueError(f"The browser path is not a valid file: {output['browser_path']}")
         except Exception as err:
             msg = f"Unable to obtain driver for {browser}"
             raise NoSuchDriverException(msg) from err

py/selenium/webdriver/common/log.py

@@ -90,7 +90,7 @@ async def mutation_events(self) -> AsyncGenerator[Dict[str, Any], None]:
             yield event
 
         payload = json.loads(evnt.value.payload)
-        elements: list = self.driver.find_elements(By.CSS_SELECTOR, f"*[data-__webdriver_id=\"{payload['target']}\"]")
+        elements: list = self.driver.find_elements(By.CSS_SELECTOR, f'*[data-__webdriver_id="{payload["target"]}"]')
         if not elements:
             elements.append(None)
         event["element"] = elements[0]

py/selenium/webdriver/support/expected_conditions.py

@@ -945,7 +945,7 @@ def any_of_condition(driver: D):
 
 
 def all_of(
-    *expected_conditions: Callable[[D], Union[T, Literal[False]]]
+    *expected_conditions: Callable[[D], Union[T, Literal[False]]],
 ) -> Callable[[D], Union[List[T], Literal[False]]]:
     """An expectation that all of multiple expected conditions is true.