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
|
# Copyright 2012 by Wibowo Arindrarto. All rights reserved.
# This code is part of the Biopython distribution and governed by its
# license. Please see the LICENSE file that should have been included
# as part of this package.
"""Tests for online Entrez access.
This file include tests for accessing the online Entrez service and parsing the
returned results. Note that we are merely testing the access and whether the
results are parseable. Detailed tests on each Entrez service are not within the
scope of this file as they are already covered in test_Entrez.py.
"""
import os
import unittest
import requires_internet
requires_internet.check()
from Bio import Entrez
from Bio import Medline
from Bio import SeqIO
from Bio.SeqRecord import SeqRecord
if os.name == 'java':
try:
from xml.parsers.expat import XML_PARAM_ENTITY_PARSING_ALWAYS
del XML_PARAM_ENTITY_PARSING_ALWAYS
except ImportError:
from Bio import MissingPythonDependencyError
raise MissingPythonDependencyError("The Bio.Entrez XML parser fails on "
"Jython, see http://bugs.jython.org/issue1447")
# This lets us set the email address to be sent to NCBI Entrez:
Entrez.email = "biopython-dev@biopython.org"
URL_HEAD = "https://eutils.ncbi.nlm.nih.gov/entrez/eutils/"
URL_TOOL = "tool=biopython"
URL_EMAIL = "email=biopython-dev%40biopython.org"
class EntrezOnlineCase(unittest.TestCase):
def test_read_from_url(self):
"""Test Entrez.read from URL"""
handle = Entrez.einfo()
self.assertTrue(handle.url.startswith(URL_HEAD + "einfo.fcgi?"), handle.url)
self.assertTrue(URL_TOOL in handle.url)
self.assertTrue(URL_EMAIL in handle.url)
rec = Entrez.read(handle)
handle.close()
self.assertTrue(isinstance(rec, dict))
self.assertTrue('DbList' in rec)
# arbitrary number, just to make sure that DbList has contents
self.assertTrue(len(rec['DbList']) > 5)
def test_parse_from_url(self):
"""Test Entrez.parse from URL"""
handle = Entrez.efetch(db='protein', id='15718680,157427902,119703751',
retmode='xml')
self.assertTrue(handle.url.startswith(URL_HEAD + "efetch.fcgi?"), handle.url)
self.assertTrue(URL_TOOL in handle.url)
self.assertTrue(URL_EMAIL in handle.url)
self.assertTrue("id=15718680%2C157427902%2C119703751" in handle.url, handle.url)
recs = list(Entrez.parse(handle))
handle.close()
self.assertEqual(3, len(recs))
# arbitrary number, just to make sure the parser works
self.assertTrue(all(len(rec).keys > 5) for rec in recs)
def test_webenv_search(self):
"""Test Entrez.search from link webenv history"""
handle = Entrez.elink(db='nucleotide', dbfrom='protein',
id='22347800,48526535', webenv=None, query_key=None,
cmd='neighbor_history')
self.assertTrue(handle.url.startswith(URL_HEAD + "elink.fcgi?"), handle.url)
self.assertTrue(URL_TOOL in handle.url)
self.assertTrue(URL_EMAIL in handle.url)
self.assertTrue("id=22347800%2C48526535" in handle.url, handle.url)
recs = Entrez.read(handle)
handle.close()
record = recs.pop()
webenv = record['WebEnv']
query_key = record['LinkSetDbHistory'][0]['QueryKey']
handle = Entrez.esearch(db='nucleotide', term=None,
retstart=0, retmax=10,
webenv=webenv, query_key=query_key,
usehistory='y')
self.assertTrue(handle.url.startswith(URL_HEAD + "esearch.fcgi?"), handle.url)
self.assertTrue(URL_TOOL in handle.url)
self.assertTrue(URL_EMAIL in handle.url)
search_record = Entrez.read(handle)
handle.close()
self.assertEqual(2, len(search_record['IdList']))
def test_seqio_from_url(self):
"""Test Entrez into SeqIO.read from URL"""
handle = Entrez.efetch(db='nucleotide', id='186972394', rettype='gb',
retmode='text')
self.assertTrue(handle.url.startswith(URL_HEAD + "efetch.fcgi?"), handle.url)
self.assertTrue(URL_TOOL in handle.url)
self.assertTrue(URL_EMAIL in handle.url)
self.assertTrue("id=186972394" in handle.url)
record = SeqIO.read(handle, 'genbank')
handle.close()
self.assertTrue(isinstance(record, SeqRecord))
self.assertEqual('EU490707.1', record.id)
self.assertEqual(1302, len(record))
def test_medline_from_url(self):
"""Test Entrez into Medline.read from URL"""
handle = Entrez.efetch(db="pubmed", id='19304878', rettype="medline",
retmode="text")
self.assertTrue(handle.url.startswith(URL_HEAD + "efetch.fcgi?"), handle.url)
self.assertTrue(URL_TOOL in handle.url)
self.assertTrue(URL_EMAIL in handle.url)
self.assertTrue("id=19304878" in handle.url)
record = Medline.read(handle)
handle.close()
self.assertTrue(isinstance(record, dict))
self.assertEqual('19304878', record['PMID'])
self.assertEqual('10.1093/bioinformatics/btp163 [doi]', record['LID'])
def test_efetch_biosystems_xml(self):
"""Test Entrez parser with XML from biosystems"""
handle = Entrez.efetch(id="1134002", db="biosystems", retmode="xml")
records = list(Entrez.parse(handle))
handle.close()
self.assertEqual(len(records), 1)
self.assertEqual(records[0]['System_sysid']['Sys-id']['Sys-id_bsid'], '1134002')
def test_efetch_taxonomy_xml(self):
"""Test Entrez using a integer id - like a taxon id"""
handle = Entrez.efetch(db="taxonomy", id=3702, retmode="XML")
taxon_record = Entrez.read(handle)
self.assertTrue(1, len(taxon_record))
self.assertTrue('TaxId' in taxon_record[0])
self.assertTrue('3702', taxon_record[0]['TaxId'])
def test_elink(self):
# Commas: Link from protein to gene
handle = Entrez.elink(db="gene", dbfrom="protein",
id="15718680,157427902,119703751")
self.assertTrue(handle.url.startswith(URL_HEAD + "elink.fcgi"), handle.url)
self.assertTrue(URL_TOOL in handle.url)
self.assertTrue(URL_EMAIL in handle.url)
self.assertTrue("id=15718680%2C157427902%2C119703751" in handle.url, handle.url)
handle.close()
# Multiple ID entries: Find one-to-one links from protein to gene
handle = Entrez.elink(db="gene", dbfrom="protein",
id=["15718680", "157427902", "119703751"])
self.assertTrue(handle.url.startswith(URL_HEAD + "elink.fcgi"), handle.url)
self.assertTrue(URL_TOOL in handle.url)
self.assertTrue(URL_EMAIL in handle.url)
self.assertTrue("id=15718680" in handle.url, handle.url)
self.assertTrue("id=157427902" in handle.url, handle.url)
self.assertTrue("id=119703751" in handle.url, handle.url)
handle.close()
def test_epost(self):
handle = Entrez.epost("nuccore", id="186972394,160418")
self.assertEqual(URL_HEAD + "epost.fcgi", handle.url)
handle.close()
handle = Entrez.epost("nuccore", id=["160418", "160351"])
self.assertEqual(URL_HEAD + "epost.fcgi", handle.url)
handle.close()
def test_egquery(self):
handle = Entrez.egquery(term="biopython")
record = Entrez.read(handle)
handle.close()
done = False
for row in record["eGQueryResult"]:
if "pmc" in row["DbName"]:
self.assertTrue(int(row["Count"]) > 60)
done = True
self.assertTrue(done)
def test_espell(self):
handle = Entrez.espell(term="biopythooon")
record = Entrez.read(handle)
handle.close()
self.assertEqual(record["Query"], "biopythooon")
self.assertEqual(record["CorrectedQuery"], "biopython")
def test_ecitmatch(self):
citation = {
"journal_title": "proc natl acad sci u s a",
"year": "1991", "volume": "88", "first_page": "3248",
"author_name": "mann bj", "key": "citation_1"
}
handle = Entrez.ecitmatch(db="pubmed", bdata=[citation])
self.assertTrue("retmode=xml" in handle.url, handle.url)
result = handle.read()
expected_result = "proc natl acad sci u s a|1991|88|3248|mann bj|citation_1|2014248\n"
self.assertEquals(result, expected_result)
def test_fetch_xml_schemas(self):
handle = Entrez.efetch("protein", id="783730874", rettype="ipg", retmode="xml")
records = list(Entrez.parse(handle))
handle.close()
self.assertEqual(len(records), 1)
self.assertTrue("Product" in records[0])
self.assertTrue("Statistics" in records[0])
self.assertTrue("RedundantGiList" in records[0])
if __name__ == "__main__":
runner = unittest.TextTestRunner(verbosity=2)
unittest.main(testRunner=runner)
|