Delete --replacement and use template for both failure and success instead (#79)

* Obsolete --replacement

* Delete logic relying on replacement

* New templates for both failure and success

* Rename template files

* Fix tests

* Update README

* forgot to add unit test files

* Autopep8

Author: kyuridenamida

README.md

@@ -50,15 +50,11 @@ $ atcoder-tool gen  [contest_id] --without-login
 
 ### gen の詳細
 ```$xslt
-usage: atcoder-tools gen [-h] [--without-login]
-                                                        [--workspace WORKSPACE]
-                                                        [--lang LANG]
-                                                        [--template TEMPLATE]
-                                                        [--replacement REPLACEMENT]
-                                                        [--parallel]
-                                                        [--save-no-session-cache]
-                                                        [--config CONFIG]
-                                                        contest_id
+usage: atcoder-tools gen
+       [-h] [--without-login] [--workspace WORKSPACE] [--lang LANG]
+       [--template TEMPLATE] [--parallel] [--save-no-session-cache]
+       [--config CONFIG]
+       contest_id
 
 positional arguments:
   contest_id            Contest ID (e.g. arc001)
@@ -68,23 +64,18 @@ optional arguments:
   --without-login       Download data without login
   --workspace WORKSPACE
                         Path to workspace's root directory. This script will create files in {WORKSPACE}/{contest_name}/{alphabet}/ e.g. ./your-workspace/arc001/A/
-                        [Default] ${HOME}/atcoder-workspace
+                        [Default] /home/kyuridenamida/atcoder-workspace
   --lang LANG           Programming language of your template code, cpp or java.
                         [Default] cpp
   --template TEMPLATE   File path to your template code
-                        [Default (C++)] /atcodertools/tools/templates/cpp/template_success.cpp
-                        [Default (Java)] /atcodertools/tools/templates/java/template_success.java
-  --replacement REPLACEMENT
-                        File path to your config file
-                        [Default (C++)] /atcodertools/tools/templates/cpp/template_failure.cpp
-                        [Default (Java)] /atcodertools/tools/templates/java/template_failure.java
+                        [Default (C++)] /atcoder-tools/atcodertools/tools/templates/cpp/default_template.cpp
+                        [Default (Java)] /atcoder-tools/atcodertools/tools/templates/java/default_template.java
   --parallel            Prepare problem directories asynchronously using multi processors.
   --save-no-session-cache
                         Save no session cache to avoid security risk
   --config CONFIG       File path to your config file
-                        [Default (Primary)] ${HOME}/.atcodertools.toml
-                        [Default (Secondary)] /atcodertools/tools/atcodertools-default.toml
-
+                        [Default (Primary)] /home/kyuridenamida/.atcodertools.toml
+                        [Default (Secondary)] /atcoder-tools/atcodertools/tools/atcodertools-default.toml
 ```
 
 ### test の詳細
@@ -160,31 +151,48 @@ code_generator_file="~/custom_code_generator.py"
 `(CogeGenArgs) -> str(ソースコード)`が型であるような`main`関数を定義した.pyファイルを`code_generator_file`で指定すると、コード生成時にカスタムコードジェネレーターを利用できます。
 
 ## テンプレートの例
-`atcoder-tools gen`コマンドに対し`--template`, `--replacement` でそれぞれ入力形式の推論に成功したときのテンプレート、生成に失敗したときに代わりに生成するソースコードを指定できます。テンプレートエンジンの仕様については[jinja2](http://jinja.pocoo.org/docs/2.10/) の公式ドキュメントを参照してください。テンプレートに渡される変数は以下の通りです。
+`atcoder-tools gen`コマンドに対し`--template`でテンプレートソースコードを指定できます。
+テンプレートエンジンの仕様については[jinja2](http://jinja.pocoo.org/docs/2.10/) の公式ドキュメントを参照してください。
+
+テンプレートに渡される変数は以下の通りです。
+
 
-- **input_part** input用のコード
-- **formal_arguments** 型つき引数列
-- **actual_arguments** 型なし引数列
+- **prediction_success** 入力形式の推論に成功したとき `True`、 失敗したとき `False`が格納されている。この値が`True`のとき次の3種類の変数も存在することが保証される。
+    - **input_part** input用のコード
+    - **formal_arguments** 型つき引数列
+    - **actual_arguments** 型なし引数列
 
-- **mod** 問題文中に存在するmodの値
-- **yes_str** 問題文中に存在する yes や possible などの真を表しそうな値
-- **no_str** 問題文中に存在する no や impossible などの偽を表しそうな値
+- **mod** 問題文中に存在するmodの整数値
+- **yes_str** 問題文中に存在する yes や possible などの真を表しそうな文字列値
+- **no_str** 問題文中に存在する no や impossible などの偽を表しそうな文字列値
 
 ```
 #include <bits/stdc++.h>
 using namespace std;
 
-{% if mod %}const int mod = {{ mod }};{% endif %}
-{% if yes_str %}const string YES = "{{ yes_str }}";{% endif %}
-{% if no_str %}const string NO = "{{ no_str }}";{% endif %}
+{% if mod %}
+const long long MOD = {{ mod }};
+{% endif %}
+{% if yes_str %}
+const string YES = "{{ yes_str }}";
+{% endif %}
+{% if no_str %}
+const string NO = "{{ no_str }}";
+{% endif %}
 
-void solve({{formal_arguments}}){
+{% if prediction_success %}
+void solve({{ formal_arguments }}){
 
 }
+{% endif %}
 
 int main(){
+    {% if prediction_success %}
     {{input_part}}
-    solve({{actual_arguments}});
+    solve({{ actual_arguments }});
+    {% else %}
+    // Failed to predict input format
+    {% endif %}
     return 0;
 }
 ```

atcodertools/codegen/code_generators/cpp.py

@@ -1,4 +1,4 @@
-from typing import Dict, Any
+from typing import Dict, Any, Optional
 
 from atcodertools.codegen.code_style_config import CodeStyleConfig
 from atcodertools.codegen.models.code_gen_args import CodeGenArgs
@@ -26,15 +26,19 @@ def _loop_header(var: Variable, for_second_index: bool):
 class CppCodeGenerator:
 
     def __init__(self,
-                 format_: Format[Variable],
+                 format_: Optional[Format[Variable]],
                  config: CodeStyleConfig):
         self._format = format_
         self._config = config
 
     def generate_parameters(self) -> Dict[str, Any]:
+        if self._format is None:
+            return dict(prediction_success=False)
+
         return dict(formal_arguments=self._formal_arguments(),
                     actual_arguments=self._actual_arguments(),
-                    input_part=self._input_part())
+                    input_part=self._input_part(),
+                    prediction_success=True)
 
     def _input_part(self):
         lines = []

atcodertools/codegen/code_style_config.py

@@ -1,5 +1,6 @@
 import importlib.machinery as imm
 import os
+from typing import Optional
 
 from atcodertools.fileutils.normalize import normalize_path
 
@@ -16,8 +17,8 @@ class CodeStyleConfig:
     def __init__(self,
                  indent_type: str = INDENT_TYPE_SPACE,
                  indent_width: int = 4,
-                 code_generator_file: str = None,
-                 template_file: str = None,
+                 code_generator_file: Optional[str] = None,
+                 template_file: Optional[str] = None,
                  ):
         code_generator_file = normalize_path(code_generator_file)
         template_file = normalize_path(template_file)

atcodertools/codegen/models/code_gen_args.py

@@ -1,3 +1,5 @@
+from typing import Optional
+
 from atcodertools.codegen.code_style_config import CodeStyleConfig
 from atcodertools.constprediction.models.problem_constant_set import ProblemConstantSet
 from atcodertools.fmtprediction.models.format import Format
@@ -8,7 +10,7 @@ class CodeGenArgs:
 
     def __init__(self,
                  template: str,
-                 format_: Format[Variable],
+                 format_: Optional[Format[Variable]],
                  constants: ProblemConstantSet,
                  config: CodeStyleConfig):
         self.template = template

atcodertools/codegen/template_engine.py

@@ -1,8 +1,8 @@
-import string
 import re
+import string
 import warnings
 
-import jinja2
+from jinja2 import Environment
 
 
 def _substitute(s, reps):
@@ -47,5 +47,5 @@ def old_render(template, **kwargs):
 
 
 def render_by_jinja(template, **kwargs):
-    template = jinja2.Template(template)
-    return template.render(**kwargs) + "\n"
+    return Environment(trim_blocks=True,
+                       lstrip_blocks=True).from_string(template).render(**kwargs) + "\n"

atcodertools/fileutils/create_contest_file.py

@@ -5,6 +5,7 @@
 
 
 def _make_text_file(file_path, text):
+    os.makedirs(os.path.dirname(file_path), exist_ok=True)
     with open(file_path, 'w') as f:
         f.write(text)
 

atcodertools/fmtprediction/models/format_prediction_result.py

@@ -1,4 +1,4 @@
-from typing import Dict
+from typing import Dict, Optional
 
 from atcodertools.fmtprediction.models.format import Format
 from atcodertools.fmtprediction.models.type import Type
@@ -7,7 +7,7 @@
 
 class FormatPredictionResult:
 
-    def __init__(self, format_: Format[Variable]):
+    def __init__(self, format_: Optional[Format[Variable]] = None):
         self.format = format_
 
     @classmethod
@@ -28,3 +28,7 @@ def create_typed_format(cls, simple_format: Format[SimpleVariable], var_to_type:
             fmt.push_back(pattern.with_replaced_vars(var_to_info))
 
         return FormatPredictionResult(fmt)
+
+    @classmethod
+    def empty_result(cls):
+        return FormatPredictionResult()

atcodertools/tools/envgen.py

@@ -21,6 +21,7 @@
 from atcodertools.constprediction.constants_prediction import predict_constants
 from atcodertools.fileutils.create_contest_file import create_examples, \
     create_code
+from atcodertools.fmtprediction.models.format_prediction_result import FormatPredictionResult
 from atcodertools.fmtprediction.predict_format import NoPredictionResultError, \
     MultiplePredictionResultsError, predict_format
 from atcodertools.tools.models.metadata import Metadata
@@ -70,7 +71,6 @@ def prepare_procedure(atcoder_client: AtCoderClient,
                       problem: Problem,
                       workspace_root_path: str,
                       template_code_path: str,
-                      replacement_code_path: str,
                       lang: str,
                       config: Config):
     pid = problem.get_alphabet()
@@ -129,40 +129,30 @@ def emit_info(text):
                 new_path))
 
     try:
-
-        with open(template_code_path, "r") as f:
-            template = f.read()
-
-        result = predict_format(content)
-        constants = predict_constants(content.original_html)
-
-        code_generator = _decide_code_generator(config, lang)
-        create_code(code_generator(
-            CodeGenArgs(
-                template,
-                result.format,
-                constants,
-                config.code_style_config
-            )),
-            code_file_path
-        )
-        emit_info(
-            "{} -- Saved auto-generated code to '{}'".format(
-                with_color("Prediction succeeded", Fore.LIGHTGREEN_EX),
-                code_file_path))
+        prediction_result = predict_format(content)
+        emit_info(with_color("Format prediction succeeded", Fore.LIGHTGREEN_EX))
     except (NoPredictionResultError, MultiplePredictionResultsError) as e:
+        prediction_result = FormatPredictionResult.empty_result()
         if isinstance(e, NoPredictionResultError):
             msg = "No prediction -- Failed to understand the input format"
         else:
             msg = "Too many prediction -- Failed to understand the input format"
-
-        os.makedirs(os.path.dirname(code_file_path), exist_ok=True)
-        shutil.copy(replacement_code_path, code_file_path)
-        emit_warning(
-            "{} -- Copied {} to {}".format(
-                with_color(msg, Fore.LIGHTRED_EX),
-                replacement_code_path,
-                code_file_path))
+        emit_warning(with_color(msg, Fore.LIGHTRED_EX))
+
+    constants = predict_constants(content.original_html)
+    code_generator = _decide_code_generator(config, lang)
+    with open(template_code_path, "r") as f:
+        template = f.read()
+
+    create_code(code_generator(
+        CodeGenArgs(
+            template,
+            prediction_result.format,
+            constants,
+            config.code_style_config
+        )),
+        code_file_path)
+    emit_info("Saved code to {}".format(code_file_path))
 
     # Save metadata
     metadata_path = os.path.join(problem_dir_path, "metadata.json")
@@ -183,18 +173,17 @@ def emit_info(text):
     output_splitter()
 
 
-def func(argv: Tuple[AtCoderClient, Problem, str, str, str, str, Config]):
-    atcoder_client, problem, workspace_root_path, template_code_path, replacement_code_path, lang, config = argv
+def func(argv: Tuple[AtCoderClient, Problem, str, str, str, Config]):
+    atcoder_client, problem, workspace_root_path, template_code_path, lang, config = argv
     prepare_procedure(
         atcoder_client, problem, workspace_root_path, template_code_path,
-        replacement_code_path, lang, config)
+        lang, config)
 
 
 def prepare_contest(atcoder_client: AtCoderClient,
                     contest_id: str,
                     workspace_root_path: str,
                     template_code_path: str,
-                    replacement_code_path: str,
                     lang: str,
                     parallel: bool,
                     config: Config,
@@ -209,7 +198,7 @@ def prepare_contest(atcoder_client: AtCoderClient,
         logging.warning(
             "Failed to fetch. Will retry in {} seconds".format(retry_duration))
 
-    tasks = [(atcoder_client, problem, workspace_root_path, template_code_path, replacement_code_path, lang, config) for
+    tasks = [(atcoder_client, problem, workspace_root_path, template_code_path, lang, config) for
              problem in problem_list]
 
     output_splitter()
@@ -242,11 +231,7 @@ def prepare_contest(atcoder_client: AtCoderClient,
 
 
 def get_default_template_path(lang):
-    return os.path.abspath(os.path.join(DEFAULT_TEMPLATE_DIR_PATH, "{lang}/template_success.{lang}".format(lang=lang)))
-
-
-def get_default_replacement_path(lang):
-    return os.path.abspath(os.path.join(DEFAULT_TEMPLATE_DIR_PATH, "{lang}/template_failure.{lang}").format(lang=lang))
+    return os.path.abspath(os.path.join(DEFAULT_TEMPLATE_DIR_PATH, "{lang}/default_template.{lang}".format(lang=lang)))
 
 
 def decide_template_path(lang: str, config: Config, cmd_template_path: str):
@@ -290,6 +275,10 @@ def _load(path: str) -> Config:
     return _load(DEFAULT_CONFIG_PATH)
 
 
+class DeletedFunctionalityError(Exception):
+    pass
+
+
 def main(prog, args):
     parser = argparse.ArgumentParser(
         prog=prog,
@@ -322,13 +311,8 @@ def main(prog, args):
                                 get_default_template_path('java')))
                         )
 
-    parser.add_argument("--replacement",
-                        help="File path to your config file\n{0}{1}".format(
-                            "[Default (C++)] {}\n".format(
-                                get_default_replacement_path('cpp')),
-                            "[Default (Java)] {}".format(
-                                get_default_replacement_path('java')))
-                        )
+    # Deleted functionality
+    parser.add_argument('--replacement', help=argparse.SUPPRESS)
 
     parser.add_argument("--parallel",
                         action="store_true",
@@ -349,6 +333,12 @@ def main(prog, args):
 
     args = parser.parse_args(args)
 
+    if args.replacement is not None:
+        logging.error(with_color("Sorry! --replacement argument no longer exists"
+                                 " and you can only use --template."
+                                 " See the official document for details.", Fore.LIGHTRED_EX))
+        raise DeletedFunctionalityError
+
     try:
         import AccountInformation  # noqa
         raise BannedFileDetectedError(
@@ -373,8 +363,6 @@ def main(prog, args):
                     args.contest_id,
                     args.workspace,
                     decide_template_path(args.lang, config, args.template),
-                    args.replacement if args.replacement is not None else get_default_replacement_path(
-                        args.lang),
                     args.lang,
                     args.parallel,
                     config