File: test_grounding.py

package info (click to toggle)
pybel 0.15.5-4
  • links: PTS, VCS
  • area: main
  • in suites: sid
  • size: 16,504 kB
  • sloc: python: 29,392; javascript: 246; makefile: 226; sh: 20
file content (585 lines) | stat: -rw-r--r-- 20,364 bytes parent folder | download | duplicates (3)
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
# -*- coding: utf-8 -*-

"""Test grounding."""

import unittest
from unittest import mock

import bioregistry
import pyobo
from pyobo.mocks import get_mock_id_name_mapping

from pybel.constants import (
    ANNOTATIONS,
    CONCEPT,
    GMOD,
    IDENTIFIER,
    KIND,
    MEMBERS,
    NAME,
    NAMESPACE,
    PMOD,
    VARIANTS,
)
from pybel.grounding import (
    _NAME_REMAPPING,
    _process_annotations,
    _process_concept,
    _process_node,
)
from pybel.language import Entity


def _failer(*_, **__):
    """Fail for all calls to this function."""
    raise ValueError("Called a PyOBO function that should be mocked")


pyobo.getters.get = _failer
pyobo.api.names.cached_mapping = _failer
pyobo.api.names.cached_multidict = _failer

mock_id_name_data = {
    "mesh": {
        "D009474": "Neurons",
        "D010300": "Parkinson Disease",
        "D013378": "Substantia Nigra",
    },
    "doid": {
        "14330": "Parkinson's disease",
    },
    "go": {
        "0006468": "protein phosphorylation",
    },
    "complexportal": {
        "CPX-1829": "Checkpoint clamp complex",
    },
    "ncbitaxon": {
        "9606": "Homo sapiens",
    },
    "cl": {
        "0000030": "glioblast",
    },
    "fplx": {
        "TAP": "TAP",
        "Gamma_secretase": "Gamma_secretase",
    },
}

mock_id_name_mapping = get_mock_id_name_mapping(mock_id_name_data)

_mock_mnemonic_data = {
    "O60921": "HUS1_HUMAN",
    "Q99638": "RAD9A_HUMAN",
    "O60671": "RAD1_HUMAN",
}
_mock_reverse_mnemonic_data = {v: k for k, v in _mock_mnemonic_data.items()}


def _mock_get_mnemonic(identifier, *_, **__):
    return _mock_mnemonic_data[identifier]


mock_get_mnemonic = mock.patch("pybel.grounding.get_mnemonic", side_effect=_mock_get_mnemonic)
mock_get_id_from_mnemonic = mock.patch(
    "pybel.grounding.get_id_from_mnemonic",
    side_effect=_mock_reverse_mnemonic_data.get,
)


@mock_id_name_mapping
@mock_get_mnemonic
@mock_get_id_from_mnemonic
class TestProcessConcept(unittest.TestCase):
    """Test the :func:`_process_concept` function."""

    def _help(self, expected, original, msg=None):
        expected = {CONCEPT: expected}
        d = {CONCEPT: original}
        self.assertIsNotNone(
            bioregistry.normalize_prefix(expected[CONCEPT][NAMESPACE]),
            msg="Unrecognized namespace",
        )
        _process_concept(concept=d[CONCEPT], node=d)
        self.assertEqual(expected[CONCEPT], d[CONCEPT], msg=msg)

    def test_normalize_prefix_case(self, *_):
        """Test normalizing the prefix to the correct case."""
        self._help(
            {NAMESPACE: "mesh", NAME: "Neurons", IDENTIFIER: "D009474"},
            {NAMESPACE: "MESH", NAME: "Neurons", IDENTIFIER: "D009474"},
        )

    def test_normalize_prefix_synonym(self, *_):
        """Test normalizing the prefix based on the synonym dictionary."""
        self._help(
            {NAMESPACE: "mesh", NAME: "Neurons", IDENTIFIER: "D009474"},
            {NAMESPACE: "MESHA", NAME: "Neurons", IDENTIFIER: "D009474"},
        )

    def test_lookup_identifier(self, *_):
        """Test look up of the identifier when given the name."""
        self._help(
            {NAMESPACE: "mesh", NAME: "Neurons", IDENTIFIER: "D009474"},
            {NAMESPACE: "MESH", NAME: "Neurons"},
        )

    def test_lookup_name_as_identifier(self, *_):
        """Test look up of the name when given as the identifier."""
        self._help(
            {NAMESPACE: "mesh", NAME: "Neurons", IDENTIFIER: "D009474"},
            {NAMESPACE: "MESH", IDENTIFIER: "Neurons"},
        )

    def test_lookup_uniprot_identifier(self, *_):
        """Test looking up a uniprot identifier."""
        self._help(
            {NAMESPACE: "uniprot", NAME: "HUS1_HUMAN", IDENTIFIER: "O60921"},
            {NAMESPACE: "UniProt", NAME: "HUS1_HUMAN"},
        )

    def test_fix_uniprot_identifier_as_name(self, *_):
        """Test lookup of the UniProt identifier when given a UniProt identifier as the name."""
        self._help(
            {NAMESPACE: "uniprot", NAME: "HUS1_HUMAN", IDENTIFIER: "O60921"},
            {NAMESPACE: "UniProt", NAME: "O60921"},
        )

    def test_fix_wrong_name(self, *_):
        """Test overwriting a wrong name (not UniProt)."""
        self._help(
            {NAMESPACE: "mesh", NAME: "Neurons", IDENTIFIER: "D009474"},
            {NAMESPACE: "MESH", NAME: "Nonsense name!", IDENTIFIER: "D009474"},
        )

    def test_fix_wrong_uniprot_name(self, *_):
        """Test overwriting a wrong name (UniProt)."""
        self._help(
            {NAMESPACE: "uniprot", NAME: "HUS1_HUMAN", IDENTIFIER: "O60921"},
            {NAMESPACE: "UniProt", NAME: "WRONG!!!!", IDENTIFIER: "O60921"},
        )

    def test_remap_sfam(self, *_):
        """Test remapping SFAM to FPLX."""
        self.assertIn(("bel", "TAP Family"), _NAME_REMAPPING)
        self._help(
            {NAMESPACE: "fplx", NAME: "TAP", IDENTIFIER: "TAP"},
            {NAMESPACE: "SFAM", NAME: "TAP Family"},
        )

    def test_remap_scomp(self, *_):
        """Test remapping SFAM to FPLX."""
        self.assertIsNotNone(bioregistry.normalize_prefix("BEL"))
        self.assertIn(
            ("bel", "gamma Secretase Complex"),
            _NAME_REMAPPING,
            msg="name remapping is not populated properly",
        )
        self._help(
            {NAMESPACE: "fplx", NAME: "Gamma_secretase", IDENTIFIER: "Gamma_secretase"},
            {NAMESPACE: "SCOMP", NAME: "gamma Secretase Complex"},
        )


@mock_id_name_mapping
@mock_get_mnemonic
@mock_get_id_from_mnemonic
class TestGround(unittest.TestCase):
    """Test grounding."""

    def _help(self, expected, result):
        _process_node(result)
        self.assertEqual(expected, result)

    def test_lookup_identifier_member(self, *_):
        """Test looking up the identifier of a member by name."""
        self._help(
            {
                MEMBERS: [
                    {
                        CONCEPT: {
                            NAMESPACE: "mesh",
                            NAME: "Neurons",
                            IDENTIFIER: "D009474",
                        }
                    }
                ]
            },
            {MEMBERS: [{CONCEPT: {NAMESPACE: "MESH", NAME: "Neurons"}}]},
        )

    def test_lookup_identifier_complex(self, *_):
        """Test looking up the identifier of a named complex and its members at the same time."""
        self._help(
            {
                CONCEPT: {
                    NAMESPACE: "complexportal",
                    NAME: "Checkpoint clamp complex",
                    IDENTIFIER: "CPX-1829",
                },
                MEMBERS: [
                    {
                        CONCEPT: {
                            NAMESPACE: "uniprot",
                            NAME: "HUS1_HUMAN",
                            IDENTIFIER: "O60921",
                        }
                    },
                    {
                        CONCEPT: {
                            NAMESPACE: "uniprot",
                            NAME: "RAD9A_HUMAN",
                            IDENTIFIER: "Q99638",
                        }
                    },
                    {
                        CONCEPT: {
                            NAMESPACE: "uniprot",
                            NAME: "RAD1_HUMAN",
                            IDENTIFIER: "O60671",
                        }
                    },
                ],
            },
            {
                CONCEPT: {NAMESPACE: "complexportal", NAME: "Checkpoint clamp complex"},
                MEMBERS: [
                    {CONCEPT: {NAMESPACE: "uniprot", NAME: "HUS1_HUMAN"}},
                    {CONCEPT: {NAMESPACE: "uniprot", NAME: "RAD9A_HUMAN"}},
                    {CONCEPT: {NAMESPACE: "uniprot", NAME: "RAD1_HUMAN"}},
                ],
            },
        )

    def test_lookup_identifier_protein(self, *_):
        """Test looking up the identifier based on a protein's name."""
        self._help(
            {CONCEPT: {NAMESPACE: "uniprot", NAME: "HUS1_HUMAN", IDENTIFIER: "O60921"}},
            {CONCEPT: {NAMESPACE: "uniprot", NAME: "HUS1_HUMAN"}},
        )

    def test_lookup_name_protein(self, *_):
        """Test looking up the name based on a protein's identifier."""
        self._help(
            {CONCEPT: {NAMESPACE: "uniprot", NAME: "HUS1_HUMAN", IDENTIFIER: "O60921"}},
            {CONCEPT: {NAMESPACE: "uniprot", IDENTIFIER: "O60921"}},
        )

    def test_fix_name_protein(self, *_):
        """Test fixing a wrong name by overwriting by identifier-based lookup."""
        self._help(
            {CONCEPT: {NAMESPACE: "uniprot", NAME: "HUS1_HUMAN", IDENTIFIER: "O60921"}},
            {CONCEPT: {NAMESPACE: "uniprot", IDENTIFIER: "O60921", NAME: "wrong!!!"}},
        )

    def test_lookup_identifier_pmod(self, *_):
        """Test looking up a protein modification's identifier by name."""
        self._help(
            {
                CONCEPT: {
                    NAMESPACE: "uniprot",
                    NAME: "HUS1_HUMAN",
                    IDENTIFIER: "O60921",
                },
                VARIANTS: [
                    {
                        KIND: PMOD,
                        CONCEPT: {
                            NAMESPACE: "go",
                            IDENTIFIER: "0006468",
                            NAME: "protein phosphorylation",
                        },
                    },
                ],
            },
            {
                CONCEPT: {NAMESPACE: "uniprot", NAME: "HUS1_HUMAN"},
                VARIANTS: [
                    {
                        KIND: PMOD,
                        CONCEPT: {NAMESPACE: "GO", NAME: "protein phosphorylation"},
                    },
                ],
            },
        )

    def test_lookup_name_pmod(self, *_):
        """Test looking up a protein modification's name by identifier."""
        self._help(
            {
                CONCEPT: {
                    NAMESPACE: "uniprot",
                    NAME: "HUS1_HUMAN",
                    IDENTIFIER: "O60921",
                },
                VARIANTS: [
                    {
                        KIND: PMOD,
                        CONCEPT: {
                            NAMESPACE: "go",
                            IDENTIFIER: "0006468",
                            NAME: "protein phosphorylation",
                        },
                    },
                ],
            },
            {
                CONCEPT: {NAMESPACE: "uniprot", IDENTIFIER: "O60921"},
                VARIANTS: [
                    {
                        KIND: PMOD,
                        CONCEPT: {NAMESPACE: "GO", IDENTIFIER: "0006468"},
                    },
                ],
            },
        )

    def test_fix_pmod_name(self, *_):
        """Test fixing a wrong name in a pmod."""
        self._help(
            {
                CONCEPT: {
                    NAMESPACE: "uniprot",
                    NAME: "HUS1_HUMAN",
                    IDENTIFIER: "O60921",
                },
                VARIANTS: [
                    {
                        KIND: PMOD,
                        CONCEPT: {
                            NAMESPACE: "go",
                            IDENTIFIER: "0006468",
                            NAME: "protein phosphorylation",
                        },
                    },
                ],
            },
            {
                CONCEPT: {NAMESPACE: "uniprot", NAME: "HUS1_HUMAN"},
                VARIANTS: [
                    {
                        KIND: PMOD,
                        CONCEPT: {
                            NAMESPACE: "GO",
                            IDENTIFIER: "0006468",
                            NAME: "WRONG!",
                        },
                    },
                ],
            },
        )

    def test_normalize_pmod_default(self, *_):
        """Test normalizing a pmod using the default bel namespace."""
        self._help(
            {
                CONCEPT: {
                    NAMESPACE: "uniprot",
                    NAME: "HUS1_HUMAN",
                    IDENTIFIER: "O60921",
                },
                VARIANTS: [
                    {
                        KIND: PMOD,
                        CONCEPT: {
                            NAMESPACE: "go",
                            IDENTIFIER: "0006468",
                            NAME: "protein phosphorylation",
                        },
                    },
                ],
            },
            {
                CONCEPT: {NAMESPACE: "uniprot", NAME: "HUS1_HUMAN"},
                VARIANTS: [
                    {
                        KIND: PMOD,
                        CONCEPT: {NAMESPACE: "bel", NAME: "Ph"},
                    },
                ],
            },
        )

    def test_normalize_pmod_default_methylation(self, *_):
        """Test normalizing the default namespace's Me entry because of conflict with gmods."""
        self._help(
            {
                CONCEPT: {
                    NAMESPACE: "uniprot",
                    NAME: "HUS1_HUMAN",
                    IDENTIFIER: "O60921",
                },
                VARIANTS: [
                    {
                        KIND: PMOD,
                        CONCEPT: {
                            NAMESPACE: "go",
                            IDENTIFIER: "0006479",
                            NAME: "protein methylation",
                        },
                    },
                ],
            },
            {
                CONCEPT: {NAMESPACE: "uniprot", NAME: "HUS1_HUMAN"},
                VARIANTS: [
                    {KIND: PMOD, CONCEPT: {NAMESPACE: "bel", NAME: "Me"}},
                ],
            },
        )

    def normalize_gmod_default_methylation(self, *_):
        """Test normalizing the default namespace's Me entry because of conflict with pmods."""
        self._help(
            {
                CONCEPT: {NAMESPACE: "hgnc", NAME: "MAPT", IDENTIFIER: "6893"},
                VARIANTS: [
                    {
                        CONCEPT: {
                            NAMESPACE: "go",
                            IDENTIFIER: "0006306",
                            NAME: "DNA methylation",
                        },
                        KIND: GMOD,
                    },
                ],
            },
            {
                CONCEPT: {NAMESPACE: "HGNC", NAME: "MAPT"},
                VARIANTS: [
                    {CONCEPT: {NAMESPACE: "bel", NAME: "Me"}, KIND: GMOD},
                ],
            },
        )


@mock_id_name_mapping
class TestAnnotations(unittest.TestCase):
    """Test processing annotations."""

    def _help(self, expected_data, data):
        expected_data = {ANNOTATIONS: expected_data}
        data = {ANNOTATIONS: data}
        _process_annotations(data)
        self.assertEqual(expected_data, data)

    def test_lookup_by_identifier(self, *_):
        """Test lookup by identifier."""
        self._help(
            {"Disease": [Entity(namespace="mesh", identifier="D010300", name="Parkinson Disease")]},
            {"Disease": [Entity(namespace="mesh", identifier="D010300")]},
        )

    def test_lookup_by_name(self, *_):
        """Test lookup by name."""
        self._help(
            {"Disease": [Entity(namespace="mesh", identifier="D010300", name="Parkinson Disease")]},
            {"Disease": [Entity(namespace="mesh", name="Parkinson Disease")]},
        )

    def test_lookup_by_name_as_identifier(self, *_):
        """Test lookup by name if it's accidentally in the identifier slot."""
        self._help(
            {"Disease": [Entity(namespace="mesh", identifier="D010300", name="Parkinson Disease")]},
            {"Disease": [Entity(namespace="mesh", identifier="Parkinson Disease")]},
        )

    def test_upgrade_category(self, *_):
        """Test upgrading the category."""
        self._help(
            {"Disease": [Entity(namespace="mesh", identifier="D010300", name="Parkinson Disease")]},
            {"MeSHDisease": [Entity(namespace="mesh", identifier="D010300", name="Parkinson Disease")]},
        )

    def test_upgrade_category_and_namespace(self, *_):
        """Test upgrading the category and the namespace simultaneously."""
        self._help(
            {"Disease": [Entity(namespace="mesh", identifier="D010300", name="Parkinson Disease")]},
            {
                "MeSHDisease": [
                    Entity(
                        namespace="MeSHDisease",
                        identifier="D010300",
                        name="Parkinson Disease",
                    )
                ]
            },
        )

    def test_upgrade_with_name_as_identifier(self, *_):
        """Test upgrading MeSH disease, MeSH anatomy, and Species tags and lookup by name, in the identifiers space."""
        self._help(
            {  # Expected
                "Disease": [Entity(namespace="mesh", identifier="D010300", name="Parkinson Disease")],
                "Anatomy": [Entity(namespace="mesh", identifier="D013378", name="Substantia Nigra")],
                "Species": [Entity(namespace="ncbitaxon", identifier="9606", name="Homo sapiens")],
            },
            {  # Original
                "MeSHDisease": [Entity(namespace="MeSHDisease", identifier="Parkinson Disease")],
                "MeSHAnatomy": [Entity(namespace="MeSHAnatomy", identifier="Substantia Nigra")],
                "Species": [Entity(namespace="Species", identifier="Homo sapiens")],
            },
        )

    def test_upgrade_by_identifier(self, *_):
        """Test upgrading and lookup by identifier."""
        self._help(
            {  # Expected
                "Disease": [Entity(namespace="mesh", identifier="D010300", name="Parkinson Disease")],
                "Anatomy": [Entity(namespace="mesh", identifier="D013378", name="Substantia Nigra")],
                "Species": [Entity(namespace="ncbitaxon", identifier="9606", name="Homo sapiens")],
            },
            {  # Original
                "MeSHDisease": [Entity(namespace="MeSHDisease", identifier="D010300")],
                "MeSHAnatomy": [Entity(namespace="MeSHAnatomy", identifier="D013378")],
                "Species": [Entity(namespace="Species", identifier="9606")],
            },
        )

    def test_upgrade_by_name(self, *_):
        """Test upgrading and lookup by name."""
        self._help(
            {  # Expected
                "Disease": [Entity(namespace="mesh", identifier="D010300", name="Parkinson Disease")],
                "Anatomy": [Entity(namespace="mesh", identifier="D013378", name="Substantia Nigra")],
                "Species": [Entity(namespace="ncbitaxon", identifier="9606", name="Homo sapiens")],
            },
            {  # Original
                "MeSHDisease": [Entity(namespace="MeSHDisease", name="Parkinson Disease")],
                "MeSHAnatomy": [Entity(namespace="MeSHAnatomy", name="Substantia Nigra")],
                "Species": [Entity(namespace="Species", name="Homo sapiens")],
            },
        )

    def test_unmappable_category(self, *_):
        """Test when the category can't be mapped."""
        self._help(
            {  # Expected
                "Custom Annotation": [Entity(namespace="Custom Annotation", identifier="Custom Value")],
            },
            {
                "Custom Annotation": [Entity(namespace="Custom Annotation", identifier="Custom Value")],
            },
        )

    def test_unmappable_identifier(self, *_):
        """Test when the identifier can not be resolved."""
        self._help(
            {  # Expected
                "Disease": [Entity(namespace="doid", identifier="Failure")],
            },
            {
                "Disease": [Entity(namespace="Disease", identifier="Failure")],
            },
        )

    def test_unmappable_name(self, *_):
        """Test when the identifier can not be looked up by name."""
        self._help(
            {  # Expected
                "Disease": [Entity(namespace="doid", name="Failure")],
            },
            {
                "Disease": [Entity(namespace="Disease", name="Failure")],
            },
        )