funapi-sciencedb 1.0.1__py3-none-any.whl

sciencedb/client.py

@@ -0,0 +1,286 @@
+import ssl
+from typing import Any, Dict, Optional, Union
+
+import httpx
+from attrs import define, evolve, field
+
+
+@define
+class Client:
+    """A class for keeping track of data related to the API
+
+    The following are accepted as keyword arguments and will be used to construct httpx Clients internally:
+
+        ``base_url``: The base URL for the API, all requests are made to a relative path to this URL
+
+        ``cookies``: A dictionary of cookies to be sent with every request
+
+        ``headers``: A dictionary of headers to be sent with every request
+
+        ``timeout``: The maximum amount of a time a request can take. API functions will raise
+        httpx.TimeoutException if this is exceeded.
+
+        ``verify_ssl``: Whether or not to verify the SSL certificate of the API server. This should be True in production,
+        but can be set to False for testing purposes.
+
+        ``follow_redirects``: Whether or not to follow redirects. Default value is False.
+
+        ``httpx_args``: A dictionary of additional arguments to be passed to the ``httpx.Client`` and ``httpx.AsyncClient`` constructor.
+
+
+    Attributes:
+        raise_on_unexpected_status: Whether or not to raise an errors.UnexpectedStatus if the API returns a
+            status code that was not documented in the source OpenAPI document. Can also be provided as a keyword
+            argument to the constructor.
+    """
+
+    raise_on_unexpected_status: bool = field(default=False, kw_only=True)
+    _base_url: str = field(alias="base_url")
+    _cookies: Dict[str, str] = field(factory=dict, kw_only=True, alias="cookies")
+    _headers: Dict[str, str] = field(factory=dict, kw_only=True, alias="headers")
+    _timeout: Optional[httpx.Timeout] = field(
+        default=None, kw_only=True, alias="timeout"
+    )
+    _verify_ssl: Union[str, bool, ssl.SSLContext] = field(
+        default=True, kw_only=True, alias="verify_ssl"
+    )
+    _follow_redirects: bool = field(
+        default=False, kw_only=True, alias="follow_redirects"
+    )
+    _httpx_args: Dict[str, Any] = field(factory=dict, kw_only=True, alias="httpx_args")
+    _client: Optional[httpx.Client] = field(default=None, init=False)
+    _async_client: Optional[httpx.AsyncClient] = field(default=None, init=False)
+
+    def with_headers(self, headers: Dict[str, str]) -> "Client":
+        """Get a new client matching this one with additional headers"""
+        if self._client is not None:
+            self._client.headers.update(headers)
+        if self._async_client is not None:
+            self._async_client.headers.update(headers)
+        return evolve(self, headers={**self._headers, **headers})
+
+    def with_cookies(self, cookies: Dict[str, str]) -> "Client":
+        """Get a new client matching this one with additional cookies"""
+        if self._client is not None:
+            self._client.cookies.update(cookies)
+        if self._async_client is not None:
+            self._async_client.cookies.update(cookies)
+        return evolve(self, cookies={**self._cookies, **cookies})
+
+    def with_timeout(self, timeout: httpx.Timeout) -> "Client":
+        """Get a new client matching this one with a new timeout (in seconds)"""
+        if self._client is not None:
+            self._client.timeout = timeout
+        if self._async_client is not None:
+            self._async_client.timeout = timeout
+        return evolve(self, timeout=timeout)
+
+    def set_httpx_client(self, client: httpx.Client) -> "Client":
+        """Manually set the underlying httpx.Client
+
+        **NOTE**: This will override any other settings on the client, including cookies, headers, and timeout.
+        """
+        self._client = client
+        return self
+
+    def get_httpx_client(self) -> httpx.Client:
+        """Get the underlying httpx.Client, constructing a new one if not previously set"""
+        if self._client is None:
+            self._client = httpx.Client(
+                base_url=self._base_url,
+                cookies=self._cookies,
+                headers=self._headers,
+                timeout=self._timeout,
+                verify=self._verify_ssl,
+                follow_redirects=self._follow_redirects,
+                **self._httpx_args,
+            )
+        return self._client
+
+    def __enter__(self) -> "Client":
+        """Enter a context manager for self.client—you cannot enter twice (see httpx docs)"""
+        self.get_httpx_client().__enter__()
+        return self
+
+    def __exit__(self, *args: Any, **kwargs: Any) -> None:
+        """Exit a context manager for internal httpx.Client (see httpx docs)"""
+        self.get_httpx_client().__exit__(*args, **kwargs)
+
+    def set_async_httpx_client(self, async_client: httpx.AsyncClient) -> "Client":
+        """Manually the underlying httpx.AsyncClient
+
+        **NOTE**: This will override any other settings on the client, including cookies, headers, and timeout.
+        """
+        self._async_client = async_client
+        return self
+
+    def get_async_httpx_client(self) -> httpx.AsyncClient:
+        """Get the underlying httpx.AsyncClient, constructing a new one if not previously set"""
+        if self._async_client is None:
+            self._async_client = httpx.AsyncClient(
+                base_url=self._base_url,
+                cookies=self._cookies,
+                headers=self._headers,
+                timeout=self._timeout,
+                verify=self._verify_ssl,
+                follow_redirects=self._follow_redirects,
+                **self._httpx_args,
+            )
+        return self._async_client
+
+    async def __aenter__(self) -> "Client":
+        """Enter a context manager for underlying httpx.AsyncClient—you cannot enter twice (see httpx docs)"""
+        await self.get_async_httpx_client().__aenter__()
+        return self
+
+    async def __aexit__(self, *args: Any, **kwargs: Any) -> None:
+        """Exit a context manager for underlying httpx.AsyncClient (see httpx docs)"""
+        await self.get_async_httpx_client().__aexit__(*args, **kwargs)
+
+
+@define
+class AuthenticatedClient:
+    """A Client which has been authenticated for use on secured endpoints
+
+    The following are accepted as keyword arguments and will be used to construct httpx Clients internally:
+
+        ``base_url``: The base URL for the API, all requests are made to a relative path to this URL
+
+        ``cookies``: A dictionary of cookies to be sent with every request
+
+        ``headers``: A dictionary of headers to be sent with every request
+
+        ``timeout``: The maximum amount of a time a request can take. API functions will raise
+        httpx.TimeoutException if this is exceeded.
+
+        ``verify_ssl``: Whether or not to verify the SSL certificate of the API server. This should be True in production,
+        but can be set to False for testing purposes.
+
+        ``follow_redirects``: Whether or not to follow redirects. Default value is False.
+
+        ``httpx_args``: A dictionary of additional arguments to be passed to the ``httpx.Client`` and ``httpx.AsyncClient`` constructor.
+
+
+    Attributes:
+        raise_on_unexpected_status: Whether or not to raise an errors.UnexpectedStatus if the API returns a
+            status code that was not documented in the source OpenAPI document. Can also be provided as a keyword
+            argument to the constructor.
+        token: The token to use for authentication
+        prefix: The prefix to use for the Authorization header
+        auth_header_name: The name of the Authorization header
+    """
+
+    raise_on_unexpected_status: bool = field(default=False, kw_only=True)
+    _base_url: str = field(alias="base_url")
+    _cookies: Dict[str, str] = field(factory=dict, kw_only=True, alias="cookies")
+    _headers: Dict[str, str] = field(factory=dict, kw_only=True, alias="headers")
+    _timeout: Optional[httpx.Timeout] = field(
+        default=None, kw_only=True, alias="timeout"
+    )
+    _verify_ssl: Union[str, bool, ssl.SSLContext] = field(
+        default=True, kw_only=True, alias="verify_ssl"
+    )
+    _follow_redirects: bool = field(
+        default=False, kw_only=True, alias="follow_redirects"
+    )
+    _httpx_args: Dict[str, Any] = field(factory=dict, kw_only=True, alias="httpx_args")
+    _client: Optional[httpx.Client] = field(default=None, init=False)
+    _async_client: Optional[httpx.AsyncClient] = field(default=None, init=False)
+
+    token: str
+    prefix: str = "Bearer"
+    auth_header_name: str = "Authorization"
+
+    def with_headers(self, headers: Dict[str, str]) -> "AuthenticatedClient":
+        """Get a new client matching this one with additional headers"""
+        if self._client is not None:
+            self._client.headers.update(headers)
+        if self._async_client is not None:
+            self._async_client.headers.update(headers)
+        return evolve(self, headers={**self._headers, **headers})
+
+    def with_cookies(self, cookies: Dict[str, str]) -> "AuthenticatedClient":
+        """Get a new client matching this one with additional cookies"""
+        if self._client is not None:
+            self._client.cookies.update(cookies)
+        if self._async_client is not None:
+            self._async_client.cookies.update(cookies)
+        return evolve(self, cookies={**self._cookies, **cookies})
+
+    def with_timeout(self, timeout: httpx.Timeout) -> "AuthenticatedClient":
+        """Get a new client matching this one with a new timeout (in seconds)"""
+        if self._client is not None:
+            self._client.timeout = timeout
+        if self._async_client is not None:
+            self._async_client.timeout = timeout
+        return evolve(self, timeout=timeout)
+
+    def set_httpx_client(self, client: httpx.Client) -> "AuthenticatedClient":
+        """Manually set the underlying httpx.Client
+
+        **NOTE**: This will override any other settings on the client, including cookies, headers, and timeout.
+        """
+        self._client = client
+        return self
+
+    def get_httpx_client(self) -> httpx.Client:
+        """Get the underlying httpx.Client, constructing a new one if not previously set"""
+        if self._client is None:
+            self._headers[self.auth_header_name] = (
+                f"{self.prefix} {self.token}" if self.prefix else self.token
+            )
+            self._client = httpx.Client(
+                base_url=self._base_url,
+                cookies=self._cookies,
+                headers=self._headers,
+                timeout=self._timeout,
+                verify=self._verify_ssl,
+                follow_redirects=self._follow_redirects,
+                **self._httpx_args,
+            )
+        return self._client
+
+    def __enter__(self) -> "AuthenticatedClient":
+        """Enter a context manager for self.client—you cannot enter twice (see httpx docs)"""
+        self.get_httpx_client().__enter__()
+        return self
+
+    def __exit__(self, *args: Any, **kwargs: Any) -> None:
+        """Exit a context manager for internal httpx.Client (see httpx docs)"""
+        self.get_httpx_client().__exit__(*args, **kwargs)
+
+    def set_async_httpx_client(
+        self, async_client: httpx.AsyncClient
+    ) -> "AuthenticatedClient":
+        """Manually the underlying httpx.AsyncClient
+
+        **NOTE**: This will override any other settings on the client, including cookies, headers, and timeout.
+        """
+        self._async_client = async_client
+        return self
+
+    def get_async_httpx_client(self) -> httpx.AsyncClient:
+        """Get the underlying httpx.AsyncClient, constructing a new one if not previously set"""
+        if self._async_client is None:
+            self._headers[self.auth_header_name] = (
+                f"{self.prefix} {self.token}" if self.prefix else self.token
+            )
+            self._async_client = httpx.AsyncClient(
+                base_url=self._base_url,
+                cookies=self._cookies,
+                headers=self._headers,
+                timeout=self._timeout,
+                verify=self._verify_ssl,
+                follow_redirects=self._follow_redirects,
+                **self._httpx_args,
+            )
+        return self._async_client
+
+    async def __aenter__(self) -> "AuthenticatedClient":
+        """Enter a context manager for underlying httpx.AsyncClient—you cannot enter twice (see httpx docs)"""
+        await self.get_async_httpx_client().__aenter__()
+        return self
+
+    async def __aexit__(self, *args: Any, **kwargs: Any) -> None:
+        """Exit a context manager for underlying httpx.AsyncClient (see httpx docs)"""
+        await self.get_async_httpx_client().__aexit__(*args, **kwargs)

sciencedb/errors.py

@@ -0,0 +1,16 @@
+"""Contains shared errors types that can be raised from API functions"""
+
+
+class UnexpectedStatus(Exception):
+    """Raised by api functions when the response status an undocumented status and Client.raise_on_unexpected_status is True"""
+
+    def __init__(self, status_code: int, content: bytes):
+        self.status_code = status_code
+        self.content = content
+
+        super().__init__(
+            f"Unexpected status code: {status_code}\n\nResponse content:\n{content.decode(errors='ignore')}"
+        )
+
+
+__all__ = ["UnexpectedStatus"]

sciencedb/models/__init__.py

@@ -0,0 +1,75 @@
+"""Contains all the data models used in inputs/outputs"""
+
+from .api_result_metrics_result import APIResultMetricsResult
+from .api_result_search_result import APIResultSearchResult
+from .counter_dataset_attributes import COUNTERDatasetAttributes
+from .counter_dataset_attributes_type import COUNTERDatasetAttributesType
+from .counter_dataset_contributors import COUNTERDatasetContributors
+from .counter_dataset_contributors_type import COUNTERDatasetContributorsType
+from .counter_dataset_dates import COUNTERDatasetDates
+from .counter_dataset_dates_type import COUNTERDatasetDatesType
+from .counter_dataset_identifiers import COUNTERDatasetIdentifiers
+from .counter_dataset_identifiers_type import COUNTERDatasetIdentifiersType
+from .counter_dataset_instance import COUNTERDatasetInstance
+from .counter_dataset_instance_access_method import COUNTERDatasetInstanceAccessMethod
+from .counter_dataset_instance_metric_type import COUNTERDatasetInstanceMetricType
+from .counter_dataset_performance import COUNTERDatasetPerformance
+from .counter_dataset_period import COUNTERDatasetPeriod
+from .counter_dataset_report import COUNTERDatasetReport
+from .counter_dataset_usage import COUNTERDatasetUsage
+from .counter_dataset_usage_data_type import COUNTERDatasetUsageDataType
+from .counter_publisher_identifiers import COUNTERPublisherIdentifiers
+from .counter_publisher_identifiers_type import COUNTERPublisherIdentifiersType
+from .metrics_result import MetricsResult
+from .search_record import SearchRecord
+from .search_result import SearchResult
+from .sushi_error_model import SUSHIErrorModel
+from .sushi_error_model_severity import SUSHIErrorModelSeverity
+from .sushi_page_meta import SUSHIPageMeta
+from .sushi_report import SUSHIReport
+from .sushi_report_header import SUSHIReportHeader
+from .sushi_report_header_report_attributes_item import (
+    SUSHIReportHeaderReportAttributesItem,
+)
+from .sushi_report_header_report_filters_item import SUSHIReportHeaderReportFiltersItem
+from .sushi_report_list import SUSHIReportList
+from .sushi_report_page import SUSHIReportPage
+from .sushi_service_status import SUSHIServiceStatus
+from .sushi_service_status_alerts_item import SUSHIServiceStatusAlertsItem
+
+__all__ = (
+    "APIResultMetricsResult",
+    "APIResultSearchResult",
+    "COUNTERDatasetAttributes",
+    "COUNTERDatasetAttributesType",
+    "COUNTERDatasetContributors",
+    "COUNTERDatasetContributorsType",
+    "COUNTERDatasetDates",
+    "COUNTERDatasetDatesType",
+    "COUNTERDatasetIdentifiers",
+    "COUNTERDatasetIdentifiersType",
+    "COUNTERDatasetInstance",
+    "COUNTERDatasetInstanceAccessMethod",
+    "COUNTERDatasetInstanceMetricType",
+    "COUNTERDatasetPerformance",
+    "COUNTERDatasetPeriod",
+    "COUNTERDatasetReport",
+    "COUNTERDatasetUsage",
+    "COUNTERDatasetUsageDataType",
+    "COUNTERPublisherIdentifiers",
+    "COUNTERPublisherIdentifiersType",
+    "MetricsResult",
+    "SearchRecord",
+    "SearchResult",
+    "SUSHIErrorModel",
+    "SUSHIErrorModelSeverity",
+    "SUSHIPageMeta",
+    "SUSHIReport",
+    "SUSHIReportHeader",
+    "SUSHIReportHeaderReportAttributesItem",
+    "SUSHIReportHeaderReportFiltersItem",
+    "SUSHIReportList",
+    "SUSHIReportPage",
+    "SUSHIServiceStatus",
+    "SUSHIServiceStatusAlertsItem",
+)

sciencedb/models/api_result_metrics_result.py

@@ -0,0 +1,99 @@
+from typing import TYPE_CHECKING, Any, Dict, List, Type, TypeVar, Union
+
+from attrs import define as _attrs_define
+from attrs import field as _attrs_field
+
+from ..types import UNSET, Unset
+
+if TYPE_CHECKING:
+    from ..models.metrics_result import MetricsResult
+
+
+T = TypeVar("T", bound="APIResultMetricsResult")
+
+
+@_attrs_define
+class APIResultMetricsResult:
+    """the api result model
+
+    Attributes:
+        code (Union[Unset, int]): 20000 means success, other means error
+        message (Union[Unset, str]): code's description in Chinese
+        get_message_en (Union[Unset, str]): code's description in English
+        data (Union[Unset, MetricsResult]): wrapper of records of '/harvest' and '/search' and '/metrics' API
+    """
+
+    code: Union[Unset, int] = UNSET
+    message: Union[Unset, str] = UNSET
+    get_message_en: Union[Unset, str] = UNSET
+    data: Union[Unset, "MetricsResult"] = UNSET
+    additional_properties: Dict[str, Any] = _attrs_field(init=False, factory=dict)
+
+    def to_dict(self) -> Dict[str, Any]:
+        code = self.code
+
+        message = self.message
+
+        get_message_en = self.get_message_en
+
+        data: Union[Unset, Dict[str, Any]] = UNSET
+        if not isinstance(self.data, Unset):
+            data = self.data.to_dict()
+
+        field_dict: Dict[str, Any] = {}
+        field_dict.update(self.additional_properties)
+        field_dict.update({})
+        if code is not UNSET:
+            field_dict["code"] = code
+        if message is not UNSET:
+            field_dict["message"] = message
+        if get_message_en is not UNSET:
+            field_dict["getMessageEn"] = get_message_en
+        if data is not UNSET:
+            field_dict["data"] = data
+
+        return field_dict
+
+    @classmethod
+    def from_dict(cls: Type[T], src_dict: Dict[str, Any]) -> T:
+        from ..models.metrics_result import MetricsResult
+
+        d = src_dict.copy()
+        code = d.pop("code", UNSET)
+
+        message = d.pop("message", UNSET)
+
+        get_message_en = d.pop("getMessageEn", UNSET)
+
+        _data = d.pop("data", UNSET)
+        data: Union[Unset, MetricsResult]
+        if isinstance(_data, Unset):
+            data = UNSET
+        else:
+            data = MetricsResult.from_dict(_data)
+
+        api_result_metrics_result = cls(
+            code=code,
+            message=message,
+            get_message_en=get_message_en,
+            data=data,
+        )
+
+        api_result_metrics_result.additional_properties = d
+        return api_result_metrics_result
+
+    @property
+    def additional_keys(self) -> List[str]:
+        return list(self.additional_properties.keys())
+
+    def __getitem__(self, key: str) -> Any:
+        return self.additional_properties[key]
+
+    def __setitem__(self, key: str, value: Any) -> None:
+        self.additional_properties[key] = value
+
+    def __delitem__(self, key: str) -> None:
+        del self.additional_properties[key]
+
+    def __contains__(self, key: str) -> bool:
+        return key in self.additional_properties

sciencedb/models/api_result_search_result.py

@@ -0,0 +1,99 @@
+from typing import TYPE_CHECKING, Any, Dict, List, Type, TypeVar, Union
+
+from attrs import define as _attrs_define
+from attrs import field as _attrs_field
+
+from ..types import UNSET, Unset
+
+if TYPE_CHECKING:
+    from ..models.search_result import SearchResult
+
+
+T = TypeVar("T", bound="APIResultSearchResult")
+
+
+@_attrs_define
+class APIResultSearchResult:
+    """the api result model
+
+    Attributes:
+        code (Union[Unset, int]): 20000 means success, other means error
+        message (Union[Unset, str]): code's description in Chinese
+        get_message_en (Union[Unset, str]): code's description in English
+        data (Union[Unset, SearchResult]): wrapper of records of '/harvest' and '/search' API
+    """
+
+    code: Union[Unset, int] = UNSET
+    message: Union[Unset, str] = UNSET
+    get_message_en: Union[Unset, str] = UNSET
+    data: Union[Unset, "SearchResult"] = UNSET
+    additional_properties: Dict[str, Any] = _attrs_field(init=False, factory=dict)
+
+    def to_dict(self) -> Dict[str, Any]:
+        code = self.code
+
+        message = self.message
+
+        get_message_en = self.get_message_en
+
+        data: Union[Unset, Dict[str, Any]] = UNSET
+        if not isinstance(self.data, Unset):
+            data = self.data.to_dict()
+
+        field_dict: Dict[str, Any] = {}
+        field_dict.update(self.additional_properties)
+        field_dict.update({})
+        if code is not UNSET:
+            field_dict["code"] = code
+        if message is not UNSET:
+            field_dict["message"] = message
+        if get_message_en is not UNSET:
+            field_dict["getMessageEn"] = get_message_en
+        if data is not UNSET:
+            field_dict["data"] = data
+
+        return field_dict
+
+    @classmethod
+    def from_dict(cls: Type[T], src_dict: Dict[str, Any]) -> T:
+        from ..models.search_result import SearchResult
+
+        d = src_dict.copy()
+        code = d.pop("code", UNSET)
+
+        message = d.pop("message", UNSET)
+
+        get_message_en = d.pop("getMessageEn", UNSET)
+
+        _data = d.pop("data", UNSET)
+        data: Union[Unset, SearchResult]
+        if isinstance(_data, Unset):
+            data = UNSET
+        else:
+            data = SearchResult.from_dict(_data)
+
+        api_result_search_result = cls(
+            code=code,
+            message=message,
+            get_message_en=get_message_en,
+            data=data,
+        )
+
+        api_result_search_result.additional_properties = d
+        return api_result_search_result
+
+    @property
+    def additional_keys(self) -> List[str]:
+        return list(self.additional_properties.keys())
+
+    def __getitem__(self, key: str) -> Any:
+        return self.additional_properties[key]
+
+    def __setitem__(self, key: str, value: Any) -> None:
+        self.additional_properties[key] = value
+
+    def __delitem__(self, key: str) -> None:
+        del self.additional_properties[key]
+
+    def __contains__(self, key: str) -> bool:
+        return key in self.additional_properties

sciencedb/models/counter_dataset_attributes.py

@@ -0,0 +1,69 @@
+from typing import Any, Dict, List, Type, TypeVar
+
+from attrs import define as _attrs_define
+from attrs import field as _attrs_field
+
+from ..models.counter_dataset_attributes_type import COUNTERDatasetAttributesType
+
+T = TypeVar("T", bound="COUNTERDatasetAttributes")
+
+
+@_attrs_define
+class COUNTERDatasetAttributes:
+    """
+    Attributes:
+        type (COUNTERDatasetAttributesType): Item attribute types are defined by NISO Journal Article Version and other
+            work... Example: dataset-version.
+        value (str): Value of the item attribute Example: VoR.
+    """
+
+    type: COUNTERDatasetAttributesType
+    value: str
+    additional_properties: Dict[str, Any] = _attrs_field(init=False, factory=dict)
+
+    def to_dict(self) -> Dict[str, Any]:
+        type = self.type.value
+
+        value = self.value
+
+        field_dict: Dict[str, Any] = {}
+        field_dict.update(self.additional_properties)
+        field_dict.update(
+            {
+                "Type": type,
+                "Value": value,
+            }
+        )
+
+        return field_dict
+
+    @classmethod
+    def from_dict(cls: Type[T], src_dict: Dict[str, Any]) -> T:
+        d = src_dict.copy()
+        type = COUNTERDatasetAttributesType(d.pop("Type"))
+
+        value = d.pop("Value")
+
+        counter_dataset_attributes = cls(
+            type=type,
+            value=value,
+        )
+
+        counter_dataset_attributes.additional_properties = d
+        return counter_dataset_attributes
+
+    @property
+    def additional_keys(self) -> List[str]:
+        return list(self.additional_properties.keys())
+
+    def __getitem__(self, key: str) -> Any:
+        return self.additional_properties[key]
+
+    def __setitem__(self, key: str, value: Any) -> None:
+        self.additional_properties[key] = value
+
+    def __delitem__(self, key: str) -> None:
+        del self.additional_properties[key]
+
+    def __contains__(self, key: str) -> bool:
+        return key in self.additional_properties

sciencedb/models/counter_dataset_attributes_type.py

@@ -0,0 +1,10 @@
+from enum import Enum
+
+
+class COUNTERDatasetAttributesType(str, Enum):
+    DATASET_TYPE = "dataset=-type"
+    DATASET_VERSION = "dataset-version"
+    PROPRIETARY = "proprietary"
+
+    def __str__(self) -> str:
+        return str(self.value)