Tools: Minor issues/improvements to pyproject.toml

kedro/framework/cli/starters.py

@@ -517,6 +517,8 @@ def _get_extra_context(  # noqa: PLR0913
             for tool in _parse_tools_input(tools)  # type: ignore
         ]
         extra_context["tools"] = str(extra_context["tools"])
+    else:
+        extra_context["tools"] = str(["None"])
 
     extra_context["example_pipeline"] = (
         _parse_yes_no_to_bool(
@@ -536,16 +538,14 @@ def _convert_tool_names_to_numbers(selected_tools: str | None) -> str | None:
 
     Args:
         selected_tools: a string containing the value for the --tools flag,
-            or None in case the flag wasn't used, i.e. lint,docs.
+            or None in case none were provided, i.e. lint,docs.
 
     Returns:
         String with the numbers corresponding to the desired tools, or
         None in case the --tools flag was not used.
     """
-    if selected_tools is None:
+    if selected_tools is None or selected_tools.lower() == "none":
         return None
-    if selected_tools.lower() == "none":
-        return ""
     if selected_tools.lower() == "all":
         return ",".join(NUMBER_TO_TOOLS_NAME.keys())
 
@@ -554,6 +554,10 @@ def _convert_tool_names_to_numbers(selected_tools: str | None) -> str | None:
         tool_short_name = tool.strip()
         if tool_short_name in TOOLS_SHORTNAME_TO_NUMBER:
             tools.append(TOOLS_SHORTNAME_TO_NUMBER[tool_short_name])
+
+    # Remove duplicates if any
+    tools = sorted(list(set(tools)))
+
     return ",".join(tools)
 
 

kedro/framework/startup.py

@@ -22,6 +22,7 @@ class ProjectMetadata(NamedTuple):
     source_dir: Path
     kedro_init_version: str
     tools: list
+    example_pipeline: str
 
 
 def _version_mismatch_error(kedro_init_version) -> str:
@@ -103,6 +104,7 @@ def _get_project_metadata(project_path: Union[str, Path]) -> ProjectMetadata:
     source_dir = Path(metadata_dict.get("source_dir", "src")).expanduser()
     source_dir = (project_path / source_dir).resolve()
     metadata_dict["tools"] = metadata_dict.get("tools")
+    metadata_dict["example_pipeline"] = metadata_dict.get("example_pipeline")
 
     metadata_dict["source_dir"] = source_dir
     metadata_dict["config_file"] = pyproject_toml
@@ -112,7 +114,7 @@ def _get_project_metadata(project_path: Union[str, Path]) -> ProjectMetadata:
     try:
         return ProjectMetadata(**metadata_dict)
     except TypeError as exc:
-        expected_keys = mandatory_keys + ["source_dir", "tools"]
+        expected_keys = mandatory_keys + ["source_dir", "tools", "example_pipeline"]
         raise RuntimeError(
             f"Found unexpected keys in '{_PYPROJECT}'. Make sure "
             f"it only contains the following keys: {expected_keys}."

kedro/templates/project/{{ cookiecutter.repo_name }}/pyproject.toml

@@ -37,7 +37,8 @@ namespaces = false
 package_name = "{{ cookiecutter.python_package }}"
 project_name = "{{ cookiecutter.project_name }}"
 kedro_init_version = "{{ cookiecutter.kedro_version }}"
-tools = "{{ cookiecutter.tools | default('') | string | replace('\"', '\\\"') }}"
+tools = {{ cookiecutter.tools | default('') | string | replace('\"', '\\\"') }}
+example_pipeline = "{{ cookiecutter.example_pipeline }}"
 
 [tool.pytest.ini_options]
 addopts = """

tests/framework/cli/conftest.py

@@ -89,6 +89,7 @@ def fake_metadata(fake_root_dir):
         kedro_init_version=kedro_version,
         source_dir=fake_root_dir / REPO_NAME / "src",
         tools=None,
+        example_pipeline=None,
     )
     return metadata
 

tests/framework/cli/test_starters.py

@@ -1337,7 +1337,11 @@ def test_valid_tools_flag(self, fake_kedro_cli, tools, example_pipeline):
             ["new", "--tools", tools, "--example", example_pipeline],
             input=_make_cli_prompt_input_without_tools(),
         )
+
         tools = _convert_tool_names_to_numbers(selected_tools=tools)
+        if not tools:
+            tools = ""
+
         _assert_template_ok(result, tools=tools, example_pipeline=example_pipeline)
         _assert_requirements_ok(result, tools=tools, repo_name="new-kedro-project")
         assert (
@@ -1508,7 +1512,7 @@ def test_convert_tool_names_to_numbers_with_empty_string(self):
     def test_convert_tool_names_to_numbers_with_none_string(self):
         selected_tools = "none"
         result = _convert_tool_names_to_numbers(selected_tools)
-        assert result == ""
+        assert result is None
 
     def test_convert_tool_names_to_numbers_with_all_string(self):
         result = _convert_tool_names_to_numbers("all")
@@ -1533,3 +1537,8 @@ def test_convert_tool_names_to_numbers_with_invalid_tools(self):
         selected_tools = "invalid_tool1,invalid_tool2"
         result = _convert_tool_names_to_numbers(selected_tools)
         assert result == ""
+
+    def test_convert_tool_names_to_numbers_with_duplicates(self):
+        selected_tools = "lint,test,tests"
+        result = _convert_tool_names_to_numbers(selected_tools)
+        assert result == "1,2"

tests/framework/test_startup.py

@@ -95,6 +95,7 @@ def test_valid_toml_file(self, mocker):
             kedro_init_version=kedro_version,
             project_path=self.project_path,
             tools=None,
+            example_pipeline=None,
         )
         assert actual == expected
 
@@ -122,6 +123,7 @@ def test_valid_toml_file_with_project_version(self, mocker):
             kedro_init_version=kedro_version,
             project_path=self.project_path,
             tools=None,
+            example_pipeline=None,
         )
         assert actual == expected
 
@@ -141,7 +143,7 @@ def test_toml_file_with_extra_keys(self, mocker):
         pattern = (
             "Found unexpected keys in 'pyproject.toml'. Make sure it "
             "only contains the following keys: ['package_name', "
-            "'project_name', 'kedro_init_version', 'source_dir', 'tools']."
+            "'project_name', 'kedro_init_version', 'source_dir', 'tools', 'example_pipeline']."
         )
 
         with pytest.raises(RuntimeError, match=re.escape(pattern)):
@@ -301,6 +303,7 @@ def test_bootstrap_project(self, monkeypatch, tmp_path):
             "kedro_init_version": kedro_version,
             "source_dir": src_dir,
             "tools": None,
+            "example_pipeline": None,
         }
         assert result == ProjectMetadata(**expected_metadata)
         assert str(src_dir) in sys.path[0]

tests/ipython/test_ipython.py

@@ -39,6 +39,7 @@ def fake_metadata(tmp_path):
         kedro_init_version=PROJECT_INIT_VERSION,
         project_path=tmp_path,
         tools=None,
+        example_pipeline=None,
     )
     return metadata
 

tests/tools/test_cli.py

@@ -37,13 +37,14 @@ def fake_root_dir(tmp_path):
 @pytest.fixture
 def fake_metadata(fake_root_dir):
     metadata = ProjectMetadata(
-        fake_root_dir / REPO_NAME / "pyproject.toml",
-        PACKAGE_NAME,
-        "CLI Tools Testing Project",
-        fake_root_dir / REPO_NAME,
-        kedro_version,
-        fake_root_dir / REPO_NAME / "src",
-        kedro_version,
+        source_dir=fake_root_dir / REPO_NAME / "src",
+        config_file=fake_root_dir / REPO_NAME / "pyproject.toml",
+        package_name=PACKAGE_NAME,
+        project_name="CLI Tools Testing Project",
+        kedro_init_version=kedro_version,
+        project_path=fake_root_dir / REPO_NAME,
+        tools=None,
+        example_pipeline=None,
     )
     return metadata