Package web2py :: Package gluon :: Module validators :: Class IS_SLUG

Class IS_SLUG

object --+    
         |    
 Validator --+
             |
            IS_SLUG

convert arbitrary text string to a slug

>>> IS_SLUG()('abc123')
('abc123', None)
>>> IS_SLUG()('ABC123')
('abc123', None)
>>> IS_SLUG()('abc-123')
('abc-123', None)
>>> IS_SLUG()('abc--123')
('abc-123', None)
>>> IS_SLUG()('abc 123')
('abc-123', None)
>>> IS_SLUG()('abc  _123')
('abc-123', None)
>>> IS_SLUG()('-abc-')
('abc', None)
>>> IS_SLUG()('abc&amp;123')
('abc123', None)
>>> IS_SLUG()('abc&amp;123&amp;def')
('abc123def', None)
>>> IS_SLUG()('ñ')
('n', None)
>>> IS_SLUG(maxlen=4)('abc123')
('abc1', None)

Instance Methods

[hide private]

__init__(self, maxlen=80, check=True, error_message='must be slug')
x.__init__(...) initializes x; see x.__class__.__doc__ for signature source code

__call__(self, value)

source code

Inherited from Validator: formatter

Inherited from object: __delattr__, __getattribute__, __hash__, __new__, __reduce__, __reduce_ex__, __repr__, __setattr__, __str__

Static Methods

[hide private]

urlify(value, maxlen=80, remove_underscores=True)

source code

Properties

[hide private]

Inherited from object: __class__

Method Details

[hide private]

init(self, maxlen=80, check=True, error_message=`'must be slug'`)
(Constructor)

source code

x.__init__(...) initializes x; see x.__class__.__doc__ for signature

Overrides: object.__init__: (inherited documentation)

Class IS_SLUG

__init__(self, maxlen=80, check=True, error_message='must be slug') (Constructor)

init(self, maxlen=80, check=True, error_message=`'must be slug'`)
(Constructor)