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

Наявність такого простого класу Python, як цей:

class Spam(object):
    __init__(self, description, value):
        self.description = description
        self.value = value

Я хотів би перевірити наступні обмеження:

• "опис не може бути порожнім"
• "значення має бути більше нуля"

Чи слід мені:
1. перевіряти дані перед створенням об’єкта спаму?
2. перевірити дані про __init__метод?
3. створити is_validметод у класі Spam і викликати його за допомогою spam.isValid ()?
4. створити is_validстатичний метод для класу спаму і викликати його за допомогою Spam.isValid (опис, значення)?
5. перевірити дані про декларацію установників?
6. тощо

Чи можете ви порекомендувати добре розроблений / пітонічний / не багатослівний (у класі з багатьма атрибутами) / елегантний підхід?

Ви можете використовувати властивості Python, щоб чітко застосовувати правила до кожного поля окремо та застосовувати їх, навіть коли клієнтський код намагається змінити поле:

class Spam(object):
    def __init__(self, description, value):
        self.description = description
        self.value = value

    @property
    def description(self):
        return self._description

    @description.setter
    def description(self, d):
        if not d: raise Exception("description cannot be empty")
        self._description = d

    @property
    def value(self):
        return self._value

    @value.setter
    def value(self, v):
        if not (v > 0): raise Exception("value must be greater than zero")
        self._value = v

Виняток буде створено при будь-якій спробі порушення правил, навіть у __init__функції, і в цьому випадку побудова об'єкта не вдасться.

ОНОВЛЕННЯ: Десь між 2010 роком і зараз я дізнався про operator.attrgetter:

import operator

class Spam(object):
    def __init__(self, description, value):
        self.description = description
        self.value = value

    description = property(operator.attrgetter('_description'))

    @description.setter
    def description(self, d):
        if not d: raise Exception("description cannot be empty")
        self._description = d

    value = property(operator.attrgetter('_value'))

    @value.setter
    def value(self, v):
        if not (v > 0): raise Exception("value must be greater than zero")
        self._value = v

Якщо ви хочете перевірити значення лише тоді, коли об'єкт створений І передача недійсних значень вважається помилкою програмування, тоді я б використав твердження:

class Spam(object):
    def __init__(self, description, value):
        assert description != ""
        assert value > 0
        self.description = description
        self.value = value

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

Якщо ви не захоплені своїми руками, ви можете просто використовувати formencode . Він справді сяє багатьма атрибутами та схемами (лише схемами підкласів) і має багато вбудованих корисних валідаторів. Як бачите, це підхід "перевірити дані перед створенням об'єкта спаму".

from formencode import Schema, validators

class SpamSchema(Schema):
    description = validators.String(not_empty=True)
    value = validators.Int(min=0)

class Spam(object):
    def __init__(self, description, value):
        self.description = description
        self.value = value

## how you actually validate depends on your application
def validate_input( cls, schema, **input):
    data = schema.to_python(input) # validate `input` dict with the schema
    return cls(**data) # it validated here, else there was an exception

# returns a Spam object
validate_input( Spam, SpamSchema, description='this works', value=5) 

# raises an exception with all the invalid fields
validate_input( Spam, SpamSchema, description='', value=-1) 

Ви можете робити перевірки під час __init__(і зробити їх повністю прозорими за допомогою дескрипторів | декораторів | метакласу), але я не дуже шанувальник цього. Мені подобається чистий бар'єр між введенням користувача та внутрішніми об'єктами.

якщо ви хочете перевірити лише ті значення, які передані конструктору, ви можете зробити:

class Spam(object):
    def __init__(self, description, value):
        if not description or value <=0:
            raise ValueError
        self.description = description
        self.value = value

Звичайно, це нікому не завадить зробити щось подібне:

>>> s = Spam('s', 5)
>>> s.value = 0
>>> s.value
0

Отже, правильний підхід залежить від того, що ви намагаєтесь досягти.

Ви можете спробувати pyfields:

from pyfields import field

class Spam(object):
    description = field(validators={"description can not be empty": lambda s: len(s) > 0})
    value = field(validators={"value must be greater than zero": lambda x: x > 0})

s = Spam()
s.description = "hello"
s.description = ""  # <-- raises error, see below

Це дає врожай

ValidationError[ValueError]: Error validating [<...>.Spam.description=''].
  InvalidValue: description can not be empty. 
  Function [<lambda>] returned [False] for value ''.

Він сумісний з python 2 і 3.5 (на відміну від pydantic), і перевірка відбувається кожного разу, коли значення змінюється (не лише вперше, на відміну від attrs). Він може створити конструктор для вас, але не робить це за замовчуванням, як показано вище.

Зверніть увагу, що, можливо, ви захочете використовувати mini-lambdaзамість простих старих лямбда-функцій, якщо ви хочете, щоб повідомлення про помилки були ще простішими (вони відображатимуть вираз, що не працює).

Дивіться pyfieldsдокументацію для деталей (я, до речі, автор;))