kattis-cli 1.0.1__tar.gz → 1.0.3__tar.gz

{kattis_cli-1.0.1 → kattis_cli-1.0.3}/PKG-INFO

@@ -1,6 +1,6 @@
 Metadata-Version: 2.1
 Name: kattis-cli
-Version: 1.0.1
+Version: 1.0.3
 Summary: A command-line tool for Kattis
 Home-page: https://github.com/rambasnet/kattis-cli
 Author: Ram Basnet
@@ -27,11 +27,16 @@ Description-Content-Type: text/markdown
 # Kattis-CLI
 
 Kattis CLI - download, test and submit Kattis problems using CLI.
-Based on Official Kattis CLI: [https://github.com/Kattis/kattis-cli](https://github.com/Kattis/kattis-cli)
+Inspired by the official Kattis CLI: [https://github.com/Kattis/kattis-cli](https://github.com/Kattis/kattis-cli)
+
+![Tests](https://github.com/rambasnet/kattis-cli/actions/workflows/ci-test.yml/badge.svg)
+[![PyPI version](https://badge.fury.io/py/kattis-cli.svg)](https://badge.fury.io/py/kattis-cli)
+[![PyPI - Downloads](https://img.shields.io/pypi/dm/kattis-cli)](https://pypi.org/project/kattis-cli/)
+[![PyPI - License](https://img.shields.io/pypi/l/kattis-cli)](https://pypi.org/project/kattis-cli/)
 
 ## Requirements
 
-- Python 3.8+ (PyPy preferred as Kattis uses PyPy to run your code)
+- Python 3.8+ (PyPy preferred as Kattis uses PyPy to run your Python3 solutions)
 - [Kattis account](https://open.kattis.com/login/email)
 
 ## Windows
@@ -70,21 +75,25 @@ If you've Python version 3.8 or higher, you can skip creating virtual environmen
 ```bash
 pip install kattis-cli
 python -m pip install kattis-cli
+kattis --version
 ```
 
 - on Windows add the path shown in the output of the above command to your PATH environment variable
 
-
-## Update Kattis-CLI
+## Update/Upgrade Kattis-CLI
 
 - remove or rename **.kattis-cli.toml** file in your home directory
 - activate virtual environment if you've created one for kattis-cli
 
 ```bash
+kattis --version
 pip install kattis-cli --upgrade
 python -m pip install kattis-cli --upgrade
 ```
 
+- on Windows add the path shown in the output of the above command to your PATH environment variable
+
+
 ## Kattis configuration
 
 - run the following command and enter your Kattis credentials
@@ -108,13 +117,13 @@ kattis --help
 - problem id can be found in the last part of the URL of the problem
 - example: [https://open.kattis.com/problems/cold](https://open.kattis.com/problems/cold) => problem id: **cold**
 
-![Problem id](images/problemid.png)
+![Problem id](./images/problemid.png)
 
 ```bash
 kattis get <problem_id>
 ```
 
-![Get problem id from URL](images/kattis_get.png)
+![Get problem id from URL](./images/kattis_get.png)
 
 ### Display problem metadata
 
@@ -123,10 +132,12 @@ cd <problem_id>
 kattis info
 ```
 
-![Problem info](images/kattis_info.png)
+![Problem info](./images/kattis_info.png)
 
 ### Test a solution locally
 
+![Test](images/kattis_test.png)
+
 - currently the following languages have been tested: Python 3, C++, NodeJS, C, Java
 - make sure CLI compilers are in your PATH
 - make sure python3 files have first line shebang: !/usr/bin/env python3
@@ -136,10 +147,20 @@ kattis info
 
 ```bash
 cd <problem_id>
-kattis test
+kattis test # for exact comparion of answers (string and int)
+kattis test -a 6 # Answer accepted upto 6 decimal places of accuracy
+```
+
+### Testing floating point results
+
+- for floating point ouput, problem provides the tolerance or accuracy upto certain decimal points
+- one can use `-a <N>` switch after kattis test command to provide the decimal places of accuracy
+- e.g., the following command checks for accuracy upto 6 decimal points or absolute error upto $10^-6$
+
+```bash
+kattis test -a 6
 ```
 
-![Test](images/kattis_test.png)
 
 ### Submit a problem
 

{kattis_cli-1.0.1 → kattis_cli-1.0.3}/README.md

@@ -1,11 +1,16 @@
 # Kattis-CLI
 
 Kattis CLI - download, test and submit Kattis problems using CLI.
-Based on Official Kattis CLI: [https://github.com/Kattis/kattis-cli](https://github.com/Kattis/kattis-cli)
+Inspired by the official Kattis CLI: [https://github.com/Kattis/kattis-cli](https://github.com/Kattis/kattis-cli)
+
+![Tests](https://github.com/rambasnet/kattis-cli/actions/workflows/ci-test.yml/badge.svg)
+[![PyPI version](https://badge.fury.io/py/kattis-cli.svg)](https://badge.fury.io/py/kattis-cli)
+[![PyPI - Downloads](https://img.shields.io/pypi/dm/kattis-cli)](https://pypi.org/project/kattis-cli/)
+[![PyPI - License](https://img.shields.io/pypi/l/kattis-cli)](https://pypi.org/project/kattis-cli/)
 
 ## Requirements
 
-- Python 3.8+ (PyPy preferred as Kattis uses PyPy to run your code)
+- Python 3.8+ (PyPy preferred as Kattis uses PyPy to run your Python3 solutions)
 - [Kattis account](https://open.kattis.com/login/email)
 
 ## Windows
@@ -44,21 +49,25 @@ If you've Python version 3.8 or higher, you can skip creating virtual environmen
 ```bash
 pip install kattis-cli
 python -m pip install kattis-cli
+kattis --version
 ```
 
 - on Windows add the path shown in the output of the above command to your PATH environment variable
 
-
-## Update Kattis-CLI
+## Update/Upgrade Kattis-CLI
 
 - remove or rename **.kattis-cli.toml** file in your home directory
 - activate virtual environment if you've created one for kattis-cli
 
 ```bash
+kattis --version
 pip install kattis-cli --upgrade
 python -m pip install kattis-cli --upgrade
 ```
 
+- on Windows add the path shown in the output of the above command to your PATH environment variable
+
+
 ## Kattis configuration
 
 - run the following command and enter your Kattis credentials
@@ -82,13 +91,13 @@ kattis --help
 - problem id can be found in the last part of the URL of the problem
 - example: [https://open.kattis.com/problems/cold](https://open.kattis.com/problems/cold) => problem id: **cold**
 
-![Problem id](images/problemid.png)
+![Problem id](./images/problemid.png)
 
 ```bash
 kattis get <problem_id>
 ```
 
-![Get problem id from URL](images/kattis_get.png)
+![Get problem id from URL](./images/kattis_get.png)
 
 ### Display problem metadata
 
@@ -97,10 +106,12 @@ cd <problem_id>
 kattis info
 ```
 
-![Problem info](images/kattis_info.png)
+![Problem info](./images/kattis_info.png)
 
 ### Test a solution locally
 
+![Test](images/kattis_test.png)
+
 - currently the following languages have been tested: Python 3, C++, NodeJS, C, Java
 - make sure CLI compilers are in your PATH
 - make sure python3 files have first line shebang: !/usr/bin/env python3
@@ -110,10 +121,20 @@ kattis info
 
 ```bash
 cd <problem_id>
-kattis test
+kattis test # for exact comparion of answers (string and int)
+kattis test -a 6 # Answer accepted upto 6 decimal places of accuracy
+```
+
+### Testing floating point results
+
+- for floating point ouput, problem provides the tolerance or accuracy upto certain decimal points
+- one can use `-a <N>` switch after kattis test command to provide the decimal places of accuracy
+- e.g., the following command checks for accuracy upto 6 decimal points or absolute error upto $10^-6$
+
+```bash
+kattis test -a 6
 ```
 
-![Test](images/kattis_test.png)
 
 ### Submit a problem
 

{kattis_cli-1.0.1 → kattis_cli-1.0.3}/kattis_cli/main.py

@@ -1,6 +1,15 @@
-""" Main module for the kattis_cli package."""
-__version__ = '0.1.6'
+""" Main module for the kattis_cli package.
+This is the main.py file for the kattis_cli package.
 
+Change the contents here instead of main.py.
+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.3'
+
+from math import inf
 from typing import Tuple
 from rich.console import Console
 import click
@@ -14,10 +23,12 @@ import kattis_cli.kattis_setup as kattis_setup
 
 
 @click.group()
+@click.version_option(version=__version__, prog_name='kattis-cli')
 def main() -> None:
     """
     CLI for downloading, testing and submitting Kattis problems.
     """
+    pass
 
 
 @main.command(help='Download sample data & metadata.')
@@ -33,7 +44,7 @@ def get(problemid: str) -> None:
     except requests.exceptions.InvalidURL:
         console.print(
             f"""Sample data for Problem ID: [bold blue]
-{problemid}[/bold blue] not found.")
+            {problemid}[/bold blue] not found.")
             """)
     console.print(
         f"Downloading metadata: [bold blue]{problemid}[/bold blue]")
@@ -52,11 +63,14 @@ def info(problemid: str) -> None:
 @click.option('-p', '--problemid', default='', help='Problem ID')
 @click.option('-l', '--language', default='', help='Sets language')
 @click.option('-m', '--mainclass', default='', help='Sets mainclass/mainfile')
+@click.option('-a', '--accuracy', default=inf,
+              help='Decimal places for float comparison')
 @click.argument('files', nargs=-1, required=False)
 def test(
         problemid: str,
         language: str,
         mainclass: str,
+        accuracy: float,
         files: Tuple[str]) -> None:
     """Test solution with sample files.
     """
@@ -74,7 +88,8 @@ def test(
         mainclass,
         root_folder,
         _files,
-        lang_config)
+        lang_config,
+        accuracy)
 
 
 @main.command(help='Submit a solution to Kattis.')

{kattis_cli-1.0.1 → kattis_cli-1.0.3}/kattis_cli/test_solution.py

@@ -1,6 +1,7 @@
 """Tester module for Kattis.
 """
 
+from math import inf
 from typing import Any, List, Dict
 import glob
 import time
@@ -19,13 +20,33 @@ from kattis_cli import kattis
 from kattis_cli.utils import run_program, utility
 
 
+def compare_floats(expected: str, ans: str, places: float) -> bool:
+    """Compare two floating point numbers with given accuracy.
+
+    Args:
+        expected (str): expected result
+        ans (str): actual result
+        places (float): decimal places for approximation
+
+    Returns:
+        bool: True if the two numbers are equal within the given accuracy
+    """
+    try:
+        flt_expected = float(expected)
+        flt_ans = float(ans)
+        return abs(flt_expected - flt_ans) <= 10**(-places)
+    except ValueError:
+        return False
+
+
 def test_samples(
         problemid: str,
         loc_language: str,
         mainclass: str,
         problem_root_folder: str,
         files: List[str],
-        lang_config: Dict[Any, Any]
+        lang_config: Dict[Any, Any],
+        accuracy: float = inf
 ) -> None:
     """Tests a problem by running all the .in files in
     the problem folder and comparing the output to the .ans files.
@@ -126,11 +147,18 @@ def test_samples(
             if code != 0:
                 ans = error
             # console.print(f"{ans=} {error=}")
-            if expected == ans.encode('utf-8').strip():
-                result = "[bold green]✅[/bold green]"
-                count += 1
-            else:
-                result = "[bold red]❌[/bold red]"
+            if accuracy == inf:  # string comparison
+                if expected == ans.encode('utf-8').strip():
+                    result = "[bold green]✅[/bold green]"
+                    count += 1
+                else:
+                    result = "[bold red]❌[/bold red]"
+            else:  # floating point comparison
+                if compare_floats(expected.decode('utf-8'), ans, accuracy):
+                    result = "[bold green]✅[/bold green]"
+                    count += 1
+                else:
+                    result = "[bold red]❌[/bold red]"
 
             # UI Table Row ---
             in_filename = Path(in_file).parts[-1]

{kattis_cli-1.0.1 → kattis_cli-1.0.3}/kattis_cli/utils/utility.py

@@ -66,7 +66,6 @@ GUESS_MAINFILE = {
     'Common Lisp',
     'Pascal',
     'PHP',
-    'Python 2',
     'Python 3',
     'Ruby',
     'Rust',
@@ -77,7 +76,6 @@ GUESS_MAINFILE = {
 # mapping is used for .kattis-cli.toml file configuration
 LOCAL_TO_KATTIS = {
     'python3': 'Python 3',
-    'python2': 'Python 2',
     'java': 'Java',
     'cpp': 'C++',
     'c++': 'C++',
@@ -132,40 +130,10 @@ def guess_language(ext: str, files: List[str]) -> str:
         else:
             return "cpp"
     if ext == ".py":
-        if is_python2(files):
-            return "python2"
-        else:
-            return "python3"
+        return "python3"
     return LANGUAGE_GUESS.get(ext, '')
 
 
-def is_python2(files: List[str]) -> bool:
-    """Check if python2.
-
-    Args:
-        files (List[str]): Tuple of files.
-
-    Returns:
-       bool: True if python2, False otherwise.
-    """
-    python2 = re.compile(r'^\s*\bprint\b *[^ \(\),\]]|\braw_input\b')
-    for filename in files:
-        try:
-            with open(filename, 'r', encoding='utf-8') as f:
-                for index, line in enumerate(f):
-                    # print(index, line)
-                    if index == 0 and line.startswith('#!'):
-                        if 'python2' in line:
-                            return True
-                        if 'python3' in line:
-                            return False
-                    if python2.search(line.split('#')[0]):
-                        return True
-        except IOError:
-            return False
-    return False
-
-
 # flake8: noqa: C901
 def guess_mainfile(
         kat_language: str,

{kattis_cli-1.0.1 → kattis_cli-1.0.3}/pyproject.toml

@@ -1,6 +1,6 @@
 [tool.poetry]
 name = "kattis-cli"
-version = "1.0.1"
+version = "1.0.3"
 authors = ["Ram Basnet <rambasnet@gmail.com>"]
 description = "A command-line tool for Kattis"
 readme = "README.md"