rspec/rules/S2325/python/rule.adoc

33 lines
834 B
Plaintext
Raw Normal View History

2020-06-30 12:48:07 +02:00
Class methods that don't access instance data can and should be static because they yield more performant code.
2020-12-23 14:59:06 +01:00
To implement a static method in Python one should use either ``@classmethod`` or ``@staticmethod``. A class method receives the class as implicit first argument, just like an instance method receives the instance. A static method does not receive an implicit first argument.
2020-06-30 12:48:07 +02:00
== Noncompliant Code Example
----
class Utilities:
def do_the_thing(self, arg1, arg2, ...): # Noncompliant
#...
----
== Compliant Solution
----
class Utilities:
@classmethod
def do_the_thing(cls, arg1, arg2, ...):
#...
----
or
2020-06-30 12:48:07 +02:00
----
class Utilities:
@staticmethod
def do_the_thing(arg1, arg2, ...):
#...
----
== Exceptions
2020-12-23 14:59:06 +01:00
Methods which raise or may raise a ``NotImplementedError`` are ignored.