[RFC] Add initial invenio class hierarchy #451
Conversation
oerc0122
force-pushed
the
add-invenio-repo-class
branch
2 times, most recently
from
cd2cfce to
fa03559
Compare
There was a problem hiding this comment.
Generally looks good in principle, thanks @oerc0122.
Most of the comments relate to minor things that the various checks probably complain about anyway, although they're not exhaustive.
What's the best way to test this? Mocking?
| self.name = name | ||
|
|
||
| @property | ||
| def dep_id(self): |
There was a problem hiding this comment.
| def dep_id(self): | |
| def dep_id(self) -> str: |
| return self.parent.dep_id | ||
|
|
||
| @property | ||
| def bucket_url(self): |
There was a problem hiding this comment.
| def bucket_url(self): | |
| def bucket_url(self) -> str: |
| my_repo.liceses.list() | ||
| """ | ||
|
|
||
| def __init__(self, url: str, api_key: str): |
There was a problem hiding this comment.
| def __init__(self, url: str, api_key: str): | |
| def __init__(self, url: str, api_key: str) -> None: |
| -------- | ||
| .. code-block:: | ||
|
|
||
| my_repo = InvenioRepository("abc123", "companyname.website") |
There was a problem hiding this comment.
| my_repo = InvenioRepository("abc123", "companyname.website") | |
| my_repo = InvenioRepository("companyname.website", "abc123") |
| Parameters | ||
| ---------- | ||
| dest | ||
| Folder to write files to. |
There was a problem hiding this comment.
| Folder to write files to. | |
| Folder to write files to. Default is current working directory. |
| requests.Request | ||
| Status of operation. | ||
| """ | ||
| file = Path(file) |
There was a problem hiding this comment.
Do we need to check if the path is actually a file, rather than a directory?
| """ | ||
| request_list = [] | ||
| for name, file in files.items(): | ||
| file = Path(file) |
There was a problem hiding this comment.
What if the path is a directory?
(Do we want to be able upload all files in a directory?)
| class _Deposition(_SubCommandHandler): | ||
| """Deposition handler.""" | ||
|
|
||
| def __init__(self, parent, dep_id): |
There was a problem hiding this comment.
| def __init__(self, parent, dep_id): | |
| def __init__(self, parent, dep_id) -> None: |
| import requests | ||
|
|
||
|
|
||
| def _check(request: requests.Request, proc: str): |
There was a problem hiding this comment.
Missing docstring and return type hint
| class _SubCommandHandler(ABC): | ||
| def __init__(self, parent): |
There was a problem hiding this comment.
Missing docstring/type hint
| my_repo = InvenioRepository("abc123", "companyname.website") | ||
| my_repo.depositions["my_repo"].files["file"].upload(my_file) | ||
| my_repo.records.get() | ||
| my_repo.liceses.list() |
There was a problem hiding this comment.
| my_repo.liceses.list() | |
| my_repo.licenses.list() |
oerc0122
force-pushed
the
add-invenio-repo-class
branch
from
fa03559 to
2c26c5f
Compare
|
Migrated to https://github.com/PSDI-UK/data-collections-API |
Add class hierarchy for handling pushing to invenio-like data repositories.