Datasets:
File size: 48,549 Bytes
cc8c085 8cd1727 cc8c085 09e94cd cc8c085 09e94cd cc8c085 09e94cd cc8c085 09e94cd cc8c085 09e94cd cc8c085 09e94cd 1f200c9 09e94cd 1f200c9 09e94cd 1f200c9 09e94cd 1f200c9 cc8c085 09e94cd cc8c085 09e94cd cc8c085 09e94cd cc8c085 09e94cd cc8c085 09e94cd cc8c085 8cd1727 cc8c085 d10cde9 cc8c085 d10cde9 cc8c085 8cd1727 cc8c085 d10cde9 cc8c085 09e94cd cc8c085 d10cde9 cc8c085 8cd1727 cc8c085 8cd1727 cc8c085 d10cde9 cc8c085 d10cde9 8cd1727 d10cde9 8cd1727 cc8c085 8cd1727 cc8c085 d10cde9 cc8c085 8cd1727 cc8c085 d10cde9 cc8c085 | 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 | """Normalize endomorphosis/ipfs_*_laws into a CID-keyed canonical corpus.
Prefer article/section as the retrieval unit; fall back to law-level when
articles are missing or empty. Strip leftover HTML, then detect multilingual
title/chapter/article/section headings (Oregon-style) when present. Never
invent legal text or a hierarchy that is not in the source.
Public Hub reads only (token=False). No Hugging Face token is read or stored.
"""
from __future__ import annotations
import json
import os
import re
from collections import Counter
from pathlib import Path
from typing import Any
import pandas as pd
from huggingface_hub import dataset_info, hf_hub_download
from huggingface_hub.errors import EntryNotFoundError
from . import ENTRY_IDENTITY_SCHEMA, LAW_IDENTITY_SCHEMA, SCHEMA_VERSION
from .auth import configure_hf, public_token
from .cidutil import cid_of_json, sha256_file, sha256_hex
from .schema import SchemaError, validate_articles, validate_laws
from .reconstruct import (
article_sort_key,
parent_needs_reconstruct,
reconstruct_on,
reconstruct_parent,
)
from .structure import normalize_legal_text, split_structured_units
COLLECTOR_DEFAULT = "endomorphosis/ipfs_datasets_py"
EMPTY_ARTICLE_COLUMNS = (
"law_id",
"id",
"title",
"text",
"source_url",
"document_number",
"article_number",
"record_type",
"metadata_json",
)
def _empty_articles() -> pd.DataFrame:
return pd.DataFrame(columns=list(EMPTY_ARTICLE_COLUMNS))
def normalize_text(value: Any) -> str:
if value is None or (isinstance(value, float) and pd.isna(value)):
return ""
return normalize_legal_text(value)
def _s(value: Any) -> str:
return normalize_text(value)
def _download(repo_id: str, filename: str, cache_dir: Path) -> Path:
configure_hf()
path = hf_hub_download(
repo_id=repo_id,
filename=filename,
repo_type="dataset",
token=public_token(),
cache_dir=str(cache_dir / "hf"),
)
return Path(path)
def _repo_filenames(info: Any) -> set[str]:
return {str(getattr(s, "rfilename", "") or "") for s in (getattr(info, "siblings", None) or [])}
def _pick_repo_file(filenames: set[str], name: str) -> str | None:
for cand in (f"data/{name}.parquet", f"{name}.parquet"):
if cand in filenames:
return cand
return None
def _resolve_local_parquet(root: Path, name: str, *, required: bool = True) -> Path | None:
"""Accept either <root>/data/<name>.parquet or <root>/<name>.parquet."""
for cand in (root / "data" / f"{name}.parquet", root / f"{name}.parquet"):
if cand.is_file():
return cand
if required:
raise FileNotFoundError(f"missing {name}.parquet under {root} (tried data/ and root)")
return None
def load_local_source(local_dir: Path) -> tuple[pd.DataFrame, pd.DataFrame, dict[str, Any]]:
"""Load a local country-laws pack (filtered preprocess layout)."""
local_dir = Path(local_dir).resolve()
laws_path = _resolve_local_parquet(local_dir, "laws")
articles_path = _resolve_local_parquet(local_dir, "articles", required=False)
laws = pd.read_parquet(laws_path)
articles = pd.read_parquet(articles_path) if articles_path is not None else _empty_articles()
validate_laws(laws)
validate_articles(articles)
pack_meta: dict[str, Any] = {}
meta_path = local_dir / "pack_meta.json"
if meta_path.is_file():
try:
pack_meta = json.loads(meta_path.read_text(encoding="utf-8"))
except Exception:
pack_meta = {}
source_dataset = (
pack_meta.get("source_dataset")
or pack_meta.get("repo")
or f"local/{local_dir.name}"
)
source_revision = str(
pack_meta.get("source_revision")
or pack_meta.get("revision")
or f"local:{local_dir.name}"
)
meta = {
"source_dataset": source_dataset,
"source_revision": source_revision,
"laws_path": str(laws_path),
"articles_path": str(articles_path) if articles_path is not None else None,
"laws_sha256": sha256_file(laws_path),
"articles_sha256": sha256_file(articles_path) if articles_path is not None else None,
"n_laws_source": int(len(laws)),
"n_articles_source": int(len(articles)),
"laws_columns": list(map(str, laws.columns)),
"articles_columns": list(map(str, articles.columns)),
"article_count_dtype": str(laws["article_count"].dtype) if "article_count" in laws.columns else None,
"schema_surprises": _schema_surprises(laws, articles),
"local_source_dir": str(local_dir),
"pack_meta": pack_meta,
}
return laws, articles, meta
def _law_shards(local: Path) -> list[Path]:
data = local / "data"
if not data.is_dir():
return []
return [
path
for path in sorted(data.glob("laws-*.parquet"))
if "_html" not in path.name
]
def _pack_local_shards(local: Path, cache_dir: Path) -> Path:
"""Concatenate a local shard directory. Does not contact the Hub."""
meta: dict[str, Any] = {}
meta_path = local / "pack_meta.json"
if meta_path.is_file():
try:
loaded = json.loads(meta_path.read_text(encoding="utf-8"))
if isinstance(loaded, dict):
meta = loaded
except Exception:
meta = {}
from ipfs_datasets_py.processors.legal_scrapers.world_law.load_sharded_laws import (
load_sharded_laws,
require_source_revision,
)
revision = require_source_revision(local)
slug = str(meta.get("slug") or local.name)
dataset = str(meta.get("source_dataset") or f"endomorphosis/ipfs_{slug}_laws")
dest = Path(cache_dir) / "packed-shards" / slug
load_sharded_laws(
local,
dest,
slug=slug,
source_dataset=dataset,
source_revision=revision,
)
return dest
def preflight_local_shard_source(source: str) -> None:
"""Reject an unpacked shard directory before ``build_country`` starts.
Hub ids and directories that already contain ``laws.parquet`` return
without reading them. A shard directory whose ``source_revision`` is
missing or not 40 lowercase hex characters raises ``ValueError``.
"""
local = Path(source)
if not local.is_dir():
return
if (local / "data" / "laws.parquet").is_file() or (local / "laws.parquet").is_file():
return
if not _law_shards(local):
return
from ipfs_datasets_py.processors.legal_scrapers.world_law.load_sharded_laws import (
require_source_revision,
)
require_source_revision(local)
def load_source(repo_id: str, cache_dir: Path) -> tuple[pd.DataFrame, pd.DataFrame, dict[str, Any]]:
"""Load Hub dataset id OR a local directory with laws/articles parquet.
A local directory of ``data/laws-*.parquet`` is packed with
``load_sharded_laws`` before it is read. That path requires a 40-hex
``source_revision`` in ``pack_meta.json`` and does not call the Hub.
"""
local = Path(repo_id)
if local.is_dir() and (
(local / "data" / "laws.parquet").is_file() or (local / "laws.parquet").is_file()
):
return load_local_source(local)
if local.is_dir() and _law_shards(local):
return load_local_source(_pack_local_shards(local, cache_dir))
configure_hf()
os.environ.setdefault("HF_HOME", str(cache_dir / "hf"))
info = dataset_info(repo_id, token=public_token())
revision = info.sha
filenames = _repo_filenames(info)
laws_file = _pick_repo_file(filenames, "laws") or "data/laws.parquet"
articles_file = _pick_repo_file(filenames, "articles")
laws_path = _download(repo_id, laws_file, cache_dir)
articles_path: Path | None = None
if articles_file is not None:
try:
articles_path = _download(repo_id, articles_file, cache_dir)
except EntryNotFoundError:
articles_path = None
laws = pd.read_parquet(laws_path)
articles = pd.read_parquet(articles_path) if articles_path is not None else _empty_articles()
validate_laws(laws)
validate_articles(articles)
meta = {
"source_dataset": repo_id,
"source_revision": revision,
"laws_path": str(laws_path),
"articles_path": str(articles_path) if articles_path is not None else None,
"laws_sha256": sha256_file(laws_path),
"articles_sha256": sha256_file(articles_path) if articles_path is not None else None,
"n_laws_source": int(len(laws)),
"n_articles_source": int(len(articles)),
"laws_columns": list(map(str, laws.columns)),
"articles_columns": list(map(str, articles.columns)),
"article_count_dtype": str(laws["article_count"].dtype) if "article_count" in laws.columns else None,
"schema_surprises": _schema_surprises(laws, articles),
}
return laws, articles, meta
def _schema_surprises(laws: pd.DataFrame, articles: pd.DataFrame) -> list[str]:
notes: list[str] = []
if articles is None or articles.empty:
notes.append("articles.parquet has 0 rows; corpus falls back to law-level units")
if "article_count" in laws.columns:
dtype = str(laws["article_count"].dtype)
notes.append(f"laws.article_count dtype={dtype}")
try:
if int((laws["article_count"].fillna(0) == 0).sum()) == len(laws):
notes.append("every law has article_count=0")
except Exception:
pass
for col in ("date", "date_issued"):
if col in laws.columns and laws[col].isna().all():
notes.append(f"laws.{col} is entirely null")
if "eli" in laws.columns:
n_eli = int(laws["eli"].notna().sum()) if hasattr(laws["eli"], "notna") else 0
notes.append(f"laws.eli non-null={n_eli}/{len(laws)}")
if "language" in laws.columns:
langs = sorted({str(x) for x in laws["language"].dropna().unique()})
notes.append(f"laws.language values={langs}")
return notes
def _parse_meta(raw: str) -> dict[str, Any]:
if not raw:
return {}
try:
obj = json.loads(raw)
return obj if isinstance(obj, dict) else {}
except Exception:
return {}
def _law_cid(instrument_id: str, instrument_title: str, jurisdiction: str, language: str, source_dataset: str) -> str:
identity = {
"schema": LAW_IDENTITY_SCHEMA,
"source_dataset": source_dataset,
"instrument_id": instrument_id,
"instrument_title": instrument_title,
"jurisdiction": jurisdiction,
"language": language,
}
return cid_of_json(identity)
def _entry_cid(record: dict[str, Any]) -> str:
identity = {
"schema": ENTRY_IDENTITY_SCHEMA,
"record_type": record["record_type"],
"source_dataset": record["source_dataset"],
"instrument_id": record["instrument_id"],
"article_number": record.get("article_number") or "",
"article_title": record.get("article_title") or "",
"body_sha256": record["body_sha256"],
"language": record.get("language") or "",
"jurisdiction": record.get("jurisdiction") or "",
"source_url": record.get("source_url") or "",
}
return cid_of_json(identity)
def _row_get(row: pd.Series, col: str, default: str = "") -> str:
if col not in row.index:
return default
return _s(row[col])
def _coverage_from(
row: pd.Series,
meta: dict[str, Any],
articles_empty: bool,
sparse_fallback: bool = False,
) -> str:
for key in ("coverage", "coverage_note"):
if key in meta and meta[key]:
return normalize_text(meta[key])
status = normalize_text(meta.get("article_extraction_status") or "")
if sparse_fallback:
note = "law-level (article coverage below 10% of laws; sparse articles table)"
if status:
return f"{note}; extraction_status={status}"
return note
if articles_empty:
if status:
return f"law-level (articles empty or unavailable in source snapshot); extraction_status={status}"
return "law-level (articles empty or unavailable in source snapshot)"
if status:
return f"article-level; extraction_status={status}"
return "article-level"
def _snapshot_date(row: pd.Series, meta: dict[str, Any], source_meta: dict[str, Any]) -> str:
for col in ("retrieved_at", "date_issued", "date"):
val = _row_get(row, col)
if val:
return val[:10] if len(val) >= 10 and val[4] == "-" else val
for key in ("snapshot_date", "retrieved_at"):
if key in meta and meta[key]:
return normalize_text(str(meta[key]))[:10]
nested = meta.get("metadata") if isinstance(meta.get("metadata"), dict) else {}
for key in ("snapshot_date", "retrieved_at"):
if nested.get(key):
return normalize_text(str(nested[key]))[:10]
return ""
def _hierarchy_fields(
title: str, body: str, article_number: str, *, language: str = ""
) -> dict[str, Any]:
"""Best-effort hierarchy from a single already-split article/section body."""
units = split_structured_units(
f"{title}\n{body}" if title else body, language=language
)
if not units:
return {
"hierarchy_kind": "article" if article_number else "law",
"hierarchy_path": "",
"title_number": "",
"chapter_number": "",
"part_number": "",
"section_number": "",
"subsections": [],
}
unit = units[0]
return {
"hierarchy_kind": unit.kind,
"hierarchy_path": unit.hierarchy_path,
"title_number": unit.title_number,
"chapter_number": unit.chapter_number,
"part_number": unit.part_number,
"section_number": unit.section_number,
"subsections": list(unit.subsections),
}
def _compact_line(text: str) -> str:
return re.sub(r"\s+", " ", text or "").strip().casefold()
def _is_title_shell(body: str, title: str) -> bool:
"""True when the article row is only its heading, repeated once."""
folded_body = _compact_line(body)
folded_title = _compact_line(title)
if len(folded_title) < 24 or not folded_body:
return False
return folded_body == folded_title or folded_body == f"{folded_title} {folded_title}"
_NOTICE_RE = re.compile(
r"(?i)(\bnewsletter\b|\bblog\b|press release|communiqu[eé]|"
r"\bnews item\b|\bnotice board\b)"
)
def _instrument_record_type(metadata: dict[str, Any], title: str) -> str:
"""A normative instrument is a law, even when its title says Article.
Newsletters, blogs, and press notices are not laws. A provision inside a
law stays an article; this label is only for the instrument itself.
"""
meta = metadata or {}
document_type = str(meta.get("document_type") or "").strip().casefold()
meta_type = str(meta.get("record_type") or "").strip().casefold()
if _NOTICE_RE.search(title or "") or document_type in {
"newsletter",
"blog",
"press",
"press_release",
"notice",
}:
return "notice"
if document_type in {"gazette", "gazette_pdf"} and meta_type not in {
"law",
"statute",
"constitution",
}:
return "notice"
return "law"
def _unit_record_type(unit: Any, instrument_type: str, *, n_units: int, parent_body: str) -> str:
"""One unit that is the whole instrument keeps the instrument label."""
if instrument_type == "notice":
return "notice"
if (
n_units == 1
and parent_body
and len(getattr(unit, "body", "") or "") >= int(0.8 * len(parent_body))
):
return "law"
kind = getattr(unit, "kind", "") or ""
if kind in {"article", "section"}:
return kind
return "article"
def _children_are_rich(kids: list[dict[str, Any]], parent_body: str) -> bool:
"""True when the article rows already carry the statute, not just headings."""
if not kids:
return False
total = sum(len((kid.get("body") or "").strip()) for kid in kids)
if total >= max(int(len(parent_body) * 0.5), 200):
return True
return any(
len((kid.get("body") or "").strip()) >= 80
and not _is_title_shell(kid.get("body") or "", kid.get("title") or "")
for kid in kids
)
def _needs_parent_split(kids: list[dict[str, Any]], parent_body: str) -> bool:
"""Split the parent when it holds the text and the article rows do not."""
if len(parent_body) < 250 or len(parent_body) > 1_200_000:
return False
return not _children_are_rich(kids, parent_body)
def _expand_title_shell(parent: str, title: str, sibling_titles: set[str]) -> str | None:
"""Copy the parent span from this heading to the next sibling heading.
The span is taken only from lines already in the parent. A short heading
such as "Article 1" is left alone, because it matches too many lines.
"""
key = _compact_line(title)
peers = {item for item in sibling_titles if item and item != key and len(item) >= 24}
if len(key) < 24 or not peers or not parent:
return None
lines = [ln.strip() for ln in parent.splitlines() if ln.strip()]
compact = [_compact_line(ln) for ln in lines]
best = ""
for index, folded in enumerate(compact):
if folded != key:
continue
chunk = [lines[index]]
for later, later_folded in zip(lines[index + 1 :], compact[index + 1 :]):
if later_folded in peers:
break
chunk.append(later)
text = "\n".join(chunk).strip()
if len(text) > len(best):
best = text
# The heading alone is not enough. Require a following sentence from the parent.
if len(best) < len(key) + 40:
return None
return best
def _collector(meta: dict[str, Any], source_dataset: str) -> str:
nested = meta.get("metadata") if isinstance(meta.get("metadata"), dict) else {}
for blob in (meta, nested):
for key in ("collector", "collector_id", "harvester"):
if blob.get(key):
return normalize_text(blob[key])
return f"{COLLECTOR_DEFAULT} ({source_dataset})"
def laws_index(laws: pd.DataFrame, source_dataset: str) -> dict[str, dict[str, Any]]:
"""Map instrument_id -> law facet fields (always computed; not always corpus units)."""
out: dict[str, dict[str, Any]] = {}
for _, row in laws.iterrows():
instrument_id = _row_get(row, "id")
instrument_title = _row_get(row, "title")
jurisdiction = _row_get(row, "jurisdiction") or _row_get(row, "country")
language = _row_get(row, "language")
law_cid = _law_cid(instrument_id, instrument_title, jurisdiction, language, source_dataset)
meta = _parse_meta(_row_get(row, "metadata_json"))
out[instrument_id] = {
"instrument_id": instrument_id,
"instrument_title": instrument_title,
"law_cid": law_cid,
"jurisdiction": jurisdiction,
"language": language,
"source_url": _row_get(row, "source_url"),
"license": _row_get(row, "license"),
"eli": _row_get(row, "eli"),
"identifier": _row_get(row, "identifier") or instrument_id,
"official_identifier": _row_get(row, "official_identifier"),
"source_type": _row_get(row, "source_type"),
"country": _row_get(row, "country"),
"law_status": _row_get(row, "law_status"),
"body": _row_get(row, "text"),
"metadata": meta,
"row": row,
}
return out
def _base_record(
*,
record_type: str,
source_dataset: str,
source_revision: str,
instrument_id: str,
instrument_title: str,
law_cid: str,
article_number: str,
article_title: str,
body: str,
jurisdiction: str,
language: str,
source_url: str,
snapshot_date: str,
coverage: str,
license_expr: str,
collector: str,
source_id: str,
extra: dict[str, Any] | None = None,
) -> dict[str, Any]:
title_for_bm25 = article_title if record_type == "article" and article_title else instrument_title
rec: dict[str, Any] = {
"record_type": record_type,
"source_dataset": source_dataset,
"source_revision": source_revision,
"source_id": source_id,
"instrument_id": instrument_id,
"instrument_title": instrument_title,
"law_id": instrument_id,
"law_cid": law_cid,
"article_number": article_number,
"article_title": article_title,
"title": title_for_bm25,
"body": body,
"body_sha256": sha256_hex(body.encode("utf-8")),
"jurisdiction": jurisdiction,
"language": language,
"source_url": source_url,
"snapshot_date": snapshot_date,
"coverage": coverage,
"license": license_expr,
"collector": collector,
"schema_version": SCHEMA_VERSION,
"entry_identity_schema_version": ENTRY_IDENTITY_SCHEMA,
}
if extra:
rec.update(extra)
from .citations import assign_citation, citation_fields
slug = ""
if source_dataset.startswith("endomorphosis/ipfs_") and source_dataset.endswith("_laws"):
slug = source_dataset.split("ipfs_", 1)[1].removesuffix("_laws")
year = ""
if snapshot_date and len(snapshot_date) >= 4 and snapshot_date[:4].isdigit():
year = snapshot_date[:4]
extra = extra or {}
rec.update(
citation_fields(
assign_citation(
eli=str(rec.get("eli") or extra.get("eli") or ""),
official_identifier=str(
rec.get("official_identifier") or extra.get("official_identifier") or ""
),
identifier=str(rec.get("identifier") or extra.get("identifier") or ""),
instrument_title=instrument_title,
article_number=article_number,
section_number=str(extra.get("section_number") or ""),
record_type=record_type,
jurisdiction=jurisdiction,
country=str(extra.get("country") or ""),
slug=slug,
year=year,
)
)
)
rec["entry_cid"] = _entry_cid(rec)
rec["title_length"] = len(title_for_bm25)
rec["body_length"] = len(body)
rec["document_length"] = len(title_for_bm25) + len(body)
return rec
def _cid_worker_count(n_articles: int, requested: int | None) -> int:
"""Cores for a CID-set check. Small corpora stay on one core."""
if requested is not None:
return max(1, int(requested))
if n_articles < 8000:
return 1
cpus = os.cpu_count() or 2
return max(2, min(12, cpus // 4, max(2, n_articles // 20000)))
def _article_outcome(
row: pd.Series,
*,
law_map: dict[str, dict[str, Any]],
promoted: dict[str, list[Any]],
sibling_titles: dict[str, set[str]],
source_meta: dict[str, Any],
source_dataset: str,
source_revision: str,
) -> tuple[dict[str, Any] | None, str, Any]:
"""One article row as a corpus record, or a drop reason.
``("", promoted skip)`` is ``(None, "", None)`` and is not a drop.
"""
source_id = _row_get(row, "id")
instrument_id = _row_get(row, "law_id")
body = _row_get(row, "text")
article_title = _row_get(row, "title")
article_number = _row_get(row, "article_number")
if not body:
return None, "empty_body", source_id
if instrument_id in promoted:
return None, "", None
parent = law_map.get(instrument_id)
if parent and _is_title_shell(body, article_title):
expanded = _expand_title_shell(
parent["body"],
article_title,
sibling_titles.get(instrument_id) or set(),
)
if expanded:
body = expanded
if not parent:
return None, "missing_instrument", {"article_id": source_id, "law_id": instrument_id}
meta = parent["metadata"]
art_meta = _parse_meta(_row_get(row, "metadata_json"))
merged_meta = {**meta, **art_meta}
record = _base_record(
record_type="article",
source_dataset=source_dataset,
source_revision=source_revision,
instrument_id=instrument_id,
instrument_title=parent["instrument_title"],
law_cid=parent["law_cid"],
article_number=article_number,
article_title=article_title,
body=body,
jurisdiction=parent["jurisdiction"],
language=parent["language"] or _row_get(row, "language"),
source_url=_row_get(row, "source_url") or parent["source_url"],
snapshot_date=_snapshot_date(parent["row"], merged_meta, source_meta),
coverage=_coverage_from(parent["row"], merged_meta, articles_empty=False),
license_expr=parent["license"],
collector=_collector(merged_meta, source_dataset),
source_id=source_id,
extra={
"eli": parent["eli"],
"identifier": parent["identifier"],
"official_identifier": parent["official_identifier"],
"source_type": parent["source_type"],
"country": parent["country"],
"law_status": parent["law_status"],
"parent_law_id": instrument_id,
"article_id": source_id,
**_hierarchy_fields(
article_title, body, article_number, language=parent["language"]
),
},
)
return record, "", None
# Forked CID workers read this. It is set only for the duration of a pool.
_CID_JOB: dict[str, Any] = {}
def _cid_article_span(span: tuple[int, int]) -> list[tuple[str, str, Any]]:
start, end = span
job = _CID_JOB
articles = job["articles"]
out: list[tuple[str, str, Any]] = []
for i in range(start, end):
record, drop, sample = _article_outcome(
articles.iloc[i],
law_map=job["law_map"],
promoted=job["promoted"],
sibling_titles=job["sibling_titles"],
source_meta=job["source_meta"],
source_dataset=job["source_dataset"],
source_revision=job["source_revision"],
)
if record is None:
out.append(("", drop, sample))
else:
out.append((str(record["entry_cid"]), "", record.get("source_id")))
return out
def build_corpus(
laws: pd.DataFrame,
articles: pd.DataFrame,
source_meta: dict[str, Any],
*,
cid_only: bool = False,
cid_workers: int | None = None,
) -> tuple[pd.DataFrame, dict[str, Any]]:
source_dataset = source_meta["source_dataset"]
source_revision = source_meta["source_revision"]
law_map = laws_index(laws, source_dataset)
articles_empty = articles is None or articles.empty
n_laws = int(len(laws))
n_arts = int(len(articles) if articles is not None else 0)
article_law_coverage = (n_arts / n_laws) if n_laws else 0.0
# Empty articles.parquet already falls back. Also fall back when the table is
# present but covers under ~10% as many rows as laws (Estonia: 2 vs 3484).
sparse_fallback = (not articles_empty) and article_law_coverage < 0.10
use_articles = (not articles_empty) and not sparse_fallback
extraction_statuses: Counter[str] = Counter()
for parent in law_map.values():
st = normalize_text(parent["metadata"].get("article_extraction_status") or "")
if st:
extraction_statuses[st] += 1
report: dict[str, Any] = {
"source_dataset": source_dataset,
"source_revision": source_revision,
"laws_sha256": source_meta.get("laws_sha256"),
"articles_sha256": source_meta.get("articles_sha256"),
"n_laws_in": int(len(laws)),
"n_articles_in": int(len(articles) if articles is not None else 0),
"unit": "article" if use_articles else "law",
"article_law_coverage": article_law_coverage,
"sparse_article_fallback": sparse_fallback,
"drops": {
"empty_body": 0,
"missing_instrument": 0,
"duplicate_cid": 0,
"duplicate_source_kept_first": 0,
},
"drop_samples": {
"empty_body": [],
"missing_instrument": [],
"duplicate_cid": [],
},
"language_breakdown": {},
"quality_flags": {},
"schema_surprises": list(source_meta.get("schema_surprises") or []),
"n_out": 0,
"never_invented_legal_text": True,
"n_reconstructed_parents": 0,
"n_reconstructed_truncated": 0,
"n_reconstructed_stubs": 0,
"n_empty_parents_with_articles_not_reconstructed": 0,
"n_thin_instruments_replaced": 0,
}
entries: list[dict[str, Any]] = []
cid_seen: set[str] = set()
n_emitted = 0
def _keep(rec: dict[str, Any]) -> None:
nonlocal n_emitted
if not cid_only:
entries.append(rec)
return
n_emitted += 1
cid = str(rec.get("entry_cid") or "")
if not cid:
return
if cid in cid_seen:
report["drops"]["duplicate_cid"] += 1
report["drops"]["duplicate_source_kept_first"] += 1
if len(report["drop_samples"]["duplicate_cid"]) < 20:
report["drop_samples"]["duplicate_cid"].append(rec.get("source_id"))
return
cid_seen.add(cid)
slug = ""
if source_dataset.startswith("endomorphosis/ipfs_") and source_dataset.endswith("_laws"):
slug = source_dataset.split("ipfs_", 1)[1].removesuffix("_laws")
children_by_law: dict[str, list[dict[str, Any]]] = {}
if not articles_empty:
for _, row in articles.iterrows():
lid = _row_get(row, "law_id")
if not lid:
continue
children_by_law.setdefault(lid, []).append(
{
"id": _row_get(row, "id"),
"title": _row_get(row, "title"),
"article_number": _row_get(row, "article_number"),
"body": _row_get(row, "text"),
"row": row,
}
)
reconstructed_ids: set[str] = set()
running_extra_bytes = 0
def _append_law_row(
instrument_id: str,
parent: dict[str, Any],
recon=None,
) -> None:
body = parent["body"]
recon_extra: dict[str, Any] = {}
coverage = _coverage_from(
parent["row"],
parent["metadata"],
articles_empty=articles_empty,
sparse_fallback=sparse_fallback,
)
if recon is not None and recon.reconstructed_from_articles:
body = recon.body
recon_extra = recon.extra_fields()
coverage = f"{coverage}; reconstructed_from_articles"
if not body:
kids = children_by_law.get(instrument_id) or []
# Article rows that normalize to nothing are not recoverable text.
if any(str(kid.get("body") or "").strip() for kid in kids):
report["n_empty_parents_with_articles_not_reconstructed"] += 1
report["drops"]["empty_body"] += 1
if len(report["drop_samples"]["empty_body"]) < 20:
report["drop_samples"]["empty_body"].append(instrument_id)
return
meta = parent["metadata"]
_keep(
_base_record(
record_type=_instrument_record_type(meta, parent["instrument_title"]),
source_dataset=source_dataset,
source_revision=source_revision,
instrument_id=instrument_id,
instrument_title=parent["instrument_title"],
law_cid=parent["law_cid"],
article_number="",
article_title="",
body=body,
jurisdiction=parent["jurisdiction"],
language=parent["language"],
source_url=parent["source_url"],
snapshot_date=_snapshot_date(parent["row"], meta, source_meta),
coverage=coverage,
license_expr=parent["license"],
collector=_collector(meta, source_dataset),
source_id=instrument_id,
extra={
"eli": parent["eli"],
"identifier": parent["identifier"],
"official_identifier": parent["official_identifier"],
"source_type": parent["source_type"],
"country": parent["country"],
"law_status": parent["law_status"],
"parent_law_id": "",
"article_id": "",
"reconstructed_from_articles": False,
**_hierarchy_fields(
parent["instrument_title"], body, "", language=parent["language"]
),
**recon_extra,
},
)
)
if sparse_fallback:
report["schema_surprises"].append(
f"article coverage {article_law_coverage:.4f} < 0.10 of laws; falling back to law-level units"
)
for instrument_id, parent in law_map.items():
kids = children_by_law.get(instrument_id) or []
recon = None
if reconstruct_on() and parent_needs_reconstruct(parent["body"], len(kids)):
recon = reconstruct_parent(
slug=slug,
parent_body=parent["body"],
parent_title=parent["instrument_title"],
children=[
{
"id": k["id"],
"title": k["title"],
"article_number": k["article_number"],
"body": k["body"],
}
for k in kids
],
running_extra_bytes=running_extra_bytes,
sha256_hex=sha256_hex,
)
running_extra_bytes += recon.extra_bytes
reconstructed_ids.add(instrument_id)
report["n_reconstructed_parents"] += 1
if recon.reconstruction_truncated:
report["n_reconstructed_truncated"] += 1
if recon.is_stub:
report["n_reconstructed_stubs"] += 1
_append_law_row(instrument_id, parent, recon)
emit_articles = use_articles or bool(reconstructed_ids)
skip_body_split = emit_articles
sibling_titles = {
instrument_id: {_compact_line(kid["title"]) for kid in kids}
for instrument_id, kids in children_by_law.items()
}
promoted: dict[str, list[Any]] = {}
if emit_articles:
for instrument_id, parent in law_map.items():
kids = children_by_law.get(instrument_id) or []
if not _needs_parent_split(kids, parent["body"]):
continue
units = split_structured_units(parent["body"], language=parent["language"])
covered = sum(len(unit.body) for unit in units)
if len(units) >= 2 and covered >= int(0.35 * len(parent["body"])):
promoted[instrument_id] = units
if promoted:
report["n_thin_instruments_replaced"] = len(promoted)
report["schema_surprises"].append(
"parent headings used for "
f"{len(promoted)} instruments whose article rows were missing or thin"
)
workers = 1
if emit_articles:
def _note_drop(drop: str, sample: Any) -> None:
if not drop:
return
report["drops"][drop] += 1
if sample is not None and len(report["drop_samples"][drop]) < 20:
report["drop_samples"][drop].append(sample)
def _take(record: dict[str, Any] | None, drop: str, sample: Any) -> None:
if drop:
_note_drop(drop, sample)
return
if record is not None:
_keep(record)
outcome_kwargs = {
"law_map": law_map,
"promoted": promoted,
"sibling_titles": sibling_titles,
"source_meta": source_meta,
"source_dataset": source_dataset,
"source_revision": source_revision,
}
workers = _cid_worker_count(int(len(articles)), cid_workers) if cid_only else 1
if workers > 1 and len(articles):
import multiprocessing as mp
_CID_JOB.clear()
_CID_JOB.update({"articles": articles, **outcome_kwargs})
span = 4000
spans = [
(start, min(start + span, int(len(articles))))
for start in range(0, int(len(articles)), span)
]
ctx = mp.get_context("fork")
with ctx.Pool(workers) as pool:
for batch in pool.imap_unordered(_cid_article_span, spans, chunksize=1):
for cid, drop, sample in batch:
if drop:
_note_drop(drop, sample)
elif cid:
_keep({"entry_cid": cid, "source_id": sample})
_CID_JOB.clear()
else:
for _, row in articles.iterrows():
_take(*_article_outcome(row, **outcome_kwargs))
for instrument_id, units in promoted.items():
parent = law_map[instrument_id]
meta = parent["metadata"]
report["unit"] = "structured"
instrument_type = _instrument_record_type(meta, parent["instrument_title"])
for unit in units:
_keep(
_base_record(
record_type=_unit_record_type(
unit,
instrument_type,
n_units=len(units),
parent_body=parent["body"],
),
source_dataset=source_dataset,
source_revision=source_revision,
instrument_id=instrument_id,
instrument_title=parent["instrument_title"],
law_cid=parent["law_cid"],
article_number=unit.article_number or unit.number,
article_title=unit.heading,
body=unit.body,
jurisdiction=parent["jurisdiction"],
language=parent["language"],
source_url=parent["source_url"],
snapshot_date=_snapshot_date(parent["row"], meta, source_meta),
coverage="structured (thin article rows replaced from the parent law)",
license_expr=parent["license"],
collector=_collector(meta, source_dataset),
source_id=f"{instrument_id}-{unit.kind}-{unit.number}",
extra={
"eli": parent["eli"],
"identifier": parent["identifier"],
"official_identifier": parent["official_identifier"],
"source_type": parent["source_type"],
"country": parent["country"],
"law_status": parent["law_status"],
"parent_law_id": instrument_id,
"article_id": "",
"hierarchy_kind": unit.kind,
"hierarchy_path": unit.hierarchy_path,
"title_number": unit.title_number,
"chapter_number": unit.chapter_number,
"part_number": unit.part_number,
"section_number": unit.section_number,
"subsections": list(unit.subsections),
},
)
)
elif not skip_body_split:
for instrument_id, parent in law_map.items():
body = parent["body"]
if not body:
continue
meta = parent["metadata"]
units = split_structured_units(body, language=parent["language"])
if units:
report["unit"] = "structured"
instrument_type = _instrument_record_type(meta, parent["instrument_title"])
for unit in units:
_keep(
_base_record(
record_type=_unit_record_type(
unit,
instrument_type,
n_units=len(units),
parent_body=body,
),
source_dataset=source_dataset,
source_revision=source_revision,
instrument_id=instrument_id,
instrument_title=parent["instrument_title"],
law_cid=parent["law_cid"],
article_number=unit.article_number or unit.number,
article_title=unit.heading,
body=unit.body,
jurisdiction=parent["jurisdiction"],
language=parent["language"],
source_url=parent["source_url"],
snapshot_date=_snapshot_date(parent["row"], meta, source_meta),
coverage="structured (headings detected in law body)",
license_expr=parent["license"],
collector=_collector(meta, source_dataset),
source_id=f"{instrument_id}-{unit.kind}-{unit.number}",
extra={
"eli": parent["eli"],
"identifier": parent["identifier"],
"official_identifier": parent["official_identifier"],
"source_type": parent["source_type"],
"country": parent["country"],
"law_status": parent["law_status"],
"parent_law_id": instrument_id,
"article_id": "",
"hierarchy_kind": unit.kind,
"hierarchy_path": unit.hierarchy_path,
"title_number": unit.title_number,
"chapter_number": unit.chapter_number,
"part_number": unit.part_number,
"section_number": unit.section_number,
"subsections": list(unit.subsections),
},
)
)
if cid_only:
# The set comparison only needs entry_cid. Bodies stay in the source
# frame and are not copied into a second corpus of Python dicts.
report["cid_only"] = True
report["cid_workers"] = workers
report["n_before_dedupe"] = n_emitted
report["n_out"] = len(cid_seen)
report["n_dropped_total"] = (
report["drops"]["empty_body"]
+ report["drops"]["missing_instrument"]
+ report["drops"]["duplicate_cid"]
)
frame = pd.DataFrame({"entry_cid": sorted(cid_seen)})
frame.attrs["normalization_report"] = report
return frame, report
entries.sort(
key=lambda r: (
r["instrument_id"],
article_sort_key(r.get("article_number") or "", r["source_id"]),
)
)
n_before = len(entries)
seen: set[str] = set()
deduped: list[dict[str, Any]] = []
for rec in entries:
cid = rec["entry_cid"]
if cid in seen:
report["drops"]["duplicate_cid"] += 1
report["drops"]["duplicate_source_kept_first"] += 1
if len(report["drop_samples"]["duplicate_cid"]) < 20:
report["drop_samples"]["duplicate_cid"].append(rec["source_id"])
continue
seen.add(cid)
deduped.append(rec)
for i, rec in enumerate(deduped):
rec["document_index"] = i
rec["corpus_index"] = i
df = pd.DataFrame(deduped)
if not df.empty and df["entry_cid"].duplicated().any():
raise SchemaError("Duplicate entry_cid remained after dedupe")
report["n_before_dedupe"] = n_before
report["n_out"] = int(len(df))
if not df.empty and "record_type" in df.columns:
n_law_rows = int((df["record_type"] == "law").sum())
n_child_rows = int(df["record_type"].isin(["article", "section"]).sum())
report["n_law_rows"] = n_law_rows
report["n_child_rows"] = n_child_rows
report["n_instruments"] = int(df["instrument_id"].nunique()) if "instrument_id" in df.columns else n_law_rows
if n_law_rows and n_child_rows:
report["unit"] = (
"law+structured" if report.get("unit") == "structured" else "law+article"
)
elif n_law_rows:
report["unit"] = "law"
elif n_child_rows:
report["unit"] = "article"
report["n_dropped_total"] = (
report["drops"]["empty_body"]
+ report["drops"]["missing_instrument"]
+ report["drops"]["duplicate_cid"]
)
if not df.empty:
report["language_breakdown"] = {
str(k): int(v) for k, v in df["language"].fillna("").value_counts().items()
}
report["record_type_breakdown"] = {
str(k): int(v) for k, v in df["record_type"].value_counts().items()
}
report["jurisdiction_breakdown"] = {
str(k): int(v) for k, v in df["jurisdiction"].fillna("").value_counts().items()
}
snapshot_dates = sorted({str(x) for x in df["snapshot_date"].fillna("") if str(x)})
report["snapshot_dates"] = snapshot_dates
else:
report["language_breakdown"] = {}
report["record_type_breakdown"] = {}
report["jurisdiction_breakdown"] = {}
report["snapshot_dates"] = []
all_article_count_zero = False
if "article_count" in laws.columns and len(laws):
try:
all_article_count_zero = int((laws["article_count"].fillna(0) == 0).sum()) == len(laws)
except Exception:
all_article_count_zero = False
report["quality_flags"] = {
"articles_table_empty": bool(articles_empty),
"sparse_article_fallback": bool(sparse_fallback),
"article_law_coverage": article_law_coverage,
"all_source_article_counts_zero": all_article_count_zero,
"article_extraction_status_counts": dict(extraction_statuses),
"missing_date": bool("date" in laws.columns and laws["date"].isna().all()) if len(laws) else False,
"missing_date_issued": bool("date_issued" in laws.columns and laws["date_issued"].isna().all()) if len(laws) else False,
"eli_present": bool("eli" in laws.columns and laws["eli"].notna().any()) if len(laws) else False,
"never_invented_legal_text": True,
"empty_bodies_dropped": report["drops"]["empty_body"],
"duplicate_cids_dropped": report["drops"]["duplicate_cid"],
}
from .profiles import majority_language, score_heading_languages
sample_text = ""
if not df.empty and "body" in df.columns:
sample_text = "\n".join(str(x) for x in df["body"].head(40).tolist())
if "title" in df.columns:
sample_text = "\n".join(str(x) for x in df["title"].head(40).tolist()) + "\n" + sample_text
heading_langs = score_heading_languages(sample_text)
report["heading_language_counts"] = dict(heading_langs)
report["heading_language_majority"] = majority_language(heading_langs)
report["document_language_majority"] = None
if report.get("language_breakdown"):
report["document_language_majority"] = max(
report["language_breakdown"].items(), key=lambda kv: kv[1]
)[0]
from .verify import verify_normalized_corpus
report["verification"] = verify_normalized_corpus(df, report)
df.attrs["normalization_report"] = report
return df, report
|