rbx.cp 0.6.0__tar.gz → 0.7.0__tar.gz

{rbx_cp-0.6.0 → rbx_cp-0.7.0}/PKG-INFO

@@ -1,11 +1,10 @@
 Metadata-Version: 2.3
 Name: rbx.cp
-Version: 0.6.0
+Version: 0.7.0
 Summary: 
 Author: Roberto Sales
-Requires-Python: >=3.9,<4.0
+Requires-Python: >=3.9.1,<4.0.0
 Classifier: Programming Language :: Python :: 3
-Classifier: Programming Language :: Python :: 3.9
 Classifier: Programming Language :: Python :: 3.10
 Classifier: Programming Language :: Python :: 3.11
 Classifier: Programming Language :: Python :: 3.12
@@ -35,15 +34,21 @@ Requires-Dist: pyyaml (>=6.0.1,<7.0.0)
 Requires-Dist: questionary (>=2.1.0,<3.0.0)
 Requires-Dist: requests (>=2.32.3,<3.0.0)
 Requires-Dist: rich (>=13.9.4,<14.0.0)
+Requires-Dist: ruamel-yaml (>=0.18.14,<0.19.0)
 Requires-Dist: ruyaml (>=0.91.0,<0.92.0)
 Requires-Dist: syncer (>=2.0.3,<3.0.0)
 Requires-Dist: textual (>=3.1.1,<4.0.0)
 Requires-Dist: textual-serve (>=1.1.2,<2.0.0)
 Requires-Dist: typer (>=0.15.1,<0.16.0)
+Requires-Dist: yamlfix (>=1.17.0,<2.0.0)
 Description-Content-Type: text/markdown
 
 <p align="center">
-    <em>The go-to CLI tool for competitive programmers and setters.</em>
+	<img src="docs/rbx_white.png" alt="rbx" width="200">
+</p>
+
+<p align="center">
+    <em>The go-to CLI tool for programming competitions setters.</em>
 </p>
 <p align="center">
 	<!-- loscal repository, no metadata badges. -->
@@ -60,6 +65,7 @@ Description-Content-Type: text/markdown
   <summary>Table of Contents</summary><br>
 
 - [Overview](#overview)
+- [Features](#features)
 - [Documentation](#documentation)
 - [License](#license)
 </details>
@@ -73,9 +79,20 @@ Description-Content-Type: text/markdown
 [![PyPI pyversions](https://img.shields.io/pypi/pyversions/rbx.svg)](https://pypi.python.org/pypi/rbx/)
 [![PyPI version shields.io](https://img.shields.io/pypi/v/rbx.svg)](https://pypi.python.org/pypi/rbx/)
 
-rbx is a CLI tool and library that aims to help contestants and setters from the competitive programming community to have an easier time.
+**rbx** is a CLI tool that empowers setters from the competitive programming community.
+
+A flexible setting tool, as powerful as [Polygon](https://polygon.codeforces.com/), right on your terminal.
+
+--- 
+
+## Features
 
-Although trying to solve the issues of these two audiences seems to be too much for a single tool to handle, we exploit the fact that the journeys of contestants and setters have a lot in common.
+- 🧱 Structure: describe your problem or contest structure with the use of YAML configuration files.
+- 🤖 Generation: provides a simple way to describe your whole testset, including both manually added and generated testcases.
+- 🔨 Testing: provides commands for automatically running correct and incorrect solutions against the testcases of your problem, automatically judging whether the verdict was as expected or not.
+- ✅ Verify: checks if your testcases and solutions are strictly conformant with the use of validators and unit tests.
+- 📝 Statements: provides tooling for writing and building statements, also ensuring they're easily synchronized with your testset.
+- 📤 Package: provides a single command for packaging your problems for use in your preferred judge system.
 
 ---
 

{rbx_cp-0.6.0 → rbx_cp-0.7.0}/README.md

@@ -1,5 +1,9 @@
 <p align="center">
-    <em>The go-to CLI tool for competitive programmers and setters.</em>
+	<img src="docs/rbx_white.png" alt="rbx" width="200">
+</p>
+
+<p align="center">
+    <em>The go-to CLI tool for programming competitions setters.</em>
 </p>
 <p align="center">
 	<!-- loscal repository, no metadata badges. -->
@@ -16,6 +20,7 @@
   <summary>Table of Contents</summary><br>
 
 - [Overview](#overview)
+- [Features](#features)
 - [Documentation](#documentation)
 - [License](#license)
 </details>
@@ -29,9 +34,20 @@
 [![PyPI pyversions](https://img.shields.io/pypi/pyversions/rbx.svg)](https://pypi.python.org/pypi/rbx/)
 [![PyPI version shields.io](https://img.shields.io/pypi/v/rbx.svg)](https://pypi.python.org/pypi/rbx/)
 
-rbx is a CLI tool and library that aims to help contestants and setters from the competitive programming community to have an easier time.
+**rbx** is a CLI tool that empowers setters from the competitive programming community.
+
+A flexible setting tool, as powerful as [Polygon](https://polygon.codeforces.com/), right on your terminal.
+
+--- 
+
+## Features
 
-Although trying to solve the issues of these two audiences seems to be too much for a single tool to handle, we exploit the fact that the journeys of contestants and setters have a lot in common.
+- 🧱 Structure: describe your problem or contest structure with the use of YAML configuration files.
+- 🤖 Generation: provides a simple way to describe your whole testset, including both manually added and generated testcases.
+- 🔨 Testing: provides commands for automatically running correct and incorrect solutions against the testcases of your problem, automatically judging whether the verdict was as expected or not.
+- ✅ Verify: checks if your testcases and solutions are strictly conformant with the use of validators and unit tests.
+- 📝 Statements: provides tooling for writing and building statements, also ensuring they're easily synchronized with your testset.
+- 📤 Package: provides a single command for packaging your problems for use in your preferred judge system.
 
 ---
 

{rbx_cp-0.6.0 → rbx_cp-0.7.0}/pyproject.toml

@@ -1,6 +1,6 @@
 [tool.poetry]
 name = "rbx.cp"
-version = "0.6.0"
+version = "0.7.0"
 description = ""
 packages = [
   {include = "rbx"}
@@ -12,7 +12,7 @@ exclude = [
 ]
 
 [tool.poetry.dependencies]
-python = "^3.9"
+python = "^3.9.1"
 typer = "^0.15.1"
 fastapi = "^0.115.8"
 filelock = "^3.14.0"
@@ -43,6 +43,8 @@ colour = "^0.1.5"
 beautifulsoup4 = "^4.13.4"
 dateparser = "^1.2.1"
 deepmerge = "^2.0"
+yamlfix = "^1.17.0"
+ruamel-yaml = "^0.18.14"
 
 [tool.poetry.scripts]
 rbc = "rbx.main:app"
@@ -63,7 +65,16 @@ pytest-cov = "^5.0.0"
 textual-dev = "^1.6.1"
 pytest-asyncio = "^0.26.0"
 mkdocs-gen-files = "^0.5.0"
+markdown-grid-tables = "^0.5.0"
 
+
+[tool.commitizen]
+name = "cz_conventional_commits"
+tag_format = "$version"
+version_scheme = "pep440"
+version_provider = "poetry"
+update_changelog_on_bump = true
+major_version_zero = true
 [build-system]
 requires = ["poetry-core"]
 build-backend = "poetry.core.masonry.api"

rbx_cp-0.7.0/rbx/box/cd.py

@@ -0,0 +1,98 @@
+import contextlib
+import functools
+import pathlib
+from typing import List, Optional
+
+import typer
+
+from rbx import console
+from rbx.box.sanitizers import warning_stack
+from rbx.utils import new_cd
+
+
+def find_package(
+    root: pathlib.Path = pathlib.Path(), consider_presets: bool = False
+) -> Optional[pathlib.Path]:
+    root = root.resolve()
+
+    def has_file():
+        problem_yaml_path = root / 'problem.rbx.yml'
+        contest_yaml_path = root / 'contest.rbx.yml'
+        preset_yaml_path = root / 'preset.rbx.yml'
+        return (
+            problem_yaml_path.is_file()
+            or contest_yaml_path.is_file()
+            or (consider_presets and preset_yaml_path.is_file())
+        )
+
+    while root != pathlib.PosixPath('/') and not has_file():
+        root = root.parent
+    if not has_file():
+        return None
+    return root
+
+
+def find_all_ancestor_packages(
+    root: pathlib.Path = pathlib.Path(),
+) -> List[pathlib.Path]:
+    packages = []
+    while (pkg := find_package(root)) is not None:
+        packages.append(pkg)
+        root = pkg.parent
+    return packages
+
+
+def is_problem_package(root: pathlib.Path = pathlib.Path()) -> bool:
+    dir = find_package(root)
+    if dir is None:
+        return False
+    return (dir / 'problem.rbx.yml').is_file()
+
+
+def is_contest_package(root: pathlib.Path = pathlib.Path()) -> bool:
+    dir = find_package(root)
+    if dir is None:
+        return False
+    return (dir / 'contest.rbx.yml').is_file()
+
+
+def is_preset_package(root: pathlib.Path = pathlib.Path()) -> bool:
+    dir = find_package(root, consider_presets=True)
+    if dir is None:
+        return False
+    return (dir / 'preset.rbx.yml').is_file()
+
+
+def within_closest_package(func, consider_presets: bool = False):
+    @functools.wraps(func)
+    def wrapper(*args, **kwargs):
+        package = find_package(consider_presets=consider_presets)
+        if package is None:
+            console.console.print('[error]No rbx package found.[/error]')
+            raise typer.Exit(1)
+        # Get deepest package.
+        with new_package_cd(package):
+            return func(*args, **kwargs)
+
+    return wrapper
+
+
+def within_closest_wrapper(func):
+    @functools.wraps(func)
+    def wrapper(*args, **kwargs):
+        package = find_package(consider_presets=True)
+        if package is None:
+            console.console.print('[error]No rbx package found.[/error]')
+            raise typer.Exit(1)
+        # Get deepest package.
+        with new_package_cd(package):
+            return func(*args, **kwargs)
+
+    return wrapper
+
+
+@contextlib.contextmanager
+def new_package_cd(x: pathlib.Path):
+    with new_cd(x):
+        yield
+        warning_stack.print_warning_stack_report()

{rbx_cp-0.6.0 → rbx_cp-0.7.0}/rbx/box/checkers.py

@@ -141,9 +141,16 @@ def _is_checker_exitcode(exitcode: int) -> bool:
     return exitcode in [0, 1, 2, 3]
 
 
+def _get_last_line(message: str) -> str:
+    if not message:
+        return ''
+    return message.strip().split('\n')[-1]
+
+
 def process_checker_run_log(
     checker_run_log: Optional[RunLog], message: str
 ) -> CheckerResult:
+    message = _get_last_line(message)
     if (
         checker_run_log is not None
         and checker_run_log.exitstatus == SandboxBase.EXIT_SANDBOX_ERROR
@@ -352,7 +359,8 @@ async def check_communication(
         return _extra_check_and_sanitize(result)
 
     # Just a defensive pattern to ensure result is not None, should never happen.
-    result = check_with_no_output(interactor_run_log)
+    if result is None:
+        result = check_with_no_output(interactor_run_log)
     if result.outcome != Outcome.ACCEPTED:
         if result.outcome == Outcome.RUNTIME_ERROR:
             result.outcome = Outcome.JUDGE_FAILED

{rbx_cp-0.6.0 → rbx_cp-0.7.0}/rbx/box/cli.py

@@ -26,7 +26,7 @@ from rbx.box import (
 )
 from rbx.box.contest import main as contest
 from rbx.box.contest.contest_package import find_contest_yaml
-from rbx.box.environment import VerificationLevel, get_environment_path
+from rbx.box.environment import VerificationLevel, get_app_environment_path
 from rbx.box.header import generate_header
 from rbx.box.packaging import main as packaging
 from rbx.box.schema import CodeItem, ExpectedOutcome, TestcaseGroup
@@ -333,7 +333,7 @@ async def run(
     )
 
 
-async def _time_impl(check: bool, detailed: bool) -> Optional[int]:
+async def _time_impl(check: bool, detailed: bool, runs: int = 0) -> Optional[int]:
     if package.get_main_solution() is None:
         console.console.print(
             '[warning]No main solution found, so cannot estimate a time limit.[/warning]'
@@ -353,6 +353,7 @@ async def _time_impl(check: bool, detailed: bool) -> Optional[int]:
             check=check,
             verification=VerificationLevel(verification),
             timelimit_override=-1,  # Unlimited for time limit estimation
+            nruns=runs,
         )
 
     console.console.print()
@@ -397,6 +398,12 @@ async def time(
         '-d',
         help='Whether to print a detailed view of the tests using tables.',
     ),
+    runs: int = typer.Option(
+        0,
+        '--runs',
+        '-r',
+        help='Number of runs to perform for each solution. Zero means the config default.',
+    ),
 ):
     main_solution = package.get_main_solution()
     if check and main_solution is None:
@@ -411,7 +418,7 @@ async def time(
     if not await builder.build(verification=verification, output=check):
         return None
 
-    await _time_impl(check, detailed)
+    await _time_impl(check, detailed, runs)
 
 
 @app.command(
@@ -814,6 +821,7 @@ def header():
     generate_header()
 
 
+# TODO: warn when using a preset (or show it)
 @app.command(
     'environment, env',
     rich_help_panel='Configuration',
@@ -831,15 +839,14 @@ def environment_command(
     ] = None,
 ):
     if env is None:
-        cfg = config.get_config()
-        console.console.print(f'Current environment: [item]{cfg.boxEnvironment}[/item]')
         console.console.print(
-            f'Location: {environment.get_environment_path(cfg.boxEnvironment)}'
+            f'Current environment: [item]{environment.get_active_environment_description()}[/item]'
         )
+        console.console.print(f'Location: {environment.get_active_environment_path()}')
         return
     if install_from is not None:
         environment.install_environment(env, pathlib.Path(install_from))
-    if not get_environment_path(env).is_file():
+    if not get_app_environment_path(env).is_file():
         console.console.print(
             f'[error]Environment [item]{env}[/item] does not exist.[/error]'
         )
@@ -852,7 +859,7 @@ def environment_command(
         )
         return
     console.console.print(
-        f'Changing box environment from [item]{cfg.boxEnvironment}[/item] to [item]{env}[/item]...'
+        f'Changing global environment from [item]{cfg.boxEnvironment}[/item] to [item]{env}[/item]...'
     )
     cfg.boxEnvironment = env
     config.save_config(cfg)
@@ -861,43 +868,6 @@ def environment_command(
     clear()
 
 
-@app.command(
-    'activate',
-    rich_help_panel='Configuration',
-    help='Activate the environment of the current preset used by the package.',
-)
-@cd.within_closest_package
-def activate():
-    preset_lock = presets.get_preset_lock()
-    if preset_lock is None:
-        console.console.print(
-            '[warning]No configured preset to be activated for this package.[/warning]'
-        )
-        raise typer.Exit(1)
-
-    preset = presets.get_installed_preset_or_null(preset_lock.preset_name)
-    if preset is None:
-        if preset_lock.uri is None:
-            console.console.print(
-                '[error]Preset is not installed. Install it manually, or specify a URI in [item].preset-lock.yml[/item].[/error]'
-            )
-            raise typer.Exit(1)
-        presets.install(preset_lock.uri)
-
-    preset = presets.get_installed_preset(preset_lock.preset_name)
-
-    # Install the environment from the preset if it's not already installed.
-    presets.optionally_install_environment_from_preset(
-        preset, root=presets.get_preset_installation_path(preset_lock.name)
-    )
-
-    # Activate the environment.
-    if preset.env is not None:
-        environment_command(preset.name)
-
-    console.console.print(f'[success]Preset [item]{preset.name}[/item] is activated.')
-
-
 @app.command(
     'languages',
     rich_help_panel='Configuration',
@@ -918,6 +888,40 @@ def languages():
         console.console.print()
 
 
+@app.command(
+    'stats',
+    rich_help_panel='Management',
+    help='Show stats about current and related packages.',
+)
+@cd.within_closest_package
+def stats(
+    transitive: bool = typer.Option(
+        False,
+        '--transitive',
+        '-t',
+        help='Show stats about all reachable packages.',
+    ),
+):
+    from rbx.box import stats
+
+    if transitive:
+        stats.print_reachable_package_stats()
+    else:
+        stats.print_package_stats()
+
+
+@app.command(
+    'fix',
+    rich_help_panel='Management',
+    help='Format files of the current package.',
+)
+@cd.within_closest_wrapper
+def fix(print_diff: bool = typer.Option(False, '--print-diff', '-p')):
+    from rbx.box import linting
+
+    linting.fix_package(print_diff=print_diff)
+
+
 @app.command(
     'clear, clean',
     rich_help_panel='Management',

{rbx_cp-0.6.0 → rbx_cp-0.7.0}/rbx/box/code.py

@@ -408,6 +408,7 @@ def _precompile_header(
     input_artifact: GradingFileInput,
     force_warnings: bool = False,
     verbose: bool = False,
+    include_other_headers: bool = False,
 ) -> GradingFileInput:
     """
     Precompile a header file (.h).
@@ -435,11 +436,12 @@ def _precompile_header(
     precompilation_artifacts = GradingArtifacts()
 
     # Keep only header files.
-    precompilation_artifacts.inputs = [
-        input
-        for input in artifacts.inputs
-        if input.src is not None and input.src.suffix == '.h'
-    ]
+    if include_other_headers:
+        precompilation_artifacts.inputs = [
+            input
+            for input in artifacts.inputs
+            if input.src is not None and input.src.suffix == '.h'
+        ]
     precompilation_artifacts.inputs.append(
         GradingFileInput(
             src=input_artifact.src,
@@ -572,14 +574,14 @@ def compile_item(
             if is_cxx_command(get_exe_from_command(command))
         ]
 
-    # Precompile C++ header files.
+    # Precompile C++ interesting header files.
     if precompile and _should_precompile(commands):
         precompilation_inputs = []
         for input in artifacts.inputs:
             if (
                 input.src is not None
                 and input.src.suffix == '.h'
-                and input.dest.suffix == '.h'
+                and input.dest.name in ['stdc++.h', 'jngen.h', 'testlib.h']
             ):
                 precompilation_inputs.append(
                     _precompile_header(

{rbx_cp-0.6.0 → rbx_cp-0.7.0}/rbx/box/contest/contest_package.py

@@ -9,7 +9,7 @@ from pydantic import ValidationError
 from rbx import console, utils
 from rbx.box import cd
 from rbx.box.contest.schema import Contest
-from rbx.box.package import find_problem_package_or_die, warn_preset_deactivated
+from rbx.box.package import find_problem_package_or_die
 from rbx.box.schema import Package
 
 YAML_NAME = 'contest.rbx.yml'
@@ -24,7 +24,6 @@ def find_contest_yaml(root: pathlib.Path = pathlib.Path()) -> Optional[pathlib.P
         contest_yaml_path = root / YAML_NAME
     if not contest_yaml_path.is_file():
         return None
-    warn_preset_deactivated(root)
     return contest_yaml_path
 
 
@@ -84,12 +83,10 @@ def get_problems(contest: Contest) -> List[Package]:
     return problems
 
 
-def get_ruyaml() -> Tuple[ruyaml.YAML, ruyaml.Any]:
-    contest_yaml_path = find_contest_yaml()
+def get_ruyaml(root: pathlib.Path = pathlib.Path()) -> Tuple[ruyaml.YAML, ruyaml.Any]:
+    contest_yaml_path = find_contest_yaml(root)
     if contest_yaml_path is None:
-        console.console.print(
-            f'Contest not found in {pathlib.Path().absolute()}', style='error'
-        )
+        console.console.print(f'[error]Contest not found in {root.absolute()}[/error]')
         raise typer.Exit(1)
     res = ruyaml.YAML()
     return res, res.load(contest_yaml_path.read_text())

{rbx_cp-0.6.0 → rbx_cp-0.7.0}/rbx/box/contest/main.py

@@ -16,8 +16,8 @@ from rbx.box.contest.contest_package import (
     within_contest,
 )
 from rbx.box.contest.schema import ContestProblem
+from rbx.box.linting import fix_package
 from rbx.box.packaging import contest_main as packaging
-from rbx.box.presets.fetch import get_preset_fetch_info
 from rbx.box.schema import Package
 from rbx.config import open_editor
 
@@ -40,53 +40,18 @@ app.add_typer(
 def create(
     path: str,
     preset: Annotated[
-        str,
+        Optional[str],
         typer.Option(
             '--preset',
             '-p',
-            help='Which preset to use to create this package. Can be a named of an already installed preset, or an URI, in which case the preset will be downloaded.',
+            help='Which preset to use to create this package. Can be a named of an already installed preset, or an URI, in which case the preset will be downloaded.\n'
+            'If not provided, the default preset will be used, or the active preset if any.',
         ),
-    ] = 'default',
-    local: bool = typer.Option(
-        False,
-        '--local',
-        '-l',
-        help='Whether to inline the installed preset within the contest folder.',
-    ),
+    ] = None,
 ):
     console.console.print(f'Creating new contest at [item]{path}[/item]...')
 
-    fetch_info = get_preset_fetch_info(preset)
-    if fetch_info is None:
-        console.console.print(
-            f'[error]Invalid preset name/URI [item]{preset}[/item][/error]'
-        )
-        raise typer.Exit(1)
-
-    if fetch_info.is_remote():
-        preset = presets.install_from_remote(fetch_info)
-    elif fetch_info.is_local_dir():
-        preset = presets.install_from_local_dir(fetch_info)
-
-    preset_cfg = presets.get_installed_preset(preset)
-    preset_path = (
-        presets.get_preset_installation_path(preset)
-        if preset_cfg.contest is not None
-        else presets.get_preset_installation_path('default')
-    )
-
-    contest_path = (
-        presets.get_preset_installation_path(preset) / preset_cfg.contest
-        if preset_cfg.contest is not None
-        else presets.get_preset_installation_path('default') / 'contest'
-    )
-
-    if not contest_path.is_dir():
-        console.console.print(
-            f'[error]Contest template [item]{contest_path}[/item] does not exist.[/error]'
-        )
-        raise typer.Exit(1)
-
+    fetch_info = presets.get_preset_fetch_info_with_fallback(preset)
     dest_path = pathlib.Path(path)
 
     if dest_path.exists():
@@ -100,23 +65,35 @@ def create(
             )
             raise typer.Exit(1)
 
-    dest_path.mkdir(parents=True, exist_ok=True)
-    shutil.copytree(str(contest_path), str(dest_path), dirs_exist_ok=True)
-    shutil.rmtree(str(dest_path / 'build'), ignore_errors=True)
-    shutil.rmtree(str(dest_path / '.box'), ignore_errors=True)
-    shutil.rmtree(str(dest_path / '.local.rbx'), ignore_errors=True)
-    # TODO: consider clearing build and .box recursively for nested problem directories
-    for lock in dest_path.rglob('.preset-lock.yml'):
-        lock.unlink(missing_ok=True)
-
-    if local:
-        presets.copy_local_preset(
-            preset_path, dest_path, remote_uri=fetch_info.uri or preset_cfg.uri
-        )
+    presets.install_contest(dest_path, fetch_info)
 
     with cd.new_package_cd(dest_path):
         contest_utils.clear_all_caches()
-        presets.generate_lock(preset if not local else presets.LOCAL)
+        fix_package()
+        presets.generate_lock()
+
+
+@app.command('init, i', help='Initialize a new contest in the current directory.')
+def init(
+    preset: Annotated[
+        Optional[str],
+        typer.Option(
+            '--preset',
+            '-p',
+            help='Which preset to use to create this package. Can be a named of an already installed preset, or an URI, in which case the preset will be downloaded.\n'
+            'If not provided, the default preset will be used, or the active preset if any.',
+        ),
+    ] = None,
+):
+    console.console.print('Initializing new contest in the current directory...')
+
+    fetch_info = presets.get_preset_fetch_info_with_fallback(preset)
+
+    presets.install_contest(pathlib.Path.cwd(), fetch_info)
+
+    contest_utils.clear_all_caches()
+    fix_package()
+    presets.generate_lock()
 
 
 @app.command('edit, e', help='Open contest.rbx.yml in your default editor.')
@@ -143,9 +120,6 @@ def add(path: str, short_name: str, preset: Optional[str] = None):
         )
         raise typer.Exit(1)
 
-    preset_lock = presets.get_preset_lock()
-    if preset is None and preset_lock is not None:
-        preset = preset_lock.preset_name
     creation.create(name, preset=preset, path=pathlib.Path(path))
 
     contest = find_contest_package_or_die()