Enable docstring ruff checks. NFC (#26806)

Author: sbc100

em-config.py

@@ -4,8 +4,10 @@
 # University of Illinois/NCSA Open Source License.  Both these licenses can be
 # found in the LICENSE file.
 
-"""This is a helper tool which is designed to make it possible
-for other apps to read emscripten's configuration variables
+"""Display emscripten configure file settings.
+
+Helper script which is designed to make it possible for
+other apps to read emscripten's configuration variables
 in a unified way.  Usage:
 
   em-config VAR_NAME

emar.py

@@ -4,8 +4,7 @@
 # University of Illinois/NCSA Open Source License.  Both these licenses can be
 # found in the LICENSE file.
 
-"""Wrapper script around `llvm-ar`.
-"""
+"""Wrapper script around `llvm-ar`."""
 
 import sys
 

emcc.py

@@ -4,7 +4,8 @@
 # University of Illinois/NCSA Open Source License.  Both these licenses can be
 # found in the LICENSE file.
 
-"""emcc - compiler helper script
+"""\
+emcc - compiler helper script
 =============================
 
 emcc is a drop-in replacement for a compiler like gcc or clang.
@@ -18,7 +19,7 @@
                (by default /tmp/emscripten_temp). "2" will save additional emcc-*
                steps, that would normally not be separately produced (so this
                slows down compilation).
-"""
+""" # noqa: D205, D400, D415
 
 import logging
 import os
@@ -104,6 +105,7 @@ class LinkFlag:
 
   A list of these is returned by separate_linker_flags.
   """
+
   value: str
   is_file: int
 
@@ -335,7 +337,6 @@ def separate_linker_flags(newargs):
   - Linker flags include input files and are returned a list of LinkFlag objects.
   - Compiler flags are those to be passed to `clang -c`.
   """
-
   compiler_args = []
   linker_args = []
 
@@ -382,9 +383,7 @@ def get_next_arg():
 
 @ToolchainProfiler.profile_block('setup')
 def phase_setup(state):
-  """Second phase: configure and setup the compiler based on the specified settings and arguments.
-  """
-
+  """Second phase: configure and setup the compiler based on the specified settings and arguments."""
   has_header_inputs = any(get_file_suffix(f) in HEADER_EXTENSIONS for f in options.input_files)
 
   if options.post_link:

emconfigure.py

@@ -4,9 +4,12 @@
 # University of Illinois/NCSA Open Source License.  Both these licenses can be
 # found in the LICENSE file.
 
-"""This is a helper script. It runs ./configure (or cmake,
-etc.) for you, setting the environment variables to use
-emcc and so forth. Usage:
+"""Helper for running ./configure.
+
+This script runs ./configure (or cmake, etc.) for you,
+setting the environment variables to use emcc and so forth.
+
+Usage:
 
   emconfigure ./configure [FLAGS]
 

emmake.py

@@ -4,8 +4,10 @@
 # University of Illinois/NCSA Open Source License.  Both these licenses can be
 # found in the LICENSE file.
 
-"""This is a helper script. It runs make for you, setting
-the environment variables to use emcc and so forth. Usage:
+"""Helper script for running make.
+
+This script runs make with correct environment
+variables to use emcc and so forth. Usage:
 
   emmake make [FLAGS]
 

emranlib.py

@@ -4,7 +4,7 @@
 # University of Illinois/NCSA Open Source License.  Both these licenses can be
 # found in the LICENSE file.
 
-"""emranlib - ranlib helper script
+"""emranlib - ranlib helper script.
 
 This script acts as a frontend replacement for ranlib, and simply invokes
 llvm-ranlib internally.

emrun.py

@@ -8,8 +8,7 @@
 # suppress these upgrade warnings:
 # ruff: noqa: UP015, UP024, UP021, UP025
 
-"""emrun: Implements machinery that allows running a .html page as if it was a
-standard executable file.
+"""emrun: Tool for running an .html page as if it was a standard executable file.
 
 Usage: emrun <options> filename.html <args to program>
 
@@ -136,8 +135,7 @@ def tick():
 
 
 def logi(msg):
-  """Prints a log message to 'info' stdout channel. Always printed.
-  """
+  """Prints a log message to 'info' stdout channel. Always printed."""
   global last_message_time
   with http_mutex:
     sys.stdout.write(msg + '\n')
@@ -147,6 +145,7 @@ def logi(msg):
 
 def logv(msg):
   """Prints a verbose log message to stdout channel.
+
   Only shown if run with --verbose.
   """
   global last_message_time
@@ -158,8 +157,7 @@ def logv(msg):
 
 
 def loge(msg):
-  """Prints an error message to stderr channel.
-  """
+  """Prints an error message to stderr channel."""
   global last_message_time
   with http_mutex:
     sys.stderr.write(msg + '\n')
@@ -174,8 +172,7 @@ def format_eol(msg):
 
 
 def browser_logi(msg):
-  """Prints a message to the browser stdout output stream.
-  """
+  """Prints a message to the browser stdout output stream."""
   global last_message_time
   msg = format_eol(msg)
   browser_stdout_handle.write(msg + '\n')
@@ -184,8 +181,7 @@ def browser_logi(msg):
 
 
 def browser_loge(msg):
-  """Prints a message to the browser stderr output stream.
-  """
+  """Prints a message to the browser stderr output stream."""
   global last_message_time
   msg = format_eol(msg)
   browser_stderr_handle.write(msg + '\n')
@@ -195,7 +191,8 @@ def browser_loge(msg):
 
 def unquote_u(source):
   """Unquotes a unicode string.
-  (translates ascii-encoded utf string back to utf)
+
+  Translates ascii-encoded utf string back to utf.
   """
   result = unquote(source)
   if '%u' in result:
@@ -207,7 +204,7 @@ def unquote_u(source):
 
 
 def delete_emrun_safe_firefox_profile():
-  """Deletes the temporary created Firefox profile (if one exists)"""
+  """Delete the temporary created Firefox profile (if one exists)."""
   global temp_firefox_profile_dir
   if temp_firefox_profile_dir is not None:
     logv('remove_tree("' + temp_firefox_profile_dir + '")')
@@ -329,6 +326,7 @@ def create_emrun_safe_firefox_profile():
 
 def is_browser_process_alive():
   """Returns whether the browser page we spawned is still running.
+
   (note, not perfect atm, in case we are running in detached mode)
   """
   # If navigation to the web page has not yet occurred, we behave as if the
@@ -358,8 +356,9 @@ def is_browser_process_alive():
 
 
 def kill_browser_process():
-  """Kills browser_process and processname_killed_atexit. Also removes the
-  temporary Firefox profile that was created, if one exists.
+  """Kills browser_process and processname_killed_atexit.
+
+  Also removes the temporary Firefox profile that was created, if one exists.
   """
   global browser_process, processname_killed_atexit, current_browser_processes
   if browser_process and browser_process.poll() is None:
@@ -443,14 +442,18 @@ def pid_existed(pid):
     logv('Was unable to detect the browser process that was spawned by emrun. This may occur if the target page was opened in a tab on a browser process that already existed before emrun started up.')
 
 
-# Our custom HTTP web server that will serve the target page to run via .html.
-# This is used so that we can load the page via a http:// URL instead of a
-# file:// URL, since those wouldn't work too well unless user allowed XHR
-# without CORS rules.  Also, the target page will route its stdout and stderr
-# back to here via HTTP requests.
 class HTTPWebServer(socketserver.ThreadingMixIn, HTTPServer):
-  """Log messaging arriving via HTTP can come in out of sequence. Implement a
-  sequencing mechanism to enforce ordered transmission."""
+  """HTTP Server used to serve the target page to run via .html.
+
+  This is used so that we can load the page via a http:// URL instead of a
+  file:// URL, since those wouldn't work too well unless user allowed XHR
+  without CORS rules.  Also, the target page will route its stdout and stderr
+  back to here via HTTP requests.
+
+  Log messaging arriving via HTTP can come in out of sequence. Implement a
+  sequencing mechanism to enforce ordered transmission.
+  """
+
   expected_http_seq_num = 1
   # Stores messages that have arrived out of order, pending for a send as soon
   # as the missing message arrives.  Kept in sorted order, first element is the

emscan-deps.py

@@ -4,7 +4,7 @@
 # University of Illinois/NCSA Open Source License.  Both these licenses can be
 # found in the LICENSE file.
 
-"""emscan-deps - clang-scan-deps helper script
+"""emscan-deps - clang-scan-deps helper script.
 
 This script acts as a frontend replacement for clang-scan-deps.
 """

emscons.py

@@ -1,11 +1,13 @@
 #!/usr/bin/env python3
-"""Wrapping the scons invocation, EMSCRIPTEN_TOOL_PATH is set in the process
-environment, and can be used to locate the emscripten SCons Tool.
+"""Wrapper for the scons invocation.
 
-Example:
+EMSCRIPTEN_TOOL_PATH is set in the process environment, and can be used to
+locate the emscripten SCons Tool.
 
+Example:
 # Load emscripten Tool
 my_env = Environment(tools=['emscripten'], toolpath=[os.environ['EMSCRIPTEN_TOOL_PATH']])
+
 """
 
 import os

emsize.py

@@ -4,7 +4,7 @@
 # University of Illinois/NCSA Open Source License.  Both these licenses can be
 # found in the LICENSE file.
 
-"""Size helper script
+"""Size helper script.
 
 This script acts as a frontend replacement for `size` that supports combining
 JS and wasm output from emscripten.