Resolve all path in Kedro

[noklam]

Description

Related:

• Replace .absolute() with .resolve() #2912
• Symlink resolution during configuration detection might break some CLI commands #2346

Development notes

def _add_src_to_path(source_dir: Path, project_path: Path) -> None:
   ... 

def bootstrap_project(project_path: Path) -> ProjectMetadata:
    """Run setup required at the beginning of the workflow
    when running in project mode, and return project metadata.
    """
    project_path = Path(project_path).resolve() # New
    metadata = _get_project_metadata(project_path)
    _add_src_to_path(metadata.source_dir, project_path)
    configure_project(metadata.package_name)
    return metadata

If you look at the bootstrap_project, it expect a path object but in fact sometimes string is passed and it is okay about this. Same go as _add_src_to_path that accepts Path only but actually taking str sometimes.

The fix here is simple, make sure project_path is resolved. It is already done in many place, just not consistently (sometimes with expanduser() too):

kedro/kedro/framework/startup.py

Lines 52 to 53 in 35ee3ea

	"""
	project_path = Path(project_path).expanduser().resolve()

and

kedro/kedro/framework/startup.py

Lines 93 to 95 in 35ee3ea

	source_dir = Path(metadata_dict.get("source_dir", "src")).expanduser()
	source_dir = (project_path / source_dir).resolve()
	metadata_dict["tools"] = metadata_dict.get("tools")

• Todo: add a test

Developer Certificate of Origin

We need all contributions to comply with the Developer Certificate of Origin (DCO). All commits must be signed off by including a Signed-off-by line in the commit message. See our wiki for guidance.

If your PR is blocked due to unsigned commits, then you must follow the instructions under "Rebase the branch" on the GitHub Checks page for your PR. This will retroactively add the sign-off to all unsigned commits and allow the DCO check to pass.

Checklist

• Read the contributing guidelines
• Signed off each commit with a Developer Certificate of Origin (DCO)
• Opened this PR as a 'Draft Pull Request' if it is work-in-progress
• Updated the documentation to reflect the code changes
• Added a description of this change in the RELEASE.md file
• Added tests to cover my changes
• Checked if this change will affect Kedro-Viz, and if so, communicated that with the Viz team

[noklam]

3831e82 this seems to work already

[noklam]

I hesitate a bit on whether it should accept both str | Path. As you can see it breaks one of our test.

On the other hand it's much cleaner to keep this path conversion happen at the beginning, i.e. bootstrap_project. Otherwise we are doing the same conversion over and over, and this is the only public function.

[merelcht]

LGTM! 👍 It makes total sense to do the path resolution as early on in the flow as possible.

[ankatiyar]

Thanks @noklam! Also came across this issue on window tests in kedro-org/kedro-plugins#599.