Абстрактні атрибути в Python [дублікат]

Який найкоротший / найелегантніший спосіб реалізації наступного коду Scala з абстрактним атрибутом у Python?

abstract class Controller {

    val path: String

}

Для Controllerвизначення "шляху" компілятором Scala примусово застосовується підклас . Підклас буде виглядати так:

class MyController extends Controller {

    override val path = "/home"

}

Python має вбудований виняток для цього, хоча ви не зустрінете виняток до часу виконання.

class Base(object):
    @property
    def path(self):
        raise NotImplementedError


class SubClass(Base):
    path = 'blah'

Python 3.3+

from abc import ABCMeta, abstractmethod


class A(metaclass=ABCMeta):
    def __init__(self):
        # ...
        pass

    @property
    @abstractmethod
    def a(self):
        pass

    @abstractmethod
    def b(self):
        pass


class B(A):
    a = 1

    def b(self):
        pass

Помилка декларування aабо bу похідному класі Bспричиняє TypeErrorтаке:

TypeError: Не вдається створити екземпляр абстрактного класу Bабстрактними методамиa

Python 2.7

Для цього існує декоратор @abstractproperty :

from abc import ABCMeta, abstractmethod, abstractproperty


class A:
    __metaclass__ = ABCMeta

    def __init__(self):
        # ...
        pass

    @abstractproperty
    def a(self):
        pass

    @abstractmethod
    def b(self):
        pass


class B(A):
    a = 1

    def b(self):
        pass

Оскільки це питання було спочатку задане, python змінив спосіб реалізації абстрактних класів. Я використав дещо інший підхід, використовуючи формалізм abc.ABC у python 3.6. Тут я визначаю константу як властивість, яка повинна бути визначена у кожному підкласі.

from abc import ABC, abstractmethod


class Base(ABC):

    @property
    @classmethod
    @abstractmethod
    def CONSTANT(cls):
        return NotImplementedError

    def print_constant(self):
        print(type(self).CONSTANT)


class Derived(Base):
    CONSTANT = 42

Це змушує похідний клас визначати константу, інакше TypeErrorвиникне виняток при спробі створити екземпляр підкласу. Коли ви хочете використовувати константу для будь-якої функціональності, реалізованої в абстрактному класі, ви повинні отримати доступ до константи підкласу type(self).CONSTANTзамість просто CONSTANT, оскільки значення не визначено в базовому класі.

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

Попередні відповіді торкалися корисних моментів, але я вважаю, що прийнята відповідь не відповідає безпосередньо на питання, тому що

• Питання вимагає реалізації в абстрактному класі, але прийнята відповідь не відповідає абстрактному формалізму.
• Питання ставить питання про те, що імплементація виконується. Я міг би стверджувати, що примусове застосування є жорсткішим у цій відповіді, оскільки воно спричиняє помилку виконання, коли підклас створюється за допомогою екземпляра, якщо CONSTANTвін не визначений. Прийнята відповідь дозволяє створити екземпляр об'єкта і видає помилку лише при CONSTANTдоступі, роблячи застосування менш жорстким.

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

У Python 3.6+ ви можете анотувати атрибут абстрактного класу (або будь-якої змінної), не надаючи значення для цього атрибута.

class Controller:
    path: str

class MyController(Controller):
    path = "/home"

Це робить дуже чистий код, де очевидно, що атрибут є абстрактним. Код, який намагається отримати доступ до атрибута, якщо, якщо він не був перезаписаний, піднімає AttributeError.

Ви можете створити атрибут у абстрактному базовому класі abc.ABC зі значенням, таким NotImplementedчином, що якщо атрибут не замінено, а потім використаний, під час виконання відображається помилка.

Наступний код використовує підказку типу PEP 484, щоб допомогти PyCharm правильно статично аналізувати тип pathатрибута.

import abc


class Controller(abc.ABC):
    path: str = NotImplemented

class MyController(Controller):
    path = "/home"

Для Python 3.3 + є елегантне рішення

from abc import ABC, abstractmethod

class BaseController(ABC):
    @property
    @abstractmethod
    def path(self) -> str:
        ...

class Controller(BaseController):
    path = "/home"


# Instead of an elipsis, you can add a docstring,
# This approach provides more clarity
class AnotherBaseController(ABC):
    @property
    @abstractmethod
    def path(self) -> str:
    """
    :return: the url path of this controller
    """

Чим він відрізняється від інших відповідей:

1. ...в абстрактному методі тіло переважніше, ніж pass. На відміну від pass, ...передбачає відсутність операцій , де passлише означає відсутність фактичної реалізації

2. ...рекомендується більше, ніж метання NotImplementedError(...). Це автоматично викликає надзвичайно багатослівну помилку, якщо реалізація абстрактного поля відсутня в підкласі. На відміну від цього, NotImplementedErrorсам по собі не говорить, чому реалізація відсутня. Більше того, для його фактичного підвищення потрібна ручна праця.

Починаючи з Python 3.6, ви можете використовувати __init_subclass__для перевірки змінних класу дочірнього класу при ініціалізації:

from abc import ABC

class A(ABC):
    @classmethod
    def __init_subclass__(cls):
        required_class_variables = [
            "foo",
            "bar"
        ]
        for var in required_class_variables:
            if not hasattr(cls, var):
                raise NotImplementedError(
                    f'Class {cls} lacks required `{var}` class attribute'
                )

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

Ваш базовий клас може реалізувати __new__метод, який перевіряє атрибут класу:

class Controller(object):
    def __new__(cls, *args, **kargs):
        if not hasattr(cls,'path'): 
            raise NotImplementedError("'Controller' subclasses should have a 'path' attribute")
        return object.__new__(cls)

class C1(Controller):
    path = 42

class C2(Controller):
    pass


c1 = C1() 
# ok

c2 = C2()  
# NotImplementedError: 'Controller' subclasses should have a 'path' attribute

Таким чином помилка виникає під час створення

Реалізація Python3.6 може виглядати так:

In [20]: class X:
    ...:     def __init_subclass__(cls):
    ...:         if not hasattr(cls, 'required'):
    ...:             raise NotImplementedError

In [21]: class Y(X):
    ...:     required = 5
    ...:     

In [22]: Y()
Out[22]: <__main__.Y at 0x7f08408c9a20>

Я трохи змінив відповідь @James , щоб усі ці декоратори не займали так багато місця. Якщо у вас було кілька таких абстрактних властивостей для визначення, це зручно:

from abc import ABC, abstractmethod

def abstractproperty(func):
   return property(classmethod(abstractmethod(func)))

class Base(ABC):

    @abstractproperty
    def CONSTANT(cls): ...

    def print_constant(self):
        print(type(self).CONSTANT)


class Derived(Base):
    CONSTANT = 42

class BadDerived(Base):
    BAD_CONSTANT = 42

Derived()       # -> Fine
BadDerived()    # -> Error

Погляньте на модуль abc (Abtract Base Class): http://docs.python.org/library/abc.html

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

У відповіді Бастієна Леонарда згадується абстрактний модуль базового класу, а у відповіді Брендана Абеля йдеться про нереалізовані атрибути, що викликають помилки. Щоб гарантувати, що клас не реалізований за межами модуля, ви можете до префікса базового імені наголосити символом підкреслення, який позначає його як приватний для модуля (тобто він не імпортується).

тобто

class _Controller(object):
    path = '' # There are better ways to declare attributes - see other answers

class MyController(_Controller):
    path = '/Home'

class AbstractStuff:
    @property
    @abc.abstractmethod
    def some_property(self):
        pass

Станом на 3.3 abc.abstractpropertyзастарілий, я думаю.