genshi/mirror: genshi/core.py annotate

annotate genshi/core.py @ 1025:8f5ead39e537 trunk

Revert r1245 (the Python3.4 regression was fixed in http://hg.python.org/cpython/rev/b328f8ccbccf).

author	hodgestar
date	Mon, 17 Feb 2014 09:10:44 +0000
parents	ad96321e4d2b
children

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

Mercurial > genshi > mirror

annotate genshi/core.py @ 1025:8f5ead39e537 trunk