My favorites | Sign in
Project Home Downloads Wiki Issues Source
Checkout   Browse   Changes    
 
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
1728
1729
1730
1731
1732
1733
1734
1735
1736
1737
1738
1739
1740
1741
1742
1743
1744
1745
1746
1747
1748
1749
1750
1751
1752
1753
1754
1755
1756
1757
1758
1759
1760
1761
1762
1763
1764
1765
1766
1767
1768
1769
1770
1771
1772
1773
1774
1775
1776
1777
1778
1779
1780
1781
1782
1783
1784
1785
1786
1787
1788
1789
1790
1791
1792
1793
1794
1795
1796
1797
1798
1799
1800
1801
1802
1803
1804
1805
1806
1807
1808
1809
1810
1811
1812
1813
1814
1815
1816
1817
1818
1819
1820
1821
1822
1823
1824
1825
1826
1827
1828
1829
1830
1831
1832
1833
1834
1835
1836
1837
1838
1839
1840
1841
1842
1843
1844
1845
1846
1847
1848
1849
1850
1851
1852
1853
1854
1855
1856
1857
1858
1859
1860
1861
1862
1863
1864
1865
1866
1867
1868
1869
1870
1871
1872
1873
1874
1875
1876
1877
1878
1879
1880
1881
1882
1883
1884
1885
1886
1887
1888
1889
1890
1891
1892
1893
1894
1895
1896
1897
1898
1899
1900
1901
1902
1903
1904
1905
1906
1907
1908
1909
1910
1911
1912
1913
1914
1915
1916
1917
1918
1919
1920
1921
1922
1923
1924
1925
1926
1927
1928
1929
1930
1931
1932
1933
1934
1935
1936
1937
1938
1939
1940
1941
1942
1943
1944
1945
1946
1947
1948
1949
1950
1951
1952
1953
1954
1955
1956
1957
1958
1959
1960
1961
1962
1963
1964
1965
1966
1967
1968
1969
1970
1971
1972
1973
1974
1975
1976
1977
1978
1979
1980
1981
1982
1983
1984
1985
1986
1987
1988
1989
1990
1991
1992
1993
1994
1995
1996
1997
1998
1999
2000
2001
2002
2003
2004
2005
2006
2007
2008
2009
2010
2011
2012
2013
2014
2015
2016
2017
2018
2019
2020
2021
2022
2023
2024
2025
2026
2027
2028
2029
2030
2031
2032
2033
2034
2035
2036
2037
2038
2039
2040
2041
2042
2043
2044
2045
2046
2047
2048
2049
2050
2051
2052
2053
2054
2055
2056
2057
2058
2059
2060
2061
2062
2063
2064
2065
2066
2067
2068
2069
2070
2071
2072
2073
2074
2075
2076
2077
2078
2079
2080
2081
2082
2083
2084
2085
2086
2087
2088
2089
2090
2091
2092
2093
2094
2095
2096
2097
2098
2099
2100
2101
2102
2103
2104
2105
2106
2107
2108
2109
2110
2111
2112
2113
2114
2115
2116
2117
2118
2119
2120
2121
2122
2123
2124
2125
2126
2127
2128
2129
2130
2131
2132
2133
2134
2135
2136
2137
2138
2139
2140
2141
2142
2143
2144
2145
2146
2147
2148
2149
2150
2151
2152
2153
2154
2155
2156
2157
2158
2159
2160
2161
2162
2163
2164
2165
2166
2167
2168
2169
2170
2171
2172
2173
2174
2175
2176
2177
2178
2179
2180
2181
2182
2183
2184
2185
2186
2187
2188
2189
2190
2191
2192
2193
2194
2195
2196
2197
2198
2199
2200
2201
2202
2203
# Natural Language Toolkit: Corpus & Model Downloader
#
# Copyright (C) 2001-2011 NLTK Project
# Author: Edward Loper <edloper@gradient.cis.upenn.edu>
# URL: <http://www.nltk.org/>
# For license information, see LICENSE.TXT

"""
The NLTK corpus and module downloader. This module defines several
interfaces which can be used to download corpora, models, and other
data packages that can be used with NLTK.

Downloading Packages
====================
If called with no arguments, L{download() <Downloader.download>}
function will display an interactive interface which can be used to
download and install new packages. If Tkinter is available, then a
graphical interface will be shown; otherwise, a simple text interface
will be provided.

Individual packages can be downloaded by calling the C{download()}
function with a single argument, giving the package identifier for the
package that should be downloaded:

>>> download('treebank') # doctest: +SKIP
[nltk_data] Downloading package 'treebank'...
[nltk_data] Unzipping corpora/treebank.zip.

NLTK also provides a number of \"package collections\", consisting of
a group of related packages. To download all packages in a
colleciton, simply call C{download()} with the collection's
identifier:

>>> download('all-corpora') # doctest: +SKIP
[nltk_data] Downloading package 'abc'...
[nltk_data] Unzipping corpora/abc.zip.
[nltk_data] Downloading package 'alpino'...
[nltk_data] Unzipping corpora/alpino.zip.
...
[nltk_data] Downloading package 'words'...
[nltk_data] Unzipping corpora/words.zip.

Download Directory
==================
By default, packages are installed in either a system-wide directory
(if Python has sufficient access to write to it); or in the current
user's home directory. However, the C{download_dir} argument may be
used to specify a different installation target, if desired.

See L{Downloader.default_download_dir()} for more a detailed
description of how the default download directory is chosen.

NLTK Download Server
====================
Before downloading any packages, the corpus and module downloader
contacts the NLTK download server, to retrieve an index file
describing the available packages. By default, this index file is
loaded from C{<http://nltk.googlecode.com/svn/trunk/nltk_data/index.xml>}.
If necessary, it is possible to create a new L{Downloader} object,
specifying a different URL for the package index file.

Usage::

python nltk/downloader.py [-d DATADIR] [-q] [-f] [-k] PACKAGE_IDS

or with py2.5+:

python -m nltk.downloader [-d DATADIR] [-q] [-f] [-k] PACKAGE_IDS
"""
#----------------------------------------------------------------------
"""

0 1 2 3
[label][----][label][----]
[column ][column ]

Notes
=====
Handling data files.. Some questions:

* Should the data files be kept zipped or unzipped? I say zipped.

* Should the data files be kept in svn at all? Advantages: history;
automatic version numbers; 'svn up' could be used rather than the
downloader to update the corpora. Disadvantages: they're big,
which makes working from svn a bit of a pain. And we're planning
to potentially make them much bigger. I don't think we want
people to have to download 400mb corpora just to use nltk from
svn.

* Compromise: keep the data files in trunk/data rather than in
trunk/nltk. That way you can check them out in svn if you want
to; but you don't need to, and you can use the downloader instead.

* Also: keep models in mind. When we change the code, we'd
potentially like the models to get updated. This could require a
little thought.

* So.. let's assume we have a trunk/data directory, containing a bunch
of packages. The packages should be kept as zip files, because we
really shouldn't be editing them much (well -- we may edit models
more, but they tend to be binary-ish files anyway, where diffs
aren't that helpful). So we'll have trunk/data, with a bunch of
files like abc.zip and treebank.zip and propbank.zip. For each
package we could also have eg treebank.xml and propbank.xml,
describing the contents of the package (name, copyright, license,
etc). Collections would also have .xml files. Finally, we would
pull all these together to form a single index.xml file. Some
directory structure wouldn't hurt. So how about::

/trunk/data/ ....................... root of data svn
index.xml ........................ main index file
src/ ............................. python scripts
packages/ ........................ dir for packages
corpora/ ....................... zip & xml files for corpora
grammars/ ...................... zip & xml files for grammars
taggers/ ....................... zip & xml files for taggers
tokenizers/ .................... zip & xml files for tokenizers
etc.
collections/ ..................... xml files for collections

Where the root (/trunk/data) would contain a makefile; and src/
would contain a script to update the info.xml file. It could also
contain scripts to rebuild some of the various model files. The
script that builds index.xml should probably check that each zip
file expands entirely into a single subdir, whose name matches the
package's uid.

Changes I need to make:
- in index: change "size" to "filesize" or "compressed-size"
- in index: add "unzipped-size"
- when checking status: check both compressed & uncompressed size.
uncompressed size is important to make sure we detect a problem
if something got partially unzipped. define new status values
to differentiate stale vs corrupt vs corruptly-uncompressed??
(we shouldn't need to re-download the file if the zip file is ok
but it didn't get uncompressed fully.)
- add other fields to the index: author, license, copyright, contact,
etc.

the current grammars/ package would become a single new package (eg
toy-grammars or book-grammars).

xml file should have:
- authorship info
- license info
- copyright info
- contact info
- info about what type of data/annotation it contains?
- recommended corpus reader?

collections can contain other collections. they can also contain
multiple package types (corpora & models). Have a single 'basics'
package that includes everything we talk about in the book?

n.b.: there will have to be a fallback to the punkt tokenizer, in case
they didn't download that model.

default: unzip or not?

"""
import time, re, os, zipfile, sys, textwrap, threading, itertools
from cStringIO import StringIO
try:
from hashlib import md5
except:
from md5 import md5

try:
TKINTER = True
from Tkinter import *
from tkMessageBox import *
from nltk.draw.table import Table
from nltk.draw import ShowText
except:
TKINTER = False
TclError = ValueError

from nltk.etree import ElementTree
import nltk
urllib2 = nltk.internals.import_from_stdlib('urllib2')


######################################################################
# Directory entry objects (from the data server's index file)
######################################################################

class Package(object):
"""
A directory entry for a downloadable package. These entries are
extracted from the XML index file that is downloaded by
L{Downloader}. Each package consists of a single file; but if
that file is a zip file, then it can be automatically decompressed
when the package is installed.
"""
def __init__(self, id, url, name=None, subdir='',
size=None, unzipped_size=None,
checksum=None, svn_revision=None,
copyright='Unknown', contact='Unknown',
license='Unknown', author='Unknown',
unzip=True,
**kw):
self.id = id
"""A unique identifier for this package."""

self.name = name or id
"""A string name for this package."""

self.subdir = subdir
"""The subdirectory where this package should be installed.
E.g., C{'corpora'} or C{'taggers'}."""

self.url = url
"""A URL that can be used to download this package's file."""

self.size = int(size)
"""The filesize (in bytes) of the package file."""

self.unzipped_size = int(unzipped_size)
"""The total filesize of the files contained in the package's
zipfile."""

self.checksum = checksum
"""The MD-5 checksum of the package file."""

self.svn_revision = svn_revision
"""A subversion revision number for this package."""

self.copyright = copyright
"""Copyright holder for this package."""

self.contact = contact
"""Name & email of the person who should be contacted with
questions about this package."""

self.license = license
"""License information for this package."""

self.author = author
"""Author of this package."""

ext = os.path.splitext(url.split('/')[-1])[1]
self.filename = os.path.join(subdir, id+ext)
"""The filename that should be used for this package's file. It
is formed by joining C{self.subdir} with C{self.id}, and
using the same extension as C{url}."""

self.unzip = bool(int(unzip)) # '0' or '1'
"""A flag indicating whether this corpus should be unzipped by
default."""

# Include any other attributes provided by the XML file.
self.__dict__.update(kw)

@staticmethod
def fromxml(xml):
if isinstance(xml, basestring):
xml = ElementTree.parse(xml)
return Package(**xml.attrib)

def __repr__(self):
return '<Package %s>' % self.id

class Collection(object):
"""
A directory entry for a collection of downloadable packages.
These entries are extracted from the XML index file that is
downloaded by L{Downloader}.
"""
def __init__(self, id, children, name=None, **kw):
self.id = id
"""A unique identifier for this collection."""

self.name = name or id
"""A string name for this collection."""

self.children = children
"""A list of the L{Collections} or L{Packages} directly
contained by this collection."""

self.packages = None
"""A list of L{Packages} contained by this collection or any
collections it recursively contains."""

# Include any other attributes provided by the XML file.
self.__dict__.update(kw)

@staticmethod
def fromxml(xml):
if isinstance(xml, basestring):
xml = ElementTree.parse(xml)
children = [child.get('ref') for child in xml.findall('item')]
return Collection(children=children, **xml.attrib)

def __repr__(self):
return '<Collection %s>' % self.id

######################################################################
# Message Passing Objects
######################################################################

class DownloaderMessage(object):
"""A status message object, used by L{incr_download} to
communicate its progress."""
class StartCollectionMessage(DownloaderMessage):
"""Data server has started working on a collection of packages."""
def __init__(self, collection): self.collection = collection
class FinishCollectionMessage(DownloaderMessage):
"""Data server has finished working on a collection of packages."""
def __init__(self, collection): self.collection = collection
class StartPackageMessage(DownloaderMessage):
"""Data server has started working on a package."""
def __init__(self, package): self.package = package
class FinishPackageMessage(DownloaderMessage):
"""Data server has finished working on a package."""
def __init__(self, package): self.package = package
class StartDownloadMessage(DownloaderMessage):
"""Data server has started downloading a package."""
def __init__(self, package): self.package = package
class FinishDownloadMessage(DownloaderMessage):
"""Data server has finished downloading a package."""
def __init__(self, package): self.package = package
class StartUnzipMessage(DownloaderMessage):
"""Data server has started unzipping a package."""
def __init__(self, package): self.package = package
class FinishUnzipMessage(DownloaderMessage):
"""Data server has finished unzipping a package."""
def __init__(self, package): self.package = package
class UpToDateMessage(DownloaderMessage):
"""The package download file is already up-to-date"""
def __init__(self, package): self.package = package
class StaleMessage(DownloaderMessage):
"""The package download file is out-of-date or corrupt"""
def __init__(self, package): self.package = package
class ErrorMessage(DownloaderMessage):
"""Data server encountered an error"""
def __init__(self, package, message):
self.package = package
if isinstance(message, Exception):
self.message = str(message)
else:
self.message = message

class ProgressMessage(DownloaderMessage):
"""Indicates how much progress the data server has made"""
def __init__(self, progress): self.progress = progress
class SelectDownloadDirMessage(DownloaderMessage):
"""Indicates what download directory the data server is using"""
def __init__(self, download_dir): self.download_dir = download_dir

######################################################################
# NLTK Data Server
######################################################################

class Downloader(object):
"""
A class used to access the NLTK data server, which can be used to
download corpora and other data packages.
"""

#/////////////////////////////////////////////////////////////////
# Configuration
#/////////////////////////////////////////////////////////////////

INDEX_TIMEOUT = 60*60 # 1 hour
"""The amount of time after which the cached copy of the data
server index will be considered 'stale,' and will be
re-downloaded."""

DEFAULT_URL = 'http://nltk.googlecode.com/svn/trunk/nltk_data/index.xml'
"""The default URL for the NLTK data server's index. An
alternative URL can be specified when creating a new
C{Downloader} object."""

#/////////////////////////////////////////////////////////////////
# Status Constants
#/////////////////////////////////////////////////////////////////

INSTALLED = 'installed'
"""A status string indicating that a package or collection is
installed and up-to-date."""
NOT_INSTALLED = 'not installed'
"""A status string indicating that a package or collection is
not installed."""
STALE = 'out of date'
"""A status string indicating that a package or collection is
corrupt or out-of-date."""
PARTIAL = 'partial'
"""A status string indicating that a collection is partially
installed (i.e., only some of its packages are installed.)"""

#/////////////////////////////////////////////////////////////////
# Cosntructor
#/////////////////////////////////////////////////////////////////

def __init__(self, server_index_url=None, download_dir=None):
self._url = server_index_url or self.DEFAULT_URL
"""The URL for the data server's index file."""

self._collections = {}
"""Dictionary from collection identifier to L{Collection}"""

self._packages = {}
"""Dictionary from package identifier to L{Package}"""

self._download_dir = download_dir
"""The default directory to which packages will be downloaded."""

self._index = None
"""The XML index file downloaded from the data server"""

self._index_timestamp = None
"""Time at which L{self._index} was downloaded. If it is more
than L{INDEX_TIMEOUT} seconds old, it will be re-downloaded."""

self._status_cache = {}
"""Dictionary from package/collection identifier to status
string (L{INSTALLED}, L{NOT_INSTALLED}, L{STALE}, or
L{PARTIAL}). Cache is used for packages only, not
collections."""

self._errors = None
"""Flag for telling if all packages got successfully downloaded or not."""

# decide where we're going to save things to.
if self._download_dir is None:
self._download_dir = self.default_download_dir()

#/////////////////////////////////////////////////////////////////
# Information
#/////////////////////////////////////////////////////////////////

def list(self, download_dir=None, show_packages=True,
show_collections=True, header=True, more_prompt=False,
skip_installed=False):
lines = 0 # for more_prompt
if download_dir is None:
download_dir = self._download_dir
print 'Using default data directory (%s)' % download_dir
if header:
print '='*(26+len(self._url))
print ' Data server index for <%s>' % self._url
print '='*(26+len(self._url))
lines += 3 # for more_prompt
stale = partial = False

categories = []
if show_packages: categories.append('packages')
if show_collections: categories.append('collections')
for category in categories:
print '%s:' % category.capitalize()
lines += 1 # for more_prompt
for info in sorted(getattr(self, category)()):
status = self.status(info, download_dir)
if status == self.INSTALLED and skip_installed: continue
if status == self.STALE: stale = True
if status == self.PARTIAL: partial = True
prefix = {self.INSTALLED:'*', self.STALE:'-',
self.PARTIAL:'P', self.NOT_INSTALLED: ' '}[status]
name = textwrap.fill('-'*27 + (info.name or info.id),
75, subsequent_indent=27*' ')[27:]
print ' [%s] %s %s' % (prefix, info.id.ljust(20, '.'), name)
lines += len(name.split('\n')) # for more_prompt
if more_prompt and lines > 20:
user_input = raw_input("Hit Enter to continue: ")
if (user_input.lower() in ('x', 'q')): return
lines = 0
print
msg = '([*] marks installed packages'
if stale: msg += '; [-] marks out-of-date or corrupt packages'
if partial: msg += '; [P] marks partially installed collections'
print textwrap.fill(msg+')', subsequent_indent=' ', width=76)

def packages(self):
self._update_index()
return self._packages.values()

def corpora(self):
self._update_index()
return [pkg for (id,pkg) in self._packages.items()
if pkg.subdir == 'corpora']

def models(self):
self._update_index()
return [pkg for (id,pkg) in self._packages.items()
if pkg.subdir != 'corpora']

def collections(self):
self._update_index()
return self._collections.values()

#/////////////////////////////////////////////////////////////////
# Downloading
#/////////////////////////////////////////////////////////////////

def _info_or_id(self, info_or_id):
if isinstance(info_or_id, basestring):
return self.info(info_or_id)
else:
return info_or_id

# [xx] When during downloading is it 'safe' to abort? Only unsafe
# time is *during* an unzip -- we don't want to leave a
# partially-unzipped corpus in place because we wouldn't notice
# it. But if we had the exact total size of the unzipped corpus,
# then that would be fine. Then we could abort anytime we want!
# So this is really what we should do. That way the threaded
# downloader in the gui can just kill the download thread anytime
# it wants.

def incr_download(self, info_or_id, download_dir=None, force=False):
# If they didn't specify a download_dir, then use the default one.
if download_dir is None:
download_dir = self._download_dir
yield SelectDownloadDirMessage(download_dir)

# If they gave us a list of ids, then download each one.
if isinstance(info_or_id, (list,tuple)):
for msg in self._download_list(info_or_id, download_dir, force):
yield msg
return

# Look up the requested collection or package.
try: info = self._info_or_id(info_or_id)
except (IOError, ValueError), e:
yield ErrorMessage(None, 'Error loading %s: %s' %
(info_or_id, e))
return

# Handle collections.
if isinstance(info, Collection):
yield StartCollectionMessage(info)
for msg in self.incr_download(info.children, download_dir, force):
yield msg
yield FinishCollectionMessage(info)

# Handle Packages (delegate to a helper function).
else:
for msg in self._download_package(info, download_dir, force):
yield msg

def _num_packages(self, item):
if isinstance(item, Package): return 1
else: return len(item.packages)

def _download_list(self, items, download_dir, force):
# Look up the requested items.
for i in range(len(items)):
try: items[i] = self._info_or_id(items[i])
except (IOError, ValueError), e:
yield ErrorMessage(items[i], e)
return

# Download each item, re-scaling their progress.
num_packages = sum(self._num_packages(item) for item in items)
progress = 0
for i, item in enumerate(items):
if isinstance(item, Package): delta = 1./num_packages
else: delta = float(len(item.packages))/num_packages
for msg in self.incr_download(item, download_dir, force):
if isinstance(msg, ProgressMessage):
yield ProgressMessage(progress + msg.progress*delta)
else:
yield msg

progress += 100*delta

def _download_package(self, info, download_dir, force):
yield StartPackageMessage(info)
yield ProgressMessage(0)

# Do we already have the current version?
status = self.status(info, download_dir)
if not force and status == self.INSTALLED:
yield UpToDateMessage(info)
yield ProgressMessage(100)
yield FinishPackageMessage(info)
return

# Remove the package from our status cache
self._status_cache.pop(info.id, None)

# Check for (and remove) any old/stale version.
filepath = os.path.join(download_dir, info.filename)
if os.path.exists(filepath):
if status == self.STALE:
yield StaleMessage(info)
os.remove(filepath)

# Ensure the download_dir exists
if not os.path.exists(download_dir):
os.mkdir(download_dir)
if not os.path.exists(os.path.join(download_dir, info.subdir)):
os.mkdir(os.path.join(download_dir, info.subdir))

# Download the file. This will raise an IOError if the url
# is not found.
yield StartDownloadMessage(info)
yield ProgressMessage(5)
try:
infile = urllib2.urlopen(info.url)
outfile = open(filepath, 'wb')
#print info.size
num_blocks = max(1, float(info.size)/(1024*16))
for block in itertools.count():
s = infile.read(1024*16) # 16k blocks.
outfile.write(s)
if not s: break
if block % 2 == 0: # how often?
yield ProgressMessage(min(80, 5+75*(block/num_blocks)))
infile.close()
outfile.close()
except IOError, e:
yield ErrorMessage(info, 'Error downloading %r from <%s>:'
'\n %s' % (info.id, info.url, e))
return
yield FinishDownloadMessage(info)
yield ProgressMessage(80)

# If it's a zipfile, uncompress it.
if info.filename.endswith('.zip'):
zipdir = os.path.join(download_dir, info.subdir)
# Unzip if we're unzipping by default; *or* if it's already
# been unzipped (presumably a previous version).
if info.unzip or os.path.exists(os.path.join(zipdir, info.id)):
yield StartUnzipMessage(info)
for msg in _unzip_iter(filepath, zipdir, verbose=False):
# Somewhat of a hack, but we need a proper package reference
msg.package = info
yield msg
yield FinishUnzipMessage(info)

yield FinishPackageMessage(info)

def download(self, info_or_id=None, download_dir=None, quiet=False,
force=False, prefix='[nltk_data] ', halt_on_error=True,
raise_on_error=False):
# If no info or id is given, then use the interactive shell.
if info_or_id is None:
# [xx] hmm -- changing self._download_dir here seems like
# the wrong thing to do. Maybe the _interactive_download
# function should make a new copy of self to use?
if download_dir is not None: self._download_dir = download_dir
self._interactive_download()
return True

else:
# Define a helper function for displaying output:
def show(s, prefix2=''):
print textwrap.fill(s, initial_indent=prefix+prefix2,
subsequent_indent=prefix+prefix2+' '*4)

for msg in self.incr_download(info_or_id, download_dir, force):
# Error messages
if isinstance(msg, ErrorMessage):
show(msg.message)
if raise_on_error:
raise ValueError(msg.message)
if halt_on_error:
return False
self._errors = True
if not quiet:
print "Error installing package. Retry? [n/y/e]"
choice = raw_input().strip()
if choice in ['y', 'Y']:
if not self.download(msg.package.id, download_dir,
quiet, force, prefix,
halt_on_error, raise_on_error):
return False
elif choice in ['e', 'E']:
return False

# All other messages
if not quiet:
# Collection downloading messages:
if isinstance(msg, StartCollectionMessage):
show('Downloading collection %r' % msg.collection.id)
prefix += ' | '
print prefix
elif isinstance(msg, FinishCollectionMessage):
print prefix
prefix = prefix[:-4]
if self._errors:
show('Downloaded collection %r with errors' %
msg.collection.id)
else:
show('Done downloading collection %r' %
msg.collection.id)

# Package downloading messages:
elif isinstance(msg, StartPackageMessage):
show('Downloading package %r to %s...' %
(msg.package.id, download_dir))
elif isinstance(msg, UpToDateMessage):
show('Package %s is already up-to-date!' %
msg.package.id, ' ')
#elif isinstance(msg, StaleMessage):
# show('Package %s is out-of-date or corrupt' %
# msg.package.id, ' ')
elif isinstance(msg, StartUnzipMessage):
show('Unzipping %s.' % msg.package.filename, ' ')

# Data directory message:
elif isinstance(msg, SelectDownloadDirMessage):
download_dir = msg.download_dir
return True

def is_stale(self, info_or_id, download_dir=None):
return self.status(info_or_id, download_dir) == self.STALE

def is_installed(self, info_or_id, download_dir=None):
return self.status(info_or_id, download_dir) == self.INSTALLED

def clear_status_cache(self, id=None):
if id is None:
self._status_cache.clear()
else:
self._status_cache.pop(id, None)

def status(self, info_or_id, download_dir=None):
"""
Return a constant describing the status of the given package
or collection. Status can be one of L{INSTALLED},
L{NOT_INSTALLED}, L{STALE}, or L{PARTIAL}.
"""
if download_dir is None: download_dir = self._download_dir
info = self._info_or_id(info_or_id)

# Handle collections:
if isinstance(info, Collection):
pkg_status = [self.status(pkg.id) for pkg in info.packages]
if self.STALE in pkg_status:
return self.STALE
elif self.PARTIAL in pkg_status:
return self.PARTIAL
elif (self.INSTALLED in pkg_status and
self.NOT_INSTALLED in pkg_status):
return self.PARTIAL
elif self.NOT_INSTALLED in pkg_status:
return self.NOT_INSTALLED
else:
return self.INSTALLED

# Handle packages:
else:
filepath = os.path.join(download_dir, info.filename)
if download_dir != self._download_dir:
status = self._pkg_status(info, filepath)
else:
if info.id not in self._status_cache:
self._status_cache[info.id] = self._pkg_status(info,
filepath)
return self._status_cache[info.id]

def _pkg_status(self, info, filepath):
if not os.path.exists(filepath):
return self.NOT_INSTALLED

# Check if the file has the correct size.
try: filestat = os.stat(filepath)
except OSError: return self.NOT_INSTALLED
if filestat.st_size != int(info.size):
return self.STALE

# Check if the file's checksum matches
if md5_hexdigest(filepath) != info.checksum:
return self.STALE

# If it's a zipfile, and it's been at least partially
# unzipped, then check if it's been fully unzipped.
if filepath.endswith('.zip'):
unzipdir = filepath[:-4]
if not os.path.exists(unzipdir):
return self.INSTALLED # but not unzipped -- ok!
if not os.path.isdir(unzipdir):
return self.STALE

unzipped_size = sum(os.stat(os.path.join(d, f)).st_size
for d, _, files in os.walk(unzipdir)
for f in files)
if unzipped_size != info.unzipped_size:
return self.STALE

# Otherwise, everything looks good.
return self.INSTALLED

def update(self, quiet=False, prefix='[nltk_data] '):
"""
Re-download any packages whose status is STALE.
"""
self.clear_status_cache()
for pkg in self.packages():
if self.status(pkg) == self.STALE:
self.download(pkg, quiet=quiet, prefix=prefix)

#/////////////////////////////////////////////////////////////////
# Index
#/////////////////////////////////////////////////////////////////

def _update_index(self, url=None):
"""A helper function that ensures that self._index is
up-to-date. If the index is older than self.INDEX_TIMEOUT,
then download it again."""
# Check if the index is aleady up-to-date. If so, do nothing.
if not (self._index is None or url is not None or
time.time()-self._index_timestamp > self.INDEX_TIMEOUT):
return

# If a URL was specified, then update our URL.
self._url = url or self._url

# Download the index file.
self._index = nltk.internals.ElementWrapper(
ElementTree.parse(urllib2.urlopen(self._url)).getroot())
self._index_timestamp = time.time()

# Build a dictionary of packages.
packages = [Package.fromxml(p) for p in
self._index.findall('packages/package')]
self._packages = dict((p.id, p) for p in packages)

# Build a dictionary of collections.
collections = [Collection.fromxml(c) for c in
self._index.findall('collections/collection')]
self._collections = dict((c.id, c) for c in collections)

# Replace identifiers with actual children in collection.children.
for collection in self._collections.values():
for i, child_id in enumerate(collection.children):
if child_id in self._packages:
collection.children[i] = self._packages[child_id]
if child_id in self._collections:
collection.children[i] = self._collections[child_id]

# Fill in collection.packages for each collection.
for collection in self._collections.values():
packages = {}
queue = [collection]
for child in queue:
if isinstance(child, Collection):
queue.extend(child.children)
else:
packages[child.id] = child
collection.packages = packages.values()

# Flush the status cache
self._status_cache.clear()

def index(self):
"""
Return the XML index describing the packages available from
the data server. If necessary, this index will be downloaded
from the data server.
"""
self._update_index()
return self._index

def info(self, id):
"""Return the L{Package} or L{Collection} record for the
given item."""
self._update_index()
if id in self._packages: return self._packages[id]
if id in self._collections: return self._collections[id]
raise ValueError('Package %r not found in index' % id)

def xmlinfo(self, id):
"""Return the XML info record for the given item"""
self._update_index()
for package in self._index.findall('packages/package'):
if package.get('id') == id:
return package
for collection in self._index.findall('collections/collection'):
if collection.get('id') == id:
return collection
raise ValueError('Package %r not found in index' % id)

#/////////////////////////////////////////////////////////////////
# URL & Data Directory
#/////////////////////////////////////////////////////////////////

def _set_url(self, url):
# If we're unable to contact the given url, then keep the
# original url.
original_url = self._url
try:
self._update_index(url)
except:
self._url = original_url
raise

url = property(lambda self: self._url, _set_url, doc="""
The URL for the data server's index file.""")

def default_download_dir(self):
"""
Return the directory to which packages will be downloaded by
default. This value can be overridden using the constructor,
or on a case-by-case basis using the C{download_dir} argument when
calling L{download()}.

On Windows, the default download directory is
C{I{PYTHONHOME}/lib/nltk}, where C{I{PYTHONHOME}} is the
directory containing Python (e.g. C{C:\\Python25}).

On all other platforms, the default directory is determined
as follows:

- If C{/usr/share} exists and is writable, then
return C{/usr/share/nltk}
- If C{/usr/local/share} exists and is writable, then
return C{/usr/local/share/nltk}
- If C{/usr/lib} exists and is writable, then
return C{/usr/lib/nltk}
- If C{/usr/local/lib} exists and is writable, then
return C{/usr/local/lib/nltk}
- Otherwise, return C{~/nltk_data}, where C{~} is the
current user's home directory.
"""
# Check if we have sufficient permissions to install in a
# variety of system-wide locations.
for nltkdir in nltk.data.path:
if (os.path.exists(nltkdir) and
nltk.internals.is_writable(nltkdir)):
return nltkdir

# On Windows, use %APPDATA%
if sys.platform == 'win32' and 'APPDATA' in os.environ:
homedir = os.environ['APPDATA']

# Otherwise, install in the user's home directory.
else:
homedir = os.path.expanduser('~/')
if homedir == '~/':
raise ValueError("Could not find a default download directory")

# append "nltk_data" to the home directory
return os.path.join(homedir, 'nltk_data')

def _set_download_dir(self, download_dir):
self._download_dir = download_dir
# Clear the status cache.
self._status_cache.clear()

download_dir = property(lambda self: self._download_dir,
_set_download_dir, doc="""
The default directory to which packages will be downloaded.
This defaults to the value returned by L{default_download_dir()}.
To override this default on a case-by-case basis, use the
C{download_dir} argument when calling L{download()}.""")

#/////////////////////////////////////////////////////////////////
# Interactive Shell
#/////////////////////////////////////////////////////////////////

def _interactive_download(self):
# Try the GUI first; if that doesn't work, try the simple
# interactive shell.
if TKINTER:
try:
DownloaderGUI(self).mainloop()
except TclError:
DownloaderShell(self).run()
else:
DownloaderShell(self).run()

class DownloaderShell(object):
def __init__(self, dataserver):
self._ds = dataserver

def _simple_interactive_menu(self, *options):
print '-'*75
spc = (68 - sum(len(o) for o in options))/(len(options)-1)*' '
print ' ' + spc.join(options)
#w = 76/len(options)
#fmt = ' ' + ('%-'+str(w)+'s')*(len(options)-1) + '%s'
#print fmt % options
print '-'*75


def run(self):
print 'NLTK Downloader'
while True:
self._simple_interactive_menu(
'd) Download', 'l) List', 'c) Config', 'h) Help', 'q) Quit')
user_input = raw_input('Downloader> ').strip()
if not user_input: print; continue
command = user_input.lower().split()[0]
args = user_input.split()[1:]
try:
if command == 'l':
print
self._ds.list(self._ds.download_dir, header=False,
more_prompt=True)
elif command == 'h':
self._simple_interactive_help()
elif command == 'c':
self._simple_interactive_config()
elif command in ('q', 'x'):
return
elif command == 'd':
self._simple_interactive_download(args)
else:
print 'Command %r unrecogmized' % user_input
except urllib2.HTTPError, e:
print 'Error reading from server: %s'%e
except urllib2.URLError, e:
print 'Error connecting to server: %s'%e.reason
# try checking if user_input is a package name, &
# downloading it?
print

def _simple_interactive_download(self, args):
if args:
for arg in args:
try: self._ds.download(arg, prefix=' ')
except (IOError, ValueError), e: print e
else:
while True:
print
print 'Download which package (l=list; x=cancel)?'
user_input = raw_input(' Identifier> ')
if user_input.lower()=='l':
self._ds.list(self._ds.download_dir, header=False,
more_prompt=True, skip_installed=True)
continue
elif user_input.lower() in ('x', 'q', ''):
return
elif user_input:
for id in user_input.split():
try: self._ds.download(id, prefix=' ')
except (IOError, ValueError), e: print e
break

def _simple_interactive_help(self):
print
print 'Commands:'
print ' d) Download a package or collection h) Help'
print ' l) List packages & collections q) Quit'
print ' c) View & Modify Configuration'

def _show_config(self):
print
print 'Data Server:'
print ' - URL: <%s>' % self._ds.url
print (' - %d Package Collections Available' %
len(self._ds.collections()))
print (' - %d Individual Packages Available' %
len(self._ds.packages()))
print
print 'Local Machine:'
print ' - Data directory: %s' % self._ds.download_dir

def _simple_interactive_config(self):
self._show_config()
while True:
print
self._simple_interactive_menu(
's) Show Config', 'u) Set Server URL',
'd) Set Data Dir', 'm) Main Menu')
user_input = raw_input('Config> ').strip().lower()
if user_input == 's':
self._show_config()
elif user_input == 'd':
new_dl_dir = raw_input(' New Directory> ').strip().lower()
if new_dl_dir in ('', 'x', 'q'):
print ' Cancelled!'
elif os.path.isdir(new_dl_dir):
self._ds.download_dir = new_dl_dir
else:
print ('Directory %r not found! Create it first.' %
new_dl_dir)
elif user_input == 'u':
new_url = raw_input(' New URL> ').strip().lower()
if new_url in ('', 'x', 'q'):
print ' Cancelled!'
else:
if not new_url.startswith('http://'):
new_url = 'http://'+new_url
try: self._ds.url = new_url
except Exception, e:
print 'Error reading <%r>:\n %s' % (new_url, e)
elif user_input == 'm':
break

class DownloaderGUI(object):
"""
Graphical interface for downloading packages from the NLTK data
server.
"""

#/////////////////////////////////////////////////////////////////
# Column Configuration
#/////////////////////////////////////////////////////////////////

COLUMNS = ['', 'Identifier', 'Name', 'Size', 'Status',
'Unzipped Size',
'Copyright', 'Contact', 'License', 'Author',
'SVN Revision', 'Subdir', 'Checksum']
"""A list of the names of columns. This controls the order in
which the columns will appear. If this is edited, then
L{_package_to_columns()} may need to be edited to match."""

COLUMN_WEIGHTS = {'': 0, 'Name': 5, 'Size': 0, 'Status': 0}
"""A dictionary specifying how columns should be resized when the
table is resized. Columns with weight 0 will not be resized at
all; and columns with high weight will be resized more.
Default weight (for columns not explicitly listed) is 1."""

COLUMN_WIDTHS = {'':1, 'Identifier':20, 'Name':45,
'Size': 10, 'Unzipped Size': 10,
'Status': 12}
"""A dictionary specifying how wide each column should be, in
characters. The default width (for columns not explicitly
listed) is specified by L{DEFAULT_COLUMN_WIDTH}."""

DEFAULT_COLUMN_WIDTH = 30
"""The default width for columns that are not explicitly listed
in C{COLUMN_WIDTHS}."""

INITIAL_COLUMNS = ['', 'Identifier', 'Name', 'Size', 'Status']
"""The set of columns that should be displayed by default."""

# Perform a few import-time sanity checks to make sure that the
# column configuration variables are defined consistently:
for c in COLUMN_WEIGHTS: assert c in COLUMNS
for c in COLUMN_WIDTHS: assert c in COLUMNS
for c in INITIAL_COLUMNS: assert c in COLUMNS

#/////////////////////////////////////////////////////////////////
# Color Configuration
#/////////////////////////////////////////////////////////////////

_BACKDROP_COLOR = ('#000', '#ccc')

_ROW_COLOR = {Downloader.INSTALLED: ('#afa', '#080'),
Downloader.PARTIAL: ('#ffa', '#880'),
Downloader.STALE: ('#faa', '#800'),
Downloader.NOT_INSTALLED: ('#fff', '#888')}

_MARK_COLOR = ('#000', '#ccc')

#_FRONT_TAB_COLOR = ('#ccf', '#008')
#_BACK_TAB_COLOR = ('#88a', '#448')
_FRONT_TAB_COLOR = ('#fff', '#45c')
_BACK_TAB_COLOR = ('#aaa', '#67a')

_PROGRESS_COLOR = ('#f00', '#aaa')

_TAB_FONT = 'helvetica -16 bold'

#/////////////////////////////////////////////////////////////////
# Constructor
#/////////////////////////////////////////////////////////////////

def __init__(self, dataserver, use_threads=True):
self._ds = dataserver
self._use_threads = use_threads

# For the threaded downloader:
self._download_lock = threading.Lock()
self._download_msg_queue = []
self._download_abort_queue = []
self._downloading = False

# For tkinter after callbacks:
self._afterid = {}

# A message log.
self._log_messages = []
self._log_indent = 0
self._log('NLTK Downloader Started!')

# Create the main window.
top = self.top = Tk()
top.geometry('+50+50')
top.title('NLTK Downloader')
top.configure(background=self._BACKDROP_COLOR[1])

# Set up some bindings now, in case anything goes wrong.
top.bind('<Control-q>', self.destroy)
top.bind('<Control-x>', self.destroy)
self._destroyed = False

self._column_vars = {}

# Initialize the GUI.
self._init_widgets()
self._init_menu()
try:
self._fill_table()
except urllib2.HTTPError, e:
showerror('Error reading from server', e)
except urllib2.URLError, e:
showerror('Error connecting to server', e.reason)

self._show_info()
self._select_columns()
self._table.select(0)

# Make sure we get notified when we're destroyed, so we can
# cancel any download in progress.
self._table.bind('<Destroy>', self._destroy)

def _log(self, msg):
self._log_messages.append('%s %s%s' % (time.ctime(),
' | '*self._log_indent, msg))

#/////////////////////////////////////////////////////////////////
# Internals
#/////////////////////////////////////////////////////////////////

def _init_widgets(self):
# Create the top-level frame structures
f1 = Frame(self.top, relief='raised', border=2, padx=8, pady=0)
f1.pack(sid='top', expand=True, fill='both')
f1.grid_rowconfigure(2, weight=1)
f1.grid_columnconfigure(0, weight=1)
Frame(f1, height=8).grid(column=0, row=0) # spacer
tabframe = Frame(f1)
tabframe.grid(column=0, row=1, sticky='news')
tableframe = Frame(f1)
tableframe.grid(column=0, row=2, sticky='news')
buttonframe = Frame(f1)
buttonframe.grid(column=0, row=3, sticky='news')
Frame(f1, height=8).grid(column=0, row=4) # spacer
infoframe = Frame(f1)
infoframe.grid(column=0, row=5, sticky='news')
Frame(f1, height=8).grid(column=0, row=6) # spacer
progressframe = Frame(self.top, padx=3, pady=3,
background=self._BACKDROP_COLOR[1])
progressframe.pack(side='bottom', fill='x')
self.top['border'] = 0
self.top['highlightthickness'] = 0

# Create the tabs
self._tab_names = ['Collections', 'Corpora',
'Models', 'All Packages',]
self._tabs = {}
for i, tab in enumerate(self._tab_names):
label = Label(tabframe, text=tab, font=self._TAB_FONT)
label.pack(side='left', padx=((i+1)%2)*10)
label.bind('<Button-1>', self._select_tab)
self._tabs[tab.lower()] = label

# Create the table.
column_weights = [self.COLUMN_WEIGHTS.get(column, 1)
for column in self.COLUMNS]
self._table = Table(tableframe, self.COLUMNS,
column_weights=column_weights,
highlightthickness=0, listbox_height=16,
reprfunc=self._table_reprfunc)
self._table.columnconfig(0, foreground=self._MARK_COLOR[0]) # marked
for i, column in enumerate(self.COLUMNS):
width = self.COLUMN_WIDTHS.get(column, self.DEFAULT_COLUMN_WIDTH)
self._table.columnconfig(i, width=width)
self._table.pack(expand=True, fill='both')
self._table.focus()
self._table.bind_to_listboxes('<Double-Button-1>',
self._download)
self._table.bind('<space>', self._table_mark)
self._table.bind('<Return>', self._download)
self._table.bind('<Left>', self._prev_tab)
self._table.bind('<Right>', self._next_tab)
self._table.bind('<Control-a>', self._mark_all)

# Create entry boxes for URL & download_dir
infoframe.grid_columnconfigure(1, weight=1)

info = [('url', 'Server Index:', self._set_url),
('download_dir','Download Directory:',self._set_download_dir)]
self._info = {}
for (i, (key, label, callback)) in enumerate(info):
Label(infoframe, text=label).grid(column=0, row=i, sticky='e')
entry = Entry(infoframe, font='courier', relief='groove',
disabledforeground='black')
self._info[key] = (entry, callback)
entry.bind('<Return>', self._info_save)
entry.bind('<Button-1>', lambda e,key=key: self._info_edit(key))
entry.grid(column=1, row=i, sticky='ew')

# If the user edits url or download_dir, and then clicks outside
# the entry box, then save their results.
self.top.bind('<Button-1>', self._info_save)

# Create Download & Refresh buttons.
self._download_button = Button(
buttonframe, text='Download', command=self._download, width=8)
self._download_button.pack(side='left')
self._refresh_button = Button(
buttonframe, text='Refresh', command=self._refresh, width=8)
self._refresh_button.pack(side='right')

# Create Progress bar
self._progresslabel = Label(progressframe, text='',
foreground=self._BACKDROP_COLOR[0],
background=self._BACKDROP_COLOR[1])
self._progressbar = Canvas(progressframe, width=200, height=16,
background=self._PROGRESS_COLOR[1],
relief='sunken', border=1)
self._init_progressbar()
self._progressbar.pack(side='right')
self._progresslabel.pack(side='left')

def _init_menu(self):
menubar = Menu(self.top)

filemenu = Menu(menubar, tearoff=0)
filemenu.add_command(label='Download', underline=0,
command=self._download, accelerator='Return')
filemenu.add_separator()
filemenu.add_command(label='Change Server Index', underline=7,
command=lambda: self._info_edit('url'))
filemenu.add_command(label='Change Download Directory', underline=0,
command=lambda: self._info_edit('download_dir'))
filemenu.add_separator()
filemenu.add_command(label='Show Log', underline=5,
command=self._show_log)
filemenu.add_separator()
filemenu.add_command(label='Exit', underline=1,
command=self.destroy, accelerator='Ctrl-x')
menubar.add_cascade(label='File', underline=0, menu=filemenu)

# Create a menu to control which columns of the table are
# shown. n.b.: we never hide the first two columns (mark and
# identifier).
viewmenu = Menu(menubar, tearoff=0)
for column in self._table.column_names[2:]:
var = IntVar(self.top)
assert column not in self._column_vars
self._column_vars[column] = var
if column in self.INITIAL_COLUMNS: var.set(1)
viewmenu.add_checkbutton(label=column, underline=0, variable=var,
command=self._select_columns)
menubar.add_cascade(label='View', underline=0, menu=viewmenu)

# Create a sort menu
# [xx] this should be selectbuttons; and it should include
# reversed sorts as options.
sortmenu = Menu(menubar, tearoff=0)
for column in self._table.column_names[1:]:
sortmenu.add_command(label='Sort by %s' % column,
command=(lambda c=column:
self._table.sort_by(c, 'ascending')))
sortmenu.add_separator()
#sortmenu.add_command(label='Descending Sort:')
for column in self._table.column_names[1:]:
sortmenu.add_command(label='Reverse sort by %s' % column,
command=(lambda c=column:
self._table.sort_by(c, 'descending')))
menubar.add_cascade(label='Sort', underline=0, menu=sortmenu)

helpmenu = Menu(menubar, tearoff=0)
helpmenu.add_command(label='About', underline=0,
command=self.about)
helpmenu.add_command(label='Instructions', underline=0,
command=self.help, accelerator='F1')
menubar.add_cascade(label='Help', underline=0, menu=helpmenu)
self.top.bind('<F1>', self.help)

self.top.config(menu=menubar)

def _select_columns(self):
for (column, var) in self._column_vars.items():
if var.get():
self._table.show_column(column)
else:
self._table.hide_column(column)

def _refresh(self):
self._ds.clear_status_cache()
try:
self._fill_table()
except urllib2.HTTPError, e:
showerror('Error reading from server', e)
except urllib2.URLError, e:
showerror('Error connecting to server', e.reason)
self._table.select(0)

def _info_edit(self, info_key):
self._info_save() # just in case.
(entry, callback) = self._info[info_key]
entry['state'] = 'normal'
entry['relief'] = 'sunken'
entry.focus()

def _info_save(self, e=None):
focus = self._table
for entry, callback in self._info.values():
if entry['state'] == 'disabled': continue
if e is not None and e.widget is entry and e.keysym != 'Return':
focus = entry
else:
entry['state'] = 'disabled'
entry['relief'] = 'groove'
callback(entry.get())
focus.focus()

def _table_reprfunc(self, row, col, val):
if self._table.column_names[col].endswith('Size'):
if isinstance(val, basestring): return ' %s' % val
elif val < 1024**2: return ' %.1f KB' % (val/1024.**1)
elif val < 1024**3: return ' %.1f MB' % (val/1024.**2)
else: return ' %.1f GB' % (val/1024.**3)

if col in (0, ''): return str(val)
else: return ' %s' % val

def _set_url(self, url):
if url == self._ds.url: return
try:
self._ds.url = url
self._fill_table()
except IOError, e:
showerror('Error Setting Server Index', str(e))
self._show_info()


def _set_download_dir(self, download_dir):
if self._ds.download_dir == download_dir: return
# check if the dir exists, and if not, ask if we should create it?

# Clear our status cache, & re-check what's installed
self._ds.download_dir = download_dir
try:
self._fill_table()
except urllib2.HTTPError, e:
showerror('Error reading from server', e)
except urllib2.URLError, e:
showerror('Error connecting to server', e.reason)
self._show_info()

def _show_info(self):
print 'showing info', self._ds.url
for entry,cb in self._info.values():
entry['state'] = 'normal'
entry.delete(0, 'end')
self._info['url'][0].insert(0, self._ds.url)
self._info['download_dir'][0].insert(0, self._ds.download_dir)
for entry,cb in self._info.values():
entry['state'] = 'disabled'

def _prev_tab(self, *e):
for i, tab in enumerate(self._tab_names):
if tab.lower() == self._tab and i > 0:
self._tab = self._tab_names[i-1].lower()
try:
return self._fill_table()
except urllib2.HTTPError, e:
showerror('Error reading from server', e)
except urllib2.URLError, e:
showerror('Error connecting to server', e.reason)

def _next_tab(self, *e):
for i, tab in enumerate(self._tab_names):
if tab.lower() == self._tab and i < (len(self._tabs)-1):
self._tab = self._tab_names[i+1].lower()
try:
return self._fill_table()
except urllib2.HTTPError, e:
showerror('Error reading from server', e)
except urllib2.URLError, e:
showerror('Error connecting to server', e.reason)

def _select_tab(self, event):
self._tab = event.widget['text'].lower()
try:
self._fill_table()
except urllib2.HTTPError, e:
showerror('Error reading from server', e)
except urllib2.URLError, e:
showerror('Error connecting to server', e.reason)

_tab = 'collections'
#_tab = 'corpora'
_rows = None
def _fill_table(self):
selected_row = self._table.selected_row()
self._table.clear()
if self._tab == 'all packages':
items = self._ds.packages()
elif self._tab == 'corpora':
items = self._ds.corpora()
elif self._tab == 'models':
items = self._ds.models()
elif self._tab == 'collections':
items = self._ds.collections()
else:
assert 0, 'bad tab value %r' % self._tab
rows = [self._package_to_columns(item) for item in items]
self._table.extend(rows)

# Highlight the active tab.
for tab, label in self._tabs.items():
if tab == self._tab:
label.configure(foreground=self._FRONT_TAB_COLOR[0],
background=self._FRONT_TAB_COLOR[1])
else:
label.configure(foreground=self._BACK_TAB_COLOR[0],
background=self._BACK_TAB_COLOR[1])

self._table.sort_by('Identifier', order='ascending')
self._color_table()
self._table.select(selected_row)

# This is a hack, because the scrollbar isn't updating its
# position right -- I'm not sure what the underlying cause is
# though. (This is on OS X w/ python 2.5) The length of
# delay that's necessary seems to depend on how fast the
# comptuer is. :-/
self.top.after(150, self._table._scrollbar.set,
*self._table._mlb.yview())
self.top.after(300, self._table._scrollbar.set,
*self._table._mlb.yview())

def _update_table_status(self):
for row_num in range(len(self._table)):
status = self._ds.status(self._table[row_num, 'Identifier'])
self._table[row_num, 'Status'] = status
self._color_table()

def _download(self, *e):
# If we're using threads, then delegate to the threaded
# downloader instead.
if self._use_threads:
return self._download_threaded(*e)

marked = [self._table[row, 'Identifier']
for row in range(len(self._table))
if self._table[row, 0] != '']
selection = self._table.selected_row()
if not marked and selection is not None:
marked = [self._table[selection, 'Identifier']]

download_iter = self._ds.incr_download(marked, self._ds.download_dir)
self._log_indent = 0
self._download_cb(download_iter, marked)

_DL_DELAY=10
def _download_cb(self, download_iter, ids):
try: msg = download_iter.next()
except StopIteration:
#self._fill_table(sort=False)
self._update_table_status()
afterid = self.top.after(10, self._show_progress, 0)
self._afterid['_download_cb'] = afterid
return

def show(s):
self._progresslabel['text'] = s
self._log(s)
if isinstance(msg, ProgressMessage):
self._show_progress(msg.progress)
elif isinstance(msg, ErrorMessage):
show(msg.message)
if msg.package is not None:
self._select(msg.package.id)
self._show_progress(None)
return # halt progress.
elif isinstance(msg, StartCollectionMessage):
show('Downloading collection %r' % msg.collection.id)
self._log_indent += 1
elif isinstance(msg, StartPackageMessage):
show('Downloading package %r' % msg.package.id)
elif isinstance(msg, UpToDateMessage):
show('Package %s is up-to-date!' % msg.package.id)
#elif isinstance(msg, StaleMessage):
# show('Package %s is out-of-date or corrupt' % msg.package.id)
elif isinstance(msg, FinishDownloadMessage):
show('Finished downloading %r.' % msg.package.id)
elif isinstance(msg, StartUnzipMessage):
show('Unzipping %s' % msg.package.filename)
elif isinstance(msg, FinishCollectionMessage):
self._log_indent -= 1
show('Finished downloading collection %r.' % msg.collection.id)
self._clear_mark(msg.collection.id)
elif isinstance(msg, FinishPackageMessage):
self._clear_mark(msg.package.id)
afterid = self.top.after(self._DL_DELAY, self._download_cb,
download_iter, ids)
self._afterid['_download_cb'] = afterid

def _select(self, id):
for row in range(len(self._table)):
if self._table[row, 'Identifier'] == id:
self._table.select(row)
return

def _color_table(self):
# Color rows according to status.
for row in range(len(self._table)):
bg, sbg = self._ROW_COLOR[self._table[row, 'Status']]
fg, sfg = ('black', 'white')
self._table.rowconfig(row, foreground=fg, selectforeground=sfg,
background=bg, selectbackground=sbg)
# Color the marked column
self._table.itemconfigure(row, 0,
foreground=self._MARK_COLOR[0],
background=self._MARK_COLOR[1])


def _clear_mark(self, id):
for row in range(len(self._table)):
if self._table[row, 'Identifier'] == id:
self._table[row, 0] = ''

def _mark_all(self, *e):
for row in range(len(self._table)):
self._table[row,0] = 'X'

def _table_mark(self, *e):
selection = self._table.selected_row()
if selection >= 0:
if self._table[selection][0] != '':
self._table[selection,0] = ''
else:
self._table[selection,0] = 'X'
self._table.select(delta=1)

def _show_log(self):
text = '\n'.join(self._log_messages)
ShowText(self.top, 'NLTK Downloader Log', text)

def _package_to_columns(self, pkg):
"""
Given a package, return a list of values describing that
package, one for each column in L{self.COLUMNS}.
"""
row = []
for column_index, column_name in enumerate(self.COLUMNS):
if column_index == 0: # Mark:
row.append('')
elif column_name == 'Identifier':
row.append(pkg.id)
elif column_name == 'Status':
row.append(self._ds.status(pkg))
else:
attr = column_name.lower().replace(' ', '_')
row.append(getattr(pkg, attr, 'n/a'))
return row

#/////////////////////////////////////////////////////////////////
# External Interface
#/////////////////////////////////////////////////////////////////

def destroy(self, *e):
if self._destroyed: return
self.top.destroy()
self._destroyed = True

def _destroy(self, *e):
if self.top is not None:
for afterid in self._afterid.values():
self.top.after_cancel(afterid)

# Abort any download in progress.
if self._downloading and self._use_threads:
self._abort_download()

# Make sure the garbage collector destroys these now;
# otherwise, they may get destroyed when we're not in the main
# thread, which would make Tkinter unhappy.
self._column_vars.clear()

def mainloop(self, *args, **kwargs):
self.top.mainloop(*args, **kwargs)

#/////////////////////////////////////////////////////////////////
# HELP
#/////////////////////////////////////////////////////////////////

HELP = textwrap.dedent("""\
This tool can be used to download a variety of corpora and models
that can be used with NLTK. Each corpus or model is distributed
in a single zip file, known as a \"package file.\" You can
download packages individually, or you can download pre-defined
collections of packages.

When you download a package, it will be saved to the \"download
directory.\" A default download directory is chosen when you run

the downloader; but you may also select a different download
directory. On Windows, the default download directory is


\"package.\"

The NLTK downloader can be used to download a variety of corpora,
models, and other data packages.

Keyboard shortcuts::
[return]\t Download
[up]\t Select previous package
[down]\t Select next package
[left]\t Select previous tab
[right]\t Select next tab
""")

def help(self, *e):
# The default font's not very legible; try using 'fixed' instead.
try:
ShowText(self.top, 'Help: NLTK Dowloader',
self.HELP.strip(), width=75, font='fixed')
except:
ShowText(self.top, 'Help: NLTK Downloader',
self.HELP.strip(), width=75)

def about(self, *e):
ABOUT = ("NLTK Downloader\n"+
"Written by Edward Loper")
TITLE = 'About: NLTK Downloader'
try:
from tkMessageBox import Message
Message(message=ABOUT, title=TITLE).show()
except ImportError:
ShowText(self._top, TITLE, ABOUT)

#/////////////////////////////////////////////////////////////////
# Progress Bar
#/////////////////////////////////////////////////////////////////

_gradient_width = 5
def _init_progressbar(self):
c = self._progressbar
width, height = int(c['width']), int(c['height'])
for i in range(0, (int(c['width'])*2)/self._gradient_width):
c.create_line(i*self._gradient_width+20, -20,
i*self._gradient_width-height-20, height+20,
width=self._gradient_width,
fill='#%02x0000' % (80 + abs(i%6-3)*12))
c.addtag_all('gradient')
c.itemconfig('gradient', state='hidden')

# This is used to display progress
c.addtag_withtag('redbox', c.create_rectangle(
0, 0, 0, 0, fill=self._PROGRESS_COLOR[0]))

def _show_progress(self, percent):
c = self._progressbar
if percent is None:
c.coords('redbox', 0, 0, 0, 0)
c.itemconfig('gradient', state='hidden')
else:
width, height = int(c['width']), int(c['height'])
x = percent * int(width) / 100 + 1
c.coords('redbox', 0, 0, x, height+1)

def _progress_alive(self):
c = self._progressbar
if not self._downloading:
c.itemconfig('gradient', state='hidden')
else:
c.itemconfig('gradient', state='normal')
x1, y1, x2, y2 = c.bbox('gradient')
if x1 <= -100:
c.move('gradient', (self._gradient_width*6)-4, 0)
else:
c.move('gradient', -4, 0)
afterid = self.top.after(200, self._progress_alive)
self._afterid['_progress_alive'] = afterid

#/////////////////////////////////////////////////////////////////
# Threaded downloader
#/////////////////////////////////////////////////////////////////

def _download_threaded(self, *e):
# If the user tries to start a new download while we're already
# downloading something, then abort the current download instead.
if self._downloading:
self._abort_download()
return

# Change the 'download' button to an 'abort' button.
self._download_button['text'] = 'Cancel'

marked = [self._table[row, 'Identifier']
for row in range(len(self._table))
if self._table[row, 0] != '']
selection = self._table.selected_row()
if not marked and selection is not None:
marked = [self._table[selection, 'Identifier']]

# Create a new data server object for the download operation,
# just in case the user modifies our data server during the
# download (e.g., clicking 'refresh' or editing the index url).
ds = Downloader(self._ds.url, self._ds.download_dir)

# Start downloading in a seperate thread.
assert self._download_msg_queue == []
assert self._download_abort_queue == []
self._DownloadThread(ds, marked, self._download_lock,
self._download_msg_queue,
self._download_abort_queue).start()

# Monitor the download message queue & display its progress.
self._log_indent = 0
self._downloading = True
self._monitor_message_queue()

# Display an indication that we're still alive and well by
# cycling the progress bar.
self._progress_alive()

def _abort_download(self):
if self._downloading:
self._download_lock.acquire()
self._download_abort_queue.append('abort')
self._download_lock.release()

class _DownloadThread(threading.Thread):
def __init__(self, data_server, items, lock, message_queue, abort):
self.data_server = data_server
self.items = items
self.lock = lock
self.message_queue = message_queue
self.abort = abort
threading.Thread.__init__(self)

def run (self):
for msg in self.data_server.incr_download(self.items):
self.lock.acquire()
self.message_queue.append(msg)
# Check if we've been told to kill ourselves:
if self.abort:
self.message_queue.append('aborted')
self.lock.release()
return
self.lock.release()
self.lock.acquire()
self.message_queue.append('finished')
self.lock.release()

_MONITOR_QUEUE_DELAY=100
def _monitor_message_queue(self):
def show(s):
self._progresslabel['text'] = s
self._log(s)

# Try to acquire the lock; if it's busy, then just try again later.
if not self._download_lock.acquire():
return
for msg in self._download_msg_queue:

# Done downloading?
if msg == 'finished' or msg == 'aborted':
#self._fill_table(sort=False)
self._update_table_status()
self._downloading = False
self._download_button['text'] = 'Download'
del self._download_msg_queue[:]
del self._download_abort_queue[:]
self._download_lock.release()
if msg == 'aborted':
show('Download aborted!')
self._show_progress(None)
else:
afterid = self.top.after(100, self._show_progress, None)
self._afterid['_monitor_message_queue'] = afterid
return

# All other messages
elif isinstance(msg, ProgressMessage):
self._show_progress(msg.progress)
elif isinstance(msg, ErrorMessage):
show(msg.message)
if msg.package is not None:
self._select(msg.package.id)
self._show_progress(None)
self._downloading = False
return # halt progress.
elif isinstance(msg, StartCollectionMessage):
show('Downloading collection %r' % msg.collection.id)
self._log_indent += 1
elif isinstance(msg, StartPackageMessage):
self._ds.clear_status_cache(msg.package.id)
show('Downloading package %r' % msg.package.id)
elif isinstance(msg, UpToDateMessage):
show('Package %s is up-to-date!' % msg.package.id)
#elif isinstance(msg, StaleMessage):
# show('Package %s is out-of-date or corrupt; updating it' %
# msg.package.id)
elif isinstance(msg, FinishDownloadMessage):
show('Finished downloading %r.' % msg.package.id)
elif isinstance(msg, StartUnzipMessage):
show('Unzipping %s' % msg.package.filename)
elif isinstance(msg, FinishUnzipMessage):
show('Finished installing %s' % msg.package.id)
elif isinstance(msg, FinishCollectionMessage):
self._log_indent -= 1
show('Finished downloading collection %r.' % msg.collection.id)
self._clear_mark(msg.collection.id)
elif isinstance(msg, FinishPackageMessage):
self._update_table_status()
self._clear_mark(msg.package.id)

# Let the user know when we're aborting a download (but
# waiting for a good point to abort it, so we don't end up
# with a partially unzipped package or anything like that).
if self._download_abort_queue:
self._progresslabel['text'] = 'Aborting download...'

# Clear the message queue and then release the lock
del self._download_msg_queue[:]
self._download_lock.release()

# Check the queue again after MONITOR_QUEUE_DELAY msec.
afterid = self.top.after(self._MONITOR_QUEUE_DELAY,
self._monitor_message_queue)
self._afterid['_monitor_message_queue'] = afterid

######################################################################
# Helper Functions
######################################################################
# [xx] It may make sense to move these to nltk.internals.

def md5_hexdigest(file):
"""
Calculate and return the MD5 checksum for a given file. C{file}
may either be a filename or an open stream.
"""
if isinstance(file, basestring):
file = open(file, 'rb')

md5_digest = md5()
while True:
block = file.read(1024*16) # 16k blocks
if not block: break
md5_digest.update(block)
return md5_digest.hexdigest()

# change this to periodically yield progress messages?
# [xx] get rid of topdir parameter -- we should be checking
# this when we build the index, anyway.
def unzip(filename, root, verbose=True):
"""
Extract the contents of the zip file C{filename} into the
directory C{root}.
"""
for message in _unzip_iter(filename, root, verbose):
if isinstance(message, ErrorMessage):
raise Exception, message

def _unzip_iter(filename, root, verbose=True):
if verbose:
sys.stdout.write('Unzipping %s' % os.path.split(filename)[1])
sys.stdout.flush()

try: zf = zipfile.ZipFile(filename)
except zipfile.error, e:
yield ErrorMessage(filename, 'Error with downloaded zip file')
return
except Exception, e:
yield ErrorMessage(filename, e)
return

# Get lists of directories & files
namelist = zf.namelist()
dirlist = [x for x in namelist if x.endswith('/')]
filelist = [x for x in namelist if not x.endswith('/')]

# Create the target directory if it doesn't exist
if not os.path.exists(root):
os.mkdir(root)

# Create the directory structure
for dirname in sorted(dirlist):
pieces = dirname[:-1].split('/')
for i in range(len(pieces)):
dirpath = os.path.join(root, *pieces[:i+1])
if not os.path.exists(dirpath):
os.mkdir(dirpath)

# Extract files.
for i, filename in enumerate(filelist):
filepath = os.path.join(root, *filename.split('/'))
out = open(filepath, 'wb')
try: contents = zf.read(filename)
except Exception, e:
yield ErrorMessage(filename, e)
return
out.write(contents)
out.close()
if verbose and (i*10/len(filelist) > (i-1)*10/len(filelist)):
sys.stdout.write('.')
sys.stdout.flush()
if verbose:
print

######################################################################
# Index Builder
######################################################################
# This may move to a different file sometime.
import subprocess, zipfile

def build_index(root, base_url):
"""
Create a new data.xml index file, by combining the xml description
files for various packages and collections. C{root} should be the
path to a directory containing the package xml and zip files; and
the collection xml files. The C{root} directory is expected to
have the following subdirectories::

root/
packages/ .................. subdirectory for packages
corpora/ ................. zip & xml files for corpora
grammars/ ................ zip & xml files for grammars
taggers/ ................. zip & xml files for taggers
tokenizers/ .............. zip & xml files for tokenizers
etc.
collections/ ............... xml files for collections

For each package, there should be two files: C{I{package}.zip}
contains the package itself, as a compressed zip file; and
C{I{package}.xml} is an xml description of the package. The
zipfile C{I{package}.zip} should expand to a single subdirectory
named C{I{package/}}. The base filename C{I{package}} must match
the identifier given in the package's xml file.

For each collection, there should be a single file
C{I{collection}.zip}, describing the collection.

All identifiers (for both packages and collections) must be unique.
"""
# Find all packages.
packages = []
for pkg_xml, zf, subdir in _find_packages(os.path.join(root, 'packages')):
zipstat = os.stat(zf.filename)
url = '%s/%s/%s' % (base_url, subdir, os.path.split(zf.filename)[1])
unzipped_size = sum(zf_info.file_size for zf_info in zf.infolist())

# Fill in several fields of the package xml with calculated values.
pkg_xml.set('unzipped_size', '%s' % unzipped_size)
pkg_xml.set('size', '%s' % zipstat.st_size)
pkg_xml.set('checksum', '%s' % md5_hexdigest(zf.filename))
pkg_xml.set('subdir', subdir)
#pkg_xml.set('svn_revision', _svn_revision(zf.filename))
pkg_xml.set('url', url)

# Record the package.
packages.append(pkg_xml)

# Find all collections
collections = list(_find_collections(os.path.join(root, 'collections')))

# Check that all UIDs are unique
uids = set()
for item in packages+collections:
if item.get('id') in uids:
raise ValueError('Duplicate UID: %s' % item.get('id'))
uids.add(item.get('id'))

# Put it all together
top_elt = ElementTree.Element('nltk_data')
top_elt.append(ElementTree.Element('packages'))
for package in packages: top_elt[0].append(package)
top_elt.append(ElementTree.Element('collections'))
for collection in collections: top_elt[1].append(collection)

_indent_xml(top_elt)
return top_elt

def _indent_xml(xml, prefix=''):
"""
Helper for L{build_index()}: Given an XML ElementTree, modify it
(and its descendents) C{text} and C{tail} attributes to generate
an indented tree, where each nested element is indented by 2
spaces with respect to its parent.
"""
if len(xml) > 0:
xml.text = (xml.text or '').strip() + '\n' + prefix + ' '
for child in xml:
_indent_xml(child, prefix+' ')
for child in xml[:-1]:
child.tail = (child.tail or '').strip() + '\n' + prefix + ' '
xml[-1].tail = (xml[-1].tail or '').strip() + '\n' + prefix

def _check_package(pkg_xml, zipfilename, zf):
"""
Helper for L{build_index()}: Perform some checks to make sure that
the given package is consistent.
"""
# The filename must patch the id given in the XML file.
uid = os.path.splitext(os.path.split(zipfilename)[1])[0]
if pkg_xml.get('id') != uid:
raise ValueError('package identifier mismatch (%s vs %s)' %
(pkg_xml.get('id'), uid))

# Zip file must expand to a subdir whose name matches uid.
if sum( (name!=uid and not name.startswith(uid+'/'))
for name in zf.namelist() ):
raise ValueError('Zipfile %s.zip does not expand to a single '
'subdirectory %s/' % (uid, uid))


def _svn_revision(filename):
"""
Helper for L{build_index()}: Calculate the subversion revision
number for a given file (by using C{subprocess} to run C{svn}).
"""
p = subprocess.Popen(['svn', 'status', '-v', filename],
stdout=subprocess.PIPE,
stderr=subprocess.PIPE)
(stdout, stderr) = p.communicate()
if p.returncode != 0 or stderr or not stdout:
raise ValueError('Error determining svn_revision for %s: %s' %
(os.path.split(filename)[1], textwrap.fill(stderr)))
return stdout.split()[2]

def _find_collections(root):
"""
Helper for L{build_index()}: Yield a list of ElementTree.Element
objects, each holding the xml for a single package collection.
"""
packages = []
for dirname, subdirs, files in os.walk(root):
for filename in files:
if filename.endswith('.xml'):
xmlfile = os.path.join(dirname, filename)
yield ElementTree.parse(xmlfile).getroot()

def _find_packages(root):
"""
Helper for L{build_index()}: Yield a list of tuples C{(pkg_xml,
zf, subdir)}, where:
- C{pkg_xml} is an ElementTree.Element holding the xml for a
package
- C{zf} is a zipfile.ZipFile for the package's contents.
- C{subdir} is the subdirectory (relative to C{root}) where
the package was found (e.g. 'corpora' or 'grammars').
"""
from nltk.corpus.reader.util import _path_from
# Find all packages.
packages = []
for dirname, subdirs, files in os.walk(root):
relpath = '/'.join(_path_from(root, dirname))
for filename in files:
if filename.endswith('.xml'):
xmlfilename = os.path.join(dirname, filename)
zipfilename = xmlfilename[:-4]+'.zip'
try: zf = zipfile.ZipFile(zipfilename)
except Exception, e:
raise ValueError('Error reading file %r!\n%s' %
(zipfilename, e))
try: pkg_xml = ElementTree.parse(xmlfilename).getroot()
except Exception, e:
raise ValueError('Error reading file %r!\n%s' %
(xmlfilename, e))

# Check that the UID matches the filename
uid = os.path.split(xmlfilename[:-4])[1]
if pkg_xml.get('id') != uid:
raise ValueError('package identifier mismatch (%s '
'vs %s)' % (pkg_xml.get('id'), uid))

# Check that the zipfile expands to a subdir whose
# name matches the uid.
if sum( (name!=uid and not name.startswith(uid+'/'))
for name in zf.namelist() ):
raise ValueError('Zipfile %s.zip does not expand to a '
'single subdirectory %s/' % (uid, uid))

yield pkg_xml, zf, relpath
# Don't recurse into svn subdirectories:
try: subdirs.remove('.svn')
except ValueError: pass

######################################################################
# Main:
######################################################################

# There should be a command-line interface

# Aliases
_downloader = Downloader()
download = _downloader.download
def download_shell(): DownloaderShell(_downloader).run()
def download_gui(): DownloaderGUI(_downloader).mainloop()
def update(): _downloader.update()

if __name__ == '__main__':
from optparse import OptionParser
parser = OptionParser()
parser.add_option("-d", "--dir", dest="dir",
help="download package to directory DIR", metavar="DIR")
parser.add_option("-q", "--quiet", dest="quiet", action="store_true",
default=False, help="work quietly")
parser.add_option("-f", "--force", dest="force", action="store_true",
default=False, help="download even if already installed")
parser.add_option("-e", "--exit-on-error", dest="halt_on_error", action="store_true",
default=False, help="exit if an error occurs")

(options, args) = parser.parse_args()

if args:
for pkg_id in args:
rv = download(info_or_id=pkg_id, download_dir=options.dir,
quiet=options.quiet, force=options.force,
halt_on_error=options.halt_on_error)
if rv==False and options.halt_on_error:
break
else:
download(download_dir=options.dir,
quiet=options.quiet, force=options.force,
halt_on_error=options.halt_on_error)

Change log

r8730 by StevenBird1 on Mar 7, 2011   Diff
Updated NLTK copyright year range from
2001-2010 to 2001-2011
Go to: 
Sign in to write a code review

Older revisions

r8675 by coles.david on Sep 21, 2010   Diff
Catch any URL or HTTP errors from the
downloader UI and display error
message.
r8479 by StevenBird1 on Jan 12, 2010   Diff
Updated copyright period to 2001-2010
r8404 by StevenBird1 on Nov 7, 2009   Diff
Removed spurious #!/usr/bin/python
lines, reported by rpmlint, resolving
 issue 462 .

All revisions of this file

File info

Size: 89588 bytes, 2203 lines
Powered by Google Project Hosting