1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 17 18 19 20 21 22 23 24 25 26 27 28 29 30 31 32 33 34 35 36 37 38 39 40 41 42 43 44 45 46 47 48 49 50 51 52 53 54 55 56 57 58 59 60 61 62 63 64 65 66 67 68 69 70 71 72 73 74 75 76 77 78 79 80 81 82 83 84 85 86 87 88 89 90 91 92 93 94 95 96 97 98 99 100 101 102 103 104 105 106 107 108 109 110 111 112 113 114 115 116 117 118 119 120 121 122 123 124 125 126 127 128 129 130 131 132 133 134 135 136 137 138 139 140 141 142 143 144 145 146 147 148 149 150 151 152 153 154 155 156 157 158 159 160 161 162 163 164 165 166 167 168 169 170 171 172 173 174 175 176 177 178 179 180 181 182 183 184 185 186 187 188 189 190 191 192 193 194 195 196 197 198 199 200 201 202 203 204 205 206 207 208 209 210 211 212 213 214 215 216 217 218 219 220 221 222 223 224 225 226 227 228 229 230 231 232 233 234 235 236 237 238 239 240 241 242 243 244 245 246 247 248 249 250 251 252 253 254 255 256 257 258 259 260 261 262 263 264 265 266 267 268 269 270 271 272 273 274 275 276 277 278 279 280 281 282 283 284 285 286 287 288 289 290 291 292 293 294 295
|
<?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>sqlalchemy.types.Unicode</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> <a
href="Camelot.camelot-module.html">Home</a> </th>
<!-- Tree link -->
<th> <a
href="module-tree.html">Trees</a> </th>
<!-- Index link -->
<th> <a
href="identifier-index.html">Indices</a> </th>
<!-- Help link -->
<th> <a
href="help.html">Help</a> </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.python-camelot.com">Camelot</a></th>
</tr></table></th>
</tr>
</table>
<table width="100%" cellpadding="0" cellspacing="0">
<tr valign="top">
<td width="100%">
<span class="breadcrumbs">
sqlalchemy ::
types ::
Unicode ::
Class Unicode
</span>
</td>
<td>
<table cellpadding="0" cellspacing="0">
<!-- hide/show private -->
<tr><td align="right"><span class="options"
>[<a href="frames.html" target="_top">frames</a
>] | <a href="sqlalchemy.types.Unicode-class.html"
target="_top">no frames</a>]</span></td></tr>
</table>
</td>
</tr>
</table>
<!-- ==================== CLASS DESCRIPTION ==================== -->
<h1 class="epydoc">Class Unicode</h1><p class="nomargin-top"></p>
<center>
<center> <map id="uml_class_diagram_for_sqlalche_2" name="uml_class_diagram_for_sqlalche_2">
<area shape="rect" href="javascript:void(0);" title="sqlalchemy.types.String.adapt" alt="" coords="113,297,289,316"/>
<area shape="rect" href="javascript:void(0);" title="Return a conversion function for processing bind values." alt="" coords="113,316,289,335"/>
<area shape="rect" href="javascript:void(0);" title="Return the corresponding type object from the underlying DB-API, if any." alt="" coords="113,335,289,353"/>
<area shape="rect" href="javascript:void(0);" title="Return a conversion function for processing result row values." alt="" coords="113,353,289,372"/>
<area shape="rect" href="javascript:void(0);" title="The base for all string and character types." alt="" coords="112,272,291,373"/>
<area shape="rect" href="sqlalchemy.types.Unicode-class.html#__init__" title="Create a Unicode-converting String type." alt="" coords="92,428,311,447"/>
<area shape="rect" href="sqlalchemy.types.Unicode-class.html" title="A variable length Unicode string." alt="" coords="91,403,312,448"/>
<area shape="rect" href="javascript:void(0);" title="Converts an add operator to concat." alt="" coords="17,195,159,213"/>
<area shape="rect" href="javascript:void(0);" title="A mixin that marks a type as supporting 'concatenation', typically strings." alt="" coords="16,169,160,215"/>
<area shape="rect" href="javascript:void(0);" title="sqlalchemy.types.TypeEngine.__getstate__" alt="" coords="212,167,420,185"/>
<area shape="rect" href="javascript:void(0);" title="sqlalchemy.types.TypeEngine.dialect_impl" alt="" coords="212,185,420,204"/>
<area shape="rect" href="javascript:void(0);" title="Return the DDL representation for this type." alt="" coords="212,204,420,223"/>
<area shape="rect" href="javascript:void(0);" title="return a list of classes to test for a match when adapting this type to a dialect-specific type." alt="" coords="212,223,420,241"/>
<area shape="rect" href="javascript:void(0);" title="Base for built-in types." alt="" coords="211,141,421,243"/>
<area shape="rect" href="javascript:void(0);" title="repr(x)" alt="" coords="237,36,395,55"/>
<area shape="rect" href="javascript:void(0);" title="Compare two values for equality." alt="" coords="237,55,395,73"/>
<area shape="rect" href="javascript:void(0);" title="sqlalchemy.types.AbstractType.copy_value" alt="" coords="237,73,395,92"/>
<area shape="rect" href="javascript:void(0);" title="Return True if the target Python type is 'mutable'." alt="" coords="237,92,395,111"/>
<area shape="rect" href="javascript:void(0);" title="sqlalchemy.types.AbstractType" alt="" coords="236,11,396,112"/>
</map>
<img src="uml_class_diagram_for_sqlalche_2.gif" alt='' usemap="#uml_class_diagram_for_sqlalche_2" ismap="ismap" class="graph-without-title" />
</center>
</center>
<hr />
<pre class="literalblock">
A variable length Unicode string.
The ``Unicode`` type is a :class:`String` which converts Python
``unicode`` objects (i.e., strings that are defined as
``u'somevalue'``) into encoded bytestrings when passing the value
to the database driver, and similarly decodes values from the
database back into Python ``unicode`` objects.
When using the ``Unicode`` type, it is only appropriate to pass
Python ``unicode`` objects, and not plain ``str``. If a
bytestring (``str``) is passed, a runtime warning is issued. If
you notice your application raising these warnings but you're not
sure where, the Python ``warnings`` filter can be used to turn
these warnings into exceptions which will illustrate a stack
trace::
import warnings
warnings.simplefilter('error')
Bytestrings sent to and received from the database are encoded
using the dialect's
:attr:`~sqlalchemy.engine.base.Dialect.encoding`, which defaults
to `utf-8`.
A synonym for String(length, convert_unicode=True, assert_unicode='warn').
</pre>
<!-- ==================== 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 align="left" colspan="2" class="table-header">
<span class="table-header">Instance Methods</span></td>
</tr>
<tr>
<td width="15%" align="right" valign="top" class="summary">
<span class="summary-type"> </span>
</td><td class="summary">
<table width="100%" cellpadding="0" cellspacing="0" border="0">
<tr>
<td><span class="summary-sig"><a href="sqlalchemy.types.Unicode-class.html#__init__" class="summary-sig-name">__init__</a>(<span class="summary-sig-arg">self</span>,
<span class="summary-sig-arg">length</span>=<span class="summary-sig-default">None</span>,
<span class="summary-sig-arg">**kwargs</span>)</span><br />
Create a Unicode-converting String type.</td>
<td align="right" valign="top">
</td>
</tr>
</table>
</td>
</tr>
<tr>
<td colspan="2" class="summary">
<p class="indent-wrapped-lines"><b>Inherited from <code>String</code></b>:
<code>adapt</code>,
<code>bind_processor</code>,
<code>get_dbapi_type</code>,
<code>result_processor</code>
</p>
<p class="indent-wrapped-lines"><b>Inherited from <code>Concatenable</code></b>:
<code>adapt_operator</code>
</p>
<p class="indent-wrapped-lines"><b>Inherited from <code>TypeEngine</code></b>:
<code>__getstate__</code>,
<code>dialect_impl</code>,
<code>get_col_spec</code>,
<code>get_search_list</code>
</p>
<p class="indent-wrapped-lines"><b>Inherited from <code>AbstractType</code></b>:
<code>__repr__</code>,
<code>compare_values</code>,
<code>copy_value</code>,
<code>is_mutable</code>
</p>
<p class="indent-wrapped-lines"><b>Inherited from <code>object</code></b>:
<code>__delattr__</code>,
<code>__format__</code>,
<code>__getattribute__</code>,
<code>__hash__</code>,
<code>__new__</code>,
<code>__reduce__</code>,
<code>__reduce_ex__</code>,
<code>__setattr__</code>,
<code>__sizeof__</code>,
<code>__str__</code>,
<code>__subclasshook__</code>
</p>
</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 align="left" colspan="2" class="table-header">
<span class="table-header">Properties</span></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 align="left" colspan="2" class="table-header">
<span class="table-header">Method Details</span></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">length</span>=<span class="sig-default">None</span>,
<span class="sig-arg">**kwargs</span>)</span>
<br /><em class="fname">(Constructor)</em>
</h3>
</td><td align="right" valign="top"
>
</td>
</tr></table>
Create a Unicode-converting String type.
<dl class="fields">
<dt>Parameters:</dt>
<dd><ul class="nomargin-top">
<li><strong class="pname"><code>length</code></strong> - optional, a length for the column for use in
DDL statements. May be safely omitted if no <tt class="rst-docutils literal">CREATE
TABLE</tt> will be issued. Certain databases may require a
<em>length</em> for use in DDL, and will raise an exception when
the <tt class="rst-docutils literal">CREATE TABLE</tt> DDL is issued. Whether the value is
interpreted as bytes or characters is database specific.</li>
</ul></dd>
<dt>Overrides:
object.__init__
</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> <a
href="Camelot.camelot-module.html">Home</a> </th>
<!-- Tree link -->
<th> <a
href="module-tree.html">Trees</a> </th>
<!-- Index link -->
<th> <a
href="identifier-index.html">Indices</a> </th>
<!-- Help link -->
<th> <a
href="help.html">Help</a> </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.python-camelot.com">Camelot</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.0.1 on Sat Jun 12 15:42:08 2010
</td>
<td align="right" class="footer">
<a target="mainFrame" 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>
|