inspect: Add some comments in Parameter.__eq__ method

1st1 · 1st1 · commit 0ba5f0d3866a · 2014-01-31T15:30:30.000-05:00
diff --git a/Lib/inspect.py b/Lib/inspect.py
@@ -1905,6 +1905,17 @@ def __repr__(self):
                                            id(self), self.name)
 
     def __eq__(self, other):
+        # NB: We deliberately do not compare '_partial_kwarg' attributes
+        # here. Imagine we have a following situation:
+        #
+        #    def foo(a, b=1): pass
+        #    def bar(a, b): pass
+        #    bar2 = functools.partial(bar, b=1)
+        #
+        # For the above scenario, signatures for `foo` and `bar2` should
+        # be equal.  '_partial_kwarg' attribute is an internal flag, to
+        # distinguish between keyword parameters with defaults and
+        # keyword parameters which got their defaults from functools.partial
         return (issubclass(other.__class__, Parameter) and
                 self._name == other._name and
                 self._kind == other._kind and
