Stuck on an issue?

Lightrun Answers was designed to reduce the constant googling that comes with debugging 3rd party libraries. It collects links to all the places you might be looking at while hunting down a tough bug.

And, if you’re still stuck at the end, we’re happy to hop on a call to see how we can help out.

Symbolic link project path not working

See original GitHub issue

Description

If the project path exists on the symlink, an error occurs when Kedro CLI is created.

Context

Workspace is a symbolic link, but when I run the kedro project on it, I get a problem that it cannot be executed.

on windows

Steps to Reproduce

mklink /J workspace /path/to/source
cd workspace
kedro new
kedro info

Expected Result

Actual Result

Traceback (most recent call last):
  File "C:\Users\-\conda\Scripts\kedro-script.py", line 9, in <module>
    sys.exit(main())
  File "C:\Users\-\conda\lib\site-packages\kedro\framework\cli\cli.py", line 265, in main
    cli_collection = KedroCLI(project_path=Path.cwd())
  File "C:\Users\-\conda\lib\site-packages\kedro\framework\cli\cli.py", line 183, in __init__
    self._metadata = bootstrap_project(project_path)
  File "C:\Users\-\conda\lib\site-packages\kedro\framework\startup.py", line 184, in bootstrap_project
    _add_src_to_path(metadata.source_dir, project_path)
  File "C:\Users\-\conda\lib\site-packages\kedro\framework\startup.py", line 168, in _add_src_to_path
    _validate_source_path(source_dir, project_path)
  File "C:\Users\-\conda\lib\site-packages\kedro\framework\startup.py", line 159, in _validate_source_path
    raise ValueError(
ValueError: Source path 'workspace\test\src' has to be relative to your project root 'workspace-link\test'.

Your Environment

Windows 11 (21H2, 22000.194)
Python==3.8.10
Kedro>=0.17.0 (tested 0.17.0, 0.17.5)

Issue Analytics

State:
Created 2 years ago
Comments:5 (2 by maintainers)

Top GitHub Comments

2reactions

jirikleincommented, Oct 7, 2021

Hi @jiunbae - thank you, this looks like a super elegant solution. I had a look at the Path.resolve implementation here (https://docs.python.org/3/library/pathlib.html#pathlib.Path.resolve) and I think for these purposes we’ll go with Path.resolve(strict=True).

However, we would need to see tests for Win, Darwin and Linux as the way all of these platforms resolve paths (and symlinks, for that matter) differs and can throw some unexpected behaviour.

1reaction

jiunbaecommented, Oct 7, 2021

Tried to create a PR, but I left an issue first because it takes times to prepare the things necessary for environment setting such as test, CI and getting used to the kedro contribution convention.