pyinaturalist 1.0.0.dev1__tar.gz → 1.0.0.dev2__tar.gz

{pyinaturalist-1.0.0.dev1 → pyinaturalist-1.0.0.dev2}/PKG-INFO

@@ -1,6 +1,6 @@
-Metadata-Version: 2.4
+Metadata-Version: 2.5
 Name: pyinaturalist
-Version: 1.0.0.dev1
+Version: 1.0.0.dev2
 Summary: iNaturalist API client for python
 Project-URL: homepage, https://github.com/pyinat/pyinaturalist
 Project-URL: repository, https://github.com/pyinat/pyinaturalist

{pyinaturalist-1.0.0.dev1 → pyinaturalist-1.0.0.dev2}/pyinaturalist/client/oauth.py

@@ -40,7 +40,15 @@ def _decode_jwt_exp(token: str) -> datetime | None:
         payload = json.loads(base64.urlsafe_b64decode(payload_b64))
         exp = payload.get('exp')
         return datetime.fromtimestamp(exp, tz=timezone.utc) if exp else None
-    except (ValueError, KeyError, AttributeError, OverflowError, binascii.Error):
+    except (
+        ValueError,
+        KeyError,
+        AttributeError,
+        OverflowError,
+        OSError,
+        TypeError,
+        binascii.Error,
+    ):
         return None
 
 
@@ -97,9 +105,10 @@ def get_access_token(
 
     Raises:
         :py:exc:`requests.HTTPError`: (401) if credentials are invalid
+        :py:exc:`.AuthenticationError`: if required credentials are missing
     """
     session, cached = _get_cached_jwt(refresh)
-    if cached:
+    if cached and jwt:
         return cached
 
     # Otherwise check for credentials in either args or environment variables
@@ -113,7 +122,7 @@ def get_access_token(
 
     # If any fields were missing, then check the keyring
     if not all(payload.values()):
-        payload.update(get_keyring_credentials())
+        payload |= {k: v for k, v in get_keyring_credentials().items() if not payload.get(k)}
         if all(payload.values()):
             _logger.info('Retrieved credentials from keyring')
         else:
@@ -121,12 +130,11 @@ def get_access_token(
 
     # Get OAuth access token
     response = session.post(f'{API_V0}/oauth/token', json=payload)
-    response.raise_for_status()
     access_token = response.json()['access_token']
 
     # If specified, use OAuth token to get (and cache) a JWT
     if jwt:
-        response = _get_jwt(session, access_token)
+        response = _get_jwt(session, access_token, refresh=refresh)
         response.raise_for_status()
         access_token = response.json()['api_token']
     return access_token
@@ -205,7 +213,7 @@ def get_access_token_via_auth_code(
             authorize in time, or the token exchange fails.
     """
     session, cached = _get_cached_jwt(refresh)
-    if cached:
+    if cached and jwt:
         return cached
 
     app_id, app_secret = _resolve_auth_code_creds(app_id, app_secret, use_pkce)
@@ -235,12 +243,11 @@ def get_access_token_via_auth_code(
         app_id, auth_code, redirect_uri, code_verifier, app_secret, use_pkce
     )
     response = session.post(f'{API_V0}/oauth/token', json=payload)
-    response.raise_for_status()
     access_token = response.json()['access_token']
 
     # If specified, use OAuth token to get (and cache) a JWT
     if jwt:
-        response = _get_jwt(session, access_token)
+        response = _get_jwt(session, access_token, refresh=refresh)
         response.raise_for_status()
         access_token = response.json()['api_token']
     return access_token
@@ -257,13 +264,22 @@ def _get_cached_jwt(refresh: bool) -> tuple[ClientSession, str | None]:
 
 
 def validate_token(access_token: str) -> bool:
-    """Determine if an access token is valid"""
+    """Determine if an access token is valid.
+
+    Returns ``False`` when the server confirms the token is invalid (401);
+    other failures are not re-raised.
+
+    Raises:
+        :py:exc:`requests.HTTPError`: for any non-401 error response
+    """
     session = get_local_session()
     try:
         session.request('GET', f'{API_V1}/users/me', access_token=access_token)
         return True
-    except HTTPError:
-        return False
+    except HTTPError as e:
+        if e.response is not None and e.response.status_code == 401:
+            return False
+        raise
 
 
 def get_keyring_credentials() -> dict[str, str | None]:
@@ -306,12 +322,16 @@ def set_keyring_credentials(
 
 
 def _get_jwt(
-    session: ClientSession, access_token: str | None = None, only_if_cached: bool = False
+    session: ClientSession,
+    access_token: str | None = None,
+    only_if_cached: bool = False,
+    refresh: bool = False,
 ) -> Response:
     headers = {'Authorization': f'Bearer {access_token}'} if access_token else {}
     return session.get(
         f'{API_V0}/users/api_token',
         headers=headers,
         only_if_cached=only_if_cached,  # If True, will return a 504 if not cached
+        force_refresh=refresh,
         raise_for_status=False,  # type: ignore
     )

{pyinaturalist-1.0.0.dev1 → pyinaturalist-1.0.0.dev2}/pyinaturalist/client/session.py

@@ -49,6 +49,7 @@ from pyinaturalist.constants import (
     REQUESTS_PER_SECOND,
     RETRY_BACKOFF,
     RETRY_STATUSES,
+    RETRYABLE_CONNECTION_ERRORS,
     WRITE_HTTP_METHODS,
     WRITE_TIMEOUT,
     FileOrPath,
@@ -356,12 +357,12 @@ class ClientSession(CacheMixin, LimiterMixin, Session):
                 timeout=timeout,  # type: ignore[arg-type]
                 **kwargs,
             )
-        # Handle write timeouts, which are not captured by urllib3 retry handling;
+        # Handle connection errors not captured by urllib3 retry handling (write timeouts, remote disconnects);
         except ConnectionError as e:
-            if 'write operation timed out' not in str(e):
+            if not any(msg in str(e).lower() for msg in RETRYABLE_CONNECTION_ERRORS):
                 raise
-            _logger.debug('Write timed out:', exc_info=True)
-            _logger.warning('Write timed out; retrying...')
+            _logger.debug('Connection error:', exc_info=True)
+            _logger.warning('Connection error; retrying...')
 
             # Reuse the same retry object to share retry state and limits
             retries = retries or self.retries

{pyinaturalist-1.0.0.dev1 → pyinaturalist-1.0.0.dev2}/pyinaturalist/constants.py

@@ -42,6 +42,10 @@ REQUEST_TIMEOUT = 20
 REQUEST_RETRIES = 5  # Maximum number of retries for a failed request
 RETRY_BACKOFF = 0.5  # Exponential backoff factor for retries
 RETRY_STATUSES = (500, 502, 503, 504)
+RETRYABLE_CONNECTION_ERRORS = (
+    'write operation timed out',
+    'remote end closed connection without response',
+)
 WRITE_TIMEOUT = 60
 
 # HTTP methods that apply to write-only dry-run mode
@@ -152,6 +156,13 @@ RANK_LEVELS = {
 }
 RANKS = list(RANK_LEVELS.keys())[:-2]
 
+# When there are multiple ranks for a given level, this maps to the most representative/common one
+RANK_LEVEL_REPRESENTATIVE_RANKS = {
+    5: 'subspecies',
+    10: 'species',
+    20: 'genus',
+}
+
 # The main 7 taxonomic ranks, used for condensed display
 COMMON_RANKS = [
     'species',
@@ -176,7 +187,6 @@ RANK_EQUIVALENTS = {
     'var': 'variety',
 }
 
-
 # Type aliases
 # Multiple-choice parameter type aliases
 Inbox = Literal['inbox', 'sent', 'any']

{pyinaturalist-1.0.0.dev1 → pyinaturalist-1.0.0.dev2}/pyinaturalist/controllers/search_controller.py

@@ -1,7 +1,7 @@
 from pyinaturalist.constants import MultiInt, MultiStr
 from pyinaturalist.controllers import BaseController
 from pyinaturalist.models import SearchResult
-from pyinaturalist.v1 import search
+from pyinaturalist.v1.search import search
 
 
 class SearchController(BaseController):

{pyinaturalist-1.0.0.dev1 → pyinaturalist-1.0.0.dev2}/pyproject.toml

@@ -1,6 +1,6 @@
 [project]
 name = 'pyinaturalist'
-version = "1.0.0.dev1"
+version = "1.0.0.dev2"
 description = 'iNaturalist API client for python'
 authors = [{ name = 'Jordan Cook' }]
 license = 'MIT'
@@ -136,7 +136,7 @@ fix = true
 unsafe-fixes = true
 line-length = 100
 output-format = 'grouped'
-exclude = ['examples/', 'scripts/specs/', 'test/sample_data/']
+exclude = ['README.md', 'examples/', 'scripts/specs/', 'test/sample_data/']
 
 [tool.ruff.format]
 quote-style = 'single'