adds Author advanced_search (w/ facets on birth + death date) #92
Conversation
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
cdrini
requested changes
Jun 15, 2018
| params = {'name': name, 'birth_date': birth_date, 'death_date': death_date} | ||
| paramstr = '+'.join(['%s:%s' % (k, v) for (k, v) in params.items() if v]) | ||
| url = cls.OL.base_url + '/search/authors.json?limit=%s&q=%s' % (limit, paramstr) | ||
| r = requests.get(url) |
There was a problem hiding this comment.
Use the params arg with requests.get:
requests.get(cls.OL.base_url + '/search/authors.json', params={'limit': limit, ...})This will also encode the url parameters.
| [u'OL26320A]' | ||
|
|
||
| Returns: | ||
| List of Author olid from API if results, else None |
There was a problem hiding this comment.
typo: this doesn't return None
| e.g. "\"January 5\"" | ||
| You can also do something like "*1982*" | ||
| (without quotes) to partial match on, e.g. year | ||
| date_date (str) - The death date of the Author; same conditions |
| r = requests.get(url) | ||
| try: | ||
| authors = r.json().get('docs', []) | ||
| except requests.JSONDecodeError as e: |
There was a problem hiding this comment.
Is there a case when this could be thrown?
| birth_date (str) - The birth date of the Author exactly as it | ||
| appears in OL (e.g. "January 5, 2013"). | ||
| Must be in quotes if the date is mult-terms, | ||
| e.g. "\"January 5\"" |
There was a problem hiding this comment.
Maybe use single quote here so you don't have to escape the double quotes.
| List of Author olid from API if results, else None | ||
| """ | ||
| params = {'name': name, 'birth_date': birth_date, 'death_date': death_date} | ||
| paramstr = '+'.join(['%s:%s' % (k, v) for (k, v) in params.items() if v]) |
There was a problem hiding this comment.
query might be a better name for this; it'll get run pretty much directly on solr.
| @@ -582,6 +582,41 @@ def get(cls, olid): | |||
| bio=OpenLibrary.get_text_value(data.pop('bio', None)), | |||
| **data) | |||
|
|
|||
| @classmethod | |||
| def advanced_search(cls, name=None, birth_date=None, death_date=None, limit=5): | |||
| """Searches for an Open Library authors using author API endpoint | |||
|
Can this be worked on to correct it based on @cdrini 's review? |
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
This PR closes #91
Description:
Even though an Author search method exists...
i.e.
ol = OpenLibrary();ol.Author.search(...)It uses the autocomplete API which doesn't appear to support query by birth + death date. For now, to unblock @salman-bhai, this PR adds an
Author.advanced_searchwhich directly hits the Author json API endpoint and supports these additional facets.