Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/hansbug/pji
(P)ython (J)udge (I)nterface for every educator.
https://github.com/hansbug/pji
judge-system python3
Last synced: 7 days ago
JSON representation
(P)ython (J)udge (I)nterface for every educator.
- Host: GitHub
- URL: https://github.com/hansbug/pji
- Owner: HansBug
- License: apache-2.0
- Created: 2022-01-14T15:05:22.000Z (almost 3 years ago)
- Default Branch: main
- Last Pushed: 2022-06-06T05:25:43.000Z (over 2 years ago)
- Last Synced: 2024-11-01T04:17:20.480Z (14 days ago)
- Topics: judge-system, python3
- Language: Python
- Homepage: https://hansbug.github.io/pji/
- Size: 6.58 MB
- Stars: 0
- Watchers: 1
- Forks: 0
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
- Contributing: CONTRIBUTING.md
- License: LICENSE
Awesome Lists containing this project
README
# pji
[](https://pypi.org/project/pji/)
[](https://pypi.org/project/pji/)
[](https://github.com/HansBug/pji/actions?query=workflow%3A%22Docs+Deploy%22)
[](https://github.com/HansBug/pji/actions?query=workflow%3A%22Code+Test%22)
[](https://github.com/HansBug/pji/actions?query=workflow%3A%22Badge+Creation%22)
[](https://github.com/HansBug/pji/actions?query=workflow%3A%22Package+Release%22)
[](https://codecov.io/gh/HansBug/pji)
[](https://github.com/HansBug/pji/stargazers)
[](https://github.com/HansBug/pji/network)
[](https://github.com/HansBug/pji/issues)
[](https://github.com/HansBug/pji/pulls)
[](https://github.com/HansBug/pji/graphs/contributors)
[](https://github.com/HansBug/pji/blob/master/LICENSE)
An new easy-to-use python interaction for judgement written by Python.
Some more features are supported, such as interaction test.
## Installation
You can simply install it with `pip` command line from the official PyPI site.
```
pip install pji
```
For more information about installation, you can refer to the [installation guide](https://hansbug.github.io/pji/main/tutorials/installation/index.html).
## Documentation
The detailed documentation are hosted on [https://hansbug.github.io/pji](https://hansbug.github.io/pji).
Only english version is provided now, the chinese documentation is still under development.
## Quick Start
`pji` uses fork to create child processes, pipe for inter-process communication, and the linux permission system to ensure evaluation security.
As a result, **`pji` only works on Linux systems, and you must have root permissions to use it**.
### Use With Command-Line
`pji` is used based on configuration files, and the command line help information is as follows
```shell
pji -h
```
Output as follows
```
Usage: pji [OPTIONS]
Options:
-v, --version Show package's version information.
-s, --script FILE Path of pji script. [default: pscript.yml]
-t, --task TEXT Task going to be executed. [default: main]
-e, --environ TEXT Environment variables (loaded before global
config).
-E, --environ_after TEXT Environment variables (loaded after global
config).
-h, --help Show this message and exit.
```
### A Simple Example
Here's an simple example. In this case, the test data is generated automatically, and then the running test of the script to be tested is performed with restricted permissions, and the results are sent back and logs are logged.
Here is the configuration file `test_dispatch.yml`.
```yml
global:
environ:
PATH: /root:${PATH}
INPUT: 2 3
use_sys_env:
- PATH
- LC_ALL
- LANG
tasks:
run_python:
sections:
- name: get_test_info
inputs:
- "copy:test_script.py:test_script.py"
outputs:
- "tag:wc_result.txt:wc"
- "tag:input_result.txt:input"
infos:
wc: "tag:wc"
input: "tag:input"
info_dump: "test_info.txt"
commands:
- args: "cat test_script.py | wc -l"
stdout: wc_result.txt
- args: "echo ${INPUT}"
stdout: input_result.txt
- name: generate_base64
outputs:
- "tag:base64.txt:b64"
infos:
b64: "tag:b64"
commands:
- args: "echo ${INPUT} | base64"
stdout: base64.txt
- name: run_result
identification: nobody
inputs:
- "copy:test_script.py:test_script.py:r--:nobody"
- "tag:b64:base64.txt:r--:nobody"
outputs:
- "tag:result.txt:result"
- "copy:result.txt:test_result.txt"
infos:
result: "tag:result"
commands:
- args: "cat base64.txt | python test_script.py"
stdout: result.txt
- 'true'
```
Script file going to be tested`test_script.py`
```python
import base64
if __name__ == '__main__':
_line = base64.b64decode(input()).decode()
print(sum([int(item.strip()) for item in _line.split(' ') if item.strip()]))
```
Place the abovementioned files to directory`/root/123`, and then run the following `pji` command.
```shell
pji -s /root/123/test_dispatch.yml -t run_python
```
The output should be
```
Section 'get_test_info' start ...
Coping file from '/root/123/test_script.py' to '/tmp/tmp6rsk6t2o/test_script.py' ... COMPLETE
Running 'cat test_script.py | wc -l' ... SUCCESS, time: 0.002s / 0.002s, memory: 18.875 MiB
Running 'echo ${INPUT}' ... SUCCESS, time: 0.004s / 0.003s, memory: 19.125 MiB
Saving file from '/tmp/tmp6rsk6t2o/wc_result.txt' to tag 'wc' ... COMPLETE
Saving file from '/tmp/tmp6rsk6t2o/input_result.txt' to tag 'input' ... COMPLETE
Collecting result information ... COMPLETE
Dumping result information to '/root/123/test_info.txt' ... COMPLETE
Section 'get_test_info' execute completed!
Section 'generate_base64' start ...
Running 'echo ${INPUT} | base64' ... SUCCESS, time: 0.003s / 0.002s, memory: 19.15625 MiB
Saving file from '/tmp/tmp_n5ftp5d/base64.txt' to tag 'b64' ... COMPLETE
Collecting result information ... COMPLETE
Section 'generate_base64' execute completed!
Section 'run_result' start ...
Coping file from '/root/123/test_script.py' to '/tmp/tmphcbmt0j9/test_script.py' ... COMPLETE
Loading tag 'b64' to '/tmp/tmphcbmt0j9/base64.txt' ... COMPLETE
Running 'cat base64.txt | python test_script.py' ... SUCCESS, time: 0.025s / 0.030s, memory: 19.16796875 MiB
Running 'true' ... SUCCESS, time: 0.000s / 0.001s, memory: 19.18359375 MiB
Saving file from '/tmp/tmphcbmt0j9/result.txt' to tag 'result' ... COMPLETE
Coping file from '/tmp/tmphcbmt0j9/result.txt' to '/root/123/test_result.txt' ... COMPLETE
Collecting result information ... COMPLETE
Section 'run_result' execute completed!
Task success.
```
The file passed back`/root/123/result.txt`
```
5
```
Furthermore, when this command line, which is slightly different from the one above, is executed
```shell
pji -s /root/123/test_dispatch.yml -t run_python -E "INPUT=1 2 3 4 5 6 7"
```
The content of `/root/123/result.txt` should be
```
28
```
And, if you need the full running information, just use the following command with `-i` option
```shell
pji -s /root/123/test_dispatch.yml -t run_python -E "INPUT=1 2 3 4 5 6 7" -i test_info.json
```
An extra log file `test_info.json` will be exported
```json
{
"ok": true,
"sections": [
{
"commands": [
{
"completed": true,
"limit": {
"max_cpu_time": null,
"max_memory": null,
"max_output_size": null,
"max_process_number": null,
"max_real_time": null,
"max_stack": null
},
"ok": true,
"result": {
"cpu_time": 0.000896,
"exitcode": 0,
"max_memory": 19709952.0,
"real_time": 0.002176523208618164,
"signal": null
},
"status": "SUCCESS"
},
{
"completed": true,
"limit": {
"max_cpu_time": null,
"max_memory": null,
"max_output_size": null,
"max_process_number": null,
"max_real_time": null,
"max_stack": null
},
"ok": true,
"result": {
"cpu_time": 0.002518,
"exitcode": 0,
"max_memory": 19881984.0,
"real_time": 0.0010895729064941406,
"signal": null
},
"status": "SUCCESS"
}
],
"information": {
"input": "1 2 3 4 5 6 7\n",
"wc": "5\n"
},
"name": "get_test_info",
"ok": true
},
{
"commands": [
{
"completed": true,
"limit": {
"max_cpu_time": null,
"max_memory": null,
"max_output_size": null,
"max_process_number": null,
"max_real_time": null,
"max_stack": null
},
"ok": true,
"result": {
"cpu_time": 0.002568,
"exitcode": 0,
"max_memory": 19922944.0,
"real_time": 0.0018069744110107422,
"signal": null
},
"status": "SUCCESS"
}
],
"information": {
"b64": "MSAyIDMgNCA1IDYgNwo=\n"
},
"name": "generate_base64",
"ok": true
},
{
"commands": [
{
"completed": true,
"limit": {
"max_cpu_time": null,
"max_memory": null,
"max_output_size": null,
"max_process_number": null,
"max_real_time": null,
"max_stack": null
},
"ok": true,
"result": {
"cpu_time": 0.023656999999999997,
"exitcode": 0,
"max_memory": 19947520.0,
"real_time": 0.027228593826293945,
"signal": null
},
"status": "SUCCESS"
},
{
"completed": true,
"limit": {
"max_cpu_time": null,
"max_memory": null,
"max_output_size": null,
"max_process_number": null,
"max_real_time": null,
"max_stack": null
},
"ok": true,
"result": {
"cpu_time": 0.001723,
"exitcode": 0,
"max_memory": 19955712.0,
"real_time": 0.0009958744049072266,
"signal": null
},
"status": "SUCCESS"
}
],
"information": {
"result": "28\n"
},
"name": "run_result",
"ok": true
}
]
}
```
### Use In Script
`pji` can be used like the above method with native python.
For example, we can build the following script to run the test mentioned above
```python
import codecs
from pji.entry import load_pji_script
if __name__ == '__main__':
_script = load_pji_script('/root/123/test_dispatch.yml')
_success, _result = _script('run_python')
print(_success)
print(_result)
with codecs.open('/root/123/test_result.txt', 'r') as rf:
print(rf.read())
```
The output should be
```
True
[('get_test_info', (True, [, ], {'wc': '5\n', 'input': '2 3\n'})), ('generate_base64', (True, [], {'b64': 'MiAzCg==\n'})), ('run_result', (True, [, ], {'result': '5\n'}))]
5
```
Another case for extra environment variable attached
```python
import codecs
from pji.entry import load_pji_script
if __name__ == '__main__':
_script = load_pji_script('/root/123/test_dispatch.yml')
_success, _result = _script('run_python', environ_after={'INPUT': '1 2 3 4 5 6 7'})
print(_success)
print(_result)
with codecs.open('/root/123/test_result.txt', 'r') as rf:
print(rf.read())
```
The output should be
```
True
[('get_test_info', (True, [, ], {'wc': '5\n', 'input': '1 2 3 4 5 6 7\n'})), ('generate_base64', (True, [], {'b64': 'MSAyIDMgNCA1IDYgNwo=\n'})), ('run_result', (True, [, ], {'result': '28\n'}))]
28
```
## Run Unittest / Building
```bash
# create dev container
make run_dev IMAGE_DEV=python:3.6
# after enter the docker container
./install.sh # install requirements with chinese mirror
source env.sh # add pji cli's environment
make unittest # run unittest
make build # build a standalone cli, placed at 'dist/pji'
```
## License
`pji` released under the Apache 2.0 license.