improve %load_node support full node syntax

[noklam]

Description

Fix #3629

• %load_node support full Kedro Node syntax, with better *args, **kwargs handling #3629

Development notes

2 main changes:

1. Refactor to use a NodeBoundArguments, which inherit from inspect.BoundArguments. . This allow the helper function to return a proper data structure for testing. The structure will also be useful for generating all the necessary text so our tests can focus on testing on the data structure, not the exact string.
2. Using BoundArguments, we can easily generate the necessary function signature according to the node function, the only thing we need to do is taking care of the "*args" to handle a specific edge case.

Developer Certificate of Origin

We need all contributions to comply with the Developer Certificate of Origin (DCO). All commits must be signed off by including a Signed-off-by line in the commit message. See our wiki for guidance.

If your PR is blocked due to unsigned commits, then you must follow the instructions under "Rebase the branch" on the GitHub Checks page for your PR. This will retroactively add the sign-off to all unsigned commits and allow the DCO check to pass.

Checklist

• Read the contributing guidelines
• Signed off each commit with a Developer Certificate of Origin (DCO)
• Opened this PR as a 'Draft Pull Request' if it is work-in-progress
• Updated the documentation to reflect the code changes
• Added a description of this change in the RELEASE.md file
• Added tests to cover my changes
• Checked if this change will affect Kedro-Viz, and if so, communicated that with the Viz team

[noklam]

@lrcouto It's ready for test, I have refactor the logic and manual tested and unit tests are all passed.

[lrcouto]

@astrojuanlu here's the issue I mentioned today at standup.

This function at inspect.BoundNode has a docstring that contains *args and **kwargs. Sphinx is considering the * characters to be a bold text tag that was opened and not closed, and I can't change the docstring since it's on an external lib. =p

[astrojuanlu]

For reference: https://docs.python.org/3/library/inspect.html#inspect.BoundArguments.apply_defaults, https://github.com/python/cpython/blob/468ba95c797623ab4f4ff95ac342ded9e9a74e97/Lib/inspect.py#L2701-L2709

[noklam]

Was the issue Sphinx is trying to render that method in docs? Can we somehow suppress this, tbh there is not much value to document the class in the API docs, we can even convert it to a private class _NodeBoundArguments if it helps.

[lrcouto]

Was the issue Sphinx is trying to render that method in docs? Can we somehow suppress this, tbh there is not much value to document the class in the API docs, we can even convert it to a private class _NodeBoundArguments if it helps.

I think it is. I've been trying to find a way to either suppress warnings from external libraries, or suppress this specific warning, but I don't think I can do that without ignoring the whole file. I'll try to see if converting it to a private class helps.

[lrcouto]

Converted NodeBoundArguments to private and that solved this specific instance of the problem. It'd still be a good idea to find a more permanent solution for this issue though.

[noklam]

@lrcouto Great! I think we have seen this issue in the past, I don't really remember how we solved it, maybe @AhdraMeraliQB or @astrojuanlu knows more? The solution is to not use some of the autodoc that trigger upstream dependencies, turning into private class is sufficient for now.

[noklam]

Tagging @DmitriiDeriabinQB and @ankatiyar for review

[astrojuanlu]

The other @DimedS :)

[astrojuanlu]

The way I've usually solved it is by committing the template generated by sphinx.ext.autosummary during the docs building process and removing the classes or properties I don't want to have documented. Sphinx will then abstain from overwriting the file.

Good that you solved the problem for now 👍🏽 I don't think this was expected to be public API anyway?

[astrojuanlu]

Tested this, and it works!

[ankatiyar]

Tested manually. Thanks @noklam and @lrcouto :D