feat: add python pep embeds (#71)

* feat: add python pep embeds

* Update src/byte/lib/utils.py

* chore: clean up commons imports

* feat: ``ExtendedEmbed`` with convenience methods (#72)

feat: `ExtendedEmbed` and some convenience methods

Co-authored-by: Alc-Alc <alc@localhost>

* chore: 404 no pep found made ephemeral

* feat: finalize pep embed format

---------

Co-authored-by: Alc-Alc <[email protected]>
Co-authored-by: Alc-Alc <alc@localhost>

Author: 3 people

pdm.lock

@@ -157,10 +157,10 @@ exclude = [
 pythonVersion = "3.11"
 reportOptionalMemberAccess = false
 reportUnknownMemberType = false
-reportGeneralTypeIssues = false
+reportGeneralTypeIssues = true
 
 [tool.mypy]
-namespace_packages = true # discord.py
+namespace_packages = true # discord.Githupy
 disallow_any_generics = false
 disallow_incomplete_defs = true
 disallow_untyped_decorators = false

pyproject.toml

@@ -1,8 +1,10 @@
 """Byte library module."""
 
-from byte.lib import settings, utils
+from byte.lib import common, log, settings, utils
 
 __all__ = [
     "settings",
     "utils",
+    "log",
+    "common",
 ]

src/byte/lib/__init__.py

@@ -0,0 +1,13 @@
+"""Common variables and functions for use throughout Byte.
+
+.. todo:: temporary, these are not multi-guild friendly.
+"""
+
+from byte.lib.common import assets, colors, guilds, links
+
+__all__ = (
+    "assets",
+    "colors",
+    "guilds",
+    "links",
+)

src/byte/lib/common/__init__.py

@@ -0,0 +1,11 @@
+"""Common variables and functions for use throughout Byte.
+
+.. todo:: temporary, these are not multi-guild friendly.
+"""
+from typing import Final
+
+# --- Assets
+litestar_logo_white: Final = "https://raw.githubusercontent.com/litestar-org/branding/main/assets/Branding%20-%20PNG%20-%20Transparent/Badge%20-%20White.png"
+litestar_logo_yellow: Final = "https://raw.githubusercontent.com/litestar-org/branding/main/assets/Branding%20-%20PNG%20-%20Transparent/Badge%20-%20Blue%20and%20Yellow.png"
+ruff_logo: Final = "https://raw.githubusercontent.com/JacobCoffee/byte/main/assets/ruff.png"
+python_logo: Final = "https://raw.githubusercontent.com/JacobCoffee/byte/main/assets/python.png"

src/byte/lib/common/assets.py

@@ -0,0 +1,12 @@
+"""Common variables and functions for use throughout Byte.
+
+.. todo:: temporary, these are not multi-guild friendly.
+"""
+from typing import Final
+
+# --- Colors
+litestar_blue: Final = 0x7289DA
+python_blue: Final = 0x4B8BBE
+python_yellow: Final = 0xFFD43B
+astral_yellow: Final = 0xD7FF64
+astral_purple: Final = 0x261230

src/byte/lib/common/colors.py

@@ -0,0 +1,8 @@
+"""Common variables and functions for use throughout Byte.
+
+.. todo:: temporary, these are not multi-guild friendly.
+"""
+from typing import Final
+
+# --- Channel IDs
+litestar_help_channel: Final = 1064114019373432912

src/byte/lib/common/guilds.py

@@ -13,11 +13,3 @@
 mcve: Final = "https://stackoverflow.com/help/minimal-reproducible-example"
 pastebin: Final = "https://paste.pythondiscord.com"
 markdown_guide: Final = "https://support.discord.com/hc/en-us/articles/210298617-Markdown-Text-101-Chat-Formatting-Bold-Italic-Underline-#h_01GY0DAKGXDEHE263BCAYEGFJA"
-
-# --- Assets
-litestar_logo_white: Final = "https://raw.githubusercontent.com/litestar-org/branding/main/assets/Branding%20-%20PNG%20-%20Transparent/Badge%20-%20White.png"
-litestar_logo_yellow: Final = "https://raw.githubusercontent.com/litestar-org/branding/main/assets/Branding%20-%20PNG%20-%20Transparent/Badge%20-%20Blue%20and%20Yellow.png"
-ruff_logo: Final = "https://raw.githubusercontent.com/JacobCoffee/byte/main/assets/ruff.png"
-
-# --- Channel IDs
-litestar_help_channel: Final = 1064114019373432912

src/byte/lib/common.py src/byte/lib/common/links.pysrc/byte/lib/common.py renamed to src/byte/lib/common/links.py

@@ -4,6 +4,8 @@
 import json
 import re
 import subprocess
+from datetime import UTC, datetime
+from enum import StrEnum
 from itertools import islice
 from typing import TYPE_CHECKING, TypedDict, TypeVar
 
@@ -13,7 +15,7 @@
 from ruff.__main__ import find_ruff_bin  # type: ignore[import-untyped]
 
 from byte.lib import settings
-from byte.lib.common import pastebin
+from byte.lib.common.links import pastebin
 
 if TYPE_CHECKING:
     from collections.abc import Iterable
@@ -22,45 +24,122 @@
     from discord.ext.commands import Context
     from discord.ext.commands._types import Check
 
+__all__ = (
+    "BaseRuffRule",
+    "RuffRule",
+    "FormattedRuffRule",
+    "PEP",
+    "is_byte_dev",
+    "linker",
+    "mention_user",
+    "mention_user_nickname",
+    "mention_channel",
+    "mention_role",
+    "mention_slash_command",
+    "mention_custom_emoji",
+    "mention_custom_emoji_animated",
+    "mention_timestamp",
+    "mention_guild_navigation",
+    "format_ruff_rule",
+    "query_all_ruff_rules",
+    "run_ruff_format",
+    "paste",
+    "chunk_sequence",
+    "query_all_peps",
+)
+
 _T = TypeVar("_T")
 
 
 class BaseRuffRule(TypedDict):
+    """Base Ruff rule data."""
+
     name: str
     summary: str
     fix: str
     explanation: str
 
 
 class RuffRule(BaseRuffRule):
+    """Ruff rule data."""
+
     code: str
     linter: str
     message_formats: list[str]
     preview: bool
 
 
 class FormattedRuffRule(BaseRuffRule):
+    """Formatted Ruff rule data."""
+
     rule_link: str
     rule_anchor_link: str
 
 
-__all__ = (
-    "is_byte_dev",
-    "linker",
-    "mention_user",
-    "mention_user_nickname",
-    "mention_channel",
-    "mention_role",
-    "mention_slash_command",
-    "mention_custom_emoji",
-    "mention_custom_emoji_animated",
-    "mention_timestamp",
-    "mention_guild_navigation",
-    "format_ruff_rule",
-    "query_all_ruff_rules",
-    "run_ruff_format",
-    "paste",
-)
+class PEPType(StrEnum):
+    """Type of PEP.
+
+    Based off of `PEP Types in PEP1 <https://peps.python.org/#pep-types-key>`_.
+    """
+
+    I = "Informational"  # noqa: E741
+    P = "Process"
+    S = "Standards Track"
+
+
+class PEPStatus(StrEnum):
+    """Status of a PEP.
+
+    .. note:: ``Active`` and ``Accepted`` both traditionally use ``A``,
+        but are differentiated here for clarity.
+
+    Based off of `PEP Status in PEP1 <https://peps.python.org/#pep-status-key>`_.
+    """
+
+    A = "Active"
+    AA = "Accepted"
+    D = "Deferred"
+    __ = "Draft"
+    F = "Final"
+    P = "Provisional"
+    R = "Rejected"
+    S = "Superseded"
+    W = "Withdrawn"
+
+
+class PEPHistoryItem(TypedDict, total=False):
+    """PEP history item.
+
+    Sometimes these include a list of ``datetime`` objects,
+    other times they are a list of datetime and str
+    because they contain a date and an rST link.
+    """
+
+    date: str
+    link: str
+
+
+class PEP(TypedDict):
+    """PEP data.
+
+    Based off of the `PEPS API <https://peps.python.org/api/peps.json>`_.
+    """
+
+    number: int
+    title: str
+    authors: list[str] | str
+    discussions_to: str
+    status: PEPStatus
+    type: PEPType
+    topic: str
+    created: datetime
+    python_version: list[float] | float
+    post_history: list[str]
+    resolution: str | None
+    requires: str | None
+    replaces: str | None
+    superseded_by: str | None
+    url: str
 
 
 def is_byte_dev() -> Check[Any]:
@@ -311,3 +390,55 @@ def chunk_sequence(sequence: Iterable[_T], size: int) -> Iterable[tuple[_T, ...]
     _sequence = iter(sequence)
     while chunk := tuple(islice(_sequence, size)):
         yield chunk
+
+
+def format_resolution_link(resolution: str | None) -> str:
+    """Formats the resolution URL into a markdown link.
+
+    Args:
+        resolution (str): The resolution URL.
+
+    Returns:
+        str: The formatted markdown link.
+    """
+    if not resolution:
+        return "N/A"
+    if "discuss.python.org" in resolution:
+        return f"[via Discussion Forum]({resolution})"
+    if "mail.python.org" in resolution:
+        return f"[via Mailist]({resolution})"
+    return resolution
+
+
+async def query_all_peps() -> list[PEP]:
+    """Query all PEPs from the PEPs Python.org API.
+
+    Returns:
+        list[PEP]: All PEPs
+    """
+    url = "https://peps.python.org/api/peps.json"
+    async with httpx.AsyncClient() as client:
+        response = await client.get(url)
+        response.raise_for_status()
+        data = response.json()
+
+    return [  # type: ignore[reportReturnType]
+        {
+            "number": pep_info["number"],
+            "title": pep_info["title"],
+            "authors": pep_info["authors"].split(", "),
+            "discussions_to": pep_info["discussions_to"],
+            "status": PEPStatus(pep_info["status"]),
+            "type": PEPType(pep_info["type"]),
+            "topic": pep_info.get("topic", ""),
+            "created": datetime.strptime(pep_info["created"], "%d-%b-%Y").replace(tzinfo=UTC).strftime("%Y-%m-%d"),
+            "python_version": pep_info.get("python_version"),
+            "post_history": pep_info.get("post_history", []),
+            "resolution": format_resolution_link(pep_info.get("resolution", "N/A")),
+            "requires": pep_info.get("requires"),
+            "replaces": pep_info.get("replaces"),
+            "superseded_by": pep_info.get("superseded_by"),
+            "url": pep_info["url"],
+        }
+        for pep_info in data.values()
+    ]