Skip to content

Commit fb8c217

Browse files
committed
Make feth_info return an Index object instead of a dict
1 parent d902bb4 commit fb8c217

File tree

4 files changed

+16
-15
lines changed

4 files changed

+16
-15
lines changed

.code-samples.meilisearch.yaml

Lines changed: 3 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -5,6 +5,9 @@
55
---
66
get_one_index_1: |-
77
index = client.get_index('movies')
8+
# Or
9+
index = client.index('movies').fetch_info()
10+
811
index.uid
912
index.primary_key
1013
list_all_indexes_1: |-

meilisearch/client.py

Lines changed: 1 addition & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -80,8 +80,7 @@ def get_index(self, uid):
8080
index : Index
8181
An Index instance containing the information the fetched index.
8282
"""
83-
index_dict = Index(self.config, uid).fetch_info()
84-
return Index(self.config, index_dict['uid'], index_dict['primaryKey'])
83+
return Index(self.config, uid).fetch_info()
8584

8685
def index(self, uid):
8786
"""Create an Index instance.

meilisearch/index.py

Lines changed: 4 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -71,12 +71,12 @@ def fetch_info(self):
7171
7272
Returns
7373
-------
74-
index: dict
75-
Dictionary containing the index information.
74+
index : Index
75+
An instance of Index containing the information of the index.
7676
"""
7777
index_dict = self.http.get('{}/{}'.format(self.config.paths.index, self.uid))
7878
self.primary_key = index_dict['primaryKey']
79-
return index_dict
79+
return self
8080

8181
def get_primary_key(self):
8282
"""Get the primary key.
@@ -86,8 +86,7 @@ def get_primary_key(self):
8686
primary_key: str
8787
String containing the primary key.
8888
"""
89-
self.primary_key = self.fetch_info()['primaryKey']
90-
return self.primary_key
89+
return self.fetch_info().primary_key
9190

9291
@staticmethod
9392
def create(config, uid, options=None):

meilisearch/tests/index/test_index.py

Lines changed: 8 additions & 8 deletions
Original file line numberDiff line numberDiff line change
@@ -111,20 +111,20 @@ def test_index_fetch_info(self):
111111
index = self.client.index(uid=self.index_uid)
112112
response = index.fetch_info()
113113
assert isinstance(response, object)
114-
assert response['uid'] == self.index_uid
115-
assert response['primaryKey'] is None
116-
assert index.primary_key == response['primaryKey']
117-
assert index.get_primary_key() == response['primaryKey']
114+
assert response.uid == self.index_uid
115+
assert response.primary_key is None
116+
assert response.primary_key == index.primary_key
117+
assert response.primary_key == index.get_primary_key()
118118

119119
def test_index_fetch_info_containing_primary_key(self):
120120
"""Tests getting the index info"""
121121
index = self.client.index(uid=self.index_uid3)
122122
response = index.fetch_info()
123123
assert isinstance(response, object)
124-
assert response['uid'] == self.index_uid3
125-
assert response['primaryKey'] == 'book_id'
126-
assert index.primary_key == response['primaryKey']
127-
assert index.get_primary_key() == response['primaryKey']
124+
assert response.uid == self.index_uid3
125+
assert response.primary_key == 'book_id'
126+
assert response.primary_key == index.primary_key
127+
assert response.primary_key == index.get_primary_key()
128128

129129
def test_get_primary_key(self):
130130
"""Tests getting the primary-key of an index"""

0 commit comments

Comments
 (0)