copy from Zotero storage #82
Conversation
paperqa/contrib/zotero.py
Outdated
| @@ -44,8 +45,22 @@ def __init__( | |||
| library_id: Optional[str] = None, | |||
| api_key: Optional[str] = None, | |||
| storage: Optional[StrPath] = None, | |||
| zotero_storage: Optional[Union[StrPath,bool]] = "~/Zotero/storage/", | |||
There was a problem hiding this comment.
| zotero_storage: Optional[Union[StrPath,bool]] = "~/Zotero/storage/", | |
| local_zotero: Optional[StrPath] = None, | |
| use_local_zotero: bool = True, |
And initialize it later on, based on what operating system it is.
Also, should use pathlib.Path.home() / "Zotero" / "storage" for safety
There was a problem hiding this comment.
Ok so we could do:
Optional[Union[StrPath,bool]] = None
StrPath: try to use the user-provided path, raise FileNotFoundError if it doesn't exist
None: try to use pathlib.Path.home() / "Zotero" / "storage", if it doesn't exist, set zotero_storage to None
False: never use zotero_storage
But what about
Union[StrPath,bool] = True
StrPath: try to use the user-provided path, raise FileNotFoundError if it doesn't exist
True: try to use pathlib.Path.home() / "Zotero" / "storage", if it doesn't exist, set zotero_storage to None
False: never use zotero_storage
I think default True makes it more obvious that the functionality is engaged by default. WYT?
There was a problem hiding this comment.
Also out of curiosity what's the diff btw pathlib.Path.home() / "Zotero" / "storage" and Path("~/Zotero/storage/").expanduser()?
There was a problem hiding this comment.
Pathlib question
It's just a more robust practice: On Windows, the "\" key is used instead of "/". So Pathlib's / operator will do the correct thing on each operating system.
Also sometimes the "~" is not expanded correctly. Better to rely on Pathlib.
There was a problem hiding this comment.
Being explicit is often best so I would recommend one parameter for specifying the location, and another for specifying whether you should use it or not. When variables can take on a bunch of different types it can make code confusing. (I edited my original comment with this suggestion)
paperqa/contrib/zotero.py
Outdated
| if zotero_storage: | ||
| self.zotero_storage = Path(zotero_storage).expanduser() | ||
| else: | ||
| self.zotero_storage = None |
There was a problem hiding this comment.
Here is where you can automatically set it, if the OS default exists.
| shutil.copy(zotero_pdf_path, pdf_path) | ||
| return pdf_path | ||
|
|
||
| except Exception as e: |
There was a problem hiding this comment.
What other exceptions are you thinking of here? Maybe catch them explicitly, and throw the error if something unexpected comes up?
There was a problem hiding this comment.
Are you suggesting one or more of the three things below? Or something else?
- catch specific error cases and resolve them
- catch, warn and fall back to downloading
- catch, wrap with a message, and raise
For unexpected edge cases, do you think raising an error would be better or just warning the user and falling back to downloading?
There was a problem hiding this comment.
Didn't have anything specific in mind - could imagine permissions errors at the destination dir.
There was a problem hiding this comment.
If there was no specific error you had in mind I would just remove the try-except. If you think there could be permissions issues for the shutil.copy I would check for the specific permissions error, and warn, then fall back to downloading. If there's an unexpected error then it should be raised.
Co-authored-by: Miles Cranmer <miles.cranmer@gmail.com>
|
Hi @g-simmons thank you for this PR. We just released v5 today which changes basically the whole repo. If you are still interested, please rebase this PR atop the current main branch. |
|
@jamesbraza thanks for the info. I probably won't be able to rebase this any time soon (other time commitments) :/ |
Copy files from Zotero storage instead of downloading, if possible. Discussed in #66.
Changes