Hi, I'm wondering about the structure of the project. According to https://docs.kedro.org/en/stable/development/automated_testing.html#set-up-automated-testing-with-pytest the test folder should be under /src. However, in the starter example (https://github.com/kedro-org/kedro-starters/tree/main/spaceflights-pandas/%7B%7B%20cookiecutter.repo_name%20%7D%7D (and while running

kedro new --name=<your-project-name> --example=yes

) it's created separately on the same level as /src. Is this a bug or a feature?

I believe test should be outside

src

, and this is a known issue that needs to be updated.

Thanks! Is there a discussion where I could learn more on why it should be kept seperate?

Let me find a link; in short, purpose or src layout is to isolate code from other things.

@Julian Nowak Would you mind leave a comment on the issue itself? It helps a lot for our priority.

@Nok Lam Chan sure, on this one: https://github.com/kedro-org/kedro/issues/1271

?

that issue exist already

Got distracted; here's a reference explanation @Julian Nowak: https://www.pyopensci.org/python-package-guide/package-structure-code/python-package-structure.html#the-src-layout-and-testing

I have a question then, my custom dataset that I created imports some function from:

from {project}.pipelines.common_methods import _to_numeric

when I reference the dataset in its test:

from src.{project}.datasets.my_dataset import MyDataset

(now I have to add this

src.

, right?) and run

pytest

I get the error

src\{project}\datasets\MyDataset.py:13: in <module>
    from {project}.pipelines.common_methods import _to_numeric
E   ModuleNotFoundError: No module named '{project}'

Should I add my project to pytonpath in some other way that it is done by default?

Yeah, you shouldn't import

from src

The first method didn't work for me, but installing it with

pip install .

does

I suggest you to install your project in editable mode:

pip install -e .

@Takieddine Kadiri thanks!

By going into the

pip install

approach you're not relying on kedro nor on pytest for adding your packages that live under

src

to the sys path, you could then import your package from whatever module that live inside your python env. You're however relying on Kedro's template that preconfigure the

pyproject.toml

to play well with the src layout.

I hope best practices for this will be included in the documentation as well 😄