plots: code templates not found

[mattlbeck]

Bug Report

Since 2.8.2 my code base templates are not located as they used to be via dvc plots show/diff -t <template_name>.

As far as I can tell this is due to the path root being prefixed to the template name before matching

https://github.com/iterative/dvc/blob/e2d705fd76771c184f85a477f8d73aea40a96cab/dvc/repo/plots/template.py#L123-L129

At face value the fix may just be

templates = [
    file
    for root, _, files in os.walk(self.templates_dir)
    for file in files
]

[daavoo]

Hi @mattlbeck ! There was a breaking change in #6550 but the docs have not been updated yet to document the new behavior 🙏 (you can find more info in the description of the P.R. though) .

Were you using custom templates or just the default included in DVC?

[daavoo]

Also, could you share the output of dvc doctor? It is known that the templates are missing in binary installations (#6550 (comment))

[mattlbeck]

DVC version: 2.8.2 (pip)
---------------------------------
Platform: Python 3.9.1 on macOS-10.16-x86_64-i386-64bit
Supports:
        webhdfs (fsspec = 2021.10.1),
        http (aiohttp = 3.7.4.post0, aiohttp-retry = 2.4.5),
        https (aiohttp = 3.7.4.post0, aiohttp-retry = 2.4.5),
        s3 (s3fs = 2021.10.1, boto3 = 1.17.106)
Cache types: reflink, hardlink, symlink
Cache directory: apfs on /dev/disk1s1s1
Caches: local
Remotes: s3
Workspace directory: apfs on /dev/disk1s1s1
Repo: dvc, git

[mattlbeck]

I have a custom template I am using e.g. .dvc/plots/mycustomplot.json

The template is not found if I use dvc plots show -t mycustomplot, which was the correct old behaviour. It is found if I use the full path e.g. dvc plots show -t .dvc/plots/mycustomplot.json.

Is this the intended behaviour? It also breaks our current dvc.yaml as the templates are also specified there. I guess I could also fix this by moving the template to the working directory (repo root), but I would personally prefer to store custom plots in the .dvc/plots directory as this feels better organised.

[dberenbaum]

@pared I don't think these changes were intended to be breaking, correct?

[pared]

@mattlbeck no its not intended behaviour, let me look into that.

[pared]

@mattlbeck I made a fix, you can check it out in #6866