File: constants.py

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

"""Constants for PyBEL tests."""

import logging
import re
import unittest
from json import dumps

from pybel import BELGraph
from pybel.canonicalize import edge_to_bel
from pybel.constants import (
    ANNOTATIONS,
    ASSOCIATION,
    CITATION,
    CITATION_TYPE_PUBMED,
    DECREASES,
    DIRECTLY_DECREASES,
    EVIDENCE,
    IDENTIFIER,
    INCREASES,
    LINE,
    METADATA_AUTHORS,
    METADATA_DESCRIPTION,
    METADATA_LICENSES,
    METADATA_NAME,
    METADATA_VERSION,
    NAMESPACE,
    PART_OF,
    RELATION,
)
from pybel.dsl import BaseEntity, ComplexAbundance, Pathology, Protein
from pybel.dsl.namespaces import hgnc
from pybel.exceptions import (
    BELParserWarning,
    BELSyntaxError,
    CitationTooShortException,
    IllegalAnnotationValueWarning,
    InvalidCitationLengthException,
    InvalidCitationType,
    InvalidFunctionSemantic,
    InvalidPubMedIdentifierWarning,
    MalformedTranslocationWarning,
    MissingAnnotationKeyWarning,
    MissingAnnotationRegexWarning,
    MissingCitationException,
    MissingMetadataException,
    MissingNamespaceNameWarning,
    MissingNamespaceRegexWarning,
    MissingSupportWarning,
    NakedNameWarning,
    NestedRelationWarning,
    PlaceholderAminoAcidWarning,
    UndefinedAnnotationWarning,
    UndefinedNamespaceWarning,
    VersionFormatWarning,
)
from pybel.language import Entity, citation_dict
from pybel.parser.parse_bel import BELParser
from pybel.parser.parse_control import ControlParser
from pybel.testing.constants import test_bel_thorough
from pybel.utils import subdict_matches
from tests.constant_helper import (
    BEL_THOROUGH_EDGES,
    BEL_THOROUGH_NODES,
    citation_1,
    evidence_1,
    expected_test_simple_metadata,
    expected_test_thorough_metadata,
)

logger = logging.getLogger(__name__)

OPENBEL_DOMAIN = "http://resources.openbel.org"
OPENBEL_ANNOTATION_RESOURCES = OPENBEL_DOMAIN + "/belframework/20150611/annotation/"

test_citation_dict = citation_dict(namespace=CITATION_TYPE_PUBMED, identifier="1235813")

SET_CITATION_TEST = f'SET Citation = {{"{test_citation_dict.namespace}", "{test_citation_dict.identifier}"}}'
test_evidence_text = "I read it on Twitter"
test_set_evidence = f'SET Evidence = "{test_evidence_text}"'

HGNC_KEYWORD = "HGNC"
MESH_DISEASES_KEYWORD = "MeSHDisease"
MESH_DISEASES_URL = OPENBEL_ANNOTATION_RESOURCES + "mesh-diseases.belanno"

akt1 = hgnc(name="AKT1")
egfr = hgnc(name="EGFR")
fadd = hgnc(name="FADD")
casp8 = hgnc(name="CASP8")


def update_provenance(control_parser: ControlParser) -> None:
    """Put a default evidence and citation in a BEL parser."""
    control_parser.citation_db = test_citation_dict.namespace
    control_parser.citation_db_id = test_citation_dict.identifier
    control_parser.evidence = test_evidence_text


def assert_has_node(self: unittest.TestCase, node: BaseEntity, graph: BELGraph, **kwargs):
    """Check if a node with the given properties is contained within a graph."""
    self.assertIsInstance(node, BaseEntity)

    self.assertIn(
        node,
        graph,
        msg="{} not found in graph. Other nodes:\n{}".format(node.as_bel(), "\n".join(n.as_bel() for n in graph)),
    )

    if kwargs:
        missing = set(kwargs) - set(graph.nodes[node])
        self.assertFalse(missing, msg="Missing {} in node data".format(", ".join(sorted(missing))))
        self.assertTrue(
            all(kwarg in graph.nodes[node] for kwarg in kwargs),
            msg="Missing kwarg in node data",
        )
        self.assertEqual(
            kwargs,
            {k: graph.nodes[node][k] for k in kwargs},
            msg="Wrong values in node data",
        )


def any_dict_matches(dict_of_dicts, query_dict) -> bool:
    """

    :param dict_of_dicts:
    :param query_dict:
    :return:
    """
    return any(query_dict == sd for sd in dict_of_dicts.values())


def any_subdict_matches(dict_of_dicts, query_dict) -> bool:
    """Checks if dictionary target_dict matches one of the subdictionaries of a

    :param dict[any,dict] dict_of_dicts: dictionary of dictionaries
    :param dict query_dict: dictionary
    :return: if dictionary target_dict matches one of the subdictionaries of a
    """
    return any(subdict_matches(sub_dict, query_dict) for sub_dict in dict_of_dicts.values())


def _remove_line(d):
    return {k: v for k, v in d.items() if k != LINE}


def assert_has_edge(
    self: unittest.TestCase,
    u: BaseEntity,
    v: BaseEntity,
    graph: BELGraph,
    *,
    only: bool = False,
    permissive: bool = True,
    use_identifiers: bool = False,
    **expected_edge_data,
):
    """A helper function for checking if an edge with the given properties is contained within a graph."""
    self.assertIsInstance(u, BaseEntity)
    self.assertIsInstance(v, BaseEntity)

    self.assertTrue(
        graph.has_edge(u, v),
        msg="Edge ({}, {}) not in graph. Other edges:\n{}".format(
            u,
            v,
            "\n".join(edge_to_bel(u, v, d, use_identifiers=use_identifiers) for u, v, d in graph.edges(data=True)),
        ),
    )

    if not expected_edge_data:
        return

    if ANNOTATIONS in expected_edge_data:
        expected_edge_data[ANNOTATIONS] = graph._clean_annotations(expected_edge_data[ANNOTATIONS])

    if only:
        _key, actual_edge_data = list(graph[u][v].items())[0]
        self.assertEqual(
            _remove_line(expected_edge_data),
            _remove_line(actual_edge_data),
            msg="Only entry not equal",
        )
    else:
        actual_dicts = {k: _remove_line(v) for k, v in graph[u][v].items()}
        if permissive:
            matches = any_subdict_matches(actual_dicts, _remove_line(expected_edge_data))
        else:
            matches = any_dict_matches(actual_dicts, _remove_line(expected_edge_data))

        msg = "No edge ({}, {}) with correct properties. expected:\n {}\nbut got:\n{}".format(
            u,
            v,
            dumps(expected_edge_data, indent=2, sort_keys=True),
            dumps(actual_dicts, indent=2, sort_keys=True),
        )
        self.assertTrue(matches, msg=msg)


class TestGraphMixin(unittest.TestCase):
    """A test case with additional functions for testing graphs."""

    def assert_has_node(self, g: BELGraph, n: BaseEntity, **kwargs):
        """Help assert node membership."""
        assert_has_node(self, n, g, **kwargs)

    def assert_has_edge(
        self,
        g: BELGraph,
        u: BaseEntity,
        v: BaseEntity,
        only=False,
        permissive=True,
        **kwargs,
    ):
        """Help assert edge membership."""
        assert_has_edge(self, u, v, g, only=only, permissive=permissive, **kwargs)


class TestTokenParserBase(unittest.TestCase):
    """A test case that has a BEL parser available."""

    @classmethod
    def setUpClass(cls):
        """Build a BEL graph and BEL parser that persist through the class."""
        cls.parser = BELParser(
            BELGraph(),  # gets overwritten in each test
            autostreamline=False,
            disallow_unqualified_translocations=True,
            namespace_to_pattern={
                "HGNC": re.compile(r".*"),
                "SNP": re.compile(r".*"),
                "CHEBI": re.compile(r".*"),
                "REF": re.compile(r".*"),
                "MOD": re.compile(r".*"),
                "EFO": re.compile(r".*"),
                "GO": re.compile(r".*"),
                "UBERON": re.compile(r".*"),
                "FPLX": re.compile(r".*"),
                "MESH": re.compile(r".*"),
                "MGI": re.compile(r".*"),
                "dbSNP": re.compile(r".*"),
            },
        )

    @property
    def graph(self):
        return self.parser.graph

    def setUp(self):
        """Clear the parser at the beginning of each test."""
        self.parser.clear()
        self.parser.graph = BELGraph()  # because all the good stuff in the graph is cleared

    def assert_has_node(self, member: BaseEntity, **kwargs):
        """Assert that this test case's graph has the given node."""
        assert_has_node(self, member, self.graph, **kwargs)

    def assert_has_edge(self, u: BaseEntity, v: BaseEntity, only: bool = False, **kwargs):
        """Assert that this test case's graph has the given edge."""
        assert_has_edge(self, u, v, self.graph, only=only, **kwargs)

    def add_default_provenance(self):
        """Add a default citation and evidence to the parser."""
        update_provenance(self.parser.control_parser)


def help_check_hgnc(test_case: unittest.TestCase, namespace_dict) -> None:
    """Assert that the namespace dictionary is correct."""
    test_case.assertIn(HGNC_KEYWORD, namespace_dict)

    mhs2 = "7071", "MHS2"
    test_case.assertIn(mhs2, namespace_dict[HGNC_KEYWORD])
    test_case.assertEqual(set("G"), set(namespace_dict[HGNC_KEYWORD][mhs2]))

    miatnb = "50731", "MIATNB"
    test_case.assertIn(miatnb, namespace_dict[HGNC_KEYWORD])
    test_case.assertEqual(set("GR"), set(namespace_dict[HGNC_KEYWORD][miatnb]))

    mia = "7076", "MIA"
    test_case.assertIn(mia, namespace_dict[HGNC_KEYWORD])
    test_case.assertEqual(set("GRP"), set(namespace_dict[HGNC_KEYWORD][mia]))


class BelReconstitutionMixin(TestGraphMixin):
    """A test case that has checks for properly loading several BEL Scripts."""

    def bel_simple_reconstituted(self, graph: BELGraph, check_metadata: bool = True):
        """Check that test_bel.bel was loaded properly."""
        self.assertIsNotNone(graph)
        self.assertIsInstance(graph, BELGraph)

        if check_metadata:
            self.assertIsNotNone(graph.document)
            self.assertEqual(expected_test_simple_metadata[METADATA_NAME], graph.name)
            self.assertEqual(expected_test_simple_metadata[METADATA_VERSION], graph.version)

        self.assertEqual(4, graph.number_of_nodes())

        # FIXME this should work, but is getting 8 for the upgrade function
        # self.assertEqual(6, graph.number_of_edges(),
        #                  msg='Edges:\n{}'.format('\n'.join(map(str, graph.edges(keys=True, data=True)))))

        for node in graph:
            self.assertIsInstance(node, BaseEntity)

        self.assertIn(akt1, graph)
        self.assertIn(egfr, graph)
        self.assertIn(fadd, graph)
        self.assertIn(casp8, graph)

        bel_simple_citation_1 = citation_dict(namespace=CITATION_TYPE_PUBMED, identifier="123455")
        bel_simple_citation_2 = citation_dict(namespace=CITATION_TYPE_PUBMED, identifier="123456")

        evidence_1_extra = "Evidence 1 w extra notes"
        evidence_2 = "Evidence 2"
        evidence_3 = "Evidence 3"

        assert_has_edge(
            self,
            akt1,
            egfr,
            graph,
            only=True,
            **{
                RELATION: INCREASES,
                CITATION: bel_simple_citation_1,
                EVIDENCE: evidence_1_extra,
                ANNOTATIONS: {
                    "Species": [Entity(namespace="Species", identifier="9606")],
                },
            },
        )
        assert_has_edge(
            self,
            egfr,
            fadd,
            graph,
            only=True,
            **{
                RELATION: DECREASES,
                ANNOTATIONS: {
                    "Species": [Entity(namespace="Species", identifier="9606")],
                    "CellLine": [Entity(namespace="CellLine", identifier="10B9 cell")],
                },
                CITATION: bel_simple_citation_1,
                EVIDENCE: evidence_2,
            },
        )
        assert_has_edge(
            self,
            egfr,
            casp8,
            graph,
            only=True,
            **{
                RELATION: DIRECTLY_DECREASES,
                ANNOTATIONS: {
                    "Species": [Entity(namespace="Species", identifier="9606")],
                    "CellLine": [Entity(namespace="CellLine", identifier="10B9 cell")],
                },
                CITATION: bel_simple_citation_1,
                EVIDENCE: evidence_2,
            },
        )
        assert_has_edge(
            self,
            fadd,
            casp8,
            graph,
            only=True,
            **{
                RELATION: INCREASES,
                ANNOTATIONS: {
                    "Species": [Entity(namespace="Species", identifier="10116")],
                },
                CITATION: bel_simple_citation_2,
                EVIDENCE: evidence_3,
            },
        )
        assert_has_edge(
            self,
            akt1,
            casp8,
            graph,
            only=True,
            **{
                RELATION: ASSOCIATION,
                ANNOTATIONS: {
                    "Species": [Entity(namespace="Species", identifier="10116")],
                },
                CITATION: bel_simple_citation_2,
                EVIDENCE: evidence_3,
            },
        )
        assert_has_edge(
            self,
            casp8,
            akt1,
            graph,
            only=True,
            **{
                RELATION: ASSOCIATION,
                ANNOTATIONS: {
                    "Species": [Entity(namespace="Species", identifier="10116")],
                },
                CITATION: bel_simple_citation_2,
                EVIDENCE: evidence_3,
            },
        )

    def bel_thorough_reconstituted(
        self,
        graph: BELGraph,
        check_metadata: bool = True,
        check_warnings: bool = True,
        check_provenance: bool = True,
        check_citation_name: bool = True,
        check_path: bool = True,
    ):
        """Check that thorough.bel was loaded properly.

        :param graph: A BEL graph
        :param check_metadata: Check the graph's document section is correct
        :param check_warnings: Check the graph produced the expected warnings
        :param check_provenance: Check the graph's definition section is correct
        :param check_citation_name: Check that the names in the citations get reconstituted. This isn't strictly
                                         necessary since this data can be looked up
        :param check_path: Check the graph contains provenance for its original file
        """
        self.assertIsNotNone(graph)
        self.assertIsInstance(graph, BELGraph)

        if check_warnings:
            self.assertEqual(
                0,
                len(graph.warnings),
                msg="Document warnings:\n{}".format("\n".join(map(str, graph.warnings))),
            )

        if check_metadata:
            self.assertLessEqual(set(expected_test_thorough_metadata), set(graph.document))
            self.assertEqual(expected_test_thorough_metadata[METADATA_NAME], graph.name)
            self.assertEqual(expected_test_thorough_metadata[METADATA_VERSION], graph.version)
            self.assertEqual(expected_test_thorough_metadata[METADATA_DESCRIPTION], graph.description)

        if check_path:
            self.assertEqual(test_bel_thorough, graph.path)

        if check_provenance:
            self.assertEqual({"CHEBI", "HGNC", "GO", "MESHD", "TESTNS2"}, set(graph.namespace_url))
            self.assertEqual({"dbSNP"}, set(graph.namespace_pattern))
            self.assertIn("TESTAN1", graph.annotation_list)
            self.assertIn("TESTAN2", graph.annotation_list)
            self.assertEqual(
                2,
                len(graph.annotation_list),
                msg="Wrong number of locally defined annotations",
            )
            self.assertEqual({"TestRegex"}, set(graph.annotation_pattern))

        for node in graph:
            self.assertIsInstance(node, BaseEntity)

        self.assertEqual(
            sorted(BEL_THOROUGH_NODES, key=str),
            sorted(graph, key=str),
            msg="Nodes not equal",
        )

        # FIXME
        # self.assertEqual(set((u, v) for u, v, _ in e), set(g.edges()))

        self.assertLess(0, graph.number_of_edges())

        for u, v, data in BEL_THOROUGH_EDGES:
            assert_has_edge(self, u, v, graph, permissive=True, **data)

    def bel_slushy_reconstituted(self, graph: BELGraph, check_metadata: bool = True, check_warnings: bool = True):
        """Check that slushy.bel was loaded properly."""
        self.assertIsNotNone(graph)
        self.assertIsInstance(graph, BELGraph)

        if check_metadata:
            self.assertIsNotNone(graph.document)
            self.assertIsInstance(graph.document, dict)

            expected_test_slushy_metadata = {
                METADATA_NAME: "Worst. BEL Document. Ever.",
                METADATA_DESCRIPTION: "This document outlines all of the evil and awful work that is possible during BEL curation",
                METADATA_VERSION: "0.0",
                METADATA_AUTHORS: "Charles Tapley Hoyt",
                METADATA_LICENSES: "WTF License",
            }

            self.assertEqual(expected_test_slushy_metadata[METADATA_NAME], graph.name)
            self.assertEqual(expected_test_slushy_metadata[METADATA_VERSION], graph.version)
            self.assertEqual(expected_test_slushy_metadata[METADATA_DESCRIPTION], graph.description)

        if check_warnings:
            expected_warnings = [
                (0, MissingMetadataException),
                (3, VersionFormatWarning),
                (26, MissingAnnotationKeyWarning),
                (29, MissingAnnotationKeyWarning),
                (34, CitationTooShortException),
                (37, InvalidCitationType),
                (40, InvalidPubMedIdentifierWarning),
                (43, MissingCitationException),
                (48, MissingAnnotationKeyWarning),
                (51, MissingAnnotationKeyWarning),
                (54, MissingSupportWarning),
                (59, NakedNameWarning),
                (62, UndefinedNamespaceWarning),
                (65, MissingNamespaceNameWarning),
                (68, UndefinedAnnotationWarning),
                (71, MissingAnnotationKeyWarning),
                (74, IllegalAnnotationValueWarning),
                (77, MissingAnnotationRegexWarning),
                (80, MissingNamespaceRegexWarning),
                (83, MalformedTranslocationWarning),
                (86, PlaceholderAminoAcidWarning),
                (89, NestedRelationWarning),
                (92, InvalidFunctionSemantic),
                # (95, Exception),
                (98, BELSyntaxError),
            ]

            for warning_tuple in graph.warnings:
                self.assertEqual(
                    3,
                    len(warning_tuple),
                    msg="Warning tuple is wrong size: {}".format(warning_tuple),
                )

            _sliced_warnings = [(w.line_number, w.__class__) for _, w, _ in graph.warnings]
            self.assertEqual(expected_warnings, _sliced_warnings, msg="wrong warnings")

            for (el, ew), (_, exc, _) in zip(expected_warnings, graph.warnings):
                self.assertIsInstance(exc, BELParserWarning)
                self.assertIsInstance(exc.line, str)
                self.assertIsInstance(exc.line_number, int)
                self.assertIsInstance(exc.position, int)
                self.assertEqual(
                    el,
                    exc.line_number,
                    msg="Expected {} on line {} but got {} on line {}: {}".format(
                        ew, el, exc.__class__, exc.line_number, exc
                    ),
                )
                self.assertIsInstance(exc, ew, msg="Line: {}".format(el))

        for node in graph:
            self.assertIsInstance(node, BaseEntity)

        self.assertIn(akt1, graph, msg="AKT1 not in graph")
        self.assertIn(egfr, graph, msg="EGFR not in graph")

        self.assertEqual(
            2,
            graph.number_of_nodes(),
            msg="Wrong number of nodes retrieved from slushy.bel",
        )
        self.assertEqual(
            1,
            graph.number_of_edges(),
            msg="Wrong nunber of edges retrieved from slushy.bel",
        )

        assert_has_edge(
            self,
            akt1,
            egfr,
            graph,
            only=True,
            **{
                RELATION: INCREASES,
                CITATION: citation_1,
                EVIDENCE: evidence_1,
            },
        )

    def bel_isolated_reconstituted(self, graph: BELGraph):
        """Run the isolated node test."""
        self.assertIsNotNone(graph)
        self.assertIsInstance(graph, BELGraph)

        adgrb1 = Protein(namespace="HGNC", name="ADGRB1")
        adgrb2 = Protein(namespace="HGNC", name="ADGRB2")
        adgrb_complex = ComplexAbundance([adgrb1, adgrb2])
        achlorhydria = Pathology(namespace="MESHD", name="Achlorhydria")

        for node in graph:
            self.assertIsInstance(node, BaseEntity)

        self.assertIn(adgrb1, graph)
        self.assertIn(adgrb2, graph)
        self.assertIn(adgrb_complex, graph)
        self.assertIn(achlorhydria, graph)

        assert_has_edge(self, adgrb1, adgrb_complex, graph, only=True, relation=PART_OF)
        assert_has_edge(self, adgrb2, adgrb_complex, graph, only=True, relation=PART_OF)