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
|
# Copyright 2015 by Carlos Pena. 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.
"""Offline tests for the URL construction of NCBI's Entrez services."""
import unittest
import warnings
from Bio import Entrez
# This lets us set the email address to be sent to NCBI Entrez:
Entrez.email = "biopython-dev@biopython.org"
URL_HEAD = "http://eutils.ncbi.nlm.nih.gov/entrez/eutils/"
URL_TOOL = "tool=biopython"
URL_EMAIL = "email=biopython-dev%40biopython.org"
class TestURLConstruction(unittest.TestCase):
def test_email_warning(self):
"""Test issuing warning when user does not specify email address."""
Entrez.email = None
with warnings.catch_warnings(record=True) as w:
Entrez._construct_params(params=None)
self.assertEqual(len(w), 1)
def test_construct_cgi_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"
}
cgi = 'http://eutils.ncbi.nlm.nih.gov/entrez/eutils/ecitmatch.cgi'
variables = Entrez._update_ecitmatch_variables({'db': 'pubmed',
'bdata': [citation]})
post = False
params = Entrez._construct_params(variables)
options = Entrez._encode_options(ecitmatch=True, params=params)
result_url = Entrez._construct_cgi(cgi, post=post, options=options)
self.assertTrue("retmode=xml" in result_url, result_url)
def test_construct_cgi_einfo(self):
"""Test constructed url for request to Entrez."""
cgi = 'http://eutils.ncbi.nlm.nih.gov/entrez/eutils/einfo.fcgi'
params = Entrez._construct_params(params=None)
options = Entrez._encode_options(ecitmatch=False, params=params)
result_url = Entrez._construct_cgi(cgi, post=False, options=options)
self.assertTrue(result_url.startswith(URL_HEAD + "einfo.fcgi?"),
result_url)
self.assertTrue(URL_TOOL in result_url)
self.assertTrue(URL_EMAIL in result_url)
def test_construct_cgi_epost1(self):
cgi = 'http://eutils.ncbi.nlm.nih.gov/entrez/eutils/epost.fcgi'
variables = {'db': 'nuccore', 'id': '186972394,160418'}
post = True
params = Entrez._construct_params(variables)
options = Entrez._encode_options(ecitmatch=False, params=params)
result_url = Entrez._construct_cgi(cgi, post=post, options=options)
self.assertEqual(URL_HEAD + "epost.fcgi", result_url)
def test_construct_cgi_epost2(self):
cgi = 'http://eutils.ncbi.nlm.nih.gov/entrez/eutils/epost.fcgi'
variables = {'db': 'nuccore', 'id': ["160418", "160351"]}
post = True
params = Entrez._construct_params(variables)
options = Entrez._encode_options(ecitmatch=False, params=params)
result_url = Entrez._construct_cgi(cgi, post=post, options=options)
self.assertEqual(URL_HEAD + "epost.fcgi", result_url)
def test_construct_cgi_elink1(self):
cgi = 'http://eutils.ncbi.nlm.nih.gov/entrez/eutils/elink.fcgi'
variables = {'cmd': 'neighbor_history', 'db': 'nucleotide',
'dbfrom': 'protein', 'id': '22347800,48526535',
'query_key': None, 'webenv': None}
post = False
params = Entrez._construct_params(variables)
options = Entrez._encode_options(ecitmatch=False, params=params)
result_url = Entrez._construct_cgi(cgi, post=post, options=options)
self.assertTrue(result_url.startswith(URL_HEAD + "elink.fcgi?"),
result_url)
self.assertTrue(URL_TOOL in result_url)
self.assertTrue(URL_EMAIL in result_url)
self.assertTrue("id=22347800%2C48526535" in result_url, result_url)
def test_construct_cgi_elink2(self):
"""Commas: Link from protein to gene."""
cgi = 'http://eutils.ncbi.nlm.nih.gov/entrez/eutils/elink.fcgi'
variables = {'db': 'gene', 'dbfrom': 'protein',
'id': '15718680,157427902,119703751'}
post = False
params = Entrez._construct_params(variables)
options = Entrez._encode_options(ecitmatch=False, params=params)
result_url = Entrez._construct_cgi(cgi, post=post, options=options)
self.assertTrue(result_url.startswith(URL_HEAD + "elink.fcgi"),
result_url)
self.assertTrue(URL_TOOL in result_url)
self.assertTrue(URL_EMAIL in result_url)
self.assertTrue("id=15718680%2C157427902%2C119703751" in result_url,
result_url)
def test_construct_cgi_elink3(self):
"""Multiple ID entries: Find one-to-one links from protein to gene."""
cgi = 'http://eutils.ncbi.nlm.nih.gov/entrez/eutils/elink.fcgi'
variables = {'db': 'gene', 'dbfrom': 'protein',
'id': ["15718680", "157427902", "119703751"]}
post = False
params = Entrez._construct_params(variables)
options = Entrez._encode_options(ecitmatch=False, params=params)
result_url = Entrez._construct_cgi(cgi, post=post, options=options)
self.assertTrue(result_url.startswith(URL_HEAD + "elink.fcgi"),
result_url)
self.assertTrue(URL_TOOL in result_url)
self.assertTrue(URL_EMAIL in result_url)
self.assertTrue("id=15718680" in result_url, result_url)
self.assertTrue("id=157427902" in result_url, result_url)
self.assertTrue("id=119703751" in result_url, result_url)
def test_construct_cgi_efetch(self):
cgi = 'http://eutils.ncbi.nlm.nih.gov/entrez/eutils/efetch.fcgi'
variables = {'db': 'protein', 'id': '15718680,157427902,119703751',
'retmode': 'xml'}
post = False
params = Entrez._construct_params(variables)
options = Entrez._encode_options(ecitmatch=False, params=params)
result_url = Entrez._construct_cgi(cgi, post=post, options=options)
self.assertTrue(result_url.startswith(URL_HEAD + "efetch.fcgi?"),
result_url)
self.assertTrue(URL_TOOL in result_url)
self.assertTrue(URL_EMAIL in result_url)
self.assertTrue("id=15718680%2C157427902%2C119703751" in result_url,
result_url)
if __name__ == "__main__":
runner = unittest.TextTestRunner(verbosity=2)
unittest.main(testRunner=runner)
|
