MobileBlur

web2py.gluon.validators.IS_SLUG-class.html at [a162dcef14]
Login

web2py.gluon.validators.IS_SLUG-class.html at [a162dcef14]

File applications/examples/static/epydoc/web2py.gluon.validators.IS_SLUG-class.html artifact cea5b54853 part of check-in a162dcef14


<?xml version="1.0" encoding="ascii"?>
<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN"
          "DTD/xhtml1-transitional.dtd">
<html xmlns="http://www.w3.org/1999/xhtml" xml:lang="en" lang="en">
<head>
  <title>web2py.gluon.validators.IS_SLUG</title>
  <link rel="stylesheet" href="epydoc.css" type="text/css" />
  <script type="text/javascript" src="epydoc.js"></script>
</head>

<body bgcolor="white" text="black" link="blue" vlink="#204080"
      alink="#204080">
<!-- ==================== NAVIGATION BAR ==================== -->
<table class="navbar" border="0" width="100%" cellpadding="0"
       bgcolor="#a0c0ff" cellspacing="0">
  <tr valign="middle">
  <!-- Home link -->
      <th>&nbsp;&nbsp;&nbsp;<a
        href="web2py.gluon-module.html">Home</a>&nbsp;&nbsp;&nbsp;</th>

  <!-- Tree link -->
      <th>&nbsp;&nbsp;&nbsp;<a
        href="module-tree.html">Trees</a>&nbsp;&nbsp;&nbsp;</th>

  <!-- Index link -->
      <th>&nbsp;&nbsp;&nbsp;<a
        href="identifier-index.html">Indices</a>&nbsp;&nbsp;&nbsp;</th>

  <!-- Help link -->
      <th>&nbsp;&nbsp;&nbsp;<a
        href="help.html">Help</a>&nbsp;&nbsp;&nbsp;</th>

  <!-- Project homepage -->
      <th class="navbar" align="right" width="100%">
        <table border="0" cellpadding="0" cellspacing="0">
          <tr><th class="navbar" align="center"
            ><a class="navbar" target="_top" href="http://www.web2py.com">web2py Web Framework</a></th>
          </tr></table></th>
  </tr>
</table>
<table width="100%" cellpadding="0" cellspacing="0">
  <tr valign="top">
    <td width="100%">
      <span class="breadcrumbs">
        Package&nbsp;web2py ::
        <a href="web2py.gluon-module.html">Package&nbsp;gluon</a> ::
        <a href="web2py.gluon.validators-module.html">Module&nbsp;validators</a> ::
        Class&nbsp;IS_SLUG
      </span>
    </td>
    <td>
      <table cellpadding="0" cellspacing="0">
        <!-- hide/show private -->
        <tr><td align="right"><span class="options">[<a href="javascript:void(0);" class="privatelink"
    onclick="toggle_private();">hide&nbsp;private</a>]</span></td></tr>
        <tr><td align="right"><span class="options"
            >[<a href="frames.html" target="_top">frames</a
            >]&nbsp;|&nbsp;<a href="web2py.gluon.validators.IS_SLUG-class.html"
            target="_top">no&nbsp;frames</a>]</span></td></tr>
      </table>
    </td>
  </tr>
</table>
<!-- ==================== CLASS DESCRIPTION ==================== -->
<h1 class="epydoc">Class IS_SLUG</h1><span class="codelink"><a href="web2py.gluon.validators-pysrc.html#IS_SLUG">source&nbsp;code</a></span><br /><br />
<pre class="base-tree">
object --+    
         |    
 <a href="web2py.gluon.validators.Validator-class.html">Validator</a> --+
             |
            <strong class="uidshort">IS_SLUG</strong>
</pre>

<hr />
convert arbitrary text string to a slug
<pre class="py-doctest">
<span class="py-prompt">&gt;&gt;&gt; </span>IS_SLUG()(<span class="py-string">'abc123'</span>)
<span class="py-output">('abc123', None)</span>
<span class="py-output"></span><span class="py-prompt">&gt;&gt;&gt; </span>IS_SLUG()(<span class="py-string">'ABC123'</span>)
<span class="py-output">('abc123', None)</span>
<span class="py-output"></span><span class="py-prompt">&gt;&gt;&gt; </span>IS_SLUG()(<span class="py-string">'abc-123'</span>)
<span class="py-output">('abc-123', None)</span>
<span class="py-output"></span><span class="py-prompt">&gt;&gt;&gt; </span>IS_SLUG()(<span class="py-string">'abc--123'</span>)
<span class="py-output">('abc-123', None)</span>
<span class="py-output"></span><span class="py-prompt">&gt;&gt;&gt; </span>IS_SLUG()(<span class="py-string">'abc 123'</span>)
<span class="py-output">('abc-123', None)</span>
<span class="py-output"></span><span class="py-prompt">&gt;&gt;&gt; </span>IS_SLUG()(<span class="py-string">'abc  _123'</span>)
<span class="py-output">('abc-123', None)</span>
<span class="py-output"></span><span class="py-prompt">&gt;&gt;&gt; </span>IS_SLUG()(<span class="py-string">'-abc-'</span>)
<span class="py-output">('abc', None)</span>
<span class="py-output"></span><span class="py-prompt">&gt;&gt;&gt; </span>IS_SLUG()(<span class="py-string">'--a--b--_ -c--'</span>)
<span class="py-output">('a-b-c', None)</span>
<span class="py-output"></span><span class="py-prompt">&gt;&gt;&gt; </span>IS_SLUG()(<span class="py-string">'abc&amp;amp;123'</span>)
<span class="py-output">('abc123', None)</span>
<span class="py-output"></span><span class="py-prompt">&gt;&gt;&gt; </span>IS_SLUG()(<span class="py-string">'abc&amp;amp;123&amp;amp;def'</span>)
<span class="py-output">('abc123def', None)</span>
<span class="py-output"></span><span class="py-prompt">&gt;&gt;&gt; </span>IS_SLUG()(<span class="py-string">'&#241;'</span>)
<span class="py-output">('n', None)</span>
<span class="py-output"></span><span class="py-prompt">&gt;&gt;&gt; </span>IS_SLUG(maxlen=4)(<span class="py-string">'abc123'</span>)
<span class="py-output">('abc1', None)</span>
<span class="py-output"></span><span class="py-prompt">&gt;&gt;&gt; </span>IS_SLUG()(<span class="py-string">'abc_123'</span>)
<span class="py-output">('abc-123', None)</span>
<span class="py-output"></span><span class="py-prompt">&gt;&gt;&gt; </span>IS_SLUG(keep_underscores=False)(<span class="py-string">'abc_123'</span>)
<span class="py-output">('abc-123', None)</span>
<span class="py-output"></span><span class="py-prompt">&gt;&gt;&gt; </span>IS_SLUG(keep_underscores=True)(<span class="py-string">'abc_123'</span>)
<span class="py-output">('abc_123', None)</span>
<span class="py-output"></span><span class="py-prompt">&gt;&gt;&gt; </span>IS_SLUG(check=False)(<span class="py-string">'abc'</span>)
<span class="py-output">('abc', None)</span>
<span class="py-output"></span><span class="py-prompt">&gt;&gt;&gt; </span>IS_SLUG(check=True)(<span class="py-string">'abc'</span>)
<span class="py-output">('abc', None)</span>
<span class="py-output"></span><span class="py-prompt">&gt;&gt;&gt; </span>IS_SLUG(check=False)(<span class="py-string">'a bc'</span>)
<span class="py-output">('a-bc', None)</span>
<span class="py-output"></span><span class="py-prompt">&gt;&gt;&gt; </span>IS_SLUG(check=True)(<span class="py-string">'a bc'</span>)
<span class="py-output">('a bc', 'must be slug')</span></pre><br /><br />

<!-- ==================== INSTANCE METHODS ==================== -->
<a name="section-InstanceMethods"></a>
<table class="summary" border="1" cellpadding="3"
       cellspacing="0" width="100%" bgcolor="white">
<tr bgcolor="#70b0f0" class="table-header">
  <td colspan="2" class="table-header">
    <table border="0" cellpadding="0" cellspacing="0" width="100%">
      <tr valign="top">
        <td align="left"><span class="table-header">Instance Methods</span></td>
        <td align="right" valign="top"
         ><span class="options">[<a href="#section-InstanceMethods"
         class="privatelink" onclick="toggle_private();"
         >hide private</a>]</span></td>
      </tr>
    </table>
  </td>
</tr>
<tr>
    <td width="15%" align="right" valign="top" class="summary">
      <span class="summary-type">&nbsp;</span>
    </td><td class="summary">
      <table width="100%" cellpadding="0" cellspacing="0" border="0">
        <tr>
          <td><span class="summary-sig"><a href="web2py.gluon.validators.IS_SLUG-class.html#__init__" class="summary-sig-name">__init__</a>(<span class="summary-sig-arg">self</span>,
        <span class="summary-sig-arg">maxlen</span>=<span class="summary-sig-default">80</span>,
        <span class="summary-sig-arg">check</span>=<span class="summary-sig-default">True</span>,
        <span class="summary-sig-arg">error_message</span>=<span class="summary-sig-default"><code class="variable-quote">'</code><code class="variable-string">must be slug</code><code class="variable-quote">'</code></span>,
        <span class="summary-sig-arg">keep_underscores</span>=<span class="summary-sig-default">True</span>)</span><br />
      x.__init__(...) initializes x; see x.__class__.__doc__ for 
      signature</td>
          <td align="right" valign="top">
            <span class="codelink"><a href="web2py.gluon.validators-pysrc.html#IS_SLUG.__init__">source&nbsp;code</a></span>
            
          </td>
        </tr>
      </table>
      
    </td>
  </tr>
<tr>
    <td width="15%" align="right" valign="top" class="summary">
      <span class="summary-type">&nbsp;</span>
    </td><td class="summary">
      <table width="100%" cellpadding="0" cellspacing="0" border="0">
        <tr>
          <td><span class="summary-sig"><a name="__call__"></a><span class="summary-sig-name">__call__</span>(<span class="summary-sig-arg">self</span>,
        <span class="summary-sig-arg">value</span>)</span></td>
          <td align="right" valign="top">
            <span class="codelink"><a href="web2py.gluon.validators-pysrc.html#IS_SLUG.__call__">source&nbsp;code</a></span>
            
          </td>
        </tr>
      </table>
      
    </td>
  </tr>
  <tr>
    <td colspan="2" class="summary">
    <p class="indent-wrapped-lines"><b>Inherited from <code><a href="web2py.gluon.validators.Validator-class.html">Validator</a></code></b>:
      <code><a href="web2py.gluon.validators.Validator-class.html#formatter">formatter</a></code>
      </p>
    <p class="indent-wrapped-lines"><b>Inherited from <code>object</code></b>:
      <code>__delattr__</code>,
      <code>__getattribute__</code>,
      <code>__hash__</code>,
      <code>__new__</code>,
      <code>__reduce__</code>,
      <code>__reduce_ex__</code>,
      <code>__repr__</code>,
      <code>__setattr__</code>,
      <code>__str__</code>
      </p>
    </td>
  </tr>
</table>
<!-- ==================== STATIC METHODS ==================== -->
<a name="section-StaticMethods"></a>
<table class="summary" border="1" cellpadding="3"
       cellspacing="0" width="100%" bgcolor="white">
<tr bgcolor="#70b0f0" class="table-header">
  <td colspan="2" class="table-header">
    <table border="0" cellpadding="0" cellspacing="0" width="100%">
      <tr valign="top">
        <td align="left"><span class="table-header">Static Methods</span></td>
        <td align="right" valign="top"
         ><span class="options">[<a href="#section-StaticMethods"
         class="privatelink" onclick="toggle_private();"
         >hide private</a>]</span></td>
      </tr>
    </table>
  </td>
</tr>
<tr>
    <td width="15%" align="right" valign="top" class="summary">
      <span class="summary-type">&nbsp;</span>
    </td><td class="summary">
      <table width="100%" cellpadding="0" cellspacing="0" border="0">
        <tr>
          <td><span class="summary-sig"><a name="urlify"></a><span class="summary-sig-name">urlify</span>(<span class="summary-sig-arg">value</span>,
        <span class="summary-sig-arg">maxlen</span>=<span class="summary-sig-default">80</span>,
        <span class="summary-sig-arg">keep_underscores</span>=<span class="summary-sig-default">True</span>)</span></td>
          <td align="right" valign="top">
            <span class="codelink"><a href="web2py.gluon.validators-pysrc.html#IS_SLUG.urlify">source&nbsp;code</a></span>
            
          </td>
        </tr>
      </table>
      
    </td>
  </tr>
</table>
<!-- ==================== PROPERTIES ==================== -->
<a name="section-Properties"></a>
<table class="summary" border="1" cellpadding="3"
       cellspacing="0" width="100%" bgcolor="white">
<tr bgcolor="#70b0f0" class="table-header">
  <td colspan="2" class="table-header">
    <table border="0" cellpadding="0" cellspacing="0" width="100%">
      <tr valign="top">
        <td align="left"><span class="table-header">Properties</span></td>
        <td align="right" valign="top"
         ><span class="options">[<a href="#section-Properties"
         class="privatelink" onclick="toggle_private();"
         >hide private</a>]</span></td>
      </tr>
    </table>
  </td>
</tr>
  <tr>
    <td colspan="2" class="summary">
    <p class="indent-wrapped-lines"><b>Inherited from <code>object</code></b>:
      <code>__class__</code>
      </p>
    </td>
  </tr>
</table>
<!-- ==================== METHOD DETAILS ==================== -->
<a name="section-MethodDetails"></a>
<table class="details" border="1" cellpadding="3"
       cellspacing="0" width="100%" bgcolor="white">
<tr bgcolor="#70b0f0" class="table-header">
  <td colspan="2" class="table-header">
    <table border="0" cellpadding="0" cellspacing="0" width="100%">
      <tr valign="top">
        <td align="left"><span class="table-header">Method Details</span></td>
        <td align="right" valign="top"
         ><span class="options">[<a href="#section-MethodDetails"
         class="privatelink" onclick="toggle_private();"
         >hide private</a>]</span></td>
      </tr>
    </table>
  </td>
</tr>
</table>
<a name="__init__"></a>
<div>
<table class="details" border="1" cellpadding="3"
       cellspacing="0" width="100%" bgcolor="white">
<tr><td>
  <table width="100%" cellpadding="0" cellspacing="0" border="0">
  <tr valign="top"><td>
  <h3 class="epydoc"><span class="sig"><span class="sig-name">__init__</span>(<span class="sig-arg">self</span>,
        <span class="sig-arg">maxlen</span>=<span class="sig-default">80</span>,
        <span class="sig-arg">check</span>=<span class="sig-default">True</span>,
        <span class="sig-arg">error_message</span>=<span class="sig-default"><code class="variable-quote">'</code><code class="variable-string">must be slug</code><code class="variable-quote">'</code></span>,
        <span class="sig-arg">keep_underscores</span>=<span class="sig-default">True</span>)</span>
    <br /><em class="fname">(Constructor)</em>
  </h3>
  </td><td align="right" valign="top"
    ><span class="codelink"><a href="web2py.gluon.validators-pysrc.html#IS_SLUG.__init__">source&nbsp;code</a></span>&nbsp;
    </td>
  </table>
  
  x.__init__(...) initializes x; see x.__class__.__doc__ for 
  signature
  <dl class="fields">
    <dt>Overrides:
      object.__init__
        <dd><em class="note">(inherited documentation)</em></dd>
    </dt>
  </dl>
</td></tr></table>
</div>
<br />
<!-- ==================== NAVIGATION BAR ==================== -->
<table class="navbar" border="0" width="100%" cellpadding="0"
       bgcolor="#a0c0ff" cellspacing="0">
  <tr valign="middle">
  <!-- Home link -->
      <th>&nbsp;&nbsp;&nbsp;<a
        href="web2py.gluon-module.html">Home</a>&nbsp;&nbsp;&nbsp;</th>

  <!-- Tree link -->
      <th>&nbsp;&nbsp;&nbsp;<a
        href="module-tree.html">Trees</a>&nbsp;&nbsp;&nbsp;</th>

  <!-- Index link -->
      <th>&nbsp;&nbsp;&nbsp;<a
        href="identifier-index.html">Indices</a>&nbsp;&nbsp;&nbsp;</th>

  <!-- Help link -->
      <th>&nbsp;&nbsp;&nbsp;<a
        href="help.html">Help</a>&nbsp;&nbsp;&nbsp;</th>

  <!-- Project homepage -->
      <th class="navbar" align="right" width="100%">
        <table border="0" cellpadding="0" cellspacing="0">
          <tr><th class="navbar" align="center"
            ><a class="navbar" target="_top" href="http://www.web2py.com">web2py Web Framework</a></th>
          </tr></table></th>
  </tr>
</table>
<table border="0" cellpadding="0" cellspacing="0" width="100%%">
  <tr>
    <td align="left" class="footer">
    Generated by Epydoc 3.0beta1 on Thu Aug  4 00:47:02 2011
    </td>
    <td align="right" class="footer">
      <a href="http://epydoc.sourceforge.net">http://epydoc.sourceforge.net</a>
    </td>
  </tr>
</table>

<script type="text/javascript">
  <!--
  // Private objects are initially displayed (because if
  // javascript is turned off then we want them to be
  // visible); but by default, we want to hide them.  So hide
  // them unless we have a cookie that says to show them.
  checkCookie()
  // -->
</script>
  
</body>
</html>