rspec/rules/S5756/python/rule.adoc
Fred Tingaud 16f6c0aecf
Inline adoc when include has no additional value (#1940)
Inline adoc files when they are included exactly once.

Also fix language tags because this inlining gives us better information
on what language the code is written in.
2023-05-25 14:18:12 +02:00

76 lines
1.3 KiB
Plaintext

== Why is this an issue?
:link-with-uscores1: https://docs.python.org/3/reference/datamodel.html#object.__call__
In order to be callable, a python class should implement the {link-with-uscores1}[``++__call__++``] method.
This rule raises an issue when a non-callable object is called.
=== Noncompliant code example
[source,python]
----
class MyClass:
pass
myvar = MyClass()
myvar() # Noncompliant
none_var = None
none_var() # Noncompliant
----
=== Compliant solution
[source,python]
----
class MyClass:
def __call__(self):
print("called")
myvar = MyClass()
myvar()
----
:link-with-uscores1: https://docs.python.org/3/reference/datamodel.html#object.__call__
== Resources
* {link-with-uscores1}[Python documentation - ++__call__++ method]
ifdef::env-github,rspecator-view[]
'''
== Implementation Specification
(visible only on this page)
=== 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."
'''
== Comments And Links
(visible only on this page)
=== relates to: S2873
endif::env-github,rspecator-view[]