WIP: feature/api improvements #41
Open
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
This method allows a user to delete the corpus using the corpus object itself, instead of needing to use `requests.delete` and the corpus url.
This method allows a user to delete a document using the document object itself, instead of needing to use `requests.delete` and the document url.
This *breaks backwards compatibility*. This means we probably need to bump the major version before we merge this into master and publish to pypi.
|
I don't know what is the expected behavior when unsucessfully trying to delet, but i would raise an informative error - maybe like the index error when trying to pop() from an empty list? |
| @@ -140,6 +156,9 @@ def __init__(self, session, *args, **kwargs): | |||
| ''' | |||
| self.session = session | |||
| for key, value in kwargs.items(): | |||
| if key == 'documents': | |||
| value = map(lambda d: Document(session=self.session, **d), | |||
There was a problem hiding this comment.
I like this, because its way more usefull for API users. No need to worry about breaking compatibility since we don't have many users yet. But we should make a clear note about this in some form of release note.
|
@rsouza the way the code is right now it will raise a RuntimeError if there is any problem while trying to delete. |
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 Pull Request is still a work in progress, so it should probably not be merged yet. I'm publishing it here so I can get reviews.
I've added methods to delete the objects (instead of having to call the
deletemethod fromrequestswith the entity URL). The biggest change, though, is returningDocumentobjects in the when accessing thedocumentsattribute of aCorpus. This change breaks backward compatibility, so we need to be sure we want that before we merge this (we also need to bump our major version before we publish to pypi).I'd like you all @rsouza , @fccoelho and @eduardostalinho to review this, please. Specially the
test_get_all_documentstest.