calling python_to_json with WindowsPath causes module import failure due to incorrect implicít path to string conversion

[SabrCat]

from grafana_dashboard.grafana_dashboard import json_to_python, python_to_json
from pathlib import Path

python_to_json(python_base_dir=Path("."), python_base_package="input", json_dir=Path("output"))

This script does not work on windows as I am passing a WindowsPath object into python_base_dir, which propagates to

grafana_dashboard_python/grafana_dashboard/converter/python_to_json.py

Line 28 in f1415a4

mod = importlib.import_module(python_package_name)

where the path is implicitly converted into a string as it passes into importlib. Therefore inputlib ends up with name='input\\testout', when it should have been called with name=input.testout.

Changing the script to the following circumvents the issue (patch courtesy of ChatGPT 4o)

import importlib
_real_import_module = importlib.import_module

def patched_import_module(name, package=None):
    # Fix backslashes to dots
    fixed = name.replace("\\", ".")
    return _real_import_module(fixed, package)

importlib.import_module = patched_import_module

from grafana_dashboard.grafana_dashboard import json_to_python, python_to_json
from pathlib import Path

import input.testout


python_to_json(python_base_dir=Path("."), python_base_package="input", json_dir=Path("output"))

[fzyzcjy]

Good fix! Do you have interest in making a PR to fix the line you pointed out?

[SabrCat]

This honestly doesn't seem like the proper fix. it's a hacky injection that works, but it's not the proper way. The proper way would be to convert a Pathlib Path object into a pythonic module string explicitly instead of relying on implicit string casting. I do not know whether Pathlib natively supports outputting paths in dot notation.

[fzyzcjy]

Yes I agree, but anyway I think change https://github.com/fzyzcjy/grafana_dashboard_python/blob/f1415a405860ec5bb50e7b6cef2a8e0b757f04d5/grafana_dashboard/converter/python_to_json.py#L51C1-L52C1 to

return str(path_python.relative_to(python_base_dir)).replace('\\', '.').replace('/', '.').removesuffix('.py')

does not harm

[SabrCat]

It would do no harm, but I think this runs the risk of breaking on edge cases. Something like this might be more stable under all operating systems. The fewer raw string operations the better in my opinion.

return path_python.relative_to(python_base_dir).with_suffix("").as_posix().replace("/", ".")