words-to-data 0.3.0

Convert Legal Documents Into Diffable Data Structures
Documentation
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
318
319
320
321
322
323
324
325
326
327
328
329
330
331
332
333
334
335
336
337
338
339
340
341
342
343
344
345
346
347
348
349
350
351
352
353
354
355
356
357
358
359
360
361
362
363
364
365
366
367
368
369
370
371
372
373
374
375
376
377
378
379
380
381
382
383
384
385
386
387
388
389
390
391
392
393
394
395
396
397
398
399
400
401
402
403
404
405
406
407
408
409
410
411
412
413
414
415
416
417
418
419
420
421
422
423
424
425
426
427
428
429
430
431
432
433
434
435
436
437
438
439
440
441
442
443
444
445
446
447
448
449
450
451
452
453
454
455
456
457
458
459
460
461
462
463
464
465
466
467
468
469
470
471
472
473
474
475
476
477
478
479
480
481
482
483
484
485
486
487
488
489
490
491
492
493
494
495
496
497
498
499
500
501
502
503
504
505
506
507
508
509
510
511
512
513
514
515
516
517
518
519
520
521
522
523
524
525
526
527
528
529
530
531
532
533
534
535
536
537
538
539
540
541
542
543
544
545
546
547
548
549
550
551
552
553
554
555
556
557
558
559
560
561
562
563
564
565
566
567
568
569
570
571
572
573
574
575
576
577
578
579
580
581
582
583
584
585
586
587
588
589
590
591
592
593
594
595
596
597
598
599
600
601
602
603
604
605
606
607
608
609
610
611
612
613
614
615
616
617
618
619
620
621
622
623
624
625
626
627
628
629
630
631
632
633
634
635
636
637
638
639
640
641
642
643
644
645
646
647
648
649
650
651
652
653
654
655
656
657
658
659
660
661
662
663
664
665
666
667
668
669
670
671
672
673
674
675
676
677
678
679
680
681
682
683
684
685
686
687
688
689
690
691
692
693
694
695
696
697
698
699
700
701
702
703
704
705
706
707
708
709
710
711
712
713
714
715
716
717
718
719
720
721
722
723
724
725
726
727
728
729
730
731
732
733
734
735
736
737
738
739
740
741
742
743
744
745
746
747
748
749
750
751
752
753
754
755
756
757
758
759
760
761
762
763
764
765
766
767
768
769
770
771
772
773
774
775
776
777
778
779
780
781
782
783
784
785
786
787
788
789
790
791
792
793
794
795
796
797
798
799
800
801
802
803
804
805
806
807
808
809
810
811
812
813
814
815
816
817
818
819
820
821
822
823
824
825
826
827
828
829
830
831
832
833
834
835
836
837
838
839
840
841
842
843
844
845
846
847
848
849
850
851
852
853
854
855
856
857
858
859
860
861
862
863
864
865
866
867
868
869
870
871
872
873
874
875
876
877
878
879
880
881
882
883
884
885
886
887
888
889
890
891
892
893
894
895
896
897
898
899
900
901
902
903
904
905
906
907
908
909
910
911
912
913
914
915
916
917
918
919
920
921
922
923
924
925
926
927
928
929
930
931
932
933
934
935
936
937
938
939
940
941
942
943
944
945
946
947
948
949
950
951
952
953
954
955
956
957
958
959
960
961
962
963
964
965
966
967
968
969
970
971
972
973
974
975
976
977
978
979
980
981
982
983
984
985
986
987
988
989
990
991
992
993
994
995
996
997
998
999
1000
1001
1002
1003
1004
1005
1006
1007
1008
1009
1010
1011
1012
1013
1014
1015
1016
1017
1018
1019
1020
1021
1022
1023
1024
1025
1026
1027
1028
1029
1030
1031
1032
1033
1034
1035
1036
1037
1038
1039
1040
1041
1042
1043
1044
1045
1046
1047
1048
1049
1050
1051
1052
1053
1054
1055
1056
1057
1058
1059
1060
1061
1062
1063
1064
1065
1066
1067
1068
1069
1070
1071
1072
1073
1074
1075
1076
1077
1078
1079
1080
1081
1082
1083
1084
1085
1086
1087
1088
1089
1090
1091
1092
1093
1094
1095
1096
1097
1098
1099
1100
1101
1102
1103
1104
1105
1106
1107
1108
1109
1110
1111
1112
1113
1114
1115
1116
1117
1118
1119
1120
1121
1122
1123
1124
1125
1126
1127
1128
1129
1130
1131
1132
1133
1134
1135
1136
1137
1138
1139
1140
1141
1142
1143
1144
1145
1146
1147
1148
1149
1150
1151
1152
1153
1154
1155
1156
1157
1158
1159
1160
1161
1162
1163
1164
1165
1166
1167
1168
1169
1170
1171
1172
1173
1174
1175
1176
1177
1178
1179
1180
1181
1182
1183
1184
1185
1186
1187
1188
1189
1190
1191
1192
1193
1194
1195
1196
1197
1198
1199
1200
1201
1202
1203
1204
1205
1206
1207
1208
1209
1210
1211
1212
1213
1214
1215
1216
1217
1218
1219
1220
1221
1222
1223
1224
1225
1226
1227
1228
1229
1230
1231
1232
1233
1234
1235
1236
1237
1238
1239
1240
1241
1242
1243
1244
1245
1246
1247
1248
1249
1250
1251
1252
1253
1254
1255
1256
1257
1258
1259
1260
1261
1262
1263
1264
1265
1266
1267
1268
1269
1270
1271
1272
1273
1274
1275
1276
1277
1278
1279
1280
1281
1282
1283
1284
1285
1286
1287
1288
1289
1290
1291
1292
1293
1294
1295
1296
1297
"""Type stubs for words_to_data"""

from typing import Any, Literal

class USLMElement:
    """A hierarchical element in a USLM document tree"""

    @property
    def data(self) -> dict[str, Any]:
        """Element metadata and content"""
        ...

    @property
    def children(self) -> list[USLMElement]:
        """Child elements in document order"""
        ...

    def find(self, path: str) -> USLMElement | None:
        """Find an element by its structural path.

        Args:
            path: The full structural path of the element

        Returns:
            The matching element, or None if not found
        """
        ...

    def to_json(self) -> str:
        """Serialize the element to a JSON string."""
        ...

    def to_dict(self) -> dict[str, Any]:
        """Serialize the element to a dictionary."""
        ...

    @staticmethod
    def from_json(json_str: str) -> USLMElement:
        """Deserialize a JSON string to a USLMElement."""
        ...

    def merge_children(self, other: USLMElement) -> None:
        """Merge the children of two nodes into one, retains the caller's ElementData"""

class TextChange:
    """A single word-level change within a text field"""

    @property
    def value(self) -> str:
        """The text value of this change"""
        ...

    @property
    def old_index(self) -> int | None:
        """Position in the original text (None for insertions)"""
        ...

    @property
    def new_index(self) -> int | None:
        """Position in the new text (None for deletions)"""
        ...

    @property
    def tag(self) -> Literal["insert", "delete", "equal"]:
        """The type of change"""
        ...

    def to_json(self) -> str:
        """Serialize the change to a JSON string."""
        ...

    def to_dict(self) -> dict[str, Any]:
        """Serialize the change to a dictionary."""
        ...

    @staticmethod
    def from_json(json_str: str) -> TextChange:
        """Deserialize a JSON string to a TextChange."""
        ...

class FieldChangeEvent:
    """A change detected in a single text content field"""

    @property
    def field_name(self) -> Literal["heading", "chapeau", "proviso", "content", "continuation"]:
        """Which text content field changed"""
        ...

    @property
    def from_date(self) -> str:
        """The publication date of the original version"""
        ...

    @property
    def to_date(self) -> str:
        """The publication date of the new version"""
        ...

    @property
    def old_value(self) -> str:
        """The complete original text of the field"""
        ...

    @property
    def new_value(self) -> str:
        """The complete new text of the field"""
        ...

    @property
    def changes(self) -> list[TextChange]:
        """Word-level changes showing insertions, deletions, and unchanged portions"""
        ...

    def to_json(self) -> str:
        """Serialize the field change event to a JSON string."""
        ...

    def to_dict(self) -> dict[str, Any]:
        """Serialize the field change event to a dictionary."""
        ...

    @staticmethod
    def from_json(json_str: str) -> FieldChangeEvent:
        """Deserialize a JSON string to a FieldChangeEvent."""
        ...

class TreeDiff:
    """A hierarchical diff between two versions of a USLM document tree"""

    @property
    def root_path(self) -> str:
        """The structural path of the element being compared"""
        ...

    @property
    def changes(self) -> list[FieldChangeEvent]:
        """Text content field changes for this element"""
        ...

    @property
    def from_element(self) -> dict[str, Any]:
        """Metadata from the original version of this element"""
        ...

    @property
    def to_element(self) -> dict[str, Any]:
        """Metadata from the new version of this element"""
        ...

    @property
    def added(self) -> list[dict[str, Any]]:
        """Child elements that were added in the new version"""
        ...

    @property
    def removed(self) -> list[dict[str, Any]]:
        """Child elements that were removed from the old version"""
        ...

    @property
    def child_diffs(self) -> list[TreeDiff]:
        """Recursive diffs for child elements present in both versions"""
        ...

    def find(self, path: str) -> TreeDiff | None:
        """Find a diff by its structural path.

        Args:
            path: The full structural path of the element

        Returns:
            The matching diff, or None if not found
        """
        ...

    def shallow(self) -> TreeDiff:
        """Return a shallow copy of this TreeDiff without children.

        Useful when correlating a specific diff node with other data
        without needing the full subtree.

        Returns:
            A new TreeDiff with the same data but empty child_diffs
        """
        ...

    def calculate_amendment_similarities(
        self, bill: Bill
    ) -> list[AmendmentSimilarity]:
        """Calculate similarity between this TreeDiff and bill data.

        Args:
            bill: The parsed bill data

        Returns:
            List of AmendmentSimilarity objects for TreeDiff paths that match
        """
        ...

    def scan_for_mentions(
        self, bill: Bill
    ) -> dict[str, list[MentionMatch]]:
        """Scan all amendment texts for mentions of changed sections.

        Uses regexes generated from this TreeDiff to find section mentions
        in each amendment's amending_text.

        Args:
            bill: The parsed bill data

        Returns:
            Dictionary mapping amendment_id to list of MentionMatch objects
        """
        ...

    def to_json(self) -> str:
        """Serialize the diff to a JSON string."""
        ...

    def to_dict(self) -> dict[str, Any]:
        """Serialize the diff to a dictionary."""
        ...

    @staticmethod
    def from_json(json_str: str) -> TreeDiff:
        """Deserialize a JSON string to a TreeDiff."""
        ...

class AmendmentSimilarity:
    """Similarity between a TreeDiff and a bill amendment.

    Used to rank how likely a BillAmendment caused the changes at a TreeDiff location.
    """

    @property
    def tree_diff_path(self) -> str:
        """The structural path of the TreeDiff node"""
        ...

    @property
    def amendment_id(self) -> str:
        """The ID of the matched BillAmendment"""
        ...

    @property
    def score(self) -> float:
        """Primary ranking metric (F1 score of best-matching BillDiff)"""
        ...

    @property
    def precision(self) -> float:
        """How well the amendment explains the TreeDiff's changes (0.0-1.0)"""
        ...

    @property
    def recall(self) -> float:
        """How much of the amendment is represented in this TreeDiff (0.0-1.0)"""
        ...

    @property
    def matched_words(self) -> int:
        """Number of words that matched between TreeDiff and Amendment"""
        ...

    @property
    def tree_diff_words(self) -> int:
        """Total significant words in the TreeDiff's changes"""
        ...

    def to_json(self) -> str:
        """Serialize to a JSON string."""
        ...

    def to_dict(self) -> dict[str, Any]:
        """Serialize to a dictionary."""
        ...

    @staticmethod
    def from_json(json_str: str) -> AmendmentSimilarity:
        """Deserialize a JSON string to an AmendmentSimilarity."""
        ...

class MentionMatch:
    """A match found when scanning amendment text for section mentions.

    When scanning bill amendments against a TreeDiff's regexes, this captures
    each match, linking the structural path from the TreeDiff to the text that
    matched in the amendment.
    """

    @property
    def tree_diff_path(self) -> str:
        """The structural path from the TreeDiff that generated this match"""
        ...

    @property
    def matched_text(self) -> str:
        """The text that matched the regex pattern"""
        ...

    def to_json(self) -> str:
        """Serialize to a JSON string."""
        ...

    def to_dict(self) -> dict[str, Any]:
        """Serialize to a dictionary."""
        ...

    @staticmethod
    def from_json(json_str: str) -> MentionMatch:
        """Deserialize a JSON string to a MentionMatch."""
        ...

def parse_uslm_xml(path: str, date: str) -> USLMElement:
    """Parse a USLM XML file and return as a USLMElement.

    Args:
        path: Path to the USLM XML file
        date: Publication date in YYYY-MM-DD format

    Returns:
        Parsed document as a USLMElement tree
    """
    ...

def load_uslm_folder(path: str, date: str) -> USLMElement | None:
    """Load and merge all USLM XML files from a folder into a single element.

    Reads all .xml files from the folder, parses them in parallel, and merges
    all parsed elements' children into a single root element. Useful for loading
    a complete US Code title that may be split across multiple XML files.

    Args:
        path: Path to directory containing USLM XML files
        date: Publication date in YYYY-MM-DD format

    Returns:
        Merged USLMElement tree, or None if the folder is empty or unreadable
    """
    ...

def compute_diff(old_element: USLMElement, new_element: USLMElement) -> TreeDiff:
    """Compute word-level diff between two USLM documents.

    Args:
        old_element: The original (older) version of the element
        new_element: The new (newer) version of the element

    Returns:
        TreeDiff containing all detected changes

    Raises:
        ValueError: If the two elements don't have the same structural path
    """
    ...

class BillDiff:
    """Word-level changes from a bill amendment instruction.

    Each BillDiff represents one atomic change instruction, such as
    "strike 'specified' and insert 'foreign'".
    """

    def __init__(self, added: list[str], removed: list[str]) -> None:
        """Create a new BillDiff.

        Args:
            added: Words that were added by this instruction
            removed: Words that were removed by this instruction
        """
        ...

    @property
    def added(self) -> list[str]:
        """Words that were added by this instruction"""
        ...

    @property
    def removed(self) -> list[str]:
        """Words that were removed by this instruction"""
        ...

    def to_json(self) -> str:
        """Serialize to a JSON string."""
        ...

    def to_dict(self) -> dict[str, Any]:
        """Serialize to a dictionary."""
        ...

    @staticmethod
    def from_json(json_str: str) -> BillDiff:
        """Deserialize a JSON string to a BillDiff."""
        ...

class BillAmendment:
    """An amendment found in a bill that modifies the US Code"""

    @property
    def id(self) -> str:
        """Content-based ID: sha256("{bill_id}:{amending_text}") - 64 hex chars"""
        ...

    @property
    def action_types(self) -> list[Literal["amend", "add", "delete", "insert", "redesignate", "repeal", "move", "strike", "strikeandinsert"]]:
        """Types of amending actions performed by this amendment"""
        ...

    @property
    def amending_text(self) -> str:
        """The full readable text of the amending instruction"""
        ...

    @property
    def changes(self) -> list[BillDiff]:
        """Word-level changes extracted from this amendment (populated externally)"""
        ...

    def update_changes(self, changes: list[BillDiff]) -> BillAmendment:
        """Create a new BillAmendment with updated changes.

        Returns a new BillAmendment with the same id, action_types, and amending_text,
        but with the provided changes.

        Args:
            changes: The new list of BillDiff changes

        Returns:
            A new BillAmendment with the updated changes
        """
        ...

    def to_json(self) -> str:
        """Serialize the amendment to a JSON string."""
        ...

    def to_dict(self) -> dict[str, Any]:
        """Serialize the amendment to a dictionary."""
        ...

    @staticmethod
    def from_json(json_str: str) -> BillAmendment:
        """Deserialize a JSON string to a BillAmendment."""
        ...

class Bill:
    """Data extracted from a bill document"""

    def __init__(self, bill_id: str, amendments: list[BillAmendment]) -> None:
        """Create a new Bill.

        Args:
            bill_id: The bill identifier (e.g., '119-21' for the 119th Congress, 21st law)
            amendments: List of BillAmendment objects extracted from the bill
        """
        ...

    @property
    def bill_id(self) -> str:
        """The bill identifier (e.g., '119-21' for the 119th Congress, 21st law)"""
        ...

    @property
    def amendments(self) -> dict[str, BillAmendment]:
        """All amendments extracted from the bill, keyed by amendment ID"""
        ...

    def get_amendment(self, amendment_id: str) -> BillAmendment | None:
        """Get a specific amendment by ID."""
        ...

    def to_json(self) -> str:
        """Serialize the bill to a JSON string."""
        ...

    def to_dict(self) -> dict[str, Any]:
        """Serialize the bill to a dictionary."""
        ...

    @staticmethod
    def from_json(json_str: str) -> Bill:
        """Deserialize a JSON string to a Bill."""
        ...

def parse_bill_amendments(bill_id: str, path: str) -> Bill:
    """Parse a Public Law bill and extract amendments to the US Code.

    Args:
        bill_id: The bill identifier (e.g., "119-21")
        path: Path to the Public Law XML file

    Returns:
        Bill containing the bill ID and all extracted amendments

    Raises:
        ValueError: If the XML is invalid
        OSError: If the file cannot be read
    """
    ...

def parse_bill_amendments_from_str(bill_id: str, xml_str: str) -> Bill:
    """Parse a Public Law bill XML string and extract amendments to the US Code.

    Args:
        bill_id: The bill identifier (e.g., "119-21")
        xml_str: The Public Law XML content as a string

    Returns:
        Bill containing the bill ID and all extracted amendments

    Raises:
        ValueError: If the XML is invalid
    """
    ...

# ============================================================================
# Annotation types
# ============================================================================

class BillReference:
    """A reference to a bill that caused a change"""

    def __init__(self, bill_id: str, amendment_id: str, causative_text: str) -> None:
        """Create a new bill reference.

        Args:
            bill_id: The bill identifier (e.g., "119-21")
            amendment_id: The amendment ID (content-hash) linking back to BillAmendment
            causative_text: Text of the amending instruction from the bill
        """
        ...

    @property
    def bill_id(self) -> str:
        """The bill identifier (e.g., "119-21" for Pub. L. 119-21)"""
        ...

    @property
    def amendment_id(self) -> str:
        """The amendment ID (content-hash) linking back to BillAmendment"""
        ...

    @property
    def causative_text(self) -> str:
        """Text of the amending instruction from the bill"""
        ...

    def to_json(self) -> str:
        """Serialize to a JSON string."""
        ...

    def to_dict(self) -> dict[str, Any]:
        """Serialize to a dictionary."""
        ...

    @staticmethod
    def from_json(json_str: str) -> BillReference:
        """Deserialize a JSON string to a BillReference."""
        ...

class AnnotationMetadata:
    """Metadata about an annotation"""

    @property
    def status(self) -> Literal["pending", "verified", "disputed", "rejected"]:
        """Current verification status of this annotation"""
        ...

    @property
    def confidence(self) -> float | None:
        """Confidence score for AI-generated annotations (0.0 - 1.0), None for human annotations"""
        ...

    @property
    def annotator(self) -> str:
        """Identifier for who/what created this annotation (e.g., "human:username" or "model:gpt-4")"""
        ...

    @property
    def timestamp(self) -> str:
        """When this annotation was created (ISO 8601 format)"""
        ...

    @property
    def notes(self) -> str | None:
        """Freeform notes about the annotation"""
        ...

    @property
    def reasoning(self) -> str | None:
        """Explanation of how/why this annotation was determined"""
        ...

    def to_json(self) -> str:
        """Serialize to a JSON string."""
        ...

    def to_dict(self) -> dict[str, Any]:
        """Serialize to a dictionary."""
        ...

    @staticmethod
    def from_json(json_str: str) -> AnnotationMetadata:
        """Deserialize a JSON string to an AnnotationMetadata."""
        ...

class ChangeAnnotation:
    """An annotation linking a change to its legal cause"""

    def __init__(
        self,
        operation: Literal["amend", "add", "delete", "insert", "redesignate", "repeal", "move", "strike", "strikeandinsert"],
        bill_id: str,
        amendment_id: str,
        causative_text: str,
        annotator: str,
        paths: list[str],
        confidence: float | None = None,
        notes: str | None = None,
        reasoning: str | None = None,
    ) -> None:
        """Create a new change annotation.

        Args:
            operation: The type of legal operation that caused this change
            bill_id: The bill identifier (e.g., "119-21")
            amendment_id: The amendment ID (content-hash) linking back to BillAmendment
            causative_text: Text of the amending instruction from the bill
            annotator: Identifier for who/what created this annotation
            paths: Structural paths of related changes (for moves, redesignations)
            confidence: Confidence score for AI-generated annotations (0.0 - 1.0)
            notes: Freeform notes about the annotation
            reasoning: Explanation of how/why this annotation was determined
        """
        ...

    @property
    def operation(self) -> Literal["amend", "add", "delete", "insert", "redesignate", "repeal", "move", "strike", "strikeandinsert"]:
        """The type of legal operation that caused this change"""
        ...

    @property
    def source_bill(self) -> BillReference:
        """Reference to the bill that enacted the change"""
        ...

    @property
    def metadata(self) -> AnnotationMetadata:
        """Metadata about the annotation itself"""
        ...

    def to_json(self) -> str:
        """Serialize to a JSON string."""
        ...

    def to_dict(self) -> dict[str, Any]:
        """Serialize to a dictionary."""
        ...

    @staticmethod
    def from_json(json_str: str) -> ChangeAnnotation:
        """Deserialize a JSON string to a ChangeAnnotation."""
        ...

# ============================================================================
# Dataset types
# ============================================================================

class DatasetMetadata:
    """Metadata for a Dataset"""

    def __init__(
        self,
        name: str,
        description: str,
        author: str,
        source_urls: list[str],
        license: str,
        version: str,
    ) -> None:
        """Create dataset metadata.

        Args:
            name: Name of the dataset
            description: Description of the dataset
            author: Author or organization
            source_urls: URLs where source data was obtained
            license: License for the dataset
            version: Version string for the dataset
        """
        ...

    @property
    def name(self) -> str:
        """Name of the dataset"""
        ...

    @property
    def description(self) -> str:
        """Description of the dataset"""
        ...

    @property
    def author(self) -> str:
        """Author or organization"""
        ...

    @property
    def source_urls(self) -> list[str]:
        """URLs where source data was obtained"""
        ...

    @property
    def license(self) -> str:
        """License for the dataset"""
        ...

    @property
    def version(self) -> str:
        """Version string for the dataset"""
        ...


class VersionSnapshot:
    """A snapshot of a USLMElement at a specific point in time"""

    def __init__(
        self, date: str, element: USLMElement, label: str | None
    ) -> None:
        """Create a version snapshot.

        Args:
            date: Date in YYYY-MM-DD format
            element: The element tree at this version
            label: Optional human-readable label (e.g., "Pre-Tax Cuts Act")
        """
        ...

    @property
    def date(self) -> str:
        """Date in YYYY-MM-DD format"""
        ...

    @property
    def label(self) -> str | None:
        """Optional human-readable label"""
        ...

    @property
    def element(self) -> USLMElement:
        """The element tree at this version"""
        ...


class SearchResult:
    """A search result from Dataset.search_text"""

    @property
    def date(self) -> str:
        """Version date where match was found"""
        ...

    @property
    def path(self) -> str:
        """Structural path of matching element"""
        ...

    @property
    def field(self) -> str:
        """Field name containing match (heading, content, etc.)"""
        ...

    @property
    def snippet(self) -> str:
        """Text snippet containing the match"""
        ...


class Dataset:
    """A versioned collection of legal documents with bill annotations"""

    def __init__(self, metadata: DatasetMetadata) -> None:
        """Create a new empty dataset with the given metadata.

        Args:
            metadata: Metadata describing the dataset
        """
        ...

    @staticmethod
    def load(path: str) -> Dataset:
        """Load a dataset from a JSON file.

        Args:
            path: Path to the JSON file

        Returns:
            The loaded dataset

        Raises:
            OSError: If the file cannot be read
            ValueError: If the JSON is invalid
        """
        ...

    def save(self, path: str) -> None:
        """Save the dataset to a JSON file.

        Args:
            path: Path where the JSON file will be written

        Raises:
            OSError: If the file cannot be written
        """
        ...

    @property
    def metadata(self) -> DatasetMetadata:
        """Dataset metadata"""
        ...

    @property
    def versions(self) -> list[VersionSnapshot]:
        """Chronologically sorted version snapshots"""
        ...

    @property
    def bills(self) -> list[Bill]:
        """Bills that caused changes in this dataset"""
        ...

    def get_annotations(
        self, from_date: str, to_date: str
    ) -> list[ChangeAnnotation] | None:
        """Get annotations for a specific version pair.

        Args:
            from_date: Date of the older version
            to_date: Date of the newer version

        Returns:
            List of annotations for the version pair, or None if not found
        """
        ...

    def add_annotation(
        self, from_date: str, to_date: str, annotation: ChangeAnnotation
    ) -> None:
        """Add an annotation for a specific version pair.

        Args:
            from_date: Date of the older version
            to_date: Date of the newer version
            annotation: The annotation to add
        """
        ...

    def annotated_paths(self, from_date: str, to_date: str) -> list[str]:
        """Get paths that have annotations for a version pair.

        Args:
            from_date: Date of the older version
            to_date: Date of the newer version

        Returns:
            List of annotated paths
        """
        ...

    def unannotated_paths(self, from_date: str, to_date: str) -> list[str]:
        """Get paths with changes that lack annotations for a version pair.

        Args:
            from_date: Date of the older version
            to_date: Date of the newer version

        Returns:
            List of unannotated paths

        Raises:
            ValueError: If either version is not found
        """
        ...

    def add_version(self, snapshot: VersionSnapshot) -> None:
        """Add a version snapshot, maintaining chronological order.

        Args:
            snapshot: The version snapshot to add
        """
        ...

    def get_version(self, date: str) -> VersionSnapshot | None:
        """Get a version snapshot by exact date.

        Args:
            date: Date in YYYY-MM-DD format

        Returns:
            The version snapshot, or None if not found
        """
        ...

    def get_version_by_label(self, label: str) -> VersionSnapshot | None:
        """Get a version snapshot by label.

        Args:
            label: The label to search for

        Returns:
            The version snapshot, or None if not found
        """
        ...

    def next_version(self, date: str) -> VersionSnapshot | None:
        """Get the version after the given date.

        Args:
            date: Date in YYYY-MM-DD format

        Returns:
            The next version snapshot, or None if at end
        """
        ...

    def prev_version(self, date: str) -> VersionSnapshot | None:
        """Get the version before the given date.

        Args:
            date: Date in YYYY-MM-DD format

        Returns:
            The previous version snapshot, or None if at start
        """
        ...

    def compute_diff(self, from_date: str, to_date: str) -> TreeDiff:
        """Compute diff between two versions by date.

        Args:
            from_date: Date of the older version
            to_date: Date of the newer version

        Returns:
            TreeDiff between the two versions

        Raises:
            ValueError: If either version is not found
        """
        ...

    def add_bill(self, bill: Bill) -> None:
        """Add a bill to the dataset.

        Args:
            bill: The bill data
        """
        ...

    def get_bill(self, bill_id: str) -> Bill | None:
        """Get a bill by its ID.

        Args:
            bill_id: The bill identifier (e.g., "119-21")

        Returns:
            The bill data, or None if not found
        """
        ...

    def annotations_for_path(self, path: str) -> list[ChangeAnnotation]:
        """Get all annotations that include the given path.

        Args:
            path: The structural path to search for

        Returns:
            List of annotations for this path
        """
        ...

    def annotations_for_bill(self, bill_id: str) -> list[ChangeAnnotation]:
        """Get all annotations associated with the given bill ID.

        Args:
            bill_id: The bill identifier

        Returns:
            List of annotations from this bill
        """
        ...

    def search_text(self, query: str) -> list[SearchResult]:
        """Search for text across all versions.

        Args:
            query: Text to search for (case-insensitive)

        Returns:
            List of search results
        """
        ...

    def find_element(self, path: str) -> list[tuple[str, USLMElement]]:
        """Find an element by path across all versions.

        Args:
            path: The structural path to search for

        Returns:
            List of (date, element) tuples for each version containing the path
        """
        ...

    def add_uslm_xml(
        self, xml_path: str, date: str, label: str | None = None
    ) -> None:
        """Parse a USLM XML file and add it as a version snapshot.

        Args:
            xml_path: Path to the USLM XML file
            date: Publication date in YYYY-MM-DD format
            label: Optional human-readable label for this version

        Raises:
            ValueError: If XML parsing fails
            OSError: If file cannot be read
        """
        ...

    def add_uslm_folder(
        self, folder_path: str, date: str, label: str | None = None
    ) -> None:
        """Load all USLM XML files from a folder and add as a merged version snapshot.

        Args:
            folder_path: Path to directory containing USLM XML files
            date: Publication date in YYYY-MM-DD format
            label: Optional human-readable label for this version

        Raises:
            OSError: If the folder is empty or cannot be read
        """
        ...

    def to_json(self) -> str:
        """Serialize the dataset to a JSON string."""
        ...


    def add_changes_to_amendment(self, amendment_id: str, bill_diff: BillDiff) -> None:
        """Add changes to an existing amendment in the dataset.

        Args:
            amendment_id: The content-hash ID of the amendment
            bill_diff: The diff to add to the amendment's changes
        """
        ...

    @staticmethod
    def from_json(json_str: str) -> Dataset:
        """Deserialize a JSON string to a Dataset."""
        ...

    # Congress data methods

    def add_member(self, member: Member) -> None:
        """Add a Congress member to the dataset."""
        ...

    def get_member(self, bioguide_id: str) -> Member | None:
        """Get a member by bioguide ID."""
        ...

    def add_sponsor_info(self, info: SponsorInfo) -> None:
        """Add sponsor info for a bill."""
        ...

    def get_sponsor_info(self, bill_id: str) -> SponsorInfo | None:
        """Get sponsor info by bill ID."""
        ...

    @property
    def members(self) -> list[Member]:
        """All Congress members."""
        ...

    @property
    def sponsors(self) -> list[SponsorInfo]:
        """All sponsor info records."""
        ...

    def load_bill_download(self, download: BillDownload) -> str:
        """Load bill data from a BillDownload.

        Parses XML and JSON, stores bill, sponsors, and members.

        Args:
            download: Downloaded bill data

        Returns:
            Canonical bill_id from parsed XML (e.g., "119-21")
        """
        ...


# ============================================================================
# Congress types
# ============================================================================

class Party:
    """Political party affiliation"""

    @staticmethod
    def democrat() -> Party: ...

    @staticmethod
    def republican() -> Party: ...

    @staticmethod
    def independent() -> Party: ...

    @staticmethod
    def other(name: str) -> Party: ...

    def is_democrat(self) -> bool: ...
    def is_republican(self) -> bool: ...
    def is_independent(self) -> bool: ...
    def name(self) -> str: ...


class Chamber:
    """Congressional chamber"""

    @staticmethod
    def senate() -> Chamber: ...

    @staticmethod
    def house() -> Chamber: ...

    def is_senate(self) -> bool: ...
    def is_house(self) -> bool: ...


class MemberTerm:
    """A term of service for a Congress member"""

    @property
    def congress(self) -> int: ...

    @property
    def chamber(self) -> Chamber: ...

    @property
    def state(self) -> str: ...

    @property
    def district(self) -> int | None: ...

    @property
    def start_year(self) -> int: ...

    @property
    def end_year(self) -> int | None: ...


class Member:
    """A Congress member"""

    def __init__(
        self,
        bioguide_id: str,
        name: str,
        first_name: str,
        last_name: str,
        party: Party,
        state: str,
        district: int | None,
        chamber: Chamber,
    ) -> None: ...

    @property
    def bioguide_id(self) -> str: ...

    @property
    def name(self) -> str: ...

    @property
    def first_name(self) -> str: ...

    @property
    def last_name(self) -> str: ...

    @property
    def party(self) -> Party: ...

    @property
    def state(self) -> str: ...

    @property
    def district(self) -> int | None: ...

    @property
    def chamber(self) -> Chamber: ...

    @property
    def terms(self) -> list[MemberTerm]: ...


class CosponsorRecord:
    """A cosponsor of a bill"""

    def __init__(self, bioguide_id: str, date: str, withdrawn: bool) -> None: ...

    @property
    def bioguide_id(self) -> str: ...

    @property
    def date(self) -> str: ...

    @property
    def withdrawn(self) -> bool: ...


class SponsorInfo:
    """Sponsor and cosponsor info for a bill"""

    @property
    def bill_id(self) -> str: ...

    @property
    def sponsor(self) -> str: ...

    @property
    def cosponsors(self) -> list[CosponsorRecord]: ...


class BillDownload:
    """Raw downloaded data for a bill"""

    def __init__(
        self,
        bill_id: str,
        bill_xml: str,
        sponsors_json: str,
        cosponsors_json: str,
        votes_json: str | None,
        member_jsons: dict[str, str],
    ) -> None: ...

    @property
    def bill_id(self) -> str: ...

    @property
    def bill_xml(self) -> str: ...

    @property
    def sponsors_json(self) -> str: ...

    @property
    def cosponsors_json(self) -> str: ...

    @property
    def votes_json(self) -> str | None: ...

    @property
    def member_jsons(self) -> dict[str, str]: ...


class CongressClient:
    """Client for downloading data from Congress.gov API"""

    def __init__(self, api_key: str) -> None:
        """Create a new Congress client.

        Args:
            api_key: Congress.gov API key
        """
        ...

    @property
    def api_key(self) -> str: ...

    def download_bill(self, bill_id: str) -> BillDownload:
        """Download all data for a bill.

        Args:
            bill_id: Bill identifier (e.g., "119-hr-1")

        Returns:
            BillDownload containing XML, JSON, and member data
        """
        ...


__version__: str
__all__: list[str]