kattis-cli 1.0.7__py3-none-any.whl → 1.1.0__py3-none-any.whl

kattis_cli/kattis_setup.py

@@ -1,21 +1,27 @@
-"""Setup file for Kattis.
+"""Setup helpers for Kattis CLI.
+
+This module now exposes a :class:`SetupManager` which accepts a
+``KattisClient`` in order to perform login flows. A module-level
+``setup`` function delegates to a default manager to preserve the
+original API used by the CLI.
 """
 
 from pathlib import Path
 import requests
 from rich.console import Console
 from rich.prompt import Prompt, Confirm
-from . import kattis
+from typing import Optional
+from .client import KattisClient
 from .utils import config
 
-
 _LOGIN_URL = 'https://open.kattis.com/login'
 _KATTISRCURL = "https://open.kattis.com/download/kattisrc"
 
-# _HEADERS = {'User-Agent': 'kattis-cli'}
-_HEADERS = {'User-Agent': 'Mozilla/5.0 (X11; Linux x86_64) AppleWebKit/537.36 \
-            (KHTML, like Gecko) \
-             Ubuntu Chromium/83.0.4103.97 Chrome/83.0.4103.97 Safari/537.36'}
+# headers used to fetch kattisrc during interactive setup
+_HEADERS = {
+    'User-Agent': 'Mozilla/5.0 (X11; Linux x86_64) AppleWebKit/537.36 '
+    '(KHTML, like Gecko) '
+    'Ubuntu Chromium/83.0.4103.97 Chrome/83.0.4103.97 Safari/537.36'}
 _HEADERS['Referer'] = _LOGIN_URL
 _HEADERS['Content-Type'] = 'application/x-www-form-urlencoded'
 _HEADERS['Origin'] = 'https://open.kattis.com'
@@ -23,96 +29,127 @@ _HEADERS['Host'] = 'open.kattis.com'
 _HEADERS['Connection'] = 'keep-alive'
 _HEADERS['Accept-Language'] = 'en-US,en;q=0.9'
 _HEADERS['Accept-Encoding'] = 'gzip, deflate, br'
-_HEADERS['Accept'] = 'text/html,application/xhtml+xml,\
-    application/xml;q=0.9,image/webp,*/*;q=0.8'
+_HEADERS['Accept'] = (
+    'text/html,application/xhtml+xml,application/xml;q=0.9,'
+    'image/webp,*/*;q=0.8'
+)
 
 _KATTISRC = Path.home().joinpath(".kattisrc")
 
 
-def check_kattisrc() -> bool:
-    """Check if kattisrc exists.
+class SetupManager:
+    """Interactive setup manager for installing .kattisrc.
 
-    Returns:
-        bool: True if kattisrc exists, False otherwise.
+    The manager accepts a `KattisClient` instance so the underlying
+    authentication logic can be injected (useful for testing).
     """
-    try:
-        cfg = config.get_kattisrc()
-        response = kattis.login_from_config(cfg)
-        if response.status_code != 200:
-            return False
-    except config.ConfigError:
-        return False
-    return True
 
+    def __init__(self, client: Optional[KattisClient] = None) -> None:
+        self.client = client or KattisClient()
 
-def setup() -> None:
-    """Setup Kattis CLI.
-    """
-    console = Console()
-    console.print(":cat: Welcome to Kattis CLI! :cat:", style="bold blue")
-    if check_kattisrc():
-        console.print(
-            ":rocket: [bold blue]kattisrc already exists with valid token.[/]")
-        console.print(
-            ":rocket: [bold green]You are ready to use Kattis CLI.[/]")
-        return
-    console.print("You need your Kattis credentials for this setup.")
-    if Confirm.ask("Do you have an account on Kattis?", default=True):
-        while True:
-            username = Prompt.ask(
-                "Please enter your username or email",
-                password=False,
+    def check_kattisrc(self) -> bool:
+        """Check if kattisrc file exists and is valid.
+
+        Returns:
+            bool: True if kattisrc is valid, False otherwise.
+        """
+        try:
+            cfg = config.get_kattisrc()
+            response = self.client.login_from_config(cfg)
+            if response.status_code != 200:
+                return False
+        except config.ConfigError:
+            return False
+        return True
+
+    def setup(self) -> None:
+        """Run the interactive setup for Kattis CLI.
+        """
+        console = Console()
+        console.print(":cat: Welcome to Kattis CLI! :cat:", style="bold blue")
+        if self.check_kattisrc():
+            console.print(
+                ":rocket: [bold blue]kattisrc already exists with valid "
+                "token.[/]"
+            )
+            console.print(
+                ":rocket: [bold green]You are ready to use Kattis CLI.[/]"
             )
+            return
+        console.print("You need your Kattis credentials for this setup.")
+        if Confirm.ask("Do you have an account on Kattis?", default=True):
             while True:
-                password = Prompt.ask(
-                    "Please enter your password",
-                    password=True,
-                )
-                if Confirm.ask("Want to see your password? ", default=False):
-                    console.print(f"You entered: {password}")
-                    if Confirm.ask("Is this correct? ", default=True):
+                username = Prompt.ask(
+                    "Please enter your username or email", password=False)
+                while True:
+                    password = Prompt.ask(
+                        "Please enter your password", password=True)
+                    if Confirm.ask(
+                        "Want to see your password? ",
+                            default=False):
+                        console.print(f"You entered: {password}")
+                        if Confirm.ask("Is this correct? ", default=True):
+                            console.print(":rocket: Logging in...")
+                            break
+                    else:
                         console.print(":rocket: Logging in...")
                         break
+
+                response = self.client.login(_LOGIN_URL, username, password)
+                if response.status_code == 200:
+                    console.print(":rocket: Login successful!")
+                    res = requests.get(
+                        _KATTISRCURL,
+                        cookies=response.cookies,
+                        headers=_HEADERS,
+                        timeout=10,
+                    )
+                    if res.status_code == 200:
+                        with open(_KATTISRC, "w", encoding='utf-8') as f:
+                            f.write(res.text)
+                        console.print(
+                            f":rocket: kattisrc downloaded and saved to "
+                            f"{str(_KATTISRC)}"
+                        )
+                    else:
+                        text = (
+                            ":loudly_crying_face:\n"
+                            "kattisrc download failed. Please download "
+                            "kattisrc manually from:\n"
+                            "https://open.kattis.com/download/kattisrc\n"
+                            "and save it to your system's home directory with "
+                            "the name .kattisrc\n"
+                        )
+                        console.print(text)
+                        break
                 else:
-                    console.print(":rocket: Logging in...")
-                    break
-
-            response = kattis.login(_LOGIN_URL, username, password)
-            # console.print("code=", response.status_code)
-            # console.print("text=", response.text)
-            if response.status_code == 200:
-                console.print(":rocket: Login successful!")
-                # download kattisrc
-                # cookies = response.cookies
-                # console.print(cookies)
-                # cookies = response.cookies.RequestsCookieJar
-                res = requests.get(
-                    _KATTISRCURL,
-                    cookies=response.cookies,
-                    headers=_HEADERS,
-                    timeout=10,
-                )
-                # console.print(res.status_code)
-                # console.print(res.text)
-                if res.status_code == 200:
-                    with open(_KATTISRC, "w", encoding='utf-8') as f:
-                        f.write(res.text)
-                    console.print(f""":rocket: kattisrc
-downloaded and saved to {str(_KATTISRC)}""")
-                else:
-                    text = """:loudly_crying_face:
-kattisrc download failed. Please download kattisrc manually from:
-[link=https://open.kattis.com/download/kattisrc]
-https://open.kattis.com/download/kattisrc[/link]
-and save it to your system's home directory with the name .kattisrc
-"""
-                    console.print(text)
-                break
-            else:
-                console.print(""":loudly_crying_face:
-Login failed. Please try again.""")
-    else:
-        console.print("Please register your account at: ")
-        console.print("""[link="https://open.kattis.com/register"]
-https://open.kattis.com/register[/link]""")
-        console.print("and try again.")
+                    console.print(
+                        ":loudly_crying_face:\n"
+                        "Login failed. Please try again."
+                    )
+        else:
+            console.print("Please register your account at: ")
+            console.print(
+                "[link=\"https://open.kattis.com/register\"]"
+                "https://open.kattis.com/register[/link]"
+            )
+            console.print("and try again.")
+
+
+# Default manager for compatibility
+_manager = SetupManager()
+
+
+def check_kattisrc() -> bool:
+    """Check if kattisrc file exists and is valid.
+
+    Returns:
+        bool: True if kattisrc is valid, False otherwise.
+    """
+    return _manager.check_kattisrc()
+
+
+def setup() -> None:
+    """Wrapper for Katti-cli setup
+    """
+    return _manager.setup()

kattis_cli/main.py

@@ -7,7 +7,7 @@ build.sh script copies the contents of this file to main.py.
 Change the __version__ to match in pyproject.toml
 Has to be higher than the pypi version.
 """
-__version__ = '1.0.7'
+__version__ = '1.1.0'
 
 from math import inf
 from typing import Tuple
@@ -17,7 +17,7 @@ import requests
 from trogon import tui
 import kattis_cli.download as download
 import kattis_cli.ui as ui
-import kattis_cli.test_solution as test_solution
+import kattis_cli.solution_tester as solution_tester
 import kattis_cli.kattis as kattis
 import kattis_cli.utils.languages as languages
 import kattis_cli.kattis_setup as kattis_setup
@@ -84,7 +84,7 @@ def test(
         mainclass = languages.guess_mainfile(
             language, _files, problemid, lang_config)
 
-    test_solution.test_samples(
+    solution_tester.test_samples(
         problemid,
         loc_language,
         mainclass,

kattis_cli/solution_tester.py

@@ -0,0 +1,221 @@
+"""Solution tester module for Kattis.
+
+Provides a SolutionTester class and a module-level `test_samples`
+delegator for backward compatibility with the previous procedural API.
+"""
+
+from typing import Any, List, Dict, Optional
+from math import inf
+import glob
+import time
+import os
+from pathlib import Path
+from rich.console import Console
+from rich.table import Table
+from rich.live import Live
+from rich.align import Align
+from rich import box
+from rich.prompt import Confirm
+from rich.markup import escape
+
+from kattis_cli import kattis
+from kattis_cli.utils import languages, run_program, utility
+
+
+class SolutionTester:
+    """Encapsulates testing of solutions using sample data.
+
+    Accepts optional collaborators to make testing easier to mock in
+    unit tests.
+    """
+
+    def __init__(
+        self,
+        client: Optional[Any] = None,
+        download_manager: Optional[Any] = None,
+    ) -> None:
+        """Create a SolutionTester.
+
+        Args:
+            client: Optional client or module providing submit_solution.
+            download_manager: Optional download manager instance.
+        """
+
+        self.client = client or kattis
+        self.download_manager = download_manager
+
+    def test_samples(
+            self,
+            problemid: str,
+            loc_language: str,
+            mainclass: str,
+            problem_root_folder: str,
+            files: List[str],
+            lang_config: Dict[Any, Any],
+            accuracy: float = inf
+    ) -> None:
+        """Run the sample tests for a solution.
+
+        This mirrors the previous procedural `test_samples` function but
+        is encapsulated on a class to allow dependency injection for
+        easier testing.
+        """
+        console = Console()
+
+        table = Table(show_header=True,
+                      header_style="bold blue",
+                      show_lines=True,
+                      show_footer=False)
+        table.box = box.SQUARE
+        table_centered = Align.center(table)
+
+        sep = os.path.sep
+        in_files = glob.glob(f"{problem_root_folder}{sep}data{sep}*.in")
+        if not in_files:
+            data_path = f"{problem_root_folder}{sep}data"
+            console.print(data_path, style="bold blue")
+            console.print("No sample input files found!", style="bold red")
+            exit(1)
+        in_files.sort()
+        if lang_config['compile']:
+            ex_code, ans, error = run_program.compile_program(
+                lang_config,
+                files,
+            )
+            if ex_code != 0:  # compilation error; exit code
+                console.print(escape(error), style='bold red')
+                exit(1)
+            console.print('Compiled successfully!', style='bold green')
+
+        count = 0
+        total = len(in_files)
+        console.clear()
+        title = f"[not italic bold blue]👷‍ Testing {mainclass} "
+        title += f" using {loc_language} 👷‍[/]"
+        table.title = title
+        with Live(table_centered, console=console,
+                  screen=False, refresh_per_second=10):
+            table.add_column(
+                "Input File",
+                justify="center",
+                style="cyan",
+                no_wrap=False)
+            table.add_column(
+                "Sample Input",
+                justify="left",
+                style="cyan",
+                no_wrap=False)
+            table.add_column(
+                "Output File",
+                justify="center",
+                style="cyan",
+                no_wrap=False)
+            table.add_column(
+                "Expected Output",
+                justify="left",
+                style="cyan",
+                no_wrap=False)
+            table.add_column(
+                "Program Output",
+                justify="left",
+                style="cyan",
+                no_wrap=False)
+            table.add_column(
+                "Result",
+                justify="center",
+                style="cyan",
+                no_wrap=True)
+
+            for in_file in in_files:
+                with open(in_file, 'rb') as f:
+                    input_content = f.read()
+                    input_content.replace(b'\r\n', b'\n')  # Windows fix
+                out_file = in_file.replace('.in', '.ans')
+                try:
+                    with open(out_file, 'rb') as f:
+                        expected = f.read()
+                        expected.replace(b'\r\n', b'\n')
+                except FileNotFoundError:
+                    try:
+                        out_file = in_file.replace('.in', '.out')
+                        with open(out_file, 'rb') as f:
+                            expected = f.read()
+                            expected.replace(b'\r\n', b'\n')
+                    except FileNotFoundError:
+                        expected = b"No .ans or .out file found!"
+                code, ans, error = run_program.run(
+                    lang_config,
+                    mainclass,
+                    in_file,
+                )
+                if code != 0:
+                    ans = error
+
+                if utility.check_answer(expected.decode('utf-8'),
+                                        ans, accuracy):
+                    result = "[bold green]✅[/bold green]"
+                    count += 1
+                else:
+                    result = "[bold red]❌[/bold red]"
+
+                in_filename = Path(in_file).parts[-1]
+                out_filename = Path(out_file).parts[-1]
+                time.sleep(0.1)
+                table.add_row(in_filename,
+                              input_content.decode('utf-8'),
+                              out_filename,
+                              escape(expected.decode('utf-8')),
+                              escape(ans),
+                              result)
+                if code != 0 and 'SyntaxError: ' in error:
+                    table.columns[4].style = 'bold red'
+                    break
+
+        data_path = f"{problem_root_folder}{sep}data"
+        console.print(data_path, style="bold blue")
+        console.print(f'Total {total} input/output sample(s) found.')
+        console.print(f"{count}/{total} tests passed.")
+        if count < total:
+            console.print("Check the output columns for differences.")
+            console.print("Keep trying!")
+        else:
+            console.print(
+                "Awesome... Time to submit it to :cat: Kattis! :cat:",
+                style="bold green",
+            )
+            if Confirm.ask("Submit to Kattis?", default=True):
+                kat_language = (
+                    languages.LOCAL_TO_KATTIS.get(loc_language, '')
+                )
+                self.client.submit_solution(
+                    files,
+                    problemid,
+                    kat_language,
+                    mainclass,
+                    tag="",
+                    force=True,
+                )
+
+
+# Default manager for module-level compatibility
+_tester = SolutionTester()
+
+
+def test_samples(
+        problemid: str,
+        loc_language: str,
+        mainclass: str,
+        problem_root_folder: str,
+        files: List[str],
+        lang_config: Dict[Any, Any],
+        accuracy: float = inf
+) -> None:
+    """Module-level wrapper delegating to the :class:`SolutionTester`.
+
+    Keeps the original procedural API for callers that import
+    `test_samples` directly from the module.
+    """
+
+    return _tester.test_samples(problemid, loc_language, mainclass,
+                                problem_root_folder, files, lang_config,
+                                accuracy)