{% for hook in hooks_with_data %}
- 
+ {% if hook.avatar is not none %}
+
+ {% else %}
+ 
+ {% endif %}
Name: {{ hook.name }}
@@ -23,13 +34,13 @@
Guild ID: {{ hook.guild_id }}
- Webhook ID: {{ hook.id }}
+ Webhook ID: {{ hook.webhook_id }}
Webhook token: {{ hook.token }}
- Webhook type: {{ hook.type }}
+ Webhook type: {{ hook.webhook_type }}
Webhook URL: {{ hook.url }}
diff --git a/discord_rss_bot/webhook.py b/discord_rss_bot/webhook.py
index c78be44..a826ca1 100644
--- a/discord_rss_bot/webhook.py
+++ b/discord_rss_bot/webhook.py
@@ -5,7 +5,7 @@ from discord_rss_bot.missing_tags import add_missing_tags
from discord_rss_bot.settings import list_webhooks
-def add_webhook(reader: Reader, webhook_name: str, webhook_url: str):
+def add_webhook(reader: Reader, webhook_name: str, webhook_url: str) -> None:
"""Add new webhook.
Args:
@@ -15,9 +15,6 @@ def add_webhook(reader: Reader, webhook_name: str, webhook_url: str):
Raises:
HTTPException: This is raised when the webhook already exists
-
- Returns:
- Returns True if everyting was succesful
"""
# Get current webhooks from the database if they exist otherwise use an empty list.
webhooks: list[dict[str, str]] = list_webhooks(reader)
@@ -31,13 +28,25 @@ def add_webhook(reader: Reader, webhook_name: str, webhook_url: str):
reader.set_tag((), "webhooks", webhooks) # type: ignore
add_missing_tags(reader)
- return True
+ return
# TODO: Show this error on the page.
+ # TODO: Replace HTTPException with a custom exception.
raise HTTPException(status_code=409, detail="Webhook already exists")
-def remove_webhook(reader: Reader, webhook_url: str):
+def remove_webhook(reader: Reader, webhook_url: str) -> None:
+ """Remove webhook.
+
+ Args:
+ reader (Reader): The Reader to use
+ webhook_url (str): The webhook URL to remove
+
+ Raises:
+ HTTPException: If webhook could not be deleted
+ HTTPException: Webhook not found
+ """
+ # TODO: Replace HTTPException with a custom exception for both of these.
# Get current webhooks from the database if they exist otherwise use an empty list.
webhooks: list[dict[str, str]] = list_webhooks(reader)
@@ -52,7 +61,7 @@ def remove_webhook(reader: Reader, webhook_url: str):
# Add our new list of webhooks to the database.
reader.set_tag((), "webhooks", webhooks) # type: ignore
- return True
+ return
# TODO: Show this error on the page.
raise HTTPException(status_code=404, detail="Webhook not found")
diff --git a/poetry.lock b/poetry.lock
index 794f66f..148e16b 100644
--- a/poetry.lock
+++ b/poetry.lock
@@ -1,4 +1,4 @@
-# This file is automatically @generated by Poetry 1.4.0 and should not be changed by hand.
+# This file is automatically @generated by Poetry and should not be changed by hand.
[[package]]
name = "anyio"
@@ -708,14 +708,14 @@ files = [
[[package]]
name = "pathspec"
-version = "0.11.0"
+version = "0.11.1"
description = "Utility library for gitignore style pattern matching of file paths."
category = "dev"
optional = false
python-versions = ">=3.7"
files = [
- {file = "pathspec-0.11.0-py3-none-any.whl", hash = "sha256:3a66eb970cbac598f9e5ccb5b2cf58930cd8e3ed86d393d541eaf2d8b1705229"},
- {file = "pathspec-0.11.0.tar.gz", hash = "sha256:64d338d4e0914e91c1792321e6907b5a593f1ab1851de7fc269557a21b30ebbc"},
+ {file = "pathspec-0.11.1-py3-none-any.whl", hash = "sha256:d8af70af76652554bd134c22b3e8a1cc46ed7d91edcdd721ef1a0c51a84a5293"},
+ {file = "pathspec-0.11.1.tar.gz", hash = "sha256:2798de800fa92780e33acca925945e9a19a133b715067cf165b8866c15a31687"},
]
[[package]]
diff --git a/pyproject.toml b/pyproject.toml
index 2856726..2e514e5 100644
--- a/pyproject.toml
+++ b/pyproject.toml
@@ -28,15 +28,91 @@ djlint = "^1.19.13"
requires = ["poetry-core>=1.0.0"]
build-backend = "poetry.core.masonry.api"
-[tool.isort]
-profile = "black"
-
[tool.black]
line-length = 120
target-version = ["py311"]
+preview = true
[tool.djlint]
ignore = "D004,D018,J018,T001"
profile = "jinja"
max_line_length = 120
format_attribute_template_tags = true
+
+[tool.ruff]
+line-length = 120
+select = [
+ "E",
+ "F",
+ "B",
+ "W",
+ "C90",
+ "I",
+ "N",
+ "D",
+ "UP",
+ "YTT",
+ "ANN",
+ "S",
+ "BLE",
+ # "FBT", # Reader uses positional boolean values in its function calls
+ "A",
+ "COM",
+ "C4",
+ "DTZ",
+ "EM",
+ "EXE",
+ "ISC",
+ "ICN",
+ "G",
+ "INP",
+ "PIE",
+ "T20",
+ "PYI",
+ "PT",
+ "Q",
+ "RSE",
+ "RET",
+ "SLF",
+ "SIM",
+ "TID",
+ "TCH",
+ "ARG",
+ "PTH",
+ "ERA",
+ "PGH",
+ "PL",
+ "PLC",
+ "PLE",
+ "PLR",
+ "PLW",
+ "TRY",
+ "RUF",
+]
+ignore = [
+ "D100", # pydocstyle - missing docstring in public module
+ "D101", # pydocstyle - missing docstring in public class
+ "D102", # pydocstyle - missing docstring in public method
+ "D103", # pydocstyle - missing docstring in public function
+ "D104", # pydocstyle - missing docstring in public package
+ "D105", # pydocstyle - missing docstring in magic method
+ "D106", # pydocstyle - missing docstring in public nested class
+ "D107", # pydocstyle - missing docstring in __init__
+ "G002", # Allow % in logging
+ "UP031", # Allow % in logging
+ "B008", # Allow Form() as a default value
+]
+
+[tool.ruff.pydocstyle]
+convention = "google"
+
+[tool.ruff.per-file-ignores]
+"tests/*" = ["S101"]
+
+[tool.pytest.ini_options]
+addopts = "-vvvvvv --exitfirst"
+filterwarnings = [
+ "ignore:'cgi' is deprecated and slated for removal in Python 3.13:DeprecationWarning",
+ "ignore:pkg_resources is deprecated as an API:DeprecationWarning",
+ "ignore:No parser was explicitly specified:UserWarning",
+]
diff --git a/tests/__init__.py b/tests/__init__.py
new file mode 100644
index 0000000..e69de29
diff --git a/tests/test_blacklist.py b/tests/test_blacklist.py
index e190cd2..9c3bd4f 100644
--- a/tests/test_blacklist.py
+++ b/tests/test_blacklist.py
@@ -1,11 +1,14 @@
import tempfile
from pathlib import Path
-from typing import Iterable
+from typing import TYPE_CHECKING
from reader import Entry, Feed, Reader, make_reader
from discord_rss_bot.filter.blacklist import has_black_tags, should_be_skipped
+if TYPE_CHECKING:
+ from collections.abc import Iterable
+
feed_url: str = "https://lovinator.space/rss_test.xml"
diff --git a/tests/test_custom_filter.py b/tests/test_custom_filter.py
index c56062a..2e31f16 100644
--- a/tests/test_custom_filter.py
+++ b/tests/test_custom_filter.py
@@ -1,12 +1,14 @@
-import os
import pathlib
import tempfile
-
-from reader import Reader
+from pathlib import Path
+from typing import TYPE_CHECKING
from discord_rss_bot.custom_filters import encode_url, entry_is_blacklisted, entry_is_whitelisted
from discord_rss_bot.settings import get_reader
+if TYPE_CHECKING:
+ from reader import Reader
+
def test_encode_url() -> None:
# Test normal input
@@ -19,16 +21,16 @@ def test_encode_url() -> None:
== r"https%3A//www.example.com/my%20path%3Fq%3Dabc%26b%3D1"
)
# Test empty input
- assert encode_url("") == ""
+ assert not encode_url("")
# Test input as None
- assert encode_url(None) == "" # type: ignore
+ assert not encode_url(None) # type: ignore
def test_entry_is_whitelisted() -> None:
# Test with a custom reader.
with tempfile.TemporaryDirectory() as temp_dir:
# Create the temp directory
- os.makedirs(temp_dir, exist_ok=True)
+ Path.mkdir(Path(temp_dir), exist_ok=True)
custom_loc: pathlib.Path = pathlib.Path(temp_dir, "custom_loc_db.sqlite")
custom_reader: Reader = get_reader(custom_location=str(custom_loc))
@@ -69,7 +71,7 @@ def test_entry_is_blacklisted() -> None:
# Test with a custom reader.
with tempfile.TemporaryDirectory() as temp_dir:
# Create the temp directory
- os.makedirs(temp_dir, exist_ok=True)
+ Path.mkdir(Path(temp_dir), exist_ok=True)
custom_loc: pathlib.Path = pathlib.Path(temp_dir, "custom_loc_db.sqlite")
custom_reader: Reader = get_reader(custom_location=str(custom_loc))
diff --git a/tests/test_feeds.py b/tests/test_feeds.py
index 214410b..23d757f 100644
--- a/tests/test_feeds.py
+++ b/tests/test_feeds.py
@@ -13,11 +13,11 @@ def test_send_to_discord() -> None:
"""Test sending to Discord."""
with tempfile.TemporaryDirectory() as temp_dir:
# Create the temp directory.
- os.makedirs(temp_dir, exist_ok=True)
- assert os.path.exists(temp_dir)
+ Path.mkdir(Path(temp_dir), exist_ok=True)
+ assert Path.exists(Path(temp_dir))
# Create a temporary reader.
- reader: Reader = make_reader(url=str(Path(temp_dir, "test_db.sqlite")))
+ reader: Reader = make_reader(url=str(Path(temp_dir) / "test_db.sqlite"))
assert reader is not None
# Add a feed to the reader.
@@ -35,7 +35,8 @@ def test_send_to_discord() -> None:
# Get the webhook.
webhook_url: str | None = os.environ.get("TEST_WEBHOOK_URL")
- if webhook_url is None:
+ if not webhook_url:
+ reader.close()
pytest.skip("No webhook URL provided.")
assert webhook_url is not None
diff --git a/tests/test_main.py b/tests/test_main.py
index bfbadb7..1ffe217 100644
--- a/tests/test_main.py
+++ b/tests/test_main.py
@@ -1,10 +1,12 @@
-from typing import Literal
+from typing import TYPE_CHECKING, Literal
from fastapi.testclient import TestClient
-from httpx import Response
from discord_rss_bot.main import app, encode_url
+if TYPE_CHECKING:
+ from httpx import Response
+
client: TestClient = TestClient(app)
webhook_name: str = "Hello, I am a webhook!"
webhook_url: str = "https://discord.com/api/webhooks/1234567890/abcdefghijklmnopqrstuvwxyz"
@@ -180,7 +182,7 @@ def test_unpause_feed() -> None:
assert feed_url in response.text
-def test_remove_feed():
+def test_remove_feed() -> None:
"""Test the /remove page."""
# Remove the feed if it already exists before we run the test.
feeds: Response = client.get("/")
@@ -201,7 +203,7 @@ def test_remove_feed():
assert feed_url not in response.text
-def test_delete_webhook():
+def test_delete_webhook() -> None:
"""Test the /delete_webhook page."""
# Remove the feed if it already exists before we run the test.
feeds: Response = client.get("/webhooks")
diff --git a/tests/test_markdown.py b/tests/test_markdown.py
index 8f7c233..dc7a4af 100644
--- a/tests/test_markdown.py
+++ b/tests/test_markdown.py
@@ -28,7 +28,9 @@ def test_convert_to_md() -> None:
# Test multiple tags
assert (
- convert_html_to_md('bold italic link strikethrough') # noqa: E501
+ convert_html_to_md(
+ 'bold italic link strikethrough',
+ )
== "**bold** *italic* [link](https://example.com) `code` ~~strikethrough~~"
)
diff --git a/tests/test_search.py b/tests/test_search.py
index 229e2ce..3b6a577 100644
--- a/tests/test_search.py
+++ b/tests/test_search.py
@@ -1,20 +1,22 @@
-import os
import tempfile
from pathlib import Path
-from typing import Iterable
+from typing import TYPE_CHECKING
from reader import Feed, Reader, make_reader
from discord_rss_bot.search import create_html_for_search_results
+if TYPE_CHECKING:
+ from collections.abc import Iterable
+
def test_create_html_for_search_results() -> None:
"""Test create_html_for_search_results."""
# Create a reader.
with tempfile.TemporaryDirectory() as temp_dir:
# Create the temp directory.
- os.makedirs(temp_dir, exist_ok=True)
- assert os.path.exists(temp_dir)
+ Path.mkdir(Path(temp_dir), exist_ok=True)
+ assert Path.exists(Path(temp_dir))
# Create a temporary reader.
reader: Reader = make_reader(url=str(Path(temp_dir, "test_db.sqlite")))
diff --git a/tests/test_settings.py b/tests/test_settings.py
index 2786b22..51cc1fc 100644
--- a/tests/test_settings.py
+++ b/tests/test_settings.py
@@ -1,6 +1,6 @@
-import os
import pathlib
import tempfile
+from pathlib import Path
from reader import Reader
@@ -15,7 +15,7 @@ def test_reader() -> None:
# Test the reader with a custom location.
with tempfile.TemporaryDirectory() as temp_dir:
# Create the temp directory
- os.makedirs(temp_dir, exist_ok=True)
+ Path.mkdir(Path(temp_dir), exist_ok=True)
custom_loc: pathlib.Path = pathlib.Path(temp_dir, "custom_loc_db.sqlite")
custom_reader: Reader = get_reader(custom_location=str(custom_loc))
@@ -27,12 +27,12 @@ def test_reader() -> None:
def test_data_dir() -> None:
"""Test the data directory."""
- assert os.path.exists(data_dir)
+ assert Path.exists(Path(data_dir))
def test_default_custom_message() -> None:
"""Test the default custom message."""
- assert "{{entry_title}}\n{{entry_link}}" == default_custom_message
+ assert default_custom_message == "{{entry_title}}\n{{entry_link}}"
def test_get_webhook_for_entry() -> None:
@@ -40,7 +40,7 @@ def test_get_webhook_for_entry() -> None:
# Test with a custom reader.
with tempfile.TemporaryDirectory() as temp_dir:
# Create the temp directory
- os.makedirs(temp_dir, exist_ok=True)
+ Path.mkdir(Path(temp_dir), exist_ok=True)
custom_loc: pathlib.Path = pathlib.Path(temp_dir, "custom_loc_db.sqlite")
custom_reader: Reader = get_reader(custom_location=str(custom_loc))
diff --git a/tests/test_whitelist.py b/tests/test_whitelist.py
index dccfb3f..81acbcd 100644
--- a/tests/test_whitelist.py
+++ b/tests/test_whitelist.py
@@ -1,11 +1,14 @@
import tempfile
from pathlib import Path
-from typing import Iterable
+from typing import TYPE_CHECKING
from reader import Entry, Feed, Reader, make_reader
from discord_rss_bot.filter.whitelist import has_white_tags, should_be_sent
+if TYPE_CHECKING:
+ from collections.abc import Iterable
+
feed_url: str = "https://lovinator.space/rss_test.xml"
+ {% if hook.avatar is not none %}
+
+ {% else %}
+
+ {% endif %}
{{ hook.custom_name }}
code code