python3-discogs-client 2.7.1__tar.gz → 2.9__tar.gz

{python3_discogs_client-2.7.1 → python3_discogs_client-2.9}/PKG-INFO

@@ -1,6 +1,6 @@
-Metadata-Version: 2.1
+Metadata-Version: 2.4
 Name: python3-discogs-client
-Version: 2.7.1
+Version: 2.9
 Summary: Python API client for Discogs
 Home-page: https://github.com/joalla/discogs_client
 Author: joalla
@@ -21,5 +21,14 @@ Provides-Extra: docs
 Requires-Dist: sphinx; extra == "docs"
 Requires-Dist: pydata-sphinx-theme; extra == "docs"
 Requires-Dist: myst-parser; extra == "docs"
+Dynamic: author
+Dynamic: author-email
+Dynamic: classifier
+Dynamic: description
+Dynamic: home-page
+Dynamic: license-file
+Dynamic: provides-extra
+Dynamic: requires-dist
+Dynamic: summary
 
 This is an active fork of the official "Discogs API client for Python", which was deprecated by discogs.com as of June 2020. We think it is a very useful Python module and decided to continue maintaining it. Please visit: https://github.com/joalla/discogs_client for more information.

{python3_discogs_client-2.7.1 → python3_discogs_client-2.9}/discogs_client/__init__.py

@@ -1,4 +1,4 @@
-__version__ = '2.7.1'
+__version__ = '2.9'
 __version_info__ = tuple(int(i) for i in __version__.split('.') if i.isdigit())
 
 from discogs_client.client import Client

{python3_discogs_client-2.7.1 → python3_discogs_client-2.9}/discogs_client/client.py

@@ -19,6 +19,7 @@ class Client:
         self.user_agent = user_agent
         self.verbose = False
         self._fetcher = RequestsFetcher()
+        self._trust_per_page = True  # Default: True
 
         if consumer_key and consumer_secret:
             self.set_consumer_key(consumer_key, consumer_secret)
@@ -219,3 +220,13 @@ class Client:
         """
         self._fetcher.connect_timeout = connect
         self._fetcher.read_timeout = read
+
+    @property
+    def trust_per_page(self) -> bool:
+        return self._trust_per_page
+
+    @trust_per_page.setter
+    def trust_per_page(self, value: bool) -> None:
+        if not isinstance(value, bool):
+            raise ValueError("trust_per_page must be a bool")
+        self._trust_per_page = value

{python3_discogs_client-2.7.1 → python3_discogs_client-2.9}/discogs_client/models.py

@@ -354,18 +354,42 @@ class BasePaginatedResponse:
         return item
 
     def __getitem__(self, index):
-        page_index = index // self.per_page + 1
-        offset = index % self.per_page
+        """Retrieve an item by its index.
 
-        try:
-            page = self.page(page_index)
-        except HTTPError as e:
-            if e.status_code == 404:
-                raise IndexError(e.msg)
-            else:
+        By default, uses the API's ``per_page`` value to calculate the page
+        containing the item directly. If the API returns fewer items per page
+        than reported, this may yield incorrect results — set
+        ``client.trust_per_page = False`` to fall back to a sequential page
+        walk at the cost of performance.
+        """
+        if self.client._trust_per_page:
+            page_index = index // self.per_page + 1
+            offset = index % self.per_page
+
+            try:
+                page = self.page(page_index)
+            except HTTPError as e:
+                if e.status_code == 404:
+                    raise IndexError(e.msg) from e
+                raise
+
+            return page[offset]
+
+        # Fallback to sequential page loading if we're not trusting the per_page parameter
+        current = 0
+        page_index = 1
+        while True:
+            try:
+                page = self.page(page_index)
+            except HTTPError as e:
+                if e.status_code == 404:
+                    raise IndexError(e.msg) from e
                 raise
+            if current + len(page) > index:
+                return page[index - current]
+            current += len(page)
+            page_index += 1
 
-        return page[offset]
 
     def __len__(self):
         return self.count
@@ -745,7 +769,7 @@ class CollectionFolder(PrimaryAPIObject):
     count = SimpleField()  #:
 
     def __init__(self, client, dict_):
-        super(CollectionFolder, self).__init__(client, dict_)
+        super().__init__(client, dict_)
 
     @property
     def releases(self):
@@ -754,14 +778,34 @@ class CollectionFolder(PrimaryAPIObject):
 
     def add_release(self, release):
         release_id = release.id if isinstance(release, Release) else release
-        add_release_url = self.fetch('resource_url') + '/releases/{}'.format(release_id)
-        self.client._post(add_release_url, None)
+        resource_url = self.fetch('resource_url')
+        self.client._post(f"{resource_url}/releases/{release_id}", None)
 
     def remove_release(self, instance):
+        """Remove a collection item entirely.
+        """
         if not isinstance(instance, CollectionItemInstance):
             raise TypeError('instance must be of type CollectionItemInstance')
-        instance_url = self.fetch('resource_url') + '/releases/{0}/instances/{1}'.format(instance.id, instance.instance_id)
-        self.client._delete(instance_url)
+        resource_url = self.fetch('resource_url')
+        self.client._delete(f"{resource_url}/releases/{instance.id}/instances/{instance.instance_id}")
+
+    def move_release(self, instance, target_folder_id):
+        """Move a collection item to another folder.
+
+        Moving to folder id 1 moves to the "Uncategorized" folder.
+        """
+        if not isinstance(instance, CollectionItemInstance):
+            raise TypeError('instance must be of type CollectionItemInstance')
+        resource_url = self.fetch('resource_url')
+        self.client._post(
+            f"{resource_url}/releases/{instance.id}/instances/{instance.instance_id}",
+            {"folder_id": target_folder_id},
+        )
+
+    def uncategorize_release(self, instance):
+        """Move a collection item to the "Uncategorized" folder.
+        """
+        self.move_release(instance, 1)
 
     def __repr__(self):
         return '<CollectionFolder {0!r} {1!r}>'.format(self.id, self.name)

{python3_discogs_client-2.7.1 → python3_discogs_client-2.9}/discogs_client/tests/test_core.py

@@ -111,6 +111,46 @@ class CoreTestCase(DiscogsClientTestCase):
         results.per_page = 10
         self.assertTrue(results._num_pages is None)
 
+    def test_pagination_index_without_trust_per_page_and_short_pages(self):
+        """Without trust_per_page, sequential page walking handles under-filled pages correctly."""
+        client = Client('ua')
+        client.trust_per_page = False  # opt into sequential walk
+        client._base_url = ''
+        client._trust_per_page = False
+        client._fetcher = MemoryFetcher({
+            '/artists/1': (
+                b'{"id": 1, "name": "Badger", "releases_url": "/artists/1/releases"}',
+                200,
+            ),
+            '/artists/1/releases?page=1&per_page=50': (
+                b'{"pagination": {"per_page": 50, "pages": 3, "items": 5}, '
+                b'"releases": ['
+                b'{"id": 101, "type": "release", "title": "A"},'
+                b'{"id": 102, "type": "release", "title": "B"}'
+                b']}',
+                200,
+            ),
+            '/artists/1/releases?page=2&per_page=50': (
+                b'{"pagination": {"per_page": 50, "pages": 3, "items": 5}, '
+                b'"releases": [{"id": 103, "type": "release", "title": "C"}]}',
+                200,
+            ),
+            '/artists/1/releases?page=3&per_page=50': (
+                b'{"pagination": {"per_page": 50, "pages": 3, "items": 5}, '
+                b'"releases": ['
+                b'{"id": 104, "type": "release", "title": "D"},'
+                b'{"id": 105, "type": "release", "title": "E"}'
+                b']}',
+                200,
+            ),
+        })
+
+        results = client.artist(1).releases
+        self.assertEqual(results[0].id, 101)  # page 1
+        self.assertEqual(results[2].id, 103)  # page 2, cross-page
+        self.assertEqual(results[4].id, 105)  # page 3, last item
+        self.assertRaises(IndexError, lambda: results[5])
+
     def test_timeout_defaults_to_none(self):
         # Need to create client without LoggingDelegator here
         # self.d would throw AttributeError trying to access timeout properties on LoggingDelegator

{python3_discogs_client-2.7.1 → python3_discogs_client-2.9}/discogs_client/tests/test_models.py

@@ -1,5 +1,5 @@
 import unittest
-from discogs_client.models import Artist, Release, ListItem, CollectionValue
+from discogs_client.models import Artist, Release, ListItem, CollectionValue, CollectionItemInstance
 from discogs_client.tests import DiscogsClientTestCase
 from discogs_client.exceptions import HTTPError
 
@@ -265,7 +265,6 @@ class ModelsTestCase(DiscogsClientTestCase):
         self.assertEqual(method, 'GET')
         self.assertEqual(url, '/marketplace/listings/150899904')
 
-
     def test_collection(self):
         """Collection folders can be manipulated"""
         # Fetch the users collection folders from the filesystem
@@ -314,6 +313,41 @@ class ModelsTestCase(DiscogsClientTestCase):
         self.assertEqual(method, 'POST')
         self.assertEqual(url, '/users/example/collection/folders/1/releases/1')
 
+    def test_collection_move_release(self):
+        """Collection items can be moved to another folder"""
+        # Fetch the users collection folders from the filesystem
+        u = self.d.user("example")
+        self.assertEqual(u.collection_folders[2].id, 2)
+
+        # Mock expected responses for move_release test using "MemoryFetcher"
+        self.m._fetcher.fetcher.responses = {
+            "/users/example/collection/folders": (b'''
+                {"folders": [
+                    {"resource_url": "/users/example/collection/folders/0", "id": 0, "name": "All"},
+                    {"resource_url": "/users/example/collection/folders/1", "id": 1, "name": "Uncategorized folder"},
+                    {"resource_url": "/users/example/collection/folders/2", "id": 2, "name": "Collection folder 2"}
+                ]}
+            ''', 200),
+            # Mock the response of the POST request to the instance resource URL
+            "/users/example/collection/folders/1/releases/123456/instances/123": (b"", 204),
+        }
+
+        # Bind the user to the MemoryFetcher
+        u.client = self.m
+
+        # Mock a collection item instance
+        instance = CollectionItemInstance(
+            client=u.client,
+            dict_={"id": 123456, "instance_id": 123}
+        )
+        # Perform the move
+        u.collection_folders[1].move_release(instance, 2)
+
+        # Verify
+        method, url, _, _ = self.m._fetcher.last_request
+        self.assertEqual(method, "POST")
+        self.assertEqual(url, "/users/example/collection/folders/1/releases/123456/instances/123")
+
     def test_delete_object(self):
         """Can request DELETE on an APIObject"""
         u = self.d.user('example')

{python3_discogs_client-2.7.1 → python3_discogs_client-2.9}/python3_discogs_client.egg-info/PKG-INFO

@@ -1,6 +1,6 @@
-Metadata-Version: 2.1
+Metadata-Version: 2.4
 Name: python3-discogs-client
-Version: 2.7.1
+Version: 2.9
 Summary: Python API client for Discogs
 Home-page: https://github.com/joalla/discogs_client
 Author: joalla
@@ -21,5 +21,14 @@ Provides-Extra: docs
 Requires-Dist: sphinx; extra == "docs"
 Requires-Dist: pydata-sphinx-theme; extra == "docs"
 Requires-Dist: myst-parser; extra == "docs"
+Dynamic: author
+Dynamic: author-email
+Dynamic: classifier
+Dynamic: description
+Dynamic: home-page
+Dynamic: license-file
+Dynamic: provides-extra
+Dynamic: requires-dist
+Dynamic: summary
 
 This is an active fork of the official "Discogs API client for Python", which was deprecated by discogs.com as of June 2020. We think it is a very useful Python module and decided to continue maintaining it. Please visit: https://github.com/joalla/discogs_client for more information.

{python3_discogs_client-2.7.1 → python3_discogs_client-2.9}/setup.py

@@ -4,7 +4,7 @@ from setuptools import setup
 
 setup(
         name='python3-discogs-client',
-        version='2.7.1',
+        version='2.9',
         description='Python API client for Discogs',
         long_description='This is an active fork of the official "Discogs API client for Python", which was deprecated by discogs.com as of June 2020. We think it is a very useful Python module and decided to continue maintaining it. Please visit: https://github.com/joalla/discogs_client for more information.',
         url='https://github.com/joalla/discogs_client',