NF: Add keyword_only decorator to enforce keyword-only arguments #888

WassCodeur · 2024-05-21T14:56:14Z

Description:

Added @keyword_only decorator to enforce keyword-only arguments in project functions.

Modification details:

Creation of the @keyword_only decorator to ensure that functions can only be - called with arguments specified solely by keyword.
Documentation of the new decorator, including usage examples and explanations of how it works.
Added unit tests to ensure proper operation of the new decorator.

This contribution represents the first step towards applying the @keyword_only decorator to the appropriate functions in the project. Current modifications include the creation of the decorator, associated documentation and unit tests. The next step will be to identify and apply the decorator to relevant functions throughout the project.

WassCodeur · 2024-05-21T17:47:53Z

Hi @skoudoro!
I'm trying to understand why the test fails on github.

skoudoro

Hi @WassCodeur,

Thank you for this first version. See below some comments

skoudoro · 2024-05-21T17:49:09Z

fury/tests/test_decorators.py

+
+def test_keyword_only():
+    @keyword_only
+    def f(*, a, b):


here, the function should be :

def f(a, b, *, c=1, d=2): return a+b+c+d

skoudoro · 2024-05-21T17:52:57Z

fury/decorators.py

+            raise TypeError(
+                (
+                    "{}() takes 0 positional arguments but {} were given\n"
+                    "Usage: {}({})\n"
+                    "Please Provide keyword-only arguments: {}"
+                ).format(
+                    func.__name__,
+                    len(args),
+                    func.__name__,
+                    params_sample_str,
+                    params_sample_str,
+                )


We do not want to raise TypeError. maximum a warning

skoudoro · 2024-05-21T17:53:02Z

fury/decorators.py

+            )
+        else:
+            if unexpected_params:
+                raise TypeError(


We do not want to raise TypeError. maximum a warning

skoudoro · 2024-05-21T17:53:08Z

fury/decorators.py

+                )
+
+            elif missing_params:
+                raise TypeError(


We do not want to raise TypeError. maximum a warning

skoudoro · 2024-05-21T17:53:51Z

fury/tests/test_decorators.py

+        return a + b
+
+    npt.assert_equal(f(a=1, b=2), 3)
+    npt.assert_raises(TypeError, f, a=1, b=2, c=2)


this case should not raise typeError or warnings, this is a good case

skoudoro · 2024-05-21T17:54:15Z

fury/tests/test_decorators.py

+
+    npt.assert_equal(f(a=1, b=2), 3)
+    npt.assert_raises(TypeError, f, a=1, b=2, c=2)
+    npt.assert_raises(TypeError, f, 1, 2)


this should generate a warning and not a typeError

skoudoro · 2024-05-21T17:54:31Z

fury/tests/test_decorators.py

+    npt.assert_equal(f(a=1, b=2), 3)
+    npt.assert_raises(TypeError, f, a=1, b=2, c=2)
+    npt.assert_raises(TypeError, f, 1, 2)
+    npt.assert_raises(TypeError, f, 1, b=2)


this should generate a warning and not a typeError

skoudoro · 2024-05-21T17:54:54Z

fury/tests/test_decorators.py

+    npt.assert_raises(TypeError, f, a=1, b=2, c=2)
+    npt.assert_raises(TypeError, f, 1, 2)
+    npt.assert_raises(TypeError, f, 1, b=2)
+    npt.assert_raises(TypeError, f, a=1, b=2)


this case is good and should generate nothing

skoudoro · 2024-05-21T17:55:17Z

fury/tests/test_decorators.py

+    npt.assert_raises(TypeError, f, 1, 2)
+    npt.assert_raises(TypeError, f, 1, b=2)
+    npt.assert_raises(TypeError, f, a=1, b=2)
+    npt.assert_raises(


this case should not exist

skoudoro · 2024-05-21T17:57:10Z

Also, You do not need to close and open a new PR. a PR can be updated. When, it is open, it is better to update it.

it is very confusing to open and close multiple time the same PR. Let me know if you need more explanation

skoudoro · 2024-05-21T17:57:39Z

So please, reopen this one and try to update it

WassCodeur · 2024-05-21T18:24:53Z

Okay, I've already reopened it. Thank you

itellaetxe

I think the functionality is correct,
Docstrings are okay, examples are given, and the test cases are sufficient.

In the CI, it looks like there is a problem when building for macos-latest for the Python versions 3.8 (ERROR: No matching distribution found for vtk>=9.1.0) and 3.10 (Error: Codecov token not found. Please provide Codecov token with -t flag. maybe something related to the workflow .yaml configuration file).
For ubuntu-latest also in Python 3.8, the test test_elements.py::test_ui_line_slider_2d_horizontal_top is not passing.

fury/decorators.py

itellaetxe · 2024-05-28T12:02:48Z

fury/tests/test_decorators.py

+    def f(a, b, *, c, d=4, e=5):
+        return a + b + c + d + e
+
+    npt.assert_equal(f(1, 2, c=3, d=4, e=5), 15)


I think tests are now correct.

skoudoro

I need to look deeper at this review, but for now, can you fix all warnings and rebase this PR. Thank you @WassCodeur

itellaetxe · 2024-05-30T09:55:59Z

Your decorator is raising the Warnings correctly, where the keyword-only functions are not being called only with keywords. You can adjust the function calls as the warning suggests to do, so you get rid of the warnings. Similar to what @deka27 did in his decorator PR.

WassCodeur · 2024-05-30T10:48:07Z

Hi @skoudoro, @itellaetxe !

Thank you for your comments. I'm working on it.

skoudoro · 2024-06-04T10:39:58Z

Hi @WassCodeur,

What is the status of this PR? Can you also rebase this PR to apply the last changes.

It would be great to have all this update as soon as possible

WassCodeur · 2024-06-04T11:01:05Z

Hi @skoudoro !

Okay. I'm making the last improvements. I'll push it today.

skoudoro

Hi @WassCodeur,

Can you rebase your PR, I see old work on this branch and we can not see the difference between your work and previous work.

Thank you

skoudoro · 2024-06-05T12:01:49Z

fury/decorators.py

@@ -43,3 +46,95 @@ def doctest_skip_parser(func):
        new_lines.append(code)
    func.__doc__ = "\n".join(new_lines)
    return func
+
+
+def keyword_only(func):


Can you rename warn_on_args_to_kwargs

also, this function needs parameter like from_version and until_version

@skoudoro

All right, thanks for your feedback.

reminder here

author WassCodeur <[email protected]> 1716302141 +0000 committer WassCodeur <[email protected]> 1717549770 +0000 NF: Add keyword_only decorator to enforce keyword-only arguments RF: Refactor keyword-only code and Add keyword-only arguments to functions TEST: Add test for keyword_only" decorator Refactor code to use keyword-only arguments in several functions NF: remove some doctest and add a short comment on line 111 to explain what the loop does in fury/decorators.py RF: Refactor keyword-only code and Add keyword-only arguments to functions Refactor code to use keyword-only arguments in several functions

…tions

skoudoro

Hi @WassCodeur,

reminder to change the decorator name.

Also, this warnings is still here and this is the last one it seems:

fury/animation/tests/test_interpolators.py::test_color_interpolators
  /home/runner/work/fury/fury/fury/animation/interpolator.py:310: UserWarning: Here's how to call the Function rgb2lab: rgb2lab(rgb_value, illuminant='value', observer='value')
    return color_interpolator(keyframes, rgb2lab, lab2rgb)

Please, check the failing CI to understand what is going on. Some are normal errors, some are not.

Thank you for the future update

skoudoro · 2024-06-07T10:12:49Z

fury/decorators.py

@@ -43,3 +46,95 @@ def doctest_skip_parser(func):
        new_lines.append(code)
    func.__doc__ = "\n".join(new_lines)
    return func
+
+
+def keyword_only(func):


reminder here

skoudoro · 2024-06-10T09:23:18Z

What is the status of this PR, we need to move forward @WassCodeur.

- Renamed `keyword-only` decorator to `warn_on_args_to_kwargs` for greater clarity. - Updated `warn_on_args_to_kwargs` to include version parameters `from_version` and `until_version`. - Added logic to raise a RuntimeError if the current version of FURY_VERSION is greater than `until_version`. - Moved `__version__` definition to a new `fury/version.py` module to avoid circular import problems. - Updated all functions using the decorator to reflect the new name and parameters. - Adjusted import declarations and ensured compatibility across the code base.

…the warn_on_args_to_kwargs decorator

itellaetxe

Extensive job modifying both the function definitions and function calls to match the requirements of your decorator. Just a small comment on a commented test function.

Maybe you could comment the test cases of the decorator a bit so it is clearer?
On the other hand, is something like deprecates_from_version being implemented? I might have overlooked it, but I could not see it.

All in all, good. GJ Wachiou

itellaetxe · 2024-06-10T17:36:13Z

fury/tests/test_decorators.py

+    npt.assert_raises(TypeError, func, 1)
+
+
+# def test_warn_on_args_to_kwargs_with_versions():


Will this function stay commented? or is it WIP?

Yes it's WIP

Will u check different test states for different versions as well?

No, it'll be one test for every version.

fury/decorators.py

WassCodeur · 2024-06-10T18:27:09Z

Extensive job modifying both the function definitions and function calls to match the requirements of your decorator. Just a small comment on a commented test function.

Maybe you could comment the test cases of the decorator a bit so it is clearer?
On the other hand, is something like deprecates_from_version being implemented? I might have overlooked it, but I could not see it.

All in all, good. GJ Wachiou

Thank you @itellaetxe for your constructive feedback!

Yes, you're right, I have to comment on it to make it clearer. For deprecates_from_version I managed it from L151 to L161 in the decorators.py file.

…gs arguments to functions in window.py and actor.py

robinroy03

Amazing work Wachiou :)

Please see the below suggestions.

fury/decorators.py

robinroy03 · 2024-06-23T21:02:54Z

fury/tests/test_decorators.py

@@ -49,3 +49,29 @@ def f():
    del HAVE_AMODULE
    f.__doc__ = docstring
    npt.assert_raises(NameError, doctest_skip_parser, f)
+
+
+def test_warn_on_args_to_kwargs():


I'm not sure if tests to check from_version and until_version are trivial. It'll be good if they are possible.

I think we could do something like fury.__version__ to simulate the situation.

Hi @robinroy03 thanks for your comment, this pull request for the warn_on_args_to_kwargs decorator. I will focus on this with another dedicated pull request.

skoudoro

Hi @WassCodeur,

See below additional comments. Please, look at @deka27 to get some inspiration concerning the versioning.

Looking forward for the update

fury/decorators.py

skoudoro · 2024-06-25T15:41:28Z

fury/decorators.py

+                    from fury import __version__ as FURY_VERSION
+
+                    if version.parse(FURY_VERSION) > version.parse(until_version):
+                        raise TypeError(e) from e


What about the other cases ? Look and review @deka27 PR.

if version.parse(FURY_VERSION) < version.parse(from_version), no warnings no errors

skoudoro · 2024-06-25T15:42:05Z

fury/gltf.py

@@ -32,7 +33,8 @@


 class glTF:
-    def __init__(self, filename, apply_normals=False):
+    @warn_on_args_to_kwargs()


parenthesis not needed everywhere

if I don't put a parenthesis it raises a TypeError.

fury/decorators.py

WassCodeur · 2024-06-25T17:42:45Z

Hi @skoudoro

Thank you for your comments, I will take into account all your remarks and fix them too.

…s and update the unittest

skoudoro

Great Job! thank you for this. merging

…y-gl#888) * parent 4baa99d author WassCodeur <[email protected]> 1716302141 +0000 committer WassCodeur <[email protected]> 1717549770 +0000 NF: Add keyword_only decorator to enforce keyword-only arguments RF: Refactor keyword-only code and Add keyword-only arguments to functions TEST: Add test for keyword_only" decorator Refactor code to use keyword-only arguments in several functions NF: remove some doctest and add a short comment on line 111 to explain what the loop does in fury/decorators.py RF: Refactor keyword-only code and Add keyword-only arguments to functions Refactor code to use keyword-only arguments in several functions * NF: Add keyword_only decorator to enforce keyword-only arguments * NF: Add keyword_only decorator to enforce keyword-only arguments * RF: Refactor keyword-only code and Add keyword-only arguments to functions * TEST: Add test for keyword_only" decorator * Refactor interactor.py and molecular.py * RF: Rename and update decorator for version checks - Renamed `keyword-only` decorator to `warn_on_args_to_kwargs` for greater clarity. - Updated `warn_on_args_to_kwargs` to include version parameters `from_version` and `until_version`. - Added logic to raise a RuntimeError if the current version of FURY_VERSION is greater than `until_version`. - Moved `__version__` definition to a new `fury/version.py` module to avoid circular import problems. - Updated all functions using the decorator to reflect the new name and parameters. - Adjusted import declarations and ensured compatibility across the code base. * RF: Refactor the code by removing version constraints in the call to the warn_on_args_to_kwargs decorator * RF: Refactor warn_on_args_to_kwargs code and Add warn_on_args_to_kwargs arguments to functions in window.py and actor.py * RF: update the version checks in the decorator: warn_on_args_to_kwargs and update the unittest * RF: warn_on_args_to_kwargs decorator parent 4baa99d author WassCodeur <[email protected]> 1716302141 +0000 committer WassCodeur <[email protected]> 1717549770 +0000 NF: Add keyword_only decorator to enforce keyword-only arguments RF: Refactor keyword-only code and Add keyword-only arguments to functions TEST: Add test for keyword_only" decorator Refactor code to use keyword-only arguments in several functions NF: remove some doctest and add a short comment on line 111 to explain what the loop does in fury/decorators.py RF: Refactor keyword-only code and Add keyword-only arguments to functions Refactor code to use keyword-only arguments in several functions NF: Add keyword_only decorator to enforce keyword-only arguments RF: Refactor keyword-only code and Add keyword-only arguments to functions Refactor interactor.py and molecular.py RF: Rename and update decorator for version checks - Renamed `keyword-only` decorator to `warn_on_args_to_kwargs` for greater clarity. - Updated `warn_on_args_to_kwargs` to include version parameters `from_version` and `until_version`. - Added logic to raise a RuntimeError if the current version of FURY_VERSION is greater than `until_version`. - Moved `__version__` definition to a new `fury/version.py` module to avoid circular import problems. - Updated all functions using the decorator to reflect the new name and parameters. - Adjusted import declarations and ensured compatibility across the code base. RF: update the version checks in the decorator: warn_on_args_to_kwargs and update the unittest RF: warn_on_args_to_kwargs decorator

…y-gl#888)

WassCodeur closed this May 21, 2024

WassCodeur deleted the keyword_only branch May 21, 2024 17:49

skoudoro reviewed May 21, 2024

View reviewed changes

WassCodeur restored the keyword_only branch May 21, 2024 18:11

WassCodeur reopened this May 22, 2024

skoudoro requested review from itellaetxe, robinroy03 and deka27 May 28, 2024 09:08

itellaetxe reviewed May 28, 2024

View reviewed changes

itellaetxe mentioned this pull request May 28, 2024

NF: Decorator for keyword-only argument dipy/dipy#3239

Merged

15 tasks

skoudoro reviewed May 29, 2024

View reviewed changes

skoudoro reviewed Jun 5, 2024

View reviewed changes

WassCodeur added 5 commits June 5, 2024 14:08

NF: Add keyword_only decorator to enforce keyword-only arguments

0047cf6

NF: Add keyword_only decorator to enforce keyword-only arguments

8e5c0b0

RF: Refactor keyword-only code and Add keyword-only arguments to func…

0126a15

…tions

TEST: Add test for keyword_only" decorator

64fa7ad

WassCodeur force-pushed the keyword_only branch from c2cfb6e to 64fa7ad Compare June 5, 2024 16:17

Refactor interactor.py and molecular.py

6b00d92

skoudoro reviewed Jun 7, 2024

View reviewed changes

WassCodeur requested review from skoudoro and itellaetxe June 10, 2024 16:39

RF: Refactor the code by removing version constraints in the call to …

562bcb0

…the warn_on_args_to_kwargs decorator

itellaetxe reviewed Jun 10, 2024

View reviewed changes

WassCodeur commented Jun 10, 2024

View reviewed changes

fury/decorators.py Outdated Show resolved Hide resolved

RF: Refactor warn_on_args_to_kwargs code and Add warn_on_args_to_kwar…

17794ee

…gs arguments to functions in window.py and actor.py

robinroy03 suggested changes Jun 23, 2024

View reviewed changes

skoudoro requested changes Jun 25, 2024

View reviewed changes

skoudoro reviewed Jun 25, 2024

View reviewed changes

fury/decorators.py Outdated Show resolved Hide resolved

WassCodeur added 2 commits June 26, 2024 14:09

RF: update the version checks in the decorator: warn_on_args_to_kwarg…

2fb6c7a

…s and update the unittest

RF: warn_on_args_to_kwargs decorator

1f34348

skoudoro approved these changes Jul 10, 2024

View reviewed changes

skoudoro merged commit 56a6177 into fury-gl:master Jul 10, 2024
17 of 29 checks passed

WassCodeur added a commit to WassCodeur/fury that referenced this pull request Jul 13, 2024

NF: Add keyword_only decorator to enforce keyword-only arguments (fur…

a3caa0e

…y-gl#888)

		npt.assert_raises(TypeError, func, 1)


		# def test_warn_on_args_to_kwargs_with_versions():

NF: Add keyword_only decorator to enforce keyword-only arguments #888

NF: Add keyword_only decorator to enforce keyword-only arguments #888

Conversation

WassCodeur commented May 21, 2024

WassCodeur commented May 21, 2024

skoudoro left a comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

skoudoro commented May 21, 2024

skoudoro commented May 21, 2024

WassCodeur commented May 21, 2024

itellaetxe left a comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

skoudoro left a comment

Choose a reason for hiding this comment

itellaetxe commented May 30, 2024

WassCodeur commented May 30, 2024

skoudoro commented Jun 4, 2024

WassCodeur commented Jun 4, 2024

skoudoro left a comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

skoudoro left a comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

skoudoro commented Jun 10, 2024

itellaetxe left a comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

deka27 Jun 12, 2024 • edited Loading

Choose a reason for hiding this comment

WassCodeur Jun 13, 2024 • edited Loading

Choose a reason for hiding this comment

WassCodeur commented Jun 10, 2024

robinroy03 left a comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

skoudoro left a comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

WassCodeur commented Jun 25, 2024

skoudoro left a comment

Choose a reason for hiding this comment

deka27 Jun 12, 2024 •

edited

Loading

WassCodeur Jun 13, 2024 •

edited

Loading