Mercurial > genshi > genshi-test
annotate genshi/core.py @ 861:e098d29c4de1
Oops, get rid of multi source copy in `genshi.core`.
author | cmlenz |
---|---|
date | Thu, 12 Nov 2009 17:38:05 +0000 |
parents | 61d37796da98 |
children | 37fb3988647a |
rev | line source |
---|---|
860
61d37796da98
A bit of cleanup of the `Markup` Python implementation.
cmlenz
parents:
857
diff
changeset
|
1 # -*- coding: utf-8 -*- |
61d37796da98
A bit of cleanup of the `Markup` Python implementation.
cmlenz
parents:
857
diff
changeset
|
2 # |
61d37796da98
A bit of cleanup of the `Markup` Python implementation.
cmlenz
parents:
857
diff
changeset
|
3 # Copyright (C) 2006-2009 Edgewall Software |
61d37796da98
A bit of cleanup of the `Markup` Python implementation.
cmlenz
parents:
857
diff
changeset
|
4 # All rights reserved. |
61d37796da98
A bit of cleanup of the `Markup` Python implementation.
cmlenz
parents:
857
diff
changeset
|
5 # |
61d37796da98
A bit of cleanup of the `Markup` Python implementation.
cmlenz
parents:
857
diff
changeset
|
6 # This software is licensed as described in the file COPYING, which |
61d37796da98
A bit of cleanup of the `Markup` Python implementation.
cmlenz
parents:
857
diff
changeset
|
7 # you should have received as part of this distribution. The terms |
61d37796da98
A bit of cleanup of the `Markup` Python implementation.
cmlenz
parents:
857
diff
changeset
|
8 # are also available at http://genshi.edgewall.org/wiki/License. |
61d37796da98
A bit of cleanup of the `Markup` Python implementation.
cmlenz
parents:
857
diff
changeset
|
9 # |
61d37796da98
A bit of cleanup of the `Markup` Python implementation.
cmlenz
parents:
857
diff
changeset
|
10 # This software consists of voluntary contributions made by many |
61d37796da98
A bit of cleanup of the `Markup` Python implementation.
cmlenz
parents:
857
diff
changeset
|
11 # individuals. For the exact contribution history, see the revision |
61d37796da98
A bit of cleanup of the `Markup` Python implementation.
cmlenz
parents:
857
diff
changeset
|
12 # history and logs, available at http://genshi.edgewall.org/log/. |
61d37796da98
A bit of cleanup of the `Markup` Python implementation.
cmlenz
parents:
857
diff
changeset
|
13 |
61d37796da98
A bit of cleanup of the `Markup` Python implementation.
cmlenz
parents:
857
diff
changeset
|
14 """Core classes for markup processing.""" |
61d37796da98
A bit of cleanup of the `Markup` Python implementation.
cmlenz
parents:
857
diff
changeset
|
15 |
61d37796da98
A bit of cleanup of the `Markup` Python implementation.
cmlenz
parents:
857
diff
changeset
|
16 try: |
61d37796da98
A bit of cleanup of the `Markup` Python implementation.
cmlenz
parents:
857
diff
changeset
|
17 reduce # builtin in Python < 3 |
61d37796da98
A bit of cleanup of the `Markup` Python implementation.
cmlenz
parents:
857
diff
changeset
|
18 except NameError: |
61d37796da98
A bit of cleanup of the `Markup` Python implementation.
cmlenz
parents:
857
diff
changeset
|
19 from functools import reduce |
61d37796da98
A bit of cleanup of the `Markup` Python implementation.
cmlenz
parents:
857
diff
changeset
|
20 from itertools import chain |
61d37796da98
A bit of cleanup of the `Markup` Python implementation.
cmlenz
parents:
857
diff
changeset
|
21 import operator |
61d37796da98
A bit of cleanup of the `Markup` Python implementation.
cmlenz
parents:
857
diff
changeset
|
22 |
61d37796da98
A bit of cleanup of the `Markup` Python implementation.
cmlenz
parents:
857
diff
changeset
|
23 from genshi.util import plaintext, stripentities, striptags, stringrepr |
61d37796da98
A bit of cleanup of the `Markup` Python implementation.
cmlenz
parents:
857
diff
changeset
|
24 |
61d37796da98
A bit of cleanup of the `Markup` Python implementation.
cmlenz
parents:
857
diff
changeset
|
25 __all__ = ['Stream', 'Markup', 'escape', 'unescape', 'Attrs', 'Namespace', |
61d37796da98
A bit of cleanup of the `Markup` Python implementation.
cmlenz
parents:
857
diff
changeset
|
26 'QName'] |
61d37796da98
A bit of cleanup of the `Markup` Python implementation.
cmlenz
parents:
857
diff
changeset
|
27 __docformat__ = 'restructuredtext en' |
61d37796da98
A bit of cleanup of the `Markup` Python implementation.
cmlenz
parents:
857
diff
changeset
|
28 |
61d37796da98
A bit of cleanup of the `Markup` Python implementation.
cmlenz
parents:
857
diff
changeset
|
29 |
61d37796da98
A bit of cleanup of the `Markup` Python implementation.
cmlenz
parents:
857
diff
changeset
|
30 class StreamEventKind(str): |
61d37796da98
A bit of cleanup of the `Markup` Python implementation.
cmlenz
parents:
857
diff
changeset
|
31 """A kind of event on a markup stream.""" |
61d37796da98
A bit of cleanup of the `Markup` Python implementation.
cmlenz
parents:
857
diff
changeset
|
32 __slots__ = [] |
61d37796da98
A bit of cleanup of the `Markup` Python implementation.
cmlenz
parents:
857
diff
changeset
|
33 _instances = {} |
61d37796da98
A bit of cleanup of the `Markup` Python implementation.
cmlenz
parents:
857
diff
changeset
|
34 |
61d37796da98
A bit of cleanup of the `Markup` Python implementation.
cmlenz
parents:
857
diff
changeset
|
35 def __new__(cls, val): |
61d37796da98
A bit of cleanup of the `Markup` Python implementation.
cmlenz
parents:
857
diff
changeset
|
36 return cls._instances.setdefault(val, str.__new__(cls, val)) |
61d37796da98
A bit of cleanup of the `Markup` Python implementation.
cmlenz
parents:
857
diff
changeset
|
37 |
61d37796da98
A bit of cleanup of the `Markup` Python implementation.
cmlenz
parents:
857
diff
changeset
|
38 |
61d37796da98
A bit of cleanup of the `Markup` Python implementation.
cmlenz
parents:
857
diff
changeset
|
39 class Stream(object): |
61d37796da98
A bit of cleanup of the `Markup` Python implementation.
cmlenz
parents:
857
diff
changeset
|
40 """Represents a stream of markup events. |
61d37796da98
A bit of cleanup of the `Markup` Python implementation.
cmlenz
parents:
857
diff
changeset
|
41 |
61d37796da98
A bit of cleanup of the `Markup` Python implementation.
cmlenz
parents:
857
diff
changeset
|
42 This class is basically an iterator over the events. |
61d37796da98
A bit of cleanup of the `Markup` Python implementation.
cmlenz
parents:
857
diff
changeset
|
43 |
61d37796da98
A bit of cleanup of the `Markup` Python implementation.
cmlenz
parents:
857
diff
changeset
|
44 Stream events are tuples of the form:: |
61d37796da98
A bit of cleanup of the `Markup` Python implementation.
cmlenz
parents:
857
diff
changeset
|
45 |
61d37796da98
A bit of cleanup of the `Markup` Python implementation.
cmlenz
parents:
857
diff
changeset
|
46 (kind, data, position) |
61d37796da98
A bit of cleanup of the `Markup` Python implementation.
cmlenz
parents:
857
diff
changeset
|
47 |
61d37796da98
A bit of cleanup of the `Markup` Python implementation.
cmlenz
parents:
857
diff
changeset
|
48 where ``kind`` is the event kind (such as `START`, `END`, `TEXT`, etc), |
61d37796da98
A bit of cleanup of the `Markup` Python implementation.
cmlenz
parents:
857
diff
changeset
|
49 ``data`` depends on the kind of event, and ``position`` is a |
61d37796da98
A bit of cleanup of the `Markup` Python implementation.
cmlenz
parents:
857
diff
changeset
|
50 ``(filename, line, offset)`` tuple that contains the location of the |
61d37796da98
A bit of cleanup of the `Markup` Python implementation.
cmlenz
parents:
857
diff
changeset
|
51 original element or text in the input. If the original location is unknown, |
61d37796da98
A bit of cleanup of the `Markup` Python implementation.
cmlenz
parents:
857
diff
changeset
|
52 ``position`` is ``(None, -1, -1)``. |
61d37796da98
A bit of cleanup of the `Markup` Python implementation.
cmlenz
parents:
857
diff
changeset
|
53 |
61d37796da98
A bit of cleanup of the `Markup` Python implementation.
cmlenz
parents:
857
diff
changeset
|
54 Also provided are ways to serialize the stream to text. The `serialize()` |
61d37796da98
A bit of cleanup of the `Markup` Python implementation.
cmlenz
parents:
857
diff
changeset
|
55 method will return an iterator over generated strings, while `render()` |
61d37796da98
A bit of cleanup of the `Markup` Python implementation.
cmlenz
parents:
857
diff
changeset
|
56 returns the complete generated text at once. Both accept various parameters |
61d37796da98
A bit of cleanup of the `Markup` Python implementation.
cmlenz
parents:
857
diff
changeset
|
57 that impact the way the stream is serialized. |
61d37796da98
A bit of cleanup of the `Markup` Python implementation.
cmlenz
parents:
857
diff
changeset
|
58 """ |
61d37796da98
A bit of cleanup of the `Markup` Python implementation.
cmlenz
parents:
857
diff
changeset
|
59 __slots__ = ['events', 'serializer'] |
61d37796da98
A bit of cleanup of the `Markup` Python implementation.
cmlenz
parents:
857
diff
changeset
|
60 |
61d37796da98
A bit of cleanup of the `Markup` Python implementation.
cmlenz
parents:
857
diff
changeset
|
61 START = StreamEventKind('START') #: a start tag |
61d37796da98
A bit of cleanup of the `Markup` Python implementation.
cmlenz
parents:
857
diff
changeset
|
62 END = StreamEventKind('END') #: an end tag |
61d37796da98
A bit of cleanup of the `Markup` Python implementation.
cmlenz
parents:
857
diff
changeset
|
63 TEXT = StreamEventKind('TEXT') #: literal text |
61d37796da98
A bit of cleanup of the `Markup` Python implementation.
cmlenz
parents:
857
diff
changeset
|
64 XML_DECL = StreamEventKind('XML_DECL') #: XML declaration |
61d37796da98
A bit of cleanup of the `Markup` Python implementation.
cmlenz
parents:
857
diff
changeset
|
65 DOCTYPE = StreamEventKind('DOCTYPE') #: doctype declaration |
61d37796da98
A bit of cleanup of the `Markup` Python implementation.
cmlenz
parents:
857
diff
changeset
|
66 START_NS = StreamEventKind('START_NS') #: start namespace mapping |
61d37796da98
A bit of cleanup of the `Markup` Python implementation.
cmlenz
parents:
857
diff
changeset
|
67 END_NS = StreamEventKind('END_NS') #: end namespace mapping |
61d37796da98
A bit of cleanup of the `Markup` Python implementation.
cmlenz
parents:
857
diff
changeset
|
68 START_CDATA = StreamEventKind('START_CDATA') #: start CDATA section |
61d37796da98
A bit of cleanup of the `Markup` Python implementation.
cmlenz
parents:
857
diff
changeset
|
69 END_CDATA = StreamEventKind('END_CDATA') #: end CDATA section |
61d37796da98
A bit of cleanup of the `Markup` Python implementation.
cmlenz
parents:
857
diff
changeset
|
70 PI = StreamEventKind('PI') #: processing instruction |
61d37796da98
A bit of cleanup of the `Markup` Python implementation.
cmlenz
parents:
857
diff
changeset
|
71 COMMENT = StreamEventKind('COMMENT') #: comment |
61d37796da98
A bit of cleanup of the `Markup` Python implementation.
cmlenz
parents:
857
diff
changeset
|
72 |
61d37796da98
A bit of cleanup of the `Markup` Python implementation.
cmlenz
parents:
857
diff
changeset
|
73 def __init__(self, events, serializer=None): |
61d37796da98
A bit of cleanup of the `Markup` Python implementation.
cmlenz
parents:
857
diff
changeset
|
74 """Initialize the stream with a sequence of markup events. |
61d37796da98
A bit of cleanup of the `Markup` Python implementation.
cmlenz
parents:
857
diff
changeset
|
75 |
61d37796da98
A bit of cleanup of the `Markup` Python implementation.
cmlenz
parents:
857
diff
changeset
|
76 :param events: a sequence or iterable providing the events |
61d37796da98
A bit of cleanup of the `Markup` Python implementation.
cmlenz
parents:
857
diff
changeset
|
77 :param serializer: the default serialization method to use for this |
61d37796da98
A bit of cleanup of the `Markup` Python implementation.
cmlenz
parents:
857
diff
changeset
|
78 stream |
61d37796da98
A bit of cleanup of the `Markup` Python implementation.
cmlenz
parents:
857
diff
changeset
|
79 |
61d37796da98
A bit of cleanup of the `Markup` Python implementation.
cmlenz
parents:
857
diff
changeset
|
80 :note: Changed in 0.5: added the `serializer` argument |
61d37796da98
A bit of cleanup of the `Markup` Python implementation.
cmlenz
parents:
857
diff
changeset
|
81 """ |
61d37796da98
A bit of cleanup of the `Markup` Python implementation.
cmlenz
parents:
857
diff
changeset
|
82 self.events = events #: The underlying iterable producing the events |
61d37796da98
A bit of cleanup of the `Markup` Python implementation.
cmlenz
parents:
857
diff
changeset
|
83 self.serializer = serializer #: The default serializion method |
61d37796da98
A bit of cleanup of the `Markup` Python implementation.
cmlenz
parents:
857
diff
changeset
|
84 |
61d37796da98
A bit of cleanup of the `Markup` Python implementation.
cmlenz
parents:
857
diff
changeset
|
85 def __iter__(self): |
61d37796da98
A bit of cleanup of the `Markup` Python implementation.
cmlenz
parents:
857
diff
changeset
|
86 return iter(self.events) |
61d37796da98
A bit of cleanup of the `Markup` Python implementation.
cmlenz
parents:
857
diff
changeset
|
87 |
61d37796da98
A bit of cleanup of the `Markup` Python implementation.
cmlenz
parents:
857
diff
changeset
|
88 def __or__(self, function): |
61d37796da98
A bit of cleanup of the `Markup` Python implementation.
cmlenz
parents:
857
diff
changeset
|
89 """Override the "bitwise or" operator to apply filters or serializers |
61d37796da98
A bit of cleanup of the `Markup` Python implementation.
cmlenz
parents:
857
diff
changeset
|
90 to the stream, providing a syntax similar to pipes on Unix shells. |
61d37796da98
A bit of cleanup of the `Markup` Python implementation.
cmlenz
parents:
857
diff
changeset
|
91 |
61d37796da98
A bit of cleanup of the `Markup` Python implementation.
cmlenz
parents:
857
diff
changeset
|
92 Assume the following stream produced by the `HTML` function: |
61d37796da98
A bit of cleanup of the `Markup` Python implementation.
cmlenz
parents:
857
diff
changeset
|
93 |
61d37796da98
A bit of cleanup of the `Markup` Python implementation.
cmlenz
parents:
857
diff
changeset
|
94 >>> from genshi.input import HTML |
61d37796da98
A bit of cleanup of the `Markup` Python implementation.
cmlenz
parents:
857
diff
changeset
|
95 >>> html = HTML('''<p onclick="alert('Whoa')">Hello, world!</p>''') |
61d37796da98
A bit of cleanup of the `Markup` Python implementation.
cmlenz
parents:
857
diff
changeset
|
96 >>> print(html) |
61d37796da98
A bit of cleanup of the `Markup` Python implementation.
cmlenz
parents:
857
diff
changeset
|
97 <p onclick="alert('Whoa')">Hello, world!</p> |
61d37796da98
A bit of cleanup of the `Markup` Python implementation.
cmlenz
parents:
857
diff
changeset
|
98 |
61d37796da98
A bit of cleanup of the `Markup` Python implementation.
cmlenz
parents:
857
diff
changeset
|
99 A filter such as the HTML sanitizer can be applied to that stream using |
61d37796da98
A bit of cleanup of the `Markup` Python implementation.
cmlenz
parents:
857
diff
changeset
|
100 the pipe notation as follows: |
61d37796da98
A bit of cleanup of the `Markup` Python implementation.
cmlenz
parents:
857
diff
changeset
|
101 |
61d37796da98
A bit of cleanup of the `Markup` Python implementation.
cmlenz
parents:
857
diff
changeset
|
102 >>> from genshi.filters import HTMLSanitizer |
61d37796da98
A bit of cleanup of the `Markup` Python implementation.
cmlenz
parents:
857
diff
changeset
|
103 >>> sanitizer = HTMLSanitizer() |
61d37796da98
A bit of cleanup of the `Markup` Python implementation.
cmlenz
parents:
857
diff
changeset
|
104 >>> print(html | sanitizer) |
61d37796da98
A bit of cleanup of the `Markup` Python implementation.
cmlenz
parents:
857
diff
changeset
|
105 <p>Hello, world!</p> |
61d37796da98
A bit of cleanup of the `Markup` Python implementation.
cmlenz
parents:
857
diff
changeset
|
106 |
61d37796da98
A bit of cleanup of the `Markup` Python implementation.
cmlenz
parents:
857
diff
changeset
|
107 Filters can be any function that accepts and produces a stream (where |
61d37796da98
A bit of cleanup of the `Markup` Python implementation.
cmlenz
parents:
857
diff
changeset
|
108 a stream is anything that iterates over events): |
61d37796da98
A bit of cleanup of the `Markup` Python implementation.
cmlenz
parents:
857
diff
changeset
|
109 |
61d37796da98
A bit of cleanup of the `Markup` Python implementation.
cmlenz
parents:
857
diff
changeset
|
110 >>> def uppercase(stream): |
61d37796da98
A bit of cleanup of the `Markup` Python implementation.
cmlenz
parents:
857
diff
changeset
|
111 ... for kind, data, pos in stream: |
61d37796da98
A bit of cleanup of the `Markup` Python implementation.
cmlenz
parents:
857
diff
changeset
|
112 ... if kind is TEXT: |
61d37796da98
A bit of cleanup of the `Markup` Python implementation.
cmlenz
parents:
857
diff
changeset
|
113 ... data = data.upper() |
61d37796da98
A bit of cleanup of the `Markup` Python implementation.
cmlenz
parents:
857
diff
changeset
|
114 ... yield kind, data, pos |
61d37796da98
A bit of cleanup of the `Markup` Python implementation.
cmlenz
parents:
857
diff
changeset
|
115 >>> print(html | sanitizer | uppercase) |
61d37796da98
A bit of cleanup of the `Markup` Python implementation.
cmlenz
parents:
857
diff
changeset
|
116 <p>HELLO, WORLD!</p> |
61d37796da98
A bit of cleanup of the `Markup` Python implementation.
cmlenz
parents:
857
diff
changeset
|
117 |
61d37796da98
A bit of cleanup of the `Markup` Python implementation.
cmlenz
parents:
857
diff
changeset
|
118 Serializers can also be used with this notation: |
61d37796da98
A bit of cleanup of the `Markup` Python implementation.
cmlenz
parents:
857
diff
changeset
|
119 |
61d37796da98
A bit of cleanup of the `Markup` Python implementation.
cmlenz
parents:
857
diff
changeset
|
120 >>> from genshi.output import TextSerializer |
61d37796da98
A bit of cleanup of the `Markup` Python implementation.
cmlenz
parents:
857
diff
changeset
|
121 >>> output = TextSerializer() |
61d37796da98
A bit of cleanup of the `Markup` Python implementation.
cmlenz
parents:
857
diff
changeset
|
122 >>> print(html | sanitizer | uppercase | output) |
61d37796da98
A bit of cleanup of the `Markup` Python implementation.
cmlenz
parents:
857
diff
changeset
|
123 HELLO, WORLD! |
61d37796da98
A bit of cleanup of the `Markup` Python implementation.
cmlenz
parents:
857
diff
changeset
|
124 |
61d37796da98
A bit of cleanup of the `Markup` Python implementation.
cmlenz
parents:
857
diff
changeset
|
125 Commonly, serializers should be used at the end of the "pipeline"; |
61d37796da98
A bit of cleanup of the `Markup` Python implementation.
cmlenz
parents:
857
diff
changeset
|
126 using them somewhere in the middle may produce unexpected results. |
61d37796da98
A bit of cleanup of the `Markup` Python implementation.
cmlenz
parents:
857
diff
changeset
|
127 |
61d37796da98
A bit of cleanup of the `Markup` Python implementation.
cmlenz
parents:
857
diff
changeset
|
128 :param function: the callable object that should be applied as a filter |
61d37796da98
A bit of cleanup of the `Markup` Python implementation.
cmlenz
parents:
857
diff
changeset
|
129 :return: the filtered stream |
61d37796da98
A bit of cleanup of the `Markup` Python implementation.
cmlenz
parents:
857
diff
changeset
|
130 :rtype: `Stream` |
61d37796da98
A bit of cleanup of the `Markup` Python implementation.
cmlenz
parents:
857
diff
changeset
|
131 """ |
61d37796da98
A bit of cleanup of the `Markup` Python implementation.
cmlenz
parents:
857
diff
changeset
|
132 return Stream(_ensure(function(self)), serializer=self.serializer) |
61d37796da98
A bit of cleanup of the `Markup` Python implementation.
cmlenz
parents:
857
diff
changeset
|
133 |
61d37796da98
A bit of cleanup of the `Markup` Python implementation.
cmlenz
parents:
857
diff
changeset
|
134 def filter(self, *filters): |
61d37796da98
A bit of cleanup of the `Markup` Python implementation.
cmlenz
parents:
857
diff
changeset
|
135 """Apply filters to the stream. |
61d37796da98
A bit of cleanup of the `Markup` Python implementation.
cmlenz
parents:
857
diff
changeset
|
136 |
61d37796da98
A bit of cleanup of the `Markup` Python implementation.
cmlenz
parents:
857
diff
changeset
|
137 This method returns a new stream with the given filters applied. The |
61d37796da98
A bit of cleanup of the `Markup` Python implementation.
cmlenz
parents:
857
diff
changeset
|
138 filters must be callables that accept the stream object as parameter, |
61d37796da98
A bit of cleanup of the `Markup` Python implementation.
cmlenz
parents:
857
diff
changeset
|
139 and return the filtered stream. |
61d37796da98
A bit of cleanup of the `Markup` Python implementation.
cmlenz
parents:
857
diff
changeset
|
140 |
61d37796da98
A bit of cleanup of the `Markup` Python implementation.
cmlenz
parents:
857
diff
changeset
|
141 The call:: |
61d37796da98
A bit of cleanup of the `Markup` Python implementation.
cmlenz
parents:
857
diff
changeset
|
142 |
61d37796da98
A bit of cleanup of the `Markup` Python implementation.
cmlenz
parents:
857
diff
changeset
|
143 stream.filter(filter1, filter2) |
61d37796da98
A bit of cleanup of the `Markup` Python implementation.
cmlenz
parents:
857
diff
changeset
|
144 |
61d37796da98
A bit of cleanup of the `Markup` Python implementation.
cmlenz
parents:
857
diff
changeset
|
145 is equivalent to:: |
61d37796da98
A bit of cleanup of the `Markup` Python implementation.
cmlenz
parents:
857
diff
changeset
|
146 |
61d37796da98
A bit of cleanup of the `Markup` Python implementation.
cmlenz
parents:
857
diff
changeset
|
147 stream | filter1 | filter2 |
61d37796da98
A bit of cleanup of the `Markup` Python implementation.
cmlenz
parents:
857
diff
changeset
|
148 |
61d37796da98
A bit of cleanup of the `Markup` Python implementation.
cmlenz
parents:
857
diff
changeset
|
149 :param filters: one or more callable objects that should be applied as |
61d37796da98
A bit of cleanup of the `Markup` Python implementation.
cmlenz
parents:
857
diff
changeset
|
150 filters |
61d37796da98
A bit of cleanup of the `Markup` Python implementation.
cmlenz
parents:
857
diff
changeset
|
151 :return: the filtered stream |
61d37796da98
A bit of cleanup of the `Markup` Python implementation.
cmlenz
parents:
857
diff
changeset
|
152 :rtype: `Stream` |
61d37796da98
A bit of cleanup of the `Markup` Python implementation.
cmlenz
parents:
857
diff
changeset
|
153 """ |
61d37796da98
A bit of cleanup of the `Markup` Python implementation.
cmlenz
parents:
857
diff
changeset
|
154 return reduce(operator.or_, (self,) + filters) |
61d37796da98
A bit of cleanup of the `Markup` Python implementation.
cmlenz
parents:
857
diff
changeset
|
155 |
61d37796da98
A bit of cleanup of the `Markup` Python implementation.
cmlenz
parents:
857
diff
changeset
|
156 def render(self, method=None, encoding='utf-8', out=None, **kwargs): |
61d37796da98
A bit of cleanup of the `Markup` Python implementation.
cmlenz
parents:
857
diff
changeset
|
157 """Return a string representation of the stream. |
61d37796da98
A bit of cleanup of the `Markup` Python implementation.
cmlenz
parents:
857
diff
changeset
|
158 |
61d37796da98
A bit of cleanup of the `Markup` Python implementation.
cmlenz
parents:
857
diff
changeset
|
159 Any additional keyword arguments are passed to the serializer, and thus |
61d37796da98
A bit of cleanup of the `Markup` Python implementation.
cmlenz
parents:
857
diff
changeset
|
160 depend on the `method` parameter value. |
61d37796da98
A bit of cleanup of the `Markup` Python implementation.
cmlenz
parents:
857
diff
changeset
|
161 |
61d37796da98
A bit of cleanup of the `Markup` Python implementation.
cmlenz
parents:
857
diff
changeset
|
162 :param method: determines how the stream is serialized; can be either |
61d37796da98
A bit of cleanup of the `Markup` Python implementation.
cmlenz
parents:
857
diff
changeset
|
163 "xml", "xhtml", "html", "text", or a custom serializer |
61d37796da98
A bit of cleanup of the `Markup` Python implementation.
cmlenz
parents:
857
diff
changeset
|
164 class; if `None`, the default serialization method of |
61d37796da98
A bit of cleanup of the `Markup` Python implementation.
cmlenz
parents:
857
diff
changeset
|
165 the stream is used |
61d37796da98
A bit of cleanup of the `Markup` Python implementation.
cmlenz
parents:
857
diff
changeset
|
166 :param encoding: how the output string should be encoded; if set to |
61d37796da98
A bit of cleanup of the `Markup` Python implementation.
cmlenz
parents:
857
diff
changeset
|
167 `None`, this method returns a `unicode` object |
61d37796da98
A bit of cleanup of the `Markup` Python implementation.
cmlenz
parents:
857
diff
changeset
|
168 :param out: a file-like object that the output should be written to |
61d37796da98
A bit of cleanup of the `Markup` Python implementation.
cmlenz
parents:
857
diff
changeset
|
169 instead of being returned as one big string; note that if |
61d37796da98
A bit of cleanup of the `Markup` Python implementation.
cmlenz
parents:
857
diff
changeset
|
170 this is a file or socket (or similar), the `encoding` must |
61d37796da98
A bit of cleanup of the `Markup` Python implementation.
cmlenz
parents:
857
diff
changeset
|
171 not be `None` (that is, the output must be encoded) |
61d37796da98
A bit of cleanup of the `Markup` Python implementation.
cmlenz
parents:
857
diff
changeset
|
172 :return: a `str` or `unicode` object (depending on the `encoding` |
61d37796da98
A bit of cleanup of the `Markup` Python implementation.
cmlenz
parents:
857
diff
changeset
|
173 parameter), or `None` if the `out` parameter is provided |
61d37796da98
A bit of cleanup of the `Markup` Python implementation.
cmlenz
parents:
857
diff
changeset
|
174 :rtype: `basestring` |
61d37796da98
A bit of cleanup of the `Markup` Python implementation.
cmlenz
parents:
857
diff
changeset
|
175 |
61d37796da98
A bit of cleanup of the `Markup` Python implementation.
cmlenz
parents:
857
diff
changeset
|
176 :see: XMLSerializer, XHTMLSerializer, HTMLSerializer, TextSerializer |
61d37796da98
A bit of cleanup of the `Markup` Python implementation.
cmlenz
parents:
857
diff
changeset
|
177 :note: Changed in 0.5: added the `out` parameter |
61d37796da98
A bit of cleanup of the `Markup` Python implementation.
cmlenz
parents:
857
diff
changeset
|
178 """ |
61d37796da98
A bit of cleanup of the `Markup` Python implementation.
cmlenz
parents:
857
diff
changeset
|
179 from genshi.output import encode |
61d37796da98
A bit of cleanup of the `Markup` Python implementation.
cmlenz
parents:
857
diff
changeset
|
180 if method is None: |
61d37796da98
A bit of cleanup of the `Markup` Python implementation.
cmlenz
parents:
857
diff
changeset
|
181 method = self.serializer or 'xml' |
61d37796da98
A bit of cleanup of the `Markup` Python implementation.
cmlenz
parents:
857
diff
changeset
|
182 generator = self.serialize(method=method, **kwargs) |
61d37796da98
A bit of cleanup of the `Markup` Python implementation.
cmlenz
parents:
857
diff
changeset
|
183 return encode(generator, method=method, encoding=encoding, out=out) |
61d37796da98
A bit of cleanup of the `Markup` Python implementation.
cmlenz
parents:
857
diff
changeset
|
184 |
61d37796da98
A bit of cleanup of the `Markup` Python implementation.
cmlenz
parents:
857
diff
changeset
|
185 def select(self, path, namespaces=None, variables=None): |
61d37796da98
A bit of cleanup of the `Markup` Python implementation.
cmlenz
parents:
857
diff
changeset
|
186 """Return a new stream that contains the events matching the given |
61d37796da98
A bit of cleanup of the `Markup` Python implementation.
cmlenz
parents:
857
diff
changeset
|
187 XPath expression. |
61d37796da98
A bit of cleanup of the `Markup` Python implementation.
cmlenz
parents:
857
diff
changeset
|
188 |
61d37796da98
A bit of cleanup of the `Markup` Python implementation.
cmlenz
parents:
857
diff
changeset
|
189 >>> from genshi import HTML |
61d37796da98
A bit of cleanup of the `Markup` Python implementation.
cmlenz
parents:
857
diff
changeset
|
190 >>> stream = HTML('<doc><elem>foo</elem><elem>bar</elem></doc>') |
61d37796da98
A bit of cleanup of the `Markup` Python implementation.
cmlenz
parents:
857
diff
changeset
|
191 >>> print(stream.select('elem')) |
61d37796da98
A bit of cleanup of the `Markup` Python implementation.
cmlenz
parents:
857
diff
changeset
|
192 <elem>foo</elem><elem>bar</elem> |
61d37796da98
A bit of cleanup of the `Markup` Python implementation.
cmlenz
parents:
857
diff
changeset
|
193 >>> print(stream.select('elem/text()')) |
61d37796da98
A bit of cleanup of the `Markup` Python implementation.
cmlenz
parents:
857
diff
changeset
|
194 foobar |
61d37796da98
A bit of cleanup of the `Markup` Python implementation.
cmlenz
parents:
857
diff
changeset
|
195 |
61d37796da98
A bit of cleanup of the `Markup` Python implementation.
cmlenz
parents:
857
diff
changeset
|
196 Note that the outermost element of the stream becomes the *context |
61d37796da98
A bit of cleanup of the `Markup` Python implementation.
cmlenz
parents:
857
diff
changeset
|
197 node* for the XPath test. That means that the expression "doc" would |
61d37796da98
A bit of cleanup of the `Markup` Python implementation.
cmlenz
parents:
857
diff
changeset
|
198 not match anything in the example above, because it only tests against |
61d37796da98
A bit of cleanup of the `Markup` Python implementation.
cmlenz
parents:
857
diff
changeset
|
199 child elements of the outermost element: |
61d37796da98
A bit of cleanup of the `Markup` Python implementation.
cmlenz
parents:
857
diff
changeset
|
200 |
61d37796da98
A bit of cleanup of the `Markup` Python implementation.
cmlenz
parents:
857
diff
changeset
|
201 >>> print(stream.select('doc')) |
61d37796da98
A bit of cleanup of the `Markup` Python implementation.
cmlenz
parents:
857
diff
changeset
|
202 <BLANKLINE> |
61d37796da98
A bit of cleanup of the `Markup` Python implementation.
cmlenz
parents:
857
diff
changeset
|
203 |
61d37796da98
A bit of cleanup of the `Markup` Python implementation.
cmlenz
parents:
857
diff
changeset
|
204 You can use the "." expression to match the context node itself |
61d37796da98
A bit of cleanup of the `Markup` Python implementation.
cmlenz
parents:
857
diff
changeset
|
205 (although that usually makes little sense): |
61d37796da98
A bit of cleanup of the `Markup` Python implementation.
cmlenz
parents:
857
diff
changeset
|
206 |
61d37796da98
A bit of cleanup of the `Markup` Python implementation.
cmlenz
parents:
857
diff
changeset
|
207 >>> print(stream.select('.')) |
61d37796da98
A bit of cleanup of the `Markup` Python implementation.
cmlenz
parents:
857
diff
changeset
|
208 <doc><elem>foo</elem><elem>bar</elem></doc> |
61d37796da98
A bit of cleanup of the `Markup` Python implementation.
cmlenz
parents:
857
diff
changeset
|
209 |
61d37796da98
A bit of cleanup of the `Markup` Python implementation.
cmlenz
parents:
857
diff
changeset
|
210 :param path: a string containing the XPath expression |
61d37796da98
A bit of cleanup of the `Markup` Python implementation.
cmlenz
parents:
857
diff
changeset
|
211 :param namespaces: mapping of namespace prefixes used in the path |
61d37796da98
A bit of cleanup of the `Markup` Python implementation.
cmlenz
parents:
857
diff
changeset
|
212 :param variables: mapping of variable names to values |
61d37796da98
A bit of cleanup of the `Markup` Python implementation.
cmlenz
parents:
857
diff
changeset
|
213 :return: the selected substream |
61d37796da98
A bit of cleanup of the `Markup` Python implementation.
cmlenz
parents:
857
diff
changeset
|
214 :rtype: `Stream` |
61d37796da98
A bit of cleanup of the `Markup` Python implementation.
cmlenz
parents:
857
diff
changeset
|
215 :raises PathSyntaxError: if the given path expression is invalid or not |
61d37796da98
A bit of cleanup of the `Markup` Python implementation.
cmlenz
parents:
857
diff
changeset
|
216 supported |
61d37796da98
A bit of cleanup of the `Markup` Python implementation.
cmlenz
parents:
857
diff
changeset
|
217 """ |
61d37796da98
A bit of cleanup of the `Markup` Python implementation.
cmlenz
parents:
857
diff
changeset
|
218 from genshi.path import Path |
61d37796da98
A bit of cleanup of the `Markup` Python implementation.
cmlenz
parents:
857
diff
changeset
|
219 return Path(path).select(self, namespaces, variables) |
61d37796da98
A bit of cleanup of the `Markup` Python implementation.
cmlenz
parents:
857
diff
changeset
|
220 |
61d37796da98
A bit of cleanup of the `Markup` Python implementation.
cmlenz
parents:
857
diff
changeset
|
221 def serialize(self, method='xml', **kwargs): |
61d37796da98
A bit of cleanup of the `Markup` Python implementation.
cmlenz
parents:
857
diff
changeset
|
222 """Generate strings corresponding to a specific serialization of the |
61d37796da98
A bit of cleanup of the `Markup` Python implementation.
cmlenz
parents:
857
diff
changeset
|
223 stream. |
61d37796da98
A bit of cleanup of the `Markup` Python implementation.
cmlenz
parents:
857
diff
changeset
|
224 |
61d37796da98
A bit of cleanup of the `Markup` Python implementation.
cmlenz
parents:
857
diff
changeset
|
225 Unlike the `render()` method, this method is a generator that returns |
61d37796da98
A bit of cleanup of the `Markup` Python implementation.
cmlenz
parents:
857
diff
changeset
|
226 the serialized output incrementally, as opposed to returning a single |
61d37796da98
A bit of cleanup of the `Markup` Python implementation.
cmlenz
parents:
857
diff
changeset
|
227 string. |
61d37796da98
A bit of cleanup of the `Markup` Python implementation.
cmlenz
parents:
857
diff
changeset
|
228 |
61d37796da98
A bit of cleanup of the `Markup` Python implementation.
cmlenz
parents:
857
diff
changeset
|
229 Any additional keyword arguments are passed to the serializer, and thus |
61d37796da98
A bit of cleanup of the `Markup` Python implementation.
cmlenz
parents:
857
diff
changeset
|
230 depend on the `method` parameter value. |
61d37796da98
A bit of cleanup of the `Markup` Python implementation.
cmlenz
parents:
857
diff
changeset
|
231 |
61d37796da98
A bit of cleanup of the `Markup` Python implementation.
cmlenz
parents:
857
diff
changeset
|
232 :param method: determines how the stream is serialized; can be either |
61d37796da98
A bit of cleanup of the `Markup` Python implementation.
cmlenz
parents:
857
diff
changeset
|
233 "xml", "xhtml", "html", "text", or a custom serializer |
61d37796da98
A bit of cleanup of the `Markup` Python implementation.
cmlenz
parents:
857
diff
changeset
|
234 class; if `None`, the default serialization method of |
61d37796da98
A bit of cleanup of the `Markup` Python implementation.
cmlenz
parents:
857
diff
changeset
|
235 the stream is used |
61d37796da98
A bit of cleanup of the `Markup` Python implementation.
cmlenz
parents:
857
diff
changeset
|
236 :return: an iterator over the serialization results (`Markup` or |
61d37796da98
A bit of cleanup of the `Markup` Python implementation.
cmlenz
parents:
857
diff
changeset
|
237 `unicode` objects, depending on the serialization method) |
61d37796da98
A bit of cleanup of the `Markup` Python implementation.
cmlenz
parents:
857
diff
changeset
|
238 :rtype: ``iterator`` |
61d37796da98
A bit of cleanup of the `Markup` Python implementation.
cmlenz
parents:
857
diff
changeset
|
239 :see: XMLSerializer, XHTMLSerializer, HTMLSerializer, TextSerializer |
61d37796da98
A bit of cleanup of the `Markup` Python implementation.
cmlenz
parents:
857
diff
changeset
|
240 """ |
61d37796da98
A bit of cleanup of the `Markup` Python implementation.
cmlenz
parents:
857
diff
changeset
|
241 from genshi.output import get_serializer |
61d37796da98
A bit of cleanup of the `Markup` Python implementation.
cmlenz
parents:
857
diff
changeset
|
242 if method is None: |
61d37796da98
A bit of cleanup of the `Markup` Python implementation.
cmlenz
parents:
857
diff
changeset
|
243 method = self.serializer or 'xml' |
61d37796da98
A bit of cleanup of the `Markup` Python implementation.
cmlenz
parents:
857
diff
changeset
|
244 return get_serializer(method, **kwargs)(_ensure(self)) |
61d37796da98
A bit of cleanup of the `Markup` Python implementation.
cmlenz
parents:
857
diff
changeset
|
245 |
61d37796da98
A bit of cleanup of the `Markup` Python implementation.
cmlenz
parents:
857
diff
changeset
|
246 def __str__(self): |
61d37796da98
A bit of cleanup of the `Markup` Python implementation.
cmlenz
parents:
857
diff
changeset
|
247 return self.render() |
61d37796da98
A bit of cleanup of the `Markup` Python implementation.
cmlenz
parents:
857
diff
changeset
|
248 |
61d37796da98
A bit of cleanup of the `Markup` Python implementation.
cmlenz
parents:
857
diff
changeset
|
249 def __unicode__(self): |
61d37796da98
A bit of cleanup of the `Markup` Python implementation.
cmlenz
parents:
857
diff
changeset
|
250 return self.render(encoding=None) |
61d37796da98
A bit of cleanup of the `Markup` Python implementation.
cmlenz
parents:
857
diff
changeset
|
251 |
61d37796da98
A bit of cleanup of the `Markup` Python implementation.
cmlenz
parents:
857
diff
changeset
|
252 def __html__(self): |
61d37796da98
A bit of cleanup of the `Markup` Python implementation.
cmlenz
parents:
857
diff
changeset
|
253 return self |
61d37796da98
A bit of cleanup of the `Markup` Python implementation.
cmlenz
parents:
857
diff
changeset
|
254 |
61d37796da98
A bit of cleanup of the `Markup` Python implementation.
cmlenz
parents:
857
diff
changeset
|
255 |
61d37796da98
A bit of cleanup of the `Markup` Python implementation.
cmlenz
parents:
857
diff
changeset
|
256 START = Stream.START |
61d37796da98
A bit of cleanup of the `Markup` Python implementation.
cmlenz
parents:
857
diff
changeset
|
257 END = Stream.END |
61d37796da98
A bit of cleanup of the `Markup` Python implementation.
cmlenz
parents:
857
diff
changeset
|
258 TEXT = Stream.TEXT |
61d37796da98
A bit of cleanup of the `Markup` Python implementation.
cmlenz
parents:
857
diff
changeset
|
259 XML_DECL = Stream.XML_DECL |
61d37796da98
A bit of cleanup of the `Markup` Python implementation.
cmlenz
parents:
857
diff
changeset
|
260 DOCTYPE = Stream.DOCTYPE |
61d37796da98
A bit of cleanup of the `Markup` Python implementation.
cmlenz
parents:
857
diff
changeset
|
261 START_NS = Stream.START_NS |
61d37796da98
A bit of cleanup of the `Markup` Python implementation.
cmlenz
parents:
857
diff
changeset
|
262 END_NS = Stream.END_NS |
61d37796da98
A bit of cleanup of the `Markup` Python implementation.
cmlenz
parents:
857
diff
changeset
|
263 START_CDATA = Stream.START_CDATA |
61d37796da98
A bit of cleanup of the `Markup` Python implementation.
cmlenz
parents:
857
diff
changeset
|
264 END_CDATA = Stream.END_CDATA |
61d37796da98
A bit of cleanup of the `Markup` Python implementation.
cmlenz
parents:
857
diff
changeset
|
265 PI = Stream.PI |
61d37796da98
A bit of cleanup of the `Markup` Python implementation.
cmlenz
parents:
857
diff
changeset
|
266 COMMENT = Stream.COMMENT |
61d37796da98
A bit of cleanup of the `Markup` Python implementation.
cmlenz
parents:
857
diff
changeset
|
267 |
61d37796da98
A bit of cleanup of the `Markup` Python implementation.
cmlenz
parents:
857
diff
changeset
|
268 |
61d37796da98
A bit of cleanup of the `Markup` Python implementation.
cmlenz
parents:
857
diff
changeset
|
269 def _ensure(stream): |
61d37796da98
A bit of cleanup of the `Markup` Python implementation.
cmlenz
parents:
857
diff
changeset
|
270 """Ensure that every item on the stream is actually a markup event.""" |
61d37796da98
A bit of cleanup of the `Markup` Python implementation.
cmlenz
parents:
857
diff
changeset
|
271 stream = iter(stream) |
61d37796da98
A bit of cleanup of the `Markup` Python implementation.
cmlenz
parents:
857
diff
changeset
|
272 event = stream.next() |
61d37796da98
A bit of cleanup of the `Markup` Python implementation.
cmlenz
parents:
857
diff
changeset
|
273 |
61d37796da98
A bit of cleanup of the `Markup` Python implementation.
cmlenz
parents:
857
diff
changeset
|
274 # Check whether the iterable is a real markup event stream by examining the |
61d37796da98
A bit of cleanup of the `Markup` Python implementation.
cmlenz
parents:
857
diff
changeset
|
275 # first item it yields; if it's not we'll need to do some conversion |
61d37796da98
A bit of cleanup of the `Markup` Python implementation.
cmlenz
parents:
857
diff
changeset
|
276 if type(event) is not tuple or len(event) != 3: |
61d37796da98
A bit of cleanup of the `Markup` Python implementation.
cmlenz
parents:
857
diff
changeset
|
277 for event in chain([event], stream): |
61d37796da98
A bit of cleanup of the `Markup` Python implementation.
cmlenz
parents:
857
diff
changeset
|
278 if hasattr(event, 'totuple'): |
61d37796da98
A bit of cleanup of the `Markup` Python implementation.
cmlenz
parents:
857
diff
changeset
|
279 event = event.totuple() |
61d37796da98
A bit of cleanup of the `Markup` Python implementation.
cmlenz
parents:
857
diff
changeset
|
280 else: |
61d37796da98
A bit of cleanup of the `Markup` Python implementation.
cmlenz
parents:
857
diff
changeset
|
281 event = TEXT, unicode(event), (None, -1, -1) |
61d37796da98
A bit of cleanup of the `Markup` Python implementation.
cmlenz
parents:
857
diff
changeset
|
282 yield event |
61d37796da98
A bit of cleanup of the `Markup` Python implementation.
cmlenz
parents:
857
diff
changeset
|
283 return |
61d37796da98
A bit of cleanup of the `Markup` Python implementation.
cmlenz
parents:
857
diff
changeset
|
284 |
61d37796da98
A bit of cleanup of the `Markup` Python implementation.
cmlenz
parents:
857
diff
changeset
|
285 # This looks like a markup event stream, so we'll just pass it through |
61d37796da98
A bit of cleanup of the `Markup` Python implementation.
cmlenz
parents:
857
diff
changeset
|
286 # unchanged |
61d37796da98
A bit of cleanup of the `Markup` Python implementation.
cmlenz
parents:
857
diff
changeset
|
287 yield event |
61d37796da98
A bit of cleanup of the `Markup` Python implementation.
cmlenz
parents:
857
diff
changeset
|
288 for event in stream: |
61d37796da98
A bit of cleanup of the `Markup` Python implementation.
cmlenz
parents:
857
diff
changeset
|
289 yield event |
61d37796da98
A bit of cleanup of the `Markup` Python implementation.
cmlenz
parents:
857
diff
changeset
|
290 |
61d37796da98
A bit of cleanup of the `Markup` Python implementation.
cmlenz
parents:
857
diff
changeset
|
291 |
61d37796da98
A bit of cleanup of the `Markup` Python implementation.
cmlenz
parents:
857
diff
changeset
|
292 class Attrs(tuple): |
61d37796da98
A bit of cleanup of the `Markup` Python implementation.
cmlenz
parents:
857
diff
changeset
|
293 """Immutable sequence type that stores the attributes of an element. |
61d37796da98
A bit of cleanup of the `Markup` Python implementation.
cmlenz
parents:
857
diff
changeset
|
294 |
61d37796da98
A bit of cleanup of the `Markup` Python implementation.
cmlenz
parents:
857
diff
changeset
|
295 Ordering of the attributes is preserved, while access by name is also |
61d37796da98
A bit of cleanup of the `Markup` Python implementation.
cmlenz
parents:
857
diff
changeset
|
296 supported. |
61d37796da98
A bit of cleanup of the `Markup` Python implementation.
cmlenz
parents:
857
diff
changeset
|
297 |
61d37796da98
A bit of cleanup of the `Markup` Python implementation.
cmlenz
parents:
857
diff
changeset
|
298 >>> attrs = Attrs([('href', '#'), ('title', 'Foo')]) |
61d37796da98
A bit of cleanup of the `Markup` Python implementation.
cmlenz
parents:
857
diff
changeset
|
299 >>> attrs |
61d37796da98
A bit of cleanup of the `Markup` Python implementation.
cmlenz
parents:
857
diff
changeset
|
300 Attrs([('href', '#'), ('title', 'Foo')]) |
61d37796da98
A bit of cleanup of the `Markup` Python implementation.
cmlenz
parents:
857
diff
changeset
|
301 |
61d37796da98
A bit of cleanup of the `Markup` Python implementation.
cmlenz
parents:
857
diff
changeset
|
302 >>> 'href' in attrs |
61d37796da98
A bit of cleanup of the `Markup` Python implementation.
cmlenz
parents:
857
diff
changeset
|
303 True |
61d37796da98
A bit of cleanup of the `Markup` Python implementation.
cmlenz
parents:
857
diff
changeset
|
304 >>> 'tabindex' in attrs |
61d37796da98
A bit of cleanup of the `Markup` Python implementation.
cmlenz
parents:
857
diff
changeset
|
305 False |
61d37796da98
A bit of cleanup of the `Markup` Python implementation.
cmlenz
parents:
857
diff
changeset
|
306 >>> attrs.get('title') |
61d37796da98
A bit of cleanup of the `Markup` Python implementation.
cmlenz
parents:
857
diff
changeset
|
307 'Foo' |
61d37796da98
A bit of cleanup of the `Markup` Python implementation.
cmlenz
parents:
857
diff
changeset
|
308 |
61d37796da98
A bit of cleanup of the `Markup` Python implementation.
cmlenz
parents:
857
diff
changeset
|
309 Instances may not be manipulated directly. Instead, the operators ``|`` and |
61d37796da98
A bit of cleanup of the `Markup` Python implementation.
cmlenz
parents:
857
diff
changeset
|
310 ``-`` can be used to produce new instances that have specific attributes |
61d37796da98
A bit of cleanup of the `Markup` Python implementation.
cmlenz
parents:
857
diff
changeset
|
311 added, replaced or removed. |
61d37796da98
A bit of cleanup of the `Markup` Python implementation.
cmlenz
parents:
857
diff
changeset
|
312 |
61d37796da98
A bit of cleanup of the `Markup` Python implementation.
cmlenz
parents:
857
diff
changeset
|
313 To remove an attribute, use the ``-`` operator. The right hand side can be |
61d37796da98
A bit of cleanup of the `Markup` Python implementation.
cmlenz
parents:
857
diff
changeset
|
314 either a string or a set/sequence of strings, identifying the name(s) of |
61d37796da98
A bit of cleanup of the `Markup` Python implementation.
cmlenz
parents:
857
diff
changeset
|
315 the attribute(s) to remove: |
61d37796da98
A bit of cleanup of the `Markup` Python implementation.
cmlenz
parents:
857
diff
changeset
|
316 |
61d37796da98
A bit of cleanup of the `Markup` Python implementation.
cmlenz
parents:
857
diff
changeset
|
317 >>> attrs - 'title' |
61d37796da98
A bit of cleanup of the `Markup` Python implementation.
cmlenz
parents:
857
diff
changeset
|
318 Attrs([('href', '#')]) |
61d37796da98
A bit of cleanup of the `Markup` Python implementation.
cmlenz
parents:
857
diff
changeset
|
319 >>> attrs - ('title', 'href') |
61d37796da98
A bit of cleanup of the `Markup` Python implementation.
cmlenz
parents:
857
diff
changeset
|
320 Attrs() |
61d37796da98
A bit of cleanup of the `Markup` Python implementation.
cmlenz
parents:
857
diff
changeset
|
321 |
61d37796da98
A bit of cleanup of the `Markup` Python implementation.
cmlenz
parents:
857
diff
changeset
|
322 The original instance is not modified, but the operator can of course be |
61d37796da98
A bit of cleanup of the `Markup` Python implementation.
cmlenz
parents:
857
diff
changeset
|
323 used with an assignment: |
61d37796da98
A bit of cleanup of the `Markup` Python implementation.
cmlenz
parents:
857
diff
changeset
|
324 |
61d37796da98
A bit of cleanup of the `Markup` Python implementation.
cmlenz
parents:
857
diff
changeset
|
325 >>> attrs |
61d37796da98
A bit of cleanup of the `Markup` Python implementation.
cmlenz
parents:
857
diff
changeset
|
326 Attrs([('href', '#'), ('title', 'Foo')]) |
61d37796da98
A bit of cleanup of the `Markup` Python implementation.
cmlenz
parents:
857
diff
changeset
|
327 >>> attrs -= 'title' |
61d37796da98
A bit of cleanup of the `Markup` Python implementation.
cmlenz
parents:
857
diff
changeset
|
328 >>> attrs |
61d37796da98
A bit of cleanup of the `Markup` Python implementation.
cmlenz
parents:
857
diff
changeset
|
329 Attrs([('href', '#')]) |
61d37796da98
A bit of cleanup of the `Markup` Python implementation.
cmlenz
parents:
857
diff
changeset
|
330 |
61d37796da98
A bit of cleanup of the `Markup` Python implementation.
cmlenz
parents:
857
diff
changeset
|
331 To add a new attribute, use the ``|`` operator, where the right hand value |
61d37796da98
A bit of cleanup of the `Markup` Python implementation.
cmlenz
parents:
857
diff
changeset
|
332 is a sequence of ``(name, value)`` tuples (which includes `Attrs` |
61d37796da98
A bit of cleanup of the `Markup` Python implementation.
cmlenz
parents:
857
diff
changeset
|
333 instances): |
61d37796da98
A bit of cleanup of the `Markup` Python implementation.
cmlenz
parents:
857
diff
changeset
|
334 |
61d37796da98
A bit of cleanup of the `Markup` Python implementation.
cmlenz
parents:
857
diff
changeset
|
335 >>> attrs | [('title', 'Bar')] |
61d37796da98
A bit of cleanup of the `Markup` Python implementation.
cmlenz
parents:
857
diff
changeset
|
336 Attrs([('href', '#'), ('title', 'Bar')]) |
61d37796da98
A bit of cleanup of the `Markup` Python implementation.
cmlenz
parents:
857
diff
changeset
|
337 |
61d37796da98
A bit of cleanup of the `Markup` Python implementation.
cmlenz
parents:
857
diff
changeset
|
338 If the attributes already contain an attribute with a given name, the value |
61d37796da98
A bit of cleanup of the `Markup` Python implementation.
cmlenz
parents:
857
diff
changeset
|
339 of that attribute is replaced: |
61d37796da98
A bit of cleanup of the `Markup` Python implementation.
cmlenz
parents:
857
diff
changeset
|
340 |
61d37796da98
A bit of cleanup of the `Markup` Python implementation.
cmlenz
parents:
857
diff
changeset
|
341 >>> attrs | [('href', 'http://example.org/')] |
61d37796da98
A bit of cleanup of the `Markup` Python implementation.
cmlenz
parents:
857
diff
changeset
|
342 Attrs([('href', 'http://example.org/')]) |
61d37796da98
A bit of cleanup of the `Markup` Python implementation.
cmlenz
parents:
857
diff
changeset
|
343 """ |
61d37796da98
A bit of cleanup of the `Markup` Python implementation.
cmlenz
parents:
857
diff
changeset
|
344 __slots__ = [] |
61d37796da98
A bit of cleanup of the `Markup` Python implementation.
cmlenz
parents:
857
diff
changeset
|
345 |
61d37796da98
A bit of cleanup of the `Markup` Python implementation.
cmlenz
parents:
857
diff
changeset
|
346 def __contains__(self, name): |
61d37796da98
A bit of cleanup of the `Markup` Python implementation.
cmlenz
parents:
857
diff
changeset
|
347 """Return whether the list includes an attribute with the specified |
61d37796da98
A bit of cleanup of the `Markup` Python implementation.
cmlenz
parents:
857
diff
changeset
|
348 name. |
61d37796da98
A bit of cleanup of the `Markup` Python implementation.
cmlenz
parents:
857
diff
changeset
|
349 |
61d37796da98
A bit of cleanup of the `Markup` Python implementation.
cmlenz
parents:
857
diff
changeset
|
350 :return: `True` if the list includes the attribute |
61d37796da98
A bit of cleanup of the `Markup` Python implementation.
cmlenz
parents:
857
diff
changeset
|
351 :rtype: `bool` |
61d37796da98
A bit of cleanup of the `Markup` Python implementation.
cmlenz
parents:
857
diff
changeset
|
352 """ |
61d37796da98
A bit of cleanup of the `Markup` Python implementation.
cmlenz
parents:
857
diff
changeset
|
353 for attr, _ in self: |
61d37796da98
A bit of cleanup of the `Markup` Python implementation.
cmlenz
parents:
857
diff
changeset
|
354 if attr == name: |
61d37796da98
A bit of cleanup of the `Markup` Python implementation.
cmlenz
parents:
857
diff
changeset
|
355 return True |
61d37796da98
A bit of cleanup of the `Markup` Python implementation.
cmlenz
parents:
857
diff
changeset
|
356 |
61d37796da98
A bit of cleanup of the `Markup` Python implementation.
cmlenz
parents:
857
diff
changeset
|
357 def __getitem__(self, i): |
61d37796da98
A bit of cleanup of the `Markup` Python implementation.
cmlenz
parents:
857
diff
changeset
|
358 """Return an item or slice of the attributes list. |
61d37796da98
A bit of cleanup of the `Markup` Python implementation.
cmlenz
parents:
857
diff
changeset
|
359 |
61d37796da98
A bit of cleanup of the `Markup` Python implementation.
cmlenz
parents:
857
diff
changeset
|
360 >>> attrs = Attrs([('href', '#'), ('title', 'Foo')]) |
61d37796da98
A bit of cleanup of the `Markup` Python implementation.
cmlenz
parents:
857
diff
changeset
|
361 >>> attrs[1] |
61d37796da98
A bit of cleanup of the `Markup` Python implementation.
cmlenz
parents:
857
diff
changeset
|
362 ('title', 'Foo') |
61d37796da98
A bit of cleanup of the `Markup` Python implementation.
cmlenz
parents:
857
diff
changeset
|
363 >>> attrs[1:] |
61d37796da98
A bit of cleanup of the `Markup` Python implementation.
cmlenz
parents:
857
diff
changeset
|
364 Attrs([('title', 'Foo')]) |
61d37796da98
A bit of cleanup of the `Markup` Python implementation.
cmlenz
parents:
857
diff
changeset
|
365 """ |
61d37796da98
A bit of cleanup of the `Markup` Python implementation.
cmlenz
parents:
857
diff
changeset
|
366 items = tuple.__getitem__(self, i) |
61d37796da98
A bit of cleanup of the `Markup` Python implementation.
cmlenz
parents:
857
diff
changeset
|
367 if type(i) is slice: |
61d37796da98
A bit of cleanup of the `Markup` Python implementation.
cmlenz
parents:
857
diff
changeset
|
368 return Attrs(items) |
61d37796da98
A bit of cleanup of the `Markup` Python implementation.
cmlenz
parents:
857
diff
changeset
|
369 return items |
61d37796da98
A bit of cleanup of the `Markup` Python implementation.
cmlenz
parents:
857
diff
changeset
|
370 |
61d37796da98
A bit of cleanup of the `Markup` Python implementation.
cmlenz
parents:
857
diff
changeset
|
371 def __getslice__(self, i, j): |
61d37796da98
A bit of cleanup of the `Markup` Python implementation.
cmlenz
parents:
857
diff
changeset
|
372 """Return a slice of the attributes list. |
61d37796da98
A bit of cleanup of the `Markup` Python implementation.
cmlenz
parents:
857
diff
changeset
|
373 |
61d37796da98
A bit of cleanup of the `Markup` Python implementation.
cmlenz
parents:
857
diff
changeset
|
374 >>> attrs = Attrs([('href', '#'), ('title', 'Foo')]) |
61d37796da98
A bit of cleanup of the `Markup` Python implementation.
cmlenz
parents:
857
diff
changeset
|
375 >>> attrs[1:] |
61d37796da98
A bit of cleanup of the `Markup` Python implementation.
cmlenz
parents:
857
diff
changeset
|
376 Attrs([('title', 'Foo')]) |
61d37796da98
A bit of cleanup of the `Markup` Python implementation.
cmlenz
parents:
857
diff
changeset
|
377 """ |
61d37796da98
A bit of cleanup of the `Markup` Python implementation.
cmlenz
parents:
857
diff
changeset
|
378 return Attrs(tuple.__getslice__(self, i, j)) |
61d37796da98
A bit of cleanup of the `Markup` Python implementation.
cmlenz
parents:
857
diff
changeset
|
379 |
61d37796da98
A bit of cleanup of the `Markup` Python implementation.
cmlenz
parents:
857
diff
changeset
|
380 def __or__(self, attrs): |
61d37796da98
A bit of cleanup of the `Markup` Python implementation.
cmlenz
parents:
857
diff
changeset
|
381 """Return a new instance that contains the attributes in `attrs` in |
61d37796da98
A bit of cleanup of the `Markup` Python implementation.
cmlenz
parents:
857
diff
changeset
|
382 addition to any already existing attributes. |
61d37796da98
A bit of cleanup of the `Markup` Python implementation.
cmlenz
parents:
857
diff
changeset
|
383 |
61d37796da98
A bit of cleanup of the `Markup` Python implementation.
cmlenz
parents:
857
diff
changeset
|
384 :return: a new instance with the merged attributes |
61d37796da98
A bit of cleanup of the `Markup` Python implementation.
cmlenz
parents:
857
diff
changeset
|
385 :rtype: `Attrs` |
61d37796da98
A bit of cleanup of the `Markup` Python implementation.
cmlenz
parents:
857
diff
changeset
|
386 """ |
61d37796da98
A bit of cleanup of the `Markup` Python implementation.
cmlenz
parents:
857
diff
changeset
|
387 repl = dict([(an, av) for an, av in attrs if an in self]) |
61d37796da98
A bit of cleanup of the `Markup` Python implementation.
cmlenz
parents:
857
diff
changeset
|
388 return Attrs([(sn, repl.get(sn, sv)) for sn, sv in self] + |
61d37796da98
A bit of cleanup of the `Markup` Python implementation.
cmlenz
parents:
857
diff
changeset
|
389 [(an, av) for an, av in attrs if an not in self]) |
61d37796da98
A bit of cleanup of the `Markup` Python implementation.
cmlenz
parents:
857
diff
changeset
|
390 |
61d37796da98
A bit of cleanup of the `Markup` Python implementation.
cmlenz
parents:
857
diff
changeset
|
391 def __repr__(self): |
61d37796da98
A bit of cleanup of the `Markup` Python implementation.
cmlenz
parents:
857
diff
changeset
|
392 if not self: |
61d37796da98
A bit of cleanup of the `Markup` Python implementation.
cmlenz
parents:
857
diff
changeset
|
393 return 'Attrs()' |
61d37796da98
A bit of cleanup of the `Markup` Python implementation.
cmlenz
parents:
857
diff
changeset
|
394 return 'Attrs([%s])' % ', '.join([repr(item) for item in self]) |
61d37796da98
A bit of cleanup of the `Markup` Python implementation.
cmlenz
parents:
857
diff
changeset
|
395 |
61d37796da98
A bit of cleanup of the `Markup` Python implementation.
cmlenz
parents:
857
diff
changeset
|
396 def __sub__(self, names): |
61d37796da98
A bit of cleanup of the `Markup` Python implementation.
cmlenz
parents:
857
diff
changeset
|
397 """Return a new instance with all attributes with a name in `names` are |
61d37796da98
A bit of cleanup of the `Markup` Python implementation.
cmlenz
parents:
857
diff
changeset
|
398 removed. |
61d37796da98
A bit of cleanup of the `Markup` Python implementation.
cmlenz
parents:
857
diff
changeset
|
399 |
61d37796da98
A bit of cleanup of the `Markup` Python implementation.
cmlenz
parents:
857
diff
changeset
|
400 :param names: the names of the attributes to remove |
61d37796da98
A bit of cleanup of the `Markup` Python implementation.
cmlenz
parents:
857
diff
changeset
|
401 :return: a new instance with the attribute removed |
61d37796da98
A bit of cleanup of the `Markup` Python implementation.
cmlenz
parents:
857
diff
changeset
|
402 :rtype: `Attrs` |
61d37796da98
A bit of cleanup of the `Markup` Python implementation.
cmlenz
parents:
857
diff
changeset
|
403 """ |
61d37796da98
A bit of cleanup of the `Markup` Python implementation.
cmlenz
parents:
857
diff
changeset
|
404 if isinstance(names, basestring): |
61d37796da98
A bit of cleanup of the `Markup` Python implementation.
cmlenz
parents:
857
diff
changeset
|
405 names = (names,) |
61d37796da98
A bit of cleanup of the `Markup` Python implementation.
cmlenz
parents:
857
diff
changeset
|
406 return Attrs([(name, val) for name, val in self if name not in names]) |
61d37796da98
A bit of cleanup of the `Markup` Python implementation.
cmlenz
parents:
857
diff
changeset
|
407 |
61d37796da98
A bit of cleanup of the `Markup` Python implementation.
cmlenz
parents:
857
diff
changeset
|
408 def get(self, name, default=None): |
61d37796da98
A bit of cleanup of the `Markup` Python implementation.
cmlenz
parents:
857
diff
changeset
|
409 """Return the value of the attribute with the specified name, or the |
61d37796da98
A bit of cleanup of the `Markup` Python implementation.
cmlenz
parents:
857
diff
changeset
|
410 value of the `default` parameter if no such attribute is found. |
61d37796da98
A bit of cleanup of the `Markup` Python implementation.
cmlenz
parents:
857
diff
changeset
|
411 |
61d37796da98
A bit of cleanup of the `Markup` Python implementation.
cmlenz
parents:
857
diff
changeset
|
412 :param name: the name of the attribute |
61d37796da98
A bit of cleanup of the `Markup` Python implementation.
cmlenz
parents:
857
diff
changeset
|
413 :param default: the value to return when the attribute does not exist |
61d37796da98
A bit of cleanup of the `Markup` Python implementation.
cmlenz
parents:
857
diff
changeset
|
414 :return: the attribute value, or the `default` value if that attribute |
61d37796da98
A bit of cleanup of the `Markup` Python implementation.
cmlenz
parents:
857
diff
changeset
|
415 does not exist |
61d37796da98
A bit of cleanup of the `Markup` Python implementation.
cmlenz
parents:
857
diff
changeset
|
416 :rtype: `object` |
61d37796da98
A bit of cleanup of the `Markup` Python implementation.
cmlenz
parents:
857
diff
changeset
|
417 """ |
61d37796da98
A bit of cleanup of the `Markup` Python implementation.
cmlenz
parents:
857
diff
changeset
|
418 for attr, value in self: |
61d37796da98
A bit of cleanup of the `Markup` Python implementation.
cmlenz
parents:
857
diff
changeset
|
419 if attr == name: |
61d37796da98
A bit of cleanup of the `Markup` Python implementation.
cmlenz
parents:
857
diff
changeset
|
420 return value |
61d37796da98
A bit of cleanup of the `Markup` Python implementation.
cmlenz
parents:
857
diff
changeset
|
421 return default |
61d37796da98
A bit of cleanup of the `Markup` Python implementation.
cmlenz
parents:
857
diff
changeset
|
422 |
61d37796da98
A bit of cleanup of the `Markup` Python implementation.
cmlenz
parents:
857
diff
changeset
|
423 def totuple(self): |
61d37796da98
A bit of cleanup of the `Markup` Python implementation.
cmlenz
parents:
857
diff
changeset
|
424 """Return the attributes as a markup event. |
61d37796da98
A bit of cleanup of the `Markup` Python implementation.
cmlenz
parents:
857
diff
changeset
|
425 |
61d37796da98
A bit of cleanup of the `Markup` Python implementation.
cmlenz
parents:
857
diff
changeset
|
426 The returned event is a `TEXT` event, the data is the value of all |
61d37796da98
A bit of cleanup of the `Markup` Python implementation.
cmlenz
parents:
857
diff
changeset
|
427 attributes joined together. |
61d37796da98
A bit of cleanup of the `Markup` Python implementation.
cmlenz
parents:
857
diff
changeset
|
428 |
61d37796da98
A bit of cleanup of the `Markup` Python implementation.
cmlenz
parents:
857
diff
changeset
|
429 >>> Attrs([('href', '#'), ('title', 'Foo')]).totuple() |
61d37796da98
A bit of cleanup of the `Markup` Python implementation.
cmlenz
parents:
857
diff
changeset
|
430 ('TEXT', '#Foo', (None, -1, -1)) |
61d37796da98
A bit of cleanup of the `Markup` Python implementation.
cmlenz
parents:
857
diff
changeset
|
431 |
61d37796da98
A bit of cleanup of the `Markup` Python implementation.
cmlenz
parents:
857
diff
changeset
|
432 :return: a `TEXT` event |
61d37796da98
A bit of cleanup of the `Markup` Python implementation.
cmlenz
parents:
857
diff
changeset
|
433 :rtype: `tuple` |
61d37796da98
A bit of cleanup of the `Markup` Python implementation.
cmlenz
parents:
857
diff
changeset
|
434 """ |
61d37796da98
A bit of cleanup of the `Markup` Python implementation.
cmlenz
parents:
857
diff
changeset
|
435 return TEXT, ''.join([x[1] for x in self]), (None, -1, -1) |
61d37796da98
A bit of cleanup of the `Markup` Python implementation.
cmlenz
parents:
857
diff
changeset
|
436 |
61d37796da98
A bit of cleanup of the `Markup` Python implementation.
cmlenz
parents:
857
diff
changeset
|
437 |
61d37796da98
A bit of cleanup of the `Markup` Python implementation.
cmlenz
parents:
857
diff
changeset
|
438 class Markup(unicode): |
61d37796da98
A bit of cleanup of the `Markup` Python implementation.
cmlenz
parents:
857
diff
changeset
|
439 """Marks a string as being safe for inclusion in HTML/XML output without |
61d37796da98
A bit of cleanup of the `Markup` Python implementation.
cmlenz
parents:
857
diff
changeset
|
440 needing to be escaped. |
61d37796da98
A bit of cleanup of the `Markup` Python implementation.
cmlenz
parents:
857
diff
changeset
|
441 """ |
61d37796da98
A bit of cleanup of the `Markup` Python implementation.
cmlenz
parents:
857
diff
changeset
|
442 __slots__ = [] |
61d37796da98
A bit of cleanup of the `Markup` Python implementation.
cmlenz
parents:
857
diff
changeset
|
443 |
61d37796da98
A bit of cleanup of the `Markup` Python implementation.
cmlenz
parents:
857
diff
changeset
|
444 def __add__(self, other): |
61d37796da98
A bit of cleanup of the `Markup` Python implementation.
cmlenz
parents:
857
diff
changeset
|
445 return Markup(unicode.__add__(self, escape(other))) |
61d37796da98
A bit of cleanup of the `Markup` Python implementation.
cmlenz
parents:
857
diff
changeset
|
446 |
61d37796da98
A bit of cleanup of the `Markup` Python implementation.
cmlenz
parents:
857
diff
changeset
|
447 def __radd__(self, other): |
61d37796da98
A bit of cleanup of the `Markup` Python implementation.
cmlenz
parents:
857
diff
changeset
|
448 return Markup(unicode.__add__(escape(other), self)) |
61d37796da98
A bit of cleanup of the `Markup` Python implementation.
cmlenz
parents:
857
diff
changeset
|
449 |
61d37796da98
A bit of cleanup of the `Markup` Python implementation.
cmlenz
parents:
857
diff
changeset
|
450 def __mod__(self, args): |
61d37796da98
A bit of cleanup of the `Markup` Python implementation.
cmlenz
parents:
857
diff
changeset
|
451 if isinstance(args, dict): |
61d37796da98
A bit of cleanup of the `Markup` Python implementation.
cmlenz
parents:
857
diff
changeset
|
452 args = dict(zip(args.keys(), map(escape, args.values()))) |
61d37796da98
A bit of cleanup of the `Markup` Python implementation.
cmlenz
parents:
857
diff
changeset
|
453 elif isinstance(args, (list, tuple)): |
61d37796da98
A bit of cleanup of the `Markup` Python implementation.
cmlenz
parents:
857
diff
changeset
|
454 args = tuple(map(escape, args)) |
61d37796da98
A bit of cleanup of the `Markup` Python implementation.
cmlenz
parents:
857
diff
changeset
|
455 else: |
61d37796da98
A bit of cleanup of the `Markup` Python implementation.
cmlenz
parents:
857
diff
changeset
|
456 args = escape(args) |
61d37796da98
A bit of cleanup of the `Markup` Python implementation.
cmlenz
parents:
857
diff
changeset
|
457 return Markup(unicode.__mod__(self, args)) |
61d37796da98
A bit of cleanup of the `Markup` Python implementation.
cmlenz
parents:
857
diff
changeset
|
458 |
61d37796da98
A bit of cleanup of the `Markup` Python implementation.
cmlenz
parents:
857
diff
changeset
|
459 def __mul__(self, num): |
61d37796da98
A bit of cleanup of the `Markup` Python implementation.
cmlenz
parents:
857
diff
changeset
|
460 return Markup(unicode.__mul__(self, num)) |
61d37796da98
A bit of cleanup of the `Markup` Python implementation.
cmlenz
parents:
857
diff
changeset
|
461 __rmul__ = __mul__ |
61d37796da98
A bit of cleanup of the `Markup` Python implementation.
cmlenz
parents:
857
diff
changeset
|
462 |
61d37796da98
A bit of cleanup of the `Markup` Python implementation.
cmlenz
parents:
857
diff
changeset
|
463 def __repr__(self): |
61d37796da98
A bit of cleanup of the `Markup` Python implementation.
cmlenz
parents:
857
diff
changeset
|
464 return "<%s %s>" % (type(self).__name__, unicode.__repr__(self)) |
61d37796da98
A bit of cleanup of the `Markup` Python implementation.
cmlenz
parents:
857
diff
changeset
|
465 |
61d37796da98
A bit of cleanup of the `Markup` Python implementation.
cmlenz
parents:
857
diff
changeset
|
466 def join(self, seq, escape_quotes=True): |
61d37796da98
A bit of cleanup of the `Markup` Python implementation.
cmlenz
parents:
857
diff
changeset
|
467 """Return a `Markup` object which is the concatenation of the strings |
61d37796da98
A bit of cleanup of the `Markup` Python implementation.
cmlenz
parents:
857
diff
changeset
|
468 in the given sequence, where this `Markup` object is the separator |
61d37796da98
A bit of cleanup of the `Markup` Python implementation.
cmlenz
parents:
857
diff
changeset
|
469 between the joined elements. |
61d37796da98
A bit of cleanup of the `Markup` Python implementation.
cmlenz
parents:
857
diff
changeset
|
470 |
61d37796da98
A bit of cleanup of the `Markup` Python implementation.
cmlenz
parents:
857
diff
changeset
|
471 Any element in the sequence that is not a `Markup` instance is |
61d37796da98
A bit of cleanup of the `Markup` Python implementation.
cmlenz
parents:
857
diff
changeset
|
472 automatically escaped. |
61d37796da98
A bit of cleanup of the `Markup` Python implementation.
cmlenz
parents:
857
diff
changeset
|
473 |
61d37796da98
A bit of cleanup of the `Markup` Python implementation.
cmlenz
parents:
857
diff
changeset
|
474 :param seq: the sequence of strings to join |
61d37796da98
A bit of cleanup of the `Markup` Python implementation.
cmlenz
parents:
857
diff
changeset
|
475 :param escape_quotes: whether double quote characters in the elements |
61d37796da98
A bit of cleanup of the `Markup` Python implementation.
cmlenz
parents:
857
diff
changeset
|
476 should be escaped |
61d37796da98
A bit of cleanup of the `Markup` Python implementation.
cmlenz
parents:
857
diff
changeset
|
477 :return: the joined `Markup` object |
61d37796da98
A bit of cleanup of the `Markup` Python implementation.
cmlenz
parents:
857
diff
changeset
|
478 :rtype: `Markup` |
61d37796da98
A bit of cleanup of the `Markup` Python implementation.
cmlenz
parents:
857
diff
changeset
|
479 :see: `escape` |
61d37796da98
A bit of cleanup of the `Markup` Python implementation.
cmlenz
parents:
857
diff
changeset
|
480 """ |
61d37796da98
A bit of cleanup of the `Markup` Python implementation.
cmlenz
parents:
857
diff
changeset
|
481 return Markup(unicode.join(self, [escape(item, quotes=escape_quotes) |
61d37796da98
A bit of cleanup of the `Markup` Python implementation.
cmlenz
parents:
857
diff
changeset
|
482 for item in seq])) |
61d37796da98
A bit of cleanup of the `Markup` Python implementation.
cmlenz
parents:
857
diff
changeset
|
483 |
61d37796da98
A bit of cleanup of the `Markup` Python implementation.
cmlenz
parents:
857
diff
changeset
|
484 @classmethod |
61d37796da98
A bit of cleanup of the `Markup` Python implementation.
cmlenz
parents:
857
diff
changeset
|
485 def escape(cls, text, quotes=True): |
61d37796da98
A bit of cleanup of the `Markup` Python implementation.
cmlenz
parents:
857
diff
changeset
|
486 """Create a Markup instance from a string and escape special characters |
61d37796da98
A bit of cleanup of the `Markup` Python implementation.
cmlenz
parents:
857
diff
changeset
|
487 it may contain (<, >, & and \"). |
61d37796da98
A bit of cleanup of the `Markup` Python implementation.
cmlenz
parents:
857
diff
changeset
|
488 |
61d37796da98
A bit of cleanup of the `Markup` Python implementation.
cmlenz
parents:
857
diff
changeset
|
489 >>> escape('"1 < 2"') |
61d37796da98
A bit of cleanup of the `Markup` Python implementation.
cmlenz
parents:
857
diff
changeset
|
490 <Markup u'"1 < 2"'> |
61d37796da98
A bit of cleanup of the `Markup` Python implementation.
cmlenz
parents:
857
diff
changeset
|
491 |
61d37796da98
A bit of cleanup of the `Markup` Python implementation.
cmlenz
parents:
857
diff
changeset
|
492 If the `quotes` parameter is set to `False`, the \" character is left |
61d37796da98
A bit of cleanup of the `Markup` Python implementation.
cmlenz
parents:
857
diff
changeset
|
493 as is. Escaping quotes is generally only required for strings that are |
61d37796da98
A bit of cleanup of the `Markup` Python implementation.
cmlenz
parents:
857
diff
changeset
|
494 to be used in attribute values. |
61d37796da98
A bit of cleanup of the `Markup` Python implementation.
cmlenz
parents:
857
diff
changeset
|
495 |
61d37796da98
A bit of cleanup of the `Markup` Python implementation.
cmlenz
parents:
857
diff
changeset
|
496 >>> escape('"1 < 2"', quotes=False) |
61d37796da98
A bit of cleanup of the `Markup` Python implementation.
cmlenz
parents:
857
diff
changeset
|
497 <Markup u'"1 < 2"'> |
61d37796da98
A bit of cleanup of the `Markup` Python implementation.
cmlenz
parents:
857
diff
changeset
|
498 |
61d37796da98
A bit of cleanup of the `Markup` Python implementation.
cmlenz
parents:
857
diff
changeset
|
499 :param text: the text to escape |
61d37796da98
A bit of cleanup of the `Markup` Python implementation.
cmlenz
parents:
857
diff
changeset
|
500 :param quotes: if ``True``, double quote characters are escaped in |
61d37796da98
A bit of cleanup of the `Markup` Python implementation.
cmlenz
parents:
857
diff
changeset
|
501 addition to the other special characters |
61d37796da98
A bit of cleanup of the `Markup` Python implementation.
cmlenz
parents:
857
diff
changeset
|
502 :return: the escaped `Markup` string |
61d37796da98
A bit of cleanup of the `Markup` Python implementation.
cmlenz
parents:
857
diff
changeset
|
503 :rtype: `Markup` |
61d37796da98
A bit of cleanup of the `Markup` Python implementation.
cmlenz
parents:
857
diff
changeset
|
504 """ |
61d37796da98
A bit of cleanup of the `Markup` Python implementation.
cmlenz
parents:
857
diff
changeset
|
505 if not text: |
61d37796da98
A bit of cleanup of the `Markup` Python implementation.
cmlenz
parents:
857
diff
changeset
|
506 return cls() |
61d37796da98
A bit of cleanup of the `Markup` Python implementation.
cmlenz
parents:
857
diff
changeset
|
507 if type(text) is cls: |
61d37796da98
A bit of cleanup of the `Markup` Python implementation.
cmlenz
parents:
857
diff
changeset
|
508 return text |
61d37796da98
A bit of cleanup of the `Markup` Python implementation.
cmlenz
parents:
857
diff
changeset
|
509 if hasattr(text, '__html__'): |
61d37796da98
A bit of cleanup of the `Markup` Python implementation.
cmlenz
parents:
857
diff
changeset
|
510 return Markup(text.__html__()) |
61d37796da98
A bit of cleanup of the `Markup` Python implementation.
cmlenz
parents:
857
diff
changeset
|
511 |
61d37796da98
A bit of cleanup of the `Markup` Python implementation.
cmlenz
parents:
857
diff
changeset
|
512 text = text.replace('&', '&') \ |
61d37796da98
A bit of cleanup of the `Markup` Python implementation.
cmlenz
parents:
857
diff
changeset
|
513 .replace('<', '<') \ |
61d37796da98
A bit of cleanup of the `Markup` Python implementation.
cmlenz
parents:
857
diff
changeset
|
514 .replace('>', '>') |
61d37796da98
A bit of cleanup of the `Markup` Python implementation.
cmlenz
parents:
857
diff
changeset
|
515 if quotes: |
61d37796da98
A bit of cleanup of the `Markup` Python implementation.
cmlenz
parents:
857
diff
changeset
|
516 text = text.replace('"', '"') |
61d37796da98
A bit of cleanup of the `Markup` Python implementation.
cmlenz
parents:
857
diff
changeset
|
517 return cls(text) |
61d37796da98
A bit of cleanup of the `Markup` Python implementation.
cmlenz
parents:
857
diff
changeset
|
518 |
61d37796da98
A bit of cleanup of the `Markup` Python implementation.
cmlenz
parents:
857
diff
changeset
|
519 def unescape(self): |
61d37796da98
A bit of cleanup of the `Markup` Python implementation.
cmlenz
parents:
857
diff
changeset
|
520 """Reverse-escapes &, <, >, and \" and returns a `unicode` object. |
61d37796da98
A bit of cleanup of the `Markup` Python implementation.
cmlenz
parents:
857
diff
changeset
|
521 |
61d37796da98
A bit of cleanup of the `Markup` Python implementation.
cmlenz
parents:
857
diff
changeset
|
522 >>> Markup('1 < 2').unescape() |
61d37796da98
A bit of cleanup of the `Markup` Python implementation.
cmlenz
parents:
857
diff
changeset
|
523 u'1 < 2' |
61d37796da98
A bit of cleanup of the `Markup` Python implementation.
cmlenz
parents:
857
diff
changeset
|
524 |
61d37796da98
A bit of cleanup of the `Markup` Python implementation.
cmlenz
parents:
857
diff
changeset
|
525 :return: the unescaped string |
61d37796da98
A bit of cleanup of the `Markup` Python implementation.
cmlenz
parents:
857
diff
changeset
|
526 :rtype: `unicode` |
61d37796da98
A bit of cleanup of the `Markup` Python implementation.
cmlenz
parents:
857
diff
changeset
|
527 :see: `genshi.core.unescape` |
61d37796da98
A bit of cleanup of the `Markup` Python implementation.
cmlenz
parents:
857
diff
changeset
|
528 """ |
61d37796da98
A bit of cleanup of the `Markup` Python implementation.
cmlenz
parents:
857
diff
changeset
|
529 if not self: |
61d37796da98
A bit of cleanup of the `Markup` Python implementation.
cmlenz
parents:
857
diff
changeset
|
530 return '' |
61d37796da98
A bit of cleanup of the `Markup` Python implementation.
cmlenz
parents:
857
diff
changeset
|
531 return unicode(self).replace('"', '"') \ |
61d37796da98
A bit of cleanup of the `Markup` Python implementation.
cmlenz
parents:
857
diff
changeset
|
532 .replace('>', '>') \ |
61d37796da98
A bit of cleanup of the `Markup` Python implementation.
cmlenz
parents:
857
diff
changeset
|
533 .replace('<', '<') \ |
61d37796da98
A bit of cleanup of the `Markup` Python implementation.
cmlenz
parents:
857
diff
changeset
|
534 .replace('&', '&') |
61d37796da98
A bit of cleanup of the `Markup` Python implementation.
cmlenz
parents:
857
diff
changeset
|
535 |
61d37796da98
A bit of cleanup of the `Markup` Python implementation.
cmlenz
parents:
857
diff
changeset
|
536 def stripentities(self, keepxmlentities=False): |
61d37796da98
A bit of cleanup of the `Markup` Python implementation.
cmlenz
parents:
857
diff
changeset
|
537 """Return a copy of the text with any character or numeric entities |
61d37796da98
A bit of cleanup of the `Markup` Python implementation.
cmlenz
parents:
857
diff
changeset
|
538 replaced by the equivalent UTF-8 characters. |
61d37796da98
A bit of cleanup of the `Markup` Python implementation.
cmlenz
parents:
857
diff
changeset
|
539 |
61d37796da98
A bit of cleanup of the `Markup` Python implementation.
cmlenz
parents:
857
diff
changeset
|
540 If the `keepxmlentities` parameter is provided and evaluates to `True`, |
61d37796da98
A bit of cleanup of the `Markup` Python implementation.
cmlenz
parents:
857
diff
changeset
|
541 the core XML entities (``&``, ``'``, ``>``, ``<`` and |
61d37796da98
A bit of cleanup of the `Markup` Python implementation.
cmlenz
parents:
857
diff
changeset
|
542 ``"``) are not stripped. |
61d37796da98
A bit of cleanup of the `Markup` Python implementation.
cmlenz
parents:
857
diff
changeset
|
543 |
61d37796da98
A bit of cleanup of the `Markup` Python implementation.
cmlenz
parents:
857
diff
changeset
|
544 :return: a `Markup` instance with entities removed |
61d37796da98
A bit of cleanup of the `Markup` Python implementation.
cmlenz
parents:
857
diff
changeset
|
545 :rtype: `Markup` |
61d37796da98
A bit of cleanup of the `Markup` Python implementation.
cmlenz
parents:
857
diff
changeset
|
546 :see: `genshi.util.stripentities` |
61d37796da98
A bit of cleanup of the `Markup` Python implementation.
cmlenz
parents:
857
diff
changeset
|
547 """ |
61d37796da98
A bit of cleanup of the `Markup` Python implementation.
cmlenz
parents:
857
diff
changeset
|
548 return Markup(stripentities(self, keepxmlentities=keepxmlentities)) |
61d37796da98
A bit of cleanup of the `Markup` Python implementation.
cmlenz
parents:
857
diff
changeset
|
549 |
61d37796da98
A bit of cleanup of the `Markup` Python implementation.
cmlenz
parents:
857
diff
changeset
|
550 def striptags(self): |
61d37796da98
A bit of cleanup of the `Markup` Python implementation.
cmlenz
parents:
857
diff
changeset
|
551 """Return a copy of the text with all XML/HTML tags removed. |
61d37796da98
A bit of cleanup of the `Markup` Python implementation.
cmlenz
parents:
857
diff
changeset
|
552 |
61d37796da98
A bit of cleanup of the `Markup` Python implementation.
cmlenz
parents:
857
diff
changeset
|
553 :return: a `Markup` instance with all tags removed |
61d37796da98
A bit of cleanup of the `Markup` Python implementation.
cmlenz
parents:
857
diff
changeset
|
554 :rtype: `Markup` |
61d37796da98
A bit of cleanup of the `Markup` Python implementation.
cmlenz
parents:
857
diff
changeset
|
555 :see: `genshi.util.striptags` |
61d37796da98
A bit of cleanup of the `Markup` Python implementation.
cmlenz
parents:
857
diff
changeset
|
556 """ |
61d37796da98
A bit of cleanup of the `Markup` Python implementation.
cmlenz
parents:
857
diff
changeset
|
557 return Markup(striptags(self)) |
61d37796da98
A bit of cleanup of the `Markup` Python implementation.
cmlenz
parents:
857
diff
changeset
|
558 |
61d37796da98
A bit of cleanup of the `Markup` Python implementation.
cmlenz
parents:
857
diff
changeset
|
559 |
61d37796da98
A bit of cleanup of the `Markup` Python implementation.
cmlenz
parents:
857
diff
changeset
|
560 try: |
61d37796da98
A bit of cleanup of the `Markup` Python implementation.
cmlenz
parents:
857
diff
changeset
|
561 from genshi._speedups import Markup |
61d37796da98
A bit of cleanup of the `Markup` Python implementation.
cmlenz
parents:
857
diff
changeset
|
562 except ImportError: |
61d37796da98
A bit of cleanup of the `Markup` Python implementation.
cmlenz
parents:
857
diff
changeset
|
563 pass # just use the Python implementation |
61d37796da98
A bit of cleanup of the `Markup` Python implementation.
cmlenz
parents:
857
diff
changeset
|
564 |
61d37796da98
A bit of cleanup of the `Markup` Python implementation.
cmlenz
parents:
857
diff
changeset
|
565 |
61d37796da98
A bit of cleanup of the `Markup` Python implementation.
cmlenz
parents:
857
diff
changeset
|
566 escape = Markup.escape |
61d37796da98
A bit of cleanup of the `Markup` Python implementation.
cmlenz
parents:
857
diff
changeset
|
567 |
61d37796da98
A bit of cleanup of the `Markup` Python implementation.
cmlenz
parents:
857
diff
changeset
|
568 |
61d37796da98
A bit of cleanup of the `Markup` Python implementation.
cmlenz
parents:
857
diff
changeset
|
569 def unescape(text): |
61d37796da98
A bit of cleanup of the `Markup` Python implementation.
cmlenz
parents:
857
diff
changeset
|
570 """Reverse-escapes &, <, >, and \" and returns a `unicode` object. |
61d37796da98
A bit of cleanup of the `Markup` Python implementation.
cmlenz
parents:
857
diff
changeset
|
571 |
61d37796da98
A bit of cleanup of the `Markup` Python implementation.
cmlenz
parents:
857
diff
changeset
|
572 >>> unescape(Markup('1 < 2')) |
61d37796da98
A bit of cleanup of the `Markup` Python implementation.
cmlenz
parents:
857
diff
changeset
|
573 u'1 < 2' |
61d37796da98
A bit of cleanup of the `Markup` Python implementation.
cmlenz
parents:
857
diff
changeset
|
574 |
61d37796da98
A bit of cleanup of the `Markup` Python implementation.
cmlenz
parents:
857
diff
changeset
|
575 If the provided `text` object is not a `Markup` instance, it is returned |
61d37796da98
A bit of cleanup of the `Markup` Python implementation.
cmlenz
parents:
857
diff
changeset
|
576 unchanged. |
61d37796da98
A bit of cleanup of the `Markup` Python implementation.
cmlenz
parents:
857
diff
changeset
|
577 |
61d37796da98
A bit of cleanup of the `Markup` Python implementation.
cmlenz
parents:
857
diff
changeset
|
578 >>> unescape('1 < 2') |
61d37796da98
A bit of cleanup of the `Markup` Python implementation.
cmlenz
parents:
857
diff
changeset
|
579 '1 < 2' |
61d37796da98
A bit of cleanup of the `Markup` Python implementation.
cmlenz
parents:
857
diff
changeset
|
580 |
61d37796da98
A bit of cleanup of the `Markup` Python implementation.
cmlenz
parents:
857
diff
changeset
|
581 :param text: the text to unescape |
61d37796da98
A bit of cleanup of the `Markup` Python implementation.
cmlenz
parents:
857
diff
changeset
|
582 :return: the unescsaped string |
61d37796da98
A bit of cleanup of the `Markup` Python implementation.
cmlenz
parents:
857
diff
changeset
|
583 :rtype: `unicode` |
61d37796da98
A bit of cleanup of the `Markup` Python implementation.
cmlenz
parents:
857
diff
changeset
|
584 """ |
61d37796da98
A bit of cleanup of the `Markup` Python implementation.
cmlenz
parents:
857
diff
changeset
|
585 if not isinstance(text, Markup): |
61d37796da98
A bit of cleanup of the `Markup` Python implementation.
cmlenz
parents:
857
diff
changeset
|
586 return text |
61d37796da98
A bit of cleanup of the `Markup` Python implementation.
cmlenz
parents:
857
diff
changeset
|
587 return text.unescape() |
61d37796da98
A bit of cleanup of the `Markup` Python implementation.
cmlenz
parents:
857
diff
changeset
|
588 |
61d37796da98
A bit of cleanup of the `Markup` Python implementation.
cmlenz
parents:
857
diff
changeset
|
589 |
61d37796da98
A bit of cleanup of the `Markup` Python implementation.
cmlenz
parents:
857
diff
changeset
|
590 class Namespace(object): |
61d37796da98
A bit of cleanup of the `Markup` Python implementation.
cmlenz
parents:
857
diff
changeset
|
591 """Utility class creating and testing elements with a namespace. |
61d37796da98
A bit of cleanup of the `Markup` Python implementation.
cmlenz
parents:
857
diff
changeset
|
592 |
61d37796da98
A bit of cleanup of the `Markup` Python implementation.
cmlenz
parents:
857
diff
changeset
|
593 Internally, namespace URIs are encoded in the `QName` of any element or |
61d37796da98
A bit of cleanup of the `Markup` Python implementation.
cmlenz
parents:
857
diff
changeset
|
594 attribute, the namespace URI being enclosed in curly braces. This class |
61d37796da98
A bit of cleanup of the `Markup` Python implementation.
cmlenz
parents:
857
diff
changeset
|
595 helps create and test these strings. |
61d37796da98
A bit of cleanup of the `Markup` Python implementation.
cmlenz
parents:
857
diff
changeset
|
596 |
61d37796da98
A bit of cleanup of the `Markup` Python implementation.
cmlenz
parents:
857
diff
changeset
|
597 A `Namespace` object is instantiated with the namespace URI. |
61d37796da98
A bit of cleanup of the `Markup` Python implementation.
cmlenz
parents:
857
diff
changeset
|
598 |
61d37796da98
A bit of cleanup of the `Markup` Python implementation.
cmlenz
parents:
857
diff
changeset
|
599 >>> html = Namespace('http://www.w3.org/1999/xhtml') |
61d37796da98
A bit of cleanup of the `Markup` Python implementation.
cmlenz
parents:
857
diff
changeset
|
600 >>> html |
61d37796da98
A bit of cleanup of the `Markup` Python implementation.
cmlenz
parents:
857
diff
changeset
|
601 Namespace('http://www.w3.org/1999/xhtml') |
61d37796da98
A bit of cleanup of the `Markup` Python implementation.
cmlenz
parents:
857
diff
changeset
|
602 >>> html.uri |
61d37796da98
A bit of cleanup of the `Markup` Python implementation.
cmlenz
parents:
857
diff
changeset
|
603 u'http://www.w3.org/1999/xhtml' |
61d37796da98
A bit of cleanup of the `Markup` Python implementation.
cmlenz
parents:
857
diff
changeset
|
604 |
61d37796da98
A bit of cleanup of the `Markup` Python implementation.
cmlenz
parents:
857
diff
changeset
|
605 The `Namespace` object can than be used to generate `QName` objects with |
61d37796da98
A bit of cleanup of the `Markup` Python implementation.
cmlenz
parents:
857
diff
changeset
|
606 that namespace: |
61d37796da98
A bit of cleanup of the `Markup` Python implementation.
cmlenz
parents:
857
diff
changeset
|
607 |
61d37796da98
A bit of cleanup of the `Markup` Python implementation.
cmlenz
parents:
857
diff
changeset
|
608 >>> html.body |
61d37796da98
A bit of cleanup of the `Markup` Python implementation.
cmlenz
parents:
857
diff
changeset
|
609 QName('http://www.w3.org/1999/xhtml}body') |
61d37796da98
A bit of cleanup of the `Markup` Python implementation.
cmlenz
parents:
857
diff
changeset
|
610 >>> html.body.localname |
61d37796da98
A bit of cleanup of the `Markup` Python implementation.
cmlenz
parents:
857
diff
changeset
|
611 u'body' |
61d37796da98
A bit of cleanup of the `Markup` Python implementation.
cmlenz
parents:
857
diff
changeset
|
612 >>> html.body.namespace |
61d37796da98
A bit of cleanup of the `Markup` Python implementation.
cmlenz
parents:
857
diff
changeset
|
613 u'http://www.w3.org/1999/xhtml' |
61d37796da98
A bit of cleanup of the `Markup` Python implementation.
cmlenz
parents:
857
diff
changeset
|
614 |
61d37796da98
A bit of cleanup of the `Markup` Python implementation.
cmlenz
parents:
857
diff
changeset
|
615 The same works using item access notation, which is useful for element or |
61d37796da98
A bit of cleanup of the `Markup` Python implementation.
cmlenz
parents:
857
diff
changeset
|
616 attribute names that are not valid Python identifiers: |
61d37796da98
A bit of cleanup of the `Markup` Python implementation.
cmlenz
parents:
857
diff
changeset
|
617 |
61d37796da98
A bit of cleanup of the `Markup` Python implementation.
cmlenz
parents:
857
diff
changeset
|
618 >>> html['body'] |
61d37796da98
A bit of cleanup of the `Markup` Python implementation.
cmlenz
parents:
857
diff
changeset
|
619 QName('http://www.w3.org/1999/xhtml}body') |
61d37796da98
A bit of cleanup of the `Markup` Python implementation.
cmlenz
parents:
857
diff
changeset
|
620 |
61d37796da98
A bit of cleanup of the `Markup` Python implementation.
cmlenz
parents:
857
diff
changeset
|
621 A `Namespace` object can also be used to test whether a specific `QName` |
61d37796da98
A bit of cleanup of the `Markup` Python implementation.
cmlenz
parents:
857
diff
changeset
|
622 belongs to that namespace using the ``in`` operator: |
61d37796da98
A bit of cleanup of the `Markup` Python implementation.
cmlenz
parents:
857
diff
changeset
|
623 |
61d37796da98
A bit of cleanup of the `Markup` Python implementation.
cmlenz
parents:
857
diff
changeset
|
624 >>> qname = html.body |
61d37796da98
A bit of cleanup of the `Markup` Python implementation.
cmlenz
parents:
857
diff
changeset
|
625 >>> qname in html |
61d37796da98
A bit of cleanup of the `Markup` Python implementation.
cmlenz
parents:
857
diff
changeset
|
626 True |
61d37796da98
A bit of cleanup of the `Markup` Python implementation.
cmlenz
parents:
857
diff
changeset
|
627 >>> qname in Namespace('http://www.w3.org/2002/06/xhtml2') |
61d37796da98
A bit of cleanup of the `Markup` Python implementation.
cmlenz
parents:
857
diff
changeset
|
628 False |
61d37796da98
A bit of cleanup of the `Markup` Python implementation.
cmlenz
parents:
857
diff
changeset
|
629 """ |
61d37796da98
A bit of cleanup of the `Markup` Python implementation.
cmlenz
parents:
857
diff
changeset
|
630 def __new__(cls, uri): |
61d37796da98
A bit of cleanup of the `Markup` Python implementation.
cmlenz
parents:
857
diff
changeset
|
631 if type(uri) is cls: |
61d37796da98
A bit of cleanup of the `Markup` Python implementation.
cmlenz
parents:
857
diff
changeset
|
632 return uri |
61d37796da98
A bit of cleanup of the `Markup` Python implementation.
cmlenz
parents:
857
diff
changeset
|
633 return object.__new__(cls) |
61d37796da98
A bit of cleanup of the `Markup` Python implementation.
cmlenz
parents:
857
diff
changeset
|
634 |
61d37796da98
A bit of cleanup of the `Markup` Python implementation.
cmlenz
parents:
857
diff
changeset
|
635 def __getnewargs__(self): |
61d37796da98
A bit of cleanup of the `Markup` Python implementation.
cmlenz
parents:
857
diff
changeset
|
636 return (self.uri,) |
61d37796da98
A bit of cleanup of the `Markup` Python implementation.
cmlenz
parents:
857
diff
changeset
|
637 |
61d37796da98
A bit of cleanup of the `Markup` Python implementation.
cmlenz
parents:
857
diff
changeset
|
638 def __getstate__(self): |
61d37796da98
A bit of cleanup of the `Markup` Python implementation.
cmlenz
parents:
857
diff
changeset
|
639 return self.uri |
61d37796da98
A bit of cleanup of the `Markup` Python implementation.
cmlenz
parents:
857
diff
changeset
|
640 |
61d37796da98
A bit of cleanup of the `Markup` Python implementation.
cmlenz
parents:
857
diff
changeset
|
641 def __setstate__(self, uri): |
61d37796da98
A bit of cleanup of the `Markup` Python implementation.
cmlenz
parents:
857
diff
changeset
|
642 self.uri = uri |
61d37796da98
A bit of cleanup of the `Markup` Python implementation.
cmlenz
parents:
857
diff
changeset
|
643 |
61d37796da98
A bit of cleanup of the `Markup` Python implementation.
cmlenz
parents:
857
diff
changeset
|
644 def __init__(self, uri): |
61d37796da98
A bit of cleanup of the `Markup` Python implementation.
cmlenz
parents:
857
diff
changeset
|
645 self.uri = unicode(uri) |
61d37796da98
A bit of cleanup of the `Markup` Python implementation.
cmlenz
parents:
857
diff
changeset
|
646 |
61d37796da98
A bit of cleanup of the `Markup` Python implementation.
cmlenz
parents:
857
diff
changeset
|
647 def __contains__(self, qname): |
61d37796da98
A bit of cleanup of the `Markup` Python implementation.
cmlenz
parents:
857
diff
changeset
|
648 return qname.namespace == self.uri |
61d37796da98
A bit of cleanup of the `Markup` Python implementation.
cmlenz
parents:
857
diff
changeset
|
649 |
61d37796da98
A bit of cleanup of the `Markup` Python implementation.
cmlenz
parents:
857
diff
changeset
|
650 def __ne__(self, other): |
61d37796da98
A bit of cleanup of the `Markup` Python implementation.
cmlenz
parents:
857
diff
changeset
|
651 return not self == other |
61d37796da98
A bit of cleanup of the `Markup` Python implementation.
cmlenz
parents:
857
diff
changeset
|
652 |
61d37796da98
A bit of cleanup of the `Markup` Python implementation.
cmlenz
parents:
857
diff
changeset
|
653 def __eq__(self, other): |
61d37796da98
A bit of cleanup of the `Markup` Python implementation.
cmlenz
parents:
857
diff
changeset
|
654 if isinstance(other, Namespace): |
61d37796da98
A bit of cleanup of the `Markup` Python implementation.
cmlenz
parents:
857
diff
changeset
|
655 return self.uri == other.uri |
61d37796da98
A bit of cleanup of the `Markup` Python implementation.
cmlenz
parents:
857
diff
changeset
|
656 return self.uri == other |
61d37796da98
A bit of cleanup of the `Markup` Python implementation.
cmlenz
parents:
857
diff
changeset
|
657 |
61d37796da98
A bit of cleanup of the `Markup` Python implementation.
cmlenz
parents:
857
diff
changeset
|
658 def __getitem__(self, name): |
61d37796da98
A bit of cleanup of the `Markup` Python implementation.
cmlenz
parents:
857
diff
changeset
|
659 return QName(self.uri + '}' + name) |
61d37796da98
A bit of cleanup of the `Markup` Python implementation.
cmlenz
parents:
857
diff
changeset
|
660 __getattr__ = __getitem__ |
61d37796da98
A bit of cleanup of the `Markup` Python implementation.
cmlenz
parents:
857
diff
changeset
|
661 |
61d37796da98
A bit of cleanup of the `Markup` Python implementation.
cmlenz
parents:
857
diff
changeset
|
662 def __hash__(self): |
61d37796da98
A bit of cleanup of the `Markup` Python implementation.
cmlenz
parents:
857
diff
changeset
|
663 return hash(self.uri) |
61d37796da98
A bit of cleanup of the `Markup` Python implementation.
cmlenz
parents:
857
diff
changeset
|
664 |
61d37796da98
A bit of cleanup of the `Markup` Python implementation.
cmlenz
parents:
857
diff
changeset
|
665 def __repr__(self): |
61d37796da98
A bit of cleanup of the `Markup` Python implementation.
cmlenz
parents:
857
diff
changeset
|
666 return 'Namespace(%s)' % stringrepr(self.uri) |
61d37796da98
A bit of cleanup of the `Markup` Python implementation.
cmlenz
parents:
857
diff
changeset
|
667 |
61d37796da98
A bit of cleanup of the `Markup` Python implementation.
cmlenz
parents:
857
diff
changeset
|
668 def __str__(self): |
61d37796da98
A bit of cleanup of the `Markup` Python implementation.
cmlenz
parents:
857
diff
changeset
|
669 return self.uri.encode('utf-8') |
61d37796da98
A bit of cleanup of the `Markup` Python implementation.
cmlenz
parents:
857
diff
changeset
|
670 |
61d37796da98
A bit of cleanup of the `Markup` Python implementation.
cmlenz
parents:
857
diff
changeset
|
671 def __unicode__(self): |
61d37796da98
A bit of cleanup of the `Markup` Python implementation.
cmlenz
parents:
857
diff
changeset
|
672 return self.uri |
61d37796da98
A bit of cleanup of the `Markup` Python implementation.
cmlenz
parents:
857
diff
changeset
|
673 |
61d37796da98
A bit of cleanup of the `Markup` Python implementation.
cmlenz
parents:
857
diff
changeset
|
674 |
61d37796da98
A bit of cleanup of the `Markup` Python implementation.
cmlenz
parents:
857
diff
changeset
|
675 # The namespace used by attributes such as xml:lang and xml:space |
61d37796da98
A bit of cleanup of the `Markup` Python implementation.
cmlenz
parents:
857
diff
changeset
|
676 XML_NAMESPACE = Namespace('http://www.w3.org/XML/1998/namespace') |
61d37796da98
A bit of cleanup of the `Markup` Python implementation.
cmlenz
parents:
857
diff
changeset
|
677 |
61d37796da98
A bit of cleanup of the `Markup` Python implementation.
cmlenz
parents:
857
diff
changeset
|
678 |
61d37796da98
A bit of cleanup of the `Markup` Python implementation.
cmlenz
parents:
857
diff
changeset
|
679 class QName(unicode): |
61d37796da98
A bit of cleanup of the `Markup` Python implementation.
cmlenz
parents:
857
diff
changeset
|
680 """A qualified element or attribute name. |
61d37796da98
A bit of cleanup of the `Markup` Python implementation.
cmlenz
parents:
857
diff
changeset
|
681 |
61d37796da98
A bit of cleanup of the `Markup` Python implementation.
cmlenz
parents:
857
diff
changeset
|
682 The unicode value of instances of this class contains the qualified name of |
61d37796da98
A bit of cleanup of the `Markup` Python implementation.
cmlenz
parents:
857
diff
changeset
|
683 the element or attribute, in the form ``{namespace-uri}local-name``. The |
61d37796da98
A bit of cleanup of the `Markup` Python implementation.
cmlenz
parents:
857
diff
changeset
|
684 namespace URI can be obtained through the additional `namespace` attribute, |
61d37796da98
A bit of cleanup of the `Markup` Python implementation.
cmlenz
parents:
857
diff
changeset
|
685 while the local name can be accessed through the `localname` attribute. |
61d37796da98
A bit of cleanup of the `Markup` Python implementation.
cmlenz
parents:
857
diff
changeset
|
686 |
61d37796da98
A bit of cleanup of the `Markup` Python implementation.
cmlenz
parents:
857
diff
changeset
|
687 >>> qname = QName('foo') |
61d37796da98
A bit of cleanup of the `Markup` Python implementation.
cmlenz
parents:
857
diff
changeset
|
688 >>> qname |
61d37796da98
A bit of cleanup of the `Markup` Python implementation.
cmlenz
parents:
857
diff
changeset
|
689 QName('foo') |
61d37796da98
A bit of cleanup of the `Markup` Python implementation.
cmlenz
parents:
857
diff
changeset
|
690 >>> qname.localname |
61d37796da98
A bit of cleanup of the `Markup` Python implementation.
cmlenz
parents:
857
diff
changeset
|
691 u'foo' |
61d37796da98
A bit of cleanup of the `Markup` Python implementation.
cmlenz
parents:
857
diff
changeset
|
692 >>> qname.namespace |
61d37796da98
A bit of cleanup of the `Markup` Python implementation.
cmlenz
parents:
857
diff
changeset
|
693 |
61d37796da98
A bit of cleanup of the `Markup` Python implementation.
cmlenz
parents:
857
diff
changeset
|
694 >>> qname = QName('http://www.w3.org/1999/xhtml}body') |
61d37796da98
A bit of cleanup of the `Markup` Python implementation.
cmlenz
parents:
857
diff
changeset
|
695 >>> qname |
61d37796da98
A bit of cleanup of the `Markup` Python implementation.
cmlenz
parents:
857
diff
changeset
|
696 QName('http://www.w3.org/1999/xhtml}body') |
61d37796da98
A bit of cleanup of the `Markup` Python implementation.
cmlenz
parents:
857
diff
changeset
|
697 >>> qname.localname |
61d37796da98
A bit of cleanup of the `Markup` Python implementation.
cmlenz
parents:
857
diff
changeset
|
698 u'body' |
61d37796da98
A bit of cleanup of the `Markup` Python implementation.
cmlenz
parents:
857
diff
changeset
|
699 >>> qname.namespace |
61d37796da98
A bit of cleanup of the `Markup` Python implementation.
cmlenz
parents:
857
diff
changeset
|
700 u'http://www.w3.org/1999/xhtml' |
61d37796da98
A bit of cleanup of the `Markup` Python implementation.
cmlenz
parents:
857
diff
changeset
|
701 """ |
61d37796da98
A bit of cleanup of the `Markup` Python implementation.
cmlenz
parents:
857
diff
changeset
|
702 __slots__ = ['namespace', 'localname'] |
61d37796da98
A bit of cleanup of the `Markup` Python implementation.
cmlenz
parents:
857
diff
changeset
|
703 |
61d37796da98
A bit of cleanup of the `Markup` Python implementation.
cmlenz
parents:
857
diff
changeset
|
704 def __new__(cls, qname): |
61d37796da98
A bit of cleanup of the `Markup` Python implementation.
cmlenz
parents:
857
diff
changeset
|
705 """Create the `QName` instance. |
61d37796da98
A bit of cleanup of the `Markup` Python implementation.
cmlenz
parents:
857
diff
changeset
|
706 |
61d37796da98
A bit of cleanup of the `Markup` Python implementation.
cmlenz
parents:
857
diff
changeset
|
707 :param qname: the qualified name as a string of the form |
61d37796da98
A bit of cleanup of the `Markup` Python implementation.
cmlenz
parents:
857
diff
changeset
|
708 ``{namespace-uri}local-name``, where the leading curly |
61d37796da98
A bit of cleanup of the `Markup` Python implementation.
cmlenz
parents:
857
diff
changeset
|
709 brace is optional |
61d37796da98
A bit of cleanup of the `Markup` Python implementation.
cmlenz
parents:
857
diff
changeset
|
710 """ |
61d37796da98
A bit of cleanup of the `Markup` Python implementation.
cmlenz
parents:
857
diff
changeset
|
711 if type(qname) is cls: |
61d37796da98
A bit of cleanup of the `Markup` Python implementation.
cmlenz
parents:
857
diff
changeset
|
712 return qname |
61d37796da98
A bit of cleanup of the `Markup` Python implementation.
cmlenz
parents:
857
diff
changeset
|
713 |
61d37796da98
A bit of cleanup of the `Markup` Python implementation.
cmlenz
parents:
857
diff
changeset
|
714 parts = qname.lstrip('{').split('}', 1) |
61d37796da98
A bit of cleanup of the `Markup` Python implementation.
cmlenz
parents:
857
diff
changeset
|
715 if len(parts) > 1: |
61d37796da98
A bit of cleanup of the `Markup` Python implementation.
cmlenz
parents:
857
diff
changeset
|
716 self = unicode.__new__(cls, '{%s' % qname) |
61d37796da98
A bit of cleanup of the `Markup` Python implementation.
cmlenz
parents:
857
diff
changeset
|
717 self.namespace, self.localname = map(unicode, parts) |
61d37796da98
A bit of cleanup of the `Markup` Python implementation.
cmlenz
parents:
857
diff
changeset
|
718 else: |
61d37796da98
A bit of cleanup of the `Markup` Python implementation.
cmlenz
parents:
857
diff
changeset
|
719 self = unicode.__new__(cls, qname) |
61d37796da98
A bit of cleanup of the `Markup` Python implementation.
cmlenz
parents:
857
diff
changeset
|
720 self.namespace, self.localname = None, unicode(qname) |
61d37796da98
A bit of cleanup of the `Markup` Python implementation.
cmlenz
parents:
857
diff
changeset
|
721 return self |
61d37796da98
A bit of cleanup of the `Markup` Python implementation.
cmlenz
parents:
857
diff
changeset
|
722 |
61d37796da98
A bit of cleanup of the `Markup` Python implementation.
cmlenz
parents:
857
diff
changeset
|
723 def __getnewargs__(self): |
61d37796da98
A bit of cleanup of the `Markup` Python implementation.
cmlenz
parents:
857
diff
changeset
|
724 return (self.lstrip('{'),) |
61d37796da98
A bit of cleanup of the `Markup` Python implementation.
cmlenz
parents:
857
diff
changeset
|
725 |
61d37796da98
A bit of cleanup of the `Markup` Python implementation.
cmlenz
parents:
857
diff
changeset
|
726 def __repr__(self): |
61d37796da98
A bit of cleanup of the `Markup` Python implementation.
cmlenz
parents:
857
diff
changeset
|
727 return 'QName(%s)' % stringrepr(self.lstrip('{')) |