File size: 52,609 Bytes
35cdf53 | 1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 17 18 19 20 21 22 23 24 25 26 27 28 29 30 31 32 33 34 35 36 37 38 39 40 41 42 43 44 45 46 47 48 49 50 51 52 53 54 55 56 57 58 59 60 61 62 63 64 65 66 67 68 69 70 71 72 73 74 75 76 77 78 79 80 81 82 83 84 85 86 87 88 89 90 91 92 93 94 95 96 97 98 99 100 101 102 103 104 105 106 107 108 109 110 111 112 113 114 115 116 117 118 119 120 121 122 123 124 125 126 127 128 129 130 131 132 133 134 135 136 137 138 139 140 141 142 143 144 145 146 147 148 149 150 151 152 153 154 155 156 157 158 159 160 161 162 163 164 165 166 167 168 169 170 171 172 173 174 175 176 177 178 179 180 181 182 183 184 185 186 187 188 189 190 191 192 193 194 195 196 197 198 199 200 201 202 203 204 205 206 207 208 209 210 211 212 213 214 215 216 217 218 219 220 221 222 223 224 225 226 227 228 229 230 231 232 233 234 235 236 237 238 239 240 241 242 243 244 245 246 247 248 249 250 251 252 253 254 255 256 257 258 259 260 261 262 263 264 265 266 267 268 269 270 271 272 273 274 275 276 277 278 279 280 281 282 283 284 285 286 287 288 289 290 291 292 293 294 295 296 297 298 299 300 301 302 303 304 305 306 307 308 309 310 311 312 313 314 315 316 317 318 319 320 321 322 323 324 325 326 327 328 329 330 331 332 333 334 335 336 337 338 339 340 341 342 343 344 345 346 347 348 349 350 351 352 353 354 355 356 357 358 359 360 361 362 363 364 365 366 367 368 369 370 371 372 373 374 375 376 377 378 379 380 381 382 383 384 385 386 387 388 389 390 391 392 393 394 395 396 397 398 399 400 401 402 403 404 405 406 407 408 409 410 411 412 413 414 415 416 417 418 419 420 421 422 423 424 425 426 427 428 429 430 431 432 433 434 435 436 437 438 439 440 441 442 443 444 445 446 447 448 449 450 451 452 453 454 455 456 457 458 459 460 461 462 463 464 465 466 467 468 469 470 471 472 473 474 475 476 477 478 479 480 481 482 483 484 485 486 487 488 489 490 491 492 493 494 495 496 497 498 499 500 501 502 503 504 505 506 507 508 509 510 511 512 513 514 515 516 517 518 519 520 521 522 523 524 525 526 527 528 529 530 531 532 533 534 535 536 537 538 539 540 541 542 543 544 545 546 547 548 549 550 551 552 553 554 555 556 557 558 559 560 561 562 563 564 565 566 567 568 569 570 571 572 573 574 575 576 577 578 579 580 581 582 583 584 585 586 587 588 589 590 591 592 593 594 595 596 597 598 599 600 601 602 603 604 605 606 607 608 609 610 611 612 613 614 615 616 617 618 619 620 621 622 623 624 625 626 627 628 629 630 631 632 633 634 635 636 637 638 639 640 641 642 643 644 645 646 647 648 649 650 651 652 653 654 655 656 657 658 659 660 661 662 663 664 665 666 667 668 669 670 671 672 673 674 675 676 677 678 679 680 681 682 683 684 685 686 687 688 689 690 691 692 693 694 695 696 697 698 699 700 701 702 703 704 705 706 707 708 709 710 711 712 713 714 715 716 717 718 719 720 721 722 723 724 725 726 727 728 729 730 731 732 733 734 735 736 737 738 739 740 741 742 743 744 745 746 747 748 749 750 751 752 753 754 755 756 757 758 759 760 761 762 763 764 765 766 767 768 769 770 771 772 773 774 775 776 777 778 779 780 781 782 783 784 785 786 787 788 789 790 791 792 793 794 795 796 797 798 799 800 801 802 803 804 805 806 807 808 809 810 811 812 813 814 815 816 817 818 819 820 821 822 823 824 825 826 827 828 829 830 831 832 833 834 835 836 837 838 839 840 841 842 843 844 845 846 847 848 849 850 851 852 853 854 855 856 857 858 859 860 861 862 863 864 865 866 867 868 869 870 871 872 873 874 875 876 877 878 879 880 881 882 883 884 885 886 887 888 889 890 891 892 893 894 895 896 897 898 899 900 901 902 903 904 905 906 907 908 909 910 911 912 913 914 915 916 917 918 919 920 921 922 923 924 925 926 927 928 929 930 931 932 933 934 935 936 937 938 939 940 941 942 943 944 945 946 947 948 949 950 951 952 953 954 955 956 957 958 959 960 961 962 963 964 965 966 967 968 969 970 971 972 973 974 975 976 977 978 979 980 981 982 983 984 985 986 987 988 989 990 991 992 993 994 995 996 997 998 999 1000 1001 1002 1003 1004 1005 1006 1007 1008 1009 1010 1011 1012 1013 1014 1015 1016 1017 1018 1019 1020 1021 1022 1023 1024 1025 1026 1027 1028 1029 1030 1031 1032 1033 1034 1035 1036 1037 1038 1039 1040 1041 1042 1043 1044 1045 1046 1047 1048 1049 1050 1051 1052 1053 1054 1055 1056 1057 1058 1059 1060 1061 1062 1063 1064 1065 1066 1067 1068 1069 1070 1071 1072 1073 1074 1075 1076 1077 1078 1079 1080 1081 1082 1083 1084 1085 1086 1087 1088 1089 1090 1091 1092 1093 1094 1095 1096 1097 1098 1099 1100 1101 1102 1103 1104 1105 1106 1107 1108 1109 1110 1111 1112 1113 1114 1115 1116 1117 1118 1119 1120 1121 1122 1123 1124 1125 1126 1127 1128 1129 1130 1131 1132 1133 1134 1135 1136 1137 1138 1139 1140 1141 1142 1143 1144 1145 1146 1147 1148 1149 1150 1151 1152 1153 1154 1155 1156 1157 1158 1159 1160 1161 1162 1163 1164 1165 1166 1167 1168 1169 1170 1171 1172 1173 1174 1175 1176 1177 1178 1179 1180 1181 1182 1183 1184 1185 1186 1187 1188 1189 1190 1191 1192 1193 1194 1195 1196 1197 1198 1199 1200 1201 1202 1203 1204 1205 1206 1207 1208 1209 1210 1211 1212 1213 1214 1215 1216 1217 1218 1219 1220 1221 1222 1223 1224 1225 1226 1227 1228 1229 1230 1231 1232 1233 1234 1235 1236 1237 1238 1239 1240 1241 1242 1243 1244 1245 1246 1247 1248 1249 1250 1251 1252 1253 1254 1255 1256 1257 1258 1259 1260 1261 1262 1263 1264 1265 1266 1267 1268 1269 1270 1271 1272 1273 1274 1275 1276 1277 1278 1279 1280 1281 1282 1283 1284 1285 1286 1287 1288 1289 1290 1291 1292 1293 1294 1295 1296 1297 1298 1299 1300 1301 1302 1303 1304 1305 1306 1307 1308 1309 1310 1311 1312 1313 1314 1315 1316 1317 1318 1319 1320 1321 1322 1323 1324 1325 1326 1327 1328 1329 1330 1331 1332 1333 1334 1335 1336 1337 1338 1339 1340 1341 1342 1343 1344 1345 1346 1347 1348 1349 1350 1351 1352 1353 1354 1355 1356 1357 1358 1359 1360 1361 1362 1363 1364 1365 1366 1367 1368 1369 1370 1371 1372 1373 1374 1375 1376 1377 1378 1379 1380 1381 1382 1383 1384 1385 1386 1387 1388 1389 1390 1391 1392 1393 1394 1395 1396 1397 1398 1399 1400 1401 1402 1403 1404 1405 1406 1407 1408 1409 1410 1411 1412 1413 1414 1415 1416 1417 1418 1419 1420 1421 1422 1423 1424 1425 1426 1427 1428 1429 1430 1431 1432 1433 1434 1435 1436 1437 1438 1439 1440 1441 1442 1443 1444 1445 1446 1447 1448 1449 1450 1451 1452 1453 1454 1455 1456 1457 1458 1459 1460 1461 1462 1463 1464 1465 1466 1467 1468 1469 1470 1471 1472 1473 1474 1475 1476 1477 1478 1479 1480 1481 1482 1483 1484 1485 1486 1487 1488 1489 1490 1491 1492 1493 1494 1495 1496 1497 1498 1499 1500 1501 1502 1503 1504 1505 1506 1507 1508 1509 1510 1511 1512 1513 1514 1515 1516 1517 1518 1519 1520 1521 1522 1523 1524 1525 1526 1527 1528 1529 |
"""Model input dataclass."""
from collections.abc import Collection, Iterator, Mapping, Sequence
import dataclasses
import gzip
import json
import logging
import lzma
import os
import pathlib
import random
import re
import string
from typing import Any, Final, Self, TypeAlias, cast
from flax_model.alphafold3 import structure
from flax_model.alphafold3.constants import chemical_components
from flax_model.alphafold3.constants import mmcif_names
from flax_model.alphafold3.constants import residue_names
from flax_model.alphafold3.cpp import cif_dict
from flax_model.alphafold3.structure import mmcif as mmcif_lib
import rdkit.Chem as rd_chem
import zstandard as zstd
BondAtomId: TypeAlias = tuple[str, int, str]
JSON_DIALECT: Final[str] = 'alphafold3'
JSON_VERSIONS: Final[tuple[int, ...]] = (1, 2, 3, 4)
JSON_VERSION: Final[int] = JSON_VERSIONS[-1]
ALPHAFOLDSERVER_JSON_DIALECT: Final[str] = 'alphafoldserver'
ALPHAFOLDSERVER_JSON_VERSION: Final[int] = 1
def _validate_keys(actual: Collection[str], expected: Collection[str]):
"""Validates that the JSON doesn't contain any extra unwanted keys."""
if bad_keys := set(actual) - set(expected):
raise ValueError(f'Unexpected JSON keys in: {", ".join(sorted(bad_keys))}')
def _read_file(path: pathlib.Path, json_path: pathlib.Path | None) -> str:
"""Reads a maybe compressed (gzip, xz, zstd) file from the given path.
Args:
path: The path to the file to read. This can be either absolute path, or a
path relative to the JSON file path.
json_path: The path to the JSON file. If None, the path must be absolute.
Returns:
The contents of the file.
"""
if not path.is_absolute():
if json_path is None:
raise ValueError('json_path must be specified if path is not absolute.')
path = (json_path.parent / path).resolve()
with open(path, 'rb') as f:
first_six_bytes = f.read(6)
f.seek(0)
# Detect the compression type using the magic number in the header.
if first_six_bytes[:2] == b'\x1f\x8b':
with gzip.open(f, 'rt') as gzip_f:
return cast(str, gzip_f.read())
elif first_six_bytes == b'\xfd\x37\x7a\x58\x5a\x00':
with lzma.open(f, 'rt') as xz_f:
return cast(str, xz_f.read())
elif first_six_bytes[:4] == b'\x28\xb5\x2f\xfd':
with zstd.open(f, 'rt') as zstd_f:
return cast(str, zstd_f.read())
else:
return f.read().decode('utf-8')
class Template:
"""Structural template input."""
__slots__ = ('_mmcif', '_query_to_template')
def __init__(self, *, mmcif: str, query_to_template_map: Mapping[int, int]):
"""Initializes the template.
Args:
mmcif: The structural template in mmCIF format. The mmCIF should have only
one protein chain.
query_to_template_map: A mapping from query residue index to template
residue index.
"""
self._mmcif = mmcif
# Needed to make the Template class hashable.
self._query_to_template = tuple(query_to_template_map.items())
@property
def query_to_template_map(self) -> Mapping[int, int]:
return dict(self._query_to_template)
@property
def mmcif(self) -> str:
return self._mmcif
def __hash__(self) -> int:
return hash((self._mmcif, tuple(sorted(self._query_to_template))))
def __eq__(self, other: Self) -> bool:
mmcifs_equal = self._mmcif == other._mmcif
maps_equal = sorted(self._query_to_template) == sorted(
other._query_to_template
)
return mmcifs_equal and maps_equal
class ProteinChain:
"""Protein chain input."""
__slots__ = (
'_id',
'_sequence',
'_ptms',
'_description',
'_paired_msa',
'_unpaired_msa',
'_templates',
)
def __init__(
self,
*,
id: str, # pylint: disable=redefined-builtin
sequence: str,
ptms: Sequence[tuple[str, int]],
description: str | None = None,
paired_msa: str | None = None,
unpaired_msa: str | None = None,
templates: Sequence[Template] | None = None,
):
"""Initializes a single protein chain input.
Args:
id: Unique protein chain identifier.
sequence: The amino acid sequence of the chain.
ptms: A list of tuples containing the post-translational modification type
and the (1-based) residue index where the modification is applied.
description: An optional textual description of the protein chain.
paired_msa: Paired A3M-formatted MSA for this chain. This MSA is not
deduplicated and will be used to compute paired features. If None, this
field is unset and must be filled in by the data pipeline before
featurisation. If set to an empty string, it will be treated as a custom
MSA with no sequences.
unpaired_msa: Unpaired A3M-formatted MSA for this chain. This will be
deduplicated and used to compute unpaired features. If None, this field
is unset and must be filled in by the data pipeline before
featurisation. If set to an empty string, it will be treated as a custom
MSA with no sequences.
templates: A list of structural templates for this chain. If None, this
field is unset and must be filled in by the data pipeline before
featurisation. The list can be empty or contain up to 20 templates.
"""
if not all(res.isalpha() for res in sequence):
raise ValueError(f'Protein must contain only letters, got "{sequence}"')
if any(not 0 < mod[1] <= len(sequence) for mod in ptms):
raise ValueError(f'Invalid protein modification index: {ptms}')
if any(mod[0].startswith('CCD_') for mod in ptms):
raise ValueError(
f'Protein ptms must not contain the "CCD_" prefix, got {ptms}'
)
# Use hashable containers for ptms and templates.
self._id = id
self._sequence = sequence
self._ptms = tuple(ptms)
self._description = description
self._paired_msa = paired_msa
self._unpaired_msa = unpaired_msa
self._templates = tuple(templates) if templates is not None else None
@property
def id(self) -> str:
return self._id
@property
def sequence(self) -> str:
"""Returns a single-letter sequence, taking modifications into account.
Uses 'X' for all unknown residues.
"""
return ''.join([
residue_names.letters_three_to_one(r, default='X')
for r in self.to_ccd_sequence()
])
@property
def ptms(self) -> Sequence[tuple[str, int]]:
return self._ptms
@property
def description(self) -> str | None:
return self._description
@property
def paired_msa(self) -> str | None:
return self._paired_msa
@property
def unpaired_msa(self) -> str | None:
return self._unpaired_msa
@property
def templates(self) -> Sequence[Template] | None:
return self._templates
def __len__(self) -> int:
return len(self._sequence)
def __eq__(self, other: Self) -> bool:
return (
self._id == other._id
and self._sequence == other._sequence
and self._ptms == other._ptms
and self._description == other._description
and self._paired_msa == other._paired_msa
and self._unpaired_msa == other._unpaired_msa
and self._templates == other._templates
)
def __hash__(self) -> int:
return hash((
self._id,
self._sequence,
self._ptms,
self._description,
self._paired_msa,
self._unpaired_msa,
self._templates,
))
def hash_without_id(self) -> int:
"""Returns a hash ignoring the ID - useful for deduplication."""
return hash((
self._sequence,
self._ptms,
self._description,
self._paired_msa,
self._unpaired_msa,
self._templates,
))
@classmethod
def from_alphafoldserver_dict(
cls, json_dict: Mapping[str, Any], seq_id: str
) -> Self:
"""Constructs ProteinChain from the AlphaFoldServer JSON dict."""
_validate_keys(
json_dict.keys(),
{
'sequence',
'glycans',
'modifications',
'count',
'maxTemplateDate',
'useStructureTemplate',
},
)
sequence = json_dict['sequence']
if 'glycans' in json_dict:
raise ValueError(
f'Specifying glycans in the `{ALPHAFOLDSERVER_JSON_DIALECT}` format'
' is not supported.'
)
if 'maxTemplateDate' in json_dict:
raise ValueError(
f'Specifying maxTemplateDate in the `{ALPHAFOLDSERVER_JSON_DIALECT}`'
' format is not supported, use the --max_template_date flag instead.'
)
templates = None # Search for templates unless explicitly disabled.
if not json_dict.get('useStructureTemplate', True):
templates = [] # Do not use any templates.
ptms = [
(mod['ptmType'].removeprefix('CCD_'), mod['ptmPosition'])
for mod in json_dict.get('modifications', [])
]
return cls(id=seq_id, sequence=sequence, ptms=ptms, templates=templates)
@classmethod
def from_dict(
cls,
json_dict: Mapping[str, Any],
json_path: pathlib.Path | None = None,
seq_id: str | None = None,
) -> Self:
"""Constructs ProteinChain from the AlphaFold JSON dict."""
json_dict = json_dict['protein']
_validate_keys(
json_dict.keys(),
{
'id',
'sequence',
'modifications',
'description',
'unpairedMsa',
'unpairedMsaPath',
'pairedMsa',
'pairedMsaPath',
'templates',
},
)
sequence = json_dict['sequence']
ptms = [
(mod['ptmType'], mod['ptmPosition'])
for mod in json_dict.get('modifications', [])
]
unpaired_msa = json_dict.get('unpairedMsa', None)
unpaired_msa_path = json_dict.get('unpairedMsaPath', None)
if unpaired_msa and unpaired_msa_path:
raise ValueError('Only one of unpairedMsa/unpairedMsaPath can be set.')
if (
unpaired_msa
and len(unpaired_msa) < 256
and os.path.exists(unpaired_msa)
):
raise ValueError(
'Set the unpaired MSA path using the "unpairedMsaPath" field.'
)
elif unpaired_msa_path:
unpaired_msa = _read_file(pathlib.Path(unpaired_msa_path), json_path)
paired_msa = json_dict.get('pairedMsa', None)
paired_msa_path = json_dict.get('pairedMsaPath', None)
if paired_msa and paired_msa_path:
raise ValueError('Only one of pairedMsa/pairedMsaPath can be set.')
if paired_msa and len(paired_msa) < 256 and os.path.exists(paired_msa):
raise ValueError(
'Set the paired MSA path using the "pairedMsaPath" field.'
)
elif paired_msa_path:
paired_msa = _read_file(pathlib.Path(paired_msa_path), json_path)
raw_templates = json_dict.get('templates', None)
if raw_templates is None:
templates = None
else:
templates = []
for raw_template in raw_templates:
_validate_keys(
raw_template.keys(),
{'mmcif', 'mmcifPath', 'queryIndices', 'templateIndices'},
)
mmcif = raw_template.get('mmcif', None)
mmcif_path = raw_template.get('mmcifPath', None)
if mmcif and mmcif_path:
raise ValueError('Only one of mmcif/mmcifPath can be set.')
if mmcif and len(mmcif) < 256 and os.path.exists(mmcif):
raise ValueError('Set the template path using the "mmcifPath" field.')
if mmcif_path:
mmcif = _read_file(pathlib.Path(mmcif_path), json_path)
query_to_template_map = dict(
zip(raw_template['queryIndices'], raw_template['templateIndices'])
)
templates.append(
Template(mmcif=mmcif, query_to_template_map=query_to_template_map)
)
return cls(
id=seq_id or json_dict['id'],
sequence=sequence,
ptms=ptms,
description=json_dict.get('description', None),
paired_msa=paired_msa,
unpaired_msa=unpaired_msa,
templates=templates,
)
def to_dict(
self, seq_id: str | Sequence[str] | None = None
) -> Mapping[str, Mapping[str, Any]]:
"""Converts ProteinChain to an AlphaFold JSON dict."""
if self._templates is None:
templates = None
else:
templates = [
{
'mmcif': template.mmcif,
'queryIndices': list(template.query_to_template_map.keys()),
'templateIndices': (
list(template.query_to_template_map.values()) or None
),
}
for template in self._templates
]
contents = {
'id': seq_id or self._id,
'sequence': self._sequence,
'modifications': [
{'ptmType': ptm[0], 'ptmPosition': ptm[1]} for ptm in self._ptms
],
'unpairedMsa': self._unpaired_msa,
'pairedMsa': self._paired_msa,
'templates': templates,
}
if self._description is not None:
contents['description'] = self._description
return {'protein': contents}
def to_ccd_sequence(self) -> Sequence[str]:
"""Converts to a sequence of CCD codes."""
ccd_coded_seq = [
residue_names.PROTEIN_COMMON_ONE_TO_THREE.get(res, residue_names.UNK)
for res in self._sequence
]
for ptm_code, ptm_index in self._ptms:
ccd_coded_seq[ptm_index - 1] = ptm_code
return ccd_coded_seq
def fill_missing_fields(self) -> Self:
"""Fill missing MSA and template fields with default values."""
return ProteinChain(
id=self.id,
sequence=self._sequence,
ptms=self._ptms,
description=self._description,
unpaired_msa=self._unpaired_msa or '',
paired_msa=self._paired_msa or '',
templates=self._templates or [],
)
class RnaChain:
"""RNA chain input."""
__slots__ = (
'_id',
'_sequence',
'_modifications',
'_description',
'_unpaired_msa',
)
def __init__(
self,
*,
id: str, # pylint: disable=redefined-builtin
sequence: str,
modifications: Sequence[tuple[str, int]],
description: str | None = None,
unpaired_msa: str | None = None,
):
"""Initializes a single strand RNA chain input.
Args:
id: Unique RNA chain identifier.
sequence: The RNA sequence of the chain.
modifications: A list of tuples containing the modification type and the
(1-based) residue index where the modification is applied.
description: An optional textual description of the RNA chain.
unpaired_msa: Unpaired A3M-formatted MSA for this chain. This will be
deduplicated and used to compute unpaired features. If None, this field
is unset and must be filled in by the data pipeline before
featurisation. If set to an empty string, it will be treated as a custom
MSA with no sequences.
"""
if not all(res.isalpha() for res in sequence):
raise ValueError(f'RNA must contain only letters, got "{sequence}"')
if any(not 0 < mod[1] <= len(sequence) for mod in modifications):
raise ValueError(f'Invalid RNA modification index: {modifications}')
if any(mod[0].startswith('CCD_') for mod in modifications):
raise ValueError(
'RNA modifications must not contain the "CCD_" prefix, got'
f' {modifications}'
)
self._id = id
self._sequence = sequence
# Use hashable container for modifications.
self._modifications = tuple(modifications)
self._description = description
self._unpaired_msa = unpaired_msa
@property
def id(self) -> str:
return self._id
@property
def sequence(self) -> str:
"""Returns a single-letter sequence, taking modifications into account.
Uses 'N' for all unknown residues.
"""
return ''.join([
residue_names.letters_three_to_one(r, default='N')
for r in self.to_ccd_sequence()
])
@property
def modifications(self) -> Sequence[tuple[str, int]]:
return self._modifications
@property
def description(self) -> str | None:
return self._description
@property
def unpaired_msa(self) -> str | None:
return self._unpaired_msa
def __len__(self) -> int:
return len(self._sequence)
def __eq__(self, other: Self) -> bool:
return (
self._id == other._id
and self._sequence == other._sequence
and self._modifications == other._modifications
and self._description == other._description
and self._unpaired_msa == other._unpaired_msa
)
def __hash__(self) -> int:
return hash((
self._id,
self._sequence,
self._modifications,
self._description,
self._unpaired_msa,
))
def hash_without_id(self) -> int:
"""Returns a hash ignoring the ID - useful for deduplication."""
return hash((
self._sequence,
self._modifications,
self._description,
self._unpaired_msa,
))
@classmethod
def from_alphafoldserver_dict(
cls, json_dict: Mapping[str, Any], seq_id: str
) -> Self:
"""Constructs RnaChain from the AlphaFoldServer JSON dict."""
_validate_keys(json_dict.keys(), {'sequence', 'modifications', 'count'})
sequence = json_dict['sequence']
modifications = [
(mod['modificationType'].removeprefix('CCD_'), mod['basePosition'])
for mod in json_dict.get('modifications', [])
]
return cls(id=seq_id, sequence=sequence, modifications=modifications)
@classmethod
def from_dict(
cls,
json_dict: Mapping[str, Any],
json_path: pathlib.Path | None = None,
seq_id: str | None = None,
) -> Self:
"""Constructs RnaChain from the AlphaFold JSON dict."""
json_dict = json_dict['rna']
_validate_keys(
json_dict.keys(),
{
'id',
'sequence',
'modifications',
'description',
'unpairedMsa',
'unpairedMsaPath',
},
)
sequence = json_dict['sequence']
modifications = [
(mod['modificationType'], mod['basePosition'])
for mod in json_dict.get('modifications', [])
]
unpaired_msa = json_dict.get('unpairedMsa', None)
unpaired_msa_path = json_dict.get('unpairedMsaPath', None)
if unpaired_msa and unpaired_msa_path:
raise ValueError('Only one of unpairedMsa/unpairedMsaPath can be set.')
if (
unpaired_msa
and len(unpaired_msa) < 256
and os.path.exists(unpaired_msa)
):
raise ValueError(
'Set the unpaired MSA path using the "unpairedMsaPath" field.'
)
elif unpaired_msa_path:
unpaired_msa = _read_file(pathlib.Path(unpaired_msa_path), json_path)
return cls(
id=seq_id or json_dict['id'],
sequence=sequence,
modifications=modifications,
description=json_dict.get('description', None),
unpaired_msa=unpaired_msa,
)
def to_dict(
self, seq_id: str | Sequence[str] | None = None
) -> Mapping[str, Mapping[str, Any]]:
"""Converts RnaChain to an AlphaFold JSON dict."""
contents = {
'id': seq_id or self._id,
'sequence': self._sequence,
'modifications': [
{'modificationType': mod[0], 'basePosition': mod[1]}
for mod in self._modifications
],
'unpairedMsa': self._unpaired_msa,
}
if self._description is not None:
contents['description'] = self._description
return {'rna': contents}
def to_ccd_sequence(self) -> Sequence[str]:
"""Converts to a sequence of CCD codes."""
mapping = {r: r for r in residue_names.RNA_TYPES} # Same 1-letter and CCD.
ccd_coded_seq = [
mapping.get(res, residue_names.UNK_RNA) for res in self._sequence
]
for ccd_code, modification_index in self._modifications:
ccd_coded_seq[modification_index - 1] = ccd_code
return ccd_coded_seq
def fill_missing_fields(self) -> Self:
"""Fill missing MSA fields with default values."""
return RnaChain(
id=self.id,
sequence=self.sequence,
modifications=self.modifications,
unpaired_msa=self._unpaired_msa or '',
)
class DnaChain:
"""Single strand DNA chain input."""
__slots__ = ('_id', '_sequence', '_modifications', '_description')
def __init__(
self,
*,
id: str, # pylint: disable=redefined-builtin
sequence: str,
modifications: Sequence[tuple[str, int]],
description: str | None = None,
):
"""Initializes a single strand DNA chain input.
Args:
id: Unique DNA chain identifier.
sequence: The DNA sequence of the chain.
modifications: A list of tuples containing the modification type and the
(1-based) residue index where the modification is applied.
description: An optional textual description of the DNA chain.
"""
if not all(res.isalpha() for res in sequence):
raise ValueError(f'DNA must contain only letters, got "{sequence}"')
if any(not 0 < mod[1] <= len(sequence) for mod in modifications):
raise ValueError(f'Invalid DNA modification index: {modifications}')
if any(mod[0].startswith('CCD_') for mod in modifications):
raise ValueError(
'DNA modifications must not contain the "CCD_" prefix, got'
f' {modifications}'
)
self._id = id
self._sequence = sequence
# Use hashable container for modifications.
self._modifications = tuple(modifications)
self._description = description
@property
def id(self) -> str:
return self._id
@property
def sequence(self) -> str:
"""Returns a single-letter sequence, taking modifications into account.
Uses 'N' for all unknown residues.
"""
return ''.join([
residue_names.letters_three_to_one(r, default='N')
for r in self.to_ccd_sequence()
])
@property
def description(self) -> str | None:
return self._description
def __len__(self) -> int:
return len(self._sequence)
def __eq__(self, other: Self) -> bool:
return (
self._id == other._id
and self._sequence == other._sequence
and self._modifications == other._modifications
and self._description == other._description
)
def __hash__(self) -> int:
return hash(
(self._id, self._sequence, self._modifications, self._description)
)
def modifications(self) -> Sequence[tuple[str, int]]:
return self._modifications
def hash_without_id(self) -> int:
"""Returns a hash ignoring the ID - useful for deduplication."""
return hash((self._sequence, self._modifications, self._description))
@classmethod
def from_alphafoldserver_dict(
cls, json_dict: Mapping[str, Any], seq_id: str
) -> Self:
"""Constructs DnaChain from the AlphaFoldServer JSON dict."""
_validate_keys(json_dict.keys(), {'sequence', 'modifications', 'count'})
sequence = json_dict['sequence']
modifications = [
(mod['modificationType'].removeprefix('CCD_'), mod['basePosition'])
for mod in json_dict.get('modifications', [])
]
return cls(id=seq_id, sequence=sequence, modifications=modifications)
@classmethod
def from_dict(
cls, json_dict: Mapping[str, Any], seq_id: str | None = None
) -> Self:
"""Constructs DnaChain from the AlphaFold JSON dict."""
json_dict = json_dict['dna']
_validate_keys(
json_dict.keys(), {'id', 'sequence', 'modifications', 'description'}
)
sequence = json_dict['sequence']
modifications = [
(mod['modificationType'], mod['basePosition'])
for mod in json_dict.get('modifications', [])
]
return cls(
id=seq_id or json_dict['id'],
sequence=sequence,
modifications=modifications,
description=json_dict.get('description', None),
)
def to_dict(
self, seq_id: str | Sequence[str] | None = None
) -> Mapping[str, Mapping[str, Any]]:
"""Converts DnaChain to an AlphaFold JSON dict."""
contents = {
'id': seq_id or self._id,
'sequence': self._sequence,
'modifications': [
{'modificationType': mod[0], 'basePosition': mod[1]}
for mod in self._modifications
],
}
if self._description is not None:
contents['description'] = self._description
return {'dna': contents}
def to_ccd_sequence(self) -> Sequence[str]:
"""Converts to a sequence of CCD codes."""
ccd_coded_seq = [
residue_names.DNA_COMMON_ONE_TO_TWO.get(res, residue_names.UNK_DNA)
for res in self._sequence
]
for ccd_code, modification_index in self._modifications:
ccd_coded_seq[modification_index - 1] = ccd_code
return ccd_coded_seq
@dataclasses.dataclass(frozen=True, slots=True, kw_only=True)
class Ligand:
"""Ligand input.
Attributes:
id: Unique ligand "chain" identifier.
ccd_ids: The Chemical Component Dictionary or user-defined CCD IDs of the
chemical components of the ligand. Typically, this is just a single ID,
but some ligands are composed of multiple components. If that is the case,
a bond linking these components should be added to the bonded_atom_pairs
Input field.
smiles: The SMILES representation of the ligand.
description: An optional textual description of the ligand.
"""
id: str
ccd_ids: Sequence[str] | None = None
smiles: str | None = None
description: str | None = None
def __post_init__(self):
if (self.ccd_ids is None) == (self.smiles is None):
raise ValueError('Ligand must have one of CCD ID or SMILES set.')
if self.smiles is not None:
mol = rd_chem.MolFromSmiles(self.smiles)
if not mol:
raise ValueError(f'Unable to make RDKit Mol from SMILES: {self.smiles}')
# Use hashable types for ccd_ids.
if self.ccd_ids is not None:
object.__setattr__(self, 'ccd_ids', tuple(self.ccd_ids))
def __len__(self) -> int:
if self.ccd_ids is not None:
return len(self.ccd_ids)
else:
return 1
def hash_without_id(self) -> int:
"""Returns a hash ignoring the ID - useful for deduplication."""
return hash((self.ccd_ids, self.smiles, self.description))
@classmethod
def from_alphafoldserver_dict(
cls, json_dict: Mapping[str, Any], seq_id: str
) -> Self:
"""Constructs Ligand from the AlphaFoldServer JSON dict."""
# Ligand can be specified either as a ligand, or ion (special-case).
_validate_keys(json_dict.keys(), {'ligand', 'ion', 'count'})
if 'ligand' in json_dict:
return cls(id=seq_id, ccd_ids=[json_dict['ligand'].removeprefix('CCD_')])
elif 'ion' in json_dict:
return cls(id=seq_id, ccd_ids=[json_dict['ion']])
else:
raise ValueError(f'Unknown ligand type: {json_dict}')
@classmethod
def from_dict(
cls, json_dict: Mapping[str, Any], seq_id: str | None = None
) -> Self:
"""Constructs Ligand from the AlphaFold JSON dict."""
json_dict = json_dict['ligand']
_validate_keys(
json_dict.keys(), {'id', 'ccdCodes', 'smiles', 'description'}
)
if json_dict.get('ccdCodes') and json_dict.get('smiles'):
raise ValueError(
'Ligand cannot have both CCD code and SMILES set at the same time, '
f'got CCD: {json_dict["ccdCodes"]} and SMILES: {json_dict["smiles"]}'
)
if 'ccdCodes' in json_dict:
ccd_codes = json_dict['ccdCodes']
if not isinstance(ccd_codes, (list, tuple)):
raise ValueError(
'CCD codes must be a list of strings, got '
f'{type(ccd_codes).__name__} instead: {ccd_codes}'
)
return cls(
id=seq_id or json_dict['id'],
ccd_ids=ccd_codes,
description=json_dict.get('description', None),
)
elif 'smiles' in json_dict:
return cls(
id=seq_id or json_dict['id'],
smiles=json_dict['smiles'],
description=json_dict.get('description', None),
)
else:
raise ValueError(f'Unknown ligand type: {json_dict}')
def to_dict(
self, seq_id: str | Sequence[str] | None = None
) -> Mapping[str, Mapping[str, Any]]:
"""Converts Ligand to an AlphaFold JSON dict."""
contents = {'id': seq_id or self.id}
if self.ccd_ids is not None:
contents['ccdCodes'] = self.ccd_ids
if self.smiles is not None:
contents['smiles'] = self.smiles
if self.description is not None:
contents['description'] = self.description
return {'ligand': contents}
def _sample_rng_seed() -> int:
"""Sample a random seed for AlphaFoldServer job."""
# See https://alphafoldserver.com/faq#what-are-seeds-and-how-are-they-set.
return random.randint(0, 2**32 - 1)
def _validate_user_ccd_keys(keys: Sequence[str], component_name: str) -> None:
"""Validates the keys of the user-defined CCD dictionary."""
mandatory_keys = (
'_chem_comp.id',
'_chem_comp.name',
'_chem_comp.type',
'_chem_comp.formula',
'_chem_comp.mon_nstd_parent_comp_id',
'_chem_comp.pdbx_synonyms',
'_chem_comp.formula_weight',
'_chem_comp_atom.comp_id',
'_chem_comp_atom.atom_id',
'_chem_comp_atom.type_symbol',
'_chem_comp_atom.charge',
'_chem_comp_atom.pdbx_model_Cartn_x_ideal',
'_chem_comp_atom.pdbx_model_Cartn_y_ideal',
'_chem_comp_atom.pdbx_model_Cartn_z_ideal',
'_chem_comp_bond.atom_id_1',
'_chem_comp_bond.atom_id_2',
'_chem_comp_bond.value_order',
'_chem_comp_bond.pdbx_aromatic_flag',
)
if missing_keys := set(mandatory_keys) - set(keys):
raise ValueError(
f'Component {component_name} in the user-defined CCD is missing these'
f' keys: {missing_keys}'
)
@dataclasses.dataclass(frozen=True, slots=True, kw_only=True)
class Input:
"""AlphaFold input.
Attributes:
name: The name of the target.
chains: Protein chains, RNA chains, DNA chains, or ligands.
protein_chains: Protein chains.
rna_chains: RNA chains.
dna_chains: Single strand DNA chains.
ligands: Ligand (including ion) inputs.
rng_seeds: Random number generator seeds, one for each model execution.
bonded_atom_pairs: A list of tuples of atoms that are bonded to each other.
Each atom is defined by a tuple of (chain_id, res_id, atom_name). Chain
IDs must be set if there are any bonded atoms. Residue IDs are 1-indexed.
Atoms in ligands defined by SMILES can't be bonded since SMILES doesn't
define unique atom names.
user_ccd: Optional user-defined chemical component dictionary in the CIF
format. This can be used to provide additional CCD entries that are not
present in the default CCD and thus define arbitrary new ligands. This is
more expressive than SMILES since it allows to name all atoms within the
ligand which in turn makes it possible to define bonds using those atoms.
"""
name: str
chains: Sequence[ProteinChain | RnaChain | DnaChain | Ligand]
rng_seeds: Sequence[int]
bonded_atom_pairs: Sequence[tuple[BondAtomId, BondAtomId]] | None = None
user_ccd: str | None = None
def __post_init__(self):
if not self.rng_seeds:
raise ValueError('Input must have at least one RNG seed.')
if not self.name.strip() or not self.sanitised_name():
raise ValueError(
'Input name must be non-empty and contain at least one valid'
' character (letters, numbers, dots, dashes, underscores).'
)
chain_ids = [c.id for c in self.chains]
if any(not c.id.isalpha() or c.id.islower() for c in self.chains):
raise ValueError(f'IDs must be upper case letters, got: {chain_ids}')
if len(set(chain_ids)) != len(chain_ids):
raise ValueError('Input JSON contains sequences with duplicate IDs.')
# Use hashable types for chains, rng_seeds, and bonded_atom_pairs.
object.__setattr__(self, 'chains', tuple(self.chains))
object.__setattr__(self, 'rng_seeds', tuple(self.rng_seeds))
if self.bonded_atom_pairs is not None:
object.__setattr__(
self, 'bonded_atom_pairs', tuple(self.bonded_atom_pairs)
)
if self.user_ccd is not None:
for component_name, component_cif in cif_dict.parse_multi_data_cif(
self.user_ccd
).items():
_validate_user_ccd_keys(component_cif.keys(), component_name)
@property
def protein_chains(self) -> Sequence[ProteinChain]:
return [chain for chain in self.chains if isinstance(chain, ProteinChain)]
@property
def rna_chains(self) -> Sequence[RnaChain]:
return [chain for chain in self.chains if isinstance(chain, RnaChain)]
@property
def dna_chains(self) -> Sequence[DnaChain]:
return [chain for chain in self.chains if isinstance(chain, DnaChain)]
@property
def ligands(self) -> Sequence[Ligand]:
return [chain for chain in self.chains if isinstance(chain, Ligand)]
def sanitised_name(self) -> str:
"""Returns sanitised version of the name that can be used as a filename."""
spaceless_name = self.name.replace(' ', '_')
allowed_chars = set(string.ascii_letters + string.digits + '_-.')
return ''.join(l for l in spaceless_name if l in allowed_chars)
@classmethod
def from_alphafoldserver_fold_job(cls, fold_job: Mapping[str, Any]) -> Self:
"""Constructs Input from an AlphaFoldServer fold job."""
# Validate the fold job has the correct format.
_validate_keys(
fold_job.keys(),
{'name', 'modelSeeds', 'sequences', 'dialect', 'version'},
)
if 'dialect' not in fold_job and 'version' not in fold_job:
dialect = ALPHAFOLDSERVER_JSON_DIALECT
version = ALPHAFOLDSERVER_JSON_VERSION
elif 'dialect' in fold_job and 'version' in fold_job:
dialect = fold_job['dialect']
version = fold_job['version']
else:
raise ValueError(
'AlphaFold Server input JSON must either contain both `dialect` and'
' `version` fields, or neither. If neither is specified, it is'
f' assumed that `dialect="{ALPHAFOLDSERVER_JSON_DIALECT}"` and'
f' `version="{ALPHAFOLDSERVER_JSON_VERSION}"`.'
)
if dialect != ALPHAFOLDSERVER_JSON_DIALECT:
raise ValueError(
f'AlphaFold Server input JSON has unsupported dialect: {dialect}, '
f'expected {ALPHAFOLDSERVER_JSON_DIALECT}.'
)
# For now, there is only one AlphaFold Server JSON version.
if version != ALPHAFOLDSERVER_JSON_VERSION:
raise ValueError(
f'AlphaFold Server input JSON has unsupported version: {version}, '
f'expected {ALPHAFOLDSERVER_JSON_VERSION}.'
)
# Parse the chains.
chains = []
for sequence in fold_job['sequences']:
if 'proteinChain' in sequence:
for _ in range(sequence['proteinChain'].get('count', 1)):
chains.append(
ProteinChain.from_alphafoldserver_dict(
sequence['proteinChain'],
seq_id=mmcif_lib.int_id_to_str_id(len(chains) + 1),
)
)
elif 'rnaSequence' in sequence:
for _ in range(sequence['rnaSequence'].get('count', 1)):
chains.append(
RnaChain.from_alphafoldserver_dict(
sequence['rnaSequence'],
seq_id=mmcif_lib.int_id_to_str_id(len(chains) + 1),
)
)
elif 'dnaSequence' in sequence:
for _ in range(sequence['dnaSequence'].get('count', 1)):
chains.append(
DnaChain.from_alphafoldserver_dict(
sequence['dnaSequence'],
seq_id=mmcif_lib.int_id_to_str_id(len(chains) + 1),
)
)
elif 'ion' in sequence:
for _ in range(sequence['ion'].get('count', 1)):
chains.append(
Ligand.from_alphafoldserver_dict(
sequence['ion'],
seq_id=mmcif_lib.int_id_to_str_id(len(chains) + 1),
)
)
elif 'ligand' in sequence:
for _ in range(sequence['ligand'].get('count', 1)):
chains.append(
Ligand.from_alphafoldserver_dict(
sequence['ligand'],
seq_id=mmcif_lib.int_id_to_str_id(len(chains) + 1),
)
)
else:
raise ValueError(f'Unknown sequence type: {sequence}')
if 'modelSeeds' in fold_job and fold_job['modelSeeds']:
rng_seeds = [int(seed) for seed in fold_job['modelSeeds']]
else:
rng_seeds = [_sample_rng_seed()]
return cls(name=fold_job['name'], chains=chains, rng_seeds=rng_seeds)
@classmethod
def from_json(
cls, json_str: str, json_path: pathlib.Path | None = None
) -> Self:
"""Loads the input from the AlphaFold JSON string."""
raw_json = json.loads(json_str)
_validate_keys(
raw_json.keys(),
{
'dialect',
'version',
'name',
'modelSeeds',
'sequences',
'bondedAtomPairs',
'userCCD',
'userCCDPath',
},
)
if 'dialect' not in raw_json or 'version' not in raw_json:
raise ValueError(
'AlphaFold 3 input JSON must contain `dialect` and `version` fields.'
)
if raw_json['dialect'] != JSON_DIALECT:
raise ValueError(
'AlphaFold 3 input JSON has unsupported dialect:'
f' {raw_json["dialect"]}, expected {JSON_DIALECT}.'
)
if raw_json['version'] not in JSON_VERSIONS:
raise ValueError(
'AlphaFold 3 input JSON has unsupported version:'
f' {raw_json["version"]}, expected one of {JSON_VERSIONS}.'
)
if 'sequences' not in raw_json:
raise ValueError('AlphaFold 3 input JSON does not contain any sequences.')
if 'modelSeeds' not in raw_json or not raw_json['modelSeeds']:
raise ValueError(
'AlphaFold 3 input JSON must specify at least one rng seed in'
' `modelSeeds`.'
)
sequences = raw_json['sequences']
# Make sure sequence IDs are all set.
raw_sequence_ids = [next(iter(s.values())).get('id') for s in sequences]
if all(raw_sequence_ids):
sequence_ids = []
for sequence_id in raw_sequence_ids:
if isinstance(sequence_id, list):
sequence_ids.append(sequence_id)
else:
sequence_ids.append([sequence_id])
else:
raise ValueError(
'AlphaFold 3 input JSON contains sequences with unset IDs.'
)
flat_seq_ids = []
for seq_ids in sequence_ids:
flat_seq_ids.extend(seq_ids)
chains = []
for seq_ids, sequence in zip(sequence_ids, sequences, strict=True):
if len(sequence) != 1:
raise ValueError(f'Chain {seq_ids} has more than 1 sequence.')
for seq_id in seq_ids:
if 'protein' in sequence:
chains.append(ProteinChain.from_dict(sequence, json_path, seq_id))
elif 'rna' in sequence:
chains.append(RnaChain.from_dict(sequence, json_path, seq_id))
elif 'dna' in sequence:
chains.append(DnaChain.from_dict(sequence, seq_id=seq_id))
elif 'ligand' in sequence:
chains.append(Ligand.from_dict(sequence, seq_id=seq_id))
else:
raise ValueError(f'Unknown sequence type: {sequence}')
smiles_ligand_ids = set(
c.id for c in chains if isinstance(c, Ligand) and c.smiles is not None
)
chain_lengths = {chain.id: len(chain) for chain in chains}
bonded_atom_pairs = None
if bonds := raw_json.get('bondedAtomPairs'):
bonded_atom_pairs = []
for bond in bonds:
if len(bond) != 2:
raise ValueError(f'Bond {bond} must have 2 atoms, got {len(bond)}.')
bond_beg, bond_end = bond
if (
len(bond_beg) != 3
or not isinstance(bond_beg[0], str)
or not isinstance(bond_beg[1], int)
or not isinstance(bond_beg[2], str)
):
raise ValueError(
f'Atom {bond_beg} in bond {bond} must have 3 components: '
'(chain_id: str, res_id: int, atom_name: str).'
)
if (
len(bond_end) != 3
or not isinstance(bond_end[0], str)
or not isinstance(bond_end[1], int)
or not isinstance(bond_end[2], str)
):
raise ValueError(
f'Atom {bond_end} in bond {bond} must have 3 components: '
'(chain_id: str, res_id: int, atom_name: str).'
)
if bond_beg[0] not in flat_seq_ids or bond_end[0] not in flat_seq_ids:
raise ValueError(f'Invalid chain ID(s) in bond {bond}')
if (
not 0 < bond_beg[1] <= chain_lengths[bond_beg[0]]
or not 0 < bond_end[1] <= chain_lengths[bond_end[0]]
):
raise ValueError(f'Invalid residue ID(s) in bond {bond}')
if bond_beg[0] in smiles_ligand_ids:
raise ValueError(
f'Bond {bond} involves an unsupported SMILES ligand {bond_beg[0]}'
)
if bond_end[0] in smiles_ligand_ids:
raise ValueError(
f'Bond {bond} involves an unsupported SMILES ligand {bond_end[0]}'
)
bonded_atom_pairs.append((tuple(bond_beg), tuple(bond_end)))
if len(bonded_atom_pairs) != len(set(bonded_atom_pairs)):
raise ValueError(f'Bonds are not unique: {bonded_atom_pairs}')
user_ccd = raw_json.get('userCCD')
user_ccd_path = raw_json.get('userCCDPath')
if user_ccd and user_ccd_path:
raise ValueError('Only one of userCCD/userCCDPath can be set.')
if user_ccd and len(user_ccd) < 256 and os.path.exists(user_ccd):
raise ValueError('Set the user CCD path using the "userCCDPath" field.')
elif user_ccd_path:
user_ccd = _read_file(pathlib.Path(user_ccd_path), json_path)
return cls(
name=raw_json['name'],
chains=chains,
rng_seeds=[int(seed) for seed in raw_json['modelSeeds']],
bonded_atom_pairs=bonded_atom_pairs,
user_ccd=user_ccd,
)
@classmethod
def from_mmcif(cls, mmcif_str: str, ccd: chemical_components.Ccd) -> Self:
"""Loads the input from an mmCIF string.
WARNING: Since rng seeds are not stored in mmCIFs, an rng seed is sampled
in the returned `Input`.
Args:
mmcif_str: The mmCIF string.
ccd: The chemical components dictionary.
Returns:
The input in an Input format.
"""
struc = structure.from_mmcif(
mmcif_str,
# Change MSE residues to MET residues.
fix_mse_residues=True,
# Fix arginine atom names. This is not needed since the input discards
# any atom-level data, but kept for consistency with the paper.
fix_arginines=True,
# Fix unknown DNA residues to the correct unknown DNA residue type.
fix_unknown_dna=True,
# Do not include water molecules.
include_water=False,
# Do not include things like DNA/RNA hybrids. This will be changed once
# we have a way of handling these in the AlphaFold 3 input format.
include_other=False,
# Include the specific bonds defined in the mmCIF bond table, e.g.
# covalent bonds for PTMs.
include_bonds=True,
)
# Create default bioassembly, expanding structures implied by stoichiometry.
struc = struc.generate_bioassembly(None)
sequences = struc.chain_single_letter_sequence(
include_missing_residues=True
)
chains = []
for chain_id, chain_type in zip(
struc.group_by_chain.chain_id, struc.group_by_chain.chain_type
):
sequence = sequences[chain_id]
if chain_type in mmcif_names.NON_POLYMER_CHAIN_TYPES:
residues = list(struc.chain_res_name_sequence()[chain_id])
if all(ccd.get(res) is not None for res in residues):
chains.append(Ligand(id=chain_id, ccd_ids=residues))
elif len(residues) == 1:
comp_name = residues[0]
comps = struc.chemical_components_data
if comps is None:
raise ValueError(
'Missing mmCIF chemical components data - this is required for '
f'a non-CCD ligand {comp_name} defined using SMILES string.'
)
chains.append(
Ligand(id=chain_id, smiles=comps.chem_comp[comp_name].pdbx_smiles)
)
else:
raise ValueError(
'Multi-component ligand must be defined using CCD IDs, defining'
' using SMILES is supported only for single-component ligands. '
f'Got {residues}'
)
else:
residues = struc.chain_res_name_sequence()[chain_id]
fixed = struc.chain_res_name_sequence(
fix_non_standard_polymer_res=True
)[chain_id]
modifications = [
(orig, i + 1)
for i, (orig, fixed) in enumerate(zip(residues, fixed, strict=True))
if orig != fixed
]
if chain_type == mmcif_names.PROTEIN_CHAIN:
chains.append(
ProteinChain(id=chain_id, sequence=sequence, ptms=modifications)
)
elif chain_type == mmcif_names.RNA_CHAIN:
chains.append(
RnaChain(
id=chain_id, sequence=sequence, modifications=modifications
)
)
elif chain_type == mmcif_names.DNA_CHAIN:
chains.append(
DnaChain(
id=chain_id, sequence=sequence, modifications=modifications
)
)
bonded_atom_pairs = []
chain_ids = set(c.id for c in chains)
for atom_a, atom_b, _ in struc.iter_bonds():
if atom_a['chain_id'] in chain_ids and atom_b['chain_id'] in chain_ids:
beg = (atom_a['chain_id'], int(atom_a['res_id']), atom_a['atom_name'])
end = (atom_b['chain_id'], int(atom_b['res_id']), atom_b['atom_name'])
bonded_atom_pairs.append((beg, end))
return cls(
name=struc.name,
chains=chains,
# mmCIFs don't store rng seeds, so we need to sample one here.
rng_seeds=[_sample_rng_seed()],
bonded_atom_pairs=bonded_atom_pairs or None,
)
def to_structure(self, ccd: chemical_components.Ccd) -> structure.Structure:
"""Converts Input to a Structure.
WARNING: This method does not preserve the rng seeds.
Args:
ccd: The chemical components dictionary.
Returns:
The input in a structure.Structure format.
"""
ids: list[str] = []
sequences: list[str] = []
poly_types: list[str] = []
formats: list[structure.SequenceFormat] = []
for chain in self.chains:
ids.append(chain.id)
match chain:
case ProteinChain():
sequences.append('(' + ')('.join(chain.to_ccd_sequence()) + ')')
poly_types.append(mmcif_names.PROTEIN_CHAIN)
formats.append(structure.SequenceFormat.CCD_CODES)
case RnaChain():
sequences.append('(' + ')('.join(chain.to_ccd_sequence()) + ')')
poly_types.append(mmcif_names.RNA_CHAIN)
formats.append(structure.SequenceFormat.CCD_CODES)
case DnaChain():
sequences.append('(' + ')('.join(chain.to_ccd_sequence()) + ')')
poly_types.append(mmcif_names.DNA_CHAIN)
formats.append(structure.SequenceFormat.CCD_CODES)
case Ligand():
if chain.ccd_ids is not None:
sequences.append('(' + ')('.join(chain.ccd_ids) + ')')
if len(chain.ccd_ids) == 1:
poly_types.append(mmcif_names.NON_POLYMER_CHAIN)
else:
poly_types.append(mmcif_names.BRANCHED_CHAIN)
formats.append(structure.SequenceFormat.CCD_CODES)
elif chain.smiles is not None:
# Convert to `<unique ligand ID>:<smiles>` format that is expected
# by structure.from_sequences_and_bonds.
sequences.append(f'LIG_{chain.id}:{chain.smiles}')
poly_types.append(mmcif_names.NON_POLYMER_CHAIN)
formats.append(structure.SequenceFormat.LIGAND_SMILES)
else:
raise ValueError('Ligand must have one of CCD ID or SMILES set.')
# Remap bond chain IDs from chain IDs to chain indices and convert to
# 0-based residue indexing.
bonded_atom_pairs = []
chain_indices = {cid: i for i, cid in enumerate(ids)}
if self.bonded_atom_pairs is not None:
for bond_beg, bond_end in self.bonded_atom_pairs:
bonded_atom_pairs.append((
(chain_indices[bond_beg[0]], bond_beg[1] - 1, bond_beg[2]),
(chain_indices[bond_end[0]], bond_end[1] - 1, bond_end[2]),
))
return structure.from_sequences_and_bonds(
sequences=sequences,
chain_types=poly_types,
sequence_formats=formats,
chain_ids=ids,
bonded_atom_pairs=bonded_atom_pairs,
ccd=ccd,
name=self.sanitised_name(),
bond_type=mmcif_names.COVALENT_BOND,
release_date=None,
)
def to_json(self) -> str:
"""Converts Input to an AlphaFold JSON."""
deduped_chains = {}
deduped_chain_ids = {}
for chain in self.chains:
deduped_chains[chain.hash_without_id()] = chain
deduped_chain_ids.setdefault(chain.hash_without_id(), []).append(chain.id)
sequences = []
for chain_content_hash, ids in deduped_chain_ids.items():
chain = deduped_chains[chain_content_hash]
sequences.append(chain.to_dict(seq_id=ids if len(ids) > 1 else ids[0]))
alphafold_json = json.dumps(
{
'dialect': JSON_DIALECT,
'version': JSON_VERSION,
'name': self.name,
'sequences': sequences,
'modelSeeds': self.rng_seeds,
'bondedAtomPairs': self.bonded_atom_pairs,
'userCCD': self.user_ccd,
},
indent=2,
)
# Remove newlines from the query/template indices arrays. We match the
# queryIndices/templatesIndices with a non-capturing group. We then match
# the entire region between the square brackets by looking for lines
# containing only whitespace, number, or a comma.
return re.sub(
r'("(?:queryIndices|templateIndices)": \[)([\s\n\d,]+)(\],?)',
lambda mtch: mtch[1] + re.sub(r'\n\s+', ' ', mtch[2].strip()) + mtch[3],
alphafold_json,
)
def fill_missing_fields(self) -> Self:
"""Fill missing MSA and template fields with default values."""
with_missing_fields = [
c.fill_missing_fields()
if isinstance(c, (ProteinChain, RnaChain))
else c
for c in self.chains
]
return dataclasses.replace(self, chains=with_missing_fields)
def with_multiple_seeds(self, num_seeds: int) -> Self:
"""Returns a copy of the input with num_seeds rng seeds."""
if num_seeds <= 1:
raise ValueError('Number of seeds must be greater than 1.')
if len(self.rng_seeds) != 1:
raise ValueError('Input must have one rng seed to set multiple seeds.')
return dataclasses.replace(
self,
rng_seeds=list(range(self.rng_seeds[0], self.rng_seeds[0] + num_seeds)),
)
def load_fold_inputs_from_path(json_path: pathlib.Path) -> Iterator[Input]:
"""Loads multiple fold inputs from a JSON string."""
with open(json_path, 'r') as f:
json_str = f.read()
# Parse the JSON string, so we can detect its format.
raw_json = json.loads(json_str)
if isinstance(raw_json, list):
# AlphaFold Server JSON.
logging.info('Loading %d fold jobs from %s', len(raw_json), json_path)
for fold_job_idx, fold_job in enumerate(raw_json):
try:
yield Input.from_alphafoldserver_fold_job(fold_job)
except ValueError as e:
raise ValueError(
f'Failed to load fold job {fold_job_idx} from {json_path}'
f' (AlphaFold Server dialect): {e}'
) from e
else:
# AlphaFold 3 JSON.
try:
yield Input.from_json(json_str, json_path)
except ValueError as e:
raise ValueError(
f'Failed to load input from {json_path} (AlphaFold 3 dialect): {e}'
) from e
def load_fold_inputs_from_dir(input_dir: pathlib.Path) -> Iterator[Input]:
"""Loads multiple fold inputs from all JSON files in a given input_dir.
Args:
input_dir: The directory containing the JSON files.
Yields:
The fold inputs from all JSON files in the input directory.
"""
for file_path in sorted(input_dir.glob('*.json')):
if not file_path.is_file():
continue
yield from load_fold_inputs_from_path(file_path)
|