Функція classmethod() в Python

Функція classmethod() повертає метод класу для вказаної функції.

Наприклад:

class Student:
  marks = 0

  def compute_marks(self, obtained_marks):
    marks = obtained_marks
    print('Obtained Marks:', marks)

# Конвертуємо compute_marks() в метод класу
Student.print_marks = classmethod(Student.compute_marks)
Student.print_marks(88)

class Student:

marks = 0

def compute_marks(self, obtained_marks):

marks = obtained_marks

print('Obtained Marks:', marks)

# Конвертуємо compute_marks() в метод класу

Student.print_marks = classmethod(Student.compute_marks)

Student.print_marks(88)

Результат:

Obtained Marks: 88

Синтаксис функції classmethod()

classmethod(function)

1	classmethod(function)

У новіших версіях Python ви можете використовувати декоратор @classmethod для визначення методу класу. Наприклад:

@classmethod
def func(cls, args...)

1 2	@classmethod def func(cls, args...)

Параметри функції classmethod()

Функція classmethod() приймає один параметр:

function — функція, яку необхідно перетворити на метод класу.

Значення, яке повертає функція classmethod()

Функція classmethod() повертає метод класу для вказаної функції.

Що таке метод класу?

Метод класу — це метод, який прив’язаний до класу, а не до його об’єкта. Він не вимагає створення екземпляра класу, як і статичний метод.

Різниця між статичним методом та методом класу полягає в наступному:

статичні методи нічого не знають про клас і просто працюють із параметрами;

метод класу працює із класом, оскільки його параметром завжди є сам клас.

Метод класу може викликатися як самим класом, і його об’єктом:

Class.classmethod()

1	Class.classmethod()

або

Class().classmethod()

1	Class().classmethod()

Але попри все, перший аргумент методу класу завжди прив’язаний як сам клас cls:

def classMethod(cls, args...)

1	def classMethod(cls, args...)

Приклад №1: Створення методу класу за допомогою функції classmethod()

class Person:
    age = 25

    def printAge(cls):
        print('The age is:', cls.age)

# Створюємо метод класу printAge()
Person.printAge = classmethod(Person.printAge)

Person.printAge()

class Person:

age = 25

def printAge(cls):

print('The age is:', cls.age)

# Створюємо метод класу printAge()

Person.printAge = classmethod(Person.printAge)

Person.printAge()

Результат:

The age is: 25

Тут у нас є клас Person, який має змінну-член age, якій присвоєно значення 25. Ми також маємо метод printAge(), який приймає один параметр cls.

Параметр cls приймає в якості аргументу клас Person, а не об’єкт класу Person. Потім ми передаємо метод Person.printAge як аргумент у функцію classmethod(). Це конвертує даний метод у метод класу, щоб він приймав перший параметр як клас (тобто Person).

В останньому рядку ми викликаємо printAge() без створення об’єкта Person, як це робиться зі статичними методами. Це виводить змінну age.

Коли слід використовувати метод класу?

1. Фабричні методи

Фабричні методи — це методи, які повертають об’єкт класу (наприклад, конструктор) для різних варіантів використання. Це схоже на перевантаження функцій у С++. Оскільки в Python нічого такого немає, то використовуються методи класу та статичні методи.

Приклад №2: Створення фабричного методу з використанням методу класу

from datetime import date

# Випадковий Person
class Person:
    def __init__(self, name, age):
        self.name = name
        self.age = age

    @classmethod
    def fromBirthYear(cls, name, birthYear):
        return cls(name, date.today().year - birthYear)

    def display(self):
        print(self.name + "'s age is: " + str(self.age))

person = Person('Adam', 19)
person.display()

person1 = Person.fromBirthYear('John',  1985)
person1.display()

from datetime import date

# Випадковий Person

class Person:

def __init__(self, name, age):

self.name = name

self.age = age

@classmethod

def fromBirthYear(cls, name, birthYear):

return cls(name, date.today().year - birthYear)

def display(self):

print(self.name + "'s age is: " + str(self.age))

person = Person('Adam', 19)

person.display()

person1 = Person.fromBirthYear('John', 1985)

person1.display()

Результат:

Adam's age is: 19
John's age is: 31

Тут об’єкт створюють:

Конструктор, який приймає звичайні параметри name та age.

Метод fromBirthYear(), який в якості першого параметра cls приймає клас Person (не об’єкт класу Person) і повертає конструктор, викликаючи cls(name, date.today().year - birthYear), що еквівалентно Person(name, date.today().year - birthYear).

Перед методом fromBirthYear() ми бачимо @classmethod. Це декоратор для перетворення fromBirthYear() в метод класу.

2. Правильне створення об’єкта у наслідуванні

Щоразу, коли ми отримуємо похідний клас шляхом реалізації фабричного методу як методу класу, це гарантує правильне створення об’єкта похідного класу.

Ми можемо створити статичний метод для вищенаведеного прикладу, але створюваний ним об’єкт завжди буде запрограмований як базовий клас.

Але коли ми використовуємо метод класу, він створює правильний екземпляр похідного класу.

Приклад №3: Як працює метод класу в наслідуванні?

from datetime import date

# Випадковий Person
class Person:
    def __init__(self, name, age):
        self.name = name
        self.age = age

    @staticmethod
    def fromFathersAge(name, fatherAge, fatherPersonAgeDiff):
        return Person(name, date.today().year - fatherAge + fatherPersonAgeDiff)

    @classmethod
    def fromBirthYear(cls, name, birthYear):
        return cls(name, date.today().year - birthYear)

    def display(self):
        print(self.name + "'s age is: " + str(self.age))

class Man(Person):
    sex = 'Male'

man = Man.fromBirthYear('John', 1985)
print(isinstance(man, Man))

man1 = Man.fromFathersAge('John', 1965, 20)
print(isinstance(man1, Man))

from datetime import date

# Випадковий Person

class Person:

def __init__(self, name, age):

self.name = name

self.age = age

@staticmethod

def fromFathersAge(name, fatherAge, fatherPersonAgeDiff):

return Person(name, date.today().year - fatherAge + fatherPersonAgeDiff)

@classmethod

def fromBirthYear(cls, name, birthYear):

return cls(name, date.today().year - birthYear)

def display(self):

print(self.name + "'s age is: " + str(self.age))

class Man(Person):

sex = 'Male'

man = Man.fromBirthYear('John', 1985)

print(isinstance(man, Man))

man1 = Man.fromFathersAge('John', 1965, 20)

print(isinstance(man1, Man))

Результат:

True
False

Тут використання статичного методу створення екземпляра класу вимагає, щоб ми запрограмували тип екземпляра під час створення. Це явно викликає проблему під час успадкування Man від Person.

Метод fromFathersAge() повертає не об’єкт Man, а об’єкт Person його базового класу. Це порушує парадигму ООП. Використання методу класу fromBirthYear() може забезпечити ООП-орієнтованість коду, оскільки він приймає в якості першого параметру сам клас і викликає його фабричний метод.

Оцінити статтю: