Merge pull request #34 from CommanderBot-Dev/pack-tweaks

Hide stacktraces by default and add name argument to pack command

Author: vberlier

CHANGELOG.md

@@ -4,6 +4,13 @@ All notable changes to this project will be documented in this file.
 
 The format is based on [Keep a Changelog](https://keepachangelog.com/en/1.0.0/), and this project adheres to [Semantic Versioning](https://semver.org/spec/v2.0.0.html).
 
+## [Unreleased]
+
+## Changed
+
+- Optional `pack` command argument for changing the name of the generated data pack or resource pack
+- The `pack` command no longer shows exception tracebacks by default
+
 ## [0.9.0] - 2021-05-09
 
 ## Changed

commanderbot_ext/ext/pack/pack_cog.py

@@ -1,6 +1,7 @@
 import asyncio
 import io
 from logging import Logger, getLogger
+from typing import Optional
 
 from discord import File, Message
 from discord.ext.commands import Bot, Cog, Context, command
@@ -14,9 +15,13 @@ def __init__(self, bot: Bot, **options):
         self.log: Logger = getLogger(self.qualified_name)
         self.project_config = options
         self.build_timeout = options.pop("timeout", 5)
+        self.show_stacktraces = options.pop("stacktraces", False)
 
-    @command(name="pack")
-    async def cmd_pack(self, ctx: Context):
+    @command(
+        name="pack",
+        brief="Generate a data pack or a resource pack.",
+    )
+    async def cmd_pack(self, ctx: Context, name: Optional[str]):
         if not ctx.message:
             self.log.warn("Command executed without message.")
             return
@@ -34,11 +39,12 @@ async def cmd_pack(self, ctx: Context):
             generate_packs,
             self.project_config,
             self.build_timeout,
-            author,
+            self.show_stacktraces,
+            name or author,
             message_content,
         )
 
-        content = f"```{joined}```" if (joined := "\n\n".join(build_output)) else ""
+        content = f"```\n{joined}\n```" if (joined := "\n\n".join(build_output)) else ""
         files = [
             File(io.BytesIO(data), filename=filename)
             for filename, data in attachments.items()

commanderbot_ext/ext/pack/pack_generate.py

@@ -14,6 +14,7 @@
 )
 from beet.core.utils import JsonDict
 from beet.toolchain.utils import format_exc
+from jinja2 import TemplateError
 from lectern import Document
 
 BuildResult = Tuple[List[str], Dict[str, bytes]]
@@ -22,12 +23,23 @@
 def generate_packs(
     project_config: JsonDict,
     build_timeout: float,
+    show_stacktraces: bool,
     project_name: str,
     message_content: str,
 ) -> BuildResult:
     q: "Queue[BuildResult]" = Queue()
 
-    p = Process(target=worker, args=(q, project_name, project_config, message_content))
+    p = Process(
+        target=worker,
+        args=(
+            q,
+            project_name,
+            project_config,
+            message_content,
+            show_stacktraces,
+        ),
+    )
+
     p.start()
     p.join(timeout=build_timeout)
 
@@ -45,6 +57,7 @@ def worker(
     project_name: str,
     project_config: JsonDict,
     message_content: str,
+    show_stacktraces: bool,
 ):
     project_directory = os.getcwd()
 
@@ -90,7 +103,26 @@ def worker(
         exception = exc
 
     if exception:
-        build_output.append(format_exc(exception))
+        exc_name = type(exception).__name__
+
+        if show_stacktraces:
+            build_output.append(format_exc(exception))
+        elif isinstance(
+            exception,
+            (
+                TypeError,
+                ValueError,
+                AttributeError,
+                LookupError,
+                ArithmeticError,
+                TemplateError,
+            ),
+        ):
+            build_output.append(f"{exc_name}: {exception}")
+        else:
+            build_output.append(
+                f'{exc_name}: Enable the "stacktraces" option to see the full traceback.'
+            )
 
     q.put((build_output, {}))
 

poetry.lock

@@ -15,8 +15,8 @@ python = "^3.8"
 commanderbot = "^0.7.0"
 SQLAlchemy = "^1.4.9"
 aiosqlite = "^0.17.0"
-lectern = ">=0.11.1"
-beet = ">=0.22.1"
+lectern = ">=0.13.0"
+beet = ">=0.23.0"
 
 [tool.poetry.dev-dependencies]
 black = "^20.8b1"