pyzotero 1.6.6__py3-none-any.whl → 1.6.8__py3-none-any.whl

_version.py

@@ -12,5 +12,5 @@ __version__: str
 __version_tuple__: VERSION_TUPLE
 version_tuple: VERSION_TUPLE
 
-__version__ = version = '1.6.6'
-__version_tuple__ = version_tuple = (1, 6, 6)
+__version__ = version = '1.6.8'
+__version_tuple__ = version_tuple = (1, 6, 8)

pyzotero/filetransport.py

@@ -0,0 +1,151 @@
+# This is a modified version of httpx_file:
+# The aiofiles dependency has been removed by modifying the async functionality to use
+# asyncio instead. A specific test for this modification can be found in tests/test_async.py
+# https://github.com/nuno-andre/httpx-file
+
+
+# The license and copyright notice are reproduced below
+# Copyright (c) 2021, Nuno André Novo
+# All rights reserved.
+
+# Redistribution and use in source and binary forms, with or without
+# modification, are permitted provided that the following conditions are met:
+# * Redistributions of source code must retain the above copyright notice, this
+#   list of conditions and the following disclaimer.
+# * Redistributions in binary form must reproduce the above copyright notice,
+#   this list of conditions and the following disclaimer in the documentation
+#   and/or other materials provided with the distribution.
+# * Neither the name of the <copyright holder> nor the names of its contributors
+#   may be used to endorse or promote products derived from this software without
+#   specific prior written permission.
+
+# THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS "AS IS" AND
+# ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED
+# WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE
+# DISCLAIMED. IN NO EVENT SHALL <COPYRIGHT HOLDER> BE LIABLE FOR ANY DIRECT,
+# INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING,
+# BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE,
+# DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF
+# LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE
+# OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF
+# ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
+
+import asyncio
+from pathlib import Path
+from typing import Optional, Tuple
+
+import httpx
+from httpx import (
+    AsyncBaseTransport,
+    BaseTransport,
+    ByteStream,
+    Request,
+    Response,
+)
+from httpx import (
+    AsyncClient as _AsyncClient,
+)
+from httpx import (
+    Client as _Client,
+)
+from httpx._utils import URLPattern
+
+
+# monkey patch to fix httpx URL parsing
+def is_relative_url(self):
+    return not (self._uri_reference.scheme or self._uri_reference.host)
+
+
+def is_absolute_url(self):
+    return not self.is_relative_url
+
+
+httpx.URL.is_relative_url = property(is_relative_url)  # type: ignore
+httpx.URL.is_absolute_url = property(is_absolute_url)  # type: ignore
+
+
+class FileTransport(AsyncBaseTransport, BaseTransport):
+    def _handle(self, request: Request) -> Tuple[Optional[int], httpx.Headers]:
+        if request.url.host and request.url.host != "localhost":
+            raise NotImplementedError("Only local paths are allowed")
+        if request.method in {"PUT", "DELETE"}:
+            status = 501  # Not Implemented
+        elif request.method not in {"GET", "HEAD"}:
+            status = 405  # Method Not Allowed
+        else:
+            status = None
+        return status, request.headers
+
+    def handle_request(self, request: Request) -> Response:
+        status, headers = self._handle(request)
+        stream = None
+        if not status:
+            parts = request.url.path.split("/")
+            if parts[1].endswith((":", "|")):
+                parts[1] = parts[1][:-1] + ":"
+                parts.pop(0)
+            ospath = Path("/".join(parts))
+            try:
+                content = ospath.read_bytes()
+                status = 200
+            except FileNotFoundError:
+                status = 404
+            except PermissionError:
+                status = 403
+            else:
+                stream = ByteStream(content)
+                headers["Content-Length"] = str(len(content))
+        return Response(
+            status_code=status,
+            headers=headers,
+            stream=stream,
+            extensions=dict(),
+        )
+
+    async def handle_async_request(self, request: Request) -> Response:
+        status, headers = self._handle(request)
+        stream = None
+        if not status:
+            parts = request.url.path.split("/")
+            if parts[1].endswith((":", "|")):
+                parts[1] = parts[1][:-1] + ":"
+                parts.pop(0)
+            ospath = Path("/".join(parts))
+            try:
+                loop = asyncio.get_event_loop()
+                content = await loop.run_in_executor(None, ospath.read_bytes)
+                status = 200
+            except FileNotFoundError:
+                status = 404
+            except PermissionError:
+                status = 403
+            else:
+                stream = ByteStream(content)
+                headers["Content-Length"] = str(len(content))
+        return Response(
+            status_code=status,
+            headers=headers,
+            stream=stream,
+            extensions=dict(),
+        )
+
+
+class Client(_Client):
+    def __init__(self, **kwargs) -> None:
+        super().__init__(**kwargs)
+        self.mount("file://", FileTransport())
+
+    def mount(self, protocol: str, transport: BaseTransport) -> None:
+        self._mounts.update({URLPattern(protocol): transport})
+
+
+class AsyncClient(_AsyncClient):
+    def __init__(self, **kwargs) -> None:
+        super().__init__(**kwargs)
+        self.mount("file://", FileTransport())
+
+    def mount(self, protocol: str, transport: AsyncBaseTransport) -> None:
+        self._mounts.update({URLPattern(protocol): transport})
+
+
+__all__ = ["FileTransport", "AsyncClient", "Client"]

pyzotero/zotero.py

@@ -44,6 +44,7 @@ from httpx import Request
 import pyzotero as pz
 
 from . import zotero_errors as ze
+from .filetransport import Client as File_Client
 
 # Avoid hanging the application if there's no server response
 timeout = 30
@@ -190,38 +191,9 @@ def retrieve(func):
             and self.content.search(str(self.request.url)).group(0)
             or "bib"
         )
-        # JSON by default
-        formats = {
-            "application/atom+xml": "atom",
-            "application/x-bibtex": "bibtex",
-            "application/json": "json",
-            "text/html": "snapshot",
-            "text/plain": "plain",
-            "application/pdf; charset=utf-8": "pdf",
-            "application/pdf": "pdf",
-            "application/msword": "doc",
-            "application/vnd.openxmlformats-officedocument.spreadsheetml.sheet": "xlsx",
-            "application/vnd.openxmlformats-officedocument.wordprocessingml.document": "docx",
-            "application/vnd.openxmlformats-officedocument.presentationml.presentation": "pptx",
-            "application/zip": "zip",
-            "application/epub+zip": "zip",
-            "audio/mpeg": "mp3",
-            "video/mp4": "mp4",
-            "audio/x-wav": "wav",
-            "video/x-msvideo": "avi",
-            "application/octet-stream": "octet",
-            "application/x-tex": "tex",
-            "application/x-texinfo": "texinfo",
-            "image/jpeg": "jpeg",
-            "image/png": "png",
-            "image/gif": "gif",
-            "image/tiff": "tiff",
-            "application/postscript": "postscript",
-            "application/rtf": "rtf",
-        }
         # select format, or assume JSON
         content_type_header = self.request.headers["Content-Type"].lower() + ";"
-        fmt = formats.get(
+        fmt = self.formats.get(
             # strip "; charset=..." segment
             content_type_header[0 : content_type_header.index(";")],
             "json",
@@ -321,12 +293,44 @@ class Zotero:
         self.tag_data = False
         self.request = None
         self.snapshot = False
-        self.client = httpx.Client(headers=self.default_headers())
+        self.client = httpx.Client(
+            headers=self.default_headers(), follow_redirects=True
+        )
         # these aren't valid item fields, so never send them to the server
         self.temp_keys = set(["key", "etag", "group_id", "updated"])
         # determine which processor to use for the parsed content
         self.fmt = re.compile(r"(?<=format=)\w+")
         self.content = re.compile(r"(?<=content=)\w+")
+        # JSON by default
+        self.formats = {
+            "application/atom+xml": "atom",
+            "application/x-bibtex": "bibtex",
+            "application/json": "json",
+            "text/html": "snapshot",
+            "text/plain": "plain",
+            "text/markdown": "plain",
+            "application/pdf; charset=utf-8": "pdf",
+            "application/pdf": "pdf",
+            "application/msword": "doc",
+            "application/vnd.openxmlformats-officedocument.spreadsheetml.sheet": "xlsx",
+            "application/vnd.openxmlformats-officedocument.wordprocessingml.document": "docx",
+            "application/vnd.openxmlformats-officedocument.presentationml.presentation": "pptx",
+            "application/zip": "zip",
+            "application/epub+zip": "zip",
+            "audio/mpeg": "mp3",
+            "video/mp4": "mp4",
+            "audio/x-wav": "wav",
+            "video/x-msvideo": "avi",
+            "application/octet-stream": "octet",
+            "application/x-tex": "tex",
+            "application/x-texinfo": "texinfo",
+            "image/jpeg": "jpeg",
+            "image/png": "png",
+            "image/gif": "gif",
+            "image/tiff": "tiff",
+            "application/postscript": "postscript",
+            "application/rtf": "rtf",
+        }
         self.processors = {
             "bib": self._bib_processor,
             "citation": self._citation_processor,
@@ -479,13 +483,28 @@ class Zotero:
         # Unfortunately, httpx doesn't like to merge query paramaters in the url string and passed params
         # so we strip the url params, combining them with our existing url_params
         final_url, final_params = merge_params(full_url, merged_params)
-        self.request = self.client.get(
-            url=final_url,
-            params=final_params,
-            headers=self.default_headers(),
-            timeout=timeout,
-        )
-        self.request.encoding = "utf-8"
+        # file URI errors are raised immediately so we have to try here
+        try:
+            self.request = self.client.get(
+                url=final_url,
+                params=final_params,
+                headers=self.default_headers(),
+                timeout=timeout,
+            )
+            self.request.encoding = "utf-8"
+        except httpx.UnsupportedProtocol:
+            # File URI handler logic
+            fc = File_Client()
+            request = fc.get(
+                url=final_url,
+                params=final_params,
+                headers=self.default_headers(),
+                timeout=timeout,
+                follow_redirects=True,
+            )
+            self.request = request
+            # since we'll be writing bytes, we need to set this to a type that will trigger the bytes processor
+            self.request.headers["Content-Type"] = "text/plain"
         try:
             self.request.raise_for_status()
         except httpx.HTTPError as exc:

{pyzotero-1.6.6.dist-info → pyzotero-1.6.8.dist-info}/METADATA

@@ -1,6 +1,6 @@
 Metadata-Version: 2.2
 Name: pyzotero
-Version: 1.6.6
+Version: 1.6.8
 Summary: Python wrapper for the Zotero API
 Author-email: Stephan Hügel <urschrei@gmail.com>
 License: # Blue Oak Model License
@@ -68,6 +68,7 @@ Requires-Dist: pytest>=7.4.2; extra == "test"
 Requires-Dist: httpretty; extra == "test"
 Requires-Dist: python-dateutil; extra == "test"
 Requires-Dist: ipython; extra == "test"
+Requires-Dist: pytest-asyncio; extra == "test"
 
 [![Supported Python versions](https://img.shields.io/pypi/pyversions/Pyzotero.svg?style=flat)](https://pypi.python.org/pypi/Pyzotero/) [![Docs](https://readthedocs.org/projects/pyzotero/badge/?version=latest)](http://pyzotero.readthedocs.org/en/latest/?badge=latest) [![PyPI Version](https://img.shields.io/pypi/v/Pyzotero.svg)](https://pypi.python.org/pypi/Pyzotero) [![Anaconda-Server Badge](https://anaconda.org/conda-forge/pyzotero/badges/version.svg)](https://anaconda.org/conda-forge/pyzotero) [![Downloads](https://pepy.tech/badge/pyzotero)](https://pepy.tech/project/pyzotero)  
 

pyzotero-1.6.8.dist-info/RECORD

@@ -0,0 +1,11 @@
+_version.py,sha256=cmsiv9CCkKr77S4CsQCya3nhc7DDRNXIH_h8pHWpeYE,411
+pyzotero/__init__.py,sha256=5QI4Jou9L-YJAf_oN9TgRXVKgt_Unc39oADo2Ch8bLI,243
+pyzotero/filetransport.py,sha256=FSdKYYX8ITFhSzqagX8U3y-SalH1aThtedDje42v3oA,5537
+pyzotero/zotero.py,sha256=8oxenEitZ-Btca5jy82y39rJcNYmnY6cxiKY2uU4MwM,77347
+pyzotero/zotero_errors.py,sha256=UPhAmf2K05cnoeIl2wjufWQedepg7vBKb-ShU0TdlL4,2582
+pyzotero-1.6.8.dist-info/AUTHORS,sha256=ZMicxg7lRScOYbxzMPznlzMbmrFIUIHwg-NvljEMbRQ,110
+pyzotero-1.6.8.dist-info/LICENSE.md,sha256=bhy1CPMj1zWffD9YifFmSeBzPylsrhb1qP8OCEx5Etw,1550
+pyzotero-1.6.8.dist-info/METADATA,sha256=js6NjlnRvg6OzTSa1UNAv6yCD9V4sBClAxhz8v1ao_8,7337
+pyzotero-1.6.8.dist-info/WHEEL,sha256=In9FTNxeP60KnTkGw7wk6mJPYd_dQSjEZmXdBdMCI-8,91
+pyzotero-1.6.8.dist-info/top_level.txt,sha256=BOPNkPk5VtNDCy_li7Xftx6k0zG8STGxh-KgckcxLEw,18
+pyzotero-1.6.8.dist-info/RECORD,,

pyzotero-1.6.6.dist-info/RECORD

@@ -1,10 +0,0 @@
-_version.py,sha256=Nz1l8vGPOAOAlxWDepNu28nfH9fOKk0GnGSnVyZJsFE,411
-pyzotero/__init__.py,sha256=5QI4Jou9L-YJAf_oN9TgRXVKgt_Unc39oADo2Ch8bLI,243
-pyzotero/zotero.py,sha256=9mwSEa3Z97Bdni9p_yMqeKBEYQFUvRdwFJAIaf0gg5A,76539
-pyzotero/zotero_errors.py,sha256=UPhAmf2K05cnoeIl2wjufWQedepg7vBKb-ShU0TdlL4,2582
-pyzotero-1.6.6.dist-info/AUTHORS,sha256=ZMicxg7lRScOYbxzMPznlzMbmrFIUIHwg-NvljEMbRQ,110
-pyzotero-1.6.6.dist-info/LICENSE.md,sha256=bhy1CPMj1zWffD9YifFmSeBzPylsrhb1qP8OCEx5Etw,1550
-pyzotero-1.6.6.dist-info/METADATA,sha256=fw5aXyuKKiBOUD74CbxLzmDDZcqw-E9XBV-HNecB0W8,7290
-pyzotero-1.6.6.dist-info/WHEEL,sha256=In9FTNxeP60KnTkGw7wk6mJPYd_dQSjEZmXdBdMCI-8,91
-pyzotero-1.6.6.dist-info/top_level.txt,sha256=BOPNkPk5VtNDCy_li7Xftx6k0zG8STGxh-KgckcxLEw,18
-pyzotero-1.6.6.dist-info/RECORD,,