rimuruchan-p2d 0.4.2__tar.gz

rimuruchan_p2d-0.4.2/.github/workflows/release.yml

@@ -0,0 +1,48 @@
+name: Release
+
+on:
+  workflow_dispatch:
+
+jobs:
+  release:
+    runs-on: ubuntu-latest
+    steps:
+      - uses: actions/checkout@v4
+        with:
+          fetch-depth: 0
+
+      - name: Set node
+        uses: actions/setup-node@v4
+        with:
+          node-version: 18.x
+
+      - run: npx changelogithub
+        env:
+          GITHUB_TOKEN: ${{ secrets.GITHUB_TOKEN }}
+
+  release-pypi:
+    runs-on: ubuntu-latest
+
+    steps:
+      - uses: actions/checkout@v4
+
+      - name: Checkout repository
+        uses: actions/checkout@v4
+        with:
+          fetch-depth: 0
+
+      - name: Install uv and set the python version
+        uses: astral-sh/setup-uv@v5
+        with:
+          enable-cache: true
+          cache-dependency-glob: "uv.lock"
+
+      - name: Build
+        run: |
+          uv build
+
+      - name: Publish
+        uses: pypa/gh-action-pypi-publish@release/v1
+        with:
+          user: __token__
+          password: ${{ secrets.PYPI_API_TOKEN }}

rimuruchan_p2d-0.4.2/.github/workflows/test.yml

@@ -0,0 +1,56 @@
+# yaml-language-server: $schema=https://json-schema.org/draft-07/schema#
+name: Test
+
+on:
+  push:
+    branches:
+      - master
+    paths:
+      - "uv.lock"
+      - "pyproject.toml"
+      - "p2d/**"
+      - "test/**"
+      - ".github/workflows/**"
+  pull_request:
+    types: [ opened, synchronize, reopened, ready_for_review ]
+    paths:
+      - "uv.lock"
+      - "pyproject.toml"
+      - "p2d/**"
+      - "test/**"
+      - ".github/workflows/**"
+  workflow_dispatch:
+
+jobs:
+  test:
+    name: Test
+    runs-on: ${{ matrix.os }}
+    strategy:
+      matrix:
+        os: [ubuntu-latest, macos-latest, windows-latest]
+        python-version: ["3.10", "3.11", "3.12", "3.13"]
+      fail-fast: false
+    steps:
+      - name: Checkout repository
+        uses: actions/checkout@v4
+        with:
+          fetch-depth: 0
+
+      - name: Install uv and set the python version
+        uses: astral-sh/setup-uv@v5
+        with:
+          python-version: ${{ matrix.python-version }}
+          enable-cache: true
+          cache-dependency-glob: "uv.lock"
+
+      - name: Install the project
+        run: |
+          uv sync --all-extras --dev
+
+      - name: Lint
+        run: |
+          uv tool run ruff check
+
+      - name: Unit Test
+        run: |
+          uv run --frozen pytest

rimuruchan_p2d-0.4.2/.gitignore

@@ -0,0 +1,168 @@
+__pycache__/
+*.py[cod]
+*$py.class
+
+# C extensions
+*.so
+
+# Distribution / packaging
+.Python
+build/
+develop-eggs/
+dist/
+downloads/
+eggs/
+.eggs/
+lib/
+lib64/
+parts/
+sdist/
+var/
+wheels/
+share/python-wheels/
+*.egg-info/
+.installed.cfg
+*.egg
+MANIFEST
+
+# PyInstaller
+#  Usually these files are written by a python script from a template
+#  before PyInstaller builds the exe, so as to inject date/other infos into it.
+*.manifest
+*.spec
+
+# Installer logs
+pip-log.txt
+pip-delete-this-directory.txt
+
+# Unit test / coverage reports
+htmlcov/
+.tox/
+.nox/
+.coverage
+.coverage.*
+.cache
+nosetests.xml
+coverage.xml
+*.cover
+*.py,cover
+.hypothesis/
+.pytest_cache/
+cover/
+
+# Translations
+*.mo
+*.pot
+
+# Django stuff:
+*.log
+local_settings.py
+db.sqlite3
+db.sqlite3-journal
+
+# Flask stuff:
+instance/
+.webassets-cache
+
+# Scrapy stuff:
+.scrapy
+
+# Sphinx documentation
+docs/_build/
+
+# PyBuilder
+.pybuilder/
+target/
+
+# Jupyter Notebook
+.ipynb_checkpoints
+
+# IPython
+profile_default/
+ipython_config.py
+
+# pyenv
+#   For a library or package, you might want to ignore these files since the code is
+#   intended to run in multiple environments; otherwise, check them in:
+# .python-version
+
+# pipenv
+#   According to pypa/pipenv#598, it is recommended to include Pipfile.lock in version control.
+#   However, in case of collaboration, if having platform-specific dependencies or dependencies
+#   having no cross-platform support, pipenv may install dependencies that don't work, or not
+#   install all needed dependencies.
+#Pipfile.lock
+
+# poetry
+#   Similar to Pipfile.lock, it is generally recommended to include poetry.lock in version control.
+#   This is especially recommended for binary packages to ensure reproducibility, and is more
+#   commonly ignored for libraries.
+#   https://python-poetry.org/docs/basic-usage/#commit-your-poetrylock-file-to-version-control
+#poetry.lock
+
+# pdm
+#   Similar to Pipfile.lock, it is generally recommended to include pdm.lock in version control.
+#pdm.lock
+#   pdm stores project-wide configurations in .pdm.toml, but it is recommended to not include it
+#   in version control.
+#   https://pdm.fming.dev/#use-with-ide
+.pdm.toml
+
+# PEP 582; used by e.g. github.com/David-OConnor/pyflow and github.com/pdm-project/pdm
+__pypackages__/
+
+# Celery stuff
+celerybeat-schedule
+celerybeat.pid
+
+# SageMath parsed files
+*.sage.py
+
+# Environments
+.env
+.venv
+env/
+venv/
+ENV/
+env.bak/
+venv.bak/
+
+# Spyder project settings
+.spyderproject
+.spyproject
+
+# Rope project settings
+.ropeproject
+
+# mkdocs documentation
+/site
+
+# mypy
+.mypy_cache/
+.dmypy.json
+dmypy.json
+
+# Pyre type checker
+.pyre/
+
+# pytype static type analyzer
+.pytype/
+
+# Cython debug symbols
+cython_debug/
+
+# PyCharm
+#  JetBrains specific template is maintained in a separate JetBrains.gitignore that can
+#  be found at https://github.com/github/gitignore/blob/main/Global/JetBrains.gitignore
+#  and can be added to the global gitignore or merged into this file.  For a more nuclear
+#  option (not recommended) you can uncomment the following to ignore the entire idea folder.
+#.idea/
+
+tmp/*
+*.log
+*.zip
+
+!/test/test_data/*
+/test/test_output
+
+_version.py

rimuruchan_p2d-0.4.2/.pre-commit-config.yaml

@@ -0,0 +1,12 @@
+repos:
+  - repo: https://github.com/pre-commit/pre-commit-hooks
+    rev: v4.6.0
+    hooks:
+      - id: end-of-file-fixer
+      - id: trailing-whitespace
+      - id: mixed-line-ending
+  - repo: https://github.com/astral-sh/ruff-pre-commit
+    rev: v0.9.10
+    hooks:
+      - id: ruff
+      - id: ruff-format

rimuruchan_p2d-0.4.2/.vscode/settings.json

@@ -0,0 +1,30 @@
+{
+    "editor.tabSize": 4,
+    "editor.insertSpaces": true,
+    "editor.formatOnSave": true,
+    "files.trimTrailingWhitespace": true,
+    "files.insertFinalNewline": true,
+    "files.trimFinalNewlines": true,
+    "[python]": {
+        "editor.defaultFormatter": "charliermarsh.ruff"
+    },
+    "cSpell.words": [
+        "cubercsl",
+        "Domjudge",
+        "interactor",
+        "interactors",
+        "kattis",
+        "memorylimit",
+        "outputlimit",
+        "pypi",
+        "pyright",
+        "pytest",
+        "testlib",
+        "testset",
+        "timelimit"
+    ],
+    "python.testing.pytestArgs": [
+        "test"
+    ],
+    "python.testing.pytestEnabled": true,
+}

rimuruchan_p2d-0.4.2/LICENSE

@@ -0,0 +1,21 @@
+The MIT License (MIT)
+
+Copyright (c) 2024 cn-xcpc-tools contributors
+
+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.

rimuruchan_p2d-0.4.2/PKG-INFO

@@ -0,0 +1,166 @@
+Metadata-Version: 2.4
+Name: rimuruchan-p2d
+Version: 0.4.2
+Summary: Simple python script converting polygon package to domjudge(kattis) package
+Project-URL: homepage, https://github.com/RimuruChan/Polygon2Domjudge
+Project-URL: documentation, https://github.com/RimuruChan/Polygon2Domjudge
+Project-URL: repository, https://github.com/RimuruChan/Polygon2Domjudge
+Author-email: cubercsl <hi@cubercsl.site>, rimuruchan <RealSprite233@outlook.com>
+Maintainer-email: rimuruchan <RealSprite233@outlook.com>
+License-Expression: MIT
+License-File: LICENSE
+Keywords: Codeforces,DOMjudge,Kattis,Polygon
+Classifier: Programming Language :: Python :: 3
+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: Topic :: Software Development :: Build Tools
+Classifier: Topic :: Software Development :: Libraries :: Python Modules
+Requires-Python: >=3.10
+Requires-Dist: deepmerge>=2.0
+Requires-Dist: pydantic>=2.10.6
+Requires-Dist: pyyaml>=6.0.2
+Requires-Dist: rich>=13.9.4
+Requires-Dist: tomli>=2.0.1; python_version < '3.11'
+Requires-Dist: typer-slim[standard]>=0.12.5
+Description-Content-Type: text/markdown
+
+# Polygon2DOMjudge
+
+[![Test][gh-test-badge]][gh-test]
+[![GitHub release][gh-release-badge]][gh-release]
+
+[中文](README.cn.md)
+
+## What is this
+
+It is a simple python script converting polygon package to DOMjudge (kattis) package.
+
+## Install
+
+### From PyPI (stable release, has been used in some contests)
+
+```bash
+pipx install p2d
+```
+
+### From source (latest version, under development with new features)
+
+```bash
+pipx install git+https://github.com/cn-xcpc-tools/Polygon2DOMjudge
+```
+
+## CLI Example
+
+First, you should build **full** package from Polygon and download the **Linux** package to your local.
+
+> [!WARNING]
+> If you download the standard package and then run `doall.sh` to build the full package by yourself, the linebreaks will be CRLF.
+> Make sure you convert the linebreaks to LF before running the script because DOMjudge is running on Linux.
+
+```bash
+# Download the full package from Polygon to /path/to/polygon-package.zip
+$ p2d --code A --color "#FF0000" -o /path/to/domjudge-package.zip /path/to/polygon-package.zip
+```
+
+Run this command to make a package from `/path/to/polygon-package.zip` to `/path/to/domjudge-package.zip` and set `code` and `color`.
+
+You can omit the output path, and the default output path will be in the current working directory and named as `{{ code }}.zip`.
+
+All available parameters are:
+
+- `--code`: problem short name in DOMjudge contest.
+- `--color`: problem color in DOMjudge.
+- `--default`: force use the default output validator.
+- `--validator-flags`: add some flags to the output validator, only works when `--default` is set.
+- `--auto`: use the default output validator if the checker is defined in config and can be replaced by the default one.
+- `--memory-limit`: override the memory limit for DOMjudge package (in MB), default is using the memory limit defined in polygon package.
+- `--output-limit`: override the output limit for DOMjudge package (in MB), default is using the default output limit in DOMjudge setting.
+- `--hide-sample`: hide the sample input and output from the problem statement, no sample data will be available for the contestants (force True if this is an interactive problem).
+    When this is not set to True and the sample output is different from the main and correct solution (usually both are correct answers),
+    the sample output will be replaced with the one shipped with problem statement.
+    But the sample input will not be replaced because DOMjudge does not support different sample input from the one downloaded.
+- `--keep-sample`: keep the sample output from the main and correct solution, this is useful when the sample output from problem statement is a placeholder.
+    (By default, all sample output will be replaced with the one shipped with problem statement)
+- `--external-id`: specify the external id of the problem in DOMjudge, default is using the problem short-name in polygon.
+- `--with-statement`: include the pdf statement in the DOMjudge package.
+- `--with-attachments`: include attachments (e.g. local testing tools for interactive problem) in the DOMjudge package.
+- `--testset`: specify the testset to convert, must specify the testset name if the problem has multiple testsets.
+
+### Convert the whole contest
+
+You can use `p2d-contest` to get a script to convert all problems in a contest.
+
+```bash
+# Download the contest.xml from Polygon first
+$ p2d-contest /path/to/contest.xml > convert.sh
+```
+
+## Config
+
+In [config.toml](./config.example.toml), you can change some special checker's validator's flags, which will be used to replace the checker with the default output validator when `--auto` is set.
+
+> [!NOTE]
+> You should create a new file named `config.toml` or something else and pass it to the script with `--config` parameter. The script will merge the default config with your config.
+
+## Environment Variable
+
+Don't change them unless you know what you are doing.
+
+- `TESTLIB_PATH`
+
+## API Example
+
+> [!WARNING]
+> The API is not stable and may change in the future.
+
+This is an example to convert all problems in a contest defined in [`problems.yaml`](https://ccs-specs.icpc.io/draft/contest_package#problemsyaml) to DOMjudge package.
+
+```python
+import yaml
+from pathlib import Path
+
+from p2d import convert
+
+polygon = Path('/path/to/polygon-packages')
+domjudge = Path('/path/to/domjudge-packages')
+
+with open(domjudge / 'problems.yaml') as f:
+    problems = yaml.safe_load(f)
+
+for problem in problems:
+    prob_id = problem['id']
+    convert(
+        polygon / f'{prob_id}.zip',
+        domjudge / f'{prob_id}.zip',
+        short_name=problem['label'],
+        color=problem['rgb'],
+    )
+```
+
+## Known Issues
+
+- For interactive problems, you must validate the output in the interactors, because DOMjudge cannot handle `tout` stream like Polygon.
+- For multi-pass problems
+  - Some logic are different from Polygon, you may need to modify it to fit the DOMjudge environment, DOMjudge will use `-DDOMJUDGE` macro to distinguish whether it is in DOMjudge environment, so you can use it to adapt your code.
+  - You may need to call `tout.open(make_new_file_in_a_dir(argv[3], "nextpass.in"))` to get the next pass input file when there exists a next pass.
+
+## Development
+
+```bash
+# install
+uv sync
+
+# build
+uv build
+
+# run unittest
+uv run pytest
+
+```
+
+[gh-test-badge]: https://github.com/cn-xcpc-tools/Polygon2DOMjudge/actions/workflows/test.yml/badge.svg
+[gh-test]: https://github.com/cn-xcpc-tools/Polygon2DOMjudge/actions/workflows/test.yml
+[gh-release-badge]: https://img.shields.io/github/release/cn-xcpc-tools/Polygon2DOMjudge.svg
+[gh-release]: https://GitHub.com/cn-xcpc-tools/Polygon2DOMjudge/releases/

rimuruchan_p2d-0.4.2/README.cn.md

@@ -0,0 +1,133 @@
+# Polygon2DOMjudge
+
+[![Test][gh-test-badge]][gh-test]
+[![GitHub release][gh-release-badge]][gh-release]
+
+## 这是什么
+
+这是一个简单的将 polygon 题目包转换成 DOMjudge (kattis) 题目包的 python 脚本。
+
+## 安装
+
+### 从 PyPI（稳定版本, 已经在一些比赛中使用过）
+
+```bash
+pipx install p2d
+```
+
+### 从源码（最新版本，正在开发中，有新的特性）
+
+```bash
+pipx install git+https://github.com/cn-xcpc-tools/Polygon2DOMjudge
+```
+
+## 命令行使用示例
+
+首先，你需要从 Polygon 构建 **完整的** 题目包并将 **Linux** 题目包下载到本地。
+
+> [!WARNING]
+> 如果你下载了标准的题目包并且运行 `doall.sh` 来构建完整的题目包，那么换行符将会是 CRLF。
+> 在运行脚本之前，请确保将换行符转换为 LF，因为 DOMjudge 是在 Linux 上运行的。
+
+```bash
+# 首先从 Polygon 下载完整的 Linux 题目包到本地
+$ ./bin/p2d --code A --color "#FF0000" -o /path/to/domjudge-package.zip /path/to/polygon-package.zip
+```
+
+运行此命令可以从 `/path/to/polygon-package.zip` 处题目包转换为 `/path/to/domjudge-package.zip`，并设置  `code` 和 `color` 属性。
+
+你可以省略输出路径，输出路径将会在当前工作目录中，并命名为 `{{ code }}.zip`。
+
+所有可用的命令行参数如下：
+
+- `--code`: 题目在 DOMjudge 比赛中的 short name。
+- `--color`: 题目在 DOMjudge 中的颜色。
+- `--default`: 强制使用 DOMjudge 默认的输出校验器。
+- `--validator-flags`: 为输出校验器添加一些命令行参数，仅在 `--default` 被设置时生效。
+- `--auto`: 自动使用 DOMjudge 默认的输出校验器，即如果 checker 在配置文件中被定义，则使用默认的输出校验器与合适的命令行参数替代。
+- `--memory-limit`: 覆盖 DOMjudge 题目包的内存限制，如果不设置，则使用 Polygon 题目包中的内存限制。
+- `--output-limit`: 覆盖 DOMjudge 题目包的输出限制，如果不设置，则使用 DOMjudge 设置中默认的输出限制。
+- `--hide-sample`: 隐藏题面中的样例输入输出，不会为选手提供样例数据（如果是交互题，则此参数强制为 True）。
+    当此参数不设置为 True 且样例输出与标程的输出不同时 （通常两者都是符合要求的答案），
+    样例输出将会被替换为题面中提供的样例输出。但是样例输入不会被替换，因为 DOMjudge 不支持下载的样例输入与实际使用的不同。
+- `--keep-sample`: 保持样例输出与标程的输出一致，当题面中的样例输出是一个占位符时，这个参数很有用。（默认情况下，所有的样例输出将会被替换为题面中提供的样例输出）
+- `--external-id`: 指定题目在 DOMjudge 中的 external id，如果不设置，则使用 Polygon 中的题目 short-name。
+- `--with-statement`: 在 DOMjudge 题目包中包含 pdf 题面。
+- `--with-attachments`: 在 DOMjudge 题目包中包含附件（例如交互题的本地测试工具）。
+- `--testset`: 指定要转换的测试点集，如果题目有多个测试点集，则必须指定测试点集的名称。
+
+### 转换整个比赛
+
+你可以使用 `p2d-contest` 来获取一个脚本来转换整个比赛中的题目。
+
+```bash
+# 首先从 Polygon 下载 contest.xml
+$ ./bin/p2d-contest /path/to/contest.xml > convert.sh
+```
+
+## 配置
+
+在 [config.toml](./config.example.toml) 文件中，你可以设置一些特殊的 checker 的输出校验器参数，这会在 `--auto` 参数被设置时用来将 checker 替换为默认的输出校验器。
+
+> [!NOTE]
+> 你应该创建一个新的文件，命名为 `config.toml` 或其他名称，并使用 `--config` 参数将其传递给脚本。脚本将会合并默认配置和你的配置。
+
+## 环境变量
+
+某些时候可能会有用。但如果你不知道你在干啥，请不要随便修改。
+
+- `TESTLIB_PATH`
+
+## API 使用示例
+
+> [!WARNING]
+> API 不是稳定的，可能会在未来的版本中发生变化。
+
+这是一个将 [`problems.yaml`](https://ccs-specs.icpc.io/draft/contest_package#problemsyaml) 中定义的比赛中的所有题目转换为 DOMjudge 题目包的示例。
+
+```python
+import yaml
+from pathlib import Path
+
+from p2d import convert
+
+polygon = Path('/path/to/polygon-packages')
+domjudge = Path('/path/to/domjudge-packages')
+
+with open(domjudge / 'problems.yaml') as f:
+    problems = yaml.safe_load(f)
+
+for problem in problems:
+    prob_id = problem['id']
+    convert(
+        polygon / f'{prob_id}.zip',
+        domjudge / f'{prob_id}.zip',
+        short_name=problem['label'],
+        color=problem['rgb'],
+    )
+```
+
+## 已知Issues
+
+- 对于交互题，您必须在交互器中完成对输出的验证（即，在交互器中直接返回最终的结果，略去使用checker对`tout`文件内容进行验证的步骤），因为 DOMjudge 无法像 Polygon 那样处理 `tout` 流。
+- 对于 multi-pass 问题
+  - 部分逻辑可能与 Polygon 不同，您可能需要调整一些逻辑来适应 DOMjudge 的要求。DOMjudge 会使用 `-DDOMJUDGE` 宏定义来区分是否为 DOMjudge 环境，您可以使用这个宏定义来调整您的代码。
+  - 您可能需要调用 `tout.open(make_new_file_in_a_dir(argv[3], "nextpass.in"))` 来获取下一次传递的输入文件。
+
+## 开发
+
+```bash
+# install
+uv sync
+
+# build
+uv build
+
+# run unittest
+uv run pytest
+```
+
+[gh-test-badge]: https://github.com/cn-xcpc-tools/Polygon2DOMjudge/actions/workflows/test.yml/badge.svg
+[gh-test]: https://github.com/cn-xcpc-tools/Polygon2DOMjudge/actions/workflows/test.yml
+[gh-release-badge]: https://img.shields.io/github/release/cn-xcpc-tools/Polygon2DOMjudge.svg
+[gh-release]: https://GitHub.com/cn-xcpc-tools/Polygon2DOMjudge/releases/