Перейти до основного вмісту

Python і ланцюгова реакція і ... дескриптори

Хочу поділитись своїми думками з приводу одного прикольного стилю програмування класів - ланцюгові виклики. Для когось це буде не новим, комусь, може, не подобається, але я вважаю, що такому стилю можна знайти застосування, при цьому код програми буде виглядати більш зрозумілим і логічним.

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

Проста задачка

Розглянемо реалізацію простого класу, назвемо його "тупий охоронець". Уявимо собі, що ми робимо комп'ютерну гру. У нас є замок, а біля воріт патрулює охоронець: ходить туди-сюди, більше нічого не робить. Код на Python 3.1:

class StupidGuard:
    """
    Stupid guard that moves around given route (way points).
    """
    direction = 0
    position = {'x': 0, 'y': 0}

    def go(self, steps):
        self.position['x'] += steps * cos(radians(self.direction))
        self.position['y'] += steps * sin(radians(self.direction))

    def rotate(self, angle):
        self.direction += angle

    def __repr__(self):
        return 'Guard: %s' % self.position

Код і математика дуже прості і, думаю, роз'яснень не вимагається. Отже, охоронець у нас є, давайте примусимо його патрулювати:

guard = StupidGuard()
print (guard)
guard.go(5)
guard.rotate(180)
guard.go(5)
guard.rotate(180)
print(guard)


Ось, що нам каже Python про стан нашої людини на початку і в кінці шляху:

Guard: {'y': 0, 'x': 0}
Guard: {'y': 6.123233995736766e-16, 'x': 0.0}

Отже, задачка виконана - охоронець ходить. Тільки довго якось ходить - 4 рядки коду. А хочеться, щоб він ходив не 4 рядки коду, а, наприклад, одну :)

Ланцюгові виклики

Це, в принципі, і є той простий спосіб - ланцюгові виклики методів. Суть в тому, що наведений код переписати так:

guard.go(5).rotate(180).go(5).rotate(180)

Неважко здогадатись, що для цього потрібно всього навсього зробити так, що методи go і rotate повертали self, а не None, як зараз. Тобто ці методи перетворюються в такі:

def go(self, steps):
    self.position['x'] += steps * cos(radians(self.direction))
    self.position['y'] += steps * sin(radians(self.direction))
    return self

def rotate(self, angle):
    self.direction += angle
    return self

Працює? Прекрасно працює. Але такий спосіб мені здався недостатньо гламурним і я вирішив зробити декоратор, назвемо його Chained, щоб кожен раз не повертати self. Звісно, цей код не скорочує, але виразність такого коду набагато вища, ніж return True. Декоратор-декоратором, а просто декоратором обійтись не вийде. Оскільки декоратор методу повинен мати доступ до экземпляра класу, - доводиться писати дескриптор.

Пишемо дескриптор

Отже, дескриптор для цієї задачі досить простий і невеликий:

class Chained:
    """
    Descriptor makes method to always return its owner class instance
    """

    def __init__(self, method):
         self.method = method
    
    def __get__(self, instance, owner):  
        def wrapper(*args, **kwargs):
            self.method(instance, *args, **kwargs)
            return instance
        return wrapper

Все, що він робить - огортає метод екземпляра в функцію, яка передає початковий код на виконання, але повертає екземляр класу, метод якого мы декоруємо. Відповідно, зміниться код нашого охоронця:

class StupidGuard:
    """
    Stupid guard that moves around given route (way points).
    """
    direction = 0
    position = {'x': 0, 'y': 0}

    @Chained
    def go(self, steps):
        self.position['x'] += steps * cos(radians(self.direction))
        self.position['y'] += steps * sin(radians(self.direction))

    @Chained      
    def rotate(self, angle):
        self.direction += angle

    def __repr__(self):
        return 'Guard: %s' % self.position

Тепер ми з легкістю можемо примусити його ходити вже двомя способами:

guard = StupidGuard()
print (guard)
guard.go(5)
guard.rotate(180)
guard.go(5)
guard.rotate(180)
print(guard)
guard.go(5).rotate(180).go(5).rotate(180)
print(guard)

Ось що інтерпретатор повідомляє про стан об'єкта:

Guard: {'y': 0, 'x': 0}
Guard: {'y': 6.123233995736766e-16, 'x': 0.0}
Guard: {'y': 1.224646799147353e-15, 'x': 0.0}

Ну ось і все

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

Коментарі

  1. > Декоратор-декоратором, а просто декоратором обойтись нельзя. Так как декоратор метода должен иметь доступ к экземпляру класса

    https://gist.github.com/eaca7df99f27cb643a6f

    ВідповістиВидалити
  2. @bsdemon
    Спасибо. С дескриптором переколдовал :)

    ВідповістиВидалити
  3. Rostislav, zdravstvuyte, ne mogu nayti vash kontakt - tel/e-mail . Proshu vas nabrat' +380632379995.
    Ivan

    ВідповістиВидалити

Дописати коментар

Популярні дописи з цього блогу

Регулярні вирази в Python: вивчення та оптимізація

Writing a regular expression is more than a skill -- it's an art. Jeffrey Friedl Що це таке? Рано чи піздно майже кожному програмісту в своєму житті доводиться стикатись з регулярними виразами. Термін "Регулярні вирази" є перекладом з англійської словосполучення "Regular expressions" і не є зовсім точним, а для тих, хто перший раз почув цей термін, мабуть, навіть спантеличуючим (я, наприклад, коли вперше почув, ніяк не міг собі второпати по назві, хоча б приблизно, що це, і для чого використовується). Літературний і більш осмислений переклад звучав би, мабуть, як "шаблонні вирази". Але назва вже прижилась, а скажете "шаблонні вирази" - вас просто не зрозуміють :). Звідси: Регулярний вираз -  це рядок, що задає шаблон пошуку під-рядків в рядку. Регулярні вирази використовуються для аналізу текстів на предмет відповідності текстової інформації деякому шаблону. Наприклад , шаблон, що задає слово, яке містить букву "к". Де застосовують

Python: як програмно перемкнути розкладку клавіатури в Windows

Дослідивши дане питання, я побачив, що Python не має засобів "з коробки" для вирішення цієї задачі. Відвоідно, задача повинна вирішуватись для каждої ОС своїм шляхом. Дане рішення було знайдено мною для ОС Windows XP +. Панацея - Win API Для того, щоб виконати завдання необхідно встановити додатково бібліотеку pywin32 , яка надає доступ до функцій Windows API з Python. З цієї бібліотеки нам знадобиться модуль win32api . >>> import win32api Дослідивши його вміст, можна побачити, що для роботы з розкладкою клавіатури є декілька функцій і одне системне повідомлення Windows - WM_INPUTLANGCHANGE : GetKeyboardLayout GetKeyboardLayoutList LoadKeyboardLayout В даному випадку для нас важлива саме остання функція - LoadKeyboardLayout . Дана функція завантажує нову розкладку (якщо вона ще не завантажена) і виконує після цього ще якісь дії; приймає в якості аргументів два: рядок з ідентифікатором розкладки. дію. Більш детально про їхні можливі значення можна почитати в MSDN . О

wxPython: Gif-анімація і прозорість

Коротко про анімацію в wxPython Дядечко робить анімацію на wxPython В wxPython засоби для роботи з анімацією - це пакет wx.animate . Пакет досить нехитрий - всього декілька класів, з яких частіше за все в роботі використовуються 2: wx.animate.Animation - інкапсулює параметри анімації, а також підтримує завантаження анімації з файлу. Підтримує Gif і Ani   формати анімацій. wx.animate.GifAnimationCtrl - Контрол для рендера і Gif-анімації в графічному інтерфейсі додатку. Останній - дуже класний засіб, оскільки дозволяє фактично в декілька рядків додати в вікно готовуу анімацію: ag_fname = r"progress.gif" ag = wx.animate.GIFAnimationCtrl(self, -1, ag_fname, pos=(0, 0), size=(64,64)) ag.GetPlayer().UseBackgroundColour(True) ag.Play() Досить непогано. І навіть більше ... прозорість. Прозрачность Третій рядок наведеного коду натякає нам, що анімація буде використовувати замість кольору, який в ній встановлений прозорим - фоновий колір вікна. Кажуть, що на GTK воно так і