rename fetch_doi to fetch_doi_prefix

Author: philerooski

src/datacite/__init__.py

@@ -1,10 +1,10 @@
 """DataCite utilities package."""
 from .datacite import (
-    fetch_doi,
+    fetch_doi_prefix,
     write_ndjson_gz,
 )
 
 __all__ = [
-    "fetch_doi",
+    "fetch_doi_prefix",
     "write_ndjson_gz",
 ]

src/datacite/datacite.py

@@ -5,11 +5,11 @@
 It handles pagination, retry logic, and efficient streaming to minimize memory usage.
 
 Primary Entrypoint:
-    fetch_doi: Iterator that automatically fetches all DOI objects matching the
+    fetch_doi_prefix: Iterator that automatically fetches all DOI objects matching the
         specified criteria. This is the main function most users will need.
 
 Public Functions:
-    fetch_doi: Fetch all DOI objects from DataCite API with automatic pagination.
+    fetch_doi_prefix: Fetch all DOI objects from DataCite API with automatic pagination.
         Returns an iterator yielding individual DOI objects. Handles session
         management and pagination transparently.
 
@@ -19,10 +19,10 @@
 Example:
     Basic usage to fetch and save Synapse DOIs:
 
-        >>> from datacite import fetch_doi, write_ndjson_gz
+        >>> from datacite import fetch_doi_prefix, write_ndjson_gz
         >>> 
         >>> # Fetch all findable DOIs with prefix 10.7303
-        >>> dois = fetch_doi(
+        >>> dois = fetch_doi_prefix(
         ...     prefixes=["10.7303"],
         ...     state="findable",
         ...     user_agent_mailto="user@example.com"
@@ -271,7 +271,7 @@ def _fetch_doi_page(
     return result
 
 
-def fetch_doi(
+def fetch_doi_prefix(
     prefixes: List[str],
     state: str = "findable",
     page_size: int = 1000,
@@ -302,7 +302,7 @@ def fetch_doi(
         requests.HTTPError: If any API request fails with non-retryable error.
 
     Example:
-        >>> for doi in fetch_doi(["10.7303"], user_agent_mailto="user@example.com"):
+        >>> for doi in fetch_doi_prefix(["10.7303"], user_agent_mailto="user@example.com"):
         ...     print(doi["id"])
     """
     _validate_fetch_params(page_size, state)

tests/datacite/test_datacite.py

@@ -25,7 +25,7 @@
     _should_continue_pagination,
     _serialize_to_ndjson,
     _fetch_doi_page,
-    fetch_doi,
+    fetch_doi_prefix,
     write_ndjson_gz,
 )
 
@@ -710,7 +710,7 @@ def test_valid_states(self, prefixes, state, create_mock_response):
 
 
 class TestFetchDoi:
-    """Tests for fetch_doi function.
+    """Tests for fetch_doi_prefix function.
     
     Tests full pagination flow with generator behavior.
     """
@@ -723,7 +723,7 @@ def test_single_full_page(self, prefixes, sample_doi_objects, mocker):
             {"data": []}  # Empty next page
         ]
 
-        results = list(fetch_doi(
+        results = list(fetch_doi_prefix(
             prefixes=prefixes,
             state="findable",
             page_size=10,
@@ -749,7 +749,7 @@ def test_multiple_pages(self, prefixes, mocker):
             {"data": page3_data},  # Partial page - should stop
         ]
 
-        results = list(fetch_doi(
+        results = list(fetch_doi_prefix(
             prefixes=prefixes,
             state="findable",
             page_size=10,
@@ -765,7 +765,7 @@ def test_empty_results(self, prefixes, mocker):
         mock_fetch_page = mocker.patch("src.datacite.datacite._fetch_doi_page")
         mock_fetch_page.return_value = {"data": []}
 
-        results = list(fetch_doi(
+        results = list(fetch_doi_prefix(
             prefixes=prefixes,
             state="findable",
             page_size=10,
@@ -789,7 +789,7 @@ def test_user_agent_header_set(self, prefixes, mocker):
             mock_update = MagicMock()
             mock_session.headers.update = mock_update
 
-            list(fetch_doi(
+            list(fetch_doi_prefix(
                 prefixes=prefixes,
                 state="findable",
                 page_size=10,
@@ -807,7 +807,7 @@ def test_start_page_parameter(self, prefixes, mocker):
         mock_fetch_page = mocker.patch("src.datacite.datacite._fetch_doi_page")
         mock_fetch_page.return_value = {"data": [{"id": "test"}]}
 
-        list(fetch_doi(
+        list(fetch_doi_prefix(
             prefixes=prefixes,
             state="findable",
             page_size=10,
@@ -830,7 +830,7 @@ def test_stops_on_partial_page(self, prefixes, mocker):
             {"data": page2_data}
         ]
 
-        results = list(fetch_doi(
+        results = list(fetch_doi_prefix(
             prefixes=prefixes,
             page_size=10
         ))
@@ -850,7 +850,7 @@ def test_handles_api_error_mid_pagination(self, prefixes, mocker):
         ]
 
         with pytest.raises(requests.HTTPError):
-            list(fetch_doi(
+            list(fetch_doi_prefix(
                 prefixes=prefixes,
                 page_size=10
             ))
@@ -861,7 +861,7 @@ def test_response_with_missing_data_key(self, prefixes, mocker):
         # API returns response without 'data' key
         mock_fetch_page.return_value = {"meta": {"total": 0}, "links": {}}
 
-        results = list(fetch_doi(
+        results = list(fetch_doi_prefix(
             prefixes=prefixes,
             page_size=10
         ))
@@ -881,7 +881,7 @@ def test_no_user_agent_when_mailto_none(self, prefixes, mocker):
             mock_update = MagicMock()
             mock_session.headers.update = mock_update
 
-            list(fetch_doi(
+            list(fetch_doi_prefix(
                 prefixes=prefixes,
                 state="findable",
                 page_size=10,
@@ -902,7 +902,7 @@ def test_large_page_size_boundary(self, prefixes, mocker):
             {"data": []}  # No more data
         ]
 
-        results = list(fetch_doi(
+        results = list(fetch_doi_prefix(
             prefixes=prefixes,
             page_size=1000  # Maximum page size
         ))
@@ -914,23 +914,23 @@ def test_large_page_size_boundary(self, prefixes, mocker):
     def test_invalid_page_size_zero(self, prefixes):
         """Test that page_size=0 raises ValueError."""
         with pytest.raises(ValueError, match="page_size must be at least 1"):
-            list(fetch_doi(
+            list(fetch_doi_prefix(
                 prefixes=prefixes,
                 page_size=0
             ))
 
     def test_invalid_page_size_negative(self, prefixes):
         """Test that negative page_size raises ValueError."""
         with pytest.raises(ValueError, match="page_size must be at least 1"):
-            list(fetch_doi(
+            list(fetch_doi_prefix(
                 prefixes=prefixes,
                 page_size=-5
             ))
 
     def test_invalid_page_size_exceeds_maximum(self, prefixes):
         """Test that page_size > 1000 raises ValueError."""
         with pytest.raises(ValueError, match="page_size cannot exceed 1000"):
-            list(fetch_doi(
+            list(fetch_doi_prefix(
                 prefixes=prefixes,
                 page_size=2000
             ))
@@ -941,19 +941,19 @@ def test_page_size_boundary_values(self, prefixes, mocker):
         mock_fetch_page.return_value = {"data": []}
 
         # page_size=1 should work
-        list(fetch_doi(prefixes=prefixes, page_size=1))
+        list(fetch_doi_prefix(prefixes=prefixes, page_size=1))
         assert mock_fetch_page.called
 
         mock_fetch_page.reset_mock()
 
         # page_size=1000 should work
-        list(fetch_doi(prefixes=prefixes, page_size=1000))
+        list(fetch_doi_prefix(prefixes=prefixes, page_size=1000))
         assert mock_fetch_page.called
 
     def test_invalid_state(self, prefixes):
         """Test that invalid state raises ValueError."""
         with pytest.raises(ValueError, match="state must be one of"):
-            list(fetch_doi(
+            list(fetch_doi_prefix(
                 prefixes=prefixes,
                 state="invalid_state"
             ))
@@ -965,7 +965,7 @@ def test_valid_states(self, prefixes, state, mocker):
         mock_fetch_page.return_value = {"data": []}
 
         # Should not raise ValueError
-        list(fetch_doi(prefixes=prefixes, state=state))
+        list(fetch_doi_prefix(prefixes=prefixes, state=state))
         assert mock_fetch_page.called