python-dbc (epydoc-based Design-by-Contract validator)

Alex Myodov <[email protected]> Tue, 09 Nov 2010 16:09:48 +0300
Newsgroups gmane.comp.python.documentation
Message-ID <[email protected]>
Hello,

I would like to notify the community about the availability of new 
python-dbc module, allowing one to perform basic design-by-contract 
checks using the docstring definitions in epydoc format. No public 
releases has been done yet, but the home page with overall instructions 
is created at http://python-dbc.googlecode.com/ and the code is 
available at https://python-dbc.googlecode.com/hg/ (this is a Mercurial 
repository, use hg clone).

At the moment, the primary functionality available is the validation of 
@precondition/@postcondition/@type/@rtype docstring fields in every 
function wrapped using @contract_epydoc decorator. The code is early, 
lacks a proper amount of unit tests and documentation, and definitely 
may have bugs for now, but it is stress-tested at the moment in internal 
projects, so far so good. The future plans include allowing to use the 
@contract_epydoc decorator to wrap the classes, thus making possible to 
add the support of @invariant fields in the class docstrings.

-- 
With best regards,
	Alexander Myodov
email: [email protected] <mailto:[email protected]>
My LinkedIn page <http://ru.linkedin.com/in/amyodov>,^en MoiKrug page 
<http://honeyman.moikrug.ru/>,^ru LiveJournal blog 
<http://honeyman.livejournal.com/>^ru

_______________________________________________
Doc-SIG maillist  -  [email protected]
http://mail.python.org/mailman/listinfo/doc-sig