Merge branch 'main' into pyapp-tests

.github/ISSUE_TEMPLATE/bug_report.md

@@ -13,6 +13,7 @@ A clear and concise description of what the bug is.
 
 **To Reproduce**
 Steps to reproduce the behavior:
+
 1. Go to '...'
 2. Click on '....'
 3. Scroll down to '....'
@@ -25,13 +26,14 @@ A clear and concise description of what you expected to happen.
 If applicable, add screenshots to help explain your problem.
 
 **iSponsorBlockTV server (please complete the following information):**
+
 - OS: [e.g. Docker on linux Arm64, windows]
 - Python version [e.g. 3.7] (no need to fill if running on docker
 
 **Apple TV (please complete the following information):**
+
 - Device: [e.g. Apple TV 4]
 - OS: [e.g. tvOS 15.4]
 
-
 **Additional context**
 Add any other context about the problem here.

.pre-commit-config.yaml

@@ -3,7 +3,7 @@
 # Inspired by textual pre-commit config
 repos:
   - repo: https://github.com/pre-commit/pre-commit-hooks
-    rev: v4.3.0
+    rev: v5.0.0
     hooks:
       - id: check-ast  # simply checks whether the files parse as valid python
       - id: check-builtin-literals  # requires literal syntax when initializing empty or zero python builtin types
@@ -18,22 +18,14 @@ repos:
       - id: end-of-file-fixer  # ensures that a file is either empty, or ends with one newline
       - id: mixed-line-ending  # replaces or checks mixed line ending
       - id: trailing-whitespace  # checks for trailing whitespace
-  - repo: https://github.com/pycqa/isort
-    rev: 5.12.0
+  - repo: https://github.com/astral-sh/ruff-pre-commit
+    rev: v0.8.6
     hooks:
-      - id: isort
-        name: isort (python)
-        language_version: '3.11'
-        args: ["--profile", "black", "--filter-files"]
-  - repo: https://github.com/psf/black
-    rev: 23.1.0
+      - id: ruff
+        args: [ --fix, --exit-non-zero-on-fix ]
+      - id: ruff-format
+  - repo: https://github.com/igorshubovych/markdownlint-cli
+    rev: v0.43.0
     hooks:
-      - id: black
-        language_version: '3.11'
-        args: ["--preview"]
-  - repo: https://github.com/hadialqattan/pycln  # removes unused imports
-    rev: v2.3.0
-    hooks:
-      - id: pycln
-        language_version: "3.11"
-        args: [--all]
+      - id: markdownlint
+        args: ["--fix"]

README.md

@@ -1,14 +1,22 @@
 # iSponsorBlockTV
+
+[![ghcr.io Pulls](https://img.shields.io/badge/dynamic/json?url=https%3A%2F%2Fipitio.github.io%2Fbackage%2Fdmunozv04%2FiSponsorBlockTV%2Fisponsorblocktv.json&query=downloads&logo=github&label=ghcr.io%20pulls&style=flat)](https://ghcr.io/dmunozv04/isponsorblocktv)
+[![Docker Pulls](https://img.shields.io/docker/pulls/dmunozv04/isponsorblocktv?logo=docker&style=flat)](https://hub.docker.com/r/dmunozv04/isponsorblocktv/)
+[![GitHub Release](https://img.shields.io/github/v/release/dmunozv04/isponsorblocktv?logo=GitHub&style=flat)](https://github.com/dmunozv04/iSponsorBlockTV/releases/latest)
+[![GitHub Repo stars](https://img.shields.io/github/stars/dmunozv04/isponsorblocktv?style=flat)](https://github.com/dmunozv04/isponsorblocktv)
+
 Skip sponsor segments in YouTube videos playing on a YouTube TV device (see below for compatibility details).
 
 This project is written in asynchronous python and should be pretty quick.
 
 ## Installation
+
 Check the [wiki](https://github.com/dmunozv04/iSponsorBlockTV/wiki/Installation)
 
 Warning: docker armv7 builds have been deprecated. Amd64 and arm64 builds are still available.
 
 ## Compatibility
+
 Legend: ✅ = Working, ❌ = Not working, ❔ = Not tested
 
 Open an issue/pull request if you have tested a device that isn't listed here.
@@ -29,6 +37,7 @@ Open an issue/pull request if you have tested a device that isn't listed here.
 | Playstation 4/5    |   ✅    |
 
 ## Usage
+
 Run iSponsorBlockTV on a computer that has network access.
 Auto discovery will require the computer to be on the same network as the device during setup.
 The device can also be manually added to iSponsorBlockTV with a YouTube TV code. This code can be found in the settings page of your YouTube application.
@@ -37,6 +46,7 @@ It connects to the device, watches its activity and skips any sponsor segment us
 It can also skip/mute YouTube ads.
 
 ## Libraries used
+
 - [pyytlounge](https://github.com/FabioGNR/pyytlounge) Used to interact with the device
 - asyncio and [aiohttp](https://github.com/aio-libs/aiohttp)
 - [async-cache](https://github.com/iamsinghrajat/async-cache)
@@ -44,9 +54,11 @@ It can also skip/mute YouTube ads.
 - [ssdp](https://github.com/codingjoe/ssdp) Used for auto discovery
 
 ## Projects using this project
+
 - [Home Assistant Addon](https://github.com/bertybuttface/addons/tree/main/isponsorblocktv)
 
 ## Contributing
+
 1. Fork it (<https://github.com/dmunozv04/iSponsorBlockTV/fork>)
 2. Create your feature branch (`git checkout -b my-new-feature`)
 3. Commit your changes (`git commit -am 'Add some feature'`)
@@ -54,8 +66,11 @@ It can also skip/mute YouTube ads.
 5. Create a new Pull Request
 
 ## Contributors
+
 - [dmunozv04](https://github.com/dmunozv04) - creator and maintainer
 - [HaltCatchFire](https://github.com/HaltCatchFire) - updated dependencies and improved skip logic
 - [Oxixes](https://github.com/oxixes) - added support for channel whitelist and minor improvements
+
 ## License
+
 [![GNU GPLv3](https://www.gnu.org/graphics/gplv3-127x51.png)](https://www.gnu.org/licenses/gpl-3.0.en.html)

src/iSponsorBlockTV/dial_client.py

@@ -1,4 +1,5 @@
 """Send out an M-SEARCH request and listening for responses."""
+
 import asyncio
 import socket
 

src/iSponsorBlockTV/main.py

@@ -27,7 +27,7 @@ class DeviceListener:
             logging.Formatter("%(asctime)s - %(name)s - %(levelname)s - %(message)s")
         )
         self.logger.addHandler(sh)
-        self.logger.info(f"Starting device")
+        self.logger.info("Starting device")
         self.lounge_controller = ytlounge.YtLoungeApi(
             device.screen_id, config, api_helper, self.logger, self.web_session
         )
@@ -131,7 +131,6 @@ class DeviceListener:
         await asyncio.create_task(self.api_helper.mark_viewed_segments(uuids))
         await asyncio.create_task(self.lounge_controller.seek_to(position))
 
-    # Stops the connection to the device
     async def cancel(self):
         self.cancelled = True
         try:
@@ -140,9 +139,15 @@ class DeviceListener:
             pass
 
 
-async def finish(devices):
-    for i in devices:
-        await i.cancel()
+async def finish(devices, web_session, tcp_connector):
+    for device in devices:
+        await device.cancel()
+    await web_session.close()
+    await tcp_connector.close()
+
+
+def handle_signal(signum, frame):
+    raise KeyboardInterrupt()
 
 
 def main(config, debug):
@@ -160,11 +165,15 @@ def main(config, debug):
         devices.append(device)
         tasks.append(loop.create_task(device.loop()))
         tasks.append(loop.create_task(device.refresh_auth_loop()))
-    signal(SIGINT, lambda s, f: loop.stop())
-    signal(SIGTERM, lambda s, f: loop.stop())
+    signal(SIGTERM, handle_signal)
+    signal(SIGINT, handle_signal)
+    try:
         loop.run_forever()
+    except KeyboardInterrupt:
         print("Cancelling tasks and exiting...")
-    loop.run_until_complete(finish(devices))
-    loop.run_until_complete(web_session.close())
-    loop.run_until_complete(tcp_connector.close())
+        for task in tasks:
+            task.cancel()
+        loop.run_until_complete(asyncio.gather(*tasks, return_exceptions=True))
+        loop.run_until_complete(finish(devices, web_session, tcp_connector))
+    finally:
         loop.close()

src/iSponsorBlockTV/setup_wizard.py

@@ -328,9 +328,9 @@ class AddDevice(ModalWithClickExit):
 
     @on(Input.Changed, "#pairing-code-input")
     def changed_pairing_code(self, event: Input.Changed):
-        self.query_one("#add-device-pin-add-button").disabled = (
-            not event.validation_result.is_valid
-        )
+        self.query_one(
+            "#add-device-pin-add-button"
+        ).disabled = not event.validation_result.is_valid
 
     @on(Input.Submitted, "#pairing-code-input")
     @on(Button.Pressed, "#add-device-pin-add-button")
@@ -377,9 +377,9 @@ class AddDevice(ModalWithClickExit):
 
     @on(SelectionList.SelectedChanged, "#dial-devices-list")
     def changed_device_list(self, event: SelectionList.SelectedChanged):
-        self.query_one("#add-device-dial-add-button").disabled = (
-            not event.selection_list.selected
-        )
+        self.query_one(
+            "#add-device-dial-add-button"
+        ).disabled = not event.selection_list.selected
 
 
 class AddChannel(ModalWithClickExit):