1 <?xml version="1.0" encoding="ascii"?>
2 <!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN"
3 "DTD/xhtml1-transitional.dtd">
4 <html xmlns="http://www.w3.org/1999/xhtml" xml:lang="en" lang="en">
6 <title>lxml.html.Classes</title>
7 <link rel="stylesheet" href="epydoc.css" type="text/css" />
8 <script type="text/javascript" src="epydoc.js"></script>
11 <body bgcolor="white" text="black" link="blue" vlink="#204080"
13 <!-- ==================== NAVIGATION BAR ==================== -->
14 <table class="navbar" border="0" width="100%" cellpadding="0"
15 bgcolor="#a0c0ff" cellspacing="0">
18 <th> <a
19 href="lxml-module.html">Home</a> </th>
22 <th> <a
23 href="module-tree.html">Trees</a> </th>
26 <th> <a
27 href="identifier-index.html">Indices</a> </th>
30 <th> <a
31 href="help.html">Help</a> </th>
33 <!-- Project homepage -->
34 <th class="navbar" align="right" width="100%">
35 <table border="0" cellpadding="0" cellspacing="0">
36 <tr><th class="navbar" align="center"
37 ><a class="navbar" target="_top" href="/">lxml API</a></th>
41 <table width="100%" cellpadding="0" cellspacing="0">
44 <span class="breadcrumbs">
52 <table cellpadding="0" cellspacing="0">
53 <!-- hide/show private -->
54 <tr><td align="right"><span class="options">[<a href="javascript:void(0);" class="privatelink"
55 onclick="toggle_private();">hide private</a>]</span></td></tr>
56 <tr><td align="right"><span class="options"
57 >[<a href="frames.html" target="_top">frames</a
58 >] | <a href="lxml.html.Classes-class.html"
59 target="_top">no frames</a>]</span></td></tr>
64 <!-- ==================== CLASS DESCRIPTION ==================== -->
65 <h1 class="epydoc">Class Classes</h1><p class="nomargin-top"><span class="codelink"><a href="lxml.html-pysrc.html#Classes">source code</a></span></p>
66 <pre class="base-tree">
81 _abcoll.MutableSet --+
83 <strong class="uidshort">Classes</strong>
87 <p>Provides access to an element's class attribute as a set-like collection.
89 <pre class="rst-literal-block">
90 >>> el = fromstring('<p class="hidden large">Text</p>')
91 >>> classes = el.classes # or: classes = Classes(el.attrib)
92 >>> classes |= ['block', 'paragraph']
93 >>> el.get('class')
94 'hidden large block paragraph'
95 >>> classes.toggle('hidden')
97 >>> el.get('class')
98 'large block paragraph'
99 >>> classes -= ('some', 'classes', 'block')
100 >>> el.get('class')
104 <!-- ==================== NESTED CLASSES ==================== -->
105 <a name="section-NestedClasses"></a>
106 <table class="summary" border="1" cellpadding="3"
107 cellspacing="0" width="100%" bgcolor="white">
108 <tr bgcolor="#70b0f0" class="table-header">
109 <td colspan="2" class="table-header">
110 <table border="0" cellpadding="0" cellspacing="0" width="100%">
112 <td align="left"><span class="table-header">Nested Classes</span></td>
113 <td align="right" valign="top"
114 ><span class="options">[<a href="#section-NestedClasses"
115 class="privatelink" onclick="toggle_private();"
116 >hide private</a>]</span></td>
122 <td colspan="2" class="summary">
123 <p class="indent-wrapped-lines"><b>Inherited from <code>_abcoll.Sized</code></b>:
124 <code><a href="abc.ABCMeta-class.html">__metaclass__</a></code>
129 <!-- ==================== INSTANCE METHODS ==================== -->
130 <a name="section-InstanceMethods"></a>
131 <table class="summary" border="1" cellpadding="3"
132 cellspacing="0" width="100%" bgcolor="white">
133 <tr bgcolor="#70b0f0" class="table-header">
134 <td colspan="2" class="table-header">
135 <table border="0" cellpadding="0" cellspacing="0" width="100%">
137 <td align="left"><span class="table-header">Instance Methods</span></td>
138 <td align="right" valign="top"
139 ><span class="options">[<a href="#section-InstanceMethods"
140 class="privatelink" onclick="toggle_private();"
141 >hide private</a>]</span></td>
147 <td width="15%" align="right" valign="top" class="summary">
148 <span class="summary-type"> </span>
149 </td><td class="summary">
150 <table width="100%" cellpadding="0" cellspacing="0" border="0">
152 <td><span class="summary-sig"><a href="lxml.html.Classes-class.html#__contains__" class="summary-sig-name">__contains__</a>(<span class="summary-sig-arg">self</span>,
153 <span class="summary-sig-arg">name</span>)</span></td>
154 <td align="right" valign="top">
155 <span class="codelink"><a href="lxml.html-pysrc.html#Classes.__contains__">source code</a></span>
164 <td width="15%" align="right" valign="top" class="summary">
165 <span class="summary-type"> </span>
166 </td><td class="summary">
167 <table width="100%" cellpadding="0" cellspacing="0" border="0">
169 <td><span class="summary-sig"><a href="lxml.html.Classes-class.html#__init__" class="summary-sig-name">__init__</a>(<span class="summary-sig-arg">self</span>,
170 <span class="summary-sig-arg">attributes</span>)</span><br />
171 x.__init__(...) initializes x; see help(type(x)) for signature</td>
172 <td align="right" valign="top">
173 <span class="codelink"><a href="lxml.html-pysrc.html#Classes.__init__">source code</a></span>
182 <td width="15%" align="right" valign="top" class="summary">
183 <span class="summary-type"> </span>
184 </td><td class="summary">
185 <table width="100%" cellpadding="0" cellspacing="0" border="0">
187 <td><span class="summary-sig"><a href="lxml.html.Classes-class.html#__iter__" class="summary-sig-name">__iter__</a>(<span class="summary-sig-arg">self</span>)</span></td>
188 <td align="right" valign="top">
189 <span class="codelink"><a href="lxml.html-pysrc.html#Classes.__iter__">source code</a></span>
198 <td width="15%" align="right" valign="top" class="summary">
199 <span class="summary-type"> </span>
200 </td><td class="summary">
201 <table width="100%" cellpadding="0" cellspacing="0" border="0">
203 <td><span class="summary-sig"><a href="lxml.html.Classes-class.html#__len__" class="summary-sig-name">__len__</a>(<span class="summary-sig-arg">self</span>)</span></td>
204 <td align="right" valign="top">
205 <span class="codelink"><a href="lxml.html-pysrc.html#Classes.__len__">source code</a></span>
214 <td width="15%" align="right" valign="top" class="summary">
215 <span class="summary-type"> </span>
216 </td><td class="summary">
217 <table width="100%" cellpadding="0" cellspacing="0" border="0">
219 <td><span class="summary-sig"><a href="lxml.html.Classes-class.html#add" class="summary-sig-name">add</a>(<span class="summary-sig-arg">self</span>,
220 <span class="summary-sig-arg">value</span>)</span><br />
222 <td align="right" valign="top">
223 <span class="codelink"><a href="lxml.html-pysrc.html#Classes.add">source code</a></span>
232 <td width="15%" align="right" valign="top" class="summary">
233 <span class="summary-type"> </span>
234 </td><td class="summary">
235 <table width="100%" cellpadding="0" cellspacing="0" border="0">
237 <td><span class="summary-sig"><a href="lxml.html.Classes-class.html#discard" class="summary-sig-name">discard</a>(<span class="summary-sig-arg">self</span>,
238 <span class="summary-sig-arg">value</span>)</span><br />
239 Remove a class if it is currently present.</td>
240 <td align="right" valign="top">
241 <span class="codelink"><a href="lxml.html-pysrc.html#Classes.discard">source code</a></span>
250 <td width="15%" align="right" valign="top" class="summary">
251 <span class="summary-type"> </span>
252 </td><td class="summary">
253 <table width="100%" cellpadding="0" cellspacing="0" border="0">
255 <td><span class="summary-sig"><a href="lxml.html.Classes-class.html#remove" class="summary-sig-name">remove</a>(<span class="summary-sig-arg">self</span>,
256 <span class="summary-sig-arg">value</span>)</span><br />
257 Remove a class; it must currently be present.</td>
258 <td align="right" valign="top">
259 <span class="codelink"><a href="lxml.html-pysrc.html#Classes.remove">source code</a></span>
268 <td width="15%" align="right" valign="top" class="summary">
269 <span class="summary-type"> </span>
270 </td><td class="summary">
271 <table width="100%" cellpadding="0" cellspacing="0" border="0">
273 <td><span class="summary-sig"><a href="lxml.html.Classes-class.html#toggle" class="summary-sig-name">toggle</a>(<span class="summary-sig-arg">self</span>,
274 <span class="summary-sig-arg">value</span>)</span><br />
275 Add a class name if it isn't there yet, or remove it if it exists.</td>
276 <td align="right" valign="top">
277 <span class="codelink"><a href="lxml.html-pysrc.html#Classes.toggle">source code</a></span>
286 <td width="15%" align="right" valign="top" class="summary">
287 <span class="summary-type"> </span>
288 </td><td class="summary">
289 <table width="100%" cellpadding="0" cellspacing="0" border="0">
291 <td><span class="summary-sig"><a name="update"></a><span class="summary-sig-name">update</span>(<span class="summary-sig-arg">self</span>,
292 <span class="summary-sig-arg">values</span>)</span><br />
293 Add all names from 'values'.</td>
294 <td align="right" valign="top">
295 <span class="codelink"><a href="lxml.html-pysrc.html#Classes.update">source code</a></span>
304 <td colspan="2" class="summary">
305 <p class="indent-wrapped-lines"><b>Inherited from <code>_abcoll.MutableSet</code></b>:
306 <code>__iand__</code>,
307 <code>__ior__</code>,
308 <code>__isub__</code>,
309 <code>__ixor__</code>,
313 <p class="indent-wrapped-lines"><b>Inherited from <code>_abcoll.Set</code></b>:
314 <code>__and__</code>,
322 <code>__rand__</code>,
323 <code>__ror__</code>,
324 <code>__rsub__</code>,
325 <code>__rxor__</code>,
326 <code>__sub__</code>,
327 <code>__xor__</code>,
328 <code>isdisjoint</code>
330 <div class="private"> <p class="indent-wrapped-lines"><b>Inherited from <code>_abcoll.Set</code></b> (private):
333 <p class="indent-wrapped-lines"><b>Inherited from <code>object</code></b>:
334 <code>__delattr__</code>,
335 <code>__format__</code>,
336 <code>__getattribute__</code>,
337 <code>__new__</code>,
338 <code>__reduce__</code>,
339 <code>__reduce_ex__</code>,
340 <code>__repr__</code>,
341 <code>__setattr__</code>,
342 <code>__sizeof__</code>,
348 <!-- ==================== CLASS METHODS ==================== -->
349 <a name="section-ClassMethods"></a>
350 <table class="summary" border="1" cellpadding="3"
351 cellspacing="0" width="100%" bgcolor="white">
352 <tr bgcolor="#70b0f0" class="table-header">
353 <td colspan="2" class="table-header">
354 <table border="0" cellpadding="0" cellspacing="0" width="100%">
356 <td align="left"><span class="table-header">Class Methods</span></td>
357 <td align="right" valign="top"
358 ><span class="options">[<a href="#section-ClassMethods"
359 class="privatelink" onclick="toggle_private();"
360 >hide private</a>]</span></td>
366 <td colspan="2" class="summary">
367 <div class="private"> <p class="indent-wrapped-lines"><b>Inherited from <code>_abcoll.Set</code></b> (private):
368 <code>_from_iterable</code>
370 <p class="indent-wrapped-lines"><b>Inherited from <code>_abcoll.Sized</code></b>:
371 <code>__subclasshook__</code>
376 <!-- ==================== CLASS VARIABLES ==================== -->
377 <a name="section-ClassVariables"></a>
378 <table class="summary" border="1" cellpadding="3"
379 cellspacing="0" width="100%" bgcolor="white">
380 <tr bgcolor="#70b0f0" class="table-header">
381 <td colspan="2" class="table-header">
382 <table border="0" cellpadding="0" cellspacing="0" width="100%">
384 <td align="left"><span class="table-header">Class Variables</span></td>
385 <td align="right" valign="top"
386 ><span class="options">[<a href="#section-ClassVariables"
387 class="privatelink" onclick="toggle_private();"
388 >hide private</a>]</span></td>
394 <td width="15%" align="right" valign="top" class="summary">
395 <span class="summary-type"> </span>
396 </td><td class="summary">
397 <a name="__abstractmethods__"></a><span class="summary-name">__abstractmethods__</span> = <code title="frozenset([])"><code class="variable-group">frozenset([</code><code class="variable-group">])</code></code>
401 <td width="15%" align="right" valign="top" class="summary">
402 <span class="summary-type"> </span>
403 </td><td class="summary">
404 <a name="_abc_negative_cache"></a><span class="summary-name">_abc_negative_cache</span> = <code title="'WeakSet'"><code class="variable-quote">'</code><code class="variable-string">WeakSet</code><code class="variable-quote">'</code></code>
408 <td width="15%" align="right" valign="top" class="summary">
409 <span class="summary-type"> </span>
410 </td><td class="summary">
411 <a name="_abc_negative_cache_version"></a><span class="summary-name">_abc_negative_cache_version</span> = <code title="21">21</code>
415 <td width="15%" align="right" valign="top" class="summary">
416 <span class="summary-type"> </span>
417 </td><td class="summary">
418 <a name="_abc_registry"></a><span class="summary-name">_abc_registry</span> = <code title="'WeakSet'"><code class="variable-quote">'</code><code class="variable-string">WeakSet</code><code class="variable-quote">'</code></code>
422 <td colspan="2" class="summary">
423 <p class="indent-wrapped-lines"><b>Inherited from <code>_abcoll.Set</code></b>:
424 <code>__hash__</code>
426 <div class="private"> <p class="indent-wrapped-lines"><b>Inherited from <code>_abcoll.Sized</code></b> (private):
427 <code>_abc_cache</code>
432 <!-- ==================== PROPERTIES ==================== -->
433 <a name="section-Properties"></a>
434 <table class="summary" border="1" cellpadding="3"
435 cellspacing="0" width="100%" bgcolor="white">
436 <tr bgcolor="#70b0f0" class="table-header">
437 <td colspan="2" class="table-header">
438 <table border="0" cellpadding="0" cellspacing="0" width="100%">
440 <td align="left"><span class="table-header">Properties</span></td>
441 <td align="right" valign="top"
442 ><span class="options">[<a href="#section-Properties"
443 class="privatelink" onclick="toggle_private();"
444 >hide private</a>]</span></td>
450 <td colspan="2" class="summary">
451 <p class="indent-wrapped-lines"><b>Inherited from <code>object</code></b>:
452 <code>__class__</code>
457 <!-- ==================== METHOD DETAILS ==================== -->
458 <a name="section-MethodDetails"></a>
459 <table class="details" border="1" cellpadding="3"
460 cellspacing="0" width="100%" bgcolor="white">
461 <tr bgcolor="#70b0f0" class="table-header">
462 <td colspan="2" class="table-header">
463 <table border="0" cellpadding="0" cellspacing="0" width="100%">
465 <td align="left"><span class="table-header">Method Details</span></td>
466 <td align="right" valign="top"
467 ><span class="options">[<a href="#section-MethodDetails"
468 class="privatelink" onclick="toggle_private();"
469 >hide private</a>]</span></td>
475 <a name="__contains__"></a>
477 <table class="details" border="1" cellpadding="3"
478 cellspacing="0" width="100%" bgcolor="white">
480 <table width="100%" cellpadding="0" cellspacing="0" border="0">
481 <tr valign="top"><td>
482 <h3 class="epydoc"><span class="sig"><span class="sig-name">__contains__</span>(<span class="sig-arg">self</span>,
483 <span class="sig-arg">name</span>)</span>
484 <br /><em class="fname">(In operator)</em>
486 </td><td align="right" valign="top"
487 ><span class="codelink"><a href="lxml.html-pysrc.html#Classes.__contains__">source code</a></span>
494 _abcoll.Container.__contains__
499 <a name="__init__"></a>
501 <table class="details" border="1" cellpadding="3"
502 cellspacing="0" width="100%" bgcolor="white">
504 <table width="100%" cellpadding="0" cellspacing="0" border="0">
505 <tr valign="top"><td>
506 <h3 class="epydoc"><span class="sig"><span class="sig-name">__init__</span>(<span class="sig-arg">self</span>,
507 <span class="sig-arg">attributes</span>)</span>
508 <br /><em class="fname">(Constructor)</em>
510 </td><td align="right" valign="top"
511 ><span class="codelink"><a href="lxml.html-pysrc.html#Classes.__init__">source code</a></span>
515 x.__init__(...) initializes x; see help(type(x)) for signature
519 <dd><em class="note">(inherited documentation)</em></dd>
524 <a name="__iter__"></a>
526 <table class="details" border="1" cellpadding="3"
527 cellspacing="0" width="100%" bgcolor="white">
529 <table width="100%" cellpadding="0" cellspacing="0" border="0">
530 <tr valign="top"><td>
531 <h3 class="epydoc"><span class="sig"><span class="sig-name">__iter__</span>(<span class="sig-arg">self</span>)</span>
533 </td><td align="right" valign="top"
534 ><span class="codelink"><a href="lxml.html-pysrc.html#Classes.__iter__">source code</a></span>
541 _abcoll.Iterable.__iter__
546 <a name="__len__"></a>
548 <table class="details" border="1" cellpadding="3"
549 cellspacing="0" width="100%" bgcolor="white">
551 <table width="100%" cellpadding="0" cellspacing="0" border="0">
552 <tr valign="top"><td>
553 <h3 class="epydoc"><span class="sig"><span class="sig-name">__len__</span>(<span class="sig-arg">self</span>)</span>
554 <br /><em class="fname">(Length operator)</em>
556 </td><td align="right" valign="top"
557 ><span class="codelink"><a href="lxml.html-pysrc.html#Classes.__len__">source code</a></span>
564 _abcoll.Sized.__len__
571 <table class="details" border="1" cellpadding="3"
572 cellspacing="0" width="100%" bgcolor="white">
574 <table width="100%" cellpadding="0" cellspacing="0" border="0">
575 <tr valign="top"><td>
576 <h3 class="epydoc"><span class="sig"><span class="sig-name">add</span>(<span class="sig-arg">self</span>,
577 <span class="sig-arg">value</span>)</span>
579 </td><td align="right" valign="top"
580 ><span class="codelink"><a href="lxml.html-pysrc.html#Classes.add">source code</a></span>
585 <p>This has no effect if the class is already present.</p>
588 _abcoll.MutableSet.add
593 <a name="discard"></a>
595 <table class="details" border="1" cellpadding="3"
596 cellspacing="0" width="100%" bgcolor="white">
598 <table width="100%" cellpadding="0" cellspacing="0" border="0">
599 <tr valign="top"><td>
600 <h3 class="epydoc"><span class="sig"><span class="sig-name">discard</span>(<span class="sig-arg">self</span>,
601 <span class="sig-arg">value</span>)</span>
603 </td><td align="right" valign="top"
604 ><span class="codelink"><a href="lxml.html-pysrc.html#Classes.discard">source code</a></span>
608 <p>Remove a class if it is currently present.</p>
609 <p>If the class is not present, do nothing.</p>
612 _abcoll.MutableSet.discard
617 <a name="remove"></a>
619 <table class="details" border="1" cellpadding="3"
620 cellspacing="0" width="100%" bgcolor="white">
622 <table width="100%" cellpadding="0" cellspacing="0" border="0">
623 <tr valign="top"><td>
624 <h3 class="epydoc"><span class="sig"><span class="sig-name">remove</span>(<span class="sig-arg">self</span>,
625 <span class="sig-arg">value</span>)</span>
627 </td><td align="right" valign="top"
628 ><span class="codelink"><a href="lxml.html-pysrc.html#Classes.remove">source code</a></span>
632 <p>Remove a class; it must currently be present.</p>
633 <p>If the class is not present, raise a KeyError.</p>
636 _abcoll.MutableSet.remove
641 <a name="toggle"></a>
643 <table class="details" border="1" cellpadding="3"
644 cellspacing="0" width="100%" bgcolor="white">
646 <table width="100%" cellpadding="0" cellspacing="0" border="0">
647 <tr valign="top"><td>
648 <h3 class="epydoc"><span class="sig"><span class="sig-name">toggle</span>(<span class="sig-arg">self</span>,
649 <span class="sig-arg">value</span>)</span>
651 </td><td align="right" valign="top"
652 ><span class="codelink"><a href="lxml.html-pysrc.html#Classes.toggle">source code</a></span>
656 <p>Add a class name if it isn't there yet, or remove it if it exists.</p>
657 <p>Returns true if the class was added (and is now enabled) and
658 false if it was removed (and is now disabled).</p>
664 <!-- ==================== NAVIGATION BAR ==================== -->
665 <table class="navbar" border="0" width="100%" cellpadding="0"
666 bgcolor="#a0c0ff" cellspacing="0">
669 <th> <a
670 href="lxml-module.html">Home</a> </th>
673 <th> <a
674 href="module-tree.html">Trees</a> </th>
677 <th> <a
678 href="identifier-index.html">Indices</a> </th>
681 <th> <a
682 href="help.html">Help</a> </th>
684 <!-- Project homepage -->
685 <th class="navbar" align="right" width="100%">
686 <table border="0" cellpadding="0" cellspacing="0">
687 <tr><th class="navbar" align="center"
688 ><a class="navbar" target="_top" href="/">lxml API</a></th>
692 <table border="0" cellpadding="0" cellspacing="0" width="100%%">
694 <td align="left" class="footer">
695 Generated by Epydoc 3.0.1
696 on Wed Jan 29 12:26:21 2020
698 <td align="right" class="footer">
699 <a target="mainFrame" href="http://epydoc.sourceforge.net"
700 >http://epydoc.sourceforge.net</a>
705 <script type="text/javascript">
707 // Private objects are initially displayed (because if
708 // javascript is turned off then we want them to be
709 // visible); but by default, we want to hide them. So hide
710 // them unless we have a cookie that says to show them.