Parser
detect_one_letter_name(atoms)
Guess a nucleotide one-letter code based on expected base atoms.
A simple scoring scheme compares the observed atom names with expected
base-atom sets in BASE_ATOMS for A, C, G, U, T.
Parameters:
| Name | Type | Description | Default |
|---|---|---|---|
atoms
|
List[Atom]
|
Atoms belonging to a single residue. |
required |
Returns:
| Name | Type | Description |
|---|---|---|
str |
str
|
Best-scoring nucleotide (A/C/G/U/T) or '?' if no match is found. |
Source code in src/rnapolis/parser.py
540 541 542 543 544 545 546 547 548 549 550 551 552 553 554 555 556 557 558 559 560 561 562 563 | |
filter_clashing_atoms(atoms, clash_distance=0.5)
Remove duplicate and clashing atoms, keeping the higher-occupancy ones.
The function first deduplicates atoms by (label, auth, atom name) using occupancy, and then uses a KDTree to detect close contacts below the given distance and resolves them according to occupancy.
Parameters:
| Name | Type | Description | Default |
|---|---|---|---|
atoms
|
List[Atom]
|
Input list of atoms. |
required |
clash_distance
|
float
|
Distance threshold (in Å) for detecting clashes. |
0.5
|
Returns:
| Type | Description |
|---|---|
List[Atom]
|
Filtered list of atoms. |
Source code in src/rnapolis/parser.py
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 | |
get_one_letter_name(entity_id, label, sequence_by_entity, name)
Infer a one-letter residue code from entity sequence and residue name.
The function first tries to read from the entity-level sequence, then falls back to simple heuristics based on residue name (RNA, DNA, last letter).
Parameters:
| Name | Type | Description | Default |
|---|---|---|---|
entity_id
|
Optional[str]
|
Entity ID for this residue. |
required |
label
|
Optional[ResidueLabel]
|
Label-style residue identifier. |
required |
sequence_by_entity
|
Dict[str, str]
|
Mapping from entity ID to sequence. |
required |
name
|
str
|
Residue name candidate. |
required |
Returns:
| Name | Type | Description |
|---|---|---|
str |
str
|
One-letter residue code or a generic placeholder. |
Source code in src/rnapolis/parser.py
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 | |
get_residue_name(auth, label, modified)
Resolve residue name based on modification annotations and auth/label data.
Parameters:
| Name | Type | Description | Default |
|---|---|---|---|
auth
|
Optional[ResidueAuth]
|
Author-style residue identifier. |
required |
label
|
Optional[ResidueLabel]
|
Label-style residue identifier. |
required |
modified
|
Dict[Union[ResidueAuth, ResidueLabel], str]
|
Mapping of modified residues to standard names. |
required |
Returns:
| Name | Type | Description |
|---|---|---|
str |
str
|
Residue name (possibly standardised) or a generic placeholder. |
Source code in src/rnapolis/parser.py
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 | |
group_atoms(atoms, modified, sequence_by_entity, is_nucleic_acid_by_entity, nucleic_acid_only)
Group atoms into residues and build a Structure3D.
This function merges atoms with the same residue identifiers, infers one-letter residue codes (using entity sequences and heuristics for nucleotides) and optionally filters to nucleic-acid residues only.
Parameters:
| Name | Type | Description | Default |
|---|---|---|---|
atoms
|
List[Atom]
|
Atoms to group. |
required |
modified
|
Dict[Union[ResidueLabel, ResidueAuth], str]
|
Mapping for modified residues to their standard names. |
required |
sequence_by_entity
|
Dict[str, str]
|
Mapping from entity ID to sequence. |
required |
is_nucleic_acid_by_entity
|
Dict[str, bool]
|
Mapping from entity ID to nucleic-acid flag. |
required |
nucleic_acid_only
|
bool
|
If True, keep only nucleic-acid residues. |
required |
Returns:
| Name | Type | Description |
|---|---|---|
Structure3D |
Structure3D
|
Assembled structure. |
Source code in src/rnapolis/parser.py
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 | |
is_cif(cif_or_pdb)
Heuristically check if a file-like object contains mmCIF data.
The function rewinds the stream and looks for _atom_site records.
Parameters:
| Name | Type | Description | Default |
|---|---|---|---|
cif_or_pdb
|
IO[str]
|
Open file-like object with structural data. |
required |
Returns:
| Name | Type | Description |
|---|---|---|
bool |
bool
|
True if the content looks like mmCIF, False if it is assumed to be PDB. |
Source code in src/rnapolis/parser.py
60 61 62 63 64 65 66 67 68 69 70 71 72 73 74 75 | |
parse_cif(cif)
Parse a mmCIF file into atoms and entity-level metadata.
Parameters:
| Name | Type | Description | Default |
|---|---|---|---|
cif
|
IO[str]
|
Open file-like object with mmCIF content. |
required |
Returns:
| Name | Type | Description |
|---|---|---|
tuple |
Tuple[List[Atom], Dict[Union[ResidueLabel, ResidueAuth], str], Dict[str, str], Dict[str, bool]]
|
A tuple containing:
|
Source code in src/rnapolis/parser.py
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 | |
parse_pdb(pdb)
Parse a PDB file into atoms and modification information.
Parameters:
| Name | Type | Description | Default |
|---|---|---|---|
pdb
|
IO[str]
|
Open file-like object with PDB content. |
required |
Returns:
| Name | Type | Description |
|---|---|---|
tuple |
Tuple[List[Atom], Dict[Union[ResidueLabel, ResidueAuth], str], Dict[str, str], Dict[str, bool]]
|
A tuple containing:
|
Source code in src/rnapolis/parser.py
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 | |
read_3d_structure(cif_or_pdb, model=None, nucleic_acid_only=False)
Read a PDB or mmCIF structure into a Structure3D object.
The function auto-detects whether the input is mmCIF or PDB, parses atoms, groups them into residues and optionally filters to nucleic-acid residues only.
Parameters:
| Name | Type | Description | Default |
|---|---|---|---|
cif_or_pdb
|
IO[str]
|
Open file-like object with PDB or mmCIF content. |
required |
model
|
Optional[int]
|
Model number to extract (1-based). If None, the first model encountered is used. |
None
|
nucleic_acid_only
|
bool
|
If True, keep only nucleic-acid residues. |
False
|
Returns:
| Name | Type | Description |
|---|---|---|
Structure3D |
Structure3D
|
Parsed 3D structure. |
Source code in src/rnapolis/parser.py
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 | |
try_parse_int(s)
Try to convert a string to int, returning None on failure.
Parameters:
| Name | Type | Description | Default |
|---|---|---|---|
s
|
str
|
String to parse. |
required |
Returns:
| Type | Description |
|---|---|
Optional[int]
|
Parsed integer, or None if conversion fails. |
Source code in src/rnapolis/parser.py
577 578 579 580 581 582 583 584 585 586 587 588 589 590 591 | |