Modify --save-profiling-data to accept File Path(Ploomber Engine CLI)

[tonykploomber]

Describe your changes

Now save_profiling_data can take Path string, also the existing bool usage will be supported as well.

Changes:

• Enhance save_profiling_data option to accept Path
• Updates doc in API Reference, Memory usage and Cell runtime

Issue number

Closes #65

Checklist before requesting a review

• Performed a self-review of my code
• Formatted my code with pkgmt format
• Added tests (when necessary).
• Added docstring documentation and update the changelog (when needed)

---

📚 Documentation preview 📚: https://ploomber-engine--78.org.readthedocs.build/en/78/

[edublancas]

im confused about these and the values below. we're testing a CLI, so all the inputs must be serialized to strings. how come we're passing floats, dictionaries and tuples?

[tonykploomber]

In the jupyter user might execute something like this:

_ = execute_notebook(
    "notebook.ipynb", "output.ipynb", profile_memory=True, save_profiling_data=float(123.0))

[tonykploomber]

If execute execute_notebook directly, it's possible we pass non-string

[edublancas]

yes, I understand. but this is testing the CLI. either this is a problem with runner.invoke or the values are being serialized to strings anyway.

i think it's best to parameterized this test over different strings then. because the other values are not representative of a real CLI use case.

[tonykploomber]

I got what you means, and this test case is to test on running on CLI

Remove other datatypes in 85b0110

But LMK if you want me to test other string

[avivajpeyi]

Hey! this is great, is there a planned pypi release date for 0.0.29dev?

[edublancas]

I forgot to make the release, just did it!

it ended up being 0.0.30 because there was some issue with the package's metadata (0.0.29 failed to upload to PyPI)