2023-06-30 09:13:07 +02:00
This rule raises an issue when a call is made to a non-callable object.
2023-05-03 11:06:20 +02:00
== Why is this an issue?
2021-04-28 16:49:39 +02:00
:link-with-uscores1: https://docs.python.org/3/reference/datamodel.html#object.__call__
2023-06-30 09:13:07 +02:00
In order to be callable, a Python class should implement the {link-with-uscores1}[``++__call__++``] method. Thanks to this method, an instance of this class will be callable as a function.
2021-04-28 16:49:39 +02:00
2023-06-30 09:13:07 +02:00
However, when making a call to a non-callable object, a `TypeError` will be raised.
2021-04-28 16:49:39 +02:00
2023-06-30 09:13:07 +02:00
In order to fix this issue, make sure that the object you are trying to call has a `++__call__++` method.
2021-04-28 16:49:39 +02:00
2023-06-30 09:13:07 +02:00
=== Code examples
2021-04-28 18:08:03 +02:00
2023-06-30 09:13:07 +02:00
==== Noncompliant code example
2021-04-28 16:49:39 +02:00
2022-02-04 17:28:24 +01:00
[source,python]
2021-04-28 16:49:39 +02:00
----
class MyClass:
pass
myvar = MyClass()
myvar() # Noncompliant
none_var = None
none_var() # Noncompliant
----
2021-04-28 18:08:03 +02:00
2023-06-30 09:13:07 +02:00
==== Compliant solution
2021-04-28 16:49:39 +02:00
2022-02-04 17:28:24 +01:00
[source,python]
2021-04-28 16:49:39 +02:00
----
class MyClass:
def __call__(self):
print("called")
myvar = MyClass()
myvar()
----
2021-04-28 18:08:03 +02:00
2021-04-28 16:49:39 +02:00
:link-with-uscores1: https://docs.python.org/3/reference/datamodel.html#object.__call__
2023-05-03 11:06:20 +02:00
== Resources
2021-04-28 16:49:39 +02:00
2023-06-30 09:13:07 +02:00
=== Documentation
2021-04-28 16:49:39 +02:00
* {link-with-uscores1}[Python documentation - ++__call__++ method]
2021-04-28 18:08:03 +02:00
2021-06-02 20:44:38 +02:00
2021-06-03 09:05:38 +02:00
ifdef::env-github,rspecator-view[]
2021-09-20 15:38:42 +02:00
'''
== Implementation Specification
(visible only on this page)
2023-05-25 14:18:12 +02:00
=== Message
Fix this call; XX is not callable.
=== Highlighting
Primary: The name before the opening parenthesis
* Secondary 1 (if the call is made on a variable)
** location: The last value assigned.
** message: "Assigned value."
* Secondary 2
** location: The class definition
** message: "Definition."
2021-09-20 15:38:42 +02:00
2021-06-08 15:52:13 +02:00
'''
2021-06-02 20:44:38 +02:00
== Comments And Links
(visible only on this page)
2023-05-25 14:18:12 +02:00
=== relates to: S2873
2021-06-03 09:05:38 +02:00
endif::env-github,rspecator-view[]