This file is indexed.

/usr/share/pyshared/zope.testbrowser-4.0.2.egg-info/PKG-INFO is in python-zope.testbrowser 4.0.2-1ubuntu1.

This file is owned by root:root, with mode 0o644.

The actual contents of the file can be viewed below.

   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
 376
 377
 378
 379
 380
 381
 382
 383
 384
 385
 386
 387
 388
 389
 390
 391
 392
 393
 394
 395
 396
 397
 398
 399
 400
 401
 402
 403
 404
 405
 406
 407
 408
 409
 410
 411
 412
 413
 414
 415
 416
 417
 418
 419
 420
 421
 422
 423
 424
 425
 426
 427
 428
 429
 430
 431
 432
 433
 434
 435
 436
 437
 438
 439
 440
 441
 442
 443
 444
 445
 446
 447
 448
 449
 450
 451
 452
 453
 454
 455
 456
 457
 458
 459
 460
 461
 462
 463
 464
 465
 466
 467
 468
 469
 470
 471
 472
 473
 474
 475
 476
 477
 478
 479
 480
 481
 482
 483
 484
 485
 486
 487
 488
 489
 490
 491
 492
 493
 494
 495
 496
 497
 498
 499
 500
 501
 502
 503
 504
 505
 506
 507
 508
 509
 510
 511
 512
 513
 514
 515
 516
 517
 518
 519
 520
 521
 522
 523
 524
 525
 526
 527
 528
 529
 530
 531
 532
 533
 534
 535
 536
 537
 538
 539
 540
 541
 542
 543
 544
 545
 546
 547
 548
 549
 550
 551
 552
 553
 554
 555
 556
 557
 558
 559
 560
 561
 562
 563
 564
 565
 566
 567
 568
 569
 570
 571
 572
 573
 574
 575
 576
 577
 578
 579
 580
 581
 582
 583
 584
 585
 586
 587
 588
 589
 590
 591
 592
 593
 594
 595
 596
 597
 598
 599
 600
 601
 602
 603
 604
 605
 606
 607
 608
 609
 610
 611
 612
 613
 614
 615
 616
 617
 618
 619
 620
 621
 622
 623
 624
 625
 626
 627
 628
 629
 630
 631
 632
 633
 634
 635
 636
 637
 638
 639
 640
 641
 642
 643
 644
 645
 646
 647
 648
 649
 650
 651
 652
 653
 654
 655
 656
 657
 658
 659
 660
 661
 662
 663
 664
 665
 666
 667
 668
 669
 670
 671
 672
 673
 674
 675
 676
 677
 678
 679
 680
 681
 682
 683
 684
 685
 686
 687
 688
 689
 690
 691
 692
 693
 694
 695
 696
 697
 698
 699
 700
 701
 702
 703
 704
 705
 706
 707
 708
 709
 710
 711
 712
 713
 714
 715
 716
 717
 718
 719
 720
 721
 722
 723
 724
 725
 726
 727
 728
 729
 730
 731
 732
 733
 734
 735
 736
 737
 738
 739
 740
 741
 742
 743
 744
 745
 746
 747
 748
 749
 750
 751
 752
 753
 754
 755
 756
 757
 758
 759
 760
 761
 762
 763
 764
 765
 766
 767
 768
 769
 770
 771
 772
 773
 774
 775
 776
 777
 778
 779
 780
 781
 782
 783
 784
 785
 786
 787
 788
 789
 790
 791
 792
 793
 794
 795
 796
 797
 798
 799
 800
 801
 802
 803
 804
 805
 806
 807
 808
 809
 810
 811
 812
 813
 814
 815
 816
 817
 818
 819
 820
 821
 822
 823
 824
 825
 826
 827
 828
 829
 830
 831
 832
 833
 834
 835
 836
 837
 838
 839
 840
 841
 842
 843
 844
 845
 846
 847
 848
 849
 850
 851
 852
 853
 854
 855
 856
 857
 858
 859
 860
 861
 862
 863
 864
 865
 866
 867
 868
 869
 870
 871
 872
 873
 874
 875
 876
 877
 878
 879
 880
 881
 882
 883
 884
 885
 886
 887
 888
 889
 890
 891
 892
 893
 894
 895
 896
 897
 898
 899
 900
 901
 902
 903
 904
 905
 906
 907
 908
 909
 910
 911
 912
 913
 914
 915
 916
 917
 918
 919
 920
 921
 922
 923
 924
 925
 926
 927
 928
 929
 930
 931
 932
 933
 934
 935
 936
 937
 938
 939
 940
 941
 942
 943
 944
 945
 946
 947
 948
 949
 950
 951
 952
 953
 954
 955
 956
 957
 958
 959
 960
 961
 962
 963
 964
 965
 966
 967
 968
 969
 970
 971
 972
 973
 974
 975
 976
 977
 978
 979
 980
 981
 982
 983
 984
 985
 986
 987
 988
 989
 990
 991
 992
 993
 994
 995
 996
 997
 998
 999
1000
1001
1002
1003
1004
1005
1006
1007
1008
1009
1010
1011
1012
1013
1014
1015
1016
1017
1018
1019
1020
1021
1022
1023
1024
1025
1026
1027
1028
1029
1030
1031
1032
1033
1034
1035
1036
1037
1038
1039
1040
1041
1042
1043
1044
1045
1046
1047
1048
1049
1050
1051
1052
1053
1054
1055
1056
1057
1058
1059
1060
1061
1062
1063
1064
1065
1066
1067
1068
1069
1070
1071
1072
1073
1074
1075
1076
1077
1078
1079
1080
1081
1082
1083
1084
1085
1086
1087
1088
1089
1090
1091
1092
1093
1094
1095
1096
1097
1098
1099
1100
1101
1102
1103
1104
1105
1106
1107
1108
1109
1110
1111
1112
1113
1114
1115
1116
1117
1118
1119
1120
1121
1122
1123
1124
1125
1126
1127
1128
1129
1130
1131
1132
1133
1134
1135
1136
1137
1138
1139
1140
1141
1142
1143
1144
1145
1146
1147
1148
1149
1150
1151
1152
1153
1154
1155
1156
1157
1158
1159
1160
1161
1162
1163
1164
1165
1166
1167
1168
1169
1170
1171
1172
1173
1174
1175
1176
1177
1178
1179
1180
1181
1182
1183
1184
1185
1186
1187
1188
1189
1190
1191
1192
1193
1194
1195
1196
1197
1198
1199
1200
1201
1202
1203
1204
1205
1206
1207
1208
1209
1210
1211
1212
1213
1214
1215
1216
1217
1218
1219
1220
1221
1222
1223
1224
1225
1226
1227
1228
1229
1230
1231
1232
1233
1234
1235
1236
1237
1238
1239
1240
1241
1242
1243
1244
1245
1246
1247
1248
1249
1250
1251
1252
1253
1254
1255
1256
1257
1258
1259
1260
1261
1262
1263
1264
1265
1266
1267
1268
1269
1270
1271
1272
1273
1274
1275
1276
1277
1278
1279
1280
1281
1282
1283
1284
1285
1286
1287
1288
1289
1290
1291
1292
1293
1294
1295
1296
1297
1298
1299
1300
1301
1302
1303
1304
1305
1306
1307
1308
1309
1310
1311
1312
1313
1314
1315
1316
1317
1318
1319
1320
1321
1322
1323
1324
1325
1326
1327
1328
1329
1330
1331
1332
1333
1334
1335
1336
1337
1338
1339
1340
1341
1342
1343
1344
1345
1346
1347
1348
1349
1350
1351
1352
1353
1354
1355
1356
1357
1358
1359
1360
1361
1362
1363
1364
1365
1366
1367
1368
1369
1370
1371
1372
1373
1374
1375
1376
1377
1378
1379
1380
1381
1382
1383
1384
1385
1386
1387
1388
1389
1390
1391
1392
1393
1394
1395
1396
1397
1398
1399
1400
1401
1402
1403
1404
1405
1406
1407
1408
1409
1410
1411
1412
1413
1414
1415
1416
1417
1418
1419
1420
1421
1422
1423
1424
1425
1426
1427
1428
1429
1430
1431
1432
1433
1434
1435
1436
1437
1438
1439
1440
1441
1442
1443
1444
1445
1446
1447
1448
1449
1450
1451
1452
1453
1454
1455
1456
1457
1458
1459
1460
1461
1462
1463
1464
1465
1466
1467
1468
1469
1470
1471
1472
1473
1474
1475
1476
1477
1478
1479
1480
1481
1482
1483
1484
1485
1486
1487
1488
1489
1490
1491
1492
1493
1494
1495
1496
1497
1498
1499
1500
1501
1502
1503
1504
1505
1506
1507
1508
1509
1510
1511
1512
1513
1514
1515
1516
1517
1518
1519
1520
1521
1522
1523
1524
1525
1526
1527
1528
1529
1530
1531
1532
1533
1534
1535
1536
1537
1538
1539
1540
1541
1542
1543
1544
1545
1546
1547
1548
1549
1550
1551
1552
1553
1554
1555
1556
1557
1558
1559
1560
1561
1562
1563
1564
1565
1566
1567
1568
1569
1570
1571
1572
1573
1574
1575
1576
1577
1578
1579
1580
1581
1582
1583
1584
1585
1586
1587
1588
1589
1590
1591
1592
1593
1594
1595
1596
1597
1598
1599
1600
1601
1602
1603
1604
1605
1606
1607
1608
1609
1610
1611
1612
1613
1614
1615
1616
1617
1618
1619
1620
1621
1622
1623
1624
1625
1626
1627
1628
1629
1630
1631
1632
1633
1634
1635
1636
1637
1638
1639
1640
1641
1642
1643
1644
1645
1646
1647
1648
1649
1650
1651
1652
1653
1654
1655
1656
1657
1658
1659
1660
1661
1662
1663
1664
1665
1666
1667
1668
1669
1670
1671
1672
1673
1674
1675
1676
1677
1678
1679
1680
1681
1682
1683
1684
1685
1686
1687
1688
1689
1690
1691
1692
1693
1694
1695
1696
1697
1698
1699
1700
1701
1702
1703
1704
1705
1706
1707
1708
1709
1710
1711
1712
1713
1714
1715
1716
1717
1718
1719
1720
1721
1722
1723
1724
1725
1726
1727
Metadata-Version: 1.1
Name: zope.testbrowser
Version: 4.0.2
Summary: Programmable browser for functional black-box tests
Home-page: http://pypi.python.org/pypi/zope.testbrowser
Author: Zope Corporation and Contributors
Author-email: zope-dev@zope.org
License: ZPL 2.1
Description: .. contents::
        
        ``zope.testbrowser`` provides an easy-to-use programmable web browser
        with special focus on testing.  It is used in Zope, but it's not Zope
        specific at all.  For instance, it can be used to test or otherwise
        interact with any web site.
        
        
        
        ======================
        Detailed Documentation
        ======================
        
        Different Browsers
        ------------------
        
        HTTP Browser
        ~~~~~~~~~~~~
        
        The ``zope.testbrowser.browser`` module exposes a ``Browser`` class that
        simulates a web browser similar to Mozilla Firefox or IE.
        
            >>> from zope.testbrowser.browser import Browser
            >>> browser = Browser()
        
        This version of the browser object can be used to access any web site just as
        you would do using a normal web browser.
        
        WSGI Test Browser
        ~~~~~~~~~~~~~~~~~
        
        General usage
        +++++++++++++
        
        There is also a special version of the ``Browser`` class which uses
        `WebTest`_ and can be used to do functional testing of WSGI
        applications. It can be imported from ``zope.testbrowser.wsgi``:
        
            >>> from zope.testbrowser.wsgi import Browser
            >>> from wsgiref.simple_server import demo_app
            >>> browser = Browser('http://localhost/', wsgi_app=demo_app)
            >>> print browser.contents
            Hello world!
            ...
        
        .. _`WebTest`: http://pypi.python.org/pypi/WebTest
        
        To use this browser you have to:
        
          * use the `wsgi` extra of the ``zope.testbrowser`` egg,
        
        You can also use it with zope layers by:
        
          * write a subclass of ``zope.testbrowser.wsgi.Layer`` and override the
            ``make_wsgi_app`` method,
        
          * use an instance of the class as the test layer of your test.
        
        Example:
        
            >>> import zope.testbrowser.wsgi
            >>> class SimpleLayer(zope.testbrowser.wsgi.Layer):
            ...     def make_wsgi_app(self):
            ...         return simple_app
        
        Where ``simple_app`` is the callable of your WSGI application.
        
        Testing a Zope 2/Zope 3/Bluebream WSGI application
        ++++++++++++++++++++++++++++++++++++++++++++++++++
        
        When testing a Zope 2/Zope 3/Bluebream WSGI application you should wrap your
        WSGI application under test into
        ``zope.testbrowser.wsgi.AuthorizationMiddleware`` as all these application
        servers expect basic authentication headers to be base64 encoded. This
        middleware handles this for you.
        
        Example when using the layer:
        
            >>> import zope.testbrowser.wsgi
            >>> class ZopeSimpleLayer(zope.testbrowser.wsgi.Layer):
            ...     def make_wsgi_app(self):
            ...         return zope.testbrowser.wsgi.AuthorizationMiddleware(simple_app)
        
        There is also a BrowserLayer in `zope.app.wsgi.testlayer`_ which does this
        for you and includes a ``TransactionMiddleware``, too, which could be handy
        when testing a ZODB based application.
        
        .. _`zope.app.wsgi.testlayer` : http://pypi.python.org/pypi/zope.app.wsgi
        
        
        Bowser Usage
        ------------
        
        We will test this browser against a WSGI test application:
        
            >>> from zope.testbrowser.ftests.wsgitestapp import WSGITestApplication
            >>> wsgi_app = WSGITestApplication()
        
        An initial page to load can be passed to the ``Browser`` constructor:
        
            >>> browser = Browser('http://localhost/@@/testbrowser/simple.html', wsgi_app=wsgi_app)
            >>> browser.url
            'http://localhost/@@/testbrowser/simple.html'
        
        The browser can send arbitrary headers; this is helpful for setting the
        "Authorization" header or a language value, so that your tests format values
        the way you expect in your tests, if you rely on zope.i18n locale-based
        formatting or a similar approach.
        
            >>> browser.addHeader('Authorization', 'Basic mgr:mgrpw')
            >>> browser.addHeader('Accept-Language', 'en-US')
        
        An existing browser instance can also `open` web pages:
        
            >>> browser.open('http://localhost/@@/testbrowser/simple.html')
            >>> browser.url
            'http://localhost/@@/testbrowser/simple.html'
        
        Once you have opened a web page initially, best practice for writing
        testbrowser doctests suggests using 'click' to navigate further (as discussed
        below), except in unusual circumstances.
        
        The test browser complies with the IBrowser interface; see
        ``zope.testbrowser.interfaces`` for full details on the interface.
        
            >>> from zope.testbrowser import interfaces
            >>> from zope.interface.verify import verifyObject
            >>> verifyObject(interfaces.IBrowser, browser)
            True
        
        
        Page Contents
        -------------
        
        The contents of the current page are available:
        
            >>> print browser.contents
            <html>
              <head>
                <title>Simple Page</title>
              </head>
              <body>
                <h1>Simple Page</h1>
              </body>
            </html>
        
        Making assertions about page contents is easy.
        
            >>> '<h1>Simple Page</h1>' in browser.contents
            True
        
        Utilizing the doctest facilities, it also possible to do:
        
            >>> browser.contents
            '...<h1>Simple Page</h1>...'
        
        Note: Unfortunately, ellipsis (...) cannot be used at the beginning of the
        output (this is a limitation of doctest).
        
        
        
        Checking for HTML
        -----------------
        
        Not all URLs return HTML.  Of course our simple page does:
        
            >>> browser.open('http://localhost/@@/testbrowser/simple.html')
            >>> browser.isHtml
            True
        
        But if we load an image (or other binary file), we do not get HTML:
        
            >>> browser.open('http://localhost/@@/testbrowser/zope3logo.gif')
            >>> browser.isHtml
            False
        
        
        
        HTML Page Title
        ----------------
        
        Another useful helper property is the title:
        
            >>> browser.open('http://localhost/@@/testbrowser/simple.html')
            >>> browser.title
            'Simple Page'
        
        If a page does not provide a title, it is simply ``None``:
        
            >>> browser.open('http://localhost/@@/testbrowser/notitle.html')
            >>> browser.title
        
        However, if the output is not HTML, then an error will occur trying to access
        the title:
        
            >>> browser.open('http://localhost/@@/testbrowser/zope3logo.gif')
            >>> browser.title
            Traceback (most recent call last):
            ...
            BrowserStateError: not viewing HTML
        
        
        Headers
        -------
        
        As you can see, the `contents` of the browser does not return any HTTP
        headers.  The headers are accessible via a separate attribute, which is an
        ``httplib.HTTPMessage`` instance (httplib is a part of Python's standard
        library):
        
            >>> browser.open('http://localhost/@@/testbrowser/simple.html')
            >>> browser.headers
            <httplib.HTTPMessage instance...>
        
        The headers can be accessed as a string:
        
            >>> print browser.headers
            Status: 200 OK
            Content-Length: 123
            Content-Type: text/html;charset=utf-8
        
        Or as a mapping:
        
            >>> browser.headers['content-type']
            'text/html;charset=utf-8'
        
        
        Cookies
        -------
        
        When a Set-Cookie header is available, it can be found in the headers, as seen
        above.  Here, we use a view that will make the server set cookies with the
        values we provide.
        
            >>> browser.open('http://localhost/set_cookie.html?name=foo&value=bar')
            >>> browser.headers['set-cookie'].replace(';', '')
            'foo=bar'
        
        It is also available in the browser's ``cookies`` attribute.  This is
        an extended mapping interface that allows getting, setting, and deleting the
        cookies that the browser is remembering *for the current url*.  Here are
        a few examples.
        
            >>> browser.cookies['foo']
            'bar'
            >>> browser.cookies.keys()
            ['foo']
            >>> browser.cookies.values()
            ['bar']
            >>> browser.cookies.items()
            [('foo', 'bar')]
            >>> 'foo' in browser.cookies
            True
            >>> 'bar' in browser.cookies
            False
            >>> len(browser.cookies)
            1
            >>> print(dict(browser.cookies))
            {'foo': 'bar'}
            >>> browser.cookies['sha'] = 'zam'
            >>> len(browser.cookies)
            2
            >>> sorted(browser.cookies.items())
            [('foo', 'bar'), ('sha', 'zam')]
            >>> browser.open('http://localhost/get_cookie.html')
            >>> print browser.headers.get('set-cookie')
            None
            >>> print browser.contents # server got the cookie change
            foo: bar
            sha: zam
            >>> sorted(browser.cookies.items())
            [('foo', 'bar'), ('sha', 'zam')]
            >>> browser.cookies.clearAll()
            >>> len(browser.cookies)
            0
        
        Many more examples, and a discussion of the additional methods available, can
        be found in cookies.txt.
        
        
        Navigation and Link Objects
        ---------------------------
        
        If you want to simulate clicking on a link, get the link and `click` on it.
        In the `navigate.html` file there are several links set up to demonstrate the
        capabilities of the link objects and their `click` method.
        
        The simplest way to get a link is via the anchor text.  In other words
        the text you would see in a browser (text and url searches are substring
        searches):
        
            >>> browser.open('http://localhost/@@/testbrowser/navigate.html')
            >>> browser.contents
            '...<a href="navigate.html?message=By+Link+Text">Link Text</a>...'
            >>> link = browser.getLink('Link Text')
            >>> link
            <Link text='Link Text'
              url='http://localhost/@@/testbrowser/navigate.html?message=By+Link+Text'>
        
        Link objects comply with the ILink interface.
        
            >>> verifyObject(interfaces.ILink, link)
            True
        
        Links expose several attributes for easy access.
        
            >>> link.text
            'Link Text'
            >>> link.tag # links can also be image maps.
            'a'
            >>> link.url # it's normalized
            'http://localhost/@@/testbrowser/navigate.html?message=By+Link+Text'
            >>> link.attrs
            {'href': 'navigate.html?message=By+Link+Text'}
        
        Links can be "clicked" and the browser will navigate to the referenced URL.
        
            >>> link.click()
            >>> browser.url
            'http://localhost/@@/testbrowser/navigate.html?message=By+Link+Text'
            >>> browser.contents
            '...Message: <em>By Link Text</em>...'
        
        When finding a link by its text, whitespace is normalized.
        
            >>> browser.open('http://localhost/@@/testbrowser/navigate.html')
            >>> browser.contents
            '...> Link Text \n    with     Whitespace\tNormalization (and parens) </...'
            >>> link = browser.getLink('Link Text with Whitespace Normalization '
            ...                        '(and parens)')
            >>> link
            <Link text='Link Text with Whitespace Normalization (and parens)'...>
            >>> link.text
            'Link Text with Whitespace Normalization (and parens)'
            >>> link.click()
            >>> browser.url
            'http://localhost/@@/testbrowser/navigate.html?message=By+Link+Text+with+Normalization'
            >>> browser.contents
            '...Message: <em>By Link Text with Normalization</em>...'
        
        When a link text matches more than one link, by default the first one is
        chosen. You can, however, specify the index of the link and thus retrieve a
        later matching link:
        
            >>> browser.getLink('Link Text')
            <Link text='Link Text' ...>
        
            >>> browser.getLink('Link Text', index=1)
            <Link text='Link Text with Whitespace Normalization (and parens)' ...>
        
        Note that clicking a link object after its browser page has expired will
        generate an error.
        
            >>> link.click()
            Traceback (most recent call last):
            ...
            ExpiredError
        
        You can also find the link by its URL,
        
            >>> browser.open('http://localhost/@@/testbrowser/navigate.html')
            >>> browser.contents
            '...<a href="navigate.html?message=By+URL">Using the URL</a>...'
        
            >>> browser.getLink(url='?message=By+URL').click()
            >>> browser.url
            'http://localhost/@@/testbrowser/navigate.html?message=By+URL'
            >>> browser.contents
            '...Message: <em>By URL</em>...'
        
        or its id:
        
            >>> browser.open('http://localhost/@@/testbrowser/navigate.html')
            >>> browser.contents
            '...<a href="navigate.html?message=By+Id"
            id="anchorid">By Anchor Id</a>...'
        
            >>> browser.getLink(id='anchorid').click()
            >>> browser.url
            'http://localhost/@@/testbrowser/navigate.html?message=By+Id'
            >>> browser.contents
            '...Message: <em>By Id</em>...'
        
        You thought we were done here? Not so quickly.  The `getLink` method also
        supports image maps, though not by specifying the coordinates, but using the
        area's id:
        
            >>> browser.open('http://localhost/@@/testbrowser/navigate.html')
            >>> link = browser.getLink(id='zope3')
            >>> link.tag
            'area'
            >>> link.click()
            >>> browser.url
            'http://localhost/@@/testbrowser/navigate.html?message=Zope+3+Name'
            >>> browser.contents
            '...Message: <em>Zope 3 Name</em>...'
        
        Getting a nonexistent link raises an exception.
        
            >>> browser.open('http://localhost/@@/testbrowser/navigate.html')
            >>> browser.getLink('This does not exist')
            Traceback (most recent call last):
            ...
            LinkNotFoundError
        
        A convenience method is provided to follow links; this uses the same
        arguments as `getLink`, but clicks on the link instead of returning the
        link object.
        
            >>> browser.open('http://localhost/@@/testbrowser/navigate.html')
            >>> browser.contents
            '...<a href="navigate.html?message=By+Link+Text">Link Text</a>...'
            >>> browser.follow('Link Text')
            >>> browser.url
            'http://localhost/@@/testbrowser/navigate.html?message=By+Link+Text'
            >>> browser.contents
            '...Message: <em>By Link Text</em>...'
        
            >>> browser.open('http://localhost/@@/testbrowser/navigate.html')
            >>> browser.follow(url='?message=By+URL')
            >>> browser.url
            'http://localhost/@@/testbrowser/navigate.html?message=By+URL'
            >>> browser.contents
            '...Message: <em>By URL</em>...'
        
            >>> browser.open('http://localhost/@@/testbrowser/navigate.html')
            >>> browser.follow(id='zope3')
            >>> browser.url
            'http://localhost/@@/testbrowser/navigate.html?message=Zope+3+Name'
            >>> browser.contents
            '...Message: <em>Zope 3 Name</em>...'
        
        Attempting to follow links that don't exist raises the same exception as
        asking for the link object:
        
            >>> browser.follow('This does not exist')
            Traceback (most recent call last):
            ...
            LinkNotFoundError
        
        
        Other Navigation
        ----------------
        
        Like in any normal browser, you can reload a page:
        
            >>> browser.open('http://localhost/@@/testbrowser/simple.html')
            >>> browser.url
            'http://localhost/@@/testbrowser/simple.html'
            >>> browser.reload()
            >>> browser.url
            'http://localhost/@@/testbrowser/simple.html'
        
        You can also go back:
        
            >>> browser.open('http://localhost/@@/testbrowser/notitle.html')
            >>> browser.url
            'http://localhost/@@/testbrowser/notitle.html'
            >>> browser.goBack()
            >>> browser.url
            'http://localhost/@@/testbrowser/simple.html'
        
        
        Controls
        --------
        
        One of the most important features of the browser is the ability to inspect
        and fill in values for the controls of input forms.  To do so, let's first open
        a page that has a bunch of controls:
        
            >>> browser.open('http://localhost/@@/testbrowser/controls.html')
        
        
        Obtaining a Control
        ~~~~~~~~~~~~~~~~~~~
        
        You look up browser controls with the 'getControl' method.  The default first
        argument is 'label', and looks up the form on the basis of any associated
        label.
        
            >>> control = browser.getControl('Text Control')
            >>> control
            <Control name='text-value' type='text'>
            >>> browser.getControl(label='Text Control') # equivalent
            <Control name='text-value' type='text'>
        
        If you request a control that doesn't exist, the code raises a LookupError:
        
            >>> browser.getControl('Does Not Exist')
            Traceback (most recent call last):
            ...
            LookupError: label 'Does Not Exist'
        
        If you request a control with an ambiguous lookup, the code raises an
        AmbiguityError.
        
            >>> browser.getControl('Ambiguous Control')
            Traceback (most recent call last):
            ...
            AmbiguityError: label 'Ambiguous Control' matches:
              <TextControl(ambiguous-control-name=First)>
              <TextControl(ambiguous-control-name=Second)>
        
        This is also true if an option in a control is ambiguous in relation to
        the control itself.
        
            >>> browser.getControl('Sub-control Ambiguity')
            Traceback (most recent call last):
            ...
            AmbiguityError: label 'Sub-control Ambiguity' matches:
              <SelectControl(ambiguous-subcontrol=[*, ambiguous])>
              <Item name='ambiguous' id=None contents='Sub-control Ambiguity Exemplified' value='ambiguous' label='Sub-control Ambiguity Exemplified'>
        
        Ambiguous controls may be specified using an index value.  We use the control's
        value attribute to show the two controls; this attribute is properly introduced
        below.
        
            >>> browser.getControl('Ambiguous Control', index=0)
            <Control name='ambiguous-control-name' type='text'>
            >>> browser.getControl('Ambiguous Control', index=0).value
            'First'
            >>> browser.getControl('Ambiguous Control', index=1).value
            'Second'
            >>> browser.getControl('Sub-control Ambiguity', index=0)
            <ListControl name='ambiguous-subcontrol' type='select'>
            >>> browser.getControl('Sub-control Ambiguity', index=1).optionValue
            'ambiguous'
        
        Label searches are against stripped, whitespace-normalized, no-tag versions of
        the text. Text applied to searches is also stripped and whitespace normalized.
        The search finds results if the text search finds the whole words of your
        text in a label.  Thus, for instance, a search for 'Add' will match the label
        'Add a Client' but not 'Address'.  Case is honored.
        
            >>> browser.getControl('Label Needs Whitespace Normalization')
            <Control name='label-needs-normalization' type='text'>
            >>> browser.getControl('label needs whitespace normalization')
            Traceback (most recent call last):
            ...
            LookupError: label 'label needs whitespace normalization'
            >>> browser.getControl(' Label  Needs Whitespace    ')
            <Control name='label-needs-normalization' type='text'>
            >>> browser.getControl('Whitespace')
            <Control name='label-needs-normalization' type='text'>
            >>> browser.getControl('hitespace')
            Traceback (most recent call last):
            ...
            LookupError: label 'hitespace'
            >>> browser.getControl('[non word characters should not confuse]')
            <Control name='non-word-characters' type='text'>
        
        Multiple labels can refer to the same control (simply because that is possible
        in the HTML 4.0 spec).
        
            >>> browser.getControl('Multiple labels really')
            <Control name='two-labels' type='text'>
            >>> browser.getControl('really are possible')
            <Control name='two-labels' type='text'>
            >>> browser.getControl('really') # OK: ambiguous labels, but not ambiguous control
            <Control name='two-labels' type='text'>
        
        A label can be connected with a control using the 'for' attribute and also by
        containing a control.
        
            >>> browser.getControl(
            ...     'Labels can be connected by containing their respective fields')
            <Control name='contained-in-label' type='text'>
        
        Get also accepts one other search argument, 'name'.  Only one of 'label' and
        'name' may be used at a time.  The 'name' keyword searches form field names.
        
            >>> browser.getControl(name='text-value')
            <Control name='text-value' type='text'>
            >>> browser.getControl(name='ambiguous-control-name')
            Traceback (most recent call last):
            ...
            AmbiguityError: name 'ambiguous-control-name' matches:
              <TextControl(ambiguous-control-name=First)>
              <TextControl(ambiguous-control-name=Second)>
            >>> browser.getControl(name='does-not-exist')
            Traceback (most recent call last):
            ...
            LookupError: name 'does-not-exist'
            >>> browser.getControl(name='ambiguous-control-name', index=1).value
            'Second'
        
        Combining 'label' and 'name' raises a ValueError, as does supplying neither of
        them.
        
            >>> browser.getControl(label='Ambiguous Control', name='ambiguous-control-name')
            Traceback (most recent call last):
            ...
            ValueError: Supply one and only one of "label" and "name" as arguments
            >>> browser.getControl()
            Traceback (most recent call last):
            ...
            ValueError: Supply one and only one of "label" and "name" as arguments
        
        Radio and checkbox fields are unusual in that their labels and names may point
        to different objects: names point to logical collections of radio buttons or
        checkboxes, but labels may only be used for individual choices within the
        logical collection.  This means that obtaining a radio button by label gets a
        different object than obtaining the radio collection by name.  Select options
        may also be searched by label.
        
            >>> browser.getControl(name='radio-value')
            <ListControl name='radio-value' type='radio'>
            >>> browser.getControl('Zwei')
            <ItemControl name='radio-value' type='radio' optionValue='2' selected=True>
            >>> browser.getControl('One')
            <ItemControl name='multi-checkbox-value' type='checkbox' optionValue='1' selected=True>
            >>> browser.getControl('Tres')
            <ItemControl name='single-select-value' type='select' optionValue='3' selected=False>
        
        Characteristics of controls and subcontrols are discussed below.
        
        
        Control Objects
        ~~~~~~~~~~~~~~~
        
        Controls provide IControl.
        
            >>> ctrl = browser.getControl('Text Control')
            >>> ctrl
            <Control name='text-value' type='text'>
            >>> verifyObject(interfaces.IControl, ctrl)
            True
        
        They have several useful attributes:
        
          - the name as which the control is known to the form:
        
            >>> ctrl.name
            'text-value'
        
          - the value of the control, which may also be set:
        
            >>> ctrl.value
            'Some Text'
            >>> ctrl.value = 'More Text'
            >>> ctrl.value
            'More Text'
        
          - the type of the control:
        
            >>> ctrl.type
            'text'
        
          - a flag describing whether the control is disabled:
        
            >>> ctrl.disabled
            False
        
          - and a flag to tell us whether the control can have multiple values:
        
            >>> ctrl.multiple
            False
        
        Additionally, controllers for select, radio, and checkbox provide IListControl.
        These fields have four other attributes and an additional method:
        
            >>> ctrl = browser.getControl('Multiple Select Control')
            >>> ctrl
            <ListControl name='multi-select-value' type='select'>
            >>> ctrl.disabled
            False
            >>> ctrl.multiple
            True
            >>> verifyObject(interfaces.IListControl, ctrl)
            True
        
          - 'options' lists all available value options.
        
            >>> ctrl.options
            ['1', '2', '3']
        
          - 'displayOptions' lists all available options by label.  The 'label'
            attribute on an option has precedence over its contents, which is why
            our last option is 'Third' in the display.
        
            >>> ctrl.displayOptions
            ['Un', 'Deux', 'Third']
        
          - 'displayValue' lets you get and set the displayed values of the control
            of the select box, rather than the actual values.
        
            >>> ctrl.value
            []
            >>> ctrl.displayValue
            []
            >>> ctrl.displayValue = ['Un', 'Deux']
            >>> ctrl.displayValue
            ['Un', 'Deux']
            >>> ctrl.value
            ['1', '2']
        
          - 'controls' gives you a list of the subcontrol objects in the control
            (subcontrols are discussed below).
        
            >>> ctrl.controls
            [<ItemControl name='multi-select-value' type='select' optionValue='1' selected=True>,
             <ItemControl name='multi-select-value' type='select' optionValue='2' selected=True>,
             <ItemControl name='multi-select-value' type='select' optionValue='3' selected=False>]
        
          - The 'getControl' method lets you get subcontrols by their label or their value.
        
            >>> ctrl.getControl('Un')
            <ItemControl name='multi-select-value' type='select' optionValue='1' selected=True>
            >>> ctrl.getControl('Deux')
            <ItemControl name='multi-select-value' type='select' optionValue='2' selected=True>
            >>> ctrl.getControl('Trois') # label attribute
            <ItemControl name='multi-select-value' type='select' optionValue='3' selected=False>
            >>> ctrl.getControl('Third') # contents
            <ItemControl name='multi-select-value' type='select' optionValue='3' selected=False>
            >>> browser.getControl('Third') # ambiguous in the browser, so useful
            Traceback (most recent call last):
            ...
            AmbiguityError: label 'Third' matches:
              <Item name='3' id=None contents='Tres' value='3' label='Third'>
              <Item name='3' id=None contents='Trois' value='3' label='Third'>
              <Item name='3' id='multi-checkbox-value-3' __label={'__text': 'Three\n        '} checked='checked' name='multi-checkbox-value' type='checkbox' id='multi-checkbox-value-3' value='3'>
              <Item name='3' id='radio-value-3' __label={'__text': ' Drei'} type='radio' name='radio-value' value='3' id='radio-value-3'>
        
        Finally, submit controls provide ISubmitControl, and image controls provide
        IImageSubmitControl, which extents ISubmitControl.  These both simply add a
        'click' method.  For image submit controls, you may also provide a coordinates
        argument, which is a tuple of (x, y).  These submit the forms, and are
        demonstrated below as we examine each control individually.
        
        
        ItemControl Objects
        ~~~~~~~~~~~~~~~~~~~
        
        As introduced briefly above, using labels to obtain elements of a logical
        radio button or checkbox collection returns item controls, which are parents.
        Manipulating the value of these controls affects the parent control.
        
            >>> browser.getControl(name='radio-value').value
            ['2']
            >>> browser.getControl('Zwei').optionValue # read-only.
            '2'
            >>> browser.getControl('Zwei').selected
            True
            >>> verifyObject(interfaces.IItemControl, browser.getControl('Zwei'))
            True
            >>> browser.getControl('Ein').selected = True
            >>> browser.getControl('Ein').selected
            True
            >>> browser.getControl('Zwei').selected
            False
            >>> browser.getControl(name='radio-value').value
            ['1']
            >>> browser.getControl('Ein').selected = False
            >>> browser.getControl(name='radio-value').value
            []
            >>> browser.getControl('Zwei').selected = True
        
        Checkbox collections behave similarly, as shown below.
        
        Controls with subcontrols--
        
        
        Various Controls
        ~~~~~~~~~~~~~~~~
        
        The various types of controls are demonstrated here.
        
          - Text Control
        
            The text control we already introduced above.
        
          - Password Control
        
            >>> ctrl = browser.getControl('Password Control')
            >>> ctrl
            <Control name='password-value' type='password'>
            >>> verifyObject(interfaces.IControl, ctrl)
            True
            >>> ctrl.value
            'Password'
            >>> ctrl.value = 'pass now'
            >>> ctrl.value
            'pass now'
            >>> ctrl.disabled
            False
            >>> ctrl.multiple
            False
        
          - Hidden Control
        
            >>> ctrl = browser.getControl(name='hidden-value')
            >>> ctrl
            <Control name='hidden-value' type='hidden'>
            >>> verifyObject(interfaces.IControl, ctrl)
            True
            >>> ctrl.value
            'Hidden'
            >>> ctrl.value = 'More Hidden'
            >>> ctrl.disabled
            False
            >>> ctrl.multiple
            False
        
          - Text Area Control
        
            >>> ctrl = browser.getControl('Text Area Control')
            >>> ctrl
            <Control name='textarea-value' type='textarea'>
            >>> verifyObject(interfaces.IControl, ctrl)
            True
            >>> ctrl.value
            '        Text inside\n        area!\n      '
            >>> ctrl.value = 'A lot of\n text.'
            >>> ctrl.disabled
            False
            >>> ctrl.multiple
            False
        
          - File Control
        
            File controls are used when a form has a file-upload field.
            To specify data, call the add_file method, passing:
        
            - A file-like object
        
            - a content type, and
        
            - a file name
        
            >>> ctrl = browser.getControl('File Control')
            >>> ctrl
            <Control name='file-value' type='file'>
            >>> verifyObject(interfaces.IControl, ctrl)
            True
            >>> ctrl.value is None
            True
            >>> import cStringIO
        
            >>> ctrl.add_file(cStringIO.StringIO('File contents'),
            ...               'text/plain', 'test.txt')
        
            The file control (like the other controls) also knows if it is disabled
            or if it can have multiple values.
        
            >>> ctrl.disabled
            False
            >>> ctrl.multiple
            False
        
          - Selection Control (Single-Valued)
        
            >>> ctrl = browser.getControl('Single Select Control')
            >>> ctrl
            <ListControl name='single-select-value' type='select'>
            >>> verifyObject(interfaces.IListControl, ctrl)
            True
            >>> ctrl.value
            ['1']
            >>> ctrl.value = ['2']
            >>> ctrl.disabled
            False
            >>> ctrl.multiple
            False
            >>> ctrl.options
            ['1', '2', '3']
            >>> ctrl.displayOptions
            ['Uno', 'Dos', 'Third']
            >>> ctrl.displayValue
            ['Dos']
            >>> ctrl.displayValue = ['Tres']
            >>> ctrl.displayValue
            ['Third']
            >>> ctrl.displayValue = ['Dos']
            >>> ctrl.displayValue
            ['Dos']
            >>> ctrl.displayValue = ['Third']
            >>> ctrl.displayValue
            ['Third']
            >>> ctrl.value
            ['3']
        
          - Selection Control (Multi-Valued)
        
            This was already demonstrated in the introduction to control objects above.
        
          - Checkbox Control (Single-Valued; Unvalued)
        
            >>> ctrl = browser.getControl(name='single-unvalued-checkbox-value')
            >>> ctrl
            <ListControl name='single-unvalued-checkbox-value' type='checkbox'>
            >>> verifyObject(interfaces.IListControl, ctrl)
            True
            >>> ctrl.value
            True
            >>> ctrl.value = False
            >>> ctrl.disabled
            False
            >>> ctrl.multiple
            True
            >>> ctrl.options
            [True]
            >>> ctrl.displayOptions
            ['Single Unvalued Checkbox']
            >>> ctrl.displayValue
            []
            >>> verifyObject(
            ...     interfaces.IItemControl,
            ...     browser.getControl('Single Unvalued Checkbox'))
            True
            >>> browser.getControl('Single Unvalued Checkbox').optionValue
            'on'
            >>> browser.getControl('Single Unvalued Checkbox').selected
            False
            >>> ctrl.displayValue = ['Single Unvalued Checkbox']
            >>> ctrl.displayValue
            ['Single Unvalued Checkbox']
            >>> browser.getControl('Single Unvalued Checkbox').selected
            True
            >>> browser.getControl('Single Unvalued Checkbox').selected = False
            >>> browser.getControl('Single Unvalued Checkbox').selected
            False
            >>> ctrl.displayValue
            []
            >>> browser.getControl(
            ...     name='single-disabled-unvalued-checkbox-value').disabled
            True
        
          - Checkbox Control (Single-Valued, Valued)
        
            >>> ctrl = browser.getControl(name='single-valued-checkbox-value')
            >>> ctrl
            <ListControl name='single-valued-checkbox-value' type='checkbox'>
            >>> verifyObject(interfaces.IListControl, ctrl)
            True
            >>> ctrl.value
            ['1']
            >>> ctrl.value = []
            >>> ctrl.disabled
            False
            >>> ctrl.multiple
            True
            >>> ctrl.options
            ['1']
            >>> ctrl.displayOptions
            ['Single Valued Checkbox']
            >>> ctrl.displayValue
            []
            >>> verifyObject(
            ...     interfaces.IItemControl,
            ...     browser.getControl('Single Valued Checkbox'))
            True
            >>> browser.getControl('Single Valued Checkbox').selected
            False
            >>> browser.getControl('Single Valued Checkbox').optionValue
            '1'
            >>> ctrl.displayValue = ['Single Valued Checkbox']
            >>> ctrl.displayValue
            ['Single Valued Checkbox']
            >>> browser.getControl('Single Valued Checkbox').selected
            True
            >>> browser.getControl('Single Valued Checkbox').selected = False
            >>> browser.getControl('Single Valued Checkbox').selected
            False
            >>> ctrl.displayValue
            []
        
          - Checkbox Control (Multi-Valued)
        
            >>> ctrl = browser.getControl(name='multi-checkbox-value')
            >>> ctrl
            <ListControl name='multi-checkbox-value' type='checkbox'>
            >>> verifyObject(interfaces.IListControl, ctrl)
            True
            >>> ctrl.value
            ['1', '3']
            >>> ctrl.value = ['1', '2']
            >>> ctrl.disabled
            False
            >>> ctrl.multiple
            True
            >>> ctrl.options
            ['1', '2', '3']
            >>> ctrl.displayOptions
            ['One', 'Two', 'Three']
            >>> ctrl.displayValue
            ['One', 'Two']
            >>> ctrl.displayValue = ['Two']
            >>> ctrl.value
            ['2']
            >>> browser.getControl('Two').optionValue
            '2'
            >>> browser.getControl('Two').selected
            True
            >>> verifyObject(interfaces.IItemControl, browser.getControl('Two'))
            True
            >>> browser.getControl('Three').selected = True
            >>> browser.getControl('Three').selected
            True
            >>> browser.getControl('Two').selected
            True
            >>> ctrl.value
            ['2', '3']
            >>> browser.getControl('Two').selected = False
            >>> ctrl.value
            ['3']
            >>> browser.getControl('Three').selected = False
            >>> ctrl.value
            []
        
          - Radio Control
        
            This is how you get a radio button based control:
        
            >>> ctrl = browser.getControl(name='radio-value')
        
            This shows the existing value of the control, as it was in the
            HTML received from the server:
        
            >>> ctrl.value
            ['2']
        
            We can then unselect it:
        
            >>> ctrl.value = []
            >>> ctrl.value
            []
        
            We can also reselect it:
        
            >>> ctrl.value = ['2']
            >>> ctrl.value
            ['2']
        
            displayValue shows the text the user would see next to the
            control:
        
            >>> ctrl.displayValue
            ['Zwei']
        
            This is just unit testing:
        
            >>> ctrl
            <ListControl name='radio-value' type='radio'>
            >>> verifyObject(interfaces.IListControl, ctrl)
            True
            >>> ctrl.disabled
            False
            >>> ctrl.multiple
            False
            >>> ctrl.options
            ['1', '2', '3']
            >>> ctrl.displayOptions
            ['Ein', 'Zwei', 'Drei']
            >>> ctrl.displayValue = ['Ein']
            >>> ctrl.value
            ['1']
            >>> ctrl.displayValue
            ['Ein']
        
            The radio control subcontrols were illustrated above.
        
          - Image Control
        
            >>> ctrl = browser.getControl(name='image-value')
            >>> ctrl
            <ImageControl name='image-value' type='image'>
            >>> verifyObject(interfaces.IImageSubmitControl, ctrl)
            True
            >>> ctrl.value
            ''
            >>> ctrl.disabled
            False
            >>> ctrl.multiple
            False
        
          - Submit Control
        
            >>> ctrl = browser.getControl(name='submit-value')
            >>> ctrl
            <SubmitControl name='submit-value' type='submit'>
            >>> browser.getControl('Submit This') # value of submit button is a label
            <SubmitControl name='submit-value' type='submit'>
            >>> browser.getControl('Standard Submit Control') # label tag is legal
            <SubmitControl name='submit-value' type='submit'>
            >>> browser.getControl('Submit') # multiple labels, but same control
            <SubmitControl name='submit-value' type='submit'>
            >>> verifyObject(interfaces.ISubmitControl, ctrl)
            True
            >>> ctrl.value
            'Submit This'
            >>> ctrl.disabled
            False
            >>> ctrl.multiple
            False
        
        
        Using Submitting Controls
        ~~~~~~~~~~~~~~~~~~~~~~~~~
        
        Both the submit and image type should be clickable and submit the form:
        
            >>> browser.getControl('Text Control').value = 'Other Text'
            >>> browser.getControl('Submit').click()
            >>> print browser.contents
            <html>
            ...
            <em>Other Text</em>
            <input type="text" name="text-value" id="text-value" value="Some Text" />
            ...
            <em>Submit This</em>
            <input type="submit" name="submit-value" id="submit-value" value="Submit This" />
            ...
            </html>
        
        Note that if you click a submit object after the associated page has expired,
        you will get an error.
        
            >>> browser.open('http://localhost/@@/testbrowser/controls.html')
            >>> ctrl = browser.getControl('Submit')
            >>> ctrl.click()
            >>> ctrl.click()
            Traceback (most recent call last):
            ...
            ExpiredError
        
        All the above also holds true for the image control:
        
            >>> browser.open('http://localhost/@@/testbrowser/controls.html')
            >>> browser.getControl('Text Control').value = 'Other Text'
            >>> browser.getControl(name='image-value').click()
            >>> print browser.contents
            <html>
            ...
            <em>Other Text</em>
            <input type="text" name="text-value" id="text-value" value="Some Text" />
            ...
            <em>1</em>
            <em>1</em>
            <input type="image" name="image-value" id="image-value"
                   src="zope3logo.gif" />
            ...
            </html>
        
            >>> browser.open('http://localhost/@@/testbrowser/controls.html')
            >>> ctrl = browser.getControl(name='image-value')
            >>> ctrl.click()
            >>> ctrl.click()
            Traceback (most recent call last):
            ...
            ExpiredError
        
        But when sending an image, you can also specify the coordinate you clicked:
        
            >>> browser.open('http://localhost/@@/testbrowser/controls.html')
            >>> browser.getControl(name='image-value').click((50,25))
            >>> print browser.contents
            <html>
            ...
            <em>50</em>
            <em>25</em>
            <input type="image" name="image-value" id="image-value"
                   src="zope3logo.gif" />
            ...
            </html>
        
        
        Forms
        -----
        
        Because pages can have multiple forms with like-named controls, it is sometimes
        necessary to access forms by name or id.  The browser's `forms` attribute can
        be used to do so.  The key value is the form's name or id.  If more than one
        form has the same name or id, the first one will be returned.
        
            >>> browser.open('http://localhost/@@/testbrowser/forms.html')
            >>> form = browser.getForm(name='one')
        
        Form instances conform to the IForm interface.
        
            >>> verifyObject(interfaces.IForm, form)
            True
        
        The form exposes several attributes related to forms:
        
          - The name of the form:
        
            >>> form.name
            'one'
        
          - The id of the form:
        
            >>> form.id
            '1'
        
          - The action (target URL) when the form is submitted:
        
            >>> form.action
            'http://localhost/@@/testbrowser/forms.html'
        
          - The method (HTTP verb) used to transmit the form data:
        
            >>> form.method
            'GET'
        
        Besides those attributes, you have also a couple of methods.  Like for the
        browser, you can get control objects, but limited to the current form...
        
            >>> form.getControl(name='text-value')
            <Control name='text-value' type='text'>
        
        ...and submit the form.
        
            >>> form.submit('Submit')
            >>> print browser.contents
            <html>
            ...
            <em>First Text</em>
            ...
            </html>
        
        Submitting also works without specifying a control, as shown below, which is
        it's primary reason for existing in competition with the control submission
        discussed above.
        
        Now let me show you briefly that looking up forms is sometimes important.  In
        the `forms.html` template, we have four forms all having a text control named
        `text-value`.  Now, if I use the browser's `get` method,
        
            >>> browser.getControl(name='text-value')
            Traceback (most recent call last):
            ...
            AmbiguityError: name 'text-value' matches:
              <TextControl(text-value=First Text)>
              <TextControl(text-value=Second Text)>
              <TextControl(text-value=Third Text)>
              <TextControl(text-value=Fourth Text)>
            >>> browser.getControl('Text Control')
            Traceback (most recent call last):
            ...
            AmbiguityError: label 'Text Control' matches:
              <TextControl(text-value=Third Text)>
              <TextControl(text-value=Fourth Text)>
        
        I'll always get an ambiguous form field.  I can use the index argument, or
        with the `getForm` method I can disambiguate by searching only within a given
        form:
        
            >>> form = browser.getForm('2')
            >>> form.getControl(name='text-value').value
            'Second Text'
            >>> form.submit('Submit')
            >>> browser.contents
            '...<em>Second Text</em>...'
            >>> form = browser.getForm('2')
            >>> form.getControl('Submit').click()
            >>> browser.contents
            '...<em>Second Text</em>...'
            >>> browser.getForm('3').getControl('Text Control').value
            'Third Text'
        
        The last form on the page does not have a name, an id, or a submit button.
        Working with it is still easy, thanks to a index attribute that guarantees
        order.  (Forms without submit buttons are sometimes useful for JavaScript.)
        
            >>> form = browser.getForm(index=3)
            >>> form.submit()
            >>> browser.contents
            '...<em>Fourth Text</em>...<em>Submitted without the submit button.</em>...'
        
        If a form is requested that does not exists, an exception will be raised.
        
            >>> form = browser.getForm('does-not-exist')
            Traceback (most recent call last):
            LookupError
        
        If the HTML page contains only one form, no arguments to `getForm` are
        needed:
        
            >>> oneform = Browser(wsgi_app=wsgi_app)
            >>> oneform.open('http://localhost/@@/testbrowser/oneform.html')
            >>> form = oneform.getForm()
        
        If the HTML page contains more than one form, `index` is needed to
        disambiguate if no other arguments are provided:
        
            >>> browser.getForm()
            Traceback (most recent call last):
            ValueError: if no other arguments are given, index is required.
        
        
        Submitting a posts body directly
        --------------------------------
        
        In addition to the open method, zope.testbrowser.testing.Browser has a ``post``
        method that allows a request body to be supplied.  This method is particularly
        helpful when testing Ajax methods.
        
        Let's visit a page that echos some interesting values from it's request:
        
            >>> browser.open('http://localhost/echo.html')
            >>> print browser.contents
            HTTP_ACCEPT_LANGUAGE: en-US
            HTTP_CONNECTION: close
            HTTP_HOST: localhost
            HTTP_USER_AGENT: Python-urllib/2.4
            PATH_INFO: /echo.html
            REQUEST_METHOD: GET
            Body: ''
        
        Now, we'll try a post.  The post method takes a URL, a data string,
        and an optional content type.  If we just pass a string, then
        a URL-encoded query string is assumed:
        
            >>> browser.post('http://localhost/echo.html', 'x=1&y=2')
            >>> print browser.contents
            CONTENT_LENGTH: 7
            CONTENT_TYPE: application/x-www-form-urlencoded
            HTTP_ACCEPT_LANGUAGE: en-US
            HTTP_CONNECTION: close
            HTTP_HOST: localhost
            HTTP_USER_AGENT: Python-urllib/2.4
            PATH_INFO: /echo.html
            REQUEST_METHOD: POST
            x: 1
            y: 2
            Body: ''
        
        The body is empty because it is consumed to get form data.
        
        We can pass a content-type explicitly:
        
            >>> browser.post('http://localhost/echo.html',
            ...              '{"x":1,"y":2}', 'application/x-javascript')
            >>> print browser.contents
            CONTENT_LENGTH: 13
            CONTENT_TYPE: application/x-javascript
            HTTP_ACCEPT_LANGUAGE: en-US
            HTTP_CONNECTION: close
            HTTP_HOST: localhost
            HTTP_USER_AGENT: Python-urllib/2.4
            PATH_INFO: /echo.html
            REQUEST_METHOD: POST
            Body: '{"x":1,"y":2}'
        
        Here, the body is left in place because it isn't form data.
        
        
        Performance Testing
        -------------------
        
        Browser objects keep up with how much time each request takes.  This can be
        used to ensure a particular request's performance is within a tolerable range.
        Be very careful using raw seconds, cross-machine differences can be huge,
        pystones is usually a better choice.
        
            >>> browser.open('http://localhost/@@/testbrowser/simple.html')
            >>> browser.lastRequestSeconds < 10 # really big number for safety
            True
            >>> browser.lastRequestPystones < 10000 # really big number for safety
            True
        
        
        Handling Errors
        ---------------
        
        Often WSGI middleware or the application itself gracefully handle application
        errors, such as invalid URLs:
        
            >>> browser.open('http://localhost/invalid')
            Traceback (most recent call last):
            ...
            HTTPError: HTTP Error 404: Not Found
        
        Note that the above error was thrown by ``mechanize`` and not by the
        application.  For debugging purposes, however, it can be very useful to see the
        original exception caused by the application.  In those cases you can set the
        ``handleErrors`` property of the browser to ``False``.  It is defaulted to
        ``True``:
        
            >>> browser.handleErrors
            True
        
        So when we tell the application not to handle the errors,
        
            >>> browser.handleErrors = False
        
        we get a different, internal error from the application:
        
            >>> browser.open('http://localhost/invalid')
            Traceback (most recent call last):
            ...
            NotFound: /invalid
        
        NB: Setting the handleErrors attribute to False will only change anything if
            the WSGI application obeys the wsgi.handleErrors or paste.throw_errors
            WSGI environment variables. i.e. it does not catch and handle the original
            exception when these are set appropriately.
        
        When the testbrowser is raising HttpErrors, the errors still hit the test.
        Sometimes we don't want that to happen, in situations where there are edge
        cases that will cause the error to be predictably but infrequently raised.
        Time is a primary cause of this.
        
        To get around this, one can set the raiseHttpErrors to False.
        
            >>> browser.handleErrors = True
            >>> browser.raiseHttpErrors = False
        
        This will cause HttpErrors not to propagate.
        
            >>> browser.open('http://localhost/invalid')
        
        The headers are still there, though.
        
            >>> '404 Not Found' in str(browser.headers)
            True
        
        If we don't handle the errors, and allow internal ones to propagate, however,
        this flag doesn't affect things.
        
            >>> browser.handleErrors = False
            >>> browser.open('http://localhost/invalid')
            Traceback (most recent call last):
            ...
            NotFound: /invalid
        
            >>> browser.raiseHttpErrors = True
        
        
        Hand-Holding
        ------------
        
        Instances of the various objects ensure that users don't set incorrect
        instance attributes accidentally.
        
            >>> browser.nonexistant = None
            Traceback (most recent call last):
            ...
            AttributeError: 'Browser' object has no attribute 'nonexistant'
        
            >>> form.nonexistant = None
            Traceback (most recent call last):
            ...
            AttributeError: 'Form' object has no attribute 'nonexistant'
        
            >>> control.nonexistant = None
            Traceback (most recent call last):
            ...
            AttributeError: 'Control' object has no attribute 'nonexistant'
        
            >>> link.nonexistant = None
            Traceback (most recent call last):
            ...
            AttributeError: 'Link' object has no attribute 'nonexistant'
        
        
        HTTPS support
        -------------
        
        Depending on the scheme of the request the variable wsgi.url_scheme will be set
        correctly on the request:
        
            >>> browser.open('http://localhost/echo_one.html?var=wsgi.url_scheme')
            >>> print browser.contents
            'http'
        
            >>> browser.open('https://localhost/echo_one.html?var=wsgi.url_scheme')
            >>> print browser.contents
            'https'
        
        see http://www.python.org/dev/peps/pep-3333/ for details.
        
        
        =======
        CHANGES
        =======
        
        4.0.2 (2011-05-25)
        ------------------
        
        - Remove test dependency on zope.pagetemplate.
        
        
        4.0.1 (2011-05-04)
        ------------------
        
        - Added a hint in documentation how to use ``zope.testbrowser.wsgi.Browser``
          to test a Zope 2/Zope 3/Bluebream WSGI application.
        
        4.0.0 (2011-03-14)
        ------------------
        
        - LP #721252: AmbiguityError now shows all matching controls.
        
        - Integrate with WebTest. ``zope.testbrowser.wsgi.Browser`` is a
          ``Browser`` implementation that uses ``webtest.TestApp`` to drive a WSGI
          application. This this replaces the wsgi_intercept support added in 3.11.
        
        - Re-write the test application as a pure WSGI application using WebOb. Run the
          existing tests using the WebTest based Browser
        
        - Move zope.app.testing based Browser into ``zope.app.testing`` (leaving
          backwards compatibility imports in-place). Released in ``zope.app.testing``
          3.9.0.
        
        
        3.11.1 (2011-01-24)
        -------------------
        
        - Fixing brown bag release 3.11.0.
        
        
        3.11.0 (2011-01-24)
        -------------------
        
        - Added `wsgi_intercept` support (came from ``zope.app.wsgi.testlayer``).
        
        
        3.10.4 (2011-01-14)
        -------------------
        
        - Move the over-the-wire.txt doctest out of the TestBrowserLayer as it doesn't
          need or use it.
        
        - Fix test compatibility with zope.app.testing 3.8.1.
        
        3.10.3 (2010-10-15)
        -------------------
        
        - Fixed backwards compatibility with ``zope.app.wsgi.testlayer``.
        
        
        3.10.2 (2010-10-15)
        -------------------
        
        - Fixed Python 2.7 compatibility in Browser.handleErrors.
        
        
        3.10.1 (2010-09-21)
        -------------------
        
        - Fixed a bug that caused the ``Browser`` to keep it's previous ``contents``
          The places are:
          - Link.click()
          - SubmitControl.click()
          - ImageControl.click()
          - Form.submit()
        
        - Also adjusted exception messages at the above places to match
          pre version 3.4.1 messages.
        
        
        3.10.0 (2010-09-14)
        -------------------
        
        - LP #98437: use mechanize's built-in ``submit()`` to submit forms, allowing
          mechanize to set the "Referer:" (sic) header appropriately.
        
        - Fixed tests to run with ``zope.app.testing`` 3.8 and above.
        
        
        3.9.0 (2010-05-17)
        ------------------
        
        - LP #568806: Update dependency ``mechanize >= 0.2.0``, which now includes
          the ``ClientForm`` APIs.  Remove use of ``urllib2`` APIs (incompatible
          with ``mechanize 0.2.0``) in favor of ``mechanize`` equivalents.
          Thanks to John J. Lee for the patch.
        
        - Use stdlib ``doctest`` module, instead of ``zope.testing.doctest``.
        
        - **Caution:** This version is no longer fully compatible with Python 2.4:
          ``handleErrors = False`` no longer works.
        
        
        3.8.1 (2010-04-19)
        ------------------
        
        - Pinned dependency on mechanize to prevent use of the upcoming
          0.2.0 release before we have time to adjust to its API changes.
        
        - LP #98396: testbrowser resolves relative URLs incorrectly.
        
        
        3.8.0 (2010-03-05)
        ------------------
        
        - Added ``follow`` convenience method which gets and follows a link.
        
        
        3.7.0 (2009-12-17)
        ------------------
        
        - Moved zope.app.testing dependency into the scope of the PublisherConnection
          class. Zope2 specifies its own PublisherConnection which isn't dependent on
          zope.app.testing.
        
        - Fixed LP #419119: return None when the browser has no contents instead of
          raising an exception.
        
        
        3.7.0a1 (2009-08-29)
        --------------------
        
        - Remove dependency on zope.app.publisher in favor of zope.browserpage,
          zope.browserresource and zope.ptresource.
        
        - Remove dependencies on zope.app.principalannotation and zope.securitypolicy
          by using the simple PermissiveSecurityPolicy. We aren't testing security
          in our tests.
        
        - Replaced the testing dependency on zope.app.zcmlfiles with explicit
          dependencies of a minimal set of packages.
        
        - Remove unneeded zope.app.authentication from ftesting.zcml.
        
        - Test dependency on zope.securitypolicy instead of its app variant.
        
        
        3.6.0a2 (2009-01-31)
        --------------------
        
        - Test dependency on zope.site.folder instead of zope.app.folder.
        
        - Remove useless test dependency in zope.app.component.
        
        
        3.6.0a1 (2009-01-08)
        --------------------
        
        - Author e-mail to zope-dev rather than zope3-dev.
        
        - New lines are no longer stripped in XML and HTML code contained in a
          textarea; fix requires ClientForm >= 0.2.10 (LP #268139).
        
        - Added ``cookies`` attribute to browser for easy manipulation of browser
          cookies.  See brief example in main documentation, plus new ``cookies.txt``
          documentation.
        
        
        3.5.1 (2008-10-10)
        ------------------
        
        - Provide a work around for a mechanize/urllib2 bug on Python 2.6
          missing 'timeout' attribute on 'Request' base class.
        
        - Provide a work around for a mechanize/urllib2 bug in creating request
          objects that won't handle fragment URLs correctly.
        
        
        3.5.0 (2008-03-30)
        ------------------
        
        - Added a zope.testbrowser.testing.Browser.post method that allows
          tests to supply a body and a content type.  This is handy for
          testing Ajax requests with non-form input (e.g. JSON).
        
        - Remove vendor import of mechanize.
        
        - Fix bug that caused HTTP exception tracebacks to differ between version 3.4.0
          and 3.4.1.
        
        - Workaround for bug in Python Cookie.SimpleCookie when handling unicode
          strings.
        
        - Fix bug introduced in 3.4.1 that created incompatible tracebacks in doctests.
          This necessitated adding a patched mechanize to the source tree; patches have
          been sent to the mechanize project.
        
        - Fix https://bugs.launchpad.net/bugs/149517 by adding zope.interface and
          zope.schema as real dependencies
        
        - Fix browser.getLink documentation that was not updated since the last API
          modification.
        
        - Move tests for fixed bugs to a separate file.
        
        - Removed non-functional and undocumented code intended to help test servers
          using virtual hosting.
        
        
        3.4.2 (2007-10-31)
        ------------------
        
        - Resolve ``ZopeSecurityPolicy`` deprecation warning.
        
        
        3.4.1 (2007-09-01)
        ------------------
        
        * Updated to mechanize 0.1.7b and ClientForm 0.2.7.  These are now
          pulled in via egg dependencies.
        
        * ``zope.testbrowser`` now works on Python 2.5.
        
        
        3.4.0 (2007-06-04)
        ------------------
        
        * Added the ability to suppress raising exceptions on HTTP errors
          (``raiseHttpErrors`` attribute).
        
        * Made the tests more resilient to HTTP header formatting changes with
          the REnormalizer.
        
        
        3.4.0a1 (2007-04-22)
        --------------------
        
        Initial release as a separate project, corresponds to zope.testbrowser
        from Zope 3.4.0a1
        
Platform: UNKNOWN
Classifier: Environment :: Web Environment
Classifier: Intended Audience :: Developers
Classifier: License :: OSI Approved :: Zope Public License
Classifier: Programming Language :: Python
Classifier: Topic :: Software Development :: Testing
Classifier: Topic :: Internet :: WWW/HTTP