pyzotero 1.6.15__tar.gz → 1.6.17__tar.gz

{pyzotero-1.6.15 → pyzotero-1.6.17}/PKG-INFO

@@ -1,6 +1,6 @@
 Metadata-Version: 2.3
 Name: pyzotero
-Version: 1.6.15
+Version: 1.6.17
 Summary: Python wrapper for the Zotero API
 Keywords: Zotero,DH
 Author: Stephan Hügel
@@ -86,7 +86,7 @@ items = zot.top(limit=5)
 # we've retrieved the latest five top-level items in our library
 # we can print each item's item type and ID
 for item in items:
-    print('Item: %s | Key: %s' % (item['data']['itemType'], item['data']['key']))
+    print(f"Item: {item['data']['itemType']} | Key: {item['data']['key']}")
 ```
 
 # Documentation
@@ -95,8 +95,9 @@ Full documentation of available Pyzotero methods, code examples, and sample outp
 
 # Installation
 
-* Using [pip][10]: `pip install pyzotero` (it's available as a wheel, and is tested on Python 3.7 and up)
-* Using Anaconda:`conda config --add channels conda-forge && conda install pyzotero`
+* Using [uv][11]: `uv add pyzotero`
+* Using [pip][10]: `pip install pyzotero`
+* Using Anaconda:`conda install conda-forge::pyzotero`
 * From a local clone, if you wish to install Pyzotero from a specific branch: 
 
 Example:
@@ -105,12 +106,13 @@ Example:
 git clone git://github.com/urschrei/pyzotero.git
 cd pyzotero
 git checkout main
-pip install .
+# specify --dev if you're planning on running tests
+uv sync
 ```
 
 ## Testing
 
-Run `pytest .` from the top-level directory.
+Run `pytest .` from the top-level directory. This requires the `dev` dependency group to be installed: `uv sync --dev` / `pip install --group dev`
 
 ## Issues
 
@@ -118,14 +120,13 @@ The latest commits can be found on the [main branch][9], although new features a
 
 ## Pull Requests
 
-Pull requests are welcomed. Please read the [contribution guidelines](CONTRIBUTING.md). In particular, please **base your PR on the `dev` branch**.
+Pull requests are welcomed. Please read the [contribution guidelines](CONTRIBUTING.md). In particular, please **base your PR on the `main` branch**.
 
 ## Versioning
 
 As of v1.0.0, Pyzotero is versioned according to [Semver](http://semver.org); version increments are performed as follows:  
 
 
-
 1. MAJOR version will increment with incompatible API changes,
 2. MINOR version will increment when functionality is added in a backwards-compatible manner, and
 3. PATCH version will increment with backwards-compatible bug fixes.
@@ -149,5 +150,6 @@ Pyzotero is licensed under the [Blue Oak Model Licence 1.0.0][8]. See [LICENSE.m
 [8]: https://opensource.org/license/blue-oak-model-license
 [9]: https://github.com/urschrei/pyzotero/tree/main
 [10]: http://www.pip-installer.org/en/latest/index.html
+[11]: https://docs.astral.sh/uv
 † This isn't strictly true: you only need an API key for personal libraries and non-public group libraries.
 

{pyzotero-1.6.15 → pyzotero-1.6.17}/README.md

@@ -21,7 +21,7 @@ items = zot.top(limit=5)
 # we've retrieved the latest five top-level items in our library
 # we can print each item's item type and ID
 for item in items:
-    print('Item: %s | Key: %s' % (item['data']['itemType'], item['data']['key']))
+    print(f"Item: {item['data']['itemType']} | Key: {item['data']['key']}")
 ```
 
 # Documentation
@@ -30,8 +30,9 @@ Full documentation of available Pyzotero methods, code examples, and sample outp
 
 # Installation
 
-* Using [pip][10]: `pip install pyzotero` (it's available as a wheel, and is tested on Python 3.7 and up)
-* Using Anaconda:`conda config --add channels conda-forge && conda install pyzotero`
+* Using [uv][11]: `uv add pyzotero`
+* Using [pip][10]: `pip install pyzotero`
+* Using Anaconda:`conda install conda-forge::pyzotero`
 * From a local clone, if you wish to install Pyzotero from a specific branch: 
 
 Example:
@@ -40,12 +41,13 @@ Example:
 git clone git://github.com/urschrei/pyzotero.git
 cd pyzotero
 git checkout main
-pip install .
+# specify --dev if you're planning on running tests
+uv sync
 ```
 
 ## Testing
 
-Run `pytest .` from the top-level directory.
+Run `pytest .` from the top-level directory. This requires the `dev` dependency group to be installed: `uv sync --dev` / `pip install --group dev`
 
 ## Issues
 
@@ -53,14 +55,13 @@ The latest commits can be found on the [main branch][9], although new features a
 
 ## Pull Requests
 
-Pull requests are welcomed. Please read the [contribution guidelines](CONTRIBUTING.md). In particular, please **base your PR on the `dev` branch**.
+Pull requests are welcomed. Please read the [contribution guidelines](CONTRIBUTING.md). In particular, please **base your PR on the `main` branch**.
 
 ## Versioning
 
 As of v1.0.0, Pyzotero is versioned according to [Semver](http://semver.org); version increments are performed as follows:  
 
 
-
 1. MAJOR version will increment with incompatible API changes,
 2. MINOR version will increment when functionality is added in a backwards-compatible manner, and
 3. PATCH version will increment with backwards-compatible bug fixes.
@@ -84,5 +85,6 @@ Pyzotero is licensed under the [Blue Oak Model Licence 1.0.0][8]. See [LICENSE.m
 [8]: https://opensource.org/license/blue-oak-model-license
 [9]: https://github.com/urschrei/pyzotero/tree/main
 [10]: http://www.pip-installer.org/en/latest/index.html
+[11]: https://docs.astral.sh/uv
 † This isn't strictly true: you only need an API key for personal libraries and non-public group libraries.
 

{pyzotero-1.6.15 → pyzotero-1.6.17}/doc/index.rst

@@ -37,7 +37,7 @@ Getting started (short version)
             # we've retrieved the latest five top-level items in our library
             # we can print each item's item type and ID
             for item in items:
-            print('Item Type: %s | Key: %s' % (item['data']['itemType'], item['data']['key']))
+            print(f"Item: {item['data']['itemType']} | Key: {item['data']['key']}")
 
 Refer to the :ref:`read` and :ref:`write`.
 

{pyzotero-1.6.15 → pyzotero-1.6.17}/pyproject.toml

@@ -1,6 +1,6 @@
 [project]
 name = "pyzotero"
-version = "1.6.15"
+version = "1.6.17"
 description = "Python wrapper for the Zotero API"
 readme = "README.md"
 requires-python = ">=3.9"

{pyzotero-1.6.15 → pyzotero-1.6.17}/src/pyzotero/zotero.py

@@ -43,10 +43,9 @@ from .filetransport import Client as File_Client
 # Avoid hanging the application if there's no server response
 timeout = 30
 
-NOT_MODIFIED = 304
 ONE_HOUR = 3600
 DEFAULT_NUM_ITEMS = 50
-TOO_MANY_REQUESTS = 429
+DEFAULT_ITEM_LIMIT = 100
 
 
 def build_url(base_url, path, args_dict=None):
@@ -450,8 +449,6 @@ class Zotero:
         Returns a JSON document
         """
         full_url = build_url(self.endpoint, request)
-        # The API doesn't return this any more, so we have to cheat
-        self.self_link = request
         # ensure that we wait if there's an active backoff
         self._check_backoff()
         # don't set locale if the url already contains it
@@ -470,7 +467,7 @@ class Zotero:
             params = {}
         if not self.url_params:
             self.url_params = {}
-        merged_params = {**params, **self.url_params}
+        merged_params = {**self.url_params, **params}
         # our incoming url might be from the "links" dict, in which case it will contain url parameters.
         # 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
@@ -484,6 +481,8 @@ class Zotero:
                 timeout=timeout,
             )
             self.request.encoding = "utf-8"
+            # The API doesn't return this any more, so we have to cheat
+            self.self_link = self.request.url
         except httpx.UnsupportedProtocol:
             # File URI handler logic
             fc = File_Client()
@@ -517,15 +516,12 @@ class Zotero:
                 fragment = f"{parsed[2]}?{parsed[4]}"
                 extracted[key] = fragment
             # add a 'self' link
-            parsed = list(urlparse(self.self_link))
-            # strip 'format' query parameter
-            stripped = "&".join(
-                ["=".join(p) for p in parse_qsl(parsed[4])[:2] if p[0] != "format"],
-            )
-            # rebuild url fragment
-            # this is a death march
+            parsed = urlparse(str(self.self_link))
+            # strip 'format' query parameter and rebuild query string
+            query_params = [(k, v) for k, v in parse_qsl(parsed.query) if k != "format"]
+            # rebuild url fragment with just path and query (consistent with other links)
             extracted["self"] = urlunparse(
-                [parsed[0], parsed[1], parsed[2], parsed[3], stripped, parsed[5]],
+                ("", "", parsed.path, "", urlencode(query_params), "")
             )
         except KeyError:
             # No links present, because it's a single item
@@ -571,7 +567,7 @@ class Zotero:
             )
             if backoff:
                 self._set_backoff(backoff)
-            return req.status_code == NOT_MODIFIED
+            return req.status_code == httpx.codes.NOT_MODIFIED
         # Still plenty of life left in't
         return False
 
@@ -580,7 +576,13 @@ class Zotero:
 
         Also ensure that only valid format/content combinations are requested
         """
-        self.url_params = None
+        # Preserve constructor-level parameters (like locale) while allowing method-level overrides
+        if self.url_params is None:
+            self.url_params = {}
+
+        # Store existing params to preserve things like locale
+        preserved_params = self.url_params.copy()
+
         # we want JSON by default
         if not params.get("format"):
             params["format"] = "json"
@@ -589,7 +591,7 @@ class Zotero:
             params["format"] = "atom"
         # TODO: rewrite format=atom, content=json request
         if "limit" not in params or params.get("limit") == 0:
-            params["limit"] = 100
+            params["limit"] = DEFAULT_ITEM_LIMIT
         # Need ability to request arbitrary number of results for version
         # response
         # -1 value is hack that works with current version
@@ -597,8 +599,10 @@ class Zotero:
             del params["limit"]
         # bib format can't have a limit
         if params.get("format") == "bib":
-            del params["limit"]
-        self.url_params = params
+            params.pop("limit", None)
+
+        # Merge preserved params with new params (new params override existing ones)
+        self.url_params = {**preserved_params, **params}
 
     def _build_query(self, query_string, no_params=False):
         """Set request parameters. Will always add the user ID if it hasn't
@@ -1638,7 +1642,7 @@ def error_handler(zot, req, exc=None):
 
     if error_codes.get(req.status_code):
         # check to see whether its 429
-        if req.status_code == TOO_MANY_REQUESTS:
+        if req.status_code == httpx.codes.TOO_MANY_REQUESTS:
             # try to get backoff or delay duration
             delay = req.headers.get("backoff") or req.headers.get("retry-after")
             if not delay:

{pyzotero-1.6.15 → pyzotero-1.6.17}/tests/test_zotero.py

@@ -21,9 +21,10 @@ from httpretty import HTTPretty
 
 try:
     from pyzotero.pyzotero import zotero as z
+    from pyzotero.pyzotero.zotero import DEFAULT_ITEM_LIMIT
 except ModuleNotFoundError:
     from pyzotero import zotero as z
-
+    from pyzotero.zotero import DEFAULT_ITEM_LIMIT
 from urllib.parse import urlencode
 
 
@@ -88,7 +89,7 @@ class ZoteroTests(unittest.TestCase):
         zot = z.Zotero("myuserID", "user", "myuserkey")
         zot.add_parameters(limit=0, start=7)
         self.assertEqual(
-            parse_qs("start=7&limit=100&format=json"),
+            parse_qs(f"start=7&limit={DEFAULT_ITEM_LIMIT}&format=json"),
             parse_qs(urlencode(zot.url_params, doseq=True)),
         )
 
@@ -104,7 +105,26 @@ class ZoteroTests(unittest.TestCase):
         zot = z.Zotero("myuserID", "user", "myuserkey")
         _ = zot.items()
         req = zot.request
-        self.assertEqual(str(req.url).find("locale"), 44)
+        self.assertIn("locale=en-US", str(req.url))
+
+    @httpretty.activate
+    def testLocalePreservedWithMethodParams(self):
+        """Should preserve locale when methods provide their own parameters"""
+        HTTPretty.register_uri(
+            HTTPretty.GET,
+            "https://api.zotero.org/users/myuserID/items/top",
+            content_type="application/json",
+            body=self.items_doc,
+        )
+        # Test with non-default locale
+        zot = z.Zotero("myuserID", "user", "myuserkey", locale="de-DE")
+        # Call top() with limit which internally adds parameters
+        _ = zot.top(limit=1)
+        req = zot.request
+        # Check that locale is preserved in the URL
+        self.assertIn("locale=de-DE", str(req.url))
+        # Also verify the method parameter is present
+        self.assertIn("limit=1", str(req.url))
 
     @httpretty.activate
     def testRequestBuilderLimitNone(self):
@@ -368,9 +388,13 @@ class ZoteroTests(unittest.TestCase):
             body=self.tags_doc,
         )
         _ = zot.tags(limit=1)
-        self.assertEqual(
-            "https://api.zotero.org/users/myuserID/tags?locale=en-US&limit=1&format=json",
-            zot.request.url,
+        # Check that all expected parameters are present
+        url_str = str(zot.request.url)
+        self.assertIn("locale=en-US", url_str)
+        self.assertIn("limit=1", url_str)
+        self.assertIn("format=json", url_str)
+        self.assertTrue(
+            url_str.startswith("https://api.zotero.org/users/myuserID/tags?")
         )
 
     @httpretty.activate
@@ -391,6 +415,27 @@ class ZoteroTests(unittest.TestCase):
         self.assertEqual(zot.links["last"], "/users/436/items/top?limit=1&start=2319")
         self.assertEqual(zot.links["alternate"], "/users/436/items/top?")
 
+    @httpretty.activate
+    def testParseLinkHeadersPreservesAllParameters(self):
+        """Test that the self link preserves all parameters, not just the first 2"""
+        zot = z.Zotero("myuserID", "user", "myuserkey")
+        HTTPretty.register_uri(
+            HTTPretty.GET,
+            "https://api.zotero.org/users/myuserID/items/top",
+            content_type="application/json",
+            body=self.items_doc,
+            adding_headers={
+                "Link": '<https://api.zotero.org/users/myuserID/items/top?start=1>; rel="next"'
+            },
+        )
+        # Call with multiple parameters including limit
+        zot.top(limit=1)
+        # The self link should preserve all parameters except format
+        self.assertIn("limit=1", zot.links["self"])
+        self.assertIn("locale=", zot.links["self"])
+        # format should be stripped
+        self.assertNotIn("format=", zot.links["self"])
+
     @httpretty.activate
     def testParseGroupsJSONDoc(self):
         """Should successfully return a list of group dicts, ID should match
@@ -408,15 +453,14 @@ class ZoteroTests(unittest.TestCase):
         self.assertEqual("smart_cities", groups_data[0]["data"]["name"])
 
     def testParamsReset(self):
-        """Should successfully reset URL parameters after a query string
-        is built
-        """
+        """Should preserve existing URL parameters when add_parameters is called multiple times"""
         zot = z.Zotero("myuserID", "user", "myuserkey")
         zot.add_parameters(start=5, limit=10)
         zot._build_query("/whatever")
         zot.add_parameters(start=2)
+        # Should get default limit=100 since no limit specified in second call
         self.assertEqual(
-            parse_qs("start=2&format=json&limit=100"),
+            parse_qs(f"start=2&format=json&limit={DEFAULT_ITEM_LIMIT}"),
             parse_qs(urlencode(zot.url_params, doseq=True)),
         )
 
@@ -1591,6 +1635,27 @@ class ZoteroTests(unittest.TestCase):
             # Verify the mock was called
             mock_iterfollow.assert_called_once()
 
+    def test_makeiter_preserves_limit_parameter(self):
+        """Test that makeiter preserves the limit parameter in the self link"""
+        zot = z.Zotero("myuserID", "user", "myuserkey")
+
+        # Simulate a self link with multiple parameters including limit
+        # This mimics what _extract_links() creates
+        test_self_link = "/users/myuserID/items/top?limit=1&locale=en-US"
+        zot.links = {
+            "self": test_self_link,
+            "next": "/users/myuserID/items/top?start=1",
+        }
+
+        # Call makeiter (with a dummy function since we're testing link manipulation)
+        with patch.object(zot, "iterfollow"):
+            zot.makeiter(lambda: None)
+
+        # Verify that the 'next' link was set to 'self' and still contains limit parameter
+        self.assertEqual(zot.links["next"], test_self_link)
+        self.assertIn("limit=1", zot.links["next"])
+        self.assertIn("locale=en-US", zot.links["next"])
+
     @httpretty.activate
     def test_publications_user(self):
         """Test the publications method for user libraries"""