pyoncat 2.6__tar.gz → 2.7__tar.gz

{pyoncat-2.6 → pyoncat-2.7}/PKG-INFO

@@ -1,20 +1,19 @@
 Metadata-Version: 2.4
 Name: pyoncat
-Version: 2.6
+Version: 2.7
 Summary: A Python Client for ONCat (the ORNL Neutron Catalog).
 Keywords: ornl,neutron,metadata,catalog
 Author: ONCat Support
 Author-email: oncat-support@ornl.gov
-Requires-Python: >=3.7,<4
+Requires-Python: >=3.9,<4
 Classifier: Programming Language :: Python :: 3
-Classifier: Programming Language :: Python :: 3.7
-Classifier: Programming Language :: Python :: 3.8
 Classifier: Programming Language :: Python :: 3.9
 Classifier: Programming Language :: Python :: 3.10
 Classifier: Programming Language :: Python :: 3.11
 Classifier: Programming Language :: Python :: 3.12
 Classifier: Programming Language :: Python :: 3.13
 Classifier: Programming Language :: Python :: 3.14
+Classifier: Programming Language :: Python :: 3.15
 Requires-Dist: requests
 Project-URL: Homepage, https://oncat.ornl.gov
 Description-Content-Type: text/markdown
@@ -59,6 +58,10 @@ Alternatively, a Conda package is available up on [Anaconda](https://anaconda.or
 
 To use the authenticated version of the API, you need to obtain credentials from an ONCat administrator. Please contact ONCat Support at [oncat-support@ornl.gov](mailto:oncat-support@ornl.gov) to request credentials.
 
+### Request headers
+
+Every request PyONCat makes carries two headers: `User-Agent: pyoncat/<version> requests/<version> Python/<major.minor>`, naming PyONCat, the `requests` library, and the Python major.minor version, and `API-Client: v1 pyoncat/<version>`. They let server logs tell PyONCat traffic from other clients.
+
 ### Examples
 
 For usage examples, please refer to the API documentation at [oncat.ornl.gov](https://oncat.ornl.gov).

{pyoncat-2.6 → pyoncat-2.7}/pyoncat/README.md

@@ -38,6 +38,10 @@ Alternatively, a Conda package is available up on [Anaconda](https://anaconda.or
 
 To use the authenticated version of the API, you need to obtain credentials from an ONCat administrator. Please contact ONCat Support at [oncat-support@ornl.gov](mailto:oncat-support@ornl.gov) to request credentials.
 
+### Request headers
+
+Every request PyONCat makes carries two headers: `User-Agent: pyoncat/<version> requests/<version> Python/<major.minor>`, naming PyONCat, the `requests` library, and the Python major.minor version, and `API-Client: v1 pyoncat/<version>`. They let server logs tell PyONCat traffic from other clients.
+
 ### Examples
 
 For usage examples, please refer to the API documentation at [oncat.ornl.gov](https://oncat.ornl.gov).

{pyoncat-2.6 → pyoncat-2.7}/pyoncat/__init__.py

@@ -34,7 +34,18 @@ from pyoncat.reduction import ReductionFileBuilder
 if TYPE_CHECKING:
     import threading
 
-__version__ = "2.6"
+__version__ = "2.7"
+
+# Sent on every request PyONCat makes, API calls and token requests alike,
+# so server logs can tell PyONCat traffic from other clients.
+_USER_AGENT = (
+    f"pyoncat/{__version__} requests/{requests.__version__} "
+    f"Python/{sys.version_info.major}.{sys.version_info.minor}"
+)
+_CLIENT_HEADERS = {
+    "User-Agent": _USER_AGENT,
+    "API-Client": f"v1 pyoncat/{__version__}",
+}
 
 # Constant for autoreduction user
 AUTOREDUCTION_USER = "auto"
@@ -403,7 +414,6 @@ class ONCat:
         Task: Task
         Info: Info
         Cache: Cache
-        Usage: Usage
         Template: Template
 
     def __init__(
@@ -525,14 +535,17 @@ class ONCat:
                     timeout=self._timeout,
                 )
             else:
+                auth_headers = (
+                    {"Authorization": "Bearer " + self._api_token}
+                    if self._api_token
+                    else {}
+                )
                 response = getattr(requests, method)(
                     full_url,
                     params=kwargs,
                     json=data,
                     verify=self._should_verify(),
-                    headers={"Authorization": "Bearer " + self._api_token}
-                    if self._api_token
-                    else None,
+                    headers={**_CLIENT_HEADERS, **auth_headers},
                     timeout=self._timeout,
                 )
             try:
@@ -799,6 +812,7 @@ class ONCat:
                     verify=self._should_verify(),
                     timeout=post_timeout,
                     headers={
+                        **_CLIENT_HEADERS,
                         "Content-Type": "application/x-www-form-urlencoded",
                         "Accept": "application/json",
                     },
@@ -975,6 +989,7 @@ class ONCat:
                 ),
                 scope=self._scopes,
             )
+            self._oauth_client.headers.update(_CLIENT_HEADERS)
         try:
             token = self._oauth_client.fetch_token(
                 self._url + "/oauth/token",
@@ -1012,6 +1027,7 @@ class ONCat:
                     client_secret=self._client_secret,
                 )
             )
+            initial_oauth_client.headers.update(_CLIENT_HEADERS)
 
             try:
                 token = initial_oauth_client.fetch_token(
@@ -1060,6 +1076,7 @@ class ONCat:
             auto_refresh_kwargs=auto_refresh_kwargs,
             token_updater=self._save_token,
         )
+        self._oauth_client.headers.update(_CLIENT_HEADERS)
 
     def _login_device_authorization(
         self,
@@ -1142,6 +1159,7 @@ class ONCat:
                 verify=self._should_verify(),
                 timeout=post_timeout,
                 headers={
+                    **_CLIENT_HEADERS,
                     "Content-Type": "application/x-www-form-urlencoded",
                     "Accept": "application/json",
                 },
@@ -1230,6 +1248,7 @@ class ONCat:
                     verify=self._should_verify(),
                     timeout=post_timeout,
                     headers={
+                        **_CLIENT_HEADERS,
                         "Content-Type": "application/x-www-form-urlencoded",
                         "Accept": "application/json",
                     },
@@ -1397,6 +1416,7 @@ class ONCat:
                 },
                 token_updater=self._save_token,
             )
+            self._oauth_client.headers.update(_CLIENT_HEADERS)
 
 
 class ONCatObject:
@@ -1556,6 +1576,12 @@ ONCatRepresentation = ONCatObject
 ########################################################################
 
 
+# TODO: The REST documentation page derives the PyONCat class and method
+# in each code example from the resource's namespace and path, without
+# consulting this module. Where a resource has no class here, or the
+# class lacks the method, the example does not run. Decide how the
+# documentation should learn what this module provides or otherwise
+# resolve this mismatch.
 class _ONCatMixinMeta(type):
     REGISTERED_RESOURCES: ClassVar[list] = []
 
@@ -1719,7 +1745,7 @@ class Grouping(_ListableONCatMixin):
 
 class Mapping(_ListableONCatMixin):
     _RESOURCE_ENDPOINT = "mappings"
-    _NAMESPACE = "settings"
+    _NAMESPACE = "option"
 
 
 class Proposal(_ListableONCatMixin):
@@ -1803,11 +1829,6 @@ class Cache(_UpdatableONCatMixin):
     _NAMESPACE = "admin"
 
 
-class Usage(_ListableONCatMixin):
-    _RESOURCE_ENDPOINT = "usage"
-    _NAMESPACE = "admin"
-
-
 ########################################################################
 
 
@@ -1818,51 +1839,6 @@ class Template(
     _NAMESPACE = "settings"
 
 
-########################################################################
-# Summary Resources
-########################################################################
-
-
-class ExperimentSummary(_ONCatResource):
-    _RESOURCE_ENDPOINT = "experiments"
-    _NAMESPACE = "summary"
-
-
-class GroupingSummary(_ONCatResource):
-    _RESOURCE_ENDPOINT = "groupings"
-    _NAMESPACE = "summary"
-
-
-class InstrumentSummary(_ONCatResource):
-    _RESOURCE_ENDPOINT = "instruments"
-    _NAMESPACE = "summary"
-
-
-class ReductionSummary(_ONCatResource):
-    _RESOURCE_ENDPOINT = "reductions"
-    _NAMESPACE = "summary"
-
-
-class RunSummary(_ONCatResource):
-    _RESOURCE_ENDPOINT = "runs"
-    _NAMESPACE = "summary"
-
-
-class SampleSummary(_ONCatResource):
-    _RESOURCE_ENDPOINT = "samples"
-    _NAMESPACE = "summary"
-
-
-class ScanSummary(_ONCatResource):
-    _RESOURCE_ENDPOINT = "scans"
-    _NAMESPACE = "summary"
-
-
-class SessionSummary(_ONCatResource):
-    _RESOURCE_ENDPOINT = "sessions"
-    _NAMESPACE = "summary"
-
-
 ########################################################################
 # Misc Tools
 ########################################################################
@@ -2099,22 +2075,22 @@ class DeviceAuthorizationError(PyONCatError):
 # (ADR-0097), spelled to read as outcomes the caller catches by reason --
 # Denied / Expired / Cancelled / Timeout. They subclass
 # `DeviceAuthorizationError`, so the suffixed base type still catches them.
-class DeviceAuthorizationDenied(DeviceAuthorizationError):  # noqa: N818 - public API name (ADR-0097)
+class DeviceAuthorizationDenied(DeviceAuthorizationError):  # ruff: ignore[error-suffix-on-exception-name] - public API name (ADR-0097)
     """Raised when the user explicitly denied the sign-in request
     (the IdP returned `access_denied`, RFC 8628 §3.5)."""
 
 
-class DeviceAuthorizationExpired(DeviceAuthorizationError):  # noqa: N818 - public API name (ADR-0097)
+class DeviceAuthorizationExpired(DeviceAuthorizationError):  # ruff: ignore[error-suffix-on-exception-name] - public API name (ADR-0097)
     """Raised when the device code expired before the user approved the
     sign-in (the IdP returned `expired_token`, RFC 8628 §3.5)."""
 
 
-class DeviceAuthorizationCancelled(DeviceAuthorizationError):  # noqa: N818 - public API name (ADR-0097)
+class DeviceAuthorizationCancelled(DeviceAuthorizationError):  # ruff: ignore[error-suffix-on-exception-name] - public API name (ADR-0097)
     """Raised when the caller cancelled the sign-in in progress via the
     `cancel_event` passed to `login()`."""
 
 
-class DeviceAuthorizationTimeout(DeviceAuthorizationError):  # noqa: N818 - public API name (ADR-0097)
+class DeviceAuthorizationTimeout(DeviceAuthorizationError):  # ruff: ignore[error-suffix-on-exception-name] - public API name (ADR-0097)
     """Raised when the sign-in did not complete before the overall
     caller deadline (`device_authorization_timeout`) or the server's own
     `expires_in`, whichever came first."""

{pyoncat-2.6 → pyoncat-2.7}/pyoncat/reduction.py

@@ -566,7 +566,7 @@ class ReductionFileBuilder:
         """
         try:
             return self.write(path, overwrite)
-        except Exception as e:  # noqa: BLE001
+        except Exception as e:  # ruff: ignore[blind-except]
             # Intentionally catch all exceptions - design requirement for
             # autoreduction scripts where cataloging failures should never
             # break the reduction workflow

{pyoncat-2.6 → pyoncat-2.7}/pyproject.toml

@@ -7,7 +7,7 @@ build-backend = "poetry.masonry.api"
 # https://github.com/python-poetry/roadmap/issues/3
 [tool.poetry]
 name = "pyoncat"
-version = "2.6"
+version = "2.7"
 description = "A Python Client for ONCat (the ORNL Neutron Catalog)."
 authors = ["ONCat Support <oncat-support@ornl.gov>"]
 readme = ["pyoncat/README.md", "pyoncat/LICENSE"]
@@ -21,7 +21,7 @@ packages = [
 ]
 
 [tool.poetry.dependencies]
-python = ">=3.7, <4"
+python = ">=3.9, <4"
 requests = "*"
 oauthlib = { version = "*", optional = true }
 requests-oauthlib = { version = "*", optional = true }