-
Notifications
You must be signed in to change notification settings - Fork 11
/
index.html
2363 lines (2351 loc) · 353 KB
/
index.html
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
<html>
<head>
<link rel="shortcut icon" href="../images/favicon.png"/>
<title>PyDwarf docs</title>
<style>
body {
font-family: sans-serif;
background-color: #1f1e1e;
color: #ddd;
padding: 2%;
}
.highlight-example {
background-color: #060606;
color: #3c1;
padding: 8px;
margins: 0;
white-space: pre-wrap; /* CSS 3 */
white-space: -moz-pre-wrap; /* Mozilla, since 1999 */
white-space: -pre-wrap; /* Opera 4-6 */
white-space: -o-pre-wrap; /* Opera 7 */
word-wrap: break-word; /* Internet Explorer 5.5+ */
}
.example-separator {
margins: 0;
}
ul {
list-style-type: circle;
}
a {
text-decoration: none;
color: #ddd;
}
a:hover {
text-decoration: underline;
}
.docstring {
padding-bottom: 16px;
font-style: italic;
color: #bbb;
}
.arguments {
font-size: 10pt;
font-style: italic;
color: #bbb;
padding-left: 8px;
}
.argument-separator, .argument-equals {
color: #555;
}
.argument-separator {
margin-right: 6px;
}
.argument-equals {
margin-left: 2px;
margin-right: 2px;
}
.argument-default {
color: #555;
}
.argument-default.str {
color: #474;
}
.argument-default.int {
color: #356;
}
.argument-name.self, .argument-default.bool, .argument-default.NoneType {
color: #742;
}
.argument.varargs, .argument.keywords {
color: #555;
}
.contents-undocumented {
color: #888;
}
.item {
padding: 6px;
}
.item-body {
padding-left: 16px;
border-top-style: solid;
border-bottom-style: solid;
border-width: 1px;
border-color: #282828;
padding-top: 6px;
padding-bottom: 6px;
margin-bottom: 12px;
}
.level {
margin-top: 16px;
border-left-style: solid;
border-width: 2px;
border-color: #444;
padding: 8px 0px;
padding-left: 20px;
}
.item-title {
display: inline;
}
.item-header {
padding-top: 12px;
padding-bottom: 8px;
}
.inherits-from, .superclass, .superclass-delimeter {
font-style: italic;
font-size: 10pt;
}
.inherits-from {
color: #bbb;
padding-left: 12px;
padding-right: 4px;
}
.superclass-delimeter {
color: #bbb;
padding-right: 3px;
}
</style>
</head>
<body>
<h1>Table of Contents</h1>
<div class="indent"><a class="contents-undocumented" href="#None"></a>None<ul><li><a class="contents-undocumented" href="#pydwarf">pydwarf</a><module 'pydwarf' from '/Users/pineapple/Dropbox/Projects/PyDwarf/docs/bin/../../pydwarf/__init__.pyc'><ul><li><a class="contents-documented" href="#pydwarf.compatible">compatible</a><function compatible at 0x2b43070><ul></ul></li>
<li><a class="contents-documented" href="#pydwarf.config">config</a><class 'pydwarf.config.config'><ul><li><a class="contents-documented" href="#pydwarf.config.__add__">__add__</a><function __add__ at 0x5f1eb0><ul></ul></li>
<li><a class="contents-documented" href="#pydwarf.config.__and__">__and__</a><function __and__ at 0x5f1f70><ul></ul></li>
<li><a class="contents-documented" href="#pydwarf.config.__getitem__">__getitem__</a><function __getitem__ at 0x5f1db0><ul></ul></li>
<li><a class="contents-documented" href="#pydwarf.config.__iadd__">__iadd__</a><function __iadd__ at 0x5f1f30><ul></ul></li>
<li><a class="contents-documented" href="#pydwarf.config.__init__">__init__</a><function __init__ at 0x5f1b70><ul></ul></li>
<li><a class="contents-documented" href="#pydwarf.config.__iter__">__iter__</a><function __iter__ at 0x5f1e30><ul></ul></li>
<li><a class="contents-documented" href="#pydwarf.config.__radd__">__radd__</a><function __radd__ at 0x5f1ef0><ul></ul></li>
<li><a class="contents-documented" href="#pydwarf.config.__setitem__">__setitem__</a><function __setitem__ at 0x5f1df0><ul></ul></li>
<li><a class="contents-documented" href="#pydwarf.config.__str__">__str__</a><function __str__ at 0x5f1d70><ul></ul></li>
<li><a class="contents-documented" href="#pydwarf.config.apply">apply</a><function apply at 0x5f40b0><ul></ul></li>
<li><a class="contents-documented" href="#pydwarf.config.copy">copy</a><function copy at 0x5f40f0><ul></ul></li>
<li><a class="contents-documented" href="#pydwarf.config.iteritems">iteritems</a><function iteritems at 0x5f1e70><ul></ul></li>
<li><a class="contents-documented" href="#pydwarf.config.json">json</a><function json at 0x5f1fb0><ul></ul></li>
<li><a class="contents-documented" href="#pydwarf.config.override">override</a><function override at 0x5f4070><ul></ul></li>
<li><a class="contents-documented" href="#pydwarf.config.setup">setup</a><function setup at 0x5f41b0><ul></ul></li>
<li><a class="contents-documented" href="#pydwarf.config.yaml">yaml</a><function yaml at 0x5f4030><ul></ul></li></ul></li>
<li><a class="contents-documented" href="#pydwarf.df">df</a><function df at 0x731430><ul></ul></li>
<li><a class="contents-documented" href="#pydwarf.df_revision_range">df_revision_range</a><function df_revision_range at 0x2b43030><ul></ul></li>
<li><a class="contents-documented" href="#pydwarf.failure">failure</a><function failure at 0x7312f0><ul></ul></li>
<li><a class="contents-documented" href="#pydwarf.findfile">findfile</a><function findfile at 0x731370><ul></ul></li>
<li><a class="contents-documented" href="#pydwarf.helpers">helpers</a><module 'pydwarf.helpers' from '/Users/pineapple/Dropbox/Projects/PyDwarf/docs/bin/../../pydwarf/helpers.pyc'><ul></ul></li>
<li><a class="contents-documented" href="#pydwarf.logger">logger</a><module 'pydwarf.logger' from '/Users/pineapple/Dropbox/Projects/PyDwarf/docs/bin/../../pydwarf/logger.pyc'><ul><li><a class="contents-documented" href="#pydwarf.logger.datetime">datetime</a><type 'datetime.datetime'><ul></ul></li></ul></li>
<li><a class="contents-documented" href="#pydwarf.quick">quick</a><function quick at 0x7313f0><ul></ul></li>
<li><a class="contents-documented" href="#pydwarf.registrar">registrar</a><class 'pydwarf.registrar.registrar'><ul><li><a class="contents-documented" href="#pydwarf.registrar.__call__">__call__</a><function __call__ at 0x731a30><ul></ul></li>
<li><a class="contents-documented" href="#pydwarf.registrar.__contains__">__contains__</a><function __contains__ at 0x731b30><ul></ul></li>
<li><a class="contents-documented" href="#pydwarf.registrar.__getattr__">__getattr__</a><function __getattr__ at 0x731bb0><ul></ul></li>
<li><a class="contents-documented" href="#pydwarf.registrar.__getitem__">__getitem__</a><function __getitem__ at 0x731ab0><ul></ul></li>
<li><a class="contents-documented" href="#pydwarf.registrar.__iadd__">__iadd__</a><function __iadd__ at 0x731c30><ul></ul></li>
<li><a class="contents-documented" href="#pydwarf.registrar.__init__">__init__</a><function __init__ at 0x7319f0><ul></ul></li>
<li><a class="contents-documented" href="#pydwarf.registrar.__iter__">__iter__</a><function __iter__ at 0x731af0><ul></ul></li>
<li><a class="contents-documented" href="#pydwarf.registrar.__len__">__len__</a><function __len__ at 0x731b70><ul></ul></li>
<li><a class="contents-documented" href="#pydwarf.registrar.__register__">__register__</a><function __register__ at 0x731c70><ul></ul></li>
<li><a class="contents-documented" href="#pydwarf.registrar.__setitem__">__setitem__</a><function __setitem__ at 0x731bf0><ul></ul></li>
<li><a class="contents-documented" href="#pydwarf.registrar.__str__">__str__</a><function __str__ at 0x731a70><ul></ul></li></ul></li>
<li><a class="contents-documented" href="#pydwarf.rel">rel</a><function rel at 0x731330><ul></ul></li>
<li><a class="contents-documented" href="#pydwarf.response">response</a><class 'pydwarf.response.response'><ul><li><a class="contents-documented" href="#pydwarf.response.__init__">__init__</a><function __init__ at 0x7311f0><ul></ul></li>
<li><a class="contents-documented" href="#pydwarf.response.__nonzero__">__nonzero__</a><function __nonzero__ at 0x731270><ul></ul></li>
<li><a class="contents-documented" href="#pydwarf.response.__str__">__str__</a><function __str__ at 0x731230><ul></ul></li></ul></li>
<li><a class="contents-documented" href="#pydwarf.session">session</a><class 'pydwarf.session.session'><ul><li><a class="contents-documented" href="#pydwarf.session.__enter__">__enter__</a><function __enter__ at 0x5f4370><ul></ul></li>
<li><a class="contents-documented" href="#pydwarf.session.__exit__">__exit__</a><function __exit__ at 0x5f43b0><ul></ul></li>
<li><a class="contents-documented" href="#pydwarf.session.__init__">__init__</a><function __init__ at 0x5f1d30><ul></ul></li>
<li><a class="contents-documented" href="#pydwarf.session.backup">backup</a><function backup at 0x5f46b0><ul></ul></li>
<li><a class="contents-documented" href="#pydwarf.session.configure">configure</a><function configure at 0x5f4330><ul></ul></li>
<li><a class="contents-documented" href="#pydwarf.session.eval">eval</a><function eval at 0x5f4570><ul></ul></li>
<li><a class="contents-documented" href="#pydwarf.session.failed">failed</a><function failed at 0x5f44f0><ul></ul></li>
<li><a class="contents-documented" href="#pydwarf.session.funcs">funcs</a><function funcs at 0x5f45b0><ul></ul></li>
<li><a class="contents-documented" href="#pydwarf.session.handle">handle</a><function handle at 0x5f45f0><ul></ul></li>
<li><a class="contents-documented" href="#pydwarf.session.handleall">handleall</a><function handleall at 0x5f4630><ul></ul></li>
<li><a class="contents-documented" href="#pydwarf.session.load">load</a><function load at 0x5f43f0><ul></ul></li>
<li><a class="contents-documented" href="#pydwarf.session.outputdir">outputdir</a><function outputdir at 0x5f4470><ul></ul></li>
<li><a class="contents-documented" href="#pydwarf.session.run">run</a><function run at 0x5f4430><ul></ul></li>
<li><a class="contents-documented" href="#pydwarf.session.successful">successful</a><function successful at 0x5f44b0><ul></ul></li>
<li><a class="contents-documented" href="#pydwarf.session.write">write</a><function write at 0x5f4670><ul></ul></li></ul></li>
<li><a class="contents-documented" href="#pydwarf.success">success</a><function success at 0x7312b0><ul></ul></li>
<li><a class="contents-documented" href="#pydwarf.urist">urist</a><class 'pydwarf.urist.urist'><ul><li><a class="contents-documented" href="#pydwarf.urist.__call__">__call__</a><function __call__ at 0x731cf0><ul></ul></li>
<li><a class="contents-documented" href="#pydwarf.urist.__init__">__init__</a><function __init__ at 0x731cb0><ul></ul></li></ul></li>
<li><a class="contents-documented" href="#pydwarf.uristdoc">uristdoc</a><module 'pydwarf.uristdoc' from '/Users/pineapple/Dropbox/Projects/PyDwarf/docs/bin/../../pydwarf/uristdoc.pyc'><ul><li><a class="contents-undocumented" href="#pydwarf.uristdoc.htmltemplate">htmltemplate</a><class 'pydwarf.uristdoc.htmltemplate'><ul><li><a class="contents-undocumented" href="#pydwarf.uristdoc.htmltemplate.__init__">__init__</a><function __init__ at 0x739df0><ul></ul></li>
<li><a class="contents-undocumented" href="#pydwarf.uristdoc.htmltemplate.arguments">arguments</a><function arguments at 0x739f30><ul></ul></li>
<li><a class="contents-undocumented" href="#pydwarf.uristdoc.htmltemplate.concat">concat</a><function concat at 0x739e70><ul></ul></li>
<li><a class="contents-undocumented" href="#pydwarf.uristdoc.htmltemplate.dependencies">dependencies</a><function dependencies at 0x739ef0><ul></ul></li>
<li><a class="contents-undocumented" href="#pydwarf.uristdoc.htmltemplate.header">header</a><function header at 0x739eb0><ul></ul></li>
<li><a class="contents-undocumented" href="#pydwarf.uristdoc.htmltemplate.metadata">metadata</a><function metadata at 0x739f70><ul></ul></li>
<li><a class="contents-undocumented" href="#pydwarf.uristdoc.htmltemplate.preprocesstext">preprocesstext</a><function preprocesstext at 0x739e30><ul></ul></li></ul></li>
<li><a class="contents-undocumented" href="#pydwarf.uristdoc.mdtemplate">mdtemplate</a><class 'pydwarf.uristdoc.mdtemplate'><ul><li><a class="contents-undocumented" href="#pydwarf.uristdoc.mdtemplate.__init__">__init__</a><function __init__ at 0x739c30><ul></ul></li>
<li><a class="contents-undocumented" href="#pydwarf.uristdoc.mdtemplate.arguments">arguments</a><function arguments at 0x739d70><ul></ul></li>
<li><a class="contents-undocumented" href="#pydwarf.uristdoc.mdtemplate.concat">concat</a><function concat at 0x739cb0><ul></ul></li>
<li><a class="contents-undocumented" href="#pydwarf.uristdoc.mdtemplate.dependencies">dependencies</a><function dependencies at 0x739d30><ul></ul></li>
<li><a class="contents-undocumented" href="#pydwarf.uristdoc.mdtemplate.header">header</a><function header at 0x739cf0><ul></ul></li>
<li><a class="contents-undocumented" href="#pydwarf.uristdoc.mdtemplate.metadata">metadata</a><function metadata at 0x739db0><ul></ul></li>
<li><a class="contents-undocumented" href="#pydwarf.uristdoc.mdtemplate.preprocesstext">preprocesstext</a><function preprocesstext at 0x739c70><ul></ul></li></ul></li>
<li><a class="contents-undocumented" href="#pydwarf.uristdoc.txttemplate">txttemplate</a><class 'pydwarf.uristdoc.txttemplate'><ul><li><a class="contents-undocumented" href="#pydwarf.uristdoc.txttemplate.__init__">__init__</a><function __init__ at 0x739af0><ul></ul></li>
<li><a class="contents-undocumented" href="#pydwarf.uristdoc.txttemplate.arguments">arguments</a><function arguments at 0x739bb0><ul></ul></li>
<li><a class="contents-undocumented" href="#pydwarf.uristdoc.txttemplate.dependencies">dependencies</a><function dependencies at 0x739b70><ul></ul></li>
<li><a class="contents-undocumented" href="#pydwarf.uristdoc.txttemplate.header">header</a><function header at 0x739b30><ul></ul></li>
<li><a class="contents-undocumented" href="#pydwarf.uristdoc.txttemplate.metadata">metadata</a><function metadata at 0x739bf0><ul></ul></li></ul></li></ul></li>
<li><a class="contents-documented" href="#pydwarf.uristscript">uristscript</a><class 'pydwarf.uristscript.uristscript'><ul><li><a class="contents-documented" href="#pydwarf.uristscript.__call__">__call__</a><function __call__ at 0x739170><ul></ul></li>
<li><a class="contents-documented" href="#pydwarf.uristscript.__hash__">__hash__</a><function __hash__ at 0x7391f0><ul></ul></li>
<li><a class="contents-documented" href="#pydwarf.uristscript.__init__">__init__</a><function __init__ at 0x739130><ul></ul></li>
<li><a class="contents-documented" href="#pydwarf.uristscript.__str__">__str__</a><function __str__ at 0x7391b0><ul></ul></li>
<li><a class="contents-documented" href="#pydwarf.uristscript.depsatisfied">depsatisfied</a><function depsatisfied at 0x739370><ul></ul></li>
<li><a class="contents-documented" href="#pydwarf.uristscript.doc">doc</a><function doc at 0x7393f0><ul></ul></li>
<li><a class="contents-documented" href="#pydwarf.uristscript.getname">getname</a><function getname at 0x7392b0><ul></ul></li>
<li><a class="contents-documented" href="#pydwarf.uristscript.matches">matches</a><function matches at 0x739330><ul></ul></li>
<li><a class="contents-documented" href="#pydwarf.uristscript.meta">meta</a><function meta at 0x7392f0><ul></ul></li>
<li><a class="contents-documented" href="#pydwarf.uristscript.setname">setname</a><function setname at 0x739270><ul></ul></li>
<li><a class="contents-documented" href="#pydwarf.uristscript.within">within</a><function within at 0x739230><ul></ul></li></ul></li>
<li><a class="contents-documented" href="#pydwarf.version">version</a><module 'pydwarf.version' from '/Users/pineapple/Dropbox/Projects/PyDwarf/docs/bin/../../pydwarf/version.pyc'><ul></ul></li></ul></li>
<li><a class="contents-undocumented" href="#raws">raws</a><module 'raws' from '/Users/pineapple/Dropbox/Projects/PyDwarf/docs/bin/../../raws/__init__.pyc'><ul><li><a class="contents-documented" href="#raws.basefile">basefile</a><class 'raws.basefile.basefile'><ul><li><a class="contents-undocumented" href="#raws.basefile.__eq__">__eq__</a><function __eq__ at 0x5a02b0><ul></ul></li>
<li><a class="contents-undocumented" href="#raws.basefile.__ge__">__ge__</a><function __ge__ at 0x5a0370><ul></ul></li>
<li><a class="contents-undocumented" href="#raws.basefile.__gt__">__gt__</a><function __gt__ at 0x5a0330><ul></ul></li>
<li><a class="contents-documented" href="#raws.basefile.__hash__">__hash__</a><function __hash__ at 0x5a0270><ul></ul></li>
<li><a class="contents-documented" href="#raws.basefile.__init__">__init__</a><function __init__ at 0x5a01f0><ul></ul></li>
<li><a class="contents-undocumented" href="#raws.basefile.__le__">__le__</a><function __le__ at 0x5a03f0><ul></ul></li>
<li><a class="contents-undocumented" href="#raws.basefile.__lt__">__lt__</a><function __lt__ at 0x5a03b0><ul></ul></li>
<li><a class="contents-undocumented" href="#raws.basefile.__ne__">__ne__</a><function __ne__ at 0x5a02f0><ul></ul></li>
<li><a class="contents-documented" href="#raws.basefile.__str__">__str__</a><function __str__ at 0x5a0230><ul></ul></li>
<li><a class="contents-documented" href="#raws.basefile.getext">getext</a><function getext at 0x5a0530><ul></ul></li>
<li><a class="contents-documented" href="#raws.basefile.getloc">getloc</a><function getloc at 0x5a05b0><ul></ul></li>
<li><a class="contents-documented" href="#raws.basefile.getname">getname</a><function getname at 0x5a04b0><ul></ul></li>
<li><a class="contents-documented" href="#raws.basefile.getpath">getpath</a><function getpath at 0x5a0430><ul></ul></li>
<li><a class="contents-documented" href="#raws.basefile.reloc">reloc</a><function reloc at 0x5a0630><ul></ul></li>
<li><a class="contents-documented" href="#raws.basefile.remove">remove</a><function remove at 0x5a06b0><ul></ul></li>
<li><a class="contents-documented" href="#raws.basefile.setext">setext</a><function setext at 0x5a0570><ul></ul></li>
<li><a class="contents-documented" href="#raws.basefile.setloc">setloc</a><function setloc at 0x5a05f0><ul></ul></li>
<li><a class="contents-documented" href="#raws.basefile.setname">setname</a><function setname at 0x5a04f0><ul></ul></li>
<li><a class="contents-documented" href="#raws.basefile.setpath">setpath</a><function setpath at 0x5a0470><ul></ul></li></ul></li>
<li><a class="contents-documented" href="#raws.basefilter">basefilter</a><class 'raws.filters.basefilter'><ul><li><a class="contents-documented" href="#raws.basefilter.__and__">__and__</a><function __and__ at 0x58b970><ul></ul></li>
<li><a class="contents-documented" href="#raws.basefilter.__call__">__call__</a><function __call__ at 0x58bab0><ul></ul></li>
<li><a class="contents-documented" href="#raws.basefilter.__contains__">__contains__</a><function __contains__ at 0x58ba70><ul></ul></li>
<li><a class="contents-documented" href="#raws.basefilter.__init__">__init__</a><function __init__ at 0x58b7b0><ul></ul></li>
<li><a class="contents-documented" href="#raws.basefilter.__invert__">__invert__</a><function __invert__ at 0x58ba30><ul></ul></li>
<li><a class="contents-documented" href="#raws.basefilter.__or__">__or__</a><function __or__ at 0x58b9b0><ul></ul></li>
<li><a class="contents-documented" href="#raws.basefilter.__xor__">__xor__</a><function __xor__ at 0x58b9f0><ul></ul></li>
<li><a class="contents-documented" href="#raws.basefilter.copy">copy</a><function copy at 0x58b8b0><ul></ul></li>
<li><a class="contents-documented" href="#raws.basefilter.eval">eval</a><function eval at 0x58b930><ul></ul></li>
<li><a class="contents-documented" href="#raws.basefilter.invert">invert</a><function invert at 0x58b7f0><ul></ul></li>
<li><a class="contents-documented" href="#raws.basefilter.inverted">inverted</a><function inverted at 0x58b8f0><ul></ul></li>
<li><a class="contents-documented" href="#raws.basefilter.match">match</a><function match at 0x58b830><ul></ul></li></ul></li>
<li><a class="contents-documented" href="#raws.binfile">binfile</a><class 'raws.binfile.binfile'><ul><li><a class="contents-documented" href="#raws.binfile.__iadd__">__iadd__</a><function __iadd__ at 0x5a4430><ul></ul></li>
<li><a class="contents-documented" href="#raws.binfile.__init__">__init__</a><function __init__ at 0x5a43b0><ul></ul></li>
<li><a class="contents-documented" href="#raws.binfile.__len__">__len__</a><function __len__ at 0x5a43f0><ul></ul></li>
<li><a class="contents-documented" href="#raws.binfile.add">add</a><function add at 0x5a4570><ul></ul></li>
<li><a class="contents-undocumented" href="#raws.binfile.bin">bin</a><function bin at 0x5a44b0><ul></ul></li>
<li><a class="contents-documented" href="#raws.binfile.copy">copy</a><function copy at 0x5a4530><ul></ul></li>
<li><a class="contents-undocumented" href="#raws.binfile.raw">raw</a><function raw at 0x5a44f0><ul></ul></li>
<li><a class="contents-undocumented" href="#raws.binfile.ref">ref</a><function ref at 0x5a4470><ul></ul></li></ul></li>
<li><a class="contents-documented" href="#raws.boolfilter">boolfilter</a><class 'raws.filters.boolfilter'><ul><li><a class="contents-documented" href="#raws.boolfilter.__init__">__init__</a><function __init__ at 0x58bcb0><ul></ul></li>
<li><a class="contents-documented" href="#raws.boolfilter.__str__">__str__</a><function __str__ at 0x58be30><ul></ul></li></ul></li>
<li><a class="contents-documented" href="#raws.color">color</a><module 'raws.color' from '/Users/pineapple/Dropbox/Projects/PyDwarf/docs/bin/../../raws/color.pyc'><ul><li><a class="contents-documented" href="#raws.color.bg">bg</a><function bg at 0x7040f0><ul></ul></li>
<li><a class="contents-documented" href="#raws.color.fg">fg</a><function fg at 0x7040b0><ul></ul></li>
<li><a class="contents-documented" href="#raws.color.get">get</a><function get at 0x704070><ul></ul></li>
<li><a class="contents-documented" href="#raws.color.group">group</a><function group at 0x704130><ul></ul></li>
<li><a class="contents-documented" href="#raws.color.record">record</a><class raws.color.record at 0x5a8fb8><ul><li><a class="contents-undocumented" href="#raws.color.record.__add__">__add__</a><function __add__ at 0x702ef0><ul></ul></li>
<li><a class="contents-documented" href="#raws.color.record.__call__">__call__</a><function __call__ at 0x702d30><ul></ul></li>
<li><a class="contents-undocumented" href="#raws.color.record.__div__">__div__</a><function __div__ at 0x702fb0><ul></ul></li>
<li><a class="contents-undocumented" href="#raws.color.record.__eq__">__eq__</a><function __eq__ at 0x702e70><ul></ul></li>
<li><a class="contents-documented" href="#raws.color.record.__init__">__init__</a><function __init__ at 0x702cf0><ul></ul></li>
<li><a class="contents-documented" href="#raws.color.record.__int__">__int__</a><function __int__ at 0x702d70><ul></ul></li>
<li><a class="contents-undocumented" href="#raws.color.record.__mod__">__mod__</a><function __mod__ at 0x704030><ul></ul></li>
<li><a class="contents-undocumented" href="#raws.color.record.__mul__">__mul__</a><function __mul__ at 0x702f70><ul></ul></li>
<li><a class="contents-undocumented" href="#raws.color.record.__ne__">__ne__</a><function __ne__ at 0x702eb0><ul></ul></li>
<li><a class="contents-documented" href="#raws.color.record.__str__">__str__</a><function __str__ at 0x702db0><ul></ul></li>
<li><a class="contents-undocumented" href="#raws.color.record.__sub__">__sub__</a><function __sub__ at 0x702f30><ul></ul></li>
<li><a class="contents-documented" href="#raws.color.record.bg">bg</a><function bg at 0x702e30><ul></ul></li>
<li><a class="contents-documented" href="#raws.color.record.fg">fg</a><function fg at 0x702df0><ul></ul></li></ul></li></ul></li>
<li><a class="contents-documented" href="#raws.contentfile">contentfile</a><class 'raws.contentfile.contentfile'><ul><li><a class="contents-undocumented" href="#raws.contentfile.__init__">__init__</a><function __init__ at 0x5a0730><ul></ul></li>
<li><a class="contents-documented" href="#raws.contentfile.getcontent">getcontent</a><function getcontent at 0x5a0770><ul></ul></li>
<li><a class="contents-documented" href="#raws.contentfile.read">read</a><function read at 0x5a07f0><ul></ul></li>
<li><a class="contents-documented" href="#raws.contentfile.setcontent">setcontent</a><function setcontent at 0x5a07b0><ul></ul></li>
<li><a class="contents-documented" href="#raws.contentfile.write">write</a><function write at 0x5a0830><ul></ul></li></ul></li>
<li><a class="contents-documented" href="#raws.copy">copy</a><function copy at 0x581770><ul></ul></li>
<li><a class="contents-undocumented" href="#raws.copytree">copytree</a><function copytree at 0x5a4330><ul></ul></li>
<li><a class="contents-documented" href="#raws.dir">dir</a><class 'raws.dir.dir'><ul><li><a class="contents-documented" href="#raws.dir.__contains__">__contains__</a><function __contains__ at 0x702270><ul></ul></li>
<li><a class="contents-documented" href="#raws.dir.__delitem__">__delitem__</a><function __delitem__ at 0x702430><ul></ul></li>
<li><a class="contents-documented" href="#raws.dir.__enter__">__enter__</a><function __enter__ at 0x702170><ul></ul></li>
<li><a class="contents-documented" href="#raws.dir.__eq__">__eq__</a><function __eq__ at 0x702330><ul></ul></li>
<li><a class="contents-documented" href="#raws.dir.__exit__">__exit__</a><function __exit__ at 0x7021b0><ul></ul></li>
<li><a class="contents-documented" href="#raws.dir.__getitem__">__getitem__</a><function __getitem__ at 0x7021f0><ul></ul></li>
<li><a class="contents-documented" href="#raws.dir.__iadd__">__iadd__</a><function __iadd__ at 0x7023b0><ul></ul></li>
<li><a class="contents-documented" href="#raws.dir.__init__">__init__</a><function __init__ at 0x7020f0><ul></ul></li>
<li><a class="contents-documented" href="#raws.dir.__isub__">__isub__</a><function __isub__ at 0x7023f0><ul></ul></li>
<li><a class="contents-documented" href="#raws.dir.__iter__">__iter__</a><function __iter__ at 0x702470><ul></ul></li>
<li><a class="contents-documented" href="#raws.dir.__len__">__len__</a><function __len__ at 0x7022b0><ul></ul></li>
<li><a class="contents-documented" href="#raws.dir.__ne__">__ne__</a><function __ne__ at 0x702370><ul></ul></li>
<li><a class="contents-documented" href="#raws.dir.__nonzero__">__nonzero__</a><function __nonzero__ at 0x7022f0><ul></ul></li>
<li><a class="contents-documented" href="#raws.dir.__setitem__">__setitem__</a><function __setitem__ at 0x702230><ul></ul></li>
<li><a class="contents-documented" href="#raws.dir.__str__">__str__</a><function __str__ at 0x702130><ul></ul></li>
<li><a class="contents-documented" href="#raws.dir.add">add</a><function add at 0x702570><ul></ul></li>
<li><a class="contents-documented" href="#raws.dir.clean">clean</a><function clean at 0x702ab0><ul></ul></li>
<li><a class="contents-documented" href="#raws.dir.clear">clear</a><function clear at 0x702b30><ul></ul></li>
<li><a class="contents-documented" href="#raws.dir.copy">copy</a><function copy at 0x702af0><ul></ul></li>
<li><a class="contents-documented" href="#raws.dir.equals">equals</a><function equals at 0x7024b0><ul></ul></li>
<li><a class="contents-documented" href="#raws.dir.getfile">getfile</a><function getfile at 0x7024f0><ul></ul></li>
<li><a class="contents-documented" href="#raws.dir.getobjheaders">getobjheaders</a><function getobjheaders at 0x702c30><ul></ul></li>
<li><a class="contents-documented" href="#raws.dir.iterfiles">iterfiles</a><function iterfiles at 0x702530><ul></ul></li>
<li><a class="contents-documented" href="#raws.dir.itokens">itokens</a><function itokens at 0x702bf0><ul></ul></li>
<li><a class="contents-documented" href="#raws.dir.read">read</a><function read at 0x702a30><ul></ul></li>
<li><a class="contents-documented" href="#raws.dir.remove">remove</a><function remove at 0x702970><ul></ul></li>
<li><a class="contents-documented" href="#raws.dir.reset">reset</a><function reset at 0x702b70><ul></ul></li>
<li><a class="contents-documented" href="#raws.dir.write">write</a><function write at 0x702a70><ul></ul></li></ul></li>
<li><a class="contents-documented" href="#raws.ends">ends</a><function ends at 0x5817f0><ul></ul></li>
<li><a class="contents-documented" href="#raws.equal">equal</a><function equal at 0x5817b0><ul></ul></li>
<li><a class="contents-undocumented" href="#raws.filefactory">filefactory</a><function filefactory at 0x5a4d30><ul></ul></li>
<li><a class="contents-undocumented" href="#raws.filters">filters</a><module 'raws.filters' from '/Users/pineapple/Dropbox/Projects/PyDwarf/docs/bin/../../raws/filters.pyc'><ul></ul></li>
<li><a class="contents-undocumented" href="#raws.helpers">helpers</a><module 'raws.helpers' from '/Users/pineapple/Dropbox/Projects/PyDwarf/docs/bin/../../raws/helpers.pyc'><ul><li><a class="contents-documented" href="#raws.helpers.copytokens">copytokens</a><function copytokens at 0x581870><ul></ul></li>
<li><a class="contents-documented" href="#raws.helpers.tokensequal">tokensequal</a><function tokensequal at 0x581930><ul></ul></li>
<li><a class="contents-documented" href="#raws.helpers.tokensstring">tokensstring</a><function tokensstring at 0x581830><ul></ul></li></ul></li>
<li><a class="contents-undocumented" href="#raws.objects">objects</a><module 'raws.objects' from '/Users/pineapple/Dropbox/Projects/PyDwarf/docs/bin/../../raws/objects.pyc'><ul><li><a class="contents-documented" href="#raws.objects.headerdict">headerdict</a><function headerdict at 0x581430><ul></ul></li>
<li><a class="contents-documented" href="#raws.objects.headerforobject">headerforobject</a><function headerforobject at 0x5814b0><ul></ul></li>
<li><a class="contents-documented" href="#raws.objects.headers">headers</a><function headers at 0x5813b0><ul></ul></li>
<li><a class="contents-documented" href="#raws.objects.objectdict">objectdict</a><function objectdict at 0x581470><ul></ul></li>
<li><a class="contents-documented" href="#raws.objects.objects">objects</a><function objects at 0x5813f0><ul></ul></li>
<li><a class="contents-documented" href="#raws.objects.objectsforheader">objectsforheader</a><function objectsforheader at 0x5814f0><ul></ul></li></ul></li>
<li><a class="contents-documented" href="#raws.parseplural">parseplural</a><function parseplural at 0x581570><ul></ul></li>
<li><a class="contents-documented" href="#raws.parsesingular">parsesingular</a><function parsesingular at 0x5815b0><ul></ul></li>
<li><a class="contents-undocumented" href="#raws.parsevariable">parsevariable</a><function parsevariable at 0x5815f0><ul></ul></li>
<li><a class="contents-documented" href="#raws.queryable">queryable</a><class 'raws.queryable.queryable'><ul><li><a class="contents-documented" href="#raws.queryable.__contains__">__contains__</a><function __contains__ at 0x7663f0><ul></ul></li>
<li><a class="contents-documented" href="#raws.queryable.__eq__">__eq__</a><function __eq__ at 0x766430><ul></ul></li>
<li><a class="contents-documented" href="#raws.queryable.__getitem__">__getitem__</a><function __getitem__ at 0x766530><ul></ul></li>
<li><a class="contents-documented" href="#raws.queryable.__iter__">__iter__</a><function __iter__ at 0x766370><ul></ul></li>
<li><a class="contents-documented" href="#raws.queryable.__ne__">__ne__</a><function __ne__ at 0x766470><ul></ul></li>
<li><a class="contents-documented" href="#raws.queryable.__reversed__">__reversed__</a><function __reversed__ at 0x7664f0><ul></ul></li>
<li><a class="contents-documented" href="#raws.queryable.__str__">__str__</a><function __str__ at 0x7664b0><ul></ul></li>
<li><a class="contents-documented" href="#raws.queryable.all">all</a><function all at 0x766030><ul></ul></li>
<li><a class="contents-documented" href="#raws.queryable.each">each</a><function each at 0x766a30><ul></ul></li>
<li><a class="contents-documented" href="#raws.queryable.equals">equals</a><function equals at 0x766a70><ul></ul></li>
<li><a class="contents-documented" href="#raws.queryable.get">get</a><function get at 0x766bb0><ul></ul></li>
<li><a class="contents-documented" href="#raws.queryable.getitem">getitem</a><function getitem at 0x766570><ul></ul></li>
<li><a class="contents-documented" href="#raws.queryable.last">last</a><function last at 0x766b70><ul></ul></li>
<li><a class="contents-documented" href="#raws.queryable.list">list</a><function list at 0x7669f0><ul></ul></li>
<li><a class="contents-documented" href="#raws.queryable.query">query</a><function query at 0x7668f0><ul></ul></li>
<li><a class="contents-documented" href="#raws.queryable.removeall">removeall</a><function removeall at 0x766b30><ul></ul></li>
<li><a class="contents-documented" href="#raws.queryable.removefirst">removefirst</a><function removefirst at 0x766ab0><ul></ul></li>
<li><a class="contents-documented" href="#raws.queryable.removelast">removelast</a><function removelast at 0x766af0><ul></ul></li>
<li><a class="contents-documented" href="#raws.queryable.slice">slice</a><function slice at 0x766830><ul></ul></li>
<li><a class="contents-documented" href="#raws.queryable.tokens">tokens</a><function tokens at 0x7669b0><ul></ul></li></ul></li>
<li><a class="contents-undocumented" href="#raws.queryableadd">queryableadd</a><class 'raws.queryableadd.queryableadd'><ul><li><a class="contents-documented" href="#raws.queryableadd.set">set</a><function set at 0x76e630><ul></ul></li>
<li><a class="contents-documented" href="#raws.queryableadd.setall">setall</a><function setall at 0x76e6b0><ul></ul></li>
<li><a class="contents-documented" href="#raws.queryableadd.setlast">setlast</a><function setlast at 0x76e670><ul></ul></li></ul></li>
<li><a class="contents-undocumented" href="#raws.queryableaddprop">queryableaddprop</a><class 'raws.queryableaddprop.queryableaddprop'><ul><li><a class="contents-documented" href="#raws.queryableaddprop.addprop">addprop</a><function addprop at 0x76edf0><ul></ul></li>
<li><a class="contents-undocumented" href="#raws.queryableaddprop.setallprop">setallprop</a><function setallprop at 0x76eeb0><ul></ul></li>
<li><a class="contents-undocumented" href="#raws.queryableaddprop.setlastprop">setlastprop</a><function setlastprop at 0x76ee70><ul></ul></li>
<li><a class="contents-documented" href="#raws.queryableaddprop.setprop">setprop</a><function setprop at 0x76ee30><ul></ul></li></ul></li>
<li><a class="contents-undocumented" href="#raws.queryableobj">queryableobj</a><class 'raws.queryableobj.queryableobj'><ul><li><a class="contents-documented" href="#raws.queryableobj.allobj">allobj</a><function allobj at 0x5a0030><ul></ul></li>
<li><a class="contents-documented" href="#raws.queryableobj.getobj">getobj</a><function getobj at 0x58bf70><ul></ul></li>
<li><a class="contents-undocumented" href="#raws.queryableobj.getobjheadername">getobjheadername</a><function getobjheadername at 0x58be70><ul></ul></li>
<li><a class="contents-undocumented" href="#raws.queryableobj.headersfortype">headersfortype</a><function headersfortype at 0x58beb0><ul></ul></li>
<li><a class="contents-documented" href="#raws.queryableobj.lastobj">lastobj</a><function lastobj at 0x58bfb0><ul></ul></li>
<li><a class="contents-documented" href="#raws.queryableobj.objdict">objdict</a><function objdict at 0x5a0070><ul></ul></li>
<li><a class="contents-undocumented" href="#raws.queryableobj.removeallobj">removeallobj</a><function removeallobj at 0x58bf30><ul></ul></li>
<li><a class="contents-undocumented" href="#raws.queryableobj.removeobj">removeobj</a><function removeobj at 0x58bef0><ul></ul></li></ul></li>
<li><a class="contents-undocumented" href="#raws.queryableprop">queryableprop</a><class 'raws.queryableprop.queryableprop'><ul><li><a class="contents-documented" href="#raws.queryableprop.allprop">allprop</a><function allprop at 0x76ecb0><ul></ul></li>
<li><a class="contents-documented" href="#raws.queryableprop.getprop">getprop</a><function getprop at 0x76ec30><ul></ul></li>
<li><a class="contents-documented" href="#raws.queryableprop.lastprop">lastprop</a><function lastprop at 0x76ec70><ul></ul></li>
<li><a class="contents-documented" href="#raws.queryableprop.removeallprop">removeallprop</a><function removeallprop at 0x76edb0><ul></ul></li>
<li><a class="contents-documented" href="#raws.queryableprop.removelastprop">removelastprop</a><function removelastprop at 0x76ed70><ul></ul></li>
<li><a class="contents-documented" href="#raws.queryableprop.removeprop">removeprop</a><function removeprop at 0x76ed30><ul></ul></li></ul></li>
<li><a class="contents-undocumented" href="#raws.queryresult">queryresult</a><class 'raws.queryresult.queryresult'><ul><li><a class="contents-undocumented" href="#raws.queryresult.__getitem__">__getitem__</a><function __getitem__ at 0x766d30><ul></ul></li>
<li><a class="contents-undocumented" href="#raws.queryresult.__init__">__init__</a><function __init__ at 0x766cb0><ul></ul></li>
<li><a class="contents-undocumented" href="#raws.queryresult.__iter__">__iter__</a><function __iter__ at 0x766cf0><ul></ul></li>
<li><a class="contents-undocumented" href="#raws.queryresult.__len__">__len__</a><function __len__ at 0x766d70><ul></ul></li>
<li><a class="contents-undocumented" href="#raws.queryresult.each">each</a><function each at 0x766df0><ul></ul></li>
<li><a class="contents-undocumented" href="#raws.queryresult.itokens">itokens</a><function itokens at 0x766db0><ul></ul></li></ul></li>
<li><a class="contents-documented" href="#raws.rawfile">rawfile</a><class 'raws.rawfile.rawfile'><ul><li><a class="contents-documented" href="#raws.rawfile.__enter__">__enter__</a><function __enter__ at 0x5a47f0><ul></ul></li>
<li><a class="contents-documented" href="#raws.rawfile.__exit__">__exit__</a><function __exit__ at 0x5a4830><ul></ul></li>
<li><a class="contents-documented" href="#raws.rawfile.__iadd__">__iadd__</a><function __iadd__ at 0x5a48f0><ul></ul></li>
<li><a class="contents-documented" href="#raws.rawfile.__init__">__init__</a><function __init__ at 0x5a4770><ul></ul></li>
<li><a class="contents-documented" href="#raws.rawfile.__len__">__len__</a><function __len__ at 0x5a4870><ul></ul></li>
<li><a class="contents-documented" href="#raws.rawfile.__nonzero__">__nonzero__</a><function __nonzero__ at 0x5a48b0><ul></ul></li>
<li><a class="contents-documented" href="#raws.rawfile.add">add</a><function add at 0x5a4c30><ul></ul></li>
<li><a class="contents-undocumented" href="#raws.rawfile.bin">bin</a><function bin at 0x5a49f0><ul></ul></li>
<li><a class="contents-documented" href="#raws.rawfile.clear">clear</a><function clear at 0x5a4cb0><ul></ul></li>
<li><a class="contents-documented" href="#raws.rawfile.copy">copy</a><function copy at 0x5a4af0><ul></ul></li>
<li><a class="contents-documented" href="#raws.rawfile.getcontent">getcontent</a><function getcontent at 0x5a4930><ul></ul></li>
<li><a class="contents-undocumented" href="#raws.rawfile.getobjheaders">getobjheaders</a><function getobjheaders at 0x5a4cf0><ul></ul></li>
<li><a class="contents-documented" href="#raws.rawfile.index">index</a><function index at 0x5a4a70><ul></ul></li>
<li><a class="contents-documented" href="#raws.rawfile.itokens">itokens</a><function itokens at 0x5a4bb0><ul></ul></li>
<li><a class="contents-documented" href="#raws.rawfile.length">length</a><function length at 0x5a4c70><ul></ul></li>
<li><a class="contents-undocumented" href="#raws.rawfile.raw">raw</a><function raw at 0x5a4a30><ul></ul></li>
<li><a class="contents-documented" href="#raws.rawfile.read">read</a><function read at 0x5a4bf0><ul></ul></li>
<li><a class="contents-undocumented" href="#raws.rawfile.ref">ref</a><function ref at 0x5a49b0><ul></ul></li>
<li><a class="contents-documented" href="#raws.rawfile.root">root</a><function root at 0x5a4b30><ul></ul></li>
<li><a class="contents-documented" href="#raws.rawfile.setcontent">setcontent</a><function setcontent at 0x5a4970><ul></ul></li>
<li><a class="contents-documented" href="#raws.rawfile.tail">tail</a><function tail at 0x5a4b70><ul></ul></li></ul></li>
<li><a class="contents-undocumented" href="#raws.reffile">reffile</a><class 'raws.reffile.reffile'><ul><li><a class="contents-undocumented" href="#raws.reffile.__init__">__init__</a><function __init__ at 0x5a41b0><ul></ul></li>
<li><a class="contents-undocumented" href="#raws.reffile.bin">bin</a><function bin at 0x5a4270><ul></ul></li>
<li><a class="contents-undocumented" href="#raws.reffile.copy">copy</a><function copy at 0x5a41f0><ul></ul></li>
<li><a class="contents-undocumented" href="#raws.reffile.raw">raw</a><function raw at 0x5a42b0><ul></ul></li>
<li><a class="contents-undocumented" href="#raws.reffile.ref">ref</a><function ref at 0x5a4230><ul></ul></li>
<li><a class="contents-undocumented" href="#raws.reffile.write">write</a><function write at 0x5a42f0><ul></ul></li></ul></li>
<li><a class="contents-undocumented" href="#raws.token">token</a><class 'raws.token.token'><ul><li><a class="contents-documented" href="#raws.token.__add__">__add__</a><function __add__ at 0x77f930><ul></ul></li>
<li><a class="contents-documented" href="#raws.token.__contains__">__contains__</a><function __contains__ at 0x77fa70><ul></ul></li>
<li><a class="contents-documented" href="#raws.token.__eq__">__eq__</a><function __eq__ at 0x77f7b0><ul></ul></li>
<li><a class="contents-documented" href="#raws.token.__ge__">__ge__</a><function __ge__ at 0x77f8f0><ul></ul></li>
<li><a class="contents-documented" href="#raws.token.__gt__">__gt__</a><function __gt__ at 0x77f870><ul></ul></li>
<li><a class="contents-documented" href="#raws.token.__hash__">__hash__</a><function __hash__ at 0x77f730><ul></ul></li>
<li><a class="contents-documented" href="#raws.token.__iadd__">__iadd__</a><function __iadd__ at 0x77fab0><ul></ul></li>
<li><a class="contents-documented" href="#raws.token.__init__">__init__</a><function __init__ at 0x77f6f0><ul></ul></li>
<li><a class="contents-documented" href="#raws.token.__isub__">__isub__</a><function __isub__ at 0x77faf0><ul></ul></li>
<li><a class="contents-documented" href="#raws.token.__iter__">__iter__</a><function __iter__ at 0x77f9f0><ul></ul></li>
<li><a class="contents-documented" href="#raws.token.__le__">__le__</a><function __le__ at 0x77f8b0><ul></ul></li>
<li><a class="contents-documented" href="#raws.token.__len__">__len__</a><function __len__ at 0x77fa30><ul></ul></li>
<li><a class="contents-documented" href="#raws.token.__lt__">__lt__</a><function __lt__ at 0x77f830><ul></ul></li>
<li><a class="contents-documented" href="#raws.token.__mul__">__mul__</a><function __mul__ at 0x77f9b0><ul></ul></li>
<li><a class="contents-documented" href="#raws.token.__ne__">__ne__</a><function __ne__ at 0x77f7f0><ul></ul></li>
<li><a class="contents-documented" href="#raws.token.__nonzero__">__nonzero__</a><function __nonzero__ at 0x77fb30><ul></ul></li>
<li><a class="contents-documented" href="#raws.token.__radd__">__radd__</a><function __radd__ at 0x77f970><ul></ul></li>
<li><a class="contents-documented" href="#raws.token.__str__">__str__</a><function __str__ at 0x77f770><ul></ul></li>
<li><a class="contents-documented" href="#raws.token.add">add</a><function add at 0x5811f0><ul></ul></li>
<li><a class="contents-documented" href="#raws.token.arg">arg</a><function arg at 0x5810f0><ul></ul></li>
<li><a class="contents-documented" href="#raws.token.copy">copy</a><function copy at 0x581170><ul></ul></li>
<li><a class="contents-documented" href="#raws.token.equals">equals</a><function equals at 0x581130><ul></ul></li>
<li><a class="contents-documented" href="#raws.token.follows">follows</a><function follows at 0x77fdf0><ul></ul></li>
<li><a class="contents-documented" href="#raws.token.fullstr">fullstr</a><function fullstr at 0x77fd70><ul></ul></li>
<li><a class="contents-documented" href="#raws.token.getargs">getargs</a><function getargs at 0x77fef0><ul></ul></li>
<li><a class="contents-documented" href="#raws.token.getprefix">getprefix</a><function getprefix at 0x77ffb0><ul></ul></li>
<li><a class="contents-documented" href="#raws.token.getsuffix">getsuffix</a><function getsuffix at 0x581070><ul></ul></li>
<li><a class="contents-documented" href="#raws.token.getvalue">getvalue</a><function getvalue at 0x77ff30><ul></ul></li>
<li><a class="contents-documented" href="#raws.token.index">index</a><function index at 0x77fdb0><ul></ul></li>
<li><a class="contents-documented" href="#raws.token.itokens">itokens</a><function itokens at 0x5811b0><ul></ul></li>
<li><a class="contents-documented" href="#raws.token.nargs">nargs</a><function nargs at 0x77fe70><ul></ul></li>
<li><a class="contents-documented" href="#raws.token.remove">remove</a><function remove at 0x5812f0><ul></ul></li>
<li><a class="contents-documented" href="#raws.token.removeselfandprops">removeselfandprops</a><function removeselfandprops at 0x581330><ul></ul></li>
<li><a class="contents-documented" href="#raws.token.setargs">setargs</a><function setargs at 0x77feb0><ul></ul></li>
<li><a class="contents-documented" href="#raws.token.setprefix">setprefix</a><function setprefix at 0x581030><ul></ul></li>
<li><a class="contents-documented" href="#raws.token.setsuffix">setsuffix</a><function setsuffix at 0x5810b0><ul></ul></li>
<li><a class="contents-documented" href="#raws.token.setvalue">setvalue</a><function setvalue at 0x77ff70><ul></ul></li>
<li><a class="contents-documented" href="#raws.token.shortstr">shortstr</a><function shortstr at 0x77fd30><ul></ul></li>
<li><a class="contents-documented" href="#raws.token.strip">strip</a><function strip at 0x77fe30><ul></ul></li></ul></li>
<li><a class="contents-documented" href="#raws.tokenargs">tokenargs</a><class 'raws.tokenargs.tokenargs'><ul><li><a class="contents-documented" href="#raws.tokenargs.__add__">__add__</a><function __add__ at 0x77f1b0><ul></ul></li>
<li><a class="contents-documented" href="#raws.tokenargs.__contains__">__contains__</a><function __contains__ at 0x77f2b0><ul></ul></li>
<li><a class="contents-documented" href="#raws.tokenargs.__delitem__">__delitem__</a><function __delitem__ at 0x77f130><ul></ul></li>
<li><a class="contents-documented" href="#raws.tokenargs.__eq__">__eq__</a><function __eq__ at 0x77f3f0><ul></ul></li>
<li><a class="contents-documented" href="#raws.tokenargs.__getitem__">__getitem__</a><function __getitem__ at 0x77f0f0><ul></ul></li>
<li><a class="contents-documented" href="#raws.tokenargs.__iadd__">__iadd__</a><function __iadd__ at 0x77f230><ul></ul></li>
<li><a class="contents-documented" href="#raws.tokenargs.__imul__">__imul__</a><function __imul__ at 0x77f3b0><ul></ul></li>
<li><a class="contents-documented" href="#raws.tokenargs.__init__">__init__</a><function __init__ at 0x77f070><ul></ul></li>
<li><a class="contents-documented" href="#raws.tokenargs.__isub__">__isub__</a><function __isub__ at 0x77f270><ul></ul></li>
<li><a class="contents-documented" href="#raws.tokenargs.__iter__">__iter__</a><function __iter__ at 0x77f2f0><ul></ul></li>
<li><a class="contents-documented" href="#raws.tokenargs.__len__">__len__</a><function __len__ at 0x77f330><ul></ul></li>
<li><a class="contents-documented" href="#raws.tokenargs.__mul__">__mul__</a><function __mul__ at 0x77f370><ul></ul></li>
<li><a class="contents-documented" href="#raws.tokenargs.__radd__">__radd__</a><function __radd__ at 0x77f1f0><ul></ul></li>
<li><a class="contents-documented" href="#raws.tokenargs.__setitem__">__setitem__</a><function __setitem__ at 0x77f0b0><ul></ul></li>
<li><a class="contents-documented" href="#raws.tokenargs.__str__">__str__</a><function __str__ at 0x77f170><ul></ul></li>
<li><a class="contents-documented" href="#raws.tokenargs.add">add</a><function add at 0x77f630><ul></ul></li>
<li><a class="contents-documented" href="#raws.tokenargs.append">append</a><function append at 0x77f570><ul></ul></li>
<li><a class="contents-documented" href="#raws.tokenargs.clear">clear</a><function clear at 0x77f4f0><ul></ul></li>
<li><a class="contents-documented" href="#raws.tokenargs.copy">copy</a><function copy at 0x77f430><ul></ul></li>
<li><a class="contents-documented" href="#raws.tokenargs.extend">extend</a><function extend at 0x77f5b0><ul></ul></li>
<li><a class="contents-documented" href="#raws.tokenargs.insert">insert</a><function insert at 0x77f5f0><ul></ul></li>
<li><a class="contents-documented" href="#raws.tokenargs.remove">remove</a><function remove at 0x77f670><ul></ul></li>
<li><a class="contents-documented" href="#raws.tokenargs.reset">reset</a><function reset at 0x77f470><ul></ul></li>
<li><a class="contents-documented" href="#raws.tokenargs.set">set</a><function set at 0x77f4b0><ul></ul></li>
<li><a class="contents-documented" href="#raws.tokenargs.sub">sub</a><function sub at 0x77f6b0><ul></ul></li></ul></li>
<li><a class="contents-documented" href="#raws.tokenfilter">tokenfilter</a><class 'raws.filters.tokenfilter'><ul><li><a class="contents-documented" href="#raws.tokenfilter.__init__">__init__</a><function __init__ at 0x58baf0><ul></ul></li>
<li><a class="contents-documented" href="#raws.tokenfilter.__str__">__str__</a><function __str__ at 0x58bc70><ul></ul></li></ul></li>
<li><a class="contents-documented" href="#raws.tokengenerator">tokengenerator</a><class 'raws.tokengenerator.tokengenerator'><ul><li><a class="contents-documented" href="#raws.tokengenerator.copy">copy</a><function copy at 0x581b70><ul></ul></li>
<li><a class="contents-documented" href="#raws.tokengenerator.itokens">itokens</a><function itokens at 0x581bf0><ul></ul></li>
<li><a class="contents-documented" href="#raws.tokengenerator.tokens">tokens</a><function tokens at 0x581bb0><ul></ul></li></ul></li>
<li><a class="contents-documented" href="#raws.tokenlist">tokenlist</a><class 'raws.tokenlist.tokenlist'><ul><li><a class="contents-documented" href="#raws.tokenlist.__add__">__add__</a><function __add__ at 0x581cb0><ul></ul></li>
<li><a class="contents-documented" href="#raws.tokenlist.__delitem__">__delitem__</a><function __delitem__ at 0x581e70><ul></ul></li>
<li><a class="contents-documented" href="#raws.tokenlist.__eq__">__eq__</a><function __eq__ at 0x581eb0><ul></ul></li>
<li><a class="contents-documented" href="#raws.tokenlist.__iadd__">__iadd__</a><function __iadd__ at 0x581db0><ul></ul></li>
<li><a class="contents-documented" href="#raws.tokenlist.__imul__">__imul__</a><function __imul__ at 0x581d70><ul></ul></li>
<li><a class="contents-documented" href="#raws.tokenlist.__init__">__init__</a><function __init__ at 0x581a70><ul></ul></li>
<li><a class="contents-documented" href="#raws.tokenlist.__isub__">__isub__</a><function __isub__ at 0x581df0><ul></ul></li>
<li><a class="contents-documented" href="#raws.tokenlist.__iter__">__iter__</a><function __iter__ at 0x581c70><ul></ul></li>
<li><a class="contents-documented" href="#raws.tokenlist.__len__">__len__</a><function __len__ at 0x581c30><ul></ul></li>
<li><a class="contents-documented" href="#raws.tokenlist.__mul__">__mul__</a><function __mul__ at 0x581d30><ul></ul></li>
<li><a class="contents-documented" href="#raws.tokenlist.__radd__">__radd__</a><function __radd__ at 0x581cf0><ul></ul></li>
<li><a class="contents-documented" href="#raws.tokenlist.__setitem__">__setitem__</a><function __setitem__ at 0x581e30><ul></ul></li>
<li><a class="contents-documented" href="#raws.tokenlist.add">add</a><function add at 0x581fb0><ul></ul></li>
<li><a class="contents-documented" href="#raws.tokenlist.append">append</a><function append at 0x581f30><ul></ul></li>
<li><a class="contents-documented" href="#raws.tokenlist.clear">clear</a><function clear at 0x5880b0><ul></ul></li>
<li><a class="contents-documented" href="#raws.tokenlist.copy">copy</a><function copy at 0x588130><ul></ul></li>
<li><a class="contents-documented" href="#raws.tokenlist.extend">extend</a><function extend at 0x581f70><ul></ul></li>
<li><a class="contents-documented" href="#raws.tokenlist.index">index</a><function index at 0x588070><ul></ul></li>
<li><a class="contents-documented" href="#raws.tokenlist.itokens">itokens</a><function itokens at 0x581ef0><ul></ul></li>
<li><a class="contents-documented" href="#raws.tokenlist.remove">remove</a><function remove at 0x5880f0><ul></ul></li>
<li><a class="contents-documented" href="#raws.tokenlist.sub">sub</a><function sub at 0x588030><ul></ul></li></ul></li>
<li><a class="contents-undocumented" href="#raws.tokenparse">tokenparse</a><module 'raws.tokenparse' from '/Users/pineapple/Dropbox/Projects/PyDwarf/docs/bin/../../raws/tokenparse.pyc'><ul></ul></li></ul></li></ul></div>
<h1>Documentation</h1>
<div class="indent"><div class="subs"><div class="item-header"><h2 class="item-title" id="pydwarf"><a href="../pydwarf/__init__.py">pydwarf</a></h2></div><div class="item-body"><div class="docstring undocumented">Undocumented</div><div class="subs"><div class="item-header"><h3 class="item-title" id="pydwarf.compatible"><a href="../pydwarf/version.py">pydwarf.compatible</a></h3></div><div class="item-body"><div class="docstring documented">Given a version regex or iterable thereof and the Dwarf Fortress version, determine if compatibility is met.</div><div class="arguments">Arguments: <span class="argument no-default"><span class="argument-name compatibility">compatibility</span></span><span class="argument-separator">,</span><span class="argument no-default"><span class="argument-name version">version</span></span></div></div><div class="item-header"><h3 class="item-title" id="pydwarf.config"><a href="../pydwarf/config.py">pydwarf.config</a></h3></div><div class="item-body"><div class="docstring documented">
Objects store settings used by session objects to determine
customizeable behavior.
</div><div class="subs"><div class="item-header"><h4 class="item-title" id="pydwarf.config.__add__"><a href="../pydwarf/config.py">pydwarf.config.__add__</a></h4></div><div class="item-body"><div class="docstring documented">Merge two configuration objects.</div><div class="arguments">Arguments: <span class="argument no-default"><span class="argument-name self">self</span></span><span class="argument-separator">,</span><span class="argument no-default"><span class="argument-name other">other</span></span></div></div><div class="item-header"><h4 class="item-title" id="pydwarf.config.__and__"><a href="../pydwarf/config.py">pydwarf.config.__and__</a></h4></div><div class="item-body"><div class="docstring documented">Get the intersection of two configuration objects.</div><div class="arguments">Arguments: <span class="argument no-default"><span class="argument-name self">self</span></span><span class="argument-separator">,</span><span class="argument no-default"><span class="argument-name other">other</span></span></div></div><div class="item-header"><h4 class="item-title" id="pydwarf.config.__getitem__"><a href="../pydwarf/config.py">pydwarf.config.__getitem__</a></h4></div><div class="item-body"><div class="docstring documented">Get configuration argument.</div><div class="arguments">Arguments: <span class="argument no-default"><span class="argument-name self">self</span></span><span class="argument-separator">,</span><span class="argument no-default"><span class="argument-name attr">attr</span></span></div></div><div class="item-header"><h4 class="item-title" id="pydwarf.config.__iadd__"><a href="../pydwarf/config.py">pydwarf.config.__iadd__</a></h4></div><div class="item-body"><div class="docstring documented">Merge another configuration object into this one.</div><div class="arguments">Arguments: <span class="argument no-default"><span class="argument-name self">self</span></span><span class="argument-separator">,</span><span class="argument no-default"><span class="argument-name item">item</span></span></div></div><div class="item-header"><h4 class="item-title" id="pydwarf.config.__init__"><a href="../pydwarf/config.py">pydwarf.config.__init__</a></h4></div><div class="item-body"><div class="docstring documented">Initialize a config object.</div><div class="arguments">Arguments: <span class="argument no-default"><span class="argument-name self">self</span></span><span class="argument-separator">,</span><span class="argument has-default"><span class="argument-name version">version</span><span class="argument-equals">=</span><span class="argument-default NoneType None">None</span></span><span class="argument-separator">,</span><span class="argument has-default"><span class="argument-name paths">paths</span><span class="argument-equals">=</span><span class="argument-default NoneType None">None</span></span><span class="argument-separator">,</span><span class="argument has-default"><span class="argument-name hackversion">hackversion</span><span class="argument-equals">=</span><span class="argument-default NoneType None">None</span></span><span class="argument-separator">,</span><span class="argument has-default"><span class="argument-name input">input</span><span class="argument-equals">=</span><span class="argument-default NoneType None">None</span></span><span class="argument-separator">,</span><span class="argument has-default"><span class="argument-name output">output</span><span class="argument-equals">=</span><span class="argument-default NoneType None">None</span></span><span class="argument-separator">,</span><span class="argument has-default"><span class="argument-name backup">backup</span><span class="argument-equals">=</span><span class="argument-default NoneType None">None</span></span><span class="argument-separator">,</span><span class="argument has-default"><span class="argument-name scripts">scripts</span><span class="argument-equals">=</span><span class="argument-default list []">[]</span></span><span class="argument-separator">,</span><span class="argument has-default"><span class="argument-name packages">packages</span><span class="argument-equals">=</span><span class="argument-default list []">[]</span></span><span class="argument-separator">,</span><span class="argument has-default"><span class="argument-name verbose">verbose</span><span class="argument-equals">=</span><span class="argument-default bool False">False</span></span><span class="argument-separator">,</span><span class="argument has-default"><span class="argument-name log">log</span><span class="argument-equals">=</span><span class="argument-default str logs/2015.09.21.09.46.54.txt">"logs/2015.09.21.09.46.54.txt"</span></span></div></div><div class="item-header"><h4 class="item-title" id="pydwarf.config.__iter__"><a href="../pydwarf/config.py">pydwarf.config.__iter__</a></h4></div><div class="item-body"><div class="docstring documented">Iterate through configuration dict.</div><div class="arguments">Arguments: <span class="argument no-default"><span class="argument-name self">self</span></span></div></div><div class="item-header"><h4 class="item-title" id="pydwarf.config.__radd__"><a href="../pydwarf/config.py">pydwarf.config.__radd__</a></h4></div><div class="item-body"><div class="docstring documented">Merge two configuration objects.</div><div class="arguments">Arguments: <span class="argument no-default"><span class="argument-name self">self</span></span><span class="argument-separator">,</span><span class="argument no-default"><span class="argument-name other">other</span></span></div></div><div class="item-header"><h4 class="item-title" id="pydwarf.config.__setitem__"><a href="../pydwarf/config.py">pydwarf.config.__setitem__</a></h4></div><div class="item-body"><div class="docstring documented">Set configuration argument.</div><div class="arguments">Arguments: <span class="argument no-default"><span class="argument-name self">self</span></span><span class="argument-separator">,</span><span class="argument no-default"><span class="argument-name attr">attr</span></span><span class="argument-separator">,</span><span class="argument no-default"><span class="argument-name value">value</span></span></div></div><div class="item-header"><h4 class="item-title" id="pydwarf.config.__str__"><a href="../pydwarf/config.py">pydwarf.config.__str__</a></h4></div><div class="item-body"><div class="docstring documented">Get a string representation.</div><div class="arguments">Arguments: <span class="argument no-default"><span class="argument-name self">self</span></span></div></div><div class="item-header"><h4 class="item-title" id="pydwarf.config.apply"><a href="../pydwarf/config.py">pydwarf.config.apply</a></h4></div><div class="item-body"><div class="docstring documented">Apply another dict or config object's settings to this one.</div><div class="arguments">Arguments: <span class="argument no-default"><span class="argument-name self">self</span></span><span class="argument-separator">,</span><span class="argument no-default"><span class="argument-name data">data</span></span><span class="argument-separator">,</span><span class="argument has-default"><span class="argument-name applynone">applynone</span><span class="argument-equals">=</span><span class="argument-default bool False">False</span></span></div></div><div class="item-header"><h4 class="item-title" id="pydwarf.config.copy"><a href="../pydwarf/config.py">pydwarf.config.copy</a></h4></div><div class="item-body"><div class="docstring documented">Copy the config object.</div><div class="arguments">Arguments: <span class="argument no-default"><span class="argument-name self">self</span></span></div></div><div class="item-header"><h4 class="item-title" id="pydwarf.config.iteritems"><a href="../pydwarf/config.py">pydwarf.config.iteritems</a></h4></div><div class="item-body"><div class="docstring documented">Iterate through configuration dict items.</div><div class="arguments">Arguments: <span class="argument no-default"><span class="argument-name self">self</span></span></div></div><div class="item-header"><h4 class="item-title" id="pydwarf.config.json"><a href="../pydwarf/config.py">pydwarf.config.json</a></h4></div><div class="item-body"><div class="docstring documented">Load json configuration from a file.</div><div class="arguments">Arguments: <span class="argument no-default"><span class="argument-name self">self</span></span><span class="argument-separator">,</span><span class="argument no-default"><span class="argument-name path">path</span></span><span class="argument-separator">,</span><span class="argument varargs">*args</span><span class="argument-separator">,</span><span class="argument keywords">**kwargs</span></div></div><div class="item-header"><h4 class="item-title" id="pydwarf.config.override"><a href="../pydwarf/config.py">pydwarf.config.override</a></h4></div><div class="item-body"><div class="docstring documented">Load python configuration from a file.</div><div class="arguments">Arguments: <span class="argument no-default"><span class="argument-name self">self</span></span><span class="argument-separator">,</span><span class="argument no-default"><span class="argument-name module">module</span></span><span class="argument-separator">,</span><span class="argument varargs">*args</span><span class="argument-separator">,</span><span class="argument keywords">**kwargs</span></div></div><div class="item-header"><h4 class="item-title" id="pydwarf.config.setup"><a href="../pydwarf/config.py">pydwarf.config.setup</a></h4></div><div class="item-body"><div class="docstring documented">
Setup logger and handle 'auto' arguments after a configuration
object has been fully loaded.
</div><div class="arguments">Arguments: <span class="argument no-default"><span class="argument-name self">self</span></span><span class="argument-separator">,</span><span class="argument has-default"><span class="argument-name logger">logger</span><span class="argument-equals">=</span><span class="argument-default bool True">True</span></span></div></div><div class="item-header"><h4 class="item-title" id="pydwarf.config.yaml"><a href="../pydwarf/config.py">pydwarf.config.yaml</a></h4></div><div class="item-body"><div class="docstring documented">Load yaml configuration from a file.</div><div class="arguments">Arguments: <span class="argument no-default"><span class="argument-name self">self</span></span><span class="argument-separator">,</span><span class="argument no-default"><span class="argument-name path">path</span></span><span class="argument-separator">,</span><span class="argument varargs">*args</span><span class="argument-separator">,</span><span class="argument keywords">**kwargs</span></div></div></div></div><div class="item-header"><h3 class="item-title" id="pydwarf.df"><a href="../pydwarf/quick.py">pydwarf.df</a></h3></div><div class="item-body"><div class="docstring documented">Quickly load a Dwarf Fortress directory. Useful for testing.</div><div class="arguments">Arguments: <span class="argument varargs">*args</span><span class="argument-separator">,</span><span class="argument keywords">**kwargs</span></div></div><div class="item-header"><h3 class="item-title" id="pydwarf.df_revision_range"><a href="../pydwarf/version.py">pydwarf.df_revision_range</a></h3></div><div class="item-body"><div class="docstring documented">Get a regular expression representing a range of Dwarf Fortress revisions.</div><div class="arguments">Arguments: <span class="argument has-default"><span class="argument-name prettymin">prettymin</span><span class="argument-equals">=</span><span class="argument-default NoneType None">None</span></span><span class="argument-separator">,</span><span class="argument has-default"><span class="argument-name prettymax">prettymax</span><span class="argument-equals">=</span><span class="argument-default NoneType None">None</span></span><span class="argument-separator">,</span><span class="argument has-default"><span class="argument-name major">major</span><span class="argument-equals">=</span><span class="argument-default NoneType None">None</span></span><span class="argument-separator">,</span><span class="argument has-default"><span class="argument-name minor">minor</span><span class="argument-equals">=</span><span class="argument-default NoneType None">None</span></span><span class="argument-separator">,</span><span class="argument has-default"><span class="argument-name minrevision">minrevision</span><span class="argument-equals">=</span><span class="argument-default NoneType None">None</span></span><span class="argument-separator">,</span><span class="argument has-default"><span class="argument-name maxrevision">maxrevision</span><span class="argument-equals">=</span><span class="argument-default NoneType None">None</span></span></div></div><div class="item-header"><h3 class="item-title" id="pydwarf.failure"><a href="../pydwarf/response.py">pydwarf.failure</a></h3></div><div class="item-body"><div class="docstring documented">Initialize a failed response object.</div><div class="arguments">Arguments: <span class="argument has-default"><span class="argument-name status">status</span><span class="argument-equals">=</span><span class="argument-default NoneType None">None</span></span></div></div><div class="item-header"><h3 class="item-title" id="pydwarf.findfile"><a href="../pydwarf/helpers.py">pydwarf.findfile</a></h3></div><div class="item-body"><div class="docstring documented">Find a file given paths the file may be located in or near.</div><div class="arguments">Arguments: <span class="argument no-default"><span class="argument-name name">name</span></span><span class="argument-separator">,</span><span class="argument no-default"><span class="argument-name paths">paths</span></span><span class="argument-separator">,</span><span class="argument has-default"><span class="argument-name recursion">recursion</span><span class="argument-equals">=</span><span class="argument-default int 6">6</span></span></div></div><div class="item-header"><h3 class="item-title" id="pydwarf.helpers"><a href="../pydwarf/helpers.py">pydwarf.helpers</a></h3></div><div class="item-body"><div class="docstring documented">Provides helper functions for common tasks.</div></div><div class="item-header"><h3 class="item-title" id="pydwarf.logger"><a href="../pydwarf/logger.py">pydwarf.logger</a></h3></div><div class="item-body"><div class="docstring documented">
Initialize a shared logger object.
</div><div class="subs"><div class="item-header"><h4 class="item-title" id="pydwarf.logger.datetime"><a href="None">pydwarf.logger.datetime</a></h4></div><div class="item-body"><div class="docstring documented">datetime(year, month, day[, hour[, minute[, second[, microsecond[,tzinfo]]]]])
The year, month and day arguments are required. tzinfo may be None, or an
instance of a tzinfo subclass. The remaining arguments may be ints or longs.
</div></div></div></div><div class="item-header"><h3 class="item-title" id="pydwarf.quick"><a href="../pydwarf/quick.py">pydwarf.quick</a></h3></div><div class="item-body"><div class="docstring documented">Quickly load a session object. Useful for testing.</div><div class="arguments">Arguments: <span class="argument no-default"><span class="argument-name raws">raws</span></span><span class="argument-separator">,</span><span class="argument has-default"><span class="argument-name root">root</span><span class="argument-equals">=</span><span class="argument-default NoneType None">None</span></span><span class="argument-separator">,</span><span class="argument keywords">**kwargs</span></div></div><div class="item-header"><h3 class="item-title" id="pydwarf.registrar"><a href="../pydwarf/registrar.py">pydwarf.registrar</a></h3></div><div class="item-body"><div class="docstring documented">
Class tracks and allows access to registered scripts via convenient
syntax.
</div><div class="subs"><div class="item-header"><h4 class="item-title" id="pydwarf.registrar.__call__"><a href="../pydwarf/registrar.py">pydwarf.registrar.__call__</a></h4></div><div class="item-body"><div class="docstring documented">
If the registrar points to a single registered script, call that
script with the given arguments. If it points to a number of
children registrars then each of those is called with the given
arguments.
</div><div class="arguments">Arguments: <span class="argument no-default"><span class="argument-name self">self</span></span><span class="argument-separator">,</span><span class="argument varargs">*args</span><span class="argument-separator">,</span><span class="argument keywords">**kwargs</span></div></div><div class="item-header"><h4 class="item-title" id="pydwarf.registrar.__contains__"><a href="../pydwarf/registrar.py">pydwarf.registrar.__contains__</a></h4></div><div class="item-body"><div class="docstring documented">Check if a script or namespace is contained within this one.</div><div class="arguments">Arguments: <span class="argument no-default"><span class="argument-name self">self</span></span><span class="argument-separator">,</span><span class="argument no-default"><span class="argument-name name">name</span></span></div></div><div class="item-header"><h4 class="item-title" id="pydwarf.registrar.__getattr__"><a href="../pydwarf/registrar.py">pydwarf.registrar.__getattr__</a></h4></div><div class="item-body"><div class="docstring documented">Get a script or namespace by name.</div><div class="arguments">Arguments: <span class="argument no-default"><span class="argument-name self">self</span></span><span class="argument-separator">,</span><span class="argument no-default"><span class="argument-name attr">attr</span></span></div><div class="examples"><pre class="highlight-example">>>> smallthings = pydwarf.scripts.umiman.smallthings
>>> print '\n'.join(sorted(str(script) for script in smallthings))
umiman.smallthings.engraving
umiman.smallthings.prefstring
umiman.smallthings.speech.nofamily
umiman.smallthings.speech.threats</pre><div class="example-separator"></div><pre class="highlight-example">15
>>> print len(df['data/speech/no_family.txt'].bin())
28
>>> responses = pydwarf.scripts.umiman.smallthings.speech(df)
>>> print '\n'.join('%s: %s' % (key, value) for key, value in responses.iteritems())
threats: SUCCESS: Ran successfully.
nofamily: SUCCESS: Ran successfully.
>>> print len(df['data/speech/threat.txt'])
8953
>>> print len(df['data/speech/no_family.txt'])
1720</pre></div></div><div class="item-header"><h4 class="item-title" id="pydwarf.registrar.__getitem__"><a href="../pydwarf/registrar.py">pydwarf.registrar.__getitem__</a></h4></div><div class="item-body"><div class="docstring documented">Get a script or namespace by name.</div><div class="arguments">Arguments: <span class="argument no-default"><span class="argument-name self">self</span></span><span class="argument-separator">,</span><span class="argument no-default"><span class="argument-name name">name</span></span></div></div><div class="item-header"><h4 class="item-title" id="pydwarf.registrar.__iadd__"><a href="../pydwarf/registrar.py">pydwarf.registrar.__iadd__</a></h4></div><div class="item-body"><div class="docstring documented">Add a new script or namespace.</div><div class="arguments">Arguments: <span class="argument no-default"><span class="argument-name self">self</span></span><span class="argument-separator">,</span><span class="argument no-default"><span class="argument-name script">script</span></span></div></div><div class="item-header"><h4 class="item-title" id="pydwarf.registrar.__init__"><a href="../pydwarf/registrar.py">pydwarf.registrar.__init__</a></h4></div><div class="item-body"><div class="docstring documented">Initialize a registrar object.</div><div class="arguments">Arguments: <span class="argument no-default"><span class="argument-name self">self</span></span><span class="argument-separator">,</span><span class="argument has-default"><span class="argument-name name">name</span><span class="argument-equals">=</span><span class="argument-default NoneType None">None</span></span><span class="argument-separator">,</span><span class="argument has-default"><span class="argument-name parent">parent</span><span class="argument-equals">=</span><span class="argument-default NoneType None">None</span></span></div></div><div class="item-header"><h4 class="item-title" id="pydwarf.registrar.__iter__"><a href="../pydwarf/registrar.py">pydwarf.registrar.__iter__</a></h4></div><div class="item-body"><div class="docstring documented">
Iterate through all scripts contained within this and child
registrars.
</div><div class="arguments">Arguments: <span class="argument no-default"><span class="argument-name self">self</span></span></div><div class="examples"><pre class="highlight-example">>>> smallthings = pydwarf.scripts.umiman.smallthings
>>> print '\n'.join(sorted(str(script) for script in smallthings))
umiman.smallthings.engraving
umiman.smallthings.prefstring
umiman.smallthings.speech.nofamily
umiman.smallthings.speech.threats</pre></div></div><div class="item-header"><h4 class="item-title" id="pydwarf.registrar.__len__"><a href="../pydwarf/registrar.py">pydwarf.registrar.__len__</a></h4></div><div class="item-body"><div class="docstring documented">Get the number of scripts contained within this namespace.</div><div class="arguments">Arguments: <span class="argument no-default"><span class="argument-name self">self</span></span></div></div><div class="item-header"><h4 class="item-title" id="pydwarf.registrar.__register__"><a href="../pydwarf/registrar.py">pydwarf.registrar.__register__</a></h4></div><div class="item-body"><div class="docstring documented">Register a new script with the registrar.</div><div class="arguments">Arguments: <span class="argument no-default"><span class="argument-name self">self</span></span><span class="argument-separator">,</span><span class="argument no-default"><span class="argument-name script">script</span></span><span class="argument-separator">,</span><span class="argument has-default"><span class="argument-name name">name</span><span class="argument-equals">=</span><span class="argument-default NoneType None">None</span></span></div></div><div class="item-header"><h4 class="item-title" id="pydwarf.registrar.__setitem__"><a href="../pydwarf/registrar.py">pydwarf.registrar.__setitem__</a></h4></div><div class="item-body"><div class="docstring documented">Set a script or namespace by name.</div><div class="arguments">Arguments: <span class="argument no-default"><span class="argument-name self">self</span></span><span class="argument-separator">,</span><span class="argument no-default"><span class="argument-name name">name</span></span><span class="argument-separator">,</span><span class="argument no-default"><span class="argument-name script">script</span></span></div></div><div class="item-header"><h4 class="item-title" id="pydwarf.registrar.__str__"><a href="../pydwarf/registrar.py">pydwarf.registrar.__str__</a></h4></div><div class="item-body"><div class="docstring documented">Get a string representation of the script or namespace.</div><div class="arguments">Arguments: <span class="argument no-default"><span class="argument-name self">self</span></span></div></div></div></div><div class="item-header"><h3 class="item-title" id="pydwarf.rel"><a href="../pydwarf/helpers.py">pydwarf.rel</a></h3></div><div class="item-body"><div class="docstring documented">Get a path relative to the directory containing another.</div><div class="arguments">Arguments: <span class="argument no-default"><span class="argument-name base">base</span></span><span class="argument-separator">,</span><span class="argument varargs">*args</span></div></div><div class="item-header"><h3 class="item-title" id="pydwarf.response"><a href="../pydwarf/response.py">pydwarf.response</a></h3></div><div class="item-body"><div class="docstring documented">
Response object recognized by sessions as an item to be returned by
registered scripts to report their termination status.
</div><div class="subs"><div class="item-header"><h4 class="item-title" id="pydwarf.response.__init__"><a href="../pydwarf/response.py">pydwarf.response.__init__</a></h4></div><div class="item-body"><div class="docstring documented">Initialize a response object.</div><div class="arguments">Arguments: <span class="argument no-default"><span class="argument-name self">self</span></span><span class="argument-separator">,</span><span class="argument no-default"><span class="argument-name success">success</span></span><span class="argument-separator">,</span><span class="argument no-default"><span class="argument-name status">status</span></span></div></div><div class="item-header"><h4 class="item-title" id="pydwarf.response.__nonzero__"><a href="../pydwarf/response.py">pydwarf.response.__nonzero__</a></h4></div><div class="item-body"><div class="docstring documented">Return True if successful, False otherwise.</div><div class="arguments">Arguments: <span class="argument no-default"><span class="argument-name self">self</span></span></div></div><div class="item-header"><h4 class="item-title" id="pydwarf.response.__str__"><a href="../pydwarf/response.py">pydwarf.response.__str__</a></h4></div><div class="item-body"><div class="docstring documented">Get a string representation.</div><div class="arguments">Arguments: <span class="argument no-default"><span class="argument-name self">self</span></span></div><div class="examples"><pre class="highlight-example">15
>>> print len(df['data/speech/no_family.txt'].bin())
28
>>> responses = pydwarf.scripts.umiman.smallthings.speech(df)
>>> print '\n'.join('%s: %s' % (key, value) for key, value in responses.iteritems())
threats: SUCCESS: Ran successfully.
nofamily: SUCCESS: Ran successfully.
>>> print len(df['data/speech/threat.txt'])
8953
>>> print len(df['data/speech/no_family.txt'])
1720</pre></div></div></div></div><div class="item-header"><h3 class="item-title" id="pydwarf.session"><a href="../pydwarf/session.py">pydwarf.session</a></h3></div><div class="item-body"><div class="docstring documented">
Class contains functionality for abstract handling for scripts and dirs.
</div><div class="subs"><div class="item-header"><h4 class="item-title" id="pydwarf.session.__enter__"><a href="../pydwarf/session.py">pydwarf.session.__enter__</a></h4></div><div class="item-body"><div class="docstring documented">Support for with/as syntax.</div><div class="arguments">Arguments: <span class="argument no-default"><span class="argument-name self">self</span></span></div></div><div class="item-header"><h4 class="item-title" id="pydwarf.session.__exit__"><a href="../pydwarf/session.py">pydwarf.session.__exit__</a></h4></div><div class="item-body"><div class="docstring documented">Support for with/as syntax.</div><div class="arguments">Arguments: <span class="argument no-default"><span class="argument-name self">self</span></span><span class="argument-separator">,</span><span class="argument no-default"><span class="argument-name type">type</span></span><span class="argument-separator">,</span><span class="argument no-default"><span class="argument-name value">value</span></span><span class="argument-separator">,</span><span class="argument no-default"><span class="argument-name traceback">traceback</span></span></div></div><div class="item-header"><h4 class="item-title" id="pydwarf.session.__init__"><a href="../pydwarf/session.py">pydwarf.session.__init__</a></h4></div><div class="item-body"><div class="docstring documented">Initialize a session object.</div><div class="arguments">Arguments: <span class="argument no-default"><span class="argument-name self">self</span></span><span class="argument-separator">,</span><span class="argument has-default"><span class="argument-name raws">raws</span><span class="argument-equals">=</span><span class="argument-default NoneType None">None</span></span><span class="argument-separator">,</span><span class="argument has-default"><span class="argument-name conf">conf</span><span class="argument-equals">=</span><span class="argument-default NoneType None">None</span></span></div></div><div class="item-header"><h4 class="item-title" id="pydwarf.session.backup"><a href="../pydwarf/session.py">pydwarf.session.backup</a></h4></div><div class="item-body"><div class="docstring documented">Backup inputted Dwarf Fortress directory.</div><div class="arguments">Arguments: <span class="argument no-default"><span class="argument-name self">self</span></span><span class="argument-separator">,</span><span class="argument has-default"><span class="argument-name dest">dest</span><span class="argument-equals">=</span><span class="argument-default NoneType None">None</span></span><span class="argument-separator">,</span><span class="argument has-default"><span class="argument-name skipfails">skipfails</span><span class="argument-equals">=</span><span class="argument-default bool False">False</span></span></div></div><div class="item-header"><h4 class="item-title" id="pydwarf.session.configure"><a href="../pydwarf/session.py">pydwarf.session.configure</a></h4></div><div class="item-body"><div class="docstring documented">
Configure a session object given a reference to the raws package and
to a configuration object.
</div><div class="arguments">Arguments: <span class="argument no-default"><span class="argument-name self">self</span></span><span class="argument-separator">,</span><span class="argument no-default"><span class="argument-name raws">raws</span></span><span class="argument-separator">,</span><span class="argument no-default"><span class="argument-name conf">conf</span></span></div></div><div class="item-header"><h4 class="item-title" id="pydwarf.session.eval"><a href="../pydwarf/session.py">pydwarf.session.eval</a></h4></div><div class="item-body"><div class="docstring documented">Evaluate an uristscript or other callable object.</div><div class="arguments">Arguments: <span class="argument no-default"><span class="argument-name self">self</span></span><span class="argument-separator">,</span><span class="argument no-default"><span class="argument-name func">func</span></span><span class="argument-separator">,</span><span class="argument has-default"><span class="argument-name args">args</span><span class="argument-equals">=</span><span class="argument-default NoneType None">None</span></span></div></div><div class="item-header"><h4 class="item-title" id="pydwarf.session.failed"><a href="../pydwarf/session.py">pydwarf.session.failed</a></h4></div><div class="item-body"><div class="docstring documented">Get a list of unsuccessfully run scripts.</div><div class="arguments">Arguments: <span class="argument no-default"><span class="argument-name self">self</span></span><span class="argument-separator">,</span><span class="argument no-default"><span class="argument-name info">info</span></span></div></div><div class="item-header"><h4 class="item-title" id="pydwarf.session.funcs"><a href="../pydwarf/session.py">pydwarf.session.funcs</a></h4></div><div class="item-body"><div class="docstring documented">
Get function information associated with an entry in a configuration
object's scripts attribute.
</div><div class="arguments">Arguments: <span class="argument no-default"><span class="argument-name self">self</span></span><span class="argument-separator">,</span><span class="argument no-default"><span class="argument-name info">info</span></span></div></div><div class="item-header"><h4 class="item-title" id="pydwarf.session.handle"><a href="../pydwarf/session.py">pydwarf.session.handle</a></h4></div><div class="item-body"><div class="docstring documented">Handle a single script.</div><div class="arguments">Arguments: <span class="argument no-default"><span class="argument-name self">self</span></span><span class="argument-separator">,</span><span class="argument no-default"><span class="argument-name info">info</span></span></div></div><div class="item-header"><h4 class="item-title" id="pydwarf.session.handleall"><a href="../pydwarf/session.py">pydwarf.session.handleall</a></h4></div><div class="item-body"><div class="docstring documented">Handle all scripts specified by the session's configuration.</div><div class="arguments">Arguments: <span class="argument no-default"><span class="argument-name self">self</span></span><span class="argument-separator">,</span><span class="argument has-default"><span class="argument-name infos">infos</span><span class="argument-equals">=</span><span class="argument-default NoneType None">None</span></span></div></div><div class="item-header"><h4 class="item-title" id="pydwarf.session.load"><a href="../pydwarf/session.py">pydwarf.session.load</a></h4></div><div class="item-body"><div class="docstring documented">
Configure a session object given arguments to specify configuration
loading behavior.
</div><div class="arguments">Arguments: <span class="argument no-default"><span class="argument-name self">self</span></span><span class="argument-separator">,</span><span class="argument no-default"><span class="argument-name raws">raws</span></span><span class="argument-separator">,</span><span class="argument varargs">*args</span><span class="argument-separator">,</span><span class="argument keywords">**kwargs</span></div></div><div class="item-header"><h4 class="item-title" id="pydwarf.session.outputdir"><a href="../pydwarf/session.py">pydwarf.session.outputdir</a></h4></div><div class="item-body"><div class="docstring documented">Get output directory given the session's configuration.</div><div class="arguments">Arguments: <span class="argument no-default"><span class="argument-name self">self</span></span></div></div><div class="item-header"><h4 class="item-title" id="pydwarf.session.run"><a href="../pydwarf/session.py">pydwarf.session.run</a></h4></div><div class="item-body"><div class="docstring documented">
Backup the session's Dwarf Fortress directory, run specified
scripts, and then write the output.
</div><div class="arguments">Arguments: <span class="argument no-default"><span class="argument-name self">self</span></span></div></div><div class="item-header"><h4 class="item-title" id="pydwarf.session.successful"><a href="../pydwarf/session.py">pydwarf.session.successful</a></h4></div><div class="item-body"><div class="docstring documented">Get a list of successfully run scripts.</div><div class="arguments">Arguments: <span class="argument no-default"><span class="argument-name self">self</span></span><span class="argument-separator">,</span><span class="argument no-default"><span class="argument-name info">info</span></span></div></div><div class="item-header"><h4 class="item-title" id="pydwarf.session.write"><a href="../pydwarf/session.py">pydwarf.session.write</a></h4></div><div class="item-body"><div class="docstring documented">Write the session's directory to its output path.</div><div class="arguments">Arguments: <span class="argument no-default"><span class="argument-name self">self</span></span><span class="argument-separator">,</span><span class="argument has-default"><span class="argument-name dest">dest</span><span class="argument-equals">=</span><span class="argument-default NoneType None">None</span></span><span class="argument-separator">,</span><span class="argument varargs">*args</span><span class="argument-separator">,</span><span class="argument keywords">**kwargs</span></div></div></div></div><div class="item-header"><h3 class="item-title" id="pydwarf.success"><a href="../pydwarf/response.py">pydwarf.success</a></h3></div><div class="item-body"><div class="docstring documented">Initialize a successful response object.</div><div class="arguments">Arguments: <span class="argument has-default"><span class="argument-name status">status</span><span class="argument-equals">=</span><span class="argument-default NoneType None">None</span></span></div></div><div class="item-header"><h3 class="item-title" id="pydwarf.urist"><a href="../pydwarf/urist.py">pydwarf.urist</a></h3></div><div class="item-body"><div class="docstring documented">
Decorates a function as being an urist. Keyword arguments are treated as
metadata.
</div><div class="subs"><div class="item-header"><h4 class="item-title" id="pydwarf.urist.__call__"><a href="../pydwarf/urist.py">pydwarf.urist.__call__</a></h4></div><div class="item-body"><div class="docstring documented">Register a function when used as a decorator.</div><div class="arguments">Arguments: <span class="argument no-default"><span class="argument-name self">self</span></span><span class="argument-separator">,</span><span class="argument no-default"><span class="argument-name func">func</span></span></div></div><div class="item-header"><h4 class="item-title" id="pydwarf.urist.__init__"><a href="../pydwarf/urist.py">pydwarf.urist.__init__</a></h4></div><div class="item-body"><div class="docstring documented">Initialize an urist object.</div><div class="arguments">Arguments: <span class="argument no-default"><span class="argument-name self">self</span></span><span class="argument-separator">,</span><span class="argument keywords">**kwargs</span></div></div></div></div><div class="item-header"><h3 class="item-title" id="pydwarf.uristdoc"><a href="../pydwarf/uristdoc.py">pydwarf.uristdoc</a></h3></div><div class="item-body"><div class="docstring documented">Generate formatted documentation for registered scripts based on their metadata.</div><div class="subs"><div class="item-header"><h4 class="item-title" id="pydwarf.uristdoc.htmltemplate"><a href="../pydwarf/uristdoc.py">pydwarf.uristdoc.htmltemplate</a></h4></div><div class="item-body"><div class="docstring undocumented">Undocumented</div><div class="subs"><div class="item-header"><h5 class="item-title" id="pydwarf.uristdoc.htmltemplate.__init__"><a href="../pydwarf/uristdoc.py">pydwarf.uristdoc.htmltemplate.__init__</a></h5></div><div class="item-body"><div class="docstring undocumented">Undocumented</div><div class="arguments">Arguments: <span class="argument no-default"><span class="argument-name self">self</span></span></div></div><div class="item-header"><h5 class="item-title" id="pydwarf.uristdoc.htmltemplate.arguments"><a href="../pydwarf/uristdoc.py">pydwarf.uristdoc.htmltemplate.arguments</a></h5></div><div class="item-body"><div class="docstring undocumented">Undocumented</div><div class="arguments">Arguments: <span class="argument no-default"><span class="argument-name self">self</span></span><span class="argument-separator">,</span><span class="argument no-default"><span class="argument-name arguments">arguments</span></span></div></div><div class="item-header"><h5 class="item-title" id="pydwarf.uristdoc.htmltemplate.concat"><a href="../pydwarf/uristdoc.py">pydwarf.uristdoc.htmltemplate.concat</a></h5></div><div class="item-body"><div class="docstring undocumented">Undocumented</div><div class="arguments">Arguments: <span class="argument no-default"><span class="argument-name self">self</span></span><span class="argument-separator">,</span><span class="argument no-default"><span class="argument-name items">items</span></span></div></div><div class="item-header"><h5 class="item-title" id="pydwarf.uristdoc.htmltemplate.dependencies"><a href="../pydwarf/uristdoc.py">pydwarf.uristdoc.htmltemplate.dependencies</a></h5></div><div class="item-body"><div class="docstring undocumented">Undocumented</div><div class="arguments">Arguments: <span class="argument no-default"><span class="argument-name self">self</span></span><span class="argument-separator">,</span><span class="argument no-default"><span class="argument-name dependencies">dependencies</span></span></div></div><div class="item-header"><h5 class="item-title" id="pydwarf.uristdoc.htmltemplate.header"><a href="../pydwarf/uristdoc.py">pydwarf.uristdoc.htmltemplate.header</a></h5></div><div class="item-body"><div class="docstring undocumented">Undocumented</div><div class="arguments">Arguments: <span class="argument no-default"><span class="argument-name self">self</span></span><span class="argument-separator">,</span><span class="argument has-default"><span class="argument-name name">name</span><span class="argument-equals">=</span><span class="argument-default NoneType None">None</span></span><span class="argument-separator">,</span><span class="argument has-default"><span class="argument-name version">version</span><span class="argument-equals">=</span><span class="argument-default NoneType None">None</span></span><span class="argument-separator">,</span><span class="argument has-default"><span class="argument-name author">author</span><span class="argument-equals">=</span><span class="argument-default NoneType None">None</span></span><span class="argument-separator">,</span><span class="argument has-default"><span class="argument-name description">description</span><span class="argument-equals">=</span><span class="argument-default NoneType None">None</span></span><span class="argument-separator">,</span><span class="argument keywords">**kwargs</span></div></div><div class="item-header"><h5 class="item-title" id="pydwarf.uristdoc.htmltemplate.metadata"><a href="../pydwarf/uristdoc.py">pydwarf.uristdoc.htmltemplate.metadata</a></h5></div><div class="item-body"><div class="docstring undocumented">Undocumented</div><div class="arguments">Arguments: <span class="argument no-default"><span class="argument-name self">self</span></span><span class="argument-separator">,</span><span class="argument no-default"><span class="argument-name metadata">metadata</span></span></div></div><div class="item-header"><h5 class="item-title" id="pydwarf.uristdoc.htmltemplate.preprocesstext"><a href="../pydwarf/uristdoc.py">pydwarf.uristdoc.htmltemplate.preprocesstext</a></h5></div><div class="item-body"><div class="docstring undocumented">Undocumented</div><div class="arguments">Arguments: <span class="argument no-default"><span class="argument-name self">self</span></span><span class="argument-separator">,</span><span class="argument no-default"><span class="argument-name text">text</span></span></div></div></div></div><div class="item-header"><h4 class="item-title" id="pydwarf.uristdoc.mdtemplate"><a href="../pydwarf/uristdoc.py">pydwarf.uristdoc.mdtemplate</a></h4></div><div class="item-body"><div class="docstring undocumented">Undocumented</div><div class="subs"><div class="item-header"><h5 class="item-title" id="pydwarf.uristdoc.mdtemplate.__init__"><a href="../pydwarf/uristdoc.py">pydwarf.uristdoc.mdtemplate.__init__</a></h5></div><div class="item-body"><div class="docstring undocumented">Undocumented</div><div class="arguments">Arguments: <span class="argument no-default"><span class="argument-name self">self</span></span></div></div><div class="item-header"><h5 class="item-title" id="pydwarf.uristdoc.mdtemplate.arguments"><a href="../pydwarf/uristdoc.py">pydwarf.uristdoc.mdtemplate.arguments</a></h5></div><div class="item-body"><div class="docstring undocumented">Undocumented</div><div class="arguments">Arguments: <span class="argument no-default"><span class="argument-name self">self</span></span><span class="argument-separator">,</span><span class="argument no-default"><span class="argument-name arguments">arguments</span></span></div></div><div class="item-header"><h5 class="item-title" id="pydwarf.uristdoc.mdtemplate.concat"><a href="../pydwarf/uristdoc.py">pydwarf.uristdoc.mdtemplate.concat</a></h5></div><div class="item-body"><div class="docstring undocumented">Undocumented</div><div class="arguments">Arguments: <span class="argument no-default"><span class="argument-name self">self</span></span><span class="argument-separator">,</span><span class="argument no-default"><span class="argument-name items">items</span></span></div></div><div class="item-header"><h5 class="item-title" id="pydwarf.uristdoc.mdtemplate.dependencies"><a href="../pydwarf/uristdoc.py">pydwarf.uristdoc.mdtemplate.dependencies</a></h5></div><div class="item-body"><div class="docstring undocumented">Undocumented</div><div class="arguments">Arguments: <span class="argument no-default"><span class="argument-name self">self</span></span><span class="argument-separator">,</span><span class="argument no-default"><span class="argument-name dependencies">dependencies</span></span></div></div><div class="item-header"><h5 class="item-title" id="pydwarf.uristdoc.mdtemplate.header"><a href="../pydwarf/uristdoc.py">pydwarf.uristdoc.mdtemplate.header</a></h5></div><div class="item-body"><div class="docstring undocumented">Undocumented</div><div class="arguments">Arguments: <span class="argument no-default"><span class="argument-name self">self</span></span><span class="argument-separator">,</span><span class="argument has-default"><span class="argument-name name">name</span><span class="argument-equals">=</span><span class="argument-default NoneType None">None</span></span><span class="argument-separator">,</span><span class="argument has-default"><span class="argument-name version">version</span><span class="argument-equals">=</span><span class="argument-default NoneType None">None</span></span><span class="argument-separator">,</span><span class="argument has-default"><span class="argument-name author">author</span><span class="argument-equals">=</span><span class="argument-default NoneType None">None</span></span><span class="argument-separator">,</span><span class="argument has-default"><span class="argument-name description">description</span><span class="argument-equals">=</span><span class="argument-default NoneType None">None</span></span><span class="argument-separator">,</span><span class="argument keywords">**kwargs</span></div></div><div class="item-header"><h5 class="item-title" id="pydwarf.uristdoc.mdtemplate.metadata"><a href="../pydwarf/uristdoc.py">pydwarf.uristdoc.mdtemplate.metadata</a></h5></div><div class="item-body"><div class="docstring undocumented">Undocumented</div><div class="arguments">Arguments: <span class="argument no-default"><span class="argument-name self">self</span></span><span class="argument-separator">,</span><span class="argument no-default"><span class="argument-name metadata">metadata</span></span></div></div><div class="item-header"><h5 class="item-title" id="pydwarf.uristdoc.mdtemplate.preprocesstext"><a href="../pydwarf/uristdoc.py">pydwarf.uristdoc.mdtemplate.preprocesstext</a></h5></div><div class="item-body"><div class="docstring undocumented">Undocumented</div><div class="arguments">Arguments: <span class="argument no-default"><span class="argument-name self">self</span></span><span class="argument-separator">,</span><span class="argument no-default"><span class="argument-name text">text</span></span></div></div></div></div><div class="item-header"><h4 class="item-title" id="pydwarf.uristdoc.txttemplate"><a href="../pydwarf/uristdoc.py">pydwarf.uristdoc.txttemplate</a></h4></div><div class="item-body"><div class="docstring undocumented">Undocumented</div><div class="subs"><div class="item-header"><h5 class="item-title" id="pydwarf.uristdoc.txttemplate.__init__"><a href="../pydwarf/uristdoc.py">pydwarf.uristdoc.txttemplate.__init__</a></h5></div><div class="item-body"><div class="docstring undocumented">Undocumented</div><div class="arguments">Arguments: <span class="argument no-default"><span class="argument-name self">self</span></span></div></div><div class="item-header"><h5 class="item-title" id="pydwarf.uristdoc.txttemplate.arguments"><a href="../pydwarf/uristdoc.py">pydwarf.uristdoc.txttemplate.arguments</a></h5></div><div class="item-body"><div class="docstring undocumented">Undocumented</div><div class="arguments">Arguments: <span class="argument no-default"><span class="argument-name self">self</span></span><span class="argument-separator">,</span><span class="argument no-default"><span class="argument-name arguments">arguments</span></span></div></div><div class="item-header"><h5 class="item-title" id="pydwarf.uristdoc.txttemplate.dependencies"><a href="../pydwarf/uristdoc.py">pydwarf.uristdoc.txttemplate.dependencies</a></h5></div><div class="item-body"><div class="docstring undocumented">Undocumented</div><div class="arguments">Arguments: <span class="argument no-default"><span class="argument-name self">self</span></span><span class="argument-separator">,</span><span class="argument no-default"><span class="argument-name dependencies">dependencies</span></span></div></div><div class="item-header"><h5 class="item-title" id="pydwarf.uristdoc.txttemplate.header"><a href="../pydwarf/uristdoc.py">pydwarf.uristdoc.txttemplate.header</a></h5></div><div class="item-body"><div class="docstring undocumented">Undocumented</div><div class="arguments">Arguments: <span class="argument no-default"><span class="argument-name self">self</span></span><span class="argument-separator">,</span><span class="argument has-default"><span class="argument-name name">name</span><span class="argument-equals">=</span><span class="argument-default NoneType None">None</span></span><span class="argument-separator">,</span><span class="argument has-default"><span class="argument-name version">version</span><span class="argument-equals">=</span><span class="argument-default NoneType None">None</span></span><span class="argument-separator">,</span><span class="argument has-default"><span class="argument-name author">author</span><span class="argument-equals">=</span><span class="argument-default NoneType None">None</span></span><span class="argument-separator">,</span><span class="argument has-default"><span class="argument-name description">description</span><span class="argument-equals">=</span><span class="argument-default NoneType None">None</span></span><span class="argument-separator">,</span><span class="argument keywords">**kwargs</span></div></div><div class="item-header"><h5 class="item-title" id="pydwarf.uristdoc.txttemplate.metadata"><a href="../pydwarf/uristdoc.py">pydwarf.uristdoc.txttemplate.metadata</a></h5></div><div class="item-body"><div class="docstring undocumented">Undocumented</div><div class="arguments">Arguments: <span class="argument no-default"><span class="argument-name self">self</span></span><span class="argument-separator">,</span><span class="argument no-default"><span class="argument-name metadata">metadata</span></span></div></div></div></div></div></div><div class="item-header"><h3 class="item-title" id="pydwarf.uristscript"><a href="../pydwarf/uristscript.py">pydwarf.uristscript</a></h3></div><div class="item-body"><div class="docstring documented">Registered functions and their metadata are tracked by instances of this class.</div><div class="subs"><div class="item-header"><h4 class="item-title" id="pydwarf.uristscript.__call__"><a href="../pydwarf/uristscript.py">pydwarf.uristscript.__call__</a></h4></div><div class="item-body"><div class="docstring documented">Call the script's function with the given arguments.</div><div class="arguments">Arguments: <span class="argument no-default"><span class="argument-name self">self</span></span><span class="argument-separator">,</span><span class="argument no-default"><span class="argument-name df">df</span></span><span class="argument-separator">,</span><span class="argument varargs">*args</span><span class="argument-separator">,</span><span class="argument keywords">**kwargs</span></div></div><div class="item-header"><h4 class="item-title" id="pydwarf.uristscript.__hash__"><a href="../pydwarf/uristscript.py">pydwarf.uristscript.__hash__</a></h4></div><div class="item-body"><div class="docstring documented">Get a hash, even though registered functions aren't strictly immutable.</div><div class="arguments">Arguments: <span class="argument no-default"><span class="argument-name self">self</span></span></div></div><div class="item-header"><h4 class="item-title" id="pydwarf.uristscript.__init__"><a href="../pydwarf/uristscript.py">pydwarf.uristscript.__init__</a></h4></div><div class="item-body"><div class="docstring documented">Initialize an uristscript object.</div><div class="arguments">Arguments: <span class="argument no-default"><span class="argument-name self">self</span></span><span class="argument-separator">,</span><span class="argument no-default"><span class="argument-name func">func</span></span><span class="argument-separator">,</span><span class="argument keywords">**kwargs</span></div></div><div class="item-header"><h4 class="item-title" id="pydwarf.uristscript.__str__"><a href="../pydwarf/uristscript.py">pydwarf.uristscript.__str__</a></h4></div><div class="item-body"><div class="docstring documented">Get a string representation.</div><div class="arguments">Arguments: <span class="argument no-default"><span class="argument-name self">self</span></span></div></div><div class="item-header"><h4 class="item-title" id="pydwarf.uristscript.depsatisfied"><a href="../pydwarf/uristscript.py">pydwarf.uristscript.depsatisfied</a></h4></div><div class="item-body"><div class="docstring documented">Given a session determine if a script's dependencies have been satisfied.</div><div class="arguments">Arguments: <span class="argument no-default"><span class="argument-name self">self</span></span><span class="argument-separator">,</span><span class="argument no-default"><span class="argument-name session">session</span></span></div></div><div class="item-header"><h4 class="item-title" id="pydwarf.uristscript.doc"><a href="../pydwarf/uristscript.py">pydwarf.uristscript.doc</a></h4></div><div class="item-body"><div class="docstring documented">Make a pretty metadata string using the script's metadata.</div><div class="arguments">Arguments: <span class="argument no-default"><span class="argument-name self">self</span></span><span class="argument-separator">,</span><span class="argument has-default"><span class="argument-name format">format</span><span class="argument-equals">=</span><span class="argument-default NoneType None">None</span></span></div></div><div class="item-header"><h4 class="item-title" id="pydwarf.uristscript.getname"><a href="../pydwarf/uristscript.py">pydwarf.uristscript.getname</a></h4></div><div class="item-body"><div class="docstring documented">Get the script's full name, including namespace.</div><div class="arguments">Arguments: <span class="argument no-default"><span class="argument-name self">self</span></span></div></div><div class="item-header"><h4 class="item-title" id="pydwarf.uristscript.matches"><a href="../pydwarf/uristscript.py">pydwarf.uristscript.matches</a></h4></div><div class="item-body"><div class="docstring documented">Determine whether the script's metadata matches the keys, values in a dict.</div><div class="arguments">Arguments: <span class="argument no-default"><span class="argument-name self">self</span></span><span class="argument-separator">,</span><span class="argument no-default"><span class="argument-name match">match</span></span></div></div><div class="item-header"><h4 class="item-title" id="pydwarf.uristscript.meta"><a href="../pydwarf/uristscript.py">pydwarf.uristscript.meta</a></h4></div><div class="item-body"><div class="docstring documented">Get metadata attribute for the script by name.</div><div class="arguments">Arguments: <span class="argument no-default"><span class="argument-name self">self</span></span><span class="argument-separator">,</span><span class="argument no-default"><span class="argument-name key">key</span></span><span class="argument-separator">,</span><span class="argument has-default"><span class="argument-name default">default</span><span class="argument-equals">=</span><span class="argument-default NoneType None">None</span></span></div></div><div class="item-header"><h4 class="item-title" id="pydwarf.uristscript.setname"><a href="../pydwarf/uristscript.py">pydwarf.uristscript.setname</a></h4></div><div class="item-body"><div class="docstring documented">Set the script's name given a string.</div><div class="arguments">Arguments: <span class="argument no-default"><span class="argument-name self">self</span></span><span class="argument-separator">,</span><span class="argument no-default"><span class="argument-name name">name</span></span></div></div><div class="item-header"><h4 class="item-title" id="pydwarf.uristscript.within"><a href="../pydwarf/uristscript.py">pydwarf.uristscript.within</a></h4></div><div class="item-body"><div class="docstring documented">Check whether the script is contained within a namespace.</div><div class="arguments">Arguments: <span class="argument no-default"><span class="argument-name self">self</span></span><span class="argument-separator">,</span><span class="argument no-default"><span class="argument-name namespace">namespace</span></span></div><div class="examples"><pre class="highlight-example">>>> noexotic = pydwarf.scripts.pineapple.noexotic
>>> noexotic.within('example.namespace')
False
>>> noexotic.within('pineapple')
True</pre><div class="example-separator"></div><pre class="highlight-example">>>> scripts = pydwarf.urist.list()
>>> print '\n'.join(sorted(str(script) for script in scripts if script.within('umiman')))
umiman.smallthings.engraving
umiman.smallthings.prefstring
umiman.smallthings.speech.nofamily
umiman.smallthings.speech.threats</pre></div></div></div></div><div class="item-header"><h3 class="item-title" id="pydwarf.version"><a href="../pydwarf/version.py">pydwarf.version</a></h3></div><div class="item-body"><div class="docstring documented">Provide utilities for working with Dwarf Fortress version strings.</div></div></div></div><div class="item-header"><h2 class="item-title" id="raws"><a href="../raws/__init__.py">raws</a></h2></div><div class="item-body"><div class="docstring undocumented">Undocumented</div><div class="subs"><div class="item-header"><h3 class="item-title" id="raws.basefile"><a href="../raws/basefile.py">raws.basefile</a></h3></div><div class="item-body"><div class="docstring documented">
Base abstract class for file objects. The files which belong to dir
objects inherit from this class.
</div><div class="subs"><div class="item-header"><h4 class="item-title" id="raws.basefile.__eq__"><a href="../raws/basefile.py">raws.basefile.__eq__</a></h4></div><div class="item-body"><div class="docstring undocumented">Undocumented</div><div class="arguments">Arguments: <span class="argument no-default"><span class="argument-name self">self</span></span><span class="argument-separator">,</span><span class="argument no-default"><span class="argument-name other">other</span></span></div></div><div class="item-header"><h4 class="item-title" id="raws.basefile.__ge__"><a href="../raws/basefile.py">raws.basefile.__ge__</a></h4></div><div class="item-body"><div class="docstring undocumented">Undocumented</div><div class="arguments">Arguments: <span class="argument no-default"><span class="argument-name self">self</span></span><span class="argument-separator">,</span><span class="argument no-default"><span class="argument-name other">other</span></span></div></div><div class="item-header"><h4 class="item-title" id="raws.basefile.__gt__"><a href="../raws/basefile.py">raws.basefile.__gt__</a></h4></div><div class="item-body"><div class="docstring undocumented">Undocumented</div><div class="arguments">Arguments: <span class="argument no-default"><span class="argument-name self">self</span></span><span class="argument-separator">,</span><span class="argument no-default"><span class="argument-name other">other</span></span></div></div><div class="item-header"><h4 class="item-title" id="raws.basefile.__hash__"><a href="../raws/basefile.py">raws.basefile.__hash__</a></h4></div><div class="item-body"><div class="docstring documented">Get a hash based on the file's name. Be careful using this hash since file objects are not inherently immutable.</div><div class="arguments">Arguments: <span class="argument no-default"><span class="argument-name self">self</span></span></div></div><div class="item-header"><h4 class="item-title" id="raws.basefile.__init__"><a href="../raws/basefile.py">raws.basefile.__init__</a></h4></div><div class="item-body"><div class="docstring documented">Initialize a basefile object.</div><div class="arguments">Arguments: <span class="argument no-default"><span class="argument-name self">self</span></span></div></div><div class="item-header"><h4 class="item-title" id="raws.basefile.__le__"><a href="../raws/basefile.py">raws.basefile.__le__</a></h4></div><div class="item-body"><div class="docstring undocumented">Undocumented</div><div class="arguments">Arguments: <span class="argument no-default"><span class="argument-name self">self</span></span><span class="argument-separator">,</span><span class="argument no-default"><span class="argument-name other">other</span></span></div></div><div class="item-header"><h4 class="item-title" id="raws.basefile.__lt__"><a href="../raws/basefile.py">raws.basefile.__lt__</a></h4></div><div class="item-body"><div class="docstring undocumented">Undocumented</div><div class="arguments">Arguments: <span class="argument no-default"><span class="argument-name self">self</span></span><span class="argument-separator">,</span><span class="argument no-default"><span class="argument-name other">other</span></span></div></div><div class="item-header"><h4 class="item-title" id="raws.basefile.__ne__"><a href="../raws/basefile.py">raws.basefile.__ne__</a></h4></div><div class="item-body"><div class="docstring undocumented">Undocumented</div><div class="arguments">Arguments: <span class="argument no-default"><span class="argument-name self">self</span></span><span class="argument-separator">,</span><span class="argument no-default"><span class="argument-name other">other</span></span></div></div><div class="item-header"><h4 class="item-title" id="raws.basefile.__str__"><a href="../raws/basefile.py">raws.basefile.__str__</a></h4></div><div class="item-body"><div class="docstring documented">Get a string representation.</div><div class="arguments">Arguments: <span class="argument no-default"><span class="argument-name self">self</span></span></div></div><div class="item-header"><h4 class="item-title" id="raws.basefile.getext"><a href="../raws/basefile.py">raws.basefile.getext</a></h4></div><div class="item-body"><div class="docstring documented">Get the file extension.</div><div class="arguments">Arguments: <span class="argument no-default"><span class="argument-name self">self</span></span></div></div><div class="item-header"><h4 class="item-title" id="raws.basefile.getloc"><a href="../raws/basefile.py">raws.basefile.getloc</a></h4></div><div class="item-body"><div class="docstring documented">Get the file location relative to a dir object's root.</div><div class="arguments">Arguments: <span class="argument no-default"><span class="argument-name self">self</span></span></div></div><div class="item-header"><h4 class="item-title" id="raws.basefile.getname"><a href="../raws/basefile.py">raws.basefile.getname</a></h4></div><div class="item-body"><div class="docstring documented">Get the file name.</div><div class="arguments">Arguments: <span class="argument no-default"><span class="argument-name self">self</span></span></div><div class="examples"><pre class="highlight-example">>>> dwarf = df.getobj('CREATURE:DWARF')
>>> creature_standard = dwarf.file
>>> print creature_standard.getname()
creature_standard
>>> creature_standard.setname('example_header')
>>> print creature_standard.getname()
example_header
>>> creature_standard.setname('creature_standard')
>>> print creature_standard.getname()
creature_standard</pre></div></div><div class="item-header"><h4 class="item-title" id="raws.basefile.getpath"><a href="../raws/basefile.py">raws.basefile.getpath</a></h4></div><div class="item-body"><div class="docstring documented">Get the path of where the file is located.</div><div class="arguments">Arguments: <span class="argument no-default"><span class="argument-name self">self</span></span></div></div><div class="item-header"><h4 class="item-title" id="raws.basefile.reloc"><a href="../raws/basefile.py">raws.basefile.reloc</a></h4></div><div class="item-body"><div class="docstring documented">Set the file location relative to its current location.</div><div class="arguments">Arguments: <span class="argument no-default"><span class="argument-name self">self</span></span><span class="argument-separator">,</span><span class="argument no-default"><span class="argument-name loc">loc</span></span></div></div><div class="item-header"><h4 class="item-title" id="raws.basefile.remove"><a href="../raws/basefile.py">raws.basefile.remove</a></h4></div><div class="item-body"><div class="docstring documented">Remove this file from the dir object to which it belongs.</div><div class="arguments">Arguments: <span class="argument no-default"><span class="argument-name self">self</span></span></div><div class="examples"><pre class="highlight-example">>>> dflen = len(df)
>>> df['raw/objects/creature_standard.txt'].remove()
>>> print dflen - len(df)
1</pre></div></div><div class="item-header"><h4 class="item-title" id="raws.basefile.setext"><a href="../raws/basefile.py">raws.basefile.setext</a></h4></div><div class="item-body"><div class="docstring documented">Set the file extension.</div><div class="arguments">Arguments: <span class="argument no-default"><span class="argument-name self">self</span></span><span class="argument-separator">,</span><span class="argument no-default"><span class="argument-name ext">ext</span></span></div></div><div class="item-header"><h4 class="item-title" id="raws.basefile.setloc"><a href="../raws/basefile.py">raws.basefile.setloc</a></h4></div><div class="item-body"><div class="docstring documented">Set the file location relative to a dir object's root.</div><div class="arguments">Arguments: <span class="argument no-default"><span class="argument-name self">self</span></span><span class="argument-separator">,</span><span class="argument no-default"><span class="argument-name loc">loc</span></span></div></div><div class="item-header"><h4 class="item-title" id="raws.basefile.setname"><a href="../raws/basefile.py">raws.basefile.setname</a></h4></div><div class="item-body"><div class="docstring documented">Set the file name.</div><div class="arguments">Arguments: <span class="argument no-default"><span class="argument-name self">self</span></span><span class="argument-separator">,</span><span class="argument no-default"><span class="argument-name name">name</span></span></div><div class="examples"><pre class="highlight-example">>>> dwarf = df.getobj('CREATURE:DWARF')
>>> creature_standard = dwarf.file
>>> print creature_standard.getname()
creature_standard
>>> creature_standard.setname('example_header')
>>> print creature_standard.getname()
example_header
>>> creature_standard.setname('creature_standard')
>>> print creature_standard.getname()
creature_standard</pre></div></div><div class="item-header"><h4 class="item-title" id="raws.basefile.setpath"><a href="../raws/basefile.py">raws.basefile.setpath</a></h4></div><div class="item-body"><div class="docstring documented">
Set path for file, and set other important attributes like name,
extension, location while we're at it.
</div><div class="arguments">Arguments: <span class="argument no-default"><span class="argument-name self">self</span></span><span class="argument-separator">,</span><span class="argument no-default"><span class="argument-name path">path</span></span><span class="argument-separator">,</span><span class="argument has-default"><span class="argument-name root">root</span><span class="argument-equals">=</span><span class="argument-default NoneType None">None</span></span><span class="argument-separator">,</span><span class="argument has-default"><span class="argument-name loc">loc</span><span class="argument-equals">=</span><span class="argument-default NoneType None">None</span></span><span class="argument-separator">,</span><span class="argument has-default"><span class="argument-name name">name</span><span class="argument-equals">=</span><span class="argument-default NoneType None">None</span></span><span class="argument-separator">,</span><span class="argument has-default"><span class="argument-name ext">ext</span><span class="argument-equals">=</span><span class="argument-default NoneType None">None</span></span></div></div></div></div><div class="item-header"><h3 class="item-title" id="raws.basefilter"><a href="../raws/filters.py">raws.basefilter</a></h3></div><div class="item-body"><div class="docstring documented">Base class for filter objects.</div><div class="subs"><div class="item-header"><h4 class="item-title" id="raws.basefilter.__and__"><a href="../raws/filters.py">raws.basefilter.__and__</a></h4></div><div class="item-body"><div class="docstring documented">Return a filter representing A AND B.</div><div class="arguments">Arguments: <span class="argument no-default"><span class="argument-name self">self</span></span><span class="argument-separator">,</span><span class="argument no-default"><span class="argument-name other">other</span></span></div></div><div class="item-header"><h4 class="item-title" id="raws.basefilter.__call__"><a href="../raws/filters.py">raws.basefilter.__call__</a></h4></div><div class="item-body"><div class="docstring documented">
Check if the filter matches a token and whether a performing query
should be terminated.
</div><div class="arguments">Arguments: <span class="argument no-default"><span class="argument-name self">self</span></span><span class="argument-separator">,</span><span class="argument no-default"><span class="argument-name token">token</span></span><span class="argument-separator">,</span><span class="argument no-default"><span class="argument-name count">count</span></span></div></div><div class="item-header"><h4 class="item-title" id="raws.basefilter.__contains__"><a href="../raws/filters.py">raws.basefilter.__contains__</a></h4></div><div class="item-body"><div class="docstring documented">Check if the filter matches a token.</div><div class="arguments">Arguments: <span class="argument no-default"><span class="argument-name self">self</span></span><span class="argument-separator">,</span><span class="argument no-default"><span class="argument-name token">token</span></span></div></div><div class="item-header"><h4 class="item-title" id="raws.basefilter.__init__"><a href="../raws/filters.py">raws.basefilter.__init__</a></h4></div><div class="item-body"><div class="docstring documented">Initialize a filter object.</div><div class="arguments">Arguments: <span class="argument no-default"><span class="argument-name self">self</span></span><span class="argument-separator">,</span><span class="argument has-default"><span class="argument-name invert">invert</span><span class="argument-equals">=</span><span class="argument-default bool False">False</span></span><span class="argument-separator">,</span><span class="argument has-default"><span class="argument-name limit">limit</span><span class="argument-equals">=</span><span class="argument-default NoneType None">None</span></span><span class="argument-separator">,</span><span class="argument has-default"><span class="argument-name limit_terminates">limit_terminates</span><span class="argument-equals">=</span><span class="argument-default bool True">True</span></span></div></div><div class="item-header"><h4 class="item-title" id="raws.basefilter.__invert__"><a href="../raws/filters.py">raws.basefilter.__invert__</a></h4></div><div class="item-body"><div class="docstring documented">Cause the filter to return the inverse of what it otherwise would.</div><div class="arguments">Arguments: <span class="argument no-default"><span class="argument-name self">self</span></span></div><div class="examples"><pre class="highlight-example">>>> filter = raws.filter(exact_value='hello', invert=True)
>>> print filter.match(raws.token('hello'))
False
>>> print filter.match(raws.token('world'))
True
>>> filter = ~raws.filter(exact_value='world')
>>> print filter.match(raws.token('hello'))
True
>>> print filter.match(raws.token('world'))
False</pre></div></div><div class="item-header"><h4 class="item-title" id="raws.basefilter.__or__"><a href="../raws/filters.py">raws.basefilter.__or__</a></h4></div><div class="item-body"><div class="docstring documented">Return a filter representing A OR B.</div><div class="arguments">Arguments: <span class="argument no-default"><span class="argument-name self">self</span></span><span class="argument-separator">,</span><span class="argument no-default"><span class="argument-name other">other</span></span></div><div class="examples"><pre class="highlight-example">>>> filter = raws.filter(exact_value='example') | raws.filter(exact_arg='token')
>>> print filter.match(raws.token('example:token'))
True
>>> print filter.match(raws.token('example:hello'))
True
>>> print filter.match(raws.token('hello:token'))
True
>>> print filter.match(raws.token('hello:world'))
False</pre></div></div><div class="item-header"><h4 class="item-title" id="raws.basefilter.__xor__"><a href="../raws/filters.py">raws.basefilter.__xor__</a></h4></div><div class="item-body"><div class="docstring documented">Return a filter representing A XOR B.</div><div class="arguments">Arguments: <span class="argument no-default"><span class="argument-name self">self</span></span><span class="argument-separator">,</span><span class="argument no-default"><span class="argument-name other">other</span></span></div></div><div class="item-header"><h4 class="item-title" id="raws.basefilter.copy"><a href="../raws/filters.py">raws.basefilter.copy</a></h4></div><div class="item-body"><div class="docstring documented">Make a copy of the filter.</div><div class="arguments">Arguments: <span class="argument no-default"><span class="argument-name self">self</span></span></div></div><div class="item-header"><h4 class="item-title" id="raws.basefilter.eval"><a href="../raws/filters.py">raws.basefilter.eval</a></h4></div><div class="item-body"><div class="docstring documented">
Check if the filter matches a token and whether a performing query
should be terminated.
</div><div class="arguments">Arguments: <span class="argument no-default"><span class="argument-name self">self</span></span><span class="argument-separator">,</span><span class="argument no-default"><span class="argument-name token">token</span></span><span class="argument-separator">,</span><span class="argument no-default"><span class="argument-name count">count</span></span></div></div><div class="item-header"><h4 class="item-title" id="raws.basefilter.invert"><a href="../raws/filters.py">raws.basefilter.invert</a></h4></div><div class="item-body"><div class="docstring documented">Cause the filter to return the inverse of what it otherwise would.</div><div class="arguments">Arguments: <span class="argument no-default"><span class="argument-name self">self</span></span></div></div><div class="item-header"><h4 class="item-title" id="raws.basefilter.inverted"><a href="../raws/filters.py">raws.basefilter.inverted</a></h4></div><div class="item-body"><div class="docstring documented">Return an inverted copy of the filter.</div><div class="arguments">Arguments: <span class="argument no-default"><span class="argument-name self">self</span></span></div></div><div class="item-header"><h4 class="item-title" id="raws.basefilter.match"><a href="../raws/filters.py">raws.basefilter.match</a></h4></div><div class="item-body"><div class="docstring documented">Check if the filter matches a token.</div><div class="arguments">Arguments: <span class="argument no-default"><span class="argument-name self">self</span></span><span class="argument-separator">,</span><span class="argument no-default"><span class="argument-name token">token</span></span></div><div class="examples"><pre class="highlight-example">>>> filter = raws.filter('EXAMPLE:TOKEN')
>>> print filter.match(raws.token('EXAMPLE:TOKEN'))
True
>>> print filter.match(raws.token('EXAMPLE:TOKEN:NO:MATCH'))
False</pre></div></div></div></div><div class="item-header"><h3 class="item-title" id="raws.binfile"><a href="../raws/binfile.py">raws.binfile</a></h3><span class="inherits-from">inherits from</span><a class="superclass" href="#raws.basefile">raws.basefile</a><span class="superclass-delimeter">,</span><a class="superclass" href="#raws.contentfile">raws.contentfile</a></div><div class="item-body"><div class="docstring documented">
File class which is represented by a string containing its binary
contents. Good for files which must have their content exposed or be
manipulated but don't have their own specialized class.
</div><div class="subs"><div class="item-header"><h4 class="item-title" id="raws.binfile.__iadd__"><a href="../raws/binfile.py">raws.binfile.__iadd__</a></h4></div><div class="item-body"><div class="docstring documented">Add to the end of the file's content string.</div><div class="arguments">Arguments: <span class="argument no-default"><span class="argument-name self">self</span></span><span class="argument-separator">,</span><span class="argument no-default"><span class="argument-name content">content</span></span></div></div><div class="item-header"><h4 class="item-title" id="raws.binfile.__init__"><a href="../raws/binfile.py">raws.binfile.__init__</a></h4></div><div class="item-body"><div class="docstring documented">Initialize a binfile object.</div><div class="arguments">Arguments: <span class="argument no-default"><span class="argument-name self">self</span></span><span class="argument-separator">,</span><span class="argument has-default"><span class="argument-name path">path</span><span class="argument-equals">=</span><span class="argument-default NoneType None">None</span></span><span class="argument-separator">,</span><span class="argument has-default"><span class="argument-name content">content</span><span class="argument-equals">=</span><span class="argument-default NoneType None">None</span></span><span class="argument-separator">,</span><span class="argument has-default"><span class="argument-name dir">dir</span><span class="argument-equals">=</span><span class="argument-default NoneType None">None</span></span><span class="argument-separator">,</span><span class="argument keywords">**kwargs</span></div><div class="examples"><pre class="highlight-example">>>> newfile = raws.binfile('data/init/newfile.txt')
>>> print newfile.loc
data/init
>>> print newfile.name
newfile
>>> print newfile.ext
.txt
>>> print newfile in df
False
>>> print 'data/init/newfile.txt' in df
False
>>> added = df.add(newfile) # returns the newfile object
>>> print newfile in df
True
>>> print 'data/init/newfile.txt' in df
True</pre></div></div><div class="item-header"><h4 class="item-title" id="raws.binfile.__len__"><a href="../raws/binfile.py">raws.binfile.__len__</a></h4></div><div class="item-body"><div class="docstring documented">Get the length in bytes of the file's binary data string.</div><div class="arguments">Arguments: <span class="argument no-default"><span class="argument-name self">self</span></span></div><div class="examples"><pre class="highlight-example">15
>>> print len(df['data/speech/no_family.txt'].bin())
28
>>> responses = pydwarf.scripts.umiman.smallthings.speech(df)
>>> print '\n'.join('%s: %s' % (key, value) for key, value in responses.iteritems())
threats: SUCCESS: Ran successfully.
nofamily: SUCCESS: Ran successfully.
>>> print len(df['data/speech/threat.txt'])
8953
>>> print len(df['data/speech/no_family.txt'])
1720</pre></div></div><div class="item-header"><h4 class="item-title" id="raws.binfile.add"><a href="../raws/binfile.py">raws.binfile.add</a></h4></div><div class="item-body"><div class="docstring documented">Add to the end of the file's content string.</div><div class="arguments">Arguments: <span class="argument no-default"><span class="argument-name self">self</span></span><span class="argument-separator">,</span><span class="argument no-default"><span class="argument-name content">content</span></span></div></div><div class="item-header"><h4 class="item-title" id="raws.binfile.bin"><a href="../raws/binfile.py">raws.binfile.bin</a></h4></div><div class="item-body"><div class="docstring undocumented">Undocumented</div><div class="arguments">Arguments: <span class="argument no-default"><span class="argument-name self">self</span></span><span class="argument-separator">,</span><span class="argument keywords">**kwargs</span></div></div><div class="item-header"><h4 class="item-title" id="raws.binfile.copy"><a href="../raws/binfile.py">raws.binfile.copy</a></h4></div><div class="item-body"><div class="docstring documented">Create a copy of the file.</div><div class="arguments">Arguments: <span class="argument no-default"><span class="argument-name self">self</span></span></div></div><div class="item-header"><h4 class="item-title" id="raws.binfile.raw"><a href="../raws/binfile.py">raws.binfile.raw</a></h4></div><div class="item-body"><div class="docstring undocumented">Undocumented</div><div class="arguments">Arguments: <span class="argument no-default"><span class="argument-name self">self</span></span><span class="argument-separator">,</span><span class="argument keywords">**kwargs</span></div></div><div class="item-header"><h4 class="item-title" id="raws.binfile.ref"><a href="../raws/binfile.py">raws.binfile.ref</a></h4></div><div class="item-body"><div class="docstring undocumented">Undocumented</div><div class="arguments">Arguments: <span class="argument no-default"><span class="argument-name self">self</span></span><span class="argument-separator">,</span><span class="argument keywords">**kwargs</span></div></div></div></div><div class="item-header"><h3 class="item-title" id="raws.boolfilter"><a href="../raws/filters.py">raws.boolfilter</a></h3><span class="inherits-from">inherits from</span><a class="superclass" href="#raws.basefilter">raws.basefilter</a></div><div class="item-body"><div class="docstring documented">Logical filter for combining other filters.</div><div class="subs"><div class="item-header"><h4 class="item-title" id="raws.boolfilter.__init__"><a href="../raws/filters.py">raws.boolfilter.__init__</a></h4></div><div class="item-body"><div class="docstring documented">Initialize a filter object.</div><div class="arguments">Arguments: <span class="argument no-default"><span class="argument-name self">self</span></span><span class="argument-separator">,</span><span class="argument no-default"><span class="argument-name subs">subs</span></span><span class="argument-separator">,</span><span class="argument has-default"><span class="argument-name operand">operand</span><span class="argument-equals">=</span><span class="argument-default NoneType None">None</span></span><span class="argument-separator">,</span><span class="argument has-default"><span class="argument-name invert">invert</span><span class="argument-equals">=</span><span class="argument-default NoneType None">None</span></span><span class="argument-separator">,</span><span class="argument has-default"><span class="argument-name limit">limit</span><span class="argument-equals">=</span><span class="argument-default NoneType None">None</span></span><span class="argument-separator">,</span><span class="argument has-default"><span class="argument-name limit_terminates">limit_terminates</span><span class="argument-equals">=</span><span class="argument-default bool True">True</span></span></div></div><div class="item-header"><h4 class="item-title" id="raws.boolfilter.__str__"><a href="../raws/filters.py">raws.boolfilter.__str__</a></h4></div><div class="item-body"><div class="docstring documented">Get a string representation.</div><div class="arguments">Arguments: <span class="argument no-default"><span class="argument-name self">self</span></span></div></div></div></div><div class="item-header"><h3 class="item-title" id="raws.color"><a href="../raws/color.py">raws.color</a></h3></div><div class="item-body"><div class="docstring documented">
A bit of clever hackishness to provide a convenient syntax for working with
color definitions in raws files.
</div><div class="subs"><div class="item-header"><h4 class="item-title" id="raws.color.bg"><a href="../raws/color.py">raws.color.bg</a></h4></div><div class="item-body"><div class="docstring documented">Extract background color record from a set of three token arguments.</div><div class="arguments">Arguments: <span class="argument no-default"><span class="argument-name args">args</span></span></div><div class="examples"><pre class="highlight-example">>>> token = raws.token('COLOR:7:0:0')
>>> print raws.color.fg(token)
white
>>> print raws.color.bg(token)
black</pre></div></div><div class="item-header"><h4 class="item-title" id="raws.color.fg"><a href="../raws/color.py">raws.color.fg</a></h4></div><div class="item-body"><div class="docstring documented">Extract foreground color record from a set of three token arguments.</div><div class="arguments">Arguments: <span class="argument no-default"><span class="argument-name args">args</span></span></div><div class="examples"><pre class="highlight-example">>>> token = raws.token('COLOR:7:0:0')
>>> print raws.color.fg(token)
white
>>> print raws.color.bg(token)
black</pre></div></div><div class="item-header"><h4 class="item-title" id="raws.color.get"><a href="../raws/color.py">raws.color.get</a></h4></div><div class="item-body"><div class="docstring documented">Get a color record by value and optional intensity.</div><div class="arguments">Arguments: <span class="argument no-default"><span class="argument-name value">value</span></span><span class="argument-separator">,</span><span class="argument has-default"><span class="argument-name i">i</span><span class="argument-equals">=</span><span class="argument-default int 0">0</span></span></div><div class="examples"><pre class="highlight-example">>>> print raws.color.blue
blue
>>> print raws.color.blue()
1:0:0
>>> print raws.color.get(1)
blue</pre><div class="example-separator"></div><pre class="highlight-example">>>> print '\n'.join(str(raws.color.get(index)) for index in range(0, 16))
black
blue
green
cyan
red
magenta
brown
lgray
dgray
lblue
lgreen
lcyan
lred
lmagenta
yellow
white</pre></div></div><div class="item-header"><h4 class="item-title" id="raws.color.group"><a href="../raws/color.py">raws.color.group</a></h4></div><div class="item-body"><div class="docstring documented">
Combine two color records to get a single list of foreground,
background, intensity arguments.
</div><div class="arguments">Arguments: <span class="argument has-default"><span class="argument-name fg">fg</span><span class="argument-equals">=</span><span class="argument-default NoneType None">None</span></span><span class="argument-separator">,</span><span class="argument has-default"><span class="argument-name bg">bg</span><span class="argument-equals">=</span><span class="argument-default NoneType None">None</span></span></div><div class="examples"><pre class="highlight-example">>>> print raws.color.yellow()
6:0:1
>>> print raws.color.blue()
1:0:0
>>> print raws.color.group(raws.color.yellow, raws.color.blue)
6:1:1
>>> print raws.color.group(raws.color.blue, raws.color.yellow)
1:14:0</pre></div></div><div class="item-header"><h4 class="item-title" id="raws.color.record"><a href="../raws/color.py">raws.color.record</a></h4></div><div class="item-body"><div class="docstring documented">
Instances record name and index information associated with each of
Dwarf Fortress' sixteen colors.
</div><div class="subs"><div class="item-header"><h5 class="item-title" id="raws.color.record.__add__"><a href="../raws/color.py">raws.color.record.__add__</a></h5></div><div class="item-body"><div class="docstring undocumented">Undocumented</div><div class="arguments">Arguments: <span class="argument no-default"><span class="argument-name self">self</span></span><span class="argument-separator">,</span><span class="argument no-default"><span class="argument-name value">value</span></span></div></div><div class="item-header"><h5 class="item-title" id="raws.color.record.__call__"><a href="../raws/color.py">raws.color.record.__call__</a></h5></div><div class="item-body"><div class="docstring documented">Get token arguments representing this color as the foreground.</div><div class="arguments">Arguments: <span class="argument no-default"><span class="argument-name self">self</span></span><span class="argument-separator">,</span><span class="argument varargs">*args</span><span class="argument-separator">,</span><span class="argument keywords">**kwargs</span></div><div class="examples"><pre class="highlight-example">>>> print raws.color.blue
blue
>>> print raws.color.blue()
1:0:0
>>> print raws.color.get(1)
blue</pre><div class="example-separator"></div><pre class="highlight-example">>>> print raws.color.green()
2:0:0
>>> print raws.color.lgreen()
2:0:1
>>> print int(raws.color.green)
2
>>> print int(raws.color.lgreen)
10</pre><div class="example-separator"></div><pre class="highlight-example">>>> print raws.color.green.fg()
2:0:0
>>> print raws.color.blue.bg()
0:1:0
>>> print raws.color.group(raws.color.green, raws.color.blue)
2:1:0
>>> print raws.color.green(raws.color.blue)
2:1:0
>>> print raws.color.blue(raws.color.green)
1:2:0</pre></div></div><div class="item-header"><h5 class="item-title" id="raws.color.record.__div__"><a href="../raws/color.py">raws.color.record.__div__</a></h5></div><div class="item-body"><div class="docstring undocumented">Undocumented</div><div class="arguments">Arguments: <span class="argument no-default"><span class="argument-name self">self</span></span><span class="argument-separator">,</span><span class="argument no-default"><span class="argument-name value">value</span></span></div></div><div class="item-header"><h5 class="item-title" id="raws.color.record.__eq__"><a href="../raws/color.py">raws.color.record.__eq__</a></h5></div><div class="item-body"><div class="docstring undocumented">Undocumented</div><div class="arguments">Arguments: <span class="argument no-default"><span class="argument-name self">self</span></span><span class="argument-separator">,</span><span class="argument no-default"><span class="argument-name value">value</span></span></div></div><div class="item-header"><h5 class="item-title" id="raws.color.record.__init__"><a href="../raws/color.py">raws.color.record.__init__</a></h5></div><div class="item-body"><div class="docstring documented">Initialize a color record.</div><div class="arguments">Arguments: <span class="argument no-default"><span class="argument-name self">self</span></span><span class="argument-separator">,</span><span class="argument no-default"><span class="argument-name name">name</span></span><span class="argument-separator">,</span><span class="argument no-default"><span class="argument-name value">value</span></span></div></div><div class="item-header"><h5 class="item-title" id="raws.color.record.__int__"><a href="../raws/color.py">raws.color.record.__int__</a></h5></div><div class="item-body"><div class="docstring documented">Get the color index associated with the record.</div><div class="arguments">Arguments: <span class="argument no-default"><span class="argument-name self">self</span></span></div><div class="examples"><pre class="highlight-example">>>> print raws.color.green()
2:0:0
>>> print raws.color.lgreen()
2:0:1
>>> print int(raws.color.green)
2
>>> print int(raws.color.lgreen)
10</pre></div></div><div class="item-header"><h5 class="item-title" id="raws.color.record.__mod__"><a href="../raws/color.py">raws.color.record.__mod__</a></h5></div><div class="item-body"><div class="docstring undocumented">Undocumented</div><div class="arguments">Arguments: <span class="argument no-default"><span class="argument-name self">self</span></span><span class="argument-separator">,</span><span class="argument no-default"><span class="argument-name value">value</span></span></div></div><div class="item-header"><h5 class="item-title" id="raws.color.record.__mul__"><a href="../raws/color.py">raws.color.record.__mul__</a></h5></div><div class="item-body"><div class="docstring undocumented">Undocumented</div><div class="arguments">Arguments: <span class="argument no-default"><span class="argument-name self">self</span></span><span class="argument-separator">,</span><span class="argument no-default"><span class="argument-name value">value</span></span></div></div><div class="item-header"><h5 class="item-title" id="raws.color.record.__ne__"><a href="../raws/color.py">raws.color.record.__ne__</a></h5></div><div class="item-body"><div class="docstring undocumented">Undocumented</div><div class="arguments">Arguments: <span class="argument no-default"><span class="argument-name self">self</span></span><span class="argument-separator">,</span><span class="argument no-default"><span class="argument-name value">value</span></span></div></div><div class="item-header"><h5 class="item-title" id="raws.color.record.__str__"><a href="../raws/color.py">raws.color.record.__str__</a></h5></div><div class="item-body"><div class="docstring documented">Get the name of the color record.</div><div class="arguments">Arguments: <span class="argument no-default"><span class="argument-name self">self</span></span></div><div class="examples"><pre class="highlight-example">>>> print raws.color.blue
blue
>>> print raws.color.blue()
1:0:0
>>> print raws.color.get(1)
blue</pre></div></div><div class="item-header"><h5 class="item-title" id="raws.color.record.__sub__"><a href="../raws/color.py">raws.color.record.__sub__</a></h5></div><div class="item-body"><div class="docstring undocumented">Undocumented</div><div class="arguments">Arguments: <span class="argument no-default"><span class="argument-name self">self</span></span><span class="argument-separator">,</span><span class="argument no-default"><span class="argument-name value">value</span></span></div></div><div class="item-header"><h5 class="item-title" id="raws.color.record.bg"><a href="../raws/color.py">raws.color.record.bg</a></h5></div><div class="item-body"><div class="docstring documented">Get token arguments representing this color as the background.</div><div class="arguments">Arguments: <span class="argument no-default"><span class="argument-name self">self</span></span></div><div class="examples"><pre class="highlight-example">>>> print raws.color.red.fg()
4:0:0
>>> print raws.color.red.bg()
0:4:0
>>> print raws.color.lred.fg()
4:0:1
>>> print raws.color.lred.bg()
0:12:0</pre></div></div><div class="item-header"><h5 class="item-title" id="raws.color.record.fg"><a href="../raws/color.py">raws.color.record.fg</a></h5></div><div class="item-body"><div class="docstring documented">Get token arguments representing this color as the foreground.</div><div class="arguments">Arguments: <span class="argument no-default"><span class="argument-name self">self</span></span><span class="argument-separator">,</span><span class="argument has-default"><span class="argument-name bg">bg</span><span class="argument-equals">=</span><span class="argument-default int 0">0</span></span><span class="argument-separator">,</span><span class="argument has-default"><span class="argument-name i">i</span><span class="argument-equals">=</span><span class="argument-default int 0">0</span></span></div><div class="examples"><pre class="highlight-example">>>> print raws.color.red.fg()
4:0:0
>>> print raws.color.red.bg()
0:4:0
>>> print raws.color.lred.fg()
4:0:1
>>> print raws.color.lred.bg()
0:12:0</pre></div></div></div></div></div></div><div class="item-header"><h3 class="item-title" id="raws.contentfile"><a href="../raws/contentfile.py">raws.contentfile</a></h3><span class="inherits-from">inherits from</span><a class="superclass" href="#raws.basefile">raws.basefile</a></div><div class="item-body"><div class="docstring documented">Base class for file classes which can have their contents represented as a string.</div><div class="subs"><div class="item-header"><h4 class="item-title" id="raws.contentfile.__init__"><a href="../raws/contentfile.py">raws.contentfile.__init__</a></h4></div><div class="item-body"><div class="docstring undocumented">Undocumented</div><div class="arguments">Arguments: <span class="argument no-default"><span class="argument-name self">self</span></span></div></div><div class="item-header"><h4 class="item-title" id="raws.contentfile.getcontent"><a href="../raws/contentfile.py">raws.contentfile.getcontent</a></h4></div><div class="item-body"><div class="docstring documented">Get the file's content.</div><div class="arguments">Arguments: <span class="argument no-default"><span class="argument-name self">self</span></span></div></div><div class="item-header"><h4 class="item-title" id="raws.contentfile.read"><a href="../raws/contentfile.py">raws.contentfile.read</a></h4></div><div class="item-body"><div class="docstring documented">Read the file contents given a path or file-like object.</div><div class="arguments">Arguments: <span class="argument no-default"><span class="argument-name self">self</span></span><span class="argument-separator">,</span><span class="argument has-default"><span class="argument-name file">file</span><span class="argument-equals">=</span><span class="argument-default NoneType None">None</span></span></div></div><div class="item-header"><h4 class="item-title" id="raws.contentfile.setcontent"><a href="../raws/contentfile.py">raws.contentfile.setcontent</a></h4></div><div class="item-body"><div class="docstring documented">Set the file's content.</div><div class="arguments">Arguments: <span class="argument no-default"><span class="argument-name self">self</span></span><span class="argument-separator">,</span><span class="argument no-default"><span class="argument-name content">content</span></span></div></div><div class="item-header"><h4 class="item-title" id="raws.contentfile.write"><a href="../raws/contentfile.py">raws.contentfile.write</a></h4></div><div class="item-body"><div class="docstring documented">Write the file contents to a path or file-like object.</div><div class="arguments">Arguments: <span class="argument no-default"><span class="argument-name self">self</span></span><span class="argument-separator">,</span><span class="argument no-default"><span class="argument-name file">file</span></span></div></div></div></div><div class="item-header"><h3 class="item-title" id="raws.copy"><a href="../raws/helpers.py">raws.copy</a></h3></div><div class="item-body"><div class="docstring documented">Copy a raws object.</div><div class="arguments">Arguments: <span class="argument no-default"><span class="argument-name item">item</span></span><span class="argument-separator">,</span><span class="argument varargs">*args</span><span class="argument-separator">,</span><span class="argument keywords">**kwargs</span></div></div><div class="item-header"><h3 class="item-title" id="raws.copytree"><a href="../raws/copytree.py">raws.copytree</a></h3></div><div class="item-body"><div class="docstring undocumented">Undocumented</div><div class="arguments">Arguments: <span class="argument no-default"><span class="argument-name src">src</span></span><span class="argument-separator">,</span><span class="argument no-default"><span class="argument-name dst">dst</span></span><span class="argument-separator">,</span><span class="argument has-default"><span class="argument-name symlinks">symlinks</span><span class="argument-equals">=</span><span class="argument-default bool False">False</span></span><span class="argument-separator">,</span><span class="argument has-default"><span class="argument-name ignore">ignore</span><span class="argument-equals">=</span><span class="argument-default NoneType None">None</span></span></div></div><div class="item-header"><h3 class="item-title" id="raws.dir"><a href="../raws/dir.py">raws.dir</a></h3><span class="inherits-from">inherits from</span><a class="superclass" href="#raws.queryable">raws.queryable</a><span class="superclass-delimeter">,</span><a class="superclass" href="#raws.queryableobj">raws.queryableobj</a></div><div class="item-body"><div class="docstring documented">Represents files contained within a Dwarf Fortress directory.</div><div class="subs"><div class="item-header"><h4 class="item-title" id="raws.dir.__contains__"><a href="../raws/dir.py">raws.dir.__contains__</a></h4></div><div class="item-body"><div class="docstring documented">Check if the dir contains a file name or object.</div><div class="arguments">Arguments: <span class="argument no-default"><span class="argument-name self">self</span></span><span class="argument-separator">,</span><span class="argument no-default"><span class="argument-name item">item</span></span></div><div class="examples"><pre class="highlight-example">>>> print 'raw/objects/creature_standard.txt' in df
True
>>> print 'creature_standard' in df
True
>>> print 'not_a_file' in df
False
>>> food = df['item_food']
>>> print food in df
True
>>> newfile = raws.binfile()
>>> print newfile in df
False</pre><div class="example-separator"></div><pre class="highlight-example">>>> newfile = raws.binfile('data/init/newfile.txt')
>>> print newfile.loc
data/init
>>> print newfile.name
newfile
>>> print newfile.ext
.txt
>>> print newfile in df
False
>>> print 'data/init/newfile.txt' in df
False
>>> added = df.add(newfile) # returns the newfile object
>>> print newfile in df
True
>>> print 'data/init/newfile.txt' in df
True</pre></div></div><div class="item-header"><h4 class="item-title" id="raws.dir.__delitem__"><a href="../raws/dir.py">raws.dir.__delitem__</a></h4></div><div class="item-body"><div class="docstring documented">Remove a file from this dir.</div><div class="arguments">Arguments: <span class="argument no-default"><span class="argument-name self">self</span></span><span class="argument-separator">,</span><span class="argument no-default"><span class="argument-name file">file</span></span></div><div class="examples"><pre class="highlight-example">>>> dflen = len(df) # Track original number of files
>>> df.remove('raw/objects/item_pants.txt')
>>> del df['data/init/init.txt']
>>> df -= 'data/init/colors.txt'
>>> print dflen - len(df) # Three fewer files now
3
>>> df.reset()
>>> print dflen == len(df) # Back to the original number
True</pre></div></div><div class="item-header"><h4 class="item-title" id="raws.dir.__enter__"><a href="../raws/dir.py">raws.dir.__enter__</a></h4></div><div class="item-body"><div class="docstring documented">Support for with/as syntax.</div><div class="arguments">Arguments: <span class="argument no-default"><span class="argument-name self">self</span></span></div></div><div class="item-header"><h4 class="item-title" id="raws.dir.__eq__"><a href="../raws/dir.py">raws.dir.__eq__</a></h4></div><div class="item-body"><div class="docstring documented">Check equivalency with another dir object.</div><div class="arguments">Arguments: <span class="argument no-default"><span class="argument-name self">self</span></span><span class="argument-separator">,</span><span class="argument no-default"><span class="argument-name other">other</span></span></div><div class="examples"><pre class="highlight-example">>>> dfcopy = df.copy()
>>> print dfcopy == df
True
>>> dwarf = dfcopy.getobj('CREATURE:DWARF')
>>> token = dwarf.add('MAKE:THE:COPY:DIFFERENT')
>>> print dfcopy == df
False</pre></div></div><div class="item-header"><h4 class="item-title" id="raws.dir.__exit__"><a href="../raws/dir.py">raws.dir.__exit__</a></h4></div><div class="item-body"><div class="docstring documented">Support for with/as syntax.</div><div class="arguments">Arguments: <span class="argument no-default"><span class="argument-name self">self</span></span><span class="argument-separator">,</span><span class="argument no-default"><span class="argument-name type">type</span></span><span class="argument-separator">,</span><span class="argument no-default"><span class="argument-name value">value</span></span><span class="argument-separator">,</span><span class="argument no-default"><span class="argument-name traceback">traceback</span></span></div></div><div class="item-header"><h4 class="item-title" id="raws.dir.__getitem__"><a href="../raws/dir.py">raws.dir.__getitem__</a></h4></div><div class="item-body"><div class="docstring documented">Get member file by name or full relative path.</div><div class="arguments">Arguments: <span class="argument no-default"><span class="argument-name self">self</span></span><span class="argument-separator">,</span><span class="argument no-default"><span class="argument-name name">name</span></span></div><div class="examples"><pre class="highlight-example">>>> df['raw/objects/creature_standard.txt'] is df['creature_standard']
True</pre><div class="example-separator"></div><pre class="highlight-example">>>> file = df['not_a_real_file']
Traceback (most recent call last):
File "<stdin>", line 1, in <module>
File "raws/dir.py", line 39, in __getitem__
return self.getfile(name)
File "raws/dir.py", line 116, in getfile
raise KeyError('Failed to find file name "%s" in dir.')
KeyError: 'Failed to find file name "not_a_real_file" in dir.'</pre><div class="example-separator"></div><pre class="highlight-example">>>> print df['item_food'].all()
[OBJECT:ITEM]
[ITEM_FOOD:ITEM_FOOD_BISCUITS]
[NAME:biscuits]
[LEVEL:2]
[ITEM_FOOD:ITEM_FOOD_STEW]
[NAME:stew]
[LEVEL:3]
[ITEM_FOOD:ITEM_FOOD_ROAST]
[NAME:roast]
[LEVEL:4]</pre></div></div><div class="item-header"><h4 class="item-title" id="raws.dir.__iadd__"><a href="../raws/dir.py">raws.dir.__iadd__</a></h4></div><div class="item-body"><div class="docstring documented">Add a file to the dir.</div><div class="arguments">Arguments: <span class="argument no-default"><span class="argument-name self">self</span></span><span class="argument-separator">,</span><span class="argument no-default"><span class="argument-name file">file</span></span></div></div><div class="item-header"><h4 class="item-title" id="raws.dir.__init__"><a href="../raws/dir.py">raws.dir.__init__</a></h4></div><div class="item-body"><div class="docstring documented">Initialize a dir object.</div><div class="arguments">Arguments: <span class="argument no-default"><span class="argument-name self">self</span></span><span class="argument-separator">,</span><span class="argument has-default"><span class="argument-name root">root</span><span class="argument-equals">=</span><span class="argument-default NoneType None">None</span></span><span class="argument-separator">,</span><span class="argument has-default"><span class="argument-name dest">dest</span><span class="argument-equals">=</span><span class="argument-default NoneType None">None</span></span><span class="argument-separator">,</span><span class="argument has-default"><span class="argument-name paths">paths</span><span class="argument-equals">=</span><span class="argument-default NoneType None">None</span></span><span class="argument-separator">,</span><span class="argument has-default"><span class="argument-name version">version</span><span class="argument-equals">=</span><span class="argument-default NoneType None">None</span></span><span class="argument-separator">,</span><span class="argument has-default"><span class="argument-name log">log</span><span class="argument-equals">=</span><span class="argument-default NoneType None">None</span></span><span class="argument-separator">,</span><span class="argument keywords">**kwargs</span></div></div><div class="item-header"><h4 class="item-title" id="raws.dir.__isub__"><a href="../raws/dir.py">raws.dir.__isub__</a></h4></div><div class="item-body"><div class="docstring documented">Remove a file from this dir.</div><div class="arguments">Arguments: <span class="argument no-default"><span class="argument-name self">self</span></span><span class="argument-separator">,</span><span class="argument no-default"><span class="argument-name file">file</span></span></div><div class="examples"><pre class="highlight-example">>>> dflen = len(df) # Track original number of files
>>> df.remove('raw/objects/item_pants.txt')
>>> del df['data/init/init.txt']
>>> df -= 'data/init/colors.txt'
>>> print dflen - len(df) # Three fewer files now
3
>>> df.reset()
>>> print dflen == len(df) # Back to the original number
True</pre></div></div><div class="item-header"><h4 class="item-title" id="raws.dir.__iter__"><a href="../raws/dir.py">raws.dir.__iter__</a></h4></div><div class="item-body"><div class="docstring documented">Iterate through the dir's file objects.</div><div class="arguments">Arguments: <span class="argument no-default"><span class="argument-name self">self</span></span></div><div class="examples"><pre class="highlight-example">>>> print '\n'.join(sorted(str(file) for file in df if file.loc == 'data/init' and file.name.startswith('i')))
data/init/init.txt
data/init/init_desk.txt
data/init/init_lappy.txt
data/init/interface.txt</pre></div></div><div class="item-header"><h4 class="item-title" id="raws.dir.__len__"><a href="../raws/dir.py">raws.dir.__len__</a></h4></div><div class="item-body"><div class="docstring documented">Get the number of file objects tracked by the dir.</div><div class="arguments">Arguments: <span class="argument no-default"><span class="argument-name self">self</span></span></div><div class="examples"><pre class="highlight-example">>>> dflen = len(df)
>>> df['raw/objects/creature_standard.txt'].remove()
>>> print dflen - len(df)
1</pre></div></div><div class="item-header"><h4 class="item-title" id="raws.dir.__ne__"><a href="../raws/dir.py">raws.dir.__ne__</a></h4></div><div class="item-body"><div class="docstring documented">Check inequivalency with another dir object.</div><div class="arguments">Arguments: <span class="argument no-default"><span class="argument-name self">self</span></span><span class="argument-separator">,</span><span class="argument no-default"><span class="argument-name other">other</span></span></div></div><div class="item-header"><h4 class="item-title" id="raws.dir.__nonzero__"><a href="../raws/dir.py">raws.dir.__nonzero__</a></h4></div><div class="item-body"><div class="docstring documented">Always returns True.</div><div class="arguments">Arguments: <span class="argument no-default"><span class="argument-name self">self</span></span></div></div><div class="item-header"><h4 class="item-title" id="raws.dir.__setitem__"><a href="../raws/dir.py">raws.dir.__setitem__</a></h4></div><div class="item-body"><div class="docstring documented">Set file given a name.</div><div class="arguments">Arguments: <span class="argument no-default"><span class="argument-name self">self</span></span><span class="argument-separator">,</span><span class="argument no-default"><span class="argument-name name">name</span></span><span class="argument-separator">,</span><span class="argument no-default"><span class="argument-name content">content</span></span></div></div><div class="item-header"><h4 class="item-title" id="raws.dir.__str__"><a href="../raws/dir.py">raws.dir.__str__</a></h4></div><div class="item-body"><div class="docstring documented">Get a string representation.</div><div class="arguments">Arguments: <span class="argument no-default"><span class="argument-name self">self</span></span></div><div class="examples"><pre class="highlight-example">>>> lines = str(df).split('\n')
>>> print '\n'.join(lines[0:8])
ref data/art/curses_640x300.bmp
ref data/art/curses_640x300.png
ref data/art/curses_800x600.bmp
ref data/art/curses_800x600.png
ref data/art/curses_square_16x16.bmp
ref data/art/curses_square_16x16.png
ref data/art/font license.txt
ref data/art/font.ttf</pre></div></div><div class="item-header"><h4 class="item-title" id="raws.dir.add"><a href="../raws/dir.py">raws.dir.add</a></h4></div><div class="item-body"><div class="docstring documented">Add a file to the dir.</div><div class="arguments">Arguments: <span class="argument no-default"><span class="argument-name self">self</span></span><span class="argument-separator">,</span><span class="argument has-default"><span class="argument-name auto">auto</span><span class="argument-equals">=</span><span class="argument-default NoneType None">None</span></span><span class="argument-separator">,</span><span class="argument keywords">**kwargs</span></div><div class="examples"><pre class="highlight-example">>>> newfile = raws.binfile('data/init/newfile.txt')
>>> print newfile.loc
data/init
>>> print newfile.name
newfile
>>> print newfile.ext
.txt
>>> print newfile in df
False
>>> print 'data/init/newfile.txt' in df
False
>>> added = df.add(newfile) # returns the newfile object
>>> print newfile in df
True
>>> print 'data/init/newfile.txt' in df
True</pre></div></div><div class="item-header"><h4 class="item-title" id="raws.dir.clean"><a href="../raws/dir.py">raws.dir.clean</a></h4></div><div class="item-body"><div class="docstring documented">
Cleans an output directory, typically before writing, so that files
that are present in the output directory but not in the dir object
won't stick around and interfere with things.
</div><div class="arguments">Arguments: <span class="argument no-default"><span class="argument-name self">self</span></span><span class="argument-separator">,</span><span class="argument has-default"><span class="argument-name dest">dest</span><span class="argument-equals">=</span><span class="argument-default NoneType None">None</span></span></div></div><div class="item-header"><h4 class="item-title" id="raws.dir.clear"><a href="../raws/dir.py">raws.dir.clear</a></h4></div><div class="item-body"><div class="docstring documented">Remove all files from this dir.</div><div class="arguments">Arguments: <span class="argument no-default"><span class="argument-name self">self</span></span></div><div class="examples"><pre class="highlight-example">>>> print len(df) > 0
True
>>> df.clear()
>>> print len(df) > 0
False</pre></div></div><div class="item-header"><h4 class="item-title" id="raws.dir.copy"><a href="../raws/dir.py">raws.dir.copy</a></h4></div><div class="item-body"><div class="docstring documented">Create a copy of this dir.</div><div class="arguments">Arguments: <span class="argument no-default"><span class="argument-name self">self</span></span></div><div class="examples"><pre class="highlight-example">>>> dfcopy = df.copy()
>>> print dfcopy == df
True
>>> dwarf = dfcopy.getobj('CREATURE:DWARF')
>>> token = dwarf.add('MAKE:THE:COPY:DIFFERENT')
>>> print dfcopy == df
False</pre></div></div><div class="item-header"><h4 class="item-title" id="raws.dir.equals"><a href="../raws/dir.py">raws.dir.equals</a></h4></div><div class="item-body"><div class="docstring documented">Check equivalency with another dir object.</div><div class="arguments">Arguments: <span class="argument no-default"><span class="argument-name self">self</span></span><span class="argument-separator">,</span><span class="argument no-default"><span class="argument-name other">other</span></span></div></div><div class="item-header"><h4 class="item-title" id="raws.dir.getfile"><a href="../raws/dir.py">raws.dir.getfile</a></h4></div><div class="item-body"><div class="docstring documented">Gets the file with a given name. If no file by that name is found,
None is returned instead. If creature is set to something other than
None, the behavior when no file by some name exists is altered: A new
file is created and associated with that name, and then its add
method is called using the value for create as its argument.</div><div class="arguments">Arguments: <span class="argument no-default"><span class="argument-name self">self</span></span><span class="argument-separator">,</span><span class="argument no-default"><span class="argument-name name">name</span></span><span class="argument-separator">,</span><span class="argument has-default"><span class="argument-name create">create</span><span class="argument-equals">=</span><span class="argument-default NoneType None">None</span></span><span class="argument-separator">,</span><span class="argument has-default"><span class="argument-name conflicts">conflicts</span><span class="argument-equals">=</span><span class="argument-default bool False">False</span></span><span class="argument-separator">,</span><span class="argument keywords">**kwargs</span></div></div><div class="item-header"><h4 class="item-title" id="raws.dir.getobjheaders"><a href="../raws/dir.py">raws.dir.getobjheaders</a></h4></div><div class="item-body"><div class="docstring documented">
Gets OBJECT:X tokens where X is type. Is also prepared for special
cases like type=ITEM_PANTS matching OBJECT:ITEM.
</div><div class="arguments">Arguments: <span class="argument no-default"><span class="argument-name self">self</span></span><span class="argument-separator">,</span><span class="argument has-default"><span class="argument-name type">type</span><span class="argument-equals">=</span><span class="argument-default NoneType None">None</span></span></div><div class="examples"><pre class="highlight-example">>>> objheaders = df.getobjheaders('INORGANIC')
>>> print '\n'.join(sorted(str(token + token.next) for token in objheaders))
[OBJECT:INORGANIC]
[INORGANIC:CLAY]
[OBJECT:INORGANIC]
[INORGANIC:HEMATITE]
[OBJECT:INORGANIC]
[INORGANIC:IRON]
[OBJECT:INORGANIC]
[INORGANIC:ONYX]
[OBJECT:INORGANIC]
[INORGANIC:PLASTER]
[OBJECT:INORGANIC]
[INORGANIC:SANDSTONE]</pre></div></div><div class="item-header"><h4 class="item-title" id="raws.dir.iterfiles"><a href="../raws/dir.py">raws.dir.iterfiles</a></h4></div><div class="item-body"><div class="docstring documented">Iterate through the dir's file objects.</div><div class="arguments">Arguments: <span class="argument no-default"><span class="argument-name self">self</span></span><span class="argument-separator">,</span><span class="argument varargs">*args</span><span class="argument-separator">,</span><span class="argument keywords">**kwargs</span></div></div><div class="item-header"><h4 class="item-title" id="raws.dir.itokens"><a href="../raws/dir.py">raws.dir.itokens</a></h4></div><div class="item-body"><div class="docstring documented">Iterate through all tokens.</div><div class="arguments">Arguments: <span class="argument no-default"><span class="argument-name self">self</span></span><span class="argument-separator">,</span><span class="argument varargs">*args</span><span class="argument-separator">,</span><span class="argument keywords">**kwargs</span></div></div><div class="item-header"><h4 class="item-title" id="raws.dir.read"><a href="../raws/dir.py">raws.dir.read</a></h4></div><div class="item-body"><div class="docstring documented">Reads raws from all text files in the specified directory.</div><div class="arguments">Arguments: <span class="argument no-default"><span class="argument-name self">self</span></span><span class="argument-separator">,</span><span class="argument has-default"><span class="argument-name root">root</span><span class="argument-equals">=</span><span class="argument-default NoneType None">None</span></span><span class="argument-separator">,</span><span class="argument has-default"><span class="argument-name paths">paths</span><span class="argument-equals">=</span><span class="argument-default NoneType None">None</span></span><span class="argument-separator">,</span><span class="argument has-default"><span class="argument-name skipfails">skipfails</span><span class="argument-equals">=</span><span class="argument-default bool False">False</span></span></div></div><div class="item-header"><h4 class="item-title" id="raws.dir.remove"><a href="../raws/dir.py">raws.dir.remove</a></h4></div><div class="item-body"><div class="docstring documented">Remove a file from this dir.</div><div class="arguments">Arguments: <span class="argument no-default"><span class="argument-name self">self</span></span><span class="argument-separator">,</span><span class="argument has-default"><span class="argument-name file">file</span><span class="argument-equals">=</span><span class="argument-default NoneType None">None</span></span></div><div class="examples"><pre class="highlight-example">>>> dflen = len(df) # Track original number of files
>>> df.remove('raw/objects/item_pants.txt')
>>> del df['data/init/init.txt']
>>> df -= 'data/init/colors.txt'
>>> print dflen - len(df) # Three fewer files now
3
>>> df.reset()
>>> print dflen == len(df) # Back to the original number
True</pre></div></div><div class="item-header"><h4 class="item-title" id="raws.dir.reset"><a href="../raws/dir.py">raws.dir.reset</a></h4></div><div class="item-body"><div class="docstring documented">
Reload the dir object from its associated directory, consequently
discarding all changes.
</div><div class="arguments">Arguments: <span class="argument no-default"><span class="argument-name self">self</span></span></div><div class="examples"><pre class="highlight-example">>>> dwarf = df.getobj('CREATURE:DWARF')
>>> dwarf.remove()
>>> print df.getobj('CREATURE:DWARF')
None
>>> df.reset()
>>> print df.getobj('CREATURE:DWARF')
[CREATURE:DWARF]</pre><div class="example-separator"></div><pre class="highlight-example">>>> dflen = len(df) # Track original number of files
>>> df.remove('raw/objects/item_pants.txt')
>>> del df['data/init/init.txt']
>>> df -= 'data/init/colors.txt'
>>> print dflen - len(df) # Three fewer files now
3
>>> df.reset()
>>> print dflen == len(df) # Back to the original number
True</pre></div></div><div class="item-header"><h4 class="item-title" id="raws.dir.write"><a href="../raws/dir.py">raws.dir.write</a></h4></div><div class="item-body"><div class="docstring documented">Writes raws to the specified directory.</div><div class="arguments">Arguments: <span class="argument no-default"><span class="argument-name self">self</span></span><span class="argument-separator">,</span><span class="argument has-default"><span class="argument-name dest">dest</span><span class="argument-equals">=</span><span class="argument-default NoneType None">None</span></span></div></div></div></div><div class="item-header"><h3 class="item-title" id="raws.ends"><a href="../raws/helpers.py">raws.ends</a></h3></div><div class="item-body"><div class="docstring documented">
Utility method for getting the first and last tokens of some iterable.
</div><div class="arguments">Arguments: <span class="argument no-default"><span class="argument-name tokens">tokens</span></span><span class="argument-separator">,</span><span class="argument has-default"><span class="argument-name setfile">setfile</span><span class="argument-equals">=</span><span class="argument-default NoneType None">None</span></span></div></div><div class="item-header"><h3 class="item-title" id="raws.equal"><a href="../raws/helpers.py">raws.equal</a></h3></div><div class="item-body"><div class="docstring documented">Check for equivalency between two raws objects.</div><div class="arguments">Arguments: <span class="argument no-default"><span class="argument-name a">a</span></span><span class="argument-separator">,</span><span class="argument no-default"><span class="argument-name b">b</span></span></div></div><div class="item-header"><h3 class="item-title" id="raws.filefactory"><a href="../raws/filefactory.py">raws.filefactory</a></h3></div><div class="item-body"><div class="docstring undocumented">Undocumented</div><div class="arguments">Arguments: <span class="argument no-default"><span class="argument-name path">path</span></span><span class="argument-separator">,</span><span class="argument has-default"><span class="argument-name log">log</span><span class="argument-equals">=</span><span class="argument-default NoneType None">None</span></span><span class="argument-separator">,</span><span class="argument keywords">**kwargs</span></div></div><div class="item-header"><h3 class="item-title" id="raws.filters"><a href="../raws/filters.py">raws.filters</a></h3></div><div class="item-body"><div class="docstring undocumented">Undocumented</div></div><div class="item-header"><h3 class="item-title" id="raws.helpers"><a href="../raws/helpers.py">raws.helpers</a></h3></div><div class="item-body"><div class="docstring undocumented">Undocumented</div><div class="subs"><div class="item-header"><h4 class="item-title" id="raws.helpers.copytokens"><a href="../raws/helpers.py">raws.helpers.copytokens</a></h4></div><div class="item-body"><div class="docstring documented">Copy tokens contained within some iterable.</div><div class="arguments">Arguments: <span class="argument no-default"><span class="argument-name tokens">tokens</span></span><span class="argument-separator">,</span><span class="argument has-default"><span class="argument-name iter">iter</span><span class="argument-equals">=</span><span class="argument-default bool False">False</span></span></div></div><div class="item-header"><h4 class="item-title" id="raws.helpers.tokensequal"><a href="../raws/helpers.py">raws.helpers.tokensequal</a></h4></div><div class="item-body"><div class="docstring documented">Check equivalency between two iterables containing tokens.</div><div class="arguments">Arguments: <span class="argument no-default"><span class="argument-name atokens">atokens</span></span><span class="argument-separator">,</span><span class="argument no-default"><span class="argument-name btokens">btokens</span></span></div></div><div class="item-header"><h4 class="item-title" id="raws.helpers.tokensstring"><a href="../raws/helpers.py">raws.helpers.tokensstring</a></h4></div><div class="item-body"><div class="docstring documented">Get a fancy string representation of some collection of tokens.</div><div class="arguments">Arguments: <span class="argument no-default"><span class="argument-name tokens">tokens</span></span><span class="argument-separator">,</span><span class="argument has-default"><span class="argument-name dedent">dedent</span><span class="argument-equals">=</span><span class="argument-default bool True">True</span></span></div></div></div></div><div class="item-header"><h3 class="item-title" id="raws.objects"><a href="../raws/objects.py">raws.objects</a></h3></div><div class="item-body"><div class="docstring undocumented">Undocumented</div><div class="subs"><div class="item-header"><h4 class="item-title" id="raws.objects.headerdict"><a href="../raws/objects.py">raws.objects.headerdict</a></h4></div><div class="item-body"><div class="docstring documented">Get the header dict corresponding to some version. The dict maps headers as keys
to lists of corresponding object types. For example, BUILDING to BUILDING_WORKSHOP
and BUILDING_FURNACE.</div><div class="arguments">Arguments: <span class="argument has-default"><span class="argument-name version">version</span><span class="argument-equals">=</span><span class="argument-default NoneType None">None</span></span></div></div><div class="item-header"><h4 class="item-title" id="raws.objects.headerforobject"><a href="../raws/objects.py">raws.objects.headerforobject</a></h4></div><div class="item-body"><div class="docstring documented">Returns the header for a particular object type given a version.</div><div class="arguments">Arguments: <span class="argument no-default"><span class="argument-name type">type</span></span><span class="argument-separator">,</span><span class="argument has-default"><span class="argument-name version">version</span><span class="argument-equals">=</span><span class="argument-default NoneType None">None</span></span></div><div class="examples"><pre class="highlight-example">>>> print raws.objects.headerforobject('ENTITY')
ENTITY
>>> print raws.objects.headerforobject('ITEM_ARMOR')
ITEM
>>> print raws.objects.headerforobject('TILE_PAGE')
GRAPHICS</pre></div></div><div class="item-header"><h4 class="item-title" id="raws.objects.headers"><a href="../raws/objects.py">raws.objects.headers</a></h4></div><div class="item-body"><div class="docstring documented">Get a list of valid object types as given by the OBJECT:TYPE tokens which appear
at the beginning of raws files.</div><div class="arguments">Arguments: <span class="argument has-default"><span class="argument-name version">version</span><span class="argument-equals">=</span><span class="argument-default NoneType None">None</span></span></div><div class="examples"><pre class="highlight-example">>>> print raws.objects.headers()
['BODY', 'INTERACTION', 'MATERIAL_TEMPLATE', 'DESCRIPTOR_SHAPE', 'TISSUE_TEMPLATE', 'BODY_DETAIL_PLAN', 'GRAPHICS', 'ENTITY', 'DESCRIPTOR_COLOR', 'BUILDING', 'REACTION', 'PLANT', 'LANGUAGE', 'ITEM', 'DESCRIPTOR_PATTERN', 'INORGANIC', 'CREATURE', 'CREATURE_VARIATION']</pre></div></div><div class="item-header"><h4 class="item-title" id="raws.objects.objectdict"><a href="../raws/objects.py">raws.objects.objectdict</a></h4></div><div class="item-body"><div class="docstring documented">Get the object dict corresponding to some version. The dict maps object types as
keys to their corresponding header. For example, BUILDING_WORKSHOP to BUILDING.</div><div class="arguments">Arguments: <span class="argument has-default"><span class="argument-name version">version</span><span class="argument-equals">=</span><span class="argument-default NoneType None">None</span></span></div></div><div class="item-header"><h4 class="item-title" id="raws.objects.objects"><a href="../raws/objects.py">raws.objects.objects</a></h4></div><div class="item-body"><div class="docstring documented">Get a list of valid object types as given by the TYPE:ID tokens which denote the
beginning of an object definition.</div><div class="arguments">Arguments: <span class="argument has-default"><span class="argument-name version">version</span><span class="argument-equals">=</span><span class="argument-default NoneType None">None</span></span></div><div class="examples"><pre class="highlight-example">>>> print raws.objects.objects()
['ITEM_FOOD', 'ITEM_SHIELD', 'SYMBOL', 'ITEM_TRAPCOMP', 'ENTITY', 'ITEM_PANTS', 'TISSUE_TEMPLATE', 'CREATURE_GRAPHICS', 'REACTION', 'WORD', 'BUILDING_WORKSHOP', 'COLOR', 'ITEM_SHOES', 'ITEM_ARMOR', 'BUILDING_FURNACE', 'SHAPE', 'ITEM_AMMO', 'ITEM_INSTRUMENT', 'ITEM_GLOVES', 'TRANSLATION', 'TILE_PAGE', 'BODY', 'INTERACTION', 'ITEM_TOOL', 'ITEM_TOY', 'COLOR_PATTERN', 'MATERIAL_TEMPLATE', 'ITEM_HELM', 'BODY_DETAIL_PLAN', 'PLANT', 'ITEM_WEAPON', 'ITEM_SIEGEAMMO', 'INORGANIC', 'CREATURE_VARIATION', 'CREATURE']</pre><div class="example-separator"></div><pre class="highlight-example">>>> print '\n'.join(object for object in raws.objects.objects() if object.startswith('ITEM_'))
ITEM_FOOD
ITEM_SHIELD
ITEM_TRAPCOMP
ITEM_PANTS
ITEM_SHOES
ITEM_ARMOR
ITEM_AMMO
ITEM_INSTRUMENT
ITEM_GLOVES
ITEM_TOOL
ITEM_TOY
ITEM_HELM
ITEM_WEAPON
ITEM_SIEGEAMMO</pre></div></div><div class="item-header"><h4 class="item-title" id="raws.objects.objectsforheader"><a href="../raws/objects.py">raws.objects.objectsforheader</a></h4></div><div class="item-body"><div class="docstring documented">Returns the object types corresponding to a particular header given a version.</div><div class="arguments">Arguments: <span class="argument no-default"><span class="argument-name header">header</span></span><span class="argument-separator">,</span><span class="argument has-default"><span class="argument-name version">version</span><span class="argument-equals">=</span><span class="argument-default NoneType None">None</span></span></div><div class="examples"><pre class="highlight-example">>>> print raws.objects.objectsforheader('INORGANIC')
['INORGANIC']
>>> print raws.objects.objectsforheader('ITEM')
['ITEM_WEAPON', 'ITEM_TOY', 'ITEM_TOOL', 'ITEM_INSTRUMENT', 'ITEM_TRAPCOMP', 'ITEM_ARMOR', 'ITEM_AMMO', 'ITEM_SIEGEAMMO', 'ITEM_GLOVES', 'ITEM_SHOES', 'ITEM_SHIELD', 'ITEM_HELM', 'ITEM_PANTS', 'ITEM_FOOD']
>>> print raws.objects.objectsforheader('GRAPHICS')
['TILE_PAGE', 'CREATURE_GRAPHICS']</pre></div></div></div></div><div class="item-header"><h3 class="item-title" id="raws.parseplural"><a href="../raws/tokenparse.py">raws.parseplural</a></h3></div><div class="item-body"><div class="docstring documented">Parses a string, turns it into a list of tokens.
data: The string to be parsed.
implicit: Determines behavior when there are no opening or closing braces.
If True, then the input is assumed to be the contents of a token, e.g. [input].
If False, an exception is raised.
**kwargs: Extra named arguments are passed to the constructor each time a new
rawstoken is distinguished and created.
</div><div class="arguments">Arguments: <span class="argument no-default"><span class="argument-name data">data</span></span><span class="argument-separator">,</span><span class="argument has-default"><span class="argument-name implicit">implicit</span><span class="argument-equals">=</span><span class="argument-default bool False">False</span></span><span class="argument-separator">,</span><span class="argument keywords">**kwargs</span></div></div><div class="item-header"><h3 class="item-title" id="raws.parsesingular"><a href="../raws/tokenparse.py">raws.parsesingular</a></h3></div><div class="item-body"><div class="docstring documented">Parses a string containing exactly one token. **kwargs are passed on to the parse static method.
</div><div class="arguments">Arguments: <span class="argument no-default"><span class="argument-name data">data</span></span><span class="argument-separator">,</span><span class="argument has-default"><span class="argument-name implicit">implicit</span><span class="argument-equals">=</span><span class="argument-default bool True">True</span></span><span class="argument-separator">,</span><span class="argument has-default"><span class="argument-name failmulti">failmulti</span><span class="argument-equals">=</span><span class="argument-default bool True">True</span></span><span class="argument-separator">,</span><span class="argument has-default"><span class="argument-name apply">apply</span><span class="argument-equals">=</span><span class="argument-default NoneType None">None</span></span><span class="argument-separator">,</span><span class="argument keywords">**kwargs</span></div></div><div class="item-header"><h3 class="item-title" id="raws.parsevariable"><a href="../raws/tokenparse.py">raws.parsevariable</a></h3></div><div class="item-body"><div class="docstring undocumented">Undocumented</div><div class="arguments">Arguments: <span class="argument varargs">*args</span><span class="argument-separator">,</span><span class="argument keywords">**kwargs</span></div></div><div class="item-header"><h3 class="item-title" id="raws.queryable"><a href="../raws/queryable.py">raws.queryable</a></h3></div><div class="item-body"><div class="docstring documented">Classes which contain raws tokens should inherit from this in order to provide querying functionality.</div><div class="subs"><div class="item-header"><h4 class="item-title" id="raws.queryable.__contains__"><a href="../raws/queryable.py">raws.queryable.__contains__</a></h4></div><div class="item-body"><div class="docstring documented">Check if some matching token can be found.</div><div class="arguments">Arguments: <span class="argument no-default"><span class="argument-name self">self</span></span><span class="argument-separator">,</span><span class="argument no-default"><span class="argument-name item">item</span></span></div><div class="examples"><pre class="highlight-example">>>> tokens = raws.tokenlist('[A][B][C][D][E][F]')
>>> print 'B' in tokens
True
>>> print 'G' in tokens
False
>>> print tokens[0] in tokens
True
>>> print raws.token('[A]') in tokens
False
>>> (lambda token: token.value == 'C') in tokens
True
>>> (lambda token: token.value == 'G') in tokens
False
>>> print ('A', 'B') in tokens
True
>>> print ('A', 'G') in tokens
False</pre></div></div><div class="item-header"><h4 class="item-title" id="raws.queryable.__eq__"><a href="../raws/queryable.py">raws.queryable.__eq__</a></h4></div><div class="item-body"><div class="docstring documented">Check for equivalency.</div><div class="arguments">Arguments: <span class="argument no-default"><span class="argument-name self">self</span></span><span class="argument-separator">,</span><span class="argument no-default"><span class="argument-name other">other</span></span></div><div class="examples"><pre class="highlight-example">>>> tokens = raws.tokenlist('[a][b][c]')
>>> print tokens == (token for token in tokens)
True
>>> print tokens == '[a][b][c]'
True
>>> print tokens == '[x][y][z]'
False</pre></div></div><div class="item-header"><h4 class="item-title" id="raws.queryable.__getitem__"><a href="../raws/queryable.py">raws.queryable.__getitem__</a></h4></div><div class="item-body"><div class="arguments">Arguments: <span class="argument no-default"><span class="argument-name self">self</span></span><span class="argument-separator">,</span><span class="argument varargs">*args</span><span class="argument-separator">,</span><span class="argument keywords">**kwargs</span></div><div class="examples"><pre class="highlight-example">>>> food = df['item_food']
>>> print food[...]
[OBJECT:ITEM]
[ITEM_FOOD:ITEM_FOOD_BISCUITS]
[NAME:biscuits]
[LEVEL:2]
[ITEM_FOOD:ITEM_FOOD_STEW]
[NAME:stew]
[LEVEL:3]
[ITEM_FOOD:ITEM_FOOD_ROAST]
[NAME:roast]
[LEVEL:4]
>>> print food[0]
[OBJECT:ITEM]
>>> print food[-1]
[LEVEL:4]
>>> print food['NAME']
[NAME:biscuits]
>>> token = raws.token('NAME:biscuits')
>>> print food[token]
[NAME:biscuits]
>>> print food[lambda token, count: (token.value == 'NAME', False)]
[NAME:biscuits]
[NAME:stew]
[NAME:roast]
>>> print food[1:4]
[ITEM_FOOD:ITEM_FOOD_BISCUITS]
[NAME:biscuits]
[LEVEL:2]
>>> print food[0, 'NAME']
[OBJECT:ITEM]
[NAME:biscuits]