Changes between Version 5 and Version 6 of TracDev/ApiChanges/0.12

Timestamp:

Sep 1, 2009, 12:22:13 AM (15 years ago)

Author:

Remy Blank

Comment:

Added a section about the changes in Href.

TracDev/ApiChanges/0.12

@@ -33 +33 @@
 
 === Other Changes to the 0.11 API ===
+==== `Href` with an empty base ^[source:trunk/trac/web/tests/href.py@8551:61-62,76-78#L57 (0.12)] [source:branches/0.11-stable/trac/web/tests/href.py@8551:63-64,79-81#L57 (0.11)]^ ==== #Href
+The `Href` class has been changed to ensure that it always generates valid URLs, even with an empty base. In 0.11, the following uses all return an empty string:
+{{{
+#!python
+# 0.11
+>>> href = Href('')             # Also applies to Href('/')
+>>> href()
+''
+>>> href('/')
+''
+}}}
+In 0.12, the same expressions return a valid relative URL:
+{{{
+#!python
+# 0.12
+>>> href = Href('')
+>>> href()
+'/'
+>>> href('/')
+'/'
+}}}
+This change will break plugins that use the following idiom to concatenate the base URL with a path starting with a slash:
+{{{
+#!python
+# 0.12
+>>> href = Href('')
+>>> path = '/path/to/page'
+>>> href() + path               # Broken
+'//path/to/page'
+}}}
+For this specific use case, a new syntax has been added to avoid doubled slashes:
+{{{
+#!python
+# 0.12 and 0.11.6
+>>> href = Href('')
+>>> path = '/path/to/page'
+>>> href + path                 # New syntax
+'/path/to/page'
+}}}
+The new syntax has been backported to 0.11-stable in 0.11.6 to facilitate compatibility of plugins with both 0.11.6 and 0.12. If compatibility with older releases of the 0.11.x branch is required, the following code can be used:
+{{{
+#!python
+# 0.12 and 0.11.x
+>>> href = Href('')
+>>> path = '/path/to/page'
+>>> href().rstrip('/') + path   # Compatibility
+'/path/to/page'
+}}}
+
+See also #8159.
+
 
 == New in the 0.12 API ==