cozeloop 0.1.0__tar.gz

cozeloop-0.1.0/LICENSE

@@ -0,0 +1,21 @@
+MIT License
+
+Copyright (c) 2025 Bytedance Ltd. and/or its affiliates
+
+Permission is hereby granted, free of charge, to any person obtaining a copy
+of this software and associated documentation files (the "Software"), to deal
+in the Software without restriction, including without limitation the rights
+to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
+copies of the Software, and to permit persons to whom the Software is
+furnished to do so, subject to the following conditions:
+
+The above copyright notice and this permission notice shall be included in all
+copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
+AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
+OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
+SOFTWARE.

cozeloop-0.1.0/PKG-INFO

@@ -0,0 +1,97 @@
+Metadata-Version: 2.3
+Name: cozeloop
+Version: 0.1.0
+Summary: coze loop sdk
+License: MIT
+Author: JiangQi715
+Author-email: jiangqi.rrt@bytedance.com
+Requires-Python: >=3.8,<4.0
+Classifier: License :: OSI Approved :: MIT License
+Classifier: Programming Language :: Python :: 3
+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
+Requires-Dist: apscheduler (>=3.11.0,<4.0.0)
+Requires-Dist: authlib (>=1.2.0,<2.0.0)
+Requires-Dist: cachetools (>=5.5.2,<6.0.0)
+Requires-Dist: httpx (>=0.28.1,<0.29.0)
+Requires-Dist: jinja2 (>=3.1.6,<4.0.0)
+Requires-Dist: pydantic (>=2.10.6,<3.0.0)
+Description-Content-Type: text/markdown
+
+# Loop Go SDK
+English | [简体中文](README.zh_CN.md)
+
+## Overview
+
+The Loop SDK is a Python client for interacting with [CozeLoop platform](https://loop.coze.cn).
+Key features:
+- Report trace
+- Get and format prompt
+
+## Requirements
+- Python 3.8 or higher
+
+## Installation
+
+`pip install CozeLoop`
+
+## Usage
+
+### Initialize
+
+To get started, visit https://www.coze.cn/open/oauth/apps and create an OAuth app.
+Then you can get your owner appid, public key and private key.
+
+Set your environment variables:
+```bash
+export COZELOOP_WORKSPACE_ID=your workspace id
+export COZELOOP_JWT_OAUTH_CLIENT_ID=your client id
+export COZELOOP_JWT_OAUTH_PRIVATE_KEY=your private key
+export COZELOOP_JWT_OAUTH_PUBLIC_KEY_ID=your public key id
+```
+
+### Report Trace
+
+```python
+def main():
+    span = cozeloop.start_span("root", "custom")
+
+    span.set_input("Hello") 
+    span.set_output("World") 
+	
+    span.finish()
+	
+    cozeloop.close()
+```
+
+### Get Prompt
+```python
+def main():
+    prompt = cozeloop.get_prompt(prompt_key="your_prompt_key")
+    messages = cozeloop.prompt_format(
+        prompt,
+        {"var1": "your content"},
+    )
+```
+
+You can see more examples [here](examples).
+
+## Contribution
+
+Please check [Contributing](CONTRIBUTING.md) for more details.
+
+## Security
+
+If you discover a potential security issue in this project, or think you may
+have discovered a security issue, we ask that you notify Bytedance Security via our [security center](https://security.bytedance.com/src) or [vulnerability reporting email](sec@bytedance.com).
+
+Please do **not** create a public GitHub issue.
+
+## License
+
+This project is licensed under the [MIT License](LICENSE).
+

cozeloop-0.1.0/README.md

@@ -0,0 +1,72 @@
+# Loop Go SDK
+English | [简体中文](README.zh_CN.md)
+
+## Overview
+
+The Loop SDK is a Python client for interacting with [CozeLoop platform](https://loop.coze.cn).
+Key features:
+- Report trace
+- Get and format prompt
+
+## Requirements
+- Python 3.8 or higher
+
+## Installation
+
+`pip install CozeLoop`
+
+## Usage
+
+### Initialize
+
+To get started, visit https://www.coze.cn/open/oauth/apps and create an OAuth app.
+Then you can get your owner appid, public key and private key.
+
+Set your environment variables:
+```bash
+export COZELOOP_WORKSPACE_ID=your workspace id
+export COZELOOP_JWT_OAUTH_CLIENT_ID=your client id
+export COZELOOP_JWT_OAUTH_PRIVATE_KEY=your private key
+export COZELOOP_JWT_OAUTH_PUBLIC_KEY_ID=your public key id
+```
+
+### Report Trace
+
+```python
+def main():
+    span = cozeloop.start_span("root", "custom")
+
+    span.set_input("Hello") 
+    span.set_output("World") 
+	
+    span.finish()
+	
+    cozeloop.close()
+```
+
+### Get Prompt
+```python
+def main():
+    prompt = cozeloop.get_prompt(prompt_key="your_prompt_key")
+    messages = cozeloop.prompt_format(
+        prompt,
+        {"var1": "your content"},
+    )
+```
+
+You can see more examples [here](examples).
+
+## Contribution
+
+Please check [Contributing](CONTRIBUTING.md) for more details.
+
+## Security
+
+If you discover a potential security issue in this project, or think you may
+have discovered a security issue, we ask that you notify Bytedance Security via our [security center](https://security.bytedance.com/src) or [vulnerability reporting email](sec@bytedance.com).
+
+Please do **not** create a public GitHub issue.
+
+## License
+
+This project is licensed under the [MIT License](LICENSE).

cozeloop-0.1.0/cozeloop/__init__.py

@@ -0,0 +1,33 @@
+# Copyright (c) 2025 Bytedance Ltd. and/or its affiliates
+# SPDX-License-Identifier: MIT
+
+from .entities.prompt import Prompt, Message
+import cozeloop.entities
+from .logger import set_log_level, add_log_handler
+
+from .internal import __version__
+from .internal.consts import (
+    CN_BASE_URL,
+)
+from .internal.consts.error import *
+
+from .client import Client
+from ._client import (
+    new_client,
+    workspace_id,
+    close,
+    get_prompt,
+    prompt_format,
+    start_span,
+    get_span_from_context,
+    get_span_from_header,
+    flush,
+    ENV_API_BASE_URL,
+    ENV_WORKSPACE_ID,
+    ENV_API_TOKEN,
+    ENV_JWT_OAUTH_CLIENT_ID,
+    ENV_JWT_OAUTH_PRIVATE_KEY,
+    ENV_JWT_OAUTH_PUBLIC_KEY_ID
+)
+
+from .span import SpanContext, Span

cozeloop-0.1.0/cozeloop/_client.py

@@ -0,0 +1,315 @@
+# Copyright (c) 2025 Bytedance Ltd. and/or its affiliates
+# SPDX-License-Identifier: MIT
+
+import atexit
+import hashlib
+import logging
+import os
+import threading
+from datetime import datetime
+from typing import Dict, Any, List, Optional
+
+from cozeloop.client import Client
+from cozeloop._noop import NOOP_SPAN, _NoopClient
+from cozeloop.entities.prompt import Prompt, Message, PromptVariable
+from cozeloop.internal import consts, httpclient
+from cozeloop.internal.consts import ClientClosedError
+from cozeloop.internal.httpclient import Auth
+from cozeloop.internal.prompt import PromptProvider
+from cozeloop.internal.trace import TraceProvider
+from cozeloop.span import SpanContext, Span
+
+logger = logging.getLogger(__name__)
+
+# environment keys for loop client
+ENV_API_BASE_URL = "COZELOOP_API_BASE_URL"
+ENV_WORKSPACE_ID = "COZELOOP_WORKSPACE_ID"
+ENV_API_TOKEN = "COZELOOP_API_TOKEN"
+ENV_JWT_OAUTH_CLIENT_ID = "COZELOOP_JWT_OAUTH_CLIENT_ID"
+ENV_JWT_OAUTH_PRIVATE_KEY = "COZELOOP_JWT_OAUTH_PRIVATE_KEY"
+ENV_JWT_OAUTH_PUBLIC_KEY_ID = "COZELOOP_JWT_OAUTH_PUBLIC_KEY_ID"
+
+_client_cache = {}
+_cache_lock = threading.Lock()
+
+_default_client = None
+_client_lock = threading.Lock()
+
+
+def _generate_cache_key(*args) -> str:
+    key_str = "\t".join(str(arg) for arg in args)
+    return hashlib.md5(key_str.encode('utf-8')).hexdigest()
+
+
+def new_client(
+        api_base_url: str = "",
+        workspace_id: str = "",
+        api_token: str = "",
+        jwt_oauth_client_id: str = "",
+        jwt_oauth_private_key: str = "",
+        jwt_oauth_public_key_id: str = "",
+        timeout: int = consts.DEFAULT_TIMEOUT,
+        upload_timeout: int = consts.DEFAULT_UPLOAD_TIMEOUT,
+        ultra_large_report: bool = False,
+        prompt_cache_max_count: int = consts.DEFAULT_PROMPT_CACHE_MAX_COUNT,
+        prompt_cache_refresh_interval: int = consts.DEFAULT_PROMPT_CACHE_REFRESH_INTERVAL,
+        prompt_trace: bool = False,
+) -> Client:
+    cache_key = _generate_cache_key(
+        api_base_url,
+        workspace_id,
+        api_token,
+        jwt_oauth_client_id,
+        jwt_oauth_private_key,
+        jwt_oauth_public_key_id,
+        timeout,
+        upload_timeout,
+        ultra_large_report,
+        prompt_cache_max_count,
+        prompt_cache_refresh_interval,
+        prompt_trace
+    )
+
+    with _cache_lock:
+        if cache_key in _client_cache:
+            logger.warning("You shouldn't creating a client with same options repeatedly, " +
+                           "return the cached client instead.")
+            return _client_cache[cache_key]
+        client = _LoopClient(
+            api_base_url=api_base_url,
+            workspace_id=workspace_id,
+            api_token=api_token,
+            jwt_oauth_client_id=jwt_oauth_client_id,
+            jwt_oauth_private_key=jwt_oauth_private_key,
+            jwt_oauth_public_key_id=jwt_oauth_public_key_id,
+            timeout=timeout,
+            upload_timeout=upload_timeout,
+            ultra_large_report=ultra_large_report,
+            prompt_cache_max_count=prompt_cache_max_count,
+            prompt_cache_refresh_interval=prompt_cache_refresh_interval,
+            prompt_trace=prompt_trace,
+        )
+        _client_cache[cache_key] = client
+        return client
+
+
+class _LoopClient(Client):
+    _workspace_id: str
+    _trace_provider: TraceProvider
+    _prompt_provider: PromptProvider
+
+    _closed: bool = False
+
+    def __init__(
+            self,
+            api_base_url: str = "",
+            workspace_id: str = "",
+            api_token: str = "",
+            jwt_oauth_client_id: str = "",
+            jwt_oauth_private_key: str = "",
+            jwt_oauth_public_key_id: str = "",
+            timeout: int = consts.DEFAULT_TIMEOUT,
+            upload_timeout: int = consts.DEFAULT_UPLOAD_TIMEOUT,
+            ultra_large_report: bool = False,
+            prompt_cache_max_count: int = consts.DEFAULT_PROMPT_CACHE_MAX_COUNT,
+            prompt_cache_refresh_interval: int = consts.DEFAULT_PROMPT_CACHE_REFRESH_INTERVAL,
+            prompt_trace: bool = False
+    ):
+        workspace_id = self._get_from_env(workspace_id, ENV_WORKSPACE_ID)
+        api_base_url = self._get_from_env(api_base_url, ENV_API_BASE_URL)
+        api_token = self._get_from_env(api_token, ENV_API_TOKEN)
+        jwt_oauth_client_id = self._get_from_env(jwt_oauth_client_id, ENV_JWT_OAUTH_CLIENT_ID)
+        jwt_oauth_private_key = self._get_from_env(jwt_oauth_private_key, ENV_JWT_OAUTH_PRIVATE_KEY)
+        jwt_oauth_public_key_id = self._get_from_env(jwt_oauth_public_key_id, ENV_JWT_OAUTH_PUBLIC_KEY_ID)
+
+        api_base_url = consts.CN_BASE_URL if not api_base_url else api_base_url
+        api_base_url = api_base_url.strip().rstrip("/")
+
+        if not api_base_url:
+            raise consts.InvalidParamError("api_base_url is required.")
+        if not workspace_id:
+            raise consts.InvalidParamError("workspace_id is required.")
+        if prompt_cache_max_count <= 0:
+            prompt_cache_max_count = consts.DEFAULT_PROMPT_CACHE_MAX_COUNT
+        if prompt_cache_refresh_interval <= 0:
+            prompt_cache_refresh_interval = consts.DEFAULT_PROMPT_CACHE_REFRESH_INTERVAL
+
+        self._workspace_id = workspace_id
+        inner_client = httpclient.HTTPClient()
+        auth = self._build_auth(
+            api_base_url=api_base_url,
+            http_client=inner_client,
+            api_token=api_token,
+            jwt_oauth_client_id=jwt_oauth_client_id,
+            jwt_oauth_private_key=jwt_oauth_private_key,
+            jwt_oauth_public_key_id=jwt_oauth_public_key_id
+        )
+        http_client = httpclient.Client(
+            api_base_url=api_base_url,
+            http_client=inner_client,
+            auth=auth,
+            timeout=timeout,
+            upload_timeout=upload_timeout
+        )
+        self._trace_provider = TraceProvider(
+            http_client=http_client,
+            workspace_id=workspace_id,
+            ultra_large_report=ultra_large_report
+        )
+        self._prompt_provider = PromptProvider(
+            workspace_id=workspace_id,
+            http_client=http_client,
+            trace_provider=self._trace_provider,
+            prompt_cache_max_count=prompt_cache_max_count,
+            prompt_cache_refresh_interval=prompt_cache_refresh_interval,
+            prompt_trace=prompt_trace
+        )
+
+    def _get_from_env(self, val: str, env_key: str) -> str:
+        if val:
+            return val
+        env_val = os.environ.get(env_key)
+        if env_val:
+            return env_val
+        else:
+            return ""
+
+    def _build_auth(
+            self,
+            api_base_url: str,
+            http_client: httpclient.HTTPClient,
+            api_token: str,
+            jwt_oauth_client_id: str,
+            jwt_oauth_private_key: str,
+            jwt_oauth_public_key_id: str
+    ) -> Auth:
+        if jwt_oauth_client_id and jwt_oauth_private_key and jwt_oauth_public_key_id:
+            return httpclient.JWTAuth(
+                client_id=jwt_oauth_client_id,
+                private_key=jwt_oauth_private_key,
+                public_key_id=jwt_oauth_public_key_id,
+                base_url=api_base_url,
+                http_client=http_client
+            )
+        if api_token:
+            return httpclient.TokenAuth(api_token)
+        raise consts.AuthInfoRequiredError
+
+    def workspace_id(self) -> str:
+        # Return the space ID
+        return self._workspace_id
+
+    def close(self):
+        if self._closed:
+            return
+        # Perform cleanup by flushing and closing the trace client
+        self._trace_provider.close_trace()
+        self._closed = True
+
+    def get_prompt(self, prompt_key: str, version: str = '') -> Optional[Prompt]:
+        if self._closed:
+            raise ClientClosedError()
+        return self._prompt_provider.get_prompt(prompt_key, version)
+
+    def prompt_format(self, prompt: Prompt, variables: Dict[str, PromptVariable]) -> List[Message]:
+        if self._closed:
+            raise ClientClosedError()
+        return self._prompt_provider.prompt_format(prompt, variables)
+
+    def start_span(
+            self,
+            name: str,
+            span_type: str,
+            *,
+            start_time: Optional[datetime] = None,
+            child_of: Optional[SpanContext] = None,
+            start_new_trace: bool = False,
+    ) -> Span:
+        if self._closed:
+            return NOOP_SPAN
+        try:
+            if child_of is None:
+                return self._trace_provider.start_span(name=name, span_type=span_type, start_time=start_time,
+                                                       start_new_trace=start_new_trace)
+            else:
+                return self._trace_provider.start_span(name=name, span_type=span_type, start_time=start_time,
+                                                       parent_span_id=child_of.span_id, trace_id=child_of.trace_id,
+                                                       baggage=child_of.baggage, start_new_trace=start_new_trace)
+        except Exception as e:
+            logger.warning(f"Start span failed, returning noop span. Error: {e}")
+            return NOOP_SPAN
+
+    def get_span_from_context(self) -> Span:
+        if self._closed:
+            return NOOP_SPAN
+        span = self._trace_provider.get_span_from_context()
+        if span is None:
+            return NOOP_SPAN
+        return span
+
+    def get_span_from_header(self, header: dict) -> SpanContext:
+        if self._closed:
+            return NOOP_SPAN
+        return self._trace_provider.get_span_from_header(header)
+
+    def flush(self):
+        if self._closed:
+            return
+        self._trace_provider.flush()
+
+
+def get_default_client() -> Client:
+    global _default_client
+    if _default_client is None:
+        with _client_lock:
+            if _default_client is None:
+                try:
+                    _default_client = new_client()
+                    atexit.register(_graceful_shutdown)
+                except Exception as e:
+                    new_exception = e
+                    _default_client = _NoopClient(new_exception)
+    return _default_client
+
+
+def _graceful_shutdown():
+    global _default_client
+    with _client_lock:
+        if _default_client is not None:
+            logger.info("Starting graceful shutdown...")
+            _default_client.close()
+            _default_client = _NoopClient(ClientClosedError())
+            logger.info("Graceful shutdown finished.")
+
+
+def workspace_id() -> str:
+    return get_default_client().workspace_id
+
+
+def close():
+    return get_default_client().close()
+
+
+def get_prompt(prompt_key: str, version: str = '') -> Prompt:
+    return get_default_client().get_prompt(prompt_key, version)
+
+
+def prompt_format(prompt: Prompt, variables: Dict[str, Any]) -> List[Message]:
+    return get_default_client().prompt_format(prompt, variables)
+
+
+def start_span(name: str, span_type: str, *, start_time: Optional[int] = None,
+               child_of: Optional[SpanContext] = None) -> Span:
+    return get_default_client().start_span(name, span_type, start_time=start_time, child_of=child_of)
+
+
+def get_span_from_context() -> Span:
+    return get_default_client().get_span_from_context()
+
+
+def get_span_from_header(header: Dict[str, str]) -> SpanContext:
+    return get_default_client().get_span_from_header(header)
+
+
+def flush() -> None:
+    return get_default_client().flush()

cozeloop-0.1.0/cozeloop/_noop.py

@@ -0,0 +1,52 @@
+# Copyright (c) 2025 Bytedance Ltd. and/or its affiliates
+# SPDX-License-Identifier: MIT
+
+import logging
+from typing import Dict, Optional, List
+
+from cozeloop.client import Client
+from cozeloop.entities.prompt import Prompt, Message, PromptVariable
+from cozeloop.internal.trace.noop_span import NoopSpan
+from cozeloop.span import SpanContext, Span
+
+NOOP_SPAN = NoopSpan()
+
+
+logger = logging.getLogger(__name__)
+
+
+class _NoopClient(Client):
+    def __init__(self, e: Exception):
+        self.new_exception = e
+
+    @property
+    def workspace_id(self) -> str:
+        logger.warning(f"Noop client not supported. {self.new_exception}")
+        return ""
+
+    def close(self):
+        logger.warning(f"Noop client not supported. {self.new_exception}")
+
+    def get_prompt(self, prompt_key: str, version: str = '') -> Optional[Prompt]:
+        logger.warning(f"Noop client not supported. {self.new_exception}")
+        raise self.new_exception
+
+    def prompt_format(self, prompt: Prompt, variables: Dict[str, PromptVariable]) -> List[Message]:
+        logger.warning(f"Noop client not supported. {self.new_exception}")
+        raise self.new_exception
+
+    def start_span(self, name: str, span_type: str, *, start_time: Optional[int] = None,
+                   child_of: Optional[SpanContext] = None, start_new_trace: bool = False) -> Span:
+        logger.warning(f"Noop client not supported. {self.new_exception}")
+        return NOOP_SPAN
+
+    def get_span_from_context(self) -> Span:
+        logger.warning(f"Noop client not supported. {self.new_exception}")
+        return NOOP_SPAN
+
+    def get_span_from_header(self, header: Dict[str, str]) -> SpanContext:
+        logger.warning(f"Noop client not supported. {self.new_exception}")
+        return NOOP_SPAN
+
+    def flush(self) -> None:
+        logger.warning(f"Noop client not supported. {self.new_exception}")

cozeloop-0.1.0/cozeloop/attribute/__init__.py

@@ -0,0 +1,3 @@
+# Copyright (c) 2025 Bytedance Ltd. and/or its affiliates
+# SPDX-License-Identifier: MIT
+

cozeloop-0.1.0/cozeloop/attribute/trace/__init__.py

@@ -0,0 +1,3 @@
+# Copyright (c) 2025 Bytedance Ltd. and/or its affiliates
+# SPDX-License-Identifier: MIT
+