Skip to content
This repository was archived by the owner on Jun 11, 2024. It is now read-only.

Commit 7fc1f3e

Browse files
committed
atomx.Atomx.search takes index parameter to only search specific models.
1 parent 00117d5 commit 7fc1f3e

File tree

2 files changed

+11
-4
lines changed

2 files changed

+11
-4
lines changed

CHANGES.txt

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -2,7 +2,7 @@
22
------------------
33

44
- :meth:`atomx.Atomx.login` takes ``totp`` parameter for users that have 2-factor auth enabled.
5-
5+
- :meth:`atomx.Atomx.search` takes ``index`` parameter to only search specific models.
66

77
1.5
88
---

atomx/__init__.py

Lines changed: 10 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -89,7 +89,7 @@ def logout(self):
8989
self.auth_token = None
9090
self.user = None
9191

92-
def search(self, query):
92+
def search(self, query, index=None):
9393
"""Search for ``query``.
9494
9595
Returns a `dict` with all found results for:
@@ -114,10 +114,17 @@ def search(self, query):
114114
>>> campaign.reload()
115115
116116
:param str query: keyword to search for.
117+
:param list index: :class:`str` or :class:`list` of the indexes you want to get returned.
118+
E.g. ``index=['campaigns', 'domains']``.
117119
:return: dict with list of :mod:`.models` as values
118120
"""
121+
params = {'q': query}
122+
if index:
123+
if isinstance(index, list):
124+
index = ','.join(index)
125+
params['index'] = index
119126
r = requests.get(self.api_endpoint + 'search',
120-
params={'q': query},
127+
params=params,
121128
headers=self._auth_header)
122129
r_json = r.json()
123130
if not r.ok:
@@ -133,7 +140,7 @@ def search(self, query):
133140
for m in search_result.keys():
134141
model_name = get_model_name(m)
135142
if model_name:
136-
search_result[m] = [getattr(models, model_name)(self, **v)
143+
search_result[m] = [getattr(models, model_name)(session=self, **v)
137144
for v in search_result[m]]
138145
return search_result
139146

0 commit comments

Comments
 (0)