genshi/mirror: genshi/core.py annotate

annotate genshi/core.py @ 326:f999da894391 trunk

Fixed `__repr__` of the `QName`, `Attrs`, and `Expression` classes so that the output can be used as code to instantiate the object again.

author	cmlenz
date	Thu, 02 Nov 2006 11:38:10 +0000
parents	a99666402b12
children	2aa7ca37ae6a

rev	line source
1 5479aae32f5a Initial import. cmlenz parents: diff changeset	1 # -- coding: utf-8 --
5479aae32f5a Initial import. cmlenz parents: diff changeset	2 #
66 59eb24184e9c Switch copyright to Edgewall and URLs to markup.edgewall.org. cmlenz parents: 54 diff changeset	3 # Copyright (C) 2006 Edgewall Software
1 5479aae32f5a Initial import. cmlenz parents: diff changeset	4 # All rights reserved.
5479aae32f5a Initial import. cmlenz parents: diff changeset	5 #
5479aae32f5a Initial import. cmlenz parents: diff changeset	6 # This software is licensed as described in the file COPYING, which
5479aae32f5a Initial import. cmlenz parents: diff changeset	7 # you should have received as part of this distribution. The terms
230 84168828b074 Renamed Markup to Genshi in repository. cmlenz parents: 224 diff changeset	8 # are also available at http://genshi.edgewall.org/wiki/License.
1 5479aae32f5a Initial import. cmlenz parents: diff changeset	9 #
5479aae32f5a Initial import. cmlenz parents: diff changeset	10 # This software consists of voluntary contributions made by many
5479aae32f5a Initial import. cmlenz parents: diff changeset	11 # individuals. For the exact contribution history, see the revision
230 84168828b074 Renamed Markup to Genshi in repository. cmlenz parents: 224 diff changeset	12 # history and logs, available at http://genshi.edgewall.org/log/.
1 5479aae32f5a Initial import. cmlenz parents: diff changeset	13
5479aae32f5a Initial import. cmlenz parents: diff changeset	14 """Core classes for markup processing."""
5479aae32f5a Initial import. cmlenz parents: diff changeset	15
5479aae32f5a Initial import. cmlenz parents: diff changeset	16 import htmlentitydefs
204 51d4101f49ca * Implement reverse add/mul operators for `Markup` class, so that the result is also a `Markup` instance. cmlenz parents: 200 diff changeset	17 import operator
1 5479aae32f5a Initial import. cmlenz parents: diff changeset	18 import re
5479aae32f5a Initial import. cmlenz parents: diff changeset	19
5479aae32f5a Initial import. cmlenz parents: diff changeset	20 __all__ = ['Stream', 'Markup', 'escape', 'unescape', 'Namespace', 'QName']
5479aae32f5a Initial import. cmlenz parents: diff changeset	21
5479aae32f5a Initial import. cmlenz parents: diff changeset	22
17 74cc70129d04 Refactoring to address #6: all match templates are now processed by a single filter, which means that match templates added by included templates are properly applied. A side effect of this refactoring is that `Context` objects may not be reused across multiple template processing runs. cmlenz parents: 10 diff changeset	23 class StreamEventKind(str):
1 5479aae32f5a Initial import. cmlenz parents: diff changeset	24 """A kind of event on an XML stream."""
279 a99666402b12 Some adjustments to make core data structures picklable (requires protocol 2). cmlenz parents: 278 diff changeset	25 __slots__ = []
a99666402b12 Some adjustments to make core data structures picklable (requires protocol 2). cmlenz parents: 278 diff changeset	26 _instances = {}
a99666402b12 Some adjustments to make core data structures picklable (requires protocol 2). cmlenz parents: 278 diff changeset	27
a99666402b12 Some adjustments to make core data structures picklable (requires protocol 2). cmlenz parents: 278 diff changeset	28 def __new__(cls, val):
a99666402b12 Some adjustments to make core data structures picklable (requires protocol 2). cmlenz parents: 278 diff changeset	29 return cls._instances.setdefault(val, str.__new__(cls, val))
1 5479aae32f5a Initial import. cmlenz parents: diff changeset	30
5479aae32f5a Initial import. cmlenz parents: diff changeset	31
5479aae32f5a Initial import. cmlenz parents: diff changeset	32 class Stream(object):
5479aae32f5a Initial import. cmlenz parents: diff changeset	33 """Represents a stream of markup events.
5479aae32f5a Initial import. cmlenz parents: diff changeset	34
5479aae32f5a Initial import. cmlenz parents: diff changeset	35 This class is basically an iterator over the events.
5479aae32f5a Initial import. cmlenz parents: diff changeset	36
5479aae32f5a Initial import. cmlenz parents: diff changeset	37 Also provided are ways to serialize the stream to text. The `serialize()`
5479aae32f5a Initial import. cmlenz parents: diff changeset	38 method will return an iterator over generated strings, while `render()`
5479aae32f5a Initial import. cmlenz parents: diff changeset	39 returns the complete generated text at once. Both accept various parameters
5479aae32f5a Initial import. cmlenz parents: diff changeset	40 that impact the way the stream is serialized.
5479aae32f5a Initial import. cmlenz parents: diff changeset	41
5479aae32f5a Initial import. cmlenz parents: diff changeset	42 Stream events are tuples of the form:
5479aae32f5a Initial import. cmlenz parents: diff changeset	43
5479aae32f5a Initial import. cmlenz parents: diff changeset	44 (kind, data, position)
5479aae32f5a Initial import. cmlenz parents: diff changeset	45
5479aae32f5a Initial import. cmlenz parents: diff changeset	46 where `kind` is the event kind (such as `START`, `END`, `TEXT`, etc), `data`
172 ff4f0d89eef7 Fix for #30 (trouble using `py:def`inside a match template) cmlenz parents: 171 diff changeset	47 depends on the kind of event, and `position` is a `(filename, line, offset)`
ff4f0d89eef7 Fix for #30 (trouble using `py:def`inside a match template) cmlenz parents: 171 diff changeset	48 tuple that contains the location of the original element or text in the
ff4f0d89eef7 Fix for #30 (trouble using `py:def`inside a match template) cmlenz parents: 171 diff changeset	49 input. If the original location is unknown, `position` is `(None, -1, -1)`.
1 5479aae32f5a Initial import. cmlenz parents: diff changeset	50 """
5479aae32f5a Initial import. cmlenz parents: diff changeset	51 __slots__ = ['events']
5479aae32f5a Initial import. cmlenz parents: diff changeset	52
17 74cc70129d04 Refactoring to address #6: all match templates are now processed by a single filter, which means that match templates added by included templates are properly applied. A side effect of this refactoring is that `Context` objects may not be reused across multiple template processing runs. cmlenz parents: 10 diff changeset	53 START = StreamEventKind('START') # a start tag
74cc70129d04 Refactoring to address #6: all match templates are now processed by a single filter, which means that match templates added by included templates are properly applied. A side effect of this refactoring is that `Context` objects may not be reused across multiple template processing runs. cmlenz parents: 10 diff changeset	54 END = StreamEventKind('END') # an end tag
74cc70129d04 Refactoring to address #6: all match templates are now processed by a single filter, which means that match templates added by included templates are properly applied. A side effect of this refactoring is that `Context` objects may not be reused across multiple template processing runs. cmlenz parents: 10 diff changeset	55 TEXT = StreamEventKind('TEXT') # literal text
74cc70129d04 Refactoring to address #6: all match templates are now processed by a single filter, which means that match templates added by included templates are properly applied. A side effect of this refactoring is that `Context` objects may not be reused across multiple template processing runs. cmlenz parents: 10 diff changeset	56 DOCTYPE = StreamEventKind('DOCTYPE') # doctype declaration
143 3d4c214c979a CDATA sections in XML input now appear as CDATA sections in the output. This should address the problem with escaping the contents of `<style>` and `<script>` elements, which would only get interpreted correctly if the output was served as `application/xhtml+xml`. Closes #24. cmlenz parents: 141 diff changeset	57 START_NS = StreamEventKind('START_NS') # start namespace mapping
3d4c214c979a CDATA sections in XML input now appear as CDATA sections in the output. This should address the problem with escaping the contents of `<style>` and `<script>` elements, which would only get interpreted correctly if the output was served as `application/xhtml+xml`. Closes #24. cmlenz parents: 141 diff changeset	58 END_NS = StreamEventKind('END_NS') # end namespace mapping
3d4c214c979a CDATA sections in XML input now appear as CDATA sections in the output. This should address the problem with escaping the contents of `<style>` and `<script>` elements, which would only get interpreted correctly if the output was served as `application/xhtml+xml`. Closes #24. cmlenz parents: 141 diff changeset	59 START_CDATA = StreamEventKind('START_CDATA') # start CDATA section
3d4c214c979a CDATA sections in XML input now appear as CDATA sections in the output. This should address the problem with escaping the contents of `<style>` and `<script>` elements, which would only get interpreted correctly if the output was served as `application/xhtml+xml`. Closes #24. cmlenz parents: 141 diff changeset	60 END_CDATA = StreamEventKind('END_CDATA') # end CDATA section
17 74cc70129d04 Refactoring to address #6: all match templates are now processed by a single filter, which means that match templates added by included templates are properly applied. A side effect of this refactoring is that `Context` objects may not be reused across multiple template processing runs. cmlenz parents: 10 diff changeset	61 PI = StreamEventKind('PI') # processing instruction
74cc70129d04 Refactoring to address #6: all match templates are now processed by a single filter, which means that match templates added by included templates are properly applied. A side effect of this refactoring is that `Context` objects may not be reused across multiple template processing runs. cmlenz parents: 10 diff changeset	62 COMMENT = StreamEventKind('COMMENT') # comment
1 5479aae32f5a Initial import. cmlenz parents: diff changeset	63
5479aae32f5a Initial import. cmlenz parents: diff changeset	64 def __init__(self, events):
5479aae32f5a Initial import. cmlenz parents: diff changeset	65 """Initialize the stream with a sequence of markup events.
5479aae32f5a Initial import. cmlenz parents: diff changeset	66
27 b4f78c05e5c9 * Fix the boilerplate in the Python source files. cmlenz parents: 18 diff changeset	67 @param events: a sequence or iterable providing the events
1 5479aae32f5a Initial import. cmlenz parents: diff changeset	68 """
5479aae32f5a Initial import. cmlenz parents: diff changeset	69 self.events = events
5479aae32f5a Initial import. cmlenz parents: diff changeset	70
5479aae32f5a Initial import. cmlenz parents: diff changeset	71 def __iter__(self):
5479aae32f5a Initial import. cmlenz parents: diff changeset	72 return iter(self.events)
5479aae32f5a Initial import. cmlenz parents: diff changeset	73
204 51d4101f49ca * Implement reverse add/mul operators for `Markup` class, so that the result is also a `Markup` instance. cmlenz parents: 200 diff changeset	74 def __or__(self, function):
51d4101f49ca * Implement reverse add/mul operators for `Markup` class, so that the result is also a `Markup` instance. cmlenz parents: 200 diff changeset	75 """Override the "bitwise or" operator to apply filters or serializers
51d4101f49ca * Implement reverse add/mul operators for `Markup` class, so that the result is also a `Markup` instance. cmlenz parents: 200 diff changeset	76 to the stream, providing a syntax similar to pipes on Unix shells.
51d4101f49ca * Implement reverse add/mul operators for `Markup` class, so that the result is also a `Markup` instance. cmlenz parents: 200 diff changeset	77
51d4101f49ca * Implement reverse add/mul operators for `Markup` class, so that the result is also a `Markup` instance. cmlenz parents: 200 diff changeset	78 Assume the following stream produced by the `HTML` function:
51d4101f49ca * Implement reverse add/mul operators for `Markup` class, so that the result is also a `Markup` instance. cmlenz parents: 200 diff changeset	79
230 84168828b074 Renamed Markup to Genshi in repository. cmlenz parents: 224 diff changeset	80 >>> from genshi.input import HTML
204 51d4101f49ca * Implement reverse add/mul operators for `Markup` class, so that the result is also a `Markup` instance. cmlenz parents: 200 diff changeset	81 >>> html = HTML('''<p onclick="alert('Whoa')">Hello, world!</p>''')
51d4101f49ca * Implement reverse add/mul operators for `Markup` class, so that the result is also a `Markup` instance. cmlenz parents: 200 diff changeset	82 >>> print html
51d4101f49ca * Implement reverse add/mul operators for `Markup` class, so that the result is also a `Markup` instance. cmlenz parents: 200 diff changeset	83 <p onclick="alert('Whoa')">Hello, world!</p>
51d4101f49ca * Implement reverse add/mul operators for `Markup` class, so that the result is also a `Markup` instance. cmlenz parents: 200 diff changeset	84
51d4101f49ca * Implement reverse add/mul operators for `Markup` class, so that the result is also a `Markup` instance. cmlenz parents: 200 diff changeset	85 A filter such as the HTML sanitizer can be applied to that stream using
51d4101f49ca * Implement reverse add/mul operators for `Markup` class, so that the result is also a `Markup` instance. cmlenz parents: 200 diff changeset	86 the pipe notation as follows:
51d4101f49ca * Implement reverse add/mul operators for `Markup` class, so that the result is also a `Markup` instance. cmlenz parents: 200 diff changeset	87
230 84168828b074 Renamed Markup to Genshi in repository. cmlenz parents: 224 diff changeset	88 >>> from genshi.filters import HTMLSanitizer
204 51d4101f49ca * Implement reverse add/mul operators for `Markup` class, so that the result is also a `Markup` instance. cmlenz parents: 200 diff changeset	89 >>> sanitizer = HTMLSanitizer()
51d4101f49ca * Implement reverse add/mul operators for `Markup` class, so that the result is also a `Markup` instance. cmlenz parents: 200 diff changeset	90 >>> print html \| sanitizer
51d4101f49ca * Implement reverse add/mul operators for `Markup` class, so that the result is also a `Markup` instance. cmlenz parents: 200 diff changeset	91 <p>Hello, world!</p>
51d4101f49ca * Implement reverse add/mul operators for `Markup` class, so that the result is also a `Markup` instance. cmlenz parents: 200 diff changeset	92
51d4101f49ca * Implement reverse add/mul operators for `Markup` class, so that the result is also a `Markup` instance. cmlenz parents: 200 diff changeset	93 Filters can be any function that accepts and produces a stream (where
51d4101f49ca * Implement reverse add/mul operators for `Markup` class, so that the result is also a `Markup` instance. cmlenz parents: 200 diff changeset	94 a stream is anything that iterators over events):
51d4101f49ca * Implement reverse add/mul operators for `Markup` class, so that the result is also a `Markup` instance. cmlenz parents: 200 diff changeset	95
51d4101f49ca * Implement reverse add/mul operators for `Markup` class, so that the result is also a `Markup` instance. cmlenz parents: 200 diff changeset	96 >>> def uppercase(stream):
51d4101f49ca * Implement reverse add/mul operators for `Markup` class, so that the result is also a `Markup` instance. cmlenz parents: 200 diff changeset	97 ... for kind, data, pos in stream:
51d4101f49ca * Implement reverse add/mul operators for `Markup` class, so that the result is also a `Markup` instance. cmlenz parents: 200 diff changeset	98 ... if kind is TEXT:
51d4101f49ca * Implement reverse add/mul operators for `Markup` class, so that the result is also a `Markup` instance. cmlenz parents: 200 diff changeset	99 ... data = data.upper()
51d4101f49ca * Implement reverse add/mul operators for `Markup` class, so that the result is also a `Markup` instance. cmlenz parents: 200 diff changeset	100 ... yield kind, data, pos
51d4101f49ca * Implement reverse add/mul operators for `Markup` class, so that the result is also a `Markup` instance. cmlenz parents: 200 diff changeset	101 >>> print html \| sanitizer \| uppercase
51d4101f49ca * Implement reverse add/mul operators for `Markup` class, so that the result is also a `Markup` instance. cmlenz parents: 200 diff changeset	102 <p>HELLO, WORLD!</p>
51d4101f49ca * Implement reverse add/mul operators for `Markup` class, so that the result is also a `Markup` instance. cmlenz parents: 200 diff changeset	103
51d4101f49ca * Implement reverse add/mul operators for `Markup` class, so that the result is also a `Markup` instance. cmlenz parents: 200 diff changeset	104 Serializers can also be used with this notation:
51d4101f49ca * Implement reverse add/mul operators for `Markup` class, so that the result is also a `Markup` instance. cmlenz parents: 200 diff changeset	105
230 84168828b074 Renamed Markup to Genshi in repository. cmlenz parents: 224 diff changeset	106 >>> from genshi.output import TextSerializer
204 51d4101f49ca * Implement reverse add/mul operators for `Markup` class, so that the result is also a `Markup` instance. cmlenz parents: 200 diff changeset	107 >>> output = TextSerializer()
51d4101f49ca * Implement reverse add/mul operators for `Markup` class, so that the result is also a `Markup` instance. cmlenz parents: 200 diff changeset	108 >>> print html \| sanitizer \| uppercase \| output
51d4101f49ca * Implement reverse add/mul operators for `Markup` class, so that the result is also a `Markup` instance. cmlenz parents: 200 diff changeset	109 HELLO, WORLD!
51d4101f49ca * Implement reverse add/mul operators for `Markup` class, so that the result is also a `Markup` instance. cmlenz parents: 200 diff changeset	110
51d4101f49ca * Implement reverse add/mul operators for `Markup` class, so that the result is also a `Markup` instance. cmlenz parents: 200 diff changeset	111 Commonly, serializers should be used at the end of the "pipeline";
51d4101f49ca * Implement reverse add/mul operators for `Markup` class, so that the result is also a `Markup` instance. cmlenz parents: 200 diff changeset	112 using them somewhere in the middle may produce unexpected results.
51d4101f49ca * Implement reverse add/mul operators for `Markup` class, so that the result is also a `Markup` instance. cmlenz parents: 200 diff changeset	113 """
51d4101f49ca * Implement reverse add/mul operators for `Markup` class, so that the result is also a `Markup` instance. cmlenz parents: 200 diff changeset	114 return Stream(_ensure(function(self)))
51d4101f49ca * Implement reverse add/mul operators for `Markup` class, so that the result is also a `Markup` instance. cmlenz parents: 200 diff changeset	115
123 10279d2eeec9 Fix for #18: whitespace in space-sensitive elements such as `<pre>` and `<textarea>` is now preserved. cmlenz parents: 116 diff changeset	116 def filter(self, *filters):
10279d2eeec9 Fix for #18: whitespace in space-sensitive elements such as `<pre>` and `<textarea>` is now preserved. cmlenz parents: 116 diff changeset	117 """Apply filters to the stream.
113 d10fbba1d5e0 Removed the `sanitize()` method from the `Markup` class, and migrate the existing unit tests to `markup.tests.filters`. Provide a `Stream.filter()` method instead which can be used to conveniently apply a filter to a stream. cmlenz parents: 111 diff changeset	118
123 10279d2eeec9 Fix for #18: whitespace in space-sensitive elements such as `<pre>` and `<textarea>` is now preserved. cmlenz parents: 116 diff changeset	119 This method returns a new stream with the given filters applied. The
10279d2eeec9 Fix for #18: whitespace in space-sensitive elements such as `<pre>` and `<textarea>` is now preserved. cmlenz parents: 116 diff changeset	120 filters must be callables that accept the stream object as parameter,
10279d2eeec9 Fix for #18: whitespace in space-sensitive elements such as `<pre>` and `<textarea>` is now preserved. cmlenz parents: 116 diff changeset	121 and return the filtered stream.
204 51d4101f49ca * Implement reverse add/mul operators for `Markup` class, so that the result is also a `Markup` instance. cmlenz parents: 200 diff changeset	122
51d4101f49ca * Implement reverse add/mul operators for `Markup` class, so that the result is also a `Markup` instance. cmlenz parents: 200 diff changeset	123 The call:
51d4101f49ca * Implement reverse add/mul operators for `Markup` class, so that the result is also a `Markup` instance. cmlenz parents: 200 diff changeset	124
51d4101f49ca * Implement reverse add/mul operators for `Markup` class, so that the result is also a `Markup` instance. cmlenz parents: 200 diff changeset	125 stream.filter(filter1, filter2)
51d4101f49ca * Implement reverse add/mul operators for `Markup` class, so that the result is also a `Markup` instance. cmlenz parents: 200 diff changeset	126
51d4101f49ca * Implement reverse add/mul operators for `Markup` class, so that the result is also a `Markup` instance. cmlenz parents: 200 diff changeset	127 is equivalent to:
51d4101f49ca * Implement reverse add/mul operators for `Markup` class, so that the result is also a `Markup` instance. cmlenz parents: 200 diff changeset	128
51d4101f49ca * Implement reverse add/mul operators for `Markup` class, so that the result is also a `Markup` instance. cmlenz parents: 200 diff changeset	129 stream \| filter1 \| filter2
113 d10fbba1d5e0 Removed the `sanitize()` method from the `Markup` class, and migrate the existing unit tests to `markup.tests.filters`. Provide a `Stream.filter()` method instead which can be used to conveniently apply a filter to a stream. cmlenz parents: 111 diff changeset	130 """
204 51d4101f49ca * Implement reverse add/mul operators for `Markup` class, so that the result is also a `Markup` instance. cmlenz parents: 200 diff changeset	131 return reduce(operator.or_, (self,) + filters)
113 d10fbba1d5e0 Removed the `sanitize()` method from the `Markup` class, and migrate the existing unit tests to `markup.tests.filters`. Provide a `Stream.filter()` method instead which can be used to conveniently apply a filter to a stream. cmlenz parents: 111 diff changeset	132
123 10279d2eeec9 Fix for #18: whitespace in space-sensitive elements such as `<pre>` and `<textarea>` is now preserved. cmlenz parents: 116 diff changeset	133 def render(self, method='xml', encoding='utf-8', **kwargs):
1 5479aae32f5a Initial import. cmlenz parents: diff changeset	134 """Return a string representation of the stream.
5479aae32f5a Initial import. cmlenz parents: diff changeset	135
5479aae32f5a Initial import. cmlenz parents: diff changeset	136 @param method: determines how the stream is serialized; can be either
200 5861f4446c26 Add serialization to plain text, based on cboos' patch. Closes #41. cmlenz parents: 182 diff changeset	137 "xml", "xhtml", "html", "text", or a custom serializer
5861f4446c26 Add serialization to plain text, based on cboos' patch. Closes #41. cmlenz parents: 182 diff changeset	138 class
1 5479aae32f5a Initial import. cmlenz parents: diff changeset	139 @param encoding: how the output string should be encoded; if set to
5479aae32f5a Initial import. cmlenz parents: diff changeset	140 `None`, this method returns a `unicode` object
5479aae32f5a Initial import. cmlenz parents: diff changeset	141
5479aae32f5a Initial import. cmlenz parents: diff changeset	142 Any additional keyword arguments are passed to the serializer, and thus
5479aae32f5a Initial import. cmlenz parents: diff changeset	143 depend on the `method` parameter value.
5479aae32f5a Initial import. cmlenz parents: diff changeset	144 """
123 10279d2eeec9 Fix for #18: whitespace in space-sensitive elements such as `<pre>` and `<textarea>` is now preserved. cmlenz parents: 116 diff changeset	145 generator = self.serialize(method=method, **kwargs)
17 74cc70129d04 Refactoring to address #6: all match templates are now processed by a single filter, which means that match templates added by included templates are properly applied. A side effect of this refactoring is that `Context` objects may not be reused across multiple template processing runs. cmlenz parents: 10 diff changeset	146 output = u''.join(list(generator))
1 5479aae32f5a Initial import. cmlenz parents: diff changeset	147 if encoding is not None:
200 5861f4446c26 Add serialization to plain text, based on cboos' patch. Closes #41. cmlenz parents: 182 diff changeset	148 errors = 'replace'
5861f4446c26 Add serialization to plain text, based on cboos' patch. Closes #41. cmlenz parents: 182 diff changeset	149 if method != 'text':
5861f4446c26 Add serialization to plain text, based on cboos' patch. Closes #41. cmlenz parents: 182 diff changeset	150 errors = 'xmlcharrefreplace'
5861f4446c26 Add serialization to plain text, based on cboos' patch. Closes #41. cmlenz parents: 182 diff changeset	151 return output.encode(encoding, errors)
8 3710e3d0d4a2 `Stream.render()` was masking `TypeError`s (fix based on suggestion by Matt Good). cmlenz parents: 6 diff changeset	152 return output
1 5479aae32f5a Initial import. cmlenz parents: diff changeset	153
278 d6c58473a9d0 Fix the handling of namespace context for match templates. cmlenz parents: 230 diff changeset	154 def select(self, path, namespaces=None, variables=None):
1 5479aae32f5a Initial import. cmlenz parents: diff changeset	155 """Return a new stream that contains the events matching the given
5479aae32f5a Initial import. cmlenz parents: diff changeset	156 XPath expression.
5479aae32f5a Initial import. cmlenz parents: diff changeset	157
5479aae32f5a Initial import. cmlenz parents: diff changeset	158 @param path: a string containing the XPath expression
5479aae32f5a Initial import. cmlenz parents: diff changeset	159 """
230 84168828b074 Renamed Markup to Genshi in repository. cmlenz parents: 224 diff changeset	160 from genshi.path import Path
278 d6c58473a9d0 Fix the handling of namespace context for match templates. cmlenz parents: 230 diff changeset	161 return Path(path).select(self, namespaces, variables)
1 5479aae32f5a Initial import. cmlenz parents: diff changeset	162
123 10279d2eeec9 Fix for #18: whitespace in space-sensitive elements such as `<pre>` and `<textarea>` is now preserved. cmlenz parents: 116 diff changeset	163 def serialize(self, method='xml', **kwargs):
1 5479aae32f5a Initial import. cmlenz parents: diff changeset	164 """Generate strings corresponding to a specific serialization of the
5479aae32f5a Initial import. cmlenz parents: diff changeset	165 stream.
5479aae32f5a Initial import. cmlenz parents: diff changeset	166
18 5420cfe42d36 Actually make use of the `markup.core.Namespace` class, and add a couple of doctests. cmlenz parents: 17 diff changeset	167 Unlike the `render()` method, this method is a generator that returns
1 5479aae32f5a Initial import. cmlenz parents: diff changeset	168 the serialized output incrementally, as opposed to returning a single
5479aae32f5a Initial import. cmlenz parents: diff changeset	169 string.
5479aae32f5a Initial import. cmlenz parents: diff changeset	170
5479aae32f5a Initial import. cmlenz parents: diff changeset	171 @param method: determines how the stream is serialized; can be either
200 5861f4446c26 Add serialization to plain text, based on cboos' patch. Closes #41. cmlenz parents: 182 diff changeset	172 "xml", "xhtml", "html", "text", or a custom serializer
5861f4446c26 Add serialization to plain text, based on cboos' patch. Closes #41. cmlenz parents: 182 diff changeset	173 class
147 a4a0ca41b6ad Use `xmlcharrefreplace` when encoding the output in `Stream.render()`, so that encoding the output to legacy encodings such as ASCII or ISO-8859-1 should always work. cmlenz parents: 145 diff changeset	174
a4a0ca41b6ad Use `xmlcharrefreplace` when encoding the output in `Stream.render()`, so that encoding the output to legacy encodings such as ASCII or ISO-8859-1 should always work. cmlenz parents: 145 diff changeset	175 Any additional keyword arguments are passed to the serializer, and thus
a4a0ca41b6ad Use `xmlcharrefreplace` when encoding the output in `Stream.render()`, so that encoding the output to legacy encodings such as ASCII or ISO-8859-1 should always work. cmlenz parents: 145 diff changeset	176 depend on the `method` parameter value.
1 5479aae32f5a Initial import. cmlenz parents: diff changeset	177 """
230 84168828b074 Renamed Markup to Genshi in repository. cmlenz parents: 224 diff changeset	178 from genshi import output
1 5479aae32f5a Initial import. cmlenz parents: diff changeset	179 cls = method
5479aae32f5a Initial import. cmlenz parents: diff changeset	180 if isinstance(method, basestring):
96 fa08aef181a2 Add an XHTML serialization method. Now really need to get rid of some code duplication in the `markup.output` module. cmlenz parents: 91 diff changeset	181 cls = {'xml': output.XMLSerializer,
fa08aef181a2 Add an XHTML serialization method. Now really need to get rid of some code duplication in the `markup.output` module. cmlenz parents: 91 diff changeset	182 'xhtml': output.XHTMLSerializer,
200 5861f4446c26 Add serialization to plain text, based on cboos' patch. Closes #41. cmlenz parents: 182 diff changeset	183 'html': output.HTMLSerializer,
5861f4446c26 Add serialization to plain text, based on cboos' patch. Closes #41. cmlenz parents: 182 diff changeset	184 'text': output.TextSerializer}[method]
204 51d4101f49ca * Implement reverse add/mul operators for `Markup` class, so that the result is also a `Markup` instance. cmlenz parents: 200 diff changeset	185 return cls(**kwargs)(_ensure(self))
1 5479aae32f5a Initial import. cmlenz parents: diff changeset	186
5479aae32f5a Initial import. cmlenz parents: diff changeset	187 def __str__(self):
5479aae32f5a Initial import. cmlenz parents: diff changeset	188 return self.render()
5479aae32f5a Initial import. cmlenz parents: diff changeset	189
5479aae32f5a Initial import. cmlenz parents: diff changeset	190 def __unicode__(self):
5479aae32f5a Initial import. cmlenz parents: diff changeset	191 return self.render(encoding=None)
5479aae32f5a Initial import. cmlenz parents: diff changeset	192
5479aae32f5a Initial import. cmlenz parents: diff changeset	193
69 c40a5dcd2b55 A couple of minor performance improvements. cmlenz parents: 66 diff changeset	194 START = Stream.START
c40a5dcd2b55 A couple of minor performance improvements. cmlenz parents: 66 diff changeset	195 END = Stream.END
c40a5dcd2b55 A couple of minor performance improvements. cmlenz parents: 66 diff changeset	196 TEXT = Stream.TEXT
c40a5dcd2b55 A couple of minor performance improvements. cmlenz parents: 66 diff changeset	197 DOCTYPE = Stream.DOCTYPE
c40a5dcd2b55 A couple of minor performance improvements. cmlenz parents: 66 diff changeset	198 START_NS = Stream.START_NS
c40a5dcd2b55 A couple of minor performance improvements. cmlenz parents: 66 diff changeset	199 END_NS = Stream.END_NS
143 3d4c214c979a CDATA sections in XML input now appear as CDATA sections in the output. This should address the problem with escaping the contents of `<style>` and `<script>` elements, which would only get interpreted correctly if the output was served as `application/xhtml+xml`. Closes #24. cmlenz parents: 141 diff changeset	200 START_CDATA = Stream.START_CDATA
3d4c214c979a CDATA sections in XML input now appear as CDATA sections in the output. This should address the problem with escaping the contents of `<style>` and `<script>` elements, which would only get interpreted correctly if the output was served as `application/xhtml+xml`. Closes #24. cmlenz parents: 141 diff changeset	201 END_CDATA = Stream.END_CDATA
69 c40a5dcd2b55 A couple of minor performance improvements. cmlenz parents: 66 diff changeset	202 PI = Stream.PI
c40a5dcd2b55 A couple of minor performance improvements. cmlenz parents: 66 diff changeset	203 COMMENT = Stream.COMMENT
c40a5dcd2b55 A couple of minor performance improvements. cmlenz parents: 66 diff changeset	204
111 2368c3becc52 Some fixes and more unit tests for the XPath engine. cmlenz parents: 100 diff changeset	205 def _ensure(stream):
2368c3becc52 Some fixes and more unit tests for the XPath engine. cmlenz parents: 100 diff changeset	206 """Ensure that every item on the stream is actually a markup event."""
2368c3becc52 Some fixes and more unit tests for the XPath engine. cmlenz parents: 100 diff changeset	207 for event in stream:
145 47bbd9d2a5af * Fix error in expression evaluation when the expression evaluates to an iterable that does not produce event tuples. cmlenz parents: 143 diff changeset	208 if type(event) is not tuple:
47bbd9d2a5af * Fix error in expression evaluation when the expression evaluates to an iterable that does not produce event tuples. cmlenz parents: 143 diff changeset	209 if hasattr(event, 'totuple'):
47bbd9d2a5af * Fix error in expression evaluation when the expression evaluates to an iterable that does not produce event tuples. cmlenz parents: 143 diff changeset	210 event = event.totuple()
47bbd9d2a5af * Fix error in expression evaluation when the expression evaluates to an iterable that does not produce event tuples. cmlenz parents: 143 diff changeset	211 else:
47bbd9d2a5af * Fix error in expression evaluation when the expression evaluates to an iterable that does not produce event tuples. cmlenz parents: 143 diff changeset	212 event = TEXT, unicode(event), (None, -1, -1)
47bbd9d2a5af * Fix error in expression evaluation when the expression evaluates to an iterable that does not produce event tuples. cmlenz parents: 143 diff changeset	213 yield event
111 2368c3becc52 Some fixes and more unit tests for the XPath engine. cmlenz parents: 100 diff changeset	214
69 c40a5dcd2b55 A couple of minor performance improvements. cmlenz parents: 66 diff changeset	215
182 2f30ce3fb85e Renamed `Attributes` to `Attrs` to reduce the verbosity. cmlenz parents: 172 diff changeset	216 class Attrs(list):
18 5420cfe42d36 Actually make use of the `markup.core.Namespace` class, and add a couple of doctests. cmlenz parents: 17 diff changeset	217 """Sequence type that stores the attributes of an element.
5420cfe42d36 Actually make use of the `markup.core.Namespace` class, and add a couple of doctests. cmlenz parents: 17 diff changeset	218
5420cfe42d36 Actually make use of the `markup.core.Namespace` class, and add a couple of doctests. cmlenz parents: 17 diff changeset	219 The order of the attributes is preserved, while accessing and manipulating
5420cfe42d36 Actually make use of the `markup.core.Namespace` class, and add a couple of doctests. cmlenz parents: 17 diff changeset	220 attributes by name is also supported.
5420cfe42d36 Actually make use of the `markup.core.Namespace` class, and add a couple of doctests. cmlenz parents: 17 diff changeset	221
182 2f30ce3fb85e Renamed `Attributes` to `Attrs` to reduce the verbosity. cmlenz parents: 172 diff changeset	222 >>> attrs = Attrs([('href', '#'), ('title', 'Foo')])
18 5420cfe42d36 Actually make use of the `markup.core.Namespace` class, and add a couple of doctests. cmlenz parents: 17 diff changeset	223 >>> attrs
326 f999da894391 Fixed `__repr__` of the `QName`, `Attrs`, and `Expression` classes so that the output can be used as code to instantiate the object again. cmlenz parents: 279 diff changeset	224 Attrs([(QName(u'href'), '#'), (QName(u'title'), 'Foo')])
18 5420cfe42d36 Actually make use of the `markup.core.Namespace` class, and add a couple of doctests. cmlenz parents: 17 diff changeset	225
5420cfe42d36 Actually make use of the `markup.core.Namespace` class, and add a couple of doctests. cmlenz parents: 17 diff changeset	226 >>> 'href' in attrs
5420cfe42d36 Actually make use of the `markup.core.Namespace` class, and add a couple of doctests. cmlenz parents: 17 diff changeset	227 True
5420cfe42d36 Actually make use of the `markup.core.Namespace` class, and add a couple of doctests. cmlenz parents: 17 diff changeset	228 >>> 'tabindex' in attrs
5420cfe42d36 Actually make use of the `markup.core.Namespace` class, and add a couple of doctests. cmlenz parents: 17 diff changeset	229 False
5420cfe42d36 Actually make use of the `markup.core.Namespace` class, and add a couple of doctests. cmlenz parents: 17 diff changeset	230
5420cfe42d36 Actually make use of the `markup.core.Namespace` class, and add a couple of doctests. cmlenz parents: 17 diff changeset	231 >>> attrs.get(u'title')
5420cfe42d36 Actually make use of the `markup.core.Namespace` class, and add a couple of doctests. cmlenz parents: 17 diff changeset	232 'Foo'
5420cfe42d36 Actually make use of the `markup.core.Namespace` class, and add a couple of doctests. cmlenz parents: 17 diff changeset	233 >>> attrs.set(u'title', 'Bar')
5420cfe42d36 Actually make use of the `markup.core.Namespace` class, and add a couple of doctests. cmlenz parents: 17 diff changeset	234 >>> attrs
326 f999da894391 Fixed `__repr__` of the `QName`, `Attrs`, and `Expression` classes so that the output can be used as code to instantiate the object again. cmlenz parents: 279 diff changeset	235 Attrs([(QName(u'href'), '#'), (QName(u'title'), 'Bar')])
18 5420cfe42d36 Actually make use of the `markup.core.Namespace` class, and add a couple of doctests. cmlenz parents: 17 diff changeset	236 >>> attrs.remove(u'title')
5420cfe42d36 Actually make use of the `markup.core.Namespace` class, and add a couple of doctests. cmlenz parents: 17 diff changeset	237 >>> attrs
326 f999da894391 Fixed `__repr__` of the `QName`, `Attrs`, and `Expression` classes so that the output can be used as code to instantiate the object again. cmlenz parents: 279 diff changeset	238 Attrs([(QName(u'href'), '#')])
18 5420cfe42d36 Actually make use of the `markup.core.Namespace` class, and add a couple of doctests. cmlenz parents: 17 diff changeset	239
5420cfe42d36 Actually make use of the `markup.core.Namespace` class, and add a couple of doctests. cmlenz parents: 17 diff changeset	240 New attributes added using the `set()` method are appended to the end of
5420cfe42d36 Actually make use of the `markup.core.Namespace` class, and add a couple of doctests. cmlenz parents: 17 diff changeset	241 the list:
5420cfe42d36 Actually make use of the `markup.core.Namespace` class, and add a couple of doctests. cmlenz parents: 17 diff changeset	242
5420cfe42d36 Actually make use of the `markup.core.Namespace` class, and add a couple of doctests. cmlenz parents: 17 diff changeset	243 >>> attrs.set(u'accesskey', 'k')
5420cfe42d36 Actually make use of the `markup.core.Namespace` class, and add a couple of doctests. cmlenz parents: 17 diff changeset	244 >>> attrs
326 f999da894391 Fixed `__repr__` of the `QName`, `Attrs`, and `Expression` classes so that the output can be used as code to instantiate the object again. cmlenz parents: 279 diff changeset	245 Attrs([(QName(u'href'), '#'), (QName(u'accesskey'), 'k')])
170 6b265e02d099 Allow initialization of `Attributes` with keyword arguments. cmlenz parents: 161 diff changeset	246
182 2f30ce3fb85e Renamed `Attributes` to `Attrs` to reduce the verbosity. cmlenz parents: 172 diff changeset	247 An `Attrs` instance can also be initialized with keyword arguments.
170 6b265e02d099 Allow initialization of `Attributes` with keyword arguments. cmlenz parents: 161 diff changeset	248
182 2f30ce3fb85e Renamed `Attributes` to `Attrs` to reduce the verbosity. cmlenz parents: 172 diff changeset	249 >>> attrs = Attrs(class_='bar', href='#', title='Foo')
171 7fcf8e04514e Follow-up to [214]: allow initializing `Attributes` with attribute names that contain dashes or conflict with a reserved word (such as ?class?.) cmlenz parents: 170 diff changeset	250 >>> attrs.get('class')
7fcf8e04514e Follow-up to [214]: allow initializing `Attributes` with attribute names that contain dashes or conflict with a reserved word (such as ?class?.) cmlenz parents: 170 diff changeset	251 'bar'
170 6b265e02d099 Allow initialization of `Attributes` with keyword arguments. cmlenz parents: 161 diff changeset	252 >>> attrs.get('href')
6b265e02d099 Allow initialization of `Attributes` with keyword arguments. cmlenz parents: 161 diff changeset	253 '#'
6b265e02d099 Allow initialization of `Attributes` with keyword arguments. cmlenz parents: 161 diff changeset	254 >>> attrs.get('title')
6b265e02d099 Allow initialization of `Attributes` with keyword arguments. cmlenz parents: 161 diff changeset	255 'Foo'
171 7fcf8e04514e Follow-up to [214]: allow initializing `Attributes` with attribute names that contain dashes or conflict with a reserved word (such as ?class?.) cmlenz parents: 170 diff changeset	256
7fcf8e04514e Follow-up to [214]: allow initializing `Attributes` with attribute names that contain dashes or conflict with a reserved word (such as ?class?.) cmlenz parents: 170 diff changeset	257 Reserved words can be used by appending a trailing underscore to the name,
7fcf8e04514e Follow-up to [214]: allow initializing `Attributes` with attribute names that contain dashes or conflict with a reserved word (such as ?class?.) cmlenz parents: 170 diff changeset	258 and any other underscore is replaced by a dash:
7fcf8e04514e Follow-up to [214]: allow initializing `Attributes` with attribute names that contain dashes or conflict with a reserved word (such as ?class?.) cmlenz parents: 170 diff changeset	259
182 2f30ce3fb85e Renamed `Attributes` to `Attrs` to reduce the verbosity. cmlenz parents: 172 diff changeset	260 >>> attrs = Attrs(class_='bar', accept_charset='utf-8')
171 7fcf8e04514e Follow-up to [214]: allow initializing `Attributes` with attribute names that contain dashes or conflict with a reserved word (such as ?class?.) cmlenz parents: 170 diff changeset	261 >>> attrs.get('class')
7fcf8e04514e Follow-up to [214]: allow initializing `Attributes` with attribute names that contain dashes or conflict with a reserved word (such as ?class?.) cmlenz parents: 170 diff changeset	262 'bar'
7fcf8e04514e Follow-up to [214]: allow initializing `Attributes` with attribute names that contain dashes or conflict with a reserved word (such as ?class?.) cmlenz parents: 170 diff changeset	263 >>> attrs.get('accept-charset')
7fcf8e04514e Follow-up to [214]: allow initializing `Attributes` with attribute names that contain dashes or conflict with a reserved word (such as ?class?.) cmlenz parents: 170 diff changeset	264 'utf-8'
7fcf8e04514e Follow-up to [214]: allow initializing `Attributes` with attribute names that contain dashes or conflict with a reserved word (such as ?class?.) cmlenz parents: 170 diff changeset	265
7fcf8e04514e Follow-up to [214]: allow initializing `Attributes` with attribute names that contain dashes or conflict with a reserved word (such as ?class?.) cmlenz parents: 170 diff changeset	266 Thus this shorthand can not be used if attribute names should contain
7fcf8e04514e Follow-up to [214]: allow initializing `Attributes` with attribute names that contain dashes or conflict with a reserved word (such as ?class?.) cmlenz parents: 170 diff changeset	267 actual underscore characters.
18 5420cfe42d36 Actually make use of the `markup.core.Namespace` class, and add a couple of doctests. cmlenz parents: 17 diff changeset	268 """
5420cfe42d36 Actually make use of the `markup.core.Namespace` class, and add a couple of doctests. cmlenz parents: 17 diff changeset	269 __slots__ = []
1 5479aae32f5a Initial import. cmlenz parents: diff changeset	270
170 6b265e02d099 Allow initialization of `Attributes` with keyword arguments. cmlenz parents: 161 diff changeset	271 def __init__(self, attrib=None, **kwargs):
182 2f30ce3fb85e Renamed `Attributes` to `Attrs` to reduce the verbosity. cmlenz parents: 172 diff changeset	272 """Create the `Attrs` instance.
18 5420cfe42d36 Actually make use of the `markup.core.Namespace` class, and add a couple of doctests. cmlenz parents: 17 diff changeset	273
5420cfe42d36 Actually make use of the `markup.core.Namespace` class, and add a couple of doctests. cmlenz parents: 17 diff changeset	274 If the `attrib` parameter is provided, it is expected to be a sequence
5420cfe42d36 Actually make use of the `markup.core.Namespace` class, and add a couple of doctests. cmlenz parents: 17 diff changeset	275 of `(name, value)` tuples.
5420cfe42d36 Actually make use of the `markup.core.Namespace` class, and add a couple of doctests. cmlenz parents: 17 diff changeset	276 """
27 b4f78c05e5c9 * Fix the boilerplate in the Python source files. cmlenz parents: 18 diff changeset	277 if attrib is None:
b4f78c05e5c9 * Fix the boilerplate in the Python source files. cmlenz parents: 18 diff changeset	278 attrib = []
b4f78c05e5c9 * Fix the boilerplate in the Python source files. cmlenz parents: 18 diff changeset	279 list.__init__(self, [(QName(name), value) for name, value in attrib])
170 6b265e02d099 Allow initialization of `Attributes` with keyword arguments. cmlenz parents: 161 diff changeset	280 for name, value in kwargs.items():
171 7fcf8e04514e Follow-up to [214]: allow initializing `Attributes` with attribute names that contain dashes or conflict with a reserved word (such as ?class?.) cmlenz parents: 170 diff changeset	281 self.set(name.rstrip('_').replace('_', '-'), value)
1 5479aae32f5a Initial import. cmlenz parents: diff changeset	282
5479aae32f5a Initial import. cmlenz parents: diff changeset	283 def __contains__(self, name):
18 5420cfe42d36 Actually make use of the `markup.core.Namespace` class, and add a couple of doctests. cmlenz parents: 17 diff changeset	284 """Return whether the list includes an attribute with the specified
5420cfe42d36 Actually make use of the `markup.core.Namespace` class, and add a couple of doctests. cmlenz parents: 17 diff changeset	285 name.
5420cfe42d36 Actually make use of the `markup.core.Namespace` class, and add a couple of doctests. cmlenz parents: 17 diff changeset	286 """
133 79f445396cd7 Minor cleanup and performance improvement for the builder module. cmlenz parents: 123 diff changeset	287 for attr, _ in self:
79f445396cd7 Minor cleanup and performance improvement for the builder module. cmlenz parents: 123 diff changeset	288 if attr == name:
79f445396cd7 Minor cleanup and performance improvement for the builder module. cmlenz parents: 123 diff changeset	289 return True
1 5479aae32f5a Initial import. cmlenz parents: diff changeset	290
326 f999da894391 Fixed `__repr__` of the `QName`, `Attrs`, and `Expression` classes so that the output can be used as code to instantiate the object again. cmlenz parents: 279 diff changeset	291 def __repr__(self):
f999da894391 Fixed `__repr__` of the `QName`, `Attrs`, and `Expression` classes so that the output can be used as code to instantiate the object again. cmlenz parents: 279 diff changeset	292 if not self:
f999da894391 Fixed `__repr__` of the `QName`, `Attrs`, and `Expression` classes so that the output can be used as code to instantiate the object again. cmlenz parents: 279 diff changeset	293 return 'Attrs()'
f999da894391 Fixed `__repr__` of the `QName`, `Attrs`, and `Expression` classes so that the output can be used as code to instantiate the object again. cmlenz parents: 279 diff changeset	294 return 'Attrs(%s)' % list.__repr__(self)
f999da894391 Fixed `__repr__` of the `QName`, `Attrs`, and `Expression` classes so that the output can be used as code to instantiate the object again. cmlenz parents: 279 diff changeset	295
1 5479aae32f5a Initial import. cmlenz parents: diff changeset	296 def get(self, name, default=None):
18 5420cfe42d36 Actually make use of the `markup.core.Namespace` class, and add a couple of doctests. cmlenz parents: 17 diff changeset	297 """Return the value of the attribute with the specified name, or the
5420cfe42d36 Actually make use of the `markup.core.Namespace` class, and add a couple of doctests. cmlenz parents: 17 diff changeset	298 value of the `default` parameter if no such attribute is found.
5420cfe42d36 Actually make use of the `markup.core.Namespace` class, and add a couple of doctests. cmlenz parents: 17 diff changeset	299 """
1 5479aae32f5a Initial import. cmlenz parents: diff changeset	300 for attr, value in self:
5479aae32f5a Initial import. cmlenz parents: diff changeset	301 if attr == name:
5479aae32f5a Initial import. cmlenz parents: diff changeset	302 return value
5479aae32f5a Initial import. cmlenz parents: diff changeset	303 return default
5479aae32f5a Initial import. cmlenz parents: diff changeset	304
5 dbb08edbc615 Improved `py:attrs` directive so that it removes existing attributes if they evaluate to `None` (AFAICT matching Kid behavior). cmlenz parents: 1 diff changeset	305 def remove(self, name):
161 7b1f07496bf7 Various docstring additions and other cosmetic changes. cmlenz parents: 147 diff changeset	306 """Remove the attribute with the specified name.
18 5420cfe42d36 Actually make use of the `markup.core.Namespace` class, and add a couple of doctests. cmlenz parents: 17 diff changeset	307
5420cfe42d36 Actually make use of the `markup.core.Namespace` class, and add a couple of doctests. cmlenz parents: 17 diff changeset	308 If no such attribute is found, this method does nothing.
5420cfe42d36 Actually make use of the `markup.core.Namespace` class, and add a couple of doctests. cmlenz parents: 17 diff changeset	309 """
5 dbb08edbc615 Improved `py:attrs` directive so that it removes existing attributes if they evaluate to `None` (AFAICT matching Kid behavior). cmlenz parents: 1 diff changeset	310 for idx, (attr, _) in enumerate(self):
dbb08edbc615 Improved `py:attrs` directive so that it removes existing attributes if they evaluate to `None` (AFAICT matching Kid behavior). cmlenz parents: 1 diff changeset	311 if attr == name:
dbb08edbc615 Improved `py:attrs` directive so that it removes existing attributes if they evaluate to `None` (AFAICT matching Kid behavior). cmlenz parents: 1 diff changeset	312 del self[idx]
dbb08edbc615 Improved `py:attrs` directive so that it removes existing attributes if they evaluate to `None` (AFAICT matching Kid behavior). cmlenz parents: 1 diff changeset	313 break
dbb08edbc615 Improved `py:attrs` directive so that it removes existing attributes if they evaluate to `None` (AFAICT matching Kid behavior). cmlenz parents: 1 diff changeset	314
1 5479aae32f5a Initial import. cmlenz parents: diff changeset	315 def set(self, name, value):
161 7b1f07496bf7 Various docstring additions and other cosmetic changes. cmlenz parents: 147 diff changeset	316 """Set the specified attribute to the given value.
18 5420cfe42d36 Actually make use of the `markup.core.Namespace` class, and add a couple of doctests. cmlenz parents: 17 diff changeset	317
5420cfe42d36 Actually make use of the `markup.core.Namespace` class, and add a couple of doctests. cmlenz parents: 17 diff changeset	318 If an attribute with the specified name is already in the list, the
5420cfe42d36 Actually make use of the `markup.core.Namespace` class, and add a couple of doctests. cmlenz parents: 17 diff changeset	319 value of the existing entry is updated. Otherwise, a new attribute is
5420cfe42d36 Actually make use of the `markup.core.Namespace` class, and add a couple of doctests. cmlenz parents: 17 diff changeset	320 appended to the end of the list.
5420cfe42d36 Actually make use of the `markup.core.Namespace` class, and add a couple of doctests. cmlenz parents: 17 diff changeset	321 """
1 5479aae32f5a Initial import. cmlenz parents: diff changeset	322 for idx, (attr, _) in enumerate(self):
5479aae32f5a Initial import. cmlenz parents: diff changeset	323 if attr == name:
170 6b265e02d099 Allow initialization of `Attributes` with keyword arguments. cmlenz parents: 161 diff changeset	324 self[idx] = (QName(attr), value)
1 5479aae32f5a Initial import. cmlenz parents: diff changeset	325 break
5479aae32f5a Initial import. cmlenz parents: diff changeset	326 else:
5479aae32f5a Initial import. cmlenz parents: diff changeset	327 self.append((QName(name), value))
5479aae32f5a Initial import. cmlenz parents: diff changeset	328
77 f5ec6d4a61e4 * Simplify implementation of the individual XPath tests (use closures instead of callable classes) cmlenz parents: 73 diff changeset	329 def totuple(self):
161 7b1f07496bf7 Various docstring additions and other cosmetic changes. cmlenz parents: 147 diff changeset	330 """Return the attributes as a markup event.
7b1f07496bf7 Various docstring additions and other cosmetic changes. cmlenz parents: 147 diff changeset	331
7b1f07496bf7 Various docstring additions and other cosmetic changes. cmlenz parents: 147 diff changeset	332 The returned event is a TEXT event, the data is the value of all
7b1f07496bf7 Various docstring additions and other cosmetic changes. cmlenz parents: 147 diff changeset	333 attributes joined together.
7b1f07496bf7 Various docstring additions and other cosmetic changes. cmlenz parents: 147 diff changeset	334 """
77 f5ec6d4a61e4 * Simplify implementation of the individual XPath tests (use closures instead of callable classes) cmlenz parents: 73 diff changeset	335 return TEXT, u''.join([x[1] for x in self]), (None, -1, -1)
f5ec6d4a61e4 * Simplify implementation of the individual XPath tests (use closures instead of callable classes) cmlenz parents: 73 diff changeset	336
1 5479aae32f5a Initial import. cmlenz parents: diff changeset	337
116 c77c113846d6 Merged [135:138/branches/experimental/cspeedups]. cmlenz parents: 115 diff changeset	338 def plaintext(text, keeplinebreaks=True):
c77c113846d6 Merged [135:138/branches/experimental/cspeedups]. cmlenz parents: 115 diff changeset	339 """Returns the text as a `unicode` string with all entities and tags
c77c113846d6 Merged [135:138/branches/experimental/cspeedups]. cmlenz parents: 115 diff changeset	340 removed.
c77c113846d6 Merged [135:138/branches/experimental/cspeedups]. cmlenz parents: 115 diff changeset	341 """
c77c113846d6 Merged [135:138/branches/experimental/cspeedups]. cmlenz parents: 115 diff changeset	342 text = stripentities(striptags(text))
c77c113846d6 Merged [135:138/branches/experimental/cspeedups]. cmlenz parents: 115 diff changeset	343 if not keeplinebreaks:
c77c113846d6 Merged [135:138/branches/experimental/cspeedups]. cmlenz parents: 115 diff changeset	344 text = text.replace(u'\n', u' ')
c77c113846d6 Merged [135:138/branches/experimental/cspeedups]. cmlenz parents: 115 diff changeset	345 return text
c77c113846d6 Merged [135:138/branches/experimental/cspeedups]. cmlenz parents: 115 diff changeset	346
113 d10fbba1d5e0 Removed the `sanitize()` method from the `Markup` class, and migrate the existing unit tests to `markup.tests.filters`. Provide a `Stream.filter()` method instead which can be used to conveniently apply a filter to a stream. cmlenz parents: 111 diff changeset	347 def stripentities(text, keepxmlentities=False):
d10fbba1d5e0 Removed the `sanitize()` method from the `Markup` class, and migrate the existing unit tests to `markup.tests.filters`. Provide a `Stream.filter()` method instead which can be used to conveniently apply a filter to a stream. cmlenz parents: 111 diff changeset	348 """Return a copy of the given text with any character or numeric entities
d10fbba1d5e0 Removed the `sanitize()` method from the `Markup` class, and migrate the existing unit tests to `markup.tests.filters`. Provide a `Stream.filter()` method instead which can be used to conveniently apply a filter to a stream. cmlenz parents: 111 diff changeset	349 replaced by the equivalent UTF-8 characters.
d10fbba1d5e0 Removed the `sanitize()` method from the `Markup` class, and migrate the existing unit tests to `markup.tests.filters`. Provide a `Stream.filter()` method instead which can be used to conveniently apply a filter to a stream. cmlenz parents: 111 diff changeset	350
d10fbba1d5e0 Removed the `sanitize()` method from the `Markup` class, and migrate the existing unit tests to `markup.tests.filters`. Provide a `Stream.filter()` method instead which can be used to conveniently apply a filter to a stream. cmlenz parents: 111 diff changeset	351 If the `keepxmlentities` parameter is provided and evaluates to `True`,
d10fbba1d5e0 Removed the `sanitize()` method from the `Markup` class, and migrate the existing unit tests to `markup.tests.filters`. Provide a `Stream.filter()` method instead which can be used to conveniently apply a filter to a stream. cmlenz parents: 111 diff changeset	352 the core XML entities (&, ', >, < and ") are not
d10fbba1d5e0 Removed the `sanitize()` method from the `Markup` class, and migrate the existing unit tests to `markup.tests.filters`. Provide a `Stream.filter()` method instead which can be used to conveniently apply a filter to a stream. cmlenz parents: 111 diff changeset	353 stripped.
d10fbba1d5e0 Removed the `sanitize()` method from the `Markup` class, and migrate the existing unit tests to `markup.tests.filters`. Provide a `Stream.filter()` method instead which can be used to conveniently apply a filter to a stream. cmlenz parents: 111 diff changeset	354 """
d10fbba1d5e0 Removed the `sanitize()` method from the `Markup` class, and migrate the existing unit tests to `markup.tests.filters`. Provide a `Stream.filter()` method instead which can be used to conveniently apply a filter to a stream. cmlenz parents: 111 diff changeset	355 def _replace_entity(match):
d10fbba1d5e0 Removed the `sanitize()` method from the `Markup` class, and migrate the existing unit tests to `markup.tests.filters`. Provide a `Stream.filter()` method instead which can be used to conveniently apply a filter to a stream. cmlenz parents: 111 diff changeset	356 if match.group(1): # numeric entity
d10fbba1d5e0 Removed the `sanitize()` method from the `Markup` class, and migrate the existing unit tests to `markup.tests.filters`. Provide a `Stream.filter()` method instead which can be used to conveniently apply a filter to a stream. cmlenz parents: 111 diff changeset	357 ref = match.group(1)
d10fbba1d5e0 Removed the `sanitize()` method from the `Markup` class, and migrate the existing unit tests to `markup.tests.filters`. Provide a `Stream.filter()` method instead which can be used to conveniently apply a filter to a stream. cmlenz parents: 111 diff changeset	358 if ref.startswith('x'):
d10fbba1d5e0 Removed the `sanitize()` method from the `Markup` class, and migrate the existing unit tests to `markup.tests.filters`. Provide a `Stream.filter()` method instead which can be used to conveniently apply a filter to a stream. cmlenz parents: 111 diff changeset	359 ref = int(ref[1:], 16)
d10fbba1d5e0 Removed the `sanitize()` method from the `Markup` class, and migrate the existing unit tests to `markup.tests.filters`. Provide a `Stream.filter()` method instead which can be used to conveniently apply a filter to a stream. cmlenz parents: 111 diff changeset	360 else:
d10fbba1d5e0 Removed the `sanitize()` method from the `Markup` class, and migrate the existing unit tests to `markup.tests.filters`. Provide a `Stream.filter()` method instead which can be used to conveniently apply a filter to a stream. cmlenz parents: 111 diff changeset	361 ref = int(ref, 10)
d10fbba1d5e0 Removed the `sanitize()` method from the `Markup` class, and migrate the existing unit tests to `markup.tests.filters`. Provide a `Stream.filter()` method instead which can be used to conveniently apply a filter to a stream. cmlenz parents: 111 diff changeset	362 return unichr(ref)
d10fbba1d5e0 Removed the `sanitize()` method from the `Markup` class, and migrate the existing unit tests to `markup.tests.filters`. Provide a `Stream.filter()` method instead which can be used to conveniently apply a filter to a stream. cmlenz parents: 111 diff changeset	363 else: # character entity
d10fbba1d5e0 Removed the `sanitize()` method from the `Markup` class, and migrate the existing unit tests to `markup.tests.filters`. Provide a `Stream.filter()` method instead which can be used to conveniently apply a filter to a stream. cmlenz parents: 111 diff changeset	364 ref = match.group(2)
200 5861f4446c26 Add serialization to plain text, based on cboos' patch. Closes #41. cmlenz parents: 182 diff changeset	365 if keepxmlentities and ref in ('amp', 'apos', 'gt', 'lt', 'quot'):
113 d10fbba1d5e0 Removed the `sanitize()` method from the `Markup` class, and migrate the existing unit tests to `markup.tests.filters`. Provide a `Stream.filter()` method instead which can be used to conveniently apply a filter to a stream. cmlenz parents: 111 diff changeset	366 return '&%s;' % ref
d10fbba1d5e0 Removed the `sanitize()` method from the `Markup` class, and migrate the existing unit tests to `markup.tests.filters`. Provide a `Stream.filter()` method instead which can be used to conveniently apply a filter to a stream. cmlenz parents: 111 diff changeset	367 try:
d10fbba1d5e0 Removed the `sanitize()` method from the `Markup` class, and migrate the existing unit tests to `markup.tests.filters`. Provide a `Stream.filter()` method instead which can be used to conveniently apply a filter to a stream. cmlenz parents: 111 diff changeset	368 codepoint = htmlentitydefs.name2codepoint[ref]
d10fbba1d5e0 Removed the `sanitize()` method from the `Markup` class, and migrate the existing unit tests to `markup.tests.filters`. Provide a `Stream.filter()` method instead which can be used to conveniently apply a filter to a stream. cmlenz parents: 111 diff changeset	369 return unichr(codepoint)
d10fbba1d5e0 Removed the `sanitize()` method from the `Markup` class, and migrate the existing unit tests to `markup.tests.filters`. Provide a `Stream.filter()` method instead which can be used to conveniently apply a filter to a stream. cmlenz parents: 111 diff changeset	370 except KeyError:
d10fbba1d5e0 Removed the `sanitize()` method from the `Markup` class, and migrate the existing unit tests to `markup.tests.filters`. Provide a `Stream.filter()` method instead which can be used to conveniently apply a filter to a stream. cmlenz parents: 111 diff changeset	371 if keepxmlentities:
d10fbba1d5e0 Removed the `sanitize()` method from the `Markup` class, and migrate the existing unit tests to `markup.tests.filters`. Provide a `Stream.filter()` method instead which can be used to conveniently apply a filter to a stream. cmlenz parents: 111 diff changeset	372 return '&%s;' % ref
d10fbba1d5e0 Removed the `sanitize()` method from the `Markup` class, and migrate the existing unit tests to `markup.tests.filters`. Provide a `Stream.filter()` method instead which can be used to conveniently apply a filter to a stream. cmlenz parents: 111 diff changeset	373 else:
d10fbba1d5e0 Removed the `sanitize()` method from the `Markup` class, and migrate the existing unit tests to `markup.tests.filters`. Provide a `Stream.filter()` method instead which can be used to conveniently apply a filter to a stream. cmlenz parents: 111 diff changeset	374 return ref
d10fbba1d5e0 Removed the `sanitize()` method from the `Markup` class, and migrate the existing unit tests to `markup.tests.filters`. Provide a `Stream.filter()` method instead which can be used to conveniently apply a filter to a stream. cmlenz parents: 111 diff changeset	375 return re.sub(r'&(?:#((?:\d+)\|(?:[xX][0-9a-fA-F]+));?\|(\w+);)',
d10fbba1d5e0 Removed the `sanitize()` method from the `Markup` class, and migrate the existing unit tests to `markup.tests.filters`. Provide a `Stream.filter()` method instead which can be used to conveniently apply a filter to a stream. cmlenz parents: 111 diff changeset	376 _replace_entity, text)
d10fbba1d5e0 Removed the `sanitize()` method from the `Markup` class, and migrate the existing unit tests to `markup.tests.filters`. Provide a `Stream.filter()` method instead which can be used to conveniently apply a filter to a stream. cmlenz parents: 111 diff changeset	377
116 c77c113846d6 Merged [135:138/branches/experimental/cspeedups]. cmlenz parents: 115 diff changeset	378 def striptags(text):
c77c113846d6 Merged [135:138/branches/experimental/cspeedups]. cmlenz parents: 115 diff changeset	379 """Return a copy of the text with all XML/HTML tags removed."""
c77c113846d6 Merged [135:138/branches/experimental/cspeedups]. cmlenz parents: 115 diff changeset	380 return re.sub(r'<[^>]*?>', '', text)
c77c113846d6 Merged [135:138/branches/experimental/cspeedups]. cmlenz parents: 115 diff changeset	381
113 d10fbba1d5e0 Removed the `sanitize()` method from the `Markup` class, and migrate the existing unit tests to `markup.tests.filters`. Provide a `Stream.filter()` method instead which can be used to conveniently apply a filter to a stream. cmlenz parents: 111 diff changeset	382
1 5479aae32f5a Initial import. cmlenz parents: diff changeset	383 class Markup(unicode):
5479aae32f5a Initial import. cmlenz parents: diff changeset	384 """Marks a string as being safe for inclusion in HTML/XML output without
5479aae32f5a Initial import. cmlenz parents: diff changeset	385 needing to be escaped.
5479aae32f5a Initial import. cmlenz parents: diff changeset	386 """
18 5420cfe42d36 Actually make use of the `markup.core.Namespace` class, and add a couple of doctests. cmlenz parents: 17 diff changeset	387 __slots__ = []
5420cfe42d36 Actually make use of the `markup.core.Namespace` class, and add a couple of doctests. cmlenz parents: 17 diff changeset	388
27 b4f78c05e5c9 * Fix the boilerplate in the Python source files. cmlenz parents: 18 diff changeset	389 def __new__(cls, text='', *args):
1 5479aae32f5a Initial import. cmlenz parents: diff changeset	390 if args:
136 b86f496f6035 Minor performance improvements in serialization. cmlenz parents: 133 diff changeset	391 text %= tuple(map(escape, args))
27 b4f78c05e5c9 * Fix the boilerplate in the Python source files. cmlenz parents: 18 diff changeset	392 return unicode.__new__(cls, text)
1 5479aae32f5a Initial import. cmlenz parents: diff changeset	393
5479aae32f5a Initial import. cmlenz parents: diff changeset	394 def __add__(self, other):
204 51d4101f49ca * Implement reverse add/mul operators for `Markup` class, so that the result is also a `Markup` instance. cmlenz parents: 200 diff changeset	395 return Markup(unicode(self) + unicode(escape(other)))
51d4101f49ca * Implement reverse add/mul operators for `Markup` class, so that the result is also a `Markup` instance. cmlenz parents: 200 diff changeset	396
51d4101f49ca * Implement reverse add/mul operators for `Markup` class, so that the result is also a `Markup` instance. cmlenz parents: 200 diff changeset	397 def __radd__(self, other):
51d4101f49ca * Implement reverse add/mul operators for `Markup` class, so that the result is also a `Markup` instance. cmlenz parents: 200 diff changeset	398 return Markup(unicode(escape(other)) + unicode(self))
1 5479aae32f5a Initial import. cmlenz parents: diff changeset	399
5479aae32f5a Initial import. cmlenz parents: diff changeset	400 def __mod__(self, args):
5479aae32f5a Initial import. cmlenz parents: diff changeset	401 if not isinstance(args, (list, tuple)):
5479aae32f5a Initial import. cmlenz parents: diff changeset	402 args = [args]
136 b86f496f6035 Minor performance improvements in serialization. cmlenz parents: 133 diff changeset	403 return Markup(unicode.__mod__(self, tuple(map(escape, args))))
1 5479aae32f5a Initial import. cmlenz parents: diff changeset	404
5479aae32f5a Initial import. cmlenz parents: diff changeset	405 def __mul__(self, num):
5479aae32f5a Initial import. cmlenz parents: diff changeset	406 return Markup(unicode(self) * num)
5479aae32f5a Initial import. cmlenz parents: diff changeset	407
204 51d4101f49ca * Implement reverse add/mul operators for `Markup` class, so that the result is also a `Markup` instance. cmlenz parents: 200 diff changeset	408 def __rmul__(self, num):
51d4101f49ca * Implement reverse add/mul operators for `Markup` class, so that the result is also a `Markup` instance. cmlenz parents: 200 diff changeset	409 return Markup(num * unicode(self))
51d4101f49ca * Implement reverse add/mul operators for `Markup` class, so that the result is also a `Markup` instance. cmlenz parents: 200 diff changeset	410
17 74cc70129d04 Refactoring to address #6: all match templates are now processed by a single filter, which means that match templates added by included templates are properly applied. A side effect of this refactoring is that `Context` objects may not be reused across multiple template processing runs. cmlenz parents: 10 diff changeset	411 def __repr__(self):
74cc70129d04 Refactoring to address #6: all match templates are now processed by a single filter, which means that match templates added by included templates are properly applied. A side effect of this refactoring is that `Context` objects may not be reused across multiple template processing runs. cmlenz parents: 10 diff changeset	412 return '<%s "%s">' % (self.__class__.__name__, self)
74cc70129d04 Refactoring to address #6: all match templates are now processed by a single filter, which means that match templates added by included templates are properly applied. A side effect of this refactoring is that `Context` objects may not be reused across multiple template processing runs. cmlenz parents: 10 diff changeset	413
54 1f3cd91325d9 Fix a number of escaping problems: cmlenz parents: 34 diff changeset	414 def join(self, seq, escape_quotes=True):
1f3cd91325d9 Fix a number of escaping problems: cmlenz parents: 34 diff changeset	415 return Markup(unicode(self).join([escape(item, quotes=escape_quotes)
34 3421dd98f015 quotes should not be escaped inside text nodes mgood parents: 27 diff changeset	416 for item in seq]))
1 5479aae32f5a Initial import. cmlenz parents: diff changeset	417
5479aae32f5a Initial import. cmlenz parents: diff changeset	418 def escape(cls, text, quotes=True):
5479aae32f5a Initial import. cmlenz parents: diff changeset	419 """Create a Markup instance from a string and escape special characters
5479aae32f5a Initial import. cmlenz parents: diff changeset	420 it may contain (<, >, & and \").
5479aae32f5a Initial import. cmlenz parents: diff changeset	421
5479aae32f5a Initial import. cmlenz parents: diff changeset	422 If the `quotes` parameter is set to `False`, the \" character is left
5479aae32f5a Initial import. cmlenz parents: diff changeset	423 as is. Escaping quotes is generally only required for strings that are
5479aae32f5a Initial import. cmlenz parents: diff changeset	424 to be used in attribute values.
5479aae32f5a Initial import. cmlenz parents: diff changeset	425 """
73 1da51d718391 Some more performance tweaks. cmlenz parents: 69 diff changeset	426 if not text:
1da51d718391 Some more performance tweaks. cmlenz parents: 69 diff changeset	427 return cls()
1da51d718391 Some more performance tweaks. cmlenz parents: 69 diff changeset	428 if type(text) is cls:
1 5479aae32f5a Initial import. cmlenz parents: diff changeset	429 return text
73 1da51d718391 Some more performance tweaks. cmlenz parents: 69 diff changeset	430 text = unicode(text).replace('&', '&') \
1da51d718391 Some more performance tweaks. cmlenz parents: 69 diff changeset	431 .replace('<', '<') \
1da51d718391 Some more performance tweaks. cmlenz parents: 69 diff changeset	432 .replace('>', '>')
1 5479aae32f5a Initial import. cmlenz parents: diff changeset	433 if quotes:
5479aae32f5a Initial import. cmlenz parents: diff changeset	434 text = text.replace('"', '"')
5479aae32f5a Initial import. cmlenz parents: diff changeset	435 return cls(text)
5479aae32f5a Initial import. cmlenz parents: diff changeset	436 escape = classmethod(escape)
5479aae32f5a Initial import. cmlenz parents: diff changeset	437
5479aae32f5a Initial import. cmlenz parents: diff changeset	438 def unescape(self):
5479aae32f5a Initial import. cmlenz parents: diff changeset	439 """Reverse-escapes &, <, > and \" and returns a `unicode` object."""
5479aae32f5a Initial import. cmlenz parents: diff changeset	440 if not self:
18 5420cfe42d36 Actually make use of the `markup.core.Namespace` class, and add a couple of doctests. cmlenz parents: 17 diff changeset	441 return u''
1 5479aae32f5a Initial import. cmlenz parents: diff changeset	442 return unicode(self).replace('"', '"') \
5479aae32f5a Initial import. cmlenz parents: diff changeset	443 .replace('>', '>') \
5479aae32f5a Initial import. cmlenz parents: diff changeset	444 .replace('<', '<') \
5479aae32f5a Initial import. cmlenz parents: diff changeset	445 .replace('&', '&')
5479aae32f5a Initial import. cmlenz parents: diff changeset	446
116 c77c113846d6 Merged [135:138/branches/experimental/cspeedups]. cmlenz parents: 115 diff changeset	447 def stripentities(self, keepxmlentities=False):
c77c113846d6 Merged [135:138/branches/experimental/cspeedups]. cmlenz parents: 115 diff changeset	448 """Return a copy of the text with any character or numeric entities
c77c113846d6 Merged [135:138/branches/experimental/cspeedups]. cmlenz parents: 115 diff changeset	449 replaced by the equivalent UTF-8 characters.
c77c113846d6 Merged [135:138/branches/experimental/cspeedups]. cmlenz parents: 115 diff changeset	450
c77c113846d6 Merged [135:138/branches/experimental/cspeedups]. cmlenz parents: 115 diff changeset	451 If the `keepxmlentities` parameter is provided and evaluates to `True`,
c77c113846d6 Merged [135:138/branches/experimental/cspeedups]. cmlenz parents: 115 diff changeset	452 the core XML entities (&, ', >, < and ") are not
c77c113846d6 Merged [135:138/branches/experimental/cspeedups]. cmlenz parents: 115 diff changeset	453 stripped.
6 71e8e645fe81 Simplified implementation of `py:content` directive. cmlenz parents: 5 diff changeset	454 """
116 c77c113846d6 Merged [135:138/branches/experimental/cspeedups]. cmlenz parents: 115 diff changeset	455 return Markup(stripentities(self, keepxmlentities=keepxmlentities))
c77c113846d6 Merged [135:138/branches/experimental/cspeedups]. cmlenz parents: 115 diff changeset	456
c77c113846d6 Merged [135:138/branches/experimental/cspeedups]. cmlenz parents: 115 diff changeset	457 def striptags(self):
c77c113846d6 Merged [135:138/branches/experimental/cspeedups]. cmlenz parents: 115 diff changeset	458 """Return a copy of the text with all XML/HTML tags removed."""
c77c113846d6 Merged [135:138/branches/experimental/cspeedups]. cmlenz parents: 115 diff changeset	459 return Markup(striptags(self))
1 5479aae32f5a Initial import. cmlenz parents: diff changeset	460
5479aae32f5a Initial import. cmlenz parents: diff changeset	461
5479aae32f5a Initial import. cmlenz parents: diff changeset	462 escape = Markup.escape
5479aae32f5a Initial import. cmlenz parents: diff changeset	463
5479aae32f5a Initial import. cmlenz parents: diff changeset	464 def unescape(text):
5479aae32f5a Initial import. cmlenz parents: diff changeset	465 """Reverse-escapes &, <, > and \" and returns a `unicode` object."""
5479aae32f5a Initial import. cmlenz parents: diff changeset	466 if not isinstance(text, Markup):
5479aae32f5a Initial import. cmlenz parents: diff changeset	467 return text
5479aae32f5a Initial import. cmlenz parents: diff changeset	468 return text.unescape()
5479aae32f5a Initial import. cmlenz parents: diff changeset	469
5479aae32f5a Initial import. cmlenz parents: diff changeset	470
5479aae32f5a Initial import. cmlenz parents: diff changeset	471 class Namespace(object):
18 5420cfe42d36 Actually make use of the `markup.core.Namespace` class, and add a couple of doctests. cmlenz parents: 17 diff changeset	472 """Utility class creating and testing elements with a namespace.
5420cfe42d36 Actually make use of the `markup.core.Namespace` class, and add a couple of doctests. cmlenz parents: 17 diff changeset	473
5420cfe42d36 Actually make use of the `markup.core.Namespace` class, and add a couple of doctests. cmlenz parents: 17 diff changeset	474 Internally, namespace URIs are encoded in the `QName` of any element or
5420cfe42d36 Actually make use of the `markup.core.Namespace` class, and add a couple of doctests. cmlenz parents: 17 diff changeset	475 attribute, the namespace URI being enclosed in curly braces. This class
5420cfe42d36 Actually make use of the `markup.core.Namespace` class, and add a couple of doctests. cmlenz parents: 17 diff changeset	476 helps create and test these strings.
5420cfe42d36 Actually make use of the `markup.core.Namespace` class, and add a couple of doctests. cmlenz parents: 17 diff changeset	477
5420cfe42d36 Actually make use of the `markup.core.Namespace` class, and add a couple of doctests. cmlenz parents: 17 diff changeset	478 A `Namespace` object is instantiated with the namespace URI.
5420cfe42d36 Actually make use of the `markup.core.Namespace` class, and add a couple of doctests. cmlenz parents: 17 diff changeset	479
5420cfe42d36 Actually make use of the `markup.core.Namespace` class, and add a couple of doctests. cmlenz parents: 17 diff changeset	480 >>> html = Namespace('http://www.w3.org/1999/xhtml')
5420cfe42d36 Actually make use of the `markup.core.Namespace` class, and add a couple of doctests. cmlenz parents: 17 diff changeset	481 >>> html
5420cfe42d36 Actually make use of the `markup.core.Namespace` class, and add a couple of doctests. cmlenz parents: 17 diff changeset	482 <Namespace "http://www.w3.org/1999/xhtml">
5420cfe42d36 Actually make use of the `markup.core.Namespace` class, and add a couple of doctests. cmlenz parents: 17 diff changeset	483 >>> html.uri
5420cfe42d36 Actually make use of the `markup.core.Namespace` class, and add a couple of doctests. cmlenz parents: 17 diff changeset	484 u'http://www.w3.org/1999/xhtml'
5420cfe42d36 Actually make use of the `markup.core.Namespace` class, and add a couple of doctests. cmlenz parents: 17 diff changeset	485
5420cfe42d36 Actually make use of the `markup.core.Namespace` class, and add a couple of doctests. cmlenz parents: 17 diff changeset	486 The `Namespace` object can than be used to generate `QName` objects with
5420cfe42d36 Actually make use of the `markup.core.Namespace` class, and add a couple of doctests. cmlenz parents: 17 diff changeset	487 that namespace:
5420cfe42d36 Actually make use of the `markup.core.Namespace` class, and add a couple of doctests. cmlenz parents: 17 diff changeset	488
5420cfe42d36 Actually make use of the `markup.core.Namespace` class, and add a couple of doctests. cmlenz parents: 17 diff changeset	489 >>> html.body
326 f999da894391 Fixed `__repr__` of the `QName`, `Attrs`, and `Expression` classes so that the output can be used as code to instantiate the object again. cmlenz parents: 279 diff changeset	490 QName(u'http://www.w3.org/1999/xhtml}body')
18 5420cfe42d36 Actually make use of the `markup.core.Namespace` class, and add a couple of doctests. cmlenz parents: 17 diff changeset	491 >>> html.body.localname
5420cfe42d36 Actually make use of the `markup.core.Namespace` class, and add a couple of doctests. cmlenz parents: 17 diff changeset	492 u'body'
5420cfe42d36 Actually make use of the `markup.core.Namespace` class, and add a couple of doctests. cmlenz parents: 17 diff changeset	493 >>> html.body.namespace
5420cfe42d36 Actually make use of the `markup.core.Namespace` class, and add a couple of doctests. cmlenz parents: 17 diff changeset	494 u'http://www.w3.org/1999/xhtml'
5420cfe42d36 Actually make use of the `markup.core.Namespace` class, and add a couple of doctests. cmlenz parents: 17 diff changeset	495
5420cfe42d36 Actually make use of the `markup.core.Namespace` class, and add a couple of doctests. cmlenz parents: 17 diff changeset	496 The same works using item access notation, which is useful for element or
5420cfe42d36 Actually make use of the `markup.core.Namespace` class, and add a couple of doctests. cmlenz parents: 17 diff changeset	497 attribute names that are not valid Python identifiers:
5420cfe42d36 Actually make use of the `markup.core.Namespace` class, and add a couple of doctests. cmlenz parents: 17 diff changeset	498
5420cfe42d36 Actually make use of the `markup.core.Namespace` class, and add a couple of doctests. cmlenz parents: 17 diff changeset	499 >>> html['body']
326 f999da894391 Fixed `__repr__` of the `QName`, `Attrs`, and `Expression` classes so that the output can be used as code to instantiate the object again. cmlenz parents: 279 diff changeset	500 QName(u'http://www.w3.org/1999/xhtml}body')
18 5420cfe42d36 Actually make use of the `markup.core.Namespace` class, and add a couple of doctests. cmlenz parents: 17 diff changeset	501
5420cfe42d36 Actually make use of the `markup.core.Namespace` class, and add a couple of doctests. cmlenz parents: 17 diff changeset	502 A `Namespace` object can also be used to test whether a specific `QName`
5420cfe42d36 Actually make use of the `markup.core.Namespace` class, and add a couple of doctests. cmlenz parents: 17 diff changeset	503 belongs to that namespace using the `in` operator:
5420cfe42d36 Actually make use of the `markup.core.Namespace` class, and add a couple of doctests. cmlenz parents: 17 diff changeset	504
5420cfe42d36 Actually make use of the `markup.core.Namespace` class, and add a couple of doctests. cmlenz parents: 17 diff changeset	505 >>> qname = html.body
5420cfe42d36 Actually make use of the `markup.core.Namespace` class, and add a couple of doctests. cmlenz parents: 17 diff changeset	506 >>> qname in html
5420cfe42d36 Actually make use of the `markup.core.Namespace` class, and add a couple of doctests. cmlenz parents: 17 diff changeset	507 True
5420cfe42d36 Actually make use of the `markup.core.Namespace` class, and add a couple of doctests. cmlenz parents: 17 diff changeset	508 >>> qname in Namespace('http://www.w3.org/2002/06/xhtml2')
5420cfe42d36 Actually make use of the `markup.core.Namespace` class, and add a couple of doctests. cmlenz parents: 17 diff changeset	509 False
5420cfe42d36 Actually make use of the `markup.core.Namespace` class, and add a couple of doctests. cmlenz parents: 17 diff changeset	510 """
224 90d62225f411 Implement support for namespace prefixes in XPath expressions. cmlenz parents: 204 diff changeset	511 def __new__(cls, uri):
90d62225f411 Implement support for namespace prefixes in XPath expressions. cmlenz parents: 204 diff changeset	512 if type(uri) is cls:
90d62225f411 Implement support for namespace prefixes in XPath expressions. cmlenz parents: 204 diff changeset	513 return uri
90d62225f411 Implement support for namespace prefixes in XPath expressions. cmlenz parents: 204 diff changeset	514 return object.__new__(cls, uri)
90d62225f411 Implement support for namespace prefixes in XPath expressions. cmlenz parents: 204 diff changeset	515
279 a99666402b12 Some adjustments to make core data structures picklable (requires protocol 2). cmlenz parents: 278 diff changeset	516 def __getnewargs__(self):
a99666402b12 Some adjustments to make core data structures picklable (requires protocol 2). cmlenz parents: 278 diff changeset	517 return (self.uri,)
a99666402b12 Some adjustments to make core data structures picklable (requires protocol 2). cmlenz parents: 278 diff changeset	518
a99666402b12 Some adjustments to make core data structures picklable (requires protocol 2). cmlenz parents: 278 diff changeset	519 def __getstate__(self):
a99666402b12 Some adjustments to make core data structures picklable (requires protocol 2). cmlenz parents: 278 diff changeset	520 return self.uri
a99666402b12 Some adjustments to make core data structures picklable (requires protocol 2). cmlenz parents: 278 diff changeset	521
a99666402b12 Some adjustments to make core data structures picklable (requires protocol 2). cmlenz parents: 278 diff changeset	522 def __setstate__(self, uri):
a99666402b12 Some adjustments to make core data structures picklable (requires protocol 2). cmlenz parents: 278 diff changeset	523 self.uri = uri
a99666402b12 Some adjustments to make core data structures picklable (requires protocol 2). cmlenz parents: 278 diff changeset	524
18 5420cfe42d36 Actually make use of the `markup.core.Namespace` class, and add a couple of doctests. cmlenz parents: 17 diff changeset	525 def __init__(self, uri):
5420cfe42d36 Actually make use of the `markup.core.Namespace` class, and add a couple of doctests. cmlenz parents: 17 diff changeset	526 self.uri = unicode(uri)
1 5479aae32f5a Initial import. cmlenz parents: diff changeset	527
18 5420cfe42d36 Actually make use of the `markup.core.Namespace` class, and add a couple of doctests. cmlenz parents: 17 diff changeset	528 def __contains__(self, qname):
5420cfe42d36 Actually make use of the `markup.core.Namespace` class, and add a couple of doctests. cmlenz parents: 17 diff changeset	529 return qname.namespace == self.uri
5420cfe42d36 Actually make use of the `markup.core.Namespace` class, and add a couple of doctests. cmlenz parents: 17 diff changeset	530
278 d6c58473a9d0 Fix the handling of namespace context for match templates. cmlenz parents: 230 diff changeset	531 def __ne__(self, other):
d6c58473a9d0 Fix the handling of namespace context for match templates. cmlenz parents: 230 diff changeset	532 return not self == other
d6c58473a9d0 Fix the handling of namespace context for match templates. cmlenz parents: 230 diff changeset	533
18 5420cfe42d36 Actually make use of the `markup.core.Namespace` class, and add a couple of doctests. cmlenz parents: 17 diff changeset	534 def __eq__(self, other):
5420cfe42d36 Actually make use of the `markup.core.Namespace` class, and add a couple of doctests. cmlenz parents: 17 diff changeset	535 if isinstance(other, Namespace):
5420cfe42d36 Actually make use of the `markup.core.Namespace` class, and add a couple of doctests. cmlenz parents: 17 diff changeset	536 return self.uri == other.uri
5420cfe42d36 Actually make use of the `markup.core.Namespace` class, and add a couple of doctests. cmlenz parents: 17 diff changeset	537 return self.uri == other
1 5479aae32f5a Initial import. cmlenz parents: diff changeset	538
5479aae32f5a Initial import. cmlenz parents: diff changeset	539 def __getitem__(self, name):
18 5420cfe42d36 Actually make use of the `markup.core.Namespace` class, and add a couple of doctests. cmlenz parents: 17 diff changeset	540 return QName(self.uri + u'}' + name)
1 5479aae32f5a Initial import. cmlenz parents: diff changeset	541 __getattr__ = __getitem__
5479aae32f5a Initial import. cmlenz parents: diff changeset	542
5479aae32f5a Initial import. cmlenz parents: diff changeset	543 def __repr__(self):
5479aae32f5a Initial import. cmlenz parents: diff changeset	544 return '<Namespace "%s">' % self.uri
5479aae32f5a Initial import. cmlenz parents: diff changeset	545
5479aae32f5a Initial import. cmlenz parents: diff changeset	546 def __str__(self):
18 5420cfe42d36 Actually make use of the `markup.core.Namespace` class, and add a couple of doctests. cmlenz parents: 17 diff changeset	547 return self.uri.encode('utf-8')
1 5479aae32f5a Initial import. cmlenz parents: diff changeset	548
5479aae32f5a Initial import. cmlenz parents: diff changeset	549 def __unicode__(self):
18 5420cfe42d36 Actually make use of the `markup.core.Namespace` class, and add a couple of doctests. cmlenz parents: 17 diff changeset	550 return self.uri
1 5479aae32f5a Initial import. cmlenz parents: diff changeset	551
5479aae32f5a Initial import. cmlenz parents: diff changeset	552
147 a4a0ca41b6ad Use `xmlcharrefreplace` when encoding the output in `Stream.render()`, so that encoding the output to legacy encodings such as ASCII or ISO-8859-1 should always work. cmlenz parents: 145 diff changeset	553 # The namespace used by attributes such as xml:lang and xml:space
141 520a5b7dd6d2 * No escaping of `<script>` or `<style>` tags in HTML output (see #24) cmlenz parents: 140 diff changeset	554 XML_NAMESPACE = Namespace('http://www.w3.org/XML/1998/namespace')
520a5b7dd6d2 * No escaping of `<script>` or `<style>` tags in HTML output (see #24) cmlenz parents: 140 diff changeset	555
520a5b7dd6d2 * No escaping of `<script>` or `<style>` tags in HTML output (see #24) cmlenz parents: 140 diff changeset	556
1 5479aae32f5a Initial import. cmlenz parents: diff changeset	557 class QName(unicode):
5479aae32f5a Initial import. cmlenz parents: diff changeset	558 """A qualified element or attribute name.
5479aae32f5a Initial import. cmlenz parents: diff changeset	559
5479aae32f5a Initial import. cmlenz parents: diff changeset	560 The unicode value of instances of this class contains the qualified name of
5479aae32f5a Initial import. cmlenz parents: diff changeset	561 the element or attribute, in the form `{namespace}localname`. The namespace
5479aae32f5a Initial import. cmlenz parents: diff changeset	562 URI can be obtained through the additional `namespace` attribute, while the
5479aae32f5a Initial import. cmlenz parents: diff changeset	563 local name can be accessed through the `localname` attribute.
18 5420cfe42d36 Actually make use of the `markup.core.Namespace` class, and add a couple of doctests. cmlenz parents: 17 diff changeset	564
5420cfe42d36 Actually make use of the `markup.core.Namespace` class, and add a couple of doctests. cmlenz parents: 17 diff changeset	565 >>> qname = QName('foo')
5420cfe42d36 Actually make use of the `markup.core.Namespace` class, and add a couple of doctests. cmlenz parents: 17 diff changeset	566 >>> qname
326 f999da894391 Fixed `__repr__` of the `QName`, `Attrs`, and `Expression` classes so that the output can be used as code to instantiate the object again. cmlenz parents: 279 diff changeset	567 QName(u'foo')
18 5420cfe42d36 Actually make use of the `markup.core.Namespace` class, and add a couple of doctests. cmlenz parents: 17 diff changeset	568 >>> qname.localname
5420cfe42d36 Actually make use of the `markup.core.Namespace` class, and add a couple of doctests. cmlenz parents: 17 diff changeset	569 u'foo'
5420cfe42d36 Actually make use of the `markup.core.Namespace` class, and add a couple of doctests. cmlenz parents: 17 diff changeset	570 >>> qname.namespace
5420cfe42d36 Actually make use of the `markup.core.Namespace` class, and add a couple of doctests. cmlenz parents: 17 diff changeset	571
5420cfe42d36 Actually make use of the `markup.core.Namespace` class, and add a couple of doctests. cmlenz parents: 17 diff changeset	572 >>> qname = QName('http://www.w3.org/1999/xhtml}body')
5420cfe42d36 Actually make use of the `markup.core.Namespace` class, and add a couple of doctests. cmlenz parents: 17 diff changeset	573 >>> qname
326 f999da894391 Fixed `__repr__` of the `QName`, `Attrs`, and `Expression` classes so that the output can be used as code to instantiate the object again. cmlenz parents: 279 diff changeset	574 QName(u'http://www.w3.org/1999/xhtml}body')
18 5420cfe42d36 Actually make use of the `markup.core.Namespace` class, and add a couple of doctests. cmlenz parents: 17 diff changeset	575 >>> qname.localname
5420cfe42d36 Actually make use of the `markup.core.Namespace` class, and add a couple of doctests. cmlenz parents: 17 diff changeset	576 u'body'
5420cfe42d36 Actually make use of the `markup.core.Namespace` class, and add a couple of doctests. cmlenz parents: 17 diff changeset	577 >>> qname.namespace
5420cfe42d36 Actually make use of the `markup.core.Namespace` class, and add a couple of doctests. cmlenz parents: 17 diff changeset	578 u'http://www.w3.org/1999/xhtml'
1 5479aae32f5a Initial import. cmlenz parents: diff changeset	579 """
5479aae32f5a Initial import. cmlenz parents: diff changeset	580 __slots__ = ['namespace', 'localname']
5479aae32f5a Initial import. cmlenz parents: diff changeset	581
5479aae32f5a Initial import. cmlenz parents: diff changeset	582 def __new__(cls, qname):
100 a519f581a1b1 Ported [111] to trunk. cmlenz parents: 96 diff changeset	583 if type(qname) is cls:
1 5479aae32f5a Initial import. cmlenz parents: diff changeset	584 return qname
5479aae32f5a Initial import. cmlenz parents: diff changeset	585
18 5420cfe42d36 Actually make use of the `markup.core.Namespace` class, and add a couple of doctests. cmlenz parents: 17 diff changeset	586 parts = qname.split(u'}', 1)
100 a519f581a1b1 Ported [111] to trunk. cmlenz parents: 96 diff changeset	587 if len(parts) > 1:
136 b86f496f6035 Minor performance improvements in serialization. cmlenz parents: 133 diff changeset	588 self = unicode.__new__(cls, u'{%s' % qname)
b86f496f6035 Minor performance improvements in serialization. cmlenz parents: 133 diff changeset	589 self.namespace, self.localname = map(unicode, parts)
1 5479aae32f5a Initial import. cmlenz parents: diff changeset	590 else:
5479aae32f5a Initial import. cmlenz parents: diff changeset	591 self = unicode.__new__(cls, qname)
136 b86f496f6035 Minor performance improvements in serialization. cmlenz parents: 133 diff changeset	592 self.namespace, self.localname = None, unicode(qname)
1 5479aae32f5a Initial import. cmlenz parents: diff changeset	593 return self
279 a99666402b12 Some adjustments to make core data structures picklable (requires protocol 2). cmlenz parents: 278 diff changeset	594
a99666402b12 Some adjustments to make core data structures picklable (requires protocol 2). cmlenz parents: 278 diff changeset	595 def __getnewargs__(self):
a99666402b12 Some adjustments to make core data structures picklable (requires protocol 2). cmlenz parents: 278 diff changeset	596 return (self.lstrip('{'),)
326 f999da894391 Fixed `__repr__` of the `QName`, `Attrs`, and `Expression` classes so that the output can be used as code to instantiate the object again. cmlenz parents: 279 diff changeset	597
f999da894391 Fixed `__repr__` of the `QName`, `Attrs`, and `Expression` classes so that the output can be used as code to instantiate the object again. cmlenz parents: 279 diff changeset	598 def __repr__(self):
f999da894391 Fixed `__repr__` of the `QName`, `Attrs`, and `Expression` classes so that the output can be used as code to instantiate the object again. cmlenz parents: 279 diff changeset	599 return 'QName(%s)' % unicode.__repr__(self.lstrip('{'))

Mercurial > genshi > mirror

annotate genshi/core.py @ 326:f999da894391 trunk