bpo-19903: IDLE: Change to inspect.signature for calltips by louisom · Pull Request #1382 · python/cpython

louisom · 2017-05-02T10:28:19Z

This commit change the get_argspec from using inspect.getfullargspec
to inspect.signature. It will improve the tip message for use.

This commit change the get_argspec from using inspect.getfullargspec to inspect.signature. It will improve the tip message for use. Also, if object is not callable, now will return this message for user, not blank tips. If the methods has an invalid method signature, it will also return message to user.

mention-bot · 2017-05-02T10:28:21Z

@lulouie, thanks for your PR! By analyzing the history of the files in this pull request, we identified @terryjreedy, @kbkaiser and @serhiy-storchaka to be potential reviewers.

serhiy-storchaka · 2017-05-02T11:59:32Z

    argspec = ""
    try:
        ob_call = ob.__call__
+    except AttributeError:


Could you left this change for separate issue?

serhiy-storchaka · 2017-05-02T12:02:34Z

        if (isinstance(ob, (type, types.MethodType)) or
                isinstance(ob_call, types.MethodType)):
-            argspec = _first_param.sub("", argspec)
+            if argspec.startswith("(self,"):


What if the first parameter have a different name?

Yes, you are right. I'll still need to figure out how it does different from getfullargspec

Find out that signature will deal correctly with MethodType, but will not handle __init__ correctly.
Fix the condition of trim first param.

louisom · 2017-05-03T04:08:59Z

@serhiy-storchaka @terryjreedy Also add the test for first param not self test.

louisom · 2017-05-03T04:12:04Z

-            def m2(**kwds): pass
        c = C()
-        for meth, mtip  in ((C.m1, '(*args)'), (c.m1, "(*args)"),
-                                      (C.m2, "(**kwds)"), (c.m2, "(**kwds)"),):


Remove invalid method signature, move to test_invalid_method_signature

louisom · 2017-05-03T04:12:24Z

+
+        mtip = "This function has an invalid method signature"
+        self.assertEqual(signature(C().m2), mtip)
+        self.assertEqual(signature(Test()), mtip)


This test borrow from test_signature

louisom · 2017-05-03T04:12:44Z

                raise BaseException
-        class Call(NoCall):
+        class CallA(NoCall):
+            def __call__(oui, a, b, c):


Add corner case for first param not self

louisom · 2017-05-03T04:13:04Z

        for obj in (0, 0.0, '0', b'0', [], {}):
            self.assertEqual(signature(obj), '')

+


terryjreedy · 2017-05-04T07:14:16Z

@@ -145,10 +148,16 @@ def get_argspec(ob):
    else:
        fob = ob
    if isinstance(fob, (types.FunctionType, types.MethodType)):


Remove and dedent block.

terryjreedy · 2017-05-04T07:14:55Z

-        argspec = inspect.formatargspec(*inspect.getfullargspec(fob))
+        try:
+            argspec = str(inspect.signature(fob))
+        except ValueError:


Must get and test error message.

terryjreedy · 2017-05-04T07:17:39Z

+        try:
+            argspec = str(inspect.signature(fob))
+        except ValueError:
+            argspec = "This function has an invalid method signature"


Add _invalid_signature to global defs before function so can access for testing without repeating string.

terryjreedy · 2017-05-04T07:18:15Z

-        argspec = inspect.formatargspec(*inspect.getfullargspec(fob))
+        try:
+            argspec = str(inspect.signature(fob))
+        except ValueError:


Condition return on error message

terryjreedy · 2017-05-04T07:19:18Z

+            argspec = "This function has an invalid method signature"
+            return argspec
+
        if (isinstance(ob, (type, types.MethodType)) or


Add argspec != '' to later revised condition

terryjreedy

See msg292964 on issue for explanations and comment on what test addition is needed.

terryjreedy · 2017-05-04T17:45:52Z

@@ -1,4 +1,4 @@
-"""calltips.py - An IDLE Extension to Jog Your Memory
+b"""calltips.py - An IDLE Extension to Jog Your Memory


??? Docstrings are not bytes.

A typo..., I'm using trackpoint on laptop, sometime when scrolling down, it will unexpectedly
pressing "b"

terryjreedy · 2017-05-04T17:57:35Z

    except BaseException:
        return argspec
-    if isinstance(ob, type):
-        fob = ob.__init__


Why remove this? It worked before. Does signature() do this automatically? Such a change should be explained on the issue with examples, both for Python and C coded classed. And yes, I wish I had added comments here or in test file or, by reference, an issue, when I revised this and and added test file.

As you said on msg, this will automatically done by signature.

terryjreedy · 2017-05-04T18:00:31Z

+    if '/' in argspec:
+        """Argument Clinic positional-only mark, ignore the result of signature
+        """
+        argspec = ''


Why? '/' is used in legitimate signatures, and appear, I believe, in the docs.

I'll use your method in msg293008

terryjreedy · 2017-07-24T19:02:39Z

Replaced by #2822 with new account name. LEAVE THIS OPEN FOR NOW. Since it will not be merged, I am using it as one example of not being able to edit the code due to lack permission.

terryjreedy · 2017-08-02T21:41:55Z

Edit by others being turned off seems to be resolved for now.

the-knights-who-say-ni added the CLA signed label May 2, 2017

serhiy-storchaka reviewed May 2, 2017

View reviewed changes

Revert object is not callable

c5ef4d1

brettcannon added the type-feature A feature request or enhancement label May 2, 2017

terryjreedy self-assigned this May 2, 2017

Fix first param trim condition

f1cf2c2

Revert test_non_callables

837f88a

louisom commented May 3, 2017

View reviewed changes

terryjreedy self-requested a review May 4, 2017 07:07

terryjreedy reviewed May 4, 2017

View reviewed changes

terryjreedy requested changes May 4, 2017

View reviewed changes

louisom added 4 commits May 4, 2017 17:08

Add built-in function test

a3bfdbd

Fix invalid method signature message

13172f1

Fix re.sub compare string

b40056c

Fix callable signature

a9f1825

terryjreedy reviewed May 4, 2017

View reviewed changes

louisom added 2 commits May 5, 2017 11:57

Revert unexpect bytes string

8caf548

Add AC argument positional explain and test

a2b3829

louisom changed the title ~~bpo-19903: Change to inspect.signature for calltips~~ bpo-19903: IDLE: Change to inspect.signature for calltips May 10, 2017

mlouielu mentioned this pull request Jul 23, 2017

bpo-19903: IDLE: Calltips changed to use inspect.signature #2822

Merged

terryjreedy closed this Aug 2, 2017

		for obj in (0, 0.0, '0', b'0', [], {}):
		self.assertEqual(signature(obj), '')

		@@ -1,4 +1,4 @@
		"""calltips.py - An IDLE Extension to Jog Your Memory
		b"""calltips.py - An IDLE Extension to Jog Your Memory

Uh oh!

Conversation

louisom commented May 2, 2017 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Uh oh!

mention-bot commented May 2, 2017

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

louisom commented May 3, 2017

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

terryjreedy left a comment

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

terryjreedy commented Jul 24, 2017 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Uh oh!

terryjreedy commented Aug 2, 2017

Uh oh!

Reviewers

Assignees

Labels

Projects

Milestone

Development

Uh oh!

6 participants

louisom commented May 2, 2017 •

edited

Loading

terryjreedy commented Jul 24, 2017 •

edited

Loading