Add new command: compiler (#231)

* コンパイラーを追加

* コンパイラ向けに追加

* インタラクティブはこのバージョンになさそうなので、コメントアウト

* compiler向けの修正

* 追加

* metadataを修正

* testerを修正

* configを修正

* READMEを追記

* compilerのテスト追加

* compilerのテストを追加

* testerを修正

* READMEを修正

* 整形

* venvを削除

* configを変更しないようにした

* configのdefaultの順番を変更

Author: chaemon

.gitignore

@@ -11,3 +11,4 @@ atcoder_tools.egg-info/
 build/
 dist/
 check_autopep8
+venv/

README.md

@@ -224,6 +224,9 @@ optional arguments:
 - `skip_existing_problems=false` ディレクトリが既に存在する問題の処理をスキップする
 - `in_example_format="in_{}.txt"` テストケース(input)のフォーマットを`in_1.txt, in_2.txt, ...`とする
 - `out_example_format="out_{}.txt"` テストケース(output)のフォーマットを`out_1.txt, out_2.txt, ...`とする
+- `compile_before_testing` テスト前にコンパイルを実行するか否かをTrue/Falseで指定。何も指定しないとFalseとなります。
+- `compile_only_when_diff_detected` テスト前のコンパイルの際、元のソースに変更があった場合のみ実行するかをTrue/Falseで指定。何も指定しないとFalseとなります。
+
 
 ```toml
 [codestyle]

atcodertools/atcoder_tools.py

@@ -9,6 +9,7 @@
 from atcodertools.tools.tester import main as tester_main
 from atcodertools.tools.submit import main as submit_main
 from atcodertools.tools.codegen import main as codegen_main
+from atcodertools.tools.compiler import main as compiler_main
 from atcodertools.release_management.version import __version__
 from colorama import Fore, Style
 
@@ -38,7 +39,7 @@ def notify_if_latest_version_found():
 def main():
     notify_if_latest_version_found()
 
-    if len(sys.argv) < 2 or sys.argv[1] not in ("gen", "test", "submit", "codegen", "version"):
+    if len(sys.argv) < 2 or sys.argv[1] not in ("gen", "test", "submit", "codegen", "compile", "version"):
         print("Usage:")
         print("{} gen -- to generate workspace".format(sys.argv[0]))
         print("{} test -- to test codes in your workspace".format(sys.argv[0]))
@@ -63,5 +64,8 @@ def main():
     if sys.argv[1] == "codegen":
         codegen_main(prog, args)
 
+    if sys.argv[1] == "compile":
+        compiler_main(prog, args)
+
     if sys.argv[1] == "version":
         print(__version__)

atcodertools/common/language.py

@@ -4,6 +4,7 @@
 from atcodertools.codegen.code_generators import cpp, java, rust, python, nim, d, cs, swift
 from atcodertools.codegen.models.code_gen_args import CodeGenArgs
 from atcodertools.tools.templates import get_default_template_path
+import platform
 
 
 class LanguageNotFoundError(Exception):
@@ -25,7 +26,10 @@ def __init__(self,
                  submission_lang_pattern: Pattern[str],
                  default_code_generator: Callable[[CodeGenArgs], str],
                  default_template_path: str,
-                 default_code_style=None
+                 default_code_style=None,
+                 compile_command=None,
+                 test_command=None,
+                 exec_filename=None
                  ):
         self.name = name
         self.display_name = display_name
@@ -34,11 +38,37 @@ def __init__(self,
         self.default_code_generator = default_code_generator
         self.default_template_path = default_template_path
         self.default_code_style = default_code_style
+        self.compile_command = compile_command
+        self.test_command = test_command
+        self.code_filename = "{filename}." + extension
+        if platform.system() == "Windows":
+            self.exec_filename = exec_filename.replace(
+                "{exec_extension}", ".exe")
+        else:
+            self.exec_filename = exec_filename.replace("{exec_extension}", "")
 
     def source_code_name(self, name_without_extension: str) -> str:
         # put extension to the name
         return "{}.{}".format(name_without_extension, self.extension)
 
+    def get_compile_command(self, filename: str):
+        return self.compile_command.format(filename=filename)
+
+    def get_code_filename(self, filename: str):
+        return self.code_filename.format(filename=filename)
+
+    def get_exec_filename(self, filename: str):
+        return self.exec_filename.format(filename=filename, capitalized_filename=filename.capitalize())
+
+    def get_test_command(self, filename: str, cwd: str = '.'):
+        exec_filename = cwd + '/'
+        if platform.system() == "Windows":
+            exec_filename += filename + ".exe"
+        else:
+            exec_filename += filename
+        capitalized_filename = filename.capitalize()
+        return self.test_command.format(filename=filename, exec_filename=exec_filename, capitalized_filename=capitalized_filename)
+
     @classmethod
     def from_name(cls, name: str):
         for lang in ALL_LANGUAGES:
@@ -56,6 +86,9 @@ def from_name(cls, name: str):
         ".*C\\+\\+ \\(GCC 9.*|.*C\\+\\+14 \\(GCC 5.*"),
     default_code_generator=cpp.main,
     default_template_path=get_default_template_path('cpp'),
+    compile_command="g++ {filename}.cpp -o {filename} -std=c++14",
+    test_command="{exec_filename}",
+    exec_filename="{filename}{exec_extension}"
 )
 
 JAVA = Language(
@@ -65,6 +98,9 @@ def from_name(cls, name: str):
     submission_lang_pattern=re.compile(".*Java8.*|.*Java \\(OpenJDK 11.*"),
     default_code_generator=java.main,
     default_template_path=get_default_template_path('java'),
+    compile_command="javac {filename}.java",
+    test_command="java {capitalized_filename}",
+    exec_filename="{capitalized_filename}.class"
 )
 
 RUST = Language(
@@ -74,6 +110,9 @@ def from_name(cls, name: str):
     submission_lang_pattern=re.compile(".*Rust \\(1.*"),
     default_code_generator=rust.main,
     default_template_path=get_default_template_path('rs'),
+    compile_command="rustc {filename}.rs -o {filename}",
+    test_command="{exec_filename}",
+    exec_filename="{filename}{exec_extension}"
 )
 
 PYTHON = Language(
@@ -83,6 +122,9 @@ def from_name(cls, name: str):
     submission_lang_pattern=re.compile(".*Python3.*|^Python$"),
     default_code_generator=python.main,
     default_template_path=get_default_template_path('py'),
+    compile_command="python3 -mpy_compile {filename}.py",
+    test_command="python3 {filename}.py",
+    exec_filename="{filename}.pyc"
 )
 
 DLANG = Language(
@@ -92,6 +134,9 @@ def from_name(cls, name: str):
     submission_lang_pattern=re.compile(".*D \\(DMD.*"),
     default_code_generator=d.main,
     default_template_path=get_default_template_path('d'),
+    compile_command="dmd {filename}.d -of={filename}",
+    test_command="{exec_filename}",
+    exec_filename="{filename}{exec_extension}"
 )
 
 NIM = Language(
@@ -101,7 +146,10 @@ def from_name(cls, name: str):
     submission_lang_pattern=re.compile(".*Nim \\(1.*"),
     default_code_generator=nim.main,
     default_template_path=get_default_template_path('nim'),
-    default_code_style=CodeStyle(indent_width=2)
+    default_code_style=CodeStyle(indent_width=2),
+    compile_command="nim cpp -o:{filename} {filename}.nim",
+    test_command="{exec_filename}",
+    exec_filename="{filename}{exec_extension}"
 )
 
 CSHARP = Language(
@@ -111,6 +159,9 @@ def from_name(cls, name: str):
     submission_lang_pattern=re.compile(".*C# \\(Mono.*"),
     default_code_generator=cs.main,
     default_template_path=get_default_template_path('cs'),
+    compile_command="mcs {filename}.cs -o {filename}",
+    test_command="{exec_filename}",
+    exec_filename="{filename}{exec_extension}"
 )
 
 SWIFT = Language(
@@ -120,6 +171,9 @@ def from_name(cls, name: str):
     submission_lang_pattern=re.compile("^Swift"),
     default_code_generator=swift.main,
     default_template_path=get_default_template_path('swift'),
+    compile_command="swiftc {filename}.swift -o {filename}",
+    test_command="{exec_filename}",
+    exec_filename="{filename}{exec_extension}"
 )
 
 

atcodertools/config/etc_config.py

@@ -7,10 +7,14 @@ def __init__(self,
                  skip_existing_problems: bool = False,
                  in_example_format: str = "in_{}.txt",
                  out_example_format: str = "out_{}.txt",
+                 compile_before_testing: bool = False,
+                 compile_only_when_diff_detected: bool = False
                  ):
         self.download_without_login = download_without_login
         self.parallel_download = parallel_download
         self.save_no_session_cache = save_no_session_cache
         self.skip_existing_problems = skip_existing_problems
         self.in_example_format = in_example_format
         self.out_example_format = out_example_format
+        self.compile_before_testing = compile_before_testing
+        self.compile_only_when_diff_detected = compile_only_when_diff_detected

atcodertools/executils/run_command.py

@@ -9,3 +9,12 @@ def run_command(exec_cmd: str, current_working_dir: str) -> str:
                           stderr=subprocess.STDOUT,
                           cwd=current_working_dir)
     return proc.stdout.decode(locale.getpreferredencoding())
+
+
+def run_command_with_returncode(exec_cmd: str, current_working_dir: str):
+    proc = subprocess.run(exec_cmd,
+                          shell=True,
+                          stdout=subprocess.PIPE,
+                          stderr=subprocess.STDOUT,
+                          cwd=current_working_dir)
+    return proc.returncode, proc.stdout.decode(locale.getpreferredencoding())

atcodertools/executils/run_program.py

@@ -36,7 +36,7 @@ def run_program(exec_file: str, input_file: str, timeout_sec: int, args=None, cu
     try:
         elapsed_sec = -time.time()
         proc = subprocess.run(
-            [exec_file] + args, stdin=open(input_file, 'r'), universal_newlines=True, timeout=timeout_sec,
+            exec_file.split(" ") + args, stdin=open(input_file, 'r'), universal_newlines=True, timeout=timeout_sec,
             stdout=subprocess.PIPE,
             stderr=subprocess.PIPE,
             cwd=current_working_dir

atcodertools/tools/compiler.py

@@ -0,0 +1,67 @@
+#!/usr/bin/python3
+import argparse
+
+from atcodertools.executils.run_command import run_command_with_returncode
+from atcodertools.tools.models.metadata import Metadata
+from atcodertools.common.language import Language
+import os
+import pathlib
+
+
+class BadStatusCodeException(Exception):
+    pass
+
+
+def _compile(code_filename: str, exec_filename: str, compile_command: str, cwd: str, force_compile: bool) -> None:
+    if not force_compile:
+        code_path = pathlib.Path(os.path.join(cwd, code_filename))
+        exec_path_name = os.path.join(cwd, exec_filename)
+
+        if os.path.exists(exec_path_name) and code_path.stat().st_mtime < pathlib.Path(exec_path_name).stat().st_mtime:
+            print("No need to compile")
+            return
+
+    print("Compiling... (command: `{}`)".format(compile_command))
+    code, stdout = run_command_with_returncode(compile_command, cwd)
+    print(stdout)
+    if code != 0:
+        raise BadStatusCodeException
+
+
+def compile_main_and_judge_programs(lang: Language, cwd="./", force_compile=False, compile_command=None) -> None:
+    print("[Main Program]")
+    if compile_command is None:
+        compile_command = lang.get_compile_command('main')
+    code_filename = lang.get_code_filename('main')
+    exec_filename = lang.get_exec_filename('main')
+
+    try:
+        _compile(code_filename, exec_filename,
+                 compile_command, cwd, force_compile)
+    except BadStatusCodeException as e:
+        raise e
+
+
+def main(prog, args):
+    parser = argparse.ArgumentParser(
+        prog=prog,
+        usage="Compile your program in the current directory (no argument)",
+        formatter_class=argparse.RawTextHelpFormatter)
+    parser.add_argument('--compile-command',
+                        help='set compile command'
+                             ' [Default]: None',
+                        type=str,
+                        default=None)
+
+    parser.add_argument('--compile-only-when-diff-detected',
+                        help='compile only when diff detected [true, false]'
+                             ' [Default]: true',
+                        type=bool,
+                        default=False)
+
+    args = parser.parse_args(args)
+
+    metadata = Metadata.load_from("./metadata.json")
+    force_compile = not args.compile_only_when_diff_detected
+    compile_main_and_judge_programs(metadata.lang, force_compile=force_compile,
+                                    compile_command=args.compile_command)

atcodertools/tools/models/metadata.py

@@ -2,7 +2,7 @@
 
 from atcodertools.client.models.problem import Problem
 from atcodertools.common.judgetype import NormalJudge, DecimalJudge, Judge
-from atcodertools.common.language import Language
+from atcodertools.common.language import Language, CPP
 
 
 class Metadata:
@@ -57,3 +57,17 @@ def save_to(self, filename):
         with open(filename, 'w') as f:
             json.dump(self.to_dict(), f, indent=1, sort_keys=True)
             f.write('\n')
+
+
+DEFAULT_IN_EXAMPLE_PATTERN = 'in_*.txt'
+DEFAULT_OUT_EXAMPLE_PATTERN = "out_*.txt"
+
+
+DEFAULT_METADATA = Metadata(
+    problem=None,
+    code_filename=None,
+    sample_in_pattern=DEFAULT_IN_EXAMPLE_PATTERN,
+    sample_out_pattern=DEFAULT_OUT_EXAMPLE_PATTERN,
+    lang=CPP,
+    judge_method=NormalJudge()
+)