~bzr-pqm/bzr/bzr.dev

:Version: Validate 0.3.2

:Date: 2008/02/24

.. _BSD License: http://www.voidspace.org.uk/python/license.shtml

.. sectnum::

 

to validate information from different sources via a single consistent

Validate was primarily written to support ConfigObj_, but is designed to be 

 

The current version is **0.3.2**, dated 24th February 2008. 

 

  version and download links.

 

*configobj.zip* contains `this document`_.

.. _configobj.zip: http://www.voidspace.org.uk/cgi-bin/voidspace/downman.py?file=configobj-4.5.2.zip

.. _Subversion Repository: http://svn.pythonutils.python-hosting.com/trunk/pythonutils/

:'boolean': matches boolean values: ``True`` or ``False``.

            Acceptable string values for True are : ::

         specify min and max sizes of the list. The list checks always 

         return a list.

         

:'tuple': matches any list. This check returns a tuple rather than a list.

                   int, str, boolean, float, ip_addr

    newval1 = vtor.check('integer', value1)

    newval2 = vtor.check('boolean', value2)

 

 

``vtor.functions`` is just a dictionary that maps names to functions, so we

 

 

 

    assert vtor.check(check1, '', missing=True) == 50

    assert vtor.check(check2, '', missing=True) == "val 1"

 

.. note:: 

 

    As of version 0.3.0, if you specify ``default='None'`` (note the quote marks

    around ``None``) then it will be interpreted as the string ``'None'``.

 

 

List Values

~~~~~~~~~~~

 

It's possible that you would like your default value to be a list. It's even

possible that you will write your own check functions - and would like to pass

them keyword arguments as lists from within the check.

 

To avoid confusing syntax with commas and quotes you use a list constructor to

specify that keyword arguments are lists. This includes the ``default`` value.

This makes checks look something like : ::

 

    checkname(default=list('val1', 'val2', 'val3'))

 

 

get_default_value

-----------------

 

``Validator`` instances have a ``get_default_value`` method. It takes a ``check`` string 

(the same string you would pass to the ``check`` method) and returns the default value,

converted to the right type. If the check doesn't define a default value then this method

raises a ``KeyError``.

 

If the ``check`` has been seen before then it will have been parsed and cached already, 

so this method is not expensive to call (however the conversion is done each time).

 

 

 

 

 

 

Known Issues

============

 

The following parses and then blows up. The resulting error message

is confusing:

 

    ``checkname(default=list(1, 2, 3, 4)``

    

This is because it parses as: ``checkname(default="list(1", 2, 3, 4)``.

That isn't actually unreasonable, but the error message won't help you

work out what has happened.

    

 

* A timestamp check function ? (Using the ``parse`` function from ``DateUtil`` perhaps).

 

 

2008/02/24 - Version 0.3.2

--------------------------

 

BUGFIX: Handling of None as default value fixed.

 

 

2008/02/05 - Version 0.3.1

--------------------------

 

BUGFIX: Unicode checks no longer broken.

 

 

2008/02/05 - Version 0.3.0

--------------------------

 

Improved performance with a parse cache.

 

New ``get_default_value`` method. Given a check it returns the default

value (converted to the correct type) or raises a ``KeyError`` if the

check doesn't specify a default.

 

Added 'tuple' check and corresponding 'is_tuple' function (which always returns a tuple).

 

BUGFIX: A quoted 'None' as a default value is no longer treated as None,

but as the string 'None'.

 

BUGFIX: We weren't unquoting keyword arguments of length two, so an

empty string didn't work as a default.

 

BUGFIX: Strings no longer pass the 'is_list' check. Additionally, the

list checks always return lists.

 

A couple of documentation bug fixes.

 

Removed CHANGELOG from module.

 

 

2007/02/04      Version 0.2.3

-----------------------------

 

Release of 0.2.3

 

 

2006/12/17      Version 0.2.3-alpha1

------------------------------------

 

By Nicola Larosa

 

Fixed validate doc to talk of ``boolean`` instead of ``bool``; changed the

``is_bool`` function to ``is_boolean`` (Sourceforge bug #1531525).

 

 

2006/04/29      Version 0.2.2

-----------------------------

 

Addressed bug where a string would pass the ``is_list`` test. (Thanks to

Konrad Wojas.)

 

 

2005/12/16      Version 0.2.1

-----------------------------

 

Fixed bug so we can handle keyword argument values with commas.

 

We now use a list constructor for passing list values to keyword arguments

(including ``default``) : ::

 

    default=list("val", "val", "val")

 

Added the ``_test`` test. {sm;:-)}

 

Moved a function call outside a try...except block.

 

 

and Mark Andrews.

 

        <p>

            <a href="http://www.python.org">

                <img src="images/new_python.gif" width="100" height="103" border="0" 

                    alt="Powered by Python" />

            </a>

            <a href="http://sourceforge.net">

                <img src="http://sourceforge.net/sflogo.php?group_id=123265&amp;type=1" width="88" height="31" border="0" alt="SourceForge.net Logo" />

            </a>

            <a href="http://www.opensource.org">

                <img src="images/osi-certified-120x100.gif" width="120" height="100" border="0"

                    alt="Certified Open Source"/>

            </a>

        </p>

        <p>

            <a href="http://www.voidspace.org.uk/python/index.shtml">

                <img src="images/pythonbanner.gif" width="468" height="60" 

                alt="Python on Voidspace" border="0" />

            </a>

        </p>