Django Utilidades :: Marinho Brandao

Versão 0.6 do Yadsel com suporte a Django

Depois de um longo período apenas mantendo a estabilidade da versão atual, tirei ontem o dia para concluir os ajustes necessários para a versão 0.6 do Yadsel, com foco quase que exclusivo em projetos construídos com Django.

Ocorre que antes disso, o Yadsel trabalhava somente com versões de forma linear, ou seja: uma classe, uma versão.

Isso permaneceu até a versão 0.4, quando implementei o recurso de Extensible Versions (versões extensíveis) e Partial Versions (versões parciais). Essa versão inaugurou a idéia de poder ter várias classes em uma só versão. Melhorou na organização dos arquivos de versões e possibilitou trabalhar várias aplicações compartilhando uma mesma versão.

Mas ainda assim, outro recurso era necessário para o uso cotidiano no Django. No Django, as aplicações são independentes umas das outras, e ainda assim, podem haver eventuais dependências. Isso cria a necessidade de suporte a múltiplas versões em um mesmo projeto, ou seja: cada aplicação, uma versão. Para isso foi necessário implementar o Version Space.

Version Space

O Version Space é um recurso novo do Yadsel que torna possível que cada "espaço" no controle de versões possua sua própria versão, histórico e log. No caso do Django, o version space traduz-se pelo nome da aplicação, em outros aplicações, o desenvolvedor pode implementar como bem quiser.

Em outras palavras: eu posso manter uma aplicação de newsletter em diversos projetos com evolução de versões independentes do restante, incluindo toda a parafernália de DDL e DML que o Yadsel suporta: Tabelas, Domínios, Triggers, Procedures, Views, etc.

Yadsel no Admin

No embalo do Version Space veio o suporte ao Admin. É simples, ao instalar a aplicação 'yadsel.drivers.django_app' em seu INSTALLED_APPS, seu Admin passará a exibir duas seções para visualizar logs e históricos da evolução do banco.

Yadsel pelo manage.py

O Yadsel implementa um novo comando ao manage.py: yadseltool. A lógica de funcionamento é a mesma da yadseltool independente, porém seguindo a sintaxe de comandos baseados aplicações do manage.py:

$ python manage.py help yadseltool
Usage: manage.py yadseltool [options] [appname ...]

Executes Yadsel database version control for the given app name(s).

Options:
  --settings=SETTINGS   The Python path to a settings module, e.g.
                        "myproject.settings.main". If this isn't provided, the
                        DJANGO_SETTINGS_MODULE environment variable will be
                        used.
  --pythonpath=PYTHONPATH
                        A directory to add to the Python path, e.g.
                        "/home/djangoprojects/myproject".
  --traceback           Print traceback on exception
  --action=ACTION       Action of evolution; up=upgrade, down=downgrade
  --from=FROM
  --to=TO
  --mode=MODE           Mode of output; hidden=messages are hidden, steps=step
                        by step, interactive=confirms actions, output=only
                        prints to output
  --test=TEST           Set test mode
  --history=HISTORY     Write history of versions
  --silent=SILENT       Keeps exception messages
  --log=LOG             Write a log of changes
  --version             show program's version number and exit
  -h, --help            show this help message and exit

Exemplo de chamada do yadseltool

$ python manage.py yadseltool minha_aplicacao

Mas como afinal utilizar o Yadsel em meu projeto Django?

Bom, primeiro é necessário baixar a versão 0.6 do Yadsel em sua máquina

http://yadsel.googlecode.com/files/yadsel-0.6-with-django-support.tar.gz

Feito o download, instale o Yadsel numa versão 2.4 ou superior do Python

$ python setup.py install

Em seu projeto, acrescente a seguinte aplicação à setting INSTALLED_APPS do arquivo settings.py

'yadsel.drivers.django_app'

Rode o syndcb

$ python manage.py syncdb

Serão criadas as duas tabelas necessárias para o histórico e log do Yadsel. Entenda que 'histórico' trata-se do controle das versões, é ele que sabe se sua aplicação está na versão X ou Y. O 'log' trata-se de cada comando SQL que é gerado e executado, assim como suas respectivas eventuais mensagens de erro.

Crie a seguinte estrutura de pastas em uma de suas aplicações:

minha_aplicacao/
minha_aplicacao/yadsel_versions/
minha_aplicacao/yadsel_versions/__init__.py
minha_aplicacao/yadsel_versions/versao1.py
minha_aplicacao/yadsel_versions/versao2.py
minha_aplicacao/yadsel_versions/versaoN.py

o arquivo __init__.py deve conter ou importar as classes de versões, que podem ser estruturadas como bem quiser, seja em módulos ou em pacotes.

O conteúdo provável do arquivo __init__.py será este:

from versao1 import *

E o do arquivo versao1.py (ou qualquer outro que contenha classes de versões) será provavelmente este:

from yadsel.core import *

class Version1(Version):
    version_number = 1

    def up(self):
        pass

    def down(self):
        pass

ou como este exemplo:

from yadsel.core import *

class MinhaVersao1(Version):
    version_number = 1

    def up(self):
        CreateTable('minha_tabela_nova',
            id = Integer(primary=True)
            name = Varchar(50, required=True),
        ).append_to(self)

        AlterTable('states',
            Add('percent', Decimal(15, 5, default=0)),
        ).append_to(self)

        ExecuteSQL("""
            Create or Alter Procedure sp_teste...
        """).append_to(self)

    def down(self):
        ExecuteSQL("""
            Drop Procedure sp_teste
        """).append_to(self)

        AlterTable('states',
            DropColumn('percent'),
        ).append_to(self)

        DropTable('minha_tabela_nova').append_to(self)

A minha sugestão é que se use o Yadsel no Django somente para manter a evolução, não para criar tabelas em si. Isso porque o Django o já cria as tabelas muito bem. O que ele não faz é o resto :D

Grupos de discussão do Yadsel

Fiz alguns ajustes no Yadsel [1] e incrementei a versão para 0.3:

Ajustado o suporte a DELETE, que estava falhando;
Ajustado o parsing das clausulas OR e NOT, que estavam funcionando como AND, também foi feita uma garantia de precedência de operadores / grupos de condições, através de parênteses;

Também criei os seguintes grupos de discussão:

yadsel-users [2]
yadsel-developers [3]

Links relacionados

[1]	http://code.google.com/p/yadsel

[2]	http://groups.google.com/group/yadsel-users

[3]	http://groups.google.com/group/yadsel-developers

Yadsel - Status

Bom, muita correria nos últimos dias. Pouco tempo para publicar qualquer coisa, mas o Yadsel, o Guia de Django e o Adorador.es estão vivos como nunca. Neste momento a prioridade é o Yadsel, por motivos de urgência em alguns aplicativos reais, em produção. O Guia segue caminhando para a conclusão e já com alguns contatos sobre publicação em curso. O Adorador.es também está de pé, esperando tempo hábil para atualização da versão 0.3. O Yadsel ainda está registrado como versão 0.1-unstable. Ainda que o nome impressione imaturidade, o software está caminhando para uma relativa maturidade, essencialmente sobre o driver de Firebird. Os drivers para MySQL e SQLite também foram melhorados e foi introduzido o driver para MSSQL (SQL Server). O foco é deixar toda a framework e core API maduras e partir daí para atacar os drivers em andamento, sempre preocupado com cases reais, nunca com teorias. A arquitetura está muito boa, minha impressão é de que superamos as espectativas, pois todas as manutenções necessárias até agora foram extremamente simples e claras, e o software está com uma performance também melhor que o esperado. Destaques das últimas tarefas efetuadas: yadseltool

para sistema operacional Windows, agora ofecere um executável standalone para poder ser embutido em aplicações sem necessidade da máquina virtual.
melhorado toda a forma de interpretar os argumentos, agora em forma de atribuição.
oferece agora 4 modos: hidden (persiste sem exibir mensagens), output (apenas escreve o script na tela, sem persistência), steps (persiste exibindo uma mensagem de progresso a cada etapa), interactive (confirma cada etapa antes de persistir - não implementado ainda)
agora suporta modo de teste - sem persistência
agora suporta controle do histórico embutido

HistoryControl

Recurso para embutir controle das atualizações. Antes este controle era feito externamente, pelo utilizador.

PartialVersions

Foi implementado o recurso de partial versions - conceito semelhante ao PartialClass, do Delphi - através do qual se pode quebrar uma só versão em várias classes e arquivos, juntando tudo numa Version só. Muito bom para situações de script completo ou grandes modificações.

ZipFile

O suporte a arquivos ZIP como repositório das versões foi liberado e será até mesmo recomendado, dado que é mais seguro e limpo.

DocTests

Alguns doctests foram criados para automatizar os testes de funcionalidades básicas:

PartialVersions
Persistencia
ZipFiles

GTKYadsel Uma ferramenta de manutenção de projetos foi criada para auxiliar o desenvolvedor e, num futuro ideal, tornar desnecessário o conhecimento de programação a quem for construir modelos de banco. Esta ferramenta trabalho no sentido de construir projetos e dar a ele uma ou mais conexões, ao qual também se pode adicionar versões e editar em um editor com highlight de sintaxe. Evidentemente, funciona melhor no Linux, mas a screenshot abaixo, tirada sob o Windows, demosntra que ele pode ser eficaz em qualquer ambiente. Ainda não está bom o suficiente para recomendar o uso, mas eu já o uso normalmente.

FullVersionBuilder Por fim, este também é um recurso cada vez mais estável. A versão completa de um dos casos reais onde o Yadsel é utilizado foi toda gerada a partir deste, com pequenos ajustes posteriores relacionados a valores DateTime. Conclusão Como podem ver, o Yadsel caminhou a passos largos. O tempo disponível não é grande, é realmente curto, mas está indo muito bem. Espero soltar a versão 0.2-stable rapidamente, ainda esta semana provavelmente. Boa sorte para todos nós!

DBMigrations será YADSEL

O project DBMigrations terá o nome definitivo de "yadsel", sigla de "Yet Another Database Schema Evolution Library". O motivo para eu tomar esta decisão se deve ao fato de que o nome antigo era provisório e também porque descobri que já existia um projeto com o mesmo nome.

DBMigrations

Publiquei a seguinte mensagem nas listas python-brasil e django-brasil:

Saudações!

senhores, como eu havia comentado há uns dias atrás, estive
trabalhando em um "migrations" para um projeto em Django e outro em
Delphi.

criei então o DBMigrations (ainda não tive idéia para um nome melhor),
que é basicamente uma ferramenta que pode ser usada como executável ou
como modulo de um software em Python, para controle de evolução de
bancos de dados, sob a LGPL, e independente de ORMs e SGBDs e que
possa ser útil para projetos feitos em outras linguagens.

a notação é mais ou menos semelhante ao Active Record Migrations, do Rails.

ele fornece um grupo de classes (uma espécie de API), que é
interpretada por um driver (por enquanto somente o MySQL está
implementado, os proximos serão o Firebird e o SQLite), e este driver
aplica as especificidades de cada SGBD.

da forma como ficou estruturado, ele permite que sejam criados drivers
para ORMs, como Django, SQLAlchemy ou SQLite, etc.

a primeira versão (0.1) ainda não foi devidamente testada, pois irei
utiliza-la oficialmente amanhã, numa virada de versão. E ainda não
suporta stored procs, triggers, views, sequences ou indices (este
ultimo não concluído).

o repositório do projeto é:

http://code.google.com/p/dbmigrations/

quem gostar da idéia e tiver interesse em participar, principalmente
criando drivers, será bem-vindo :)

espero que seja útil.