1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 17 18 19 20 21 22 23 24 25 26 27 28 29 30 31 32 33 34 35 36 37 38 39 40 41 42 43 44 45 46 47 48 49 50 51 52 53 54 55 56 57 58 59 60 61 62 63 64 65 66 67 68 69 70 71 72 73 74 75 76 77 78 79 80 81 82 83 84 85 86 87 88 89 90 91 92 93 94 95 96 97 98 99 100 101 102 103 104 105 106 107 108 109 110 111 112 113 114 115 116 117 118 119 120 121 122 123 124 125 126 127 128 129 130 131 132 133 134 135 136 137 138 139 140 141 142 143 144 145 146 147 148 149 150 151 152 153 154 155 156 157 158 159 160 161 162 163 164 165 166 167 168 169 170 171 172 173 174 175 176 177 178 179 180 181 182 183 184 185 186 187 188 189 190 191 192 193 194 195 196 197 198 199 200 201 202 203 204 205 206 207 208 209 210 211 212 213 214 215 216 217 218 219 220 221 222 223 224 225 226 227 228 229 230 231 232 233 234 235 236 237 238 239 240 241 242 243 244 245 246 247 248 249 250 251 252 253 254 255 256 257 258 259 260 261 262 263 264 265 266 267 268 269 270 271 272 273 274 275 276 277 278 279 280 281 282 283 284 285 286 287 288 289 290 291 292 293 294 295 296 297 298 299 300 301 302 303 304 305 306 307 308 309 310 311 312 313 314 315 316 317 318 319 320 321 322 323 324 325 326 327 328 329 330 331 332 333 334 335 336 337 338 339 340 341 342 343 344 345 346 347 348 349 350 351 352 353 354 355 356 357 358 359 360 361 362 363 364 365 366 367 368 369 370 371 372 373 374 375
|
import platform
import doctest
import unittest
from nose.tools import assert_raises
from urlobject import urlobject as urlobject_module
from urlobject import URLObject
from urlobject.six import text_type, u, print_
def dictsort(d):
"""``repr()`` a dictionary with sorted key/value pairs, for doctests."""
items = sorted(d.items())
print_('{' + ', '.join('%r: %r' % (k, v) for k, v in items) + '}')
class URLObjectTest(unittest.TestCase):
def setUp(self):
self.url_string = u("https://github.com/zacharyvoase/urlobject?spam=eggs#foo")
def test_urlobject_preserves_equality_with_the_original_string(self):
assert URLObject(self.url_string) == self.url_string
def test_urlobject_preserves_the_hash_of_the_original_string(self):
assert hash(URLObject(self.url_string)) == hash(self.url_string)
def test_calling_unicode_on_a_urlobject_returns_a_normal_string(self):
url = URLObject(self.url_string)
# Normally `type(x) is Y` is a bad idea, but it's exactly what we want.
assert type(text_type(url)) is text_type
assert text_type(url) == self.url_string
class SphinxDoctestsTest(unittest.TestCase):
def test__doctest(self):
result = doctest.testmod(urlobject_module,
extraglobs={'dictsort': dictsort})
if platform.python_version() < '3.2':
# Don't run doctests on pre-3.2.
return
failed = result.failed
attempted = result.attempted
self.assertTrue(attempted > 0, "No doctests were found")
self.assertEquals(failed, 0, "There are failed doctests")
class URLObjectRelativeTest(unittest.TestCase):
def setUp(self):
self.url = URLObject("https://github.com/zacharyvoase/urlobject?spam=eggs#foo")
def test_relative_with_scheme_returns_the_given_URL(self):
assert self.url.relative('http://example.com/abc') == 'http://example.com/abc'
def test_relative_with_netloc_returns_the_given_URL_but_preserves_scheme(self):
assert self.url.relative('//example.com/abc') == 'https://example.com/abc'
def test_relative_with_path_replaces_path_and_removes_query_string_and_fragment(self):
assert self.url.relative('another-project') == 'https://github.com/zacharyvoase/another-project'
assert self.url.relative('.') == 'https://github.com/zacharyvoase/'
assert self.url.relative('/dvxhouse/intessa') == 'https://github.com/dvxhouse/intessa'
assert self.url.relative('/dvxhouse/intessa') == 'https://github.com/dvxhouse/intessa'
def test_relative_with_empty_string_removes_fragment_but_preserves_query(self):
# The empty string is treated as a path meaning 'the current location'.
assert self.url.relative('') == self.url.without_fragment()
def test_relative_with_query_string_removes_fragment(self):
assert self.url.relative('?name=value') == self.url.without_fragment().with_query('name=value')
def test_relative_with_fragment_removes_nothing(self):
assert self.url.relative('#foobar') == self.url.with_fragment('foobar')
def test_compound_relative_urls(self):
assert self.url.relative('//example.com/a/b') == 'https://example.com/a/b'
assert self.url.relative('//example.com/a/b#bar') == 'https://example.com/a/b#bar'
assert self.url.relative('//example.com/a/b?c=d#bar') == 'https://example.com/a/b?c=d#bar'
assert self.url.relative('/a/b?c=d#bar') == 'https://github.com/a/b?c=d#bar'
assert self.url.relative('?c=d#bar') == 'https://github.com/zacharyvoase/urlobject?c=d#bar'
assert self.url.relative('#bar') == 'https://github.com/zacharyvoase/urlobject?spam=eggs#bar'
class URLObjectPropertyTest(unittest.TestCase):
def setUp(self):
self.url = URLObject("https://github.com/zacharyvoase/urlobject?spam=eggs#foo")
def test_scheme_returns_scheme(self):
assert self.url.scheme == 'https'
def test_netloc_returns_netloc(self):
assert self.url.netloc == 'github.com'
def test_hostname_returns_hostname(self):
assert self.url.hostname == 'github.com'
url = URLObject("https://user:pass@github.com:443")
assert url.hostname == 'github.com'
def test_port_returns_port_or_None(self):
assert self.url.port is None
assert URLObject("https://github.com:412").port == 412
def test_default_port_returns_default_port_when_none_specified(self):
assert self.url.default_port == 443
def test_default_port_returns_given_port_when_one_is_specified(self):
assert URLObject("https://github.com:412").default_port == 412
def test_path_returns_path(self):
assert self.url.path == '/zacharyvoase/urlobject'
def test_query_returns_query(self):
assert self.url.query == 'spam=eggs'
def test_query_list_returns_a_list_of_query_params(self):
assert self.url.query_list == [('spam', 'eggs')]
def test_query_dict_returns_a_dict_of_query_params(self):
assert self.url.query_dict == {'spam': 'eggs'}
def test_query_multi_dict_returns_a_multi_dict_of_query_params(self):
url = URLObject('https://example.com/?spam=eggs&spam=ham&foo=bar')
assert url.query_multi_dict == {'spam': ['eggs', 'ham'],
'foo': ['bar']}
def test_fragment_returns_fragment(self):
assert self.url.fragment == 'foo'
def test_fragment_is_decoded_correctly(self):
url = URLObject('https://example.com/#frag%20ment')
assert url.fragment == 'frag ment'
def test_auth_properties_can_parse_username_and_password(self):
url = URLObject('https://zack:12345@github.com/')
assert url.username == 'zack'
assert url.password == '12345'
assert url.auth == ('zack', '12345')
def test_auth_properties_can_parse_username(self):
url = URLObject('https://zack@github.com/')
assert url.username == 'zack'
assert url.password is None
assert url.auth == ('zack', None)
def test_auth_properties_return_None_with_no_username_or_password(self):
url = URLObject('https://github.com/')
assert url.username is None
assert url.password is None
assert url.auth == (None, None)
class URLObjectModificationTest(unittest.TestCase):
def setUp(self):
self.url = URLObject('https://github.com/zacharyvoase/urlobject?spam=eggs#foo')
def test_with_scheme_replaces_scheme(self):
assert (self.url.with_scheme('http') ==
'http://github.com/zacharyvoase/urlobject?spam=eggs#foo')
def test_with_netloc_replaces_netloc(self):
assert (self.url.with_netloc('example.com') ==
'https://example.com/zacharyvoase/urlobject?spam=eggs#foo')
def test_with_hostname_replaces_hostname(self):
url = URLObject('https://user:pass@github.com/')
assert (url.with_hostname('example.com') ==
'https://user:pass@example.com/')
def test_with_username_adds_username(self):
url = URLObject('https://github.com/')
assert url.with_username('zack') == 'https://zack@github.com/'
def test_with_username_replaces_username(self):
url = URLObject('https://zack@github.com/')
assert url.with_username('alice') == 'https://alice@github.com/'
def test_without_username_removes_username(self):
url = URLObject('https://zack@github.com/')
assert url.without_username() == 'https://github.com/'
def test_with_password_adds_password(self):
url = URLObject('https://zack@github.com/')
assert url.with_password('1234') == 'https://zack:1234@github.com/'
def test_with_password_raises_ValueError_when_there_is_no_username(self):
url = URLObject('https://github.com/')
assert_raises(ValueError, lambda: url.with_password('1234'))
def test_with_password_replaces_password(self):
url = URLObject('https://zack:1234@github.com/')
assert url.with_password('5678') == 'https://zack:5678@github.com/'
def test_without_password_removes_password(self):
url = URLObject('https://zack:1234@github.com/')
assert url.without_password() == 'https://zack@github.com/'
def test_with_auth_with_one_arg_adds_username(self):
url = URLObject('https://github.com/')
assert url.with_auth('zack') == 'https://zack@github.com/'
def test_with_auth_with_one_arg_replaces_whole_auth_string_with_username(self):
url = URLObject('https://alice:1234@github.com/')
assert url.with_auth('zack') == 'https://zack@github.com/'
def test_with_auth_with_two_args_adds_username_and_password(self):
url = URLObject('https://github.com/')
assert url.with_auth('zack', '1234') == 'https://zack:1234@github.com/'
def test_with_auth_with_two_args_replaces_whole_auth_string_with_username_and_password(self):
# Replaces username-only auth string
url = URLObject('https://alice@github.com/')
assert url.with_auth('zack', '1234') == 'https://zack:1234@github.com/'
# Replaces username and password.
url = URLObject('https://alice:4567@github.com/')
assert url.with_auth('zack', '1234') == 'https://zack:1234@github.com/'
def test_without_auth_removes_entire_auth_string(self):
# No username or password => no-op.
url = URLObject('https://github.com/')
assert url.without_auth() == 'https://github.com/'
# Username-only.
url = URLObject('https://alice@github.com/')
assert url.without_auth() == 'https://github.com/'
# Username and password.
url = URLObject('https://alice:1234@github.com/')
assert url.without_auth() == 'https://github.com/'
def test_with_port_adds_port_number(self):
assert (self.url.with_port(24) ==
'https://github.com:24/zacharyvoase/urlobject?spam=eggs#foo')
def test_with_port_replaces_port_number(self):
url = URLObject('https://github.com:59/')
assert url.with_port(67) == 'https://github.com:67/'
def test_without_port_removes_port_number(self):
url = URLObject('https://github.com:59/')
assert url.without_port() == 'https://github.com/'
def test_with_path_replaces_path(self):
assert (self.url.with_path('/dvxhouse/intessa') ==
'https://github.com/dvxhouse/intessa?spam=eggs#foo')
def test_root_goes_to_root_path(self):
assert self.url.root == 'https://github.com/?spam=eggs#foo'
def test_parent_jumps_up_one_level(self):
url = URLObject('https://github.com/zacharyvoase/urlobject')
assert url.parent == 'https://github.com/zacharyvoase/'
assert url.parent.parent == 'https://github.com/'
def test_add_path_segment_adds_a_path_segment(self):
url = URLObject('https://github.com/zacharyvoase/urlobject')
assert (url.add_path_segment('tree') ==
'https://github.com/zacharyvoase/urlobject/tree')
assert (url.add_path_segment('tree/master') ==
'https://github.com/zacharyvoase/urlobject/tree%2Fmaster')
def test_add_path_adds_a_partial_path(self):
url = URLObject('https://github.com/zacharyvoase/urlobject')
assert (url.add_path('tree') ==
'https://github.com/zacharyvoase/urlobject/tree')
assert (url.add_path('tree/master') ==
'https://github.com/zacharyvoase/urlobject/tree/master')
def test_is_leaf(self):
assert URLObject('https://github.com/zacharyvoase/urlobject').is_leaf
assert not URLObject('https://github.com/zacharyvoase/').is_leaf
def test_with_query_replaces_query(self):
assert (self.url.with_query('spam-ham-eggs') ==
'https://github.com/zacharyvoase/urlobject?spam-ham-eggs#foo')
def test_without_query_removes_query(self):
assert (self.url.without_query() ==
'https://github.com/zacharyvoase/urlobject#foo')
def test_add_query_param_adds_one_query_parameter(self):
assert (self.url.add_query_param('spam', 'ham') ==
'https://github.com/zacharyvoase/urlobject?spam=eggs&spam=ham#foo')
def test_add_query_params_adds_multiple_query_parameters(self):
assert (self.url.add_query_params([('spam', 'ham'), ('foo', 'bar')]) ==
'https://github.com/zacharyvoase/urlobject?spam=eggs&spam=ham&foo=bar#foo')
def test_add_query_params_with_multiple_values_adds_the_same_query_parameter_multiple_times(self):
assert (self.url.add_query_params({'foo': ['bar', 'baz']}) ==
'https://github.com/zacharyvoase/urlobject?spam=eggs&foo=bar&foo=baz#foo')
def test_set_query_param_adds_or_replaces_one_query_parameter(self):
assert (self.url.set_query_param('spam', 'ham') ==
'https://github.com/zacharyvoase/urlobject?spam=ham#foo')
def test_set_query_params_adds_or_replaces_multiple_query_parameters(self):
assert (self.url.set_query_params({'foo': 'bar'}, spam='ham') ==
'https://github.com/zacharyvoase/urlobject?foo=bar&spam=ham#foo')
def test_set_query_params_with_multiple_values_adds_or_replaces_the_same_parameter_multiple_times(self):
assert (self.url.set_query_params({'spam': ['bar', 'baz']}) ==
'https://github.com/zacharyvoase/urlobject?spam=bar&spam=baz#foo')
assert (self.url.set_query_params({'foo': ['bar', 'baz']}) ==
'https://github.com/zacharyvoase/urlobject?spam=eggs&foo=bar&foo=baz#foo')
# Ensure it removes all appearances of an existing name before adding
# the new ones.
url = URLObject('https://github.com/zacharyvoase/urlobject?foo=bar&foo=baz#foo')
assert (url.set_query_params({'foo': ['spam', 'ham']}) ==
'https://github.com/zacharyvoase/urlobject?foo=spam&foo=ham#foo')
def test_del_query_param_removes_one_query_parameter(self):
assert (self.url.del_query_param('spam') ==
'https://github.com/zacharyvoase/urlobject#foo')
def test_del_query_params_removes_multiple_query_parameters(self):
url = URLObject('https://github.com/zacharyvoase/urlobject?foo=bar&baz=spam#foo')
assert (url.del_query_params(['foo', 'baz']) ==
'https://github.com/zacharyvoase/urlobject#foo')
def test_del_query_param_value_removes_matching_query_parameters(self):
url = URLObject('https://github.com/zacharyvoase/urlobject?foo=bar&baz=spam&foo=qux&foo=bar#foo')
assert (url.del_query_param_value('foo', 'bar') ==
'https://github.com/zacharyvoase/urlobject?baz=spam&foo=qux#foo')
def test_with_fragment_replaces_fragment(self):
assert (self.url.with_fragment('part') ==
'https://github.com/zacharyvoase/urlobject?spam=eggs#part')
def test_with_fragment_encodes_fragment_correctly(self):
assert (self.url.with_fragment('foo bar#baz') ==
'https://github.com/zacharyvoase/urlobject?spam=eggs#foo%20bar%23baz')
def test_without_fragment_removes_fragment(self):
assert (self.url.without_fragment() ==
'https://github.com/zacharyvoase/urlobject?spam=eggs')
class IRITest(unittest.TestCase):
def test_encode_hostname_idna(self):
assert (URLObject.from_iri(u('https://\xe9xample.com/')) ==
'https://xn--xample-9ua.com/')
def test_port_maintained(self):
assert (URLObject.from_iri(u('https://\xe9xample.com:80/')) ==
'https://xn--xample-9ua.com:80/')
def test_encode_path(self):
assert (URLObject.from_iri(u('https://example.com/p\xe5th/path2')) ==
'https://example.com/p%C3%A5th/path2')
def test_encode_query(self):
assert (URLObject.from_iri(u('https://example.com/?k\xe9y=v\xe5l&key2=val2')) ==
'https://example.com/?k%C3%A9y=v%C3%A5l&key2=val2')
def test_encode_fragment(self):
assert (URLObject.from_iri(u('https://example.com/#fr\xe5gment')) ==
'https://example.com/#fr%C3%A5gment')
def test_path_params(self):
assert (URLObject.from_iri(u('https://example.com/foo;p\xe5rameter')) ==
'https://example.com/foo;p%C3%A5rameter')
def test_quoted_iri(self):
"""
If an IRI already has some quoted characters, they will be maintained as is.
"""
assert (URLObject.from_iri(u('https://example.com/foo%20b\xe5r/')) ==
'https://example.com/foo%20b%C3%A5r/')
def test_quote_other_special_characters(self):
assert (URLObject.from_iri(u('https://example.com/foo bar/')) ==
'https://example.com/foo%20bar/')
|