bot-formatter 0.1.0__tar.gz

bot_formatter-0.1.0/LICENSE

@@ -0,0 +1,21 @@
+MIT License
+
+Copyright (c) 2023 Timo (tibue99)
+
+Permission is hereby granted, free of charge, to any person obtaining a copy
+of this software and associated documentation files (the "Software"), to deal
+in the Software without restriction, including without limitation the rights
+to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
+copies of the Software, and to permit persons to whom the Software is
+furnished to do so, subject to the following conditions:
+
+The above copyright notice and this permission notice shall be included in all
+copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
+AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
+OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
+SOFTWARE.

bot_formatter-0.1.0/PKG-INFO

@@ -0,0 +1,51 @@
+Metadata-Version: 2.4
+Name: bot-formatter
+Version: 0.1.0
+Summary: A formatter for Discord bots.
+Author: tibue99
+License: MIT
+Project-URL: GitHub, https://github.com/CookieAppTeam/bot-formatter
+Keywords: discord,discord.py,py-cord
+Classifier: Development Status :: 5 - Production/Stable
+Classifier: License :: OSI Approved :: MIT License
+Classifier: Intended Audience :: Developers
+Classifier: Operating System :: OS Independent
+Classifier: Topic :: Software Development :: Quality Assurance
+Classifier: Programming Language :: Python :: 3.10
+Classifier: Programming Language :: Python :: 3.11
+Classifier: Programming Language :: Python :: 3.12
+Classifier: Programming Language :: Python :: 3.13
+Classifier: Programming Language :: Python :: 3.14
+Requires-Python: >=3.10
+Description-Content-Type: text/markdown
+License-File: LICENSE
+Requires-Dist: libcst
+Requires-Dist: PyYAML
+Dynamic: license-file
+
+# bot-formatter
+[![](https://img.shields.io/pypi/v/bot-formatter.svg?style=for-the-badge&logo=pypi&color=yellow&logoColor=white)](https://pypi.org/project/bot-formatter/)
+[![](https://img.shields.io/readthedocs/bot-formatter?style=for-the-badge&color=blue&link=https%3A%2F%2Fbot-formatter.readthedocs.io%2F)](https://bot-formatter.readthedocs.io/)
+[![](https://img.shields.io/pypi/l/bot-formatter?style=for-the-badge)](https://pypi.org/project/bot-formatter/)
+
+A formatter for Discord bots.
+
+## Installing
+Python 3.10 or higher is required.
+```
+pip install bot-formatter
+```
+
+## Usage
+For a full overview, see the [documentation](https://bot-formatter.readthedocs.io/).
+```
+bot-formatter main.py
+```
+
+## Pre-Commit
+```yaml
+- repo: https://github.com/CookieAppTeam/bot-formatter
+  rev: 0.1.0
+  hooks:
+    - id: bot-formatter
+```

bot_formatter-0.1.0/README.md

@@ -0,0 +1,26 @@
+# bot-formatter
+[![](https://img.shields.io/pypi/v/bot-formatter.svg?style=for-the-badge&logo=pypi&color=yellow&logoColor=white)](https://pypi.org/project/bot-formatter/)
+[![](https://img.shields.io/readthedocs/bot-formatter?style=for-the-badge&color=blue&link=https%3A%2F%2Fbot-formatter.readthedocs.io%2F)](https://bot-formatter.readthedocs.io/)
+[![](https://img.shields.io/pypi/l/bot-formatter?style=for-the-badge)](https://pypi.org/project/bot-formatter/)
+
+A formatter for Discord bots.
+
+## Installing
+Python 3.10 or higher is required.
+```
+pip install bot-formatter
+```
+
+## Usage
+For a full overview, see the [documentation](https://bot-formatter.readthedocs.io/).
+```
+bot-formatter main.py
+```
+
+## Pre-Commit
+```yaml
+- repo: https://github.com/CookieAppTeam/bot-formatter
+  rev: 0.1.0
+  hooks:
+    - id: bot-formatter
+```

bot_formatter-0.1.0/bot_formatter/__init__.py

@@ -0,0 +1,13 @@
+__title__ = "bot-formatter"
+__author__ = "tibue99"
+__license__ = "MIT"
+__version__ = "0.1.0"
+
+
+import sys
+
+from bot_formatter.run import BotFormatter
+
+
+def run():
+    BotFormatter(sys.argv[1:])

bot_formatter-0.1.0/bot_formatter/__main__.py

@@ -0,0 +1,3 @@
+import bot_formatter
+
+bot_formatter.run()

bot_formatter-0.1.0/bot_formatter/formatters/__init__.py

@@ -0,0 +1,11 @@
+from .dpy import ConvertSetup
+from .yml import remove_duplicate_new_lines
+from .pycord import ConvertContext
+from .lang import check_missing_keys, check_empty_line_diffs
+
+
+EZCORD = [ConvertContext]
+LANG = [check_missing_keys, check_empty_line_diffs]
+PYCORD = []
+DPY = [ConvertSetup]
+YML = [remove_duplicate_new_lines]

bot_formatter-0.1.0/bot_formatter/formatters/dpy.py

@@ -0,0 +1,35 @@
+"""Formatters for Discord.py."""
+
+import libcst as cst
+import libcst.matchers as m
+from libcst.codemod import VisitorBasedCodemodCommand
+
+
+class ConvertSetup(VisitorBasedCodemodCommand):
+    DESCRIPTION = "Converts setup methods to their asynchronous equivalent."
+
+    ADD_COG = m.Expr(
+        m.Call(
+            m.Attribute(
+                attr=m.Name(
+                    value="add_cog",
+                )
+            )
+        )
+    )
+
+    def __init__(self, context: cst.codemod.CodemodContext):
+        super().__init__(context)
+
+    def leave_FunctionDef(
+        self, node: cst.FunctionDef, updated_node: cst.FunctionDef
+    ) -> cst.FunctionDef:
+        if node.name.value == "setup":
+            return updated_node.with_changes(asynchronous=cst.Asynchronous())
+        return updated_node
+
+    @m.call_if_inside(ADD_COG)
+    def leave_Call(self, node: cst.Call, updated_node: cst.Call) -> cst.Call:
+        if isinstance(node.func, cst.Attribute):
+            return updated_node.with_changes(func=cst.Await(updated_node.func))
+        return updated_node

bot_formatter-0.1.0/bot_formatter/formatters/lang.py

@@ -0,0 +1,70 @@
+"""
+Formatters for YAML language files that compare content and keys across multiple files.
+"""
+
+# A dictionary with a mapping of file names to their keys
+LANG_KEYS = dict[str, dict]
+
+# A dictionary with a mapping of file names to their content
+LANG_CONTENT = dict[str, str]
+
+
+def _collect_keys(dict_content: dict, parent_key: str | None = None) -> set[str]:
+    """Recursively collects all keys in a nested dictionary."""
+
+    keys = set()
+    for key, value in dict_content.items():
+        full_key = f"{parent_key}.{key}" if parent_key else key
+        keys.add(full_key)
+        if isinstance(value, dict):
+            keys.update(_collect_keys(value, full_key))
+
+    return keys
+
+
+def check_missing_keys(lang_keys: LANG_KEYS, report):
+    """Checks that all language files have the same keys."""
+
+    for file_name, content in lang_keys.items():
+        for other_file_name, other_content in lang_keys.items():
+            if file_name == other_file_name:
+                continue
+
+            keys = _collect_keys(content)
+            other_keys = _collect_keys(other_content)
+
+            missing_keys = other_keys - keys
+
+            if missing_keys:
+                missing = '\n'.join(sorted([f"- {key}" for key in missing_keys]))
+                report.check_failed(file_name, f"Missing keys compared to {other_file_name}:\n{missing}")
+
+
+def check_empty_line_diffs(lang_content: LANG_CONTENT, report):
+    """Checks if all YAML keys are in the same line across different language files."""
+
+    reference_file = None
+    reference_lines = []
+
+    for file_name, content in lang_content.items():
+        reference_file = file_name
+        reference_lines = content.splitlines()
+        break
+
+    if reference_file is None:
+        return
+
+    # Compare all files to reference file
+    for file_name, content in lang_content.items():
+        if file_name == reference_file:
+            continue
+
+        current_lines = content.splitlines()
+
+        for line, (ref_line, cur_line) in enumerate(zip(reference_lines, current_lines), start=1):
+            if ref_line.strip() == "" and ref_line.strip() != cur_line.strip():
+                report.check_failed(
+                    file_name,
+                    f"Empty line {line} differs from {reference_file}."
+                )
+                break

bot_formatter-0.1.0/bot_formatter/formatters/pycord.py

@@ -0,0 +1,77 @@
+"""Formatters for Pycord ."""
+
+import libcst as cst
+import libcst.matchers as m
+from libcst.codemod import VisitorBasedCodemodCommand
+
+
+class ConvertContext(VisitorBasedCodemodCommand):
+    DESCRIPTION = "Converts discord.ApplicationContext to ezcord.EzContext."
+
+    SLASH_DECORATOR = m.FunctionDef(
+        decorators=[m.Decorator(decorator=m.Call(func=m.Name("slash_command")))]
+    )
+
+    IMPORT_EZCORD = m.Import(names=[m.ImportAlias(name=m.Name(value="ezcord"))])
+
+    EZ_ANNOTATION_1 = m.Annotation(m.Attribute(value=m.Name("ezcord"), attr=m.Name("EzContext")))
+
+    EZ_ANNOTATION_2 = m.Annotation(
+        m.Name(
+            value="EzContext",
+        )
+    )
+
+    def __init__(self, context: cst.codemod.CodemodContext):
+        super().__init__(context)
+        self.has_changes = False
+        self.has_ezcord_import = False
+
+    def leave_Import(self, original_node: cst.Import, updated_node: cst.Import) -> cst.Import:
+        """Checks if Ezcord is already imported."""
+
+        if m.matches(updated_node, self.IMPORT_EZCORD):
+            self.has_ezcord_import = True
+
+        return updated_node
+
+    @m.call_if_inside(SLASH_DECORATOR)
+    def leave_FunctionDef(
+        self, node: cst.FunctionDef, updated_node: cst.FunctionDef
+    ) -> cst.FunctionDef:
+        """Replaces discord.ApplicationContext with ezcord.EzContext if it doesn't already exist."""
+
+        new_params = []
+        for param in node.params.params:
+            if param.annotation:
+                if m.matches(param.annotation, self.EZ_ANNOTATION_1) or m.matches(
+                    param.annotation, self.EZ_ANNOTATION_2
+                ):
+                    new_params.append(param)
+                    continue
+
+            if param.name.value != "ctx":
+                new_params.append(param)
+                continue
+
+            modified_param = cst.Param(
+                cst.Name("ctx"),
+                cst.Annotation(cst.Attribute(value=cst.Name("ezcord"), attr=cst.Name("EzContext"))),
+            )
+            new_params.append(modified_param)
+            self.has_changes = True
+
+        return updated_node.with_changes(params=cst.Parameters(params=new_params))
+
+    def leave_Module(self, node: cst.Module, updated_node: cst.Module) -> cst.Module:
+        """Adds an import for ezcord if it doesn't exist and if changes were made."""
+
+        if self.has_changes and not self.has_ezcord_import:
+            new_import = cst.Import(names=[cst.ImportAlias(name=cst.Name("ezcord"))])
+            new_body = [
+                cst.SimpleStatementLine(body=[new_import]),
+                cst.Newline(),
+            ] + list(updated_node.body)
+            return updated_node.with_changes(body=new_body)
+
+        return updated_node

bot_formatter-0.1.0/bot_formatter/formatters/yml.py

@@ -0,0 +1,10 @@
+"""Formatter for YAML files."""
+
+
+def remove_duplicate_new_lines(content: str) -> str:
+    """Removes duplicate new lines from the content of a YAML file."""
+
+    while "\n\n\n" in content:
+        content = content.replace("\n\n\n", "\n\n")
+
+    return content

bot_formatter-0.1.0/bot_formatter/run.py

@@ -0,0 +1,191 @@
+from __future__ import annotations
+
+import argparse
+from pathlib import Path
+from typing import get_type_hints
+
+from libcst import codemod
+import yaml
+
+from bot_formatter.formatters import DPY, EZCORD, PYCORD, LANG, YML
+
+
+class Output:
+    modified_files: list[str] = []
+    failed_files: list[str] = []
+    failed_checks: dict[str, list[str]] = {}
+
+    def __init__(self, config: argparse.Namespace):
+        self.config = config
+
+    def success(self, file: str):
+        self.modified_files.append(file)
+
+    def error(self, file: str, error: Exception):
+        self.failed_files.append(f"{file}: {error}")
+
+    def check_failed(self, file: str, error_txt: str):
+        if file not in self.failed_checks:
+            self.failed_checks[file] = []
+        self.failed_checks[file].append(error_txt)
+
+    @staticmethod
+    def _check_plural(word: str, count: int) -> str:
+        return f"{count} {word}{'s' if count != 1 else ''}"
+
+    def print_output(self):
+        """Prints a report to the console if the silent mode isn't enabled."""
+
+        if self.config.silent:
+            return
+
+        modify = self._check_plural("file", len(self.modified_files))
+        check = self._check_plural("file", len(self.config.files))
+
+        if self.config.dry_run:
+            report = f"Done! Would modify {modify} (checked {check})"
+        else:
+            report = f"Done! Modified {modify} (checked {check})"
+
+        if self.modified_files:
+            report += "\n\n" + "\n".join(self.modified_files)
+
+        if self.failed_files:
+            report += f"\n\n{self._check_plural('error', len(self.failed_files))} occurred"
+            report += "\n" + "\n".join(self.failed_files)
+
+        for file, errors in self.failed_checks.items():
+            report += f"\n\n\n------ CHECKS FAILED IN {file.upper()} ------"
+            report += "\n\n" + "\n\n".join(errors)
+
+        print(report)
+
+
+class BotFormatter:
+    def __init__(self, args: list[str]) -> None:
+        parser = argparse.ArgumentParser(prog="bot-formatter")
+        parser.add_argument("files", nargs="*", help="The files to format.")
+        parser.add_argument("--silent", action="store_true", help="Hide all log messages.")
+        parser.add_argument(
+            "--dry-run", action="store_true", help="Scan files without modifying them."
+        )
+        parser.add_argument(
+            "--lib", default="pycord", choices=["dpy", "pycord"], help="The library to use."
+        )
+        parser.add_argument("--ezcord", action="store_true", help="Use Ezcord formatters.")
+        parser.add_argument("--no-yaml", action="store_true", help="Disable YAML formatters.")
+        parser.add_argument("--lang", help="The language directory to check.")
+
+        self.config = parser.parse_args(args)
+        self.report = Output(self.config)
+
+        if not self.config.files:
+            parser.print_help()
+            return
+
+        # Format each file
+        for file in self.config.files:
+            self.format_file(file)
+
+        # Check language files
+        if self.config.lang:
+            self.lang_dir = Path(self.config.lang)
+            if not self.lang_dir.is_dir():
+                raise ValueError(f"The language directory '{self.lang_dir}' is not a valid directory.")
+            self.check_lang_files()
+
+        # Print report and exit with error code if needed
+        self.report.print_output()
+        if len(self.report.failed_checks) > 0:
+            raise SystemExit(1)
+
+    def log(self, message: str):
+        """Prints a message to the console if the silent mode isn't enabled."""
+
+        if not self.config.silent:
+            print(message)
+
+    def check_lang_files(self):
+        """Ensure consistency across all language files."""
+
+        lang_files = list(self.lang_dir.glob("*.yaml")) + list(self.lang_dir.glob("*.yml"))
+
+        # All keys as a dictionary
+        lang_keys = {}
+        for file_path in lang_files:
+            with open(file_path, encoding="utf-8") as f:
+                content = yaml.safe_load(f)
+                lang_keys[file_path.name] = content
+
+        # All contents as a string
+        lang_contents = {}
+        for file_path in lang_files:
+            with open(file_path, encoding="utf-8") as f:
+                code = f.read()
+                lang_contents[file_path.name] = code
+
+        for formatter in LANG:
+            params = get_type_hints(formatter)
+
+            if "lang_keys" in params and "lang_content" in params:
+                formatter(lang_keys, lang_contents, self.report)
+            elif "lang_content" in params:
+                formatter(lang_contents, self.report)
+            elif "lang_keys" in params:
+                formatter(lang_keys, self.report)
+            else:
+                raise ValueError(
+                    "Formatter must accept either 'lang_keys' or 'lang_contents' parameter."
+                )
+
+
+    def format_file(self, filename: str):
+        """Runs all enabled formatters on a given file."""
+        try:
+            with open(filename, encoding="utf-8") as f:
+                code = f.read()
+        except Exception as e:
+            self.report.error(filename, e)
+            return
+
+        formatters = []
+        if self.config.lib == "pycord":
+            formatters.extend(PYCORD)
+        elif self.config.lib == "dpy":
+            formatters.extend(DPY)
+        if self.config.ezcord:
+            formatters.extend(EZCORD)
+
+        ext = filename.split(".")[-1]
+
+        # Run Python formatters
+        for formatter in formatters:
+            if ext != "py":
+                continue
+
+            transformer = formatter(codemod.CodemodContext(filename=filename))
+            result = codemod.transform_module(transformer, code)
+
+            if isinstance(result, codemod.TransformSuccess):
+                if result.code != code:
+                    self.report.success(filename)
+
+                    if not self.config.dry_run:
+                        with open(filename, "w", encoding="utf-8") as f:
+                            f.write(result.code)
+
+            elif isinstance(result, codemod.TransformFailure):
+                self.report.error(filename, result.error)
+
+        # Run YAML formatters
+        if self.config.no_yaml or ext not in ["yaml", "yml"]:
+            return
+
+        for lang_formatter in YML:
+            new_code = lang_formatter(code)
+
+            if new_code != code:
+                self.report.success(filename)
+                if not self.config.dry_run:
+                    with open(filename, "w", encoding="utf-8") as f:
+                        f.write(new_code)

bot_formatter-0.1.0/bot_formatter.egg-info/PKG-INFO

@@ -0,0 +1,51 @@
+Metadata-Version: 2.4
+Name: bot-formatter
+Version: 0.1.0
+Summary: A formatter for Discord bots.
+Author: tibue99
+License: MIT
+Project-URL: GitHub, https://github.com/CookieAppTeam/bot-formatter
+Keywords: discord,discord.py,py-cord
+Classifier: Development Status :: 5 - Production/Stable
+Classifier: License :: OSI Approved :: MIT License
+Classifier: Intended Audience :: Developers
+Classifier: Operating System :: OS Independent
+Classifier: Topic :: Software Development :: Quality Assurance
+Classifier: Programming Language :: Python :: 3.10
+Classifier: Programming Language :: Python :: 3.11
+Classifier: Programming Language :: Python :: 3.12
+Classifier: Programming Language :: Python :: 3.13
+Classifier: Programming Language :: Python :: 3.14
+Requires-Python: >=3.10
+Description-Content-Type: text/markdown
+License-File: LICENSE
+Requires-Dist: libcst
+Requires-Dist: PyYAML
+Dynamic: license-file
+
+# bot-formatter
+[![](https://img.shields.io/pypi/v/bot-formatter.svg?style=for-the-badge&logo=pypi&color=yellow&logoColor=white)](https://pypi.org/project/bot-formatter/)
+[![](https://img.shields.io/readthedocs/bot-formatter?style=for-the-badge&color=blue&link=https%3A%2F%2Fbot-formatter.readthedocs.io%2F)](https://bot-formatter.readthedocs.io/)
+[![](https://img.shields.io/pypi/l/bot-formatter?style=for-the-badge)](https://pypi.org/project/bot-formatter/)
+
+A formatter for Discord bots.
+
+## Installing
+Python 3.10 or higher is required.
+```
+pip install bot-formatter
+```
+
+## Usage
+For a full overview, see the [documentation](https://bot-formatter.readthedocs.io/).
+```
+bot-formatter main.py
+```
+
+## Pre-Commit
+```yaml
+- repo: https://github.com/CookieAppTeam/bot-formatter
+  rev: 0.1.0
+  hooks:
+    - id: bot-formatter
+```

bot_formatter-0.1.0/bot_formatter.egg-info/SOURCES.txt

@@ -0,0 +1,18 @@
+LICENSE
+README.md
+pyproject.toml
+requirements.txt
+bot_formatter/__init__.py
+bot_formatter/__main__.py
+bot_formatter/run.py
+bot_formatter.egg-info/PKG-INFO
+bot_formatter.egg-info/SOURCES.txt
+bot_formatter.egg-info/dependency_links.txt
+bot_formatter.egg-info/entry_points.txt
+bot_formatter.egg-info/requires.txt
+bot_formatter.egg-info/top_level.txt
+bot_formatter/formatters/__init__.py
+bot_formatter/formatters/dpy.py
+bot_formatter/formatters/lang.py
+bot_formatter/formatters/pycord.py
+bot_formatter/formatters/yml.py

bot_formatter-0.1.0/bot_formatter.egg-info/dependency_links.txt

@@ -0,0 +1 @@
+

bot_formatter-0.1.0/bot_formatter.egg-info/entry_points.txt

@@ -0,0 +1,2 @@
+[console_scripts]
+bot-formatter = bot_formatter:run

bot_formatter-0.1.0/bot_formatter.egg-info/requires.txt

@@ -0,0 +1,2 @@
+libcst
+PyYAML

bot_formatter-0.1.0/bot_formatter.egg-info/top_level.txt

@@ -0,0 +1 @@
+bot_formatter

bot_formatter-0.1.0/pyproject.toml

@@ -0,0 +1,37 @@
+[project]
+name = "bot-formatter"
+description = "A formatter for Discord bots."
+readme = "README.md"
+requires-python = ">=3.10"
+license = {text = "MIT"}
+keywords = ["discord", "discord.py", "py-cord"]
+authors = [
+    { name = "tibue99" }
+]
+classifiers = [
+    "Development Status :: 5 - Production/Stable",
+    "License :: OSI Approved :: MIT License",
+    "Intended Audience :: Developers",
+    "Operating System :: OS Independent",
+    "Topic :: Software Development :: Quality Assurance",
+    "Programming Language :: Python :: 3.10",
+    "Programming Language :: Python :: 3.11",
+    "Programming Language :: Python :: 3.12",
+    "Programming Language :: Python :: 3.13",
+    "Programming Language :: Python :: 3.14",
+]
+dynamic = ["version", "dependencies"]
+
+[tool.setuptools.dynamic]
+version = {attr = "bot_formatter.__version__"}
+dependencies = {file = "requirements.txt"}
+
+[project.urls]
+GitHub = "https://github.com/CookieAppTeam/bot-formatter"
+
+[project.scripts]
+bot-formatter = "bot_formatter:run"
+
+[build-system]
+requires = ["setuptools>=62.6", "wheel"]
+build-backend = "setuptools.build_meta"

bot_formatter-0.1.0/requirements.txt

@@ -0,0 +1,2 @@
+libcst
+PyYAML

bot_formatter-0.1.0/setup.cfg

@@ -0,0 +1,4 @@
+[egg_info]
+tag_build = 
+tag_date = 0
+