spla/Mastodonplus.py
1
0
Fork 0
Codi Incidències Sol·licituds Pull repo.project Llançaments Paquets Wiki Activitat

Add new parameter for search

Explorar la Font
This commit is contained in:
Lorenz Diener 2019-10-12 20:13:38 +02:00
pare 0b952aef12
commit f421b1e498
S'han modificat 3 arxius amb 25 adicions i 14 eliminacions
Mostrar estadístiques Descarregar el fitxer de pedaç Descarregar el fitxer de diferències Expand all files Collapse all files

14
mastodon/Mastodon.py
Veure arxiu

@ -1207,7 +1207,7 @@ class Mastodon:
raise MastodonVersionError("Advanced search parameters require Mastodon 2.8.0+") raise MastodonVersionError("Advanced search parameters require Mastodon 2.8.0+")
@api_version("1.1.0", "2.8.0", __DICT_VERSION_SEARCHRESULT) @api_version("1.1.0", "2.8.0", __DICT_VERSION_SEARCHRESULT)
def search(self, q, resolve=True, result_type=None, account_id=None, offset=None, min_id=None, max_id=None): def search(self, q, resolve=True, result_type=None, account_id=None, offset=None, min_id=None, max_id=None, exclude_unreviewed=True):
""" """
Fetch matching hashtags, accounts and statuses. Will perform webfinger Fetch matching hashtags, accounts and statuses. Will perform webfinger
lookups if resolve is True. Full-text search is only enabled if lookups if resolve is True. Full-text search is only enabled if
@ -1221,6 +1221,9 @@ class Mastodon:
`offset`, `min_id` and `max_id` can be used to paginate. `offset`, `min_id` and `max_id` can be used to paginate.
`exclude_unreviewed` can be used to restrict search results for hashtags to only
those that have been reviewed by moderators. It is on by default.
Will use search_v1 (no tag dicts in return values) on Mastodon versions before Will use search_v1 (no tag dicts in return values) on Mastodon versions before
2.4.1), search_v2 otherwise. Parameters other than resolve are only available 2.4.1), search_v2 otherwise. Parameters other than resolve are only available
on Mastodon 2.8.0 or above - this function will throw a MastodonVersionError on Mastodon 2.8.0 or above - this function will throw a MastodonVersionError
@ -1250,18 +1253,23 @@ class Mastodon:
return self.__api_request('GET', '/api/v1/search', params) return self.__api_request('GET', '/api/v1/search', params)
@api_version("2.4.1", "2.8.0", __DICT_VERSION_SEARCHRESULT) @api_version("2.4.1", "2.8.0", __DICT_VERSION_SEARCHRESULT)
def search_v2(self, q, resolve=True, result_type=None, account_id=None, offset=None, min_id=None, max_id=None): def search_v2(self, q, resolve=True, result_type=None, account_id=None, offset=None, min_id=None, max_id=None, exclude_unreviewed=True):
""" """
Identical to `search_v1()`, except in that it returns tags as Identical to `search_v1()`, except in that it returns tags as
`hashtag dicts`_, has more parameters, and resolves by default. `hashtag dicts`_, has more parameters, and resolves by default.
For more details documentation, please see `search()`
Returns a `search result dict`_. Returns a `search result dict`_.
""" """
self.__ensure_search_params_acceptable(account_id, offset, min_id, max_id) self.__ensure_search_params_acceptable(account_id, offset, min_id, max_id)
params = self.__generate_params(locals()) params = self.__generate_params(locals())
if resolve == False: if resolve == False:
del params['resolve'] del params["resolve"]
if exclude_unreviewed == False or not self.verify_minimum_version("3.0.0", cached=True):
del params["exclude_unreviewed"]
if "result_type" in params: if "result_type" in params:
params["type"] = params["result_type"] params["type"] = params["result_type"]

22
tests/cassettes/test_search.yaml
Veure arxiu

@ -8,9 +8,9 @@ interactions:
Connection: [keep-alive] Connection: [keep-alive]
User-Agent: [python-requests/2.18.4] User-Agent: [python-requests/2.18.4]
method: GET method: GET
uri: http://localhost:3000/api/v2/search?resolve=1&q=mastodonpy_test uri: http://localhost:3000/api/v2/search?exclude_unreviewed=1&resolve=1&q=mastodonpy_test
response: response:
body: {string: '{"accounts":[{"id":"1234567890123456","username":"mastodonpy_test","acct":"mastodonpy_test","display_name":"","locked":false,"bot":false,"created_at":"2019-06-22T23:11:52.441Z","note":"\u003cp\u003e\u003c/p\u003e","url":"http://localhost/@mastodonpy_test","avatar":"http://localhost/avatars/original/missing.png","avatar_static":"http://localhost/avatars/original/missing.png","header":"http://localhost/headers/original/missing.png","header_static":"http://localhost/headers/original/missing.png","followers_count":0,"following_count":0,"statuses_count":2,"last_status_at":"2019-10-11T21:49:22.805Z","emojis":[],"fields":[]},{"id":"1234567890123457","username":"mastodonpy_test_2","acct":"mastodonpy_test_2","display_name":"","locked":true,"bot":false,"created_at":"2019-06-22T23:11:52.445Z","note":"\u003cp\u003e\u003c/p\u003e","url":"http://localhost/@mastodonpy_test_2","avatar":"http://localhost/avatars/original/missing.png","avatar_static":"http://localhost/avatars/original/missing.png","header":"http://localhost/headers/original/missing.png","header_static":"http://localhost/headers/original/missing.png","followers_count":0,"following_count":0,"statuses_count":0,"last_status_at":null,"emojis":[],"fields":[]}],"statuses":[],"hashtags":[]}'} body: {string: '{"accounts":[{"id":"1234567890123456","username":"mastodonpy_test","acct":"mastodonpy_test","display_name":"","locked":false,"bot":false,"created_at":"2019-06-22T23:11:52.441Z","note":"\u003cp\u003e\u003c/p\u003e","url":"http://localhost/@mastodonpy_test","avatar":"http://localhost/avatars/original/missing.png","avatar_static":"http://localhost/avatars/original/missing.png","header":"http://localhost/headers/original/missing.png","header_static":"http://localhost/headers/original/missing.png","followers_count":0,"following_count":1,"statuses_count":2,"last_status_at":"2019-10-11T21:50:54.637Z","emojis":[],"fields":[]},{"id":"1234567890123457","username":"mastodonpy_test_2","acct":"mastodonpy_test_2","display_name":"","locked":true,"bot":false,"created_at":"2019-06-22T23:11:52.445Z","note":"\u003cp\u003e\u003c/p\u003e","url":"http://localhost/@mastodonpy_test_2","avatar":"http://localhost/avatars/original/missing.png","avatar_static":"http://localhost/avatars/original/missing.png","header":"http://localhost/headers/original/missing.png","header_static":"http://localhost/headers/original/missing.png","followers_count":0,"following_count":0,"statuses_count":0,"last_status_at":null,"emojis":[],"fields":[]}],"statuses":[],"hashtags":[]}'}
headers: headers:
Cache-Control: ['no-cache, no-store'] Cache-Control: ['no-cache, no-store']
Content-Type: [application/json; charset=utf-8] Content-Type: [application/json; charset=utf-8]
@ -21,8 +21,8 @@ interactions:
X-Download-Options: [noopen] X-Download-Options: [noopen]
X-Frame-Options: [SAMEORIGIN] X-Frame-Options: [SAMEORIGIN]
X-Permitted-Cross-Domain-Policies: [none] X-Permitted-Cross-Domain-Policies: [none]
X-Request-Id: [4ed49a56-2ee0-489c-822a-135ba9c9203e] X-Request-Id: [e3981344-186b-487f-9ac5-1195c31679c7]
X-Runtime: ['0.028978'] X-Runtime: ['0.031916']
X-XSS-Protection: [1; mode=block] X-XSS-Protection: [1; mode=block]
content-length: ['1251'] content-length: ['1251']
status: {code: 200, message: OK} status: {code: 200, message: OK}
@ -35,9 +35,9 @@ interactions:
Connection: [keep-alive] Connection: [keep-alive]
User-Agent: [python-requests/2.18.4] User-Agent: [python-requests/2.18.4]
method: GET method: GET
uri: http://localhost:3000/api/v2/search?resolve=1&q=mastodonpy_test uri: http://localhost:3000/api/v2/search?exclude_unreviewed=1&resolve=1&q=mastodonpy_test
response: response:
body: {string: '{"accounts":[{"id":"1234567890123456","username":"mastodonpy_test","acct":"mastodonpy_test","display_name":"","locked":false,"bot":false,"created_at":"2019-06-22T23:11:52.441Z","note":"\u003cp\u003e\u003c/p\u003e","url":"http://localhost/@mastodonpy_test","avatar":"http://localhost/avatars/original/missing.png","avatar_static":"http://localhost/avatars/original/missing.png","header":"http://localhost/headers/original/missing.png","header_static":"http://localhost/headers/original/missing.png","followers_count":0,"following_count":0,"statuses_count":2,"last_status_at":"2019-10-11T21:49:22.805Z","emojis":[],"fields":[]},{"id":"1234567890123457","username":"mastodonpy_test_2","acct":"mastodonpy_test_2","display_name":"","locked":true,"bot":false,"created_at":"2019-06-22T23:11:52.445Z","note":"\u003cp\u003e\u003c/p\u003e","url":"http://localhost/@mastodonpy_test_2","avatar":"http://localhost/avatars/original/missing.png","avatar_static":"http://localhost/avatars/original/missing.png","header":"http://localhost/headers/original/missing.png","header_static":"http://localhost/headers/original/missing.png","followers_count":0,"following_count":0,"statuses_count":0,"last_status_at":null,"emojis":[],"fields":[]}],"statuses":[],"hashtags":[]}'} body: {string: '{"accounts":[{"id":"1234567890123456","username":"mastodonpy_test","acct":"mastodonpy_test","display_name":"","locked":false,"bot":false,"created_at":"2019-06-22T23:11:52.441Z","note":"\u003cp\u003e\u003c/p\u003e","url":"http://localhost/@mastodonpy_test","avatar":"http://localhost/avatars/original/missing.png","avatar_static":"http://localhost/avatars/original/missing.png","header":"http://localhost/headers/original/missing.png","header_static":"http://localhost/headers/original/missing.png","followers_count":0,"following_count":1,"statuses_count":2,"last_status_at":"2019-10-11T21:50:54.637Z","emojis":[],"fields":[]},{"id":"1234567890123457","username":"mastodonpy_test_2","acct":"mastodonpy_test_2","display_name":"","locked":true,"bot":false,"created_at":"2019-06-22T23:11:52.445Z","note":"\u003cp\u003e\u003c/p\u003e","url":"http://localhost/@mastodonpy_test_2","avatar":"http://localhost/avatars/original/missing.png","avatar_static":"http://localhost/avatars/original/missing.png","header":"http://localhost/headers/original/missing.png","header_static":"http://localhost/headers/original/missing.png","followers_count":0,"following_count":0,"statuses_count":0,"last_status_at":null,"emojis":[],"fields":[]}],"statuses":[],"hashtags":[]}'}
headers: headers:
Cache-Control: ['no-cache, no-store'] Cache-Control: ['no-cache, no-store']
Content-Type: [application/json; charset=utf-8] Content-Type: [application/json; charset=utf-8]
@ -48,8 +48,8 @@ interactions:
X-Download-Options: [noopen] X-Download-Options: [noopen]
X-Frame-Options: [SAMEORIGIN] X-Frame-Options: [SAMEORIGIN]
X-Permitted-Cross-Domain-Policies: [none] X-Permitted-Cross-Domain-Policies: [none]
X-Request-Id: [b9c4a547-27f6-4b55-9830-73a4e65d55da] X-Request-Id: [5e62a49c-ac34-4759-8265-ffee054f1ca2]
X-Runtime: ['0.026422'] X-Runtime: ['0.024392']
X-XSS-Protection: [1; mode=block] X-XSS-Protection: [1; mode=block]
content-length: ['1251'] content-length: ['1251']
status: {code: 200, message: OK} status: {code: 200, message: OK}
@ -62,7 +62,7 @@ interactions:
Connection: [keep-alive] Connection: [keep-alive]
User-Agent: [python-requests/2.18.4] User-Agent: [python-requests/2.18.4]
method: GET method: GET
uri: http://localhost:3000/api/v2/search?resolve=1&q=mastodonpy_test&type=statuses uri: http://localhost:3000/api/v2/search?exclude_unreviewed=1&resolve=1&q=mastodonpy_test&type=statuses
response: response:
body: {string: '{"accounts":[],"statuses":[],"hashtags":[]}'} body: {string: '{"accounts":[],"statuses":[],"hashtags":[]}'}
headers: headers:
@ -75,8 +75,8 @@ interactions:
X-Download-Options: [noopen] X-Download-Options: [noopen]
X-Frame-Options: [SAMEORIGIN] X-Frame-Options: [SAMEORIGIN]
X-Permitted-Cross-Domain-Policies: [none] X-Permitted-Cross-Domain-Policies: [none]
X-Request-Id: [bea1135c-ef57-4e75-bbeb-c472c77273b6] X-Request-Id: [10deaa1f-2a07-40d0-ab06-cbd50df93eb7]
X-Runtime: ['0.016913'] X-Runtime: ['0.017407']
X-XSS-Protection: [1; mode=block] X-XSS-Protection: [1; mode=block]
content-length: ['43'] content-length: ['43']
status: {code: 200, message: OK} status: {code: 200, message: OK}

3
tests/test_search.py
Veure arxiu

@ -15,6 +15,9 @@ def test_search(api):
assert len(results["accounts"]) == 0 assert len(results["accounts"]) == 0
def test_search_pre_2_9_2(api): def test_search_pre_2_9_2(api):
api.mastodon_major = 2
api.mastodon_minor = 9
api.mastodon_patch = 1
with vcr.use_cassette('test_search.yaml', cassette_library_dir='tests/cassettes_pre_2_9_2', record_mode='none'): with vcr.use_cassette('test_search.yaml', cassette_library_dir='tests/cassettes_pre_2_9_2', record_mode='none'):
results = api.search_v1('mastodonpy_test') results = api.search_v1('mastodonpy_test')
assert isinstance(results, dict) assert isinstance(results, dict)