Máquinas de estado em Python

Fernando Macedo

@fgmacedo | fgmacedo@gmail.com

Agenda

• Case de máquina de estados real.
• Definições sobre máquina de estados.
• Sinais de que você precisa de uma.
• Exemplos.

Case: Integração com o novo sorter

Cenário:

• Alta disponibilidade.
• Baixa latência.

Case: Integração com o novo sorter

Máquinas de estados

Não é sobre: DFA, NFA, GNFA, Moore, Mealy, classificações...

Máquinas de estados

• Um objeto sempre está em apenas um dos possíveis estados, e existem transições mapeadas entre estes estados.

• A alteração de estado se dá em resposta a eventos externos.

• A resposta para um evento geralmente depende do tipo de evento e do estado interno do sistema, e pode implicar numa transição de estado.

Considere um semáforo:

• Cada um dos círculos é um estado;
• Cada seta é uma transição de estado possível;
• O nome associado com a seta representa um evento.

Eventos

• Ações que afetam o sistema, os gatilhos ou triggers.
• Podem conter parâmetros.

Um evento é algo que acontece que afeta o sistema. Pode conter parâmetros que qualificam o evento, como por exemplo um evento de "tecla pressionada", deve conter a informação da tecla associada.

Estados

• Representam um comportamento do sistema;
• Uma condição de execução, que simplifica a verificação das ações possíveis para uma única variável.

Um estado representa um comportamento do sistema, uma condição de execução que reduz o problema de identificar o contexto de execução do sistema para apenas uma única variável, a do próprio estado, ao invés de muitas variáveis, eliminando lógicas condicionais.

Para o domínio da sua aplicação, deve existir um conjunto finito de estados possíveis, daí o nome FSM (Finite State Machines).

Estados extendidos

Existe uma interpretação em que cada estado representa um conjunto distinto de valores válidos para todas as variáveis. A quantidade de estados seria como uma permutação de todos os valores possíveis para todas as variáveis. Esta interpretação é impraticável em um sistema pois gera uma infinidade de estados. Variáveis são normalmente desassociadas dos estados.

O estado representa um comportamento, e uma mudança numa variável nem sempre implica em mudança de comportamento.

Vencendo a barreira

• Por que são tão pouco utilizadas?
• Quantas vezes você já implementou uma solução baseada em máquina de estados?

Justificativas

• Não identificar o padrão.

• Objetos que evoluem ao longo do tempo.

• Existe o campo de estado, mas o controle é feito manualmente.

• A complexidade atual é suficiente para cobrir o esforço de portar?

• Curva de aprendizado para incorporar uma nova ferramenta.

Aplicações

• Sempre que existe mudança de comportamento quando um estado interno muda;
• É especialmente útil em sistemas orientados a eventos;
• Auxilia a descobrir casos de uso e comportamentos não previstos.

Identificando o padrão

Sintomas de que você pode precisar de uma máquina de estados:

• Ter um campo state ou status no seu modelo.

• Campos booleanos, como published, paid, started, finished.

• Campos de timestamp que permitem nulos, como published_at, paid_at.

• Quando existem muitas operações com verificações condicionais “protegendo” sua execução.

Implementações

hand made

• Padrão State (Gang of Four)
• Dicionário com o mapa das transições.

Implementações

transitions

• https://github.com/pytransitions/transitions
• Python 2.7+, 3.3+.
• Full featured with some extra bonus.

Implementações

automaton

• https://github.com/nazavode/automaton
• Python 3.4+.
• Minimalist.

Implementações

python-statemachine

• https://github.com/fgmacedo/python-statemachine
• Python 2.7+, 3.4+.
• Full featured.
• Disclaimer: Eu sou o autor.

from statemachine import StateMachine, State

class TrafficLightMachine(StateMachine):
    "A traffic light machine"
    green = State('Green', initial=True)
    yellow = State('Yellow')
    red = State('Red')

    slowdown = green.to(yellow)
    stop = yellow.to(red)
    go = red.to(green)

    def on_slowdown(self):
        print('Calma, lá!')

    def on_stop(self):
        print('Parou.')

    def on_go(self):
        print('Valendo!')

stm = TrafficLightMachine()

stm.slowdown()
stm.stop()
stm.go()

Calma, lá!
Parou.
Valendo!

stm.is_green

True

try:
    stm.stop()
except Exception as e:
    print(e, type(e))

Can't stop when in Green. <class 'statemachine.exceptions.TransitionNotAllowed'>

from statemachine import StateMachine, State

class TrafficLightMachine(StateMachine):
    "A traffic light machine"
    green = State('Green', initial=True)
    yellow = State('Yellow')
    red = State('Red')

    cycle = green.to(yellow) | yellow.to(red) | red.to(green)

    def on_enter_green(self):
        print('Valendo!')

    def on_enter_yellow(self):
        print('Calma, lá!')

    def on_enter_red(self):
        print('Parou.')

stm = TrafficLightMachine()

stm.cycle()
stm.cycle()
stm.cycle()

Calma, lá!
Parou.
Valendo!

Solucionando o problema do sorter

class PackageStateMachine(StateMachine):
    # States
    created = State('Criado', initial=True)
    scanned = State('Escaneado')
    measured = State('Medido')
    waiting_routing = State('Aguardando roteirização')
    routed = State('Roteirizado')
    dispatched = State('Expedido')
    rejected = State('Rejeitado')
    unfit = State('Fora do perfil')
    cancelled = State('Cancelado')

Definimos as transições e os eventos:

# transitions
    scan = (
        created.to(scanned, rejected) |
        rejected.to(scanned) |
        unfit.to(scanned, rejected)
    )
    measure = scanned.to(measured, unfit)
    sort = (
        measured.to(waiting_routing, rejected) |
        unfit.to(unfit) |
        rejected.to(unfit)
    )
    route = waiting_routing.to(routed)
    dispatch = routed.to(dispatched)
    status_changed = (
        created.to(created, cancelled) |
        dispatched.to(dispatched)
    )
    update = created.to(created) | rejected.to(rejected)

Obrigado!

Fernando Macedo

@fgmacedo | fgmacedo@gmail.com

Hey, estamos contratando!