bely-api 2026.3.1__py3-none-any.whl

BelyApiFactory.py

@@ -0,0 +1,256 @@
+#!/usr/bin/env python
+
+# Copyright (c) UChicago Argonne, LLC. All rights reserved.
+# See LICENSE file.
+
+# Annotations are stored as strings so that the API return types below can be
+# named without importing them at module load time.
+from __future__ import annotations
+
+import base64
+import os
+import warnings
+import typing
+
+if typing.TYPE_CHECKING:
+    from belyApi import (
+        AuthenticationApi,
+        DomainApi,
+        DownloadsApi,
+        LogbookApi,
+        NotificationConfigurationApi,
+        PropertyValueApi,
+        SearchApi,
+        SystemLogApi,
+        UsersApi,
+    )
+
+
+class BelyApiFactory:
+
+    HEADER_TOKEN_KEY = "token"
+    URL_FORMAT = "%s/views/item/view?id=%s"
+
+    LOGBOOK_DOMAIN_ID = 1
+
+    # attribute name -> generated api class. Each api is built on first access by
+    # __getattr__ so that importing this module does not drag in every belyApi
+    # model; see the "Known startup cost" section of bely-cli/CLAUDE.md. The
+    # generator's lazyImports option only pays off while this stays lazy.
+    _API_CLASSES = {
+        "auth_api": "AuthenticationApi",
+        "domain_api": "DomainApi",
+        "downloads_api": "DownloadsApi",
+        "logbook_api": "LogbookApi",
+        "notification_configuration_api": "NotificationConfigurationApi",
+        "property_value_api": "PropertyValueApi",
+        "search_api": "SearchApi",
+        "systemlog_api": "SystemLogApi",
+        "users_api": "UsersApi",
+    }
+
+    # Deprecated camelCase aliases -> canonical attribute name
+    _API_ALIASES = {
+        "domainApi": "domain_api",
+        "downloadsApi": "downloads_api",
+        "propertyValueApi": "property_value_api",
+        "searchApi": "search_api",
+        "systemlogApi": "systemlog_api",
+        "usersApi": "users_api",
+    }
+
+    def __init__(self, bely_url):
+        from belyApi import ApiClient, Configuration
+
+        self.bely_url = bely_url
+        self.config = Configuration(host=self.bely_url)
+        self.api_client = ApiClient(configuration=self.config)
+
+    def __getattr__(self, name):
+        """Build api instances on first access.
+
+        Only called when normal attribute lookup fails, so each api is created
+        once and then cached in __dict__.
+        """
+        canonical = self._API_ALIASES.get(name, name)
+        class_name = self._API_CLASSES.get(canonical)
+        if class_name is None:
+            raise AttributeError(
+                f"{type(self).__name__!r} object has no attribute {name!r}"
+            )
+
+        # __init__ must have run; guard against access on a half-built instance
+        # (e.g. during unpickling) recursing back into __getattr__.
+        if "api_client" not in self.__dict__:
+            raise AttributeError(
+                f"cannot build {canonical!r} before BelyApiFactory.__init__ has run"
+            )
+
+        import belyApi
+
+        api = getattr(belyApi, class_name)(api_client=self.api_client)
+        setattr(self, canonical, api)
+        if name != canonical:
+            setattr(self, name, api)
+        return api
+
+    def __dir__(self):
+        return sorted(
+            set(super().__dir__())
+            | set(self._API_CLASSES)
+            | set(self._API_ALIASES)
+        )
+
+    def _deprecated(self, old_name, new_name):
+        warnings.warn(
+            f"{old_name} is deprecated, use {new_name} instead",
+            DeprecationWarning,
+            stacklevel=3,
+        )
+
+    # -- snake_case methods (primary) --
+
+    def get_logbook_api(self) -> LogbookApi:
+        return self.logbook_api
+
+    def get_domain_api(self) -> DomainApi:
+        return self.domain_api
+
+    def get_download_api(self) -> DownloadsApi:
+        return self.downloads_api
+
+    def get_property_value_api(self) -> PropertyValueApi:
+        return self.property_value_api
+
+    def get_users_api(self) -> UsersApi:
+        return self.users_api
+
+    def get_search_api(self) -> SearchApi:
+        return self.search_api
+
+    def get_notification_configuration_api(self):
+        return self.notification_configuration_api
+
+    def generate_cdb_url_for_item_id(self, item_id):
+        return self.URL_FORMAT % (self.bely_url, str(item_id))
+
+    def authenticate_user(self, username, password):
+        response = self.auth_api.authenticate_user_with_http_info(
+            username=username, password=password
+        )
+
+        token = response.headers[self.HEADER_TOKEN_KEY]
+        self.__set_authenticate_token(token)
+
+    def __set_authenticate_token(self, token):
+        self.api_client.set_default_header(self.HEADER_TOKEN_KEY, token)
+
+    def get_authenticate_token(self):
+        return self.api_client.default_headers[self.HEADER_TOKEN_KEY]
+
+    def test_authenticated(self):
+        self.auth_api.verify_authenticated()
+
+    def logout_user(self):
+        self.auth_api.log_out()
+
+    def parse_api_exception(self, open_api_exception):
+        from belyApi import ApiExceptionMessage
+
+        response_type = ApiExceptionMessage.__name__
+        open_api_exception.data = open_api_exception.body
+        ex_obj = self.api_client.deserialize(open_api_exception, response_type)
+        ex_obj.status = open_api_exception.status
+        return ex_obj
+
+    # -- Deprecated camelCase wrappers --
+
+    def getDomainApi(self) -> DomainApi:
+        self._deprecated("getDomainApi", "get_domain_api")
+        return self.get_domain_api()
+
+    def getDownloadApi(self) -> DownloadsApi:
+        self._deprecated("getDownloadApi", "get_download_api")
+        return self.get_download_api()
+
+    def getPropertyValueApi(self) -> PropertyValueApi:
+        self._deprecated("getPropertyValueApi", "get_property_value_api")
+        return self.get_property_value_api()
+
+    def getUsersApi(self) -> UsersApi:
+        self._deprecated("getUsersApi", "get_users_api")
+        return self.get_users_api()
+
+    def getSearchApi(self) -> SearchApi:
+        self._deprecated("getSearchApi", "get_search_api")
+        return self.get_search_api()
+
+    def getNotificationConfigurationApi(self):
+        self._deprecated("getNotificationConfigurationApi", "get_notification_configuration_api")
+        return self.get_notification_configuration_api()
+
+    def generateCDBUrlForItemId(self, itemId):
+        self._deprecated("generateCDBUrlForItemId", "generate_cdb_url_for_item_id")
+        return self.generate_cdb_url_for_item_id(itemId)
+
+    def getAuthenticateToken(self):
+        self._deprecated("getAuthenticateToken", "get_authenticate_token")
+        return self.get_authenticate_token()
+
+    def parseApiException(self, openApiException):
+        self._deprecated("parseApiException", "parse_api_exception")
+        return self.parse_api_exception(openApiException)
+
+    # Restore later
+    # @classmethod
+    # def createFileUploadObject(cls, filePath):
+    # 	data = open(filePath, "rb").read()
+    # 	b64String = base64.b64encode(data).decode()
+
+    # 	fileName = os.path.basename(filePath)
+    # 	return FileUploadObject(file_name=fileName, base64_binary=b64String)
+
+
+# def run_command():
+# Example
+# 	print("\nEnter cdb URL (ex: https://cdb.aps.anl.gov/cdb): ")
+# 	hostname = input()
+
+# 	apiFactory = CdbApiFactory(hostname)
+# 	itemApi = apiFactory.getItemApi()
+
+# 	catalogItems = itemApi.get_catalog_items()
+# 	catalogItem = catalogItems[0]
+
+# 	# Lists of items seem to be lists of dict items
+# 	catalogId = catalogItem.id
+
+# 	# Single items seem to be appropriate type
+# 	catalogFetchedById = itemApi.get_item_by_id(catalogId)
+# 	print(catalogFetchedById.name)
+
+# 	inventoryItemPerCatalog = itemApi.get_items_derived_from_item_by_item_id(catalogId)
+# 	print(inventoryItemPerCatalog)
+
+# 	print("\n\n\nWould you like to test authentication? (y/N): ")
+# 	resp = input()
+# 	if resp == 'y' or resp == "Y":
+# 		import getpass
+# 		print("Username: ")
+# 		username = input()
+# 		print("Password: ")
+# 		password = getpass.getpass()
+
+# 		try:
+# 			apiFactory.authenticateUser(username, password)
+# 			apiFactory.testAuthenticated()
+# 			apiFactory.logOutUser()
+# 		except ApiException:
+# 			print("Authentication failed!")
+# 			exit(1)
+
+# 		print("Success!")
+
+if __name__ == "__main__":
+    pass
+# 	run_command()

belyApi/__init__.py

@@ -0,0 +1,266 @@
+# coding: utf-8
+
+# flake8: noqa
+
+"""
+    BELY API
+
+    The API that provides access to BELY data.
+
+    The version of the OpenAPI document: 2024.5
+    Contact: djarosz@anl.gov
+    Generated by OpenAPI Generator (https://openapi-generator.tech)
+
+    Do not edit the class manually.
+"""  # noqa: E501
+
+
+__version__ = "1.0.0"
+
+# Define package exports
+__all__ = [
+    "AuthenticationApi",
+    "DownloadsApi",
+    "LogbookApi",
+    "NotificationConfigurationApi",
+    "PropertyValueApi",
+    "SearchApi",
+    "SystemLogApi",
+    "TestApi",
+    "UsersApi",
+    "DomainApi",
+    "ApiResponse",
+    "ApiClient",
+    "Configuration",
+    "OpenApiException",
+    "ApiTypeError",
+    "ApiValueError",
+    "ApiKeyError",
+    "ApiAttributeError",
+    "ApiException",
+    "AllowedPropertyValue",
+    "ApiExceptionMessage",
+    "ApiExceptionMessageException",
+    "ApiExceptionMessageExceptionCause",
+    "ApiExceptionMessageExceptionCauseStackTraceInner",
+    "ApiExceptionMessageExceptionCauseSuppressedInner",
+    "Connector",
+    "ConnectorType",
+    "Domain",
+    "EntityInfo",
+    "EntityType",
+    "Item",
+    "ItemCategory",
+    "ItemConnector",
+    "ItemDomainLogbook",
+    "ItemElement",
+    "ItemElementHistory",
+    "ItemElementRelationship",
+    "ItemElementRelationshipHistory",
+    "ItemProject",
+    "ItemResource",
+    "ItemSource",
+    "ItemType",
+    "ListTbl",
+    "Log",
+    "LogDocumentOptions",
+    "LogDocumentSection",
+    "LogEntry",
+    "LogEntryAttachment",
+    "LogReaction",
+    "LogbookSearchResults",
+    "NotificationConfiguration",
+    "NotificationConfigurationHandlerSetting",
+    "NotificationConfigurationSetting",
+    "NotificationHandlerConfigKey",
+    "NotificationProvider",
+    "NotificationProviderConfigKey",
+    "PropertyMetadata",
+    "PropertyType",
+    "PropertyValue",
+    "PropertyValueHistory",
+    "Reaction",
+    "RelationshipType",
+    "RelationshipTypeHandler",
+    "ResourceType",
+    "ResourceTypeCategory",
+    "RoleType",
+    "SearchEntitiesOptions",
+    "SearchEntitiesResults",
+    "SearchResult",
+    "Source",
+    "UserGroup",
+    "UserInfo",
+    "UserRole",
+]
+
+import typing as _typing
+
+if _typing.TYPE_CHECKING:
+    # import apis into sdk package
+    from belyApi.api.authentication_api import AuthenticationApi as AuthenticationApi
+    from belyApi.api.downloads_api import DownloadsApi as DownloadsApi
+    from belyApi.api.logbook_api import LogbookApi as LogbookApi
+    from belyApi.api.notification_configuration_api import NotificationConfigurationApi as NotificationConfigurationApi
+    from belyApi.api.property_value_api import PropertyValueApi as PropertyValueApi
+    from belyApi.api.search_api import SearchApi as SearchApi
+    from belyApi.api.system_log_api import SystemLogApi as SystemLogApi
+    from belyApi.api.test_api import TestApi as TestApi
+    from belyApi.api.users_api import UsersApi as UsersApi
+    from belyApi.api.domain_api import DomainApi as DomainApi
+    
+    # import ApiClient
+    from belyApi.api_response import ApiResponse as ApiResponse
+    from belyApi.api_client import ApiClient as ApiClient
+    from belyApi.configuration import Configuration as Configuration
+    from belyApi.exceptions import OpenApiException as OpenApiException
+    from belyApi.exceptions import ApiTypeError as ApiTypeError
+    from belyApi.exceptions import ApiValueError as ApiValueError
+    from belyApi.exceptions import ApiKeyError as ApiKeyError
+    from belyApi.exceptions import ApiAttributeError as ApiAttributeError
+    from belyApi.exceptions import ApiException as ApiException
+    
+    # import models into sdk package
+    from belyApi.models.allowed_property_value import AllowedPropertyValue as AllowedPropertyValue
+    from belyApi.models.api_exception_message import ApiExceptionMessage as ApiExceptionMessage
+    from belyApi.models.api_exception_message_exception import ApiExceptionMessageException as ApiExceptionMessageException
+    from belyApi.models.api_exception_message_exception_cause import ApiExceptionMessageExceptionCause as ApiExceptionMessageExceptionCause
+    from belyApi.models.api_exception_message_exception_cause_stack_trace_inner import ApiExceptionMessageExceptionCauseStackTraceInner as ApiExceptionMessageExceptionCauseStackTraceInner
+    from belyApi.models.api_exception_message_exception_cause_suppressed_inner import ApiExceptionMessageExceptionCauseSuppressedInner as ApiExceptionMessageExceptionCauseSuppressedInner
+    from belyApi.models.connector import Connector as Connector
+    from belyApi.models.connector_type import ConnectorType as ConnectorType
+    from belyApi.models.domain import Domain as Domain
+    from belyApi.models.entity_info import EntityInfo as EntityInfo
+    from belyApi.models.entity_type import EntityType as EntityType
+    from belyApi.models.item import Item as Item
+    from belyApi.models.item_category import ItemCategory as ItemCategory
+    from belyApi.models.item_connector import ItemConnector as ItemConnector
+    from belyApi.models.item_domain_logbook import ItemDomainLogbook as ItemDomainLogbook
+    from belyApi.models.item_element import ItemElement as ItemElement
+    from belyApi.models.item_element_history import ItemElementHistory as ItemElementHistory
+    from belyApi.models.item_element_relationship import ItemElementRelationship as ItemElementRelationship
+    from belyApi.models.item_element_relationship_history import ItemElementRelationshipHistory as ItemElementRelationshipHistory
+    from belyApi.models.item_project import ItemProject as ItemProject
+    from belyApi.models.item_resource import ItemResource as ItemResource
+    from belyApi.models.item_source import ItemSource as ItemSource
+    from belyApi.models.item_type import ItemType as ItemType
+    from belyApi.models.list_tbl import ListTbl as ListTbl
+    from belyApi.models.log import Log as Log
+    from belyApi.models.log_document_options import LogDocumentOptions as LogDocumentOptions
+    from belyApi.models.log_document_section import LogDocumentSection as LogDocumentSection
+    from belyApi.models.log_entry import LogEntry as LogEntry
+    from belyApi.models.log_entry_attachment import LogEntryAttachment as LogEntryAttachment
+    from belyApi.models.log_reaction import LogReaction as LogReaction
+    from belyApi.models.logbook_search_results import LogbookSearchResults as LogbookSearchResults
+    from belyApi.models.notification_configuration import NotificationConfiguration as NotificationConfiguration
+    from belyApi.models.notification_configuration_handler_setting import NotificationConfigurationHandlerSetting as NotificationConfigurationHandlerSetting
+    from belyApi.models.notification_configuration_setting import NotificationConfigurationSetting as NotificationConfigurationSetting
+    from belyApi.models.notification_handler_config_key import NotificationHandlerConfigKey as NotificationHandlerConfigKey
+    from belyApi.models.notification_provider import NotificationProvider as NotificationProvider
+    from belyApi.models.notification_provider_config_key import NotificationProviderConfigKey as NotificationProviderConfigKey
+    from belyApi.models.property_metadata import PropertyMetadata as PropertyMetadata
+    from belyApi.models.property_type import PropertyType as PropertyType
+    from belyApi.models.property_value import PropertyValue as PropertyValue
+    from belyApi.models.property_value_history import PropertyValueHistory as PropertyValueHistory
+    from belyApi.models.reaction import Reaction as Reaction
+    from belyApi.models.relationship_type import RelationshipType as RelationshipType
+    from belyApi.models.relationship_type_handler import RelationshipTypeHandler as RelationshipTypeHandler
+    from belyApi.models.resource_type import ResourceType as ResourceType
+    from belyApi.models.resource_type_category import ResourceTypeCategory as ResourceTypeCategory
+    from belyApi.models.role_type import RoleType as RoleType
+    from belyApi.models.search_entities_options import SearchEntitiesOptions as SearchEntitiesOptions
+    from belyApi.models.search_entities_results import SearchEntitiesResults as SearchEntitiesResults
+    from belyApi.models.search_result import SearchResult as SearchResult
+    from belyApi.models.source import Source as Source
+    from belyApi.models.user_group import UserGroup as UserGroup
+    from belyApi.models.user_info import UserInfo as UserInfo
+    from belyApi.models.user_role import UserRole as UserRole
+    
+else:
+    from importlib import import_module
+
+    _exports = {
+        "AuthenticationApi": ".api.authentication_api",
+        "DownloadsApi": ".api.downloads_api",
+        "LogbookApi": ".api.logbook_api",
+        "NotificationConfigurationApi": ".api.notification_configuration_api",
+        "PropertyValueApi": ".api.property_value_api",
+        "SearchApi": ".api.search_api",
+        "SystemLogApi": ".api.system_log_api",
+        "TestApi": ".api.test_api",
+        "UsersApi": ".api.users_api",
+        "DomainApi": ".api.domain_api",
+        "ApiResponse": ".api_response",
+        "ApiClient": ".api_client",
+        "Configuration": ".configuration",
+        "OpenApiException": ".exceptions",
+        "ApiTypeError": ".exceptions",
+        "ApiValueError": ".exceptions",
+        "ApiKeyError": ".exceptions",
+        "ApiAttributeError": ".exceptions",
+        "ApiException": ".exceptions",
+        "AllowedPropertyValue": ".models.allowed_property_value",
+        "ApiExceptionMessage": ".models.api_exception_message",
+        "ApiExceptionMessageException": ".models.api_exception_message_exception",
+        "ApiExceptionMessageExceptionCause": ".models.api_exception_message_exception_cause",
+        "ApiExceptionMessageExceptionCauseStackTraceInner": ".models.api_exception_message_exception_cause_stack_trace_inner",
+        "ApiExceptionMessageExceptionCauseSuppressedInner": ".models.api_exception_message_exception_cause_suppressed_inner",
+        "Connector": ".models.connector",
+        "ConnectorType": ".models.connector_type",
+        "Domain": ".models.domain",
+        "EntityInfo": ".models.entity_info",
+        "EntityType": ".models.entity_type",
+        "Item": ".models.item",
+        "ItemCategory": ".models.item_category",
+        "ItemConnector": ".models.item_connector",
+        "ItemDomainLogbook": ".models.item_domain_logbook",
+        "ItemElement": ".models.item_element",
+        "ItemElementHistory": ".models.item_element_history",
+        "ItemElementRelationship": ".models.item_element_relationship",
+        "ItemElementRelationshipHistory": ".models.item_element_relationship_history",
+        "ItemProject": ".models.item_project",
+        "ItemResource": ".models.item_resource",
+        "ItemSource": ".models.item_source",
+        "ItemType": ".models.item_type",
+        "ListTbl": ".models.list_tbl",
+        "Log": ".models.log",
+        "LogDocumentOptions": ".models.log_document_options",
+        "LogDocumentSection": ".models.log_document_section",
+        "LogEntry": ".models.log_entry",
+        "LogEntryAttachment": ".models.log_entry_attachment",
+        "LogReaction": ".models.log_reaction",
+        "LogbookSearchResults": ".models.logbook_search_results",
+        "NotificationConfiguration": ".models.notification_configuration",
+        "NotificationConfigurationHandlerSetting": ".models.notification_configuration_handler_setting",
+        "NotificationConfigurationSetting": ".models.notification_configuration_setting",
+        "NotificationHandlerConfigKey": ".models.notification_handler_config_key",
+        "NotificationProvider": ".models.notification_provider",
+        "NotificationProviderConfigKey": ".models.notification_provider_config_key",
+        "PropertyMetadata": ".models.property_metadata",
+        "PropertyType": ".models.property_type",
+        "PropertyValue": ".models.property_value",
+        "PropertyValueHistory": ".models.property_value_history",
+        "Reaction": ".models.reaction",
+        "RelationshipType": ".models.relationship_type",
+        "RelationshipTypeHandler": ".models.relationship_type_handler",
+        "ResourceType": ".models.resource_type",
+        "ResourceTypeCategory": ".models.resource_type_category",
+        "RoleType": ".models.role_type",
+        "SearchEntitiesOptions": ".models.search_entities_options",
+        "SearchEntitiesResults": ".models.search_entities_results",
+        "SearchResult": ".models.search_result",
+        "Source": ".models.source",
+        "UserGroup": ".models.user_group",
+        "UserInfo": ".models.user_info",
+        "UserRole": ".models.user_role",
+    }
+
+    def __getattr__(name: str) -> object:
+        if (module_name := _exports.get(name)) is None:
+            raise AttributeError(f"module {__name__!r} has no attribute {name!r}")
+        value = getattr(import_module(module_name, __name__), name)
+        globals()[name] = value
+        return value
+
+    def __dir__() -> list[str]:
+        return sorted(globals().keys() | _exports.keys())

belyApi/api/__init__.py

@@ -0,0 +1,55 @@
+# flake8: noqa
+
+__all__ = [
+    "AuthenticationApi",
+    "DownloadsApi",
+    "LogbookApi",
+    "NotificationConfigurationApi",
+    "PropertyValueApi",
+    "SearchApi",
+    "SystemLogApi",
+    "TestApi",
+    "UsersApi",
+    "DomainApi",
+]
+
+import typing as _typing
+
+if _typing.TYPE_CHECKING:
+    # import apis into api package
+    from belyApi.api.authentication_api import AuthenticationApi
+    from belyApi.api.downloads_api import DownloadsApi
+    from belyApi.api.logbook_api import LogbookApi
+    from belyApi.api.notification_configuration_api import NotificationConfigurationApi
+    from belyApi.api.property_value_api import PropertyValueApi
+    from belyApi.api.search_api import SearchApi
+    from belyApi.api.system_log_api import SystemLogApi
+    from belyApi.api.test_api import TestApi
+    from belyApi.api.users_api import UsersApi
+    from belyApi.api.domain_api import DomainApi
+    
+else:
+    from importlib import import_module
+
+    _exports = {
+        "AuthenticationApi": ".authentication_api",
+        "DownloadsApi": ".downloads_api",
+        "LogbookApi": ".logbook_api",
+        "NotificationConfigurationApi": ".notification_configuration_api",
+        "PropertyValueApi": ".property_value_api",
+        "SearchApi": ".search_api",
+        "SystemLogApi": ".system_log_api",
+        "TestApi": ".test_api",
+        "UsersApi": ".users_api",
+        "DomainApi": ".domain_api",
+    }
+
+    def __getattr__(name: str) -> object:
+        if (module_name := _exports.get(name)) is None:
+            raise AttributeError(f"module {__name__!r} has no attribute {name!r}")
+        value = getattr(import_module(module_name, __name__), name)
+        globals()[name] = value
+        return value
+
+    def __dir__() -> list[str]:
+        return sorted(globals().keys() | _exports.keys())