[lint] Fix E731 warnings, add W rules, and un-exclude docs/

Author: Breakthrough

docs/generate_cli_docs.py

@@ -20,10 +20,10 @@
 currentdir = os.path.dirname(os.path.abspath(inspect.getfile(inspect.currentframe())))
 parentdir = os.path.dirname(currentdir)
 sys.path.insert(0, parentdir)
-# Third-party imports
-import click
+# Third-party imports (must follow sys.path mutation above).
+import click  # noqa: E402
 
-from scenedetect._cli import scenedetect
+from scenedetect._cli import scenedetect  # noqa: E402
 
 StrGenerator = ty.Generator[str, None, None]
 
@@ -80,7 +80,7 @@ def patch_help(s: str, commands: ty.List[str]) -> str:
 
     for command in [command for command in commands if command not in INFO_COMMANDS]:
 
-        def add_link(_match: re.Match) -> str:
+        def add_link(_match: re.Match, command: str = command) -> str:
             return ":ref:`%s <command-%s>`" % (command, command)
 
         s = re.sub("``%s``(?!\\n)" % command, add_link, s)
@@ -116,7 +116,7 @@ def add_backquotes_with_refs(refs: ty.Set[str]) -> ty.Callable[[str], str]:
 
     def _add_backquotes(s: re.Match) -> str:
         to_add: str = s.string[s.start() : s.end()]
-        flag = re.search("-+[\w-]+[^\.\=\s\/]*", to_add)
+        flag = re.search(r"-+[\w-]+[^\.\=\s\/]*", to_add)
         if flag is not None and flag.string[flag.start() : flag.end()] in refs:
             # add cross reference
             cross_ref = flag.string[flag.start() : flag.end()]
@@ -129,7 +129,7 @@ def _add_backquotes(s: re.Match) -> str:
 
 
 def extract_default_value(s: str) -> ty.Tuple[str, ty.Optional[str]]:
-    default = re.search("\[default: .*\]", s)
+    default = re.search(r"\[default: .*\]", s)
     if default is not None:
         span = default.span()
         assert span[1] == len(s)
@@ -145,11 +145,11 @@ def transform_add_option_refs(s: str, refs: ty.List[str]) -> str:
     # TODO: Match prefix of `global option` and add ref to parent `scenedetect` command option.
     # Replace patch to complete this.
     #  -c/--command
-    s = re.sub("-\w/--\w[\w-]*", transform, s)
+    s = re.sub(r"-\w/--\w[\w-]*", transform, s)
     #  --arg=value, --arg=1.2.3, --arg=1,2,3
-    s = re.sub('-+[\w-]+=[^"\s\)]+(?<![\.\,])', transform, s)
+    s = re.sub(r'-+[\w-]+=[^"\s\)]+(?<![\.\,])', transform, s)
     # --args=" command with spaces"
-    s = re.sub('--[\w-]+[=]+".*?"', transform, s)
+    s = re.sub(r'--[\w-]+[=]+".*?"', transform, s)
     return s
 
 
@@ -252,7 +252,9 @@ def create_help() -> ty.Tuple[str, ty.List[str]]:
     ctx = click.Context(scenedetect, info_name=scenedetect.name)
 
     commands: ty.List[str] = ctx.command.list_commands(ctx)
-    commands = list(filter(lambda command: not ctx.command.get_command(ctx, command).hidden, commands))
+    commands = list(
+        filter(lambda command: not ctx.command.get_command(ctx, command).hidden, commands)
+    )
     # ctx.to_info_dict lacks metavar so we have to use the context directly.
     actions = [
         generate_title("``scenedetect`` 🎬 Command", level=0),
@@ -268,7 +270,10 @@ def create_help() -> ty.Tuple[str, ty.List[str]]:
 def main():
     help, commands = create_help()
     help = patch_help(help, commands)
-    help = ".. NOTE: This file is auto-generated by docs/generate_cli_docs.py and should not be modified.\n" + help
+    help = (
+        ".. NOTE: This file is auto-generated by docs/generate_cli_docs.py and should not be modified.\n"
+        + help
+    )
     with open("docs/cli.rst", "wb") as f:
         f.write(help.encode())
 

pyproject.toml

@@ -13,9 +13,6 @@ requires = ["setuptools"]
 build-backend = "setuptools.build_meta"
 
 [tool.ruff]
-exclude = [
-    "docs"
-]
 line-length = 100
 indent-width = 4
 
@@ -31,6 +28,7 @@ select = [
     "B",
     # pycodestyle
     "E",
+    "W",
     # Pyflakes
     "F",
     # isort
@@ -46,8 +44,6 @@ ignore = [
     "F401",
     # TODO: Line too long
     "E501",
-    # TODO: Do not assign a `lambda` expression, use a `def`
-    "E731",
 ]
 fixable = ["ALL"]
 unfixable = []

scenedetect/output/video.py

@@ -129,20 +129,23 @@ def default_formatter(template: str) -> PathFormatter:
     `$START_PTS`, `$END_PTS` (presentation timestamp in milliseconds, accurate for VFR video)
     """
     MIN_DIGITS = 3
-    format_scene_number: PathFormatter = lambda video, scene: (
-        ("%0" + str(max(MIN_DIGITS, math.floor(math.log(video.total_scenes, 10)) + 1)) + "d")
-        % (scene.index + 1)
-    )
-    formatter: PathFormatter = lambda video, scene: Template(template).safe_substitute(
-        VIDEO_NAME=video.name,
-        SCENE_NUMBER=format_scene_number(video, scene),
-        START_TIME=str(scene.start.get_timecode().replace(":", ";")),
-        END_TIME=str(scene.end.get_timecode().replace(":", ";")),
-        START_FRAME=str(scene.start.frame_num),
-        END_FRAME=str(scene.end.frame_num),
-        START_PTS=str(round(scene.start.seconds * 1000)),
-        END_PTS=str(round(scene.end.seconds * 1000)),
-    )
+
+    def format_scene_number(video: VideoMetadata, scene: SceneMetadata) -> str:
+        width = max(MIN_DIGITS, math.floor(math.log(video.total_scenes, 10)) + 1)
+        return ("%0" + str(width) + "d") % (scene.index + 1)
+
+    def formatter(video: VideoMetadata, scene: SceneMetadata) -> str:
+        return Template(template).safe_substitute(
+            VIDEO_NAME=video.name,
+            SCENE_NUMBER=format_scene_number(video, scene),
+            START_TIME=str(scene.start.get_timecode().replace(":", ";")),
+            END_TIME=str(scene.end.get_timecode().replace(":", ";")),
+            START_FRAME=str(scene.start.frame_num),
+            END_FRAME=str(scene.end.frame_num),
+            START_PTS=str(round(scene.start.seconds * 1000)),
+            END_PTS=str(round(scene.end.seconds * 1000)),
+        )
+
     return formatter