release: 3.0.0-beta.8

.github/workflows/ci.yml

@@ -22,7 +22,7 @@ jobs:
           echo "$HOME/.rye/shims" >> $GITHUB_PATH
         env:
           RYE_VERSION: 0.24.0
-          RYE_INSTALL_OPTION: "--yes"
+          RYE_INSTALL_OPTION: '--yes'
 
       - name: Install dependencies
         run: |
@@ -39,3 +39,29 @@ jobs:
       - name: Ensure importable
         run: |
           rye run python -c 'import cloudflare'
+
+  examples:
+    name: examples
+    runs-on: ubuntu-latest
+
+    steps:
+      - uses: actions/checkout@v4
+
+      - name: Install Rye
+        run: |
+          curl -sSf https://rye-up.com/get | bash
+          echo "$HOME/.rye/shims" >> $GITHUB_PATH
+        env:
+          RYE_VERSION: 0.24.0
+          RYE_INSTALL_OPTION: "--yes"
+      - name: Install dependencies
+        run: |
+          rye sync --all-features
+
+      - env: 
+          CLOUDFLARE_ACCOUNT_ID: f037e56e89293a057740de681ac9abbe
+          CLOUDFLARE_EMAIL: [email protected]
+          CLOUDFLARE_ZONE_ID: 0da42c8d2132a9ddaf714f9e7c92011
+          CLOUDFLARE_API_KEY: ${{ secrets.CLOUDFLARE_API_KEY }}
+        run: |
+            rye run python ./examples/workers/ai/demo.py

.release-please-manifest.json

@@ -1,3 +1,3 @@
 {
-  ".": "3.0.0-beta.7"
+  ".": "3.0.0-beta.8"
 }

.stats.yml

@@ -1 +1 @@
-configured_endpoints: 1292
+configured_endpoints: 1266

README.md

@@ -30,6 +30,8 @@ from cloudflare import Cloudflare
 client = Cloudflare(
     # This is the default and can be omitted
     api_email=os.environ.get("CLOUDFLARE_EMAIL"),
+    # This is the default and can be omitted
+    api_key=os.environ.get("CLOUDFLARE_API_KEY"),
 )
 
 zone = client.zones.create(
@@ -57,6 +59,8 @@ from cloudflare import AsyncCloudflare
 client = AsyncCloudflare(
     # This is the default and can be omitted
     api_email=os.environ.get("CLOUDFLARE_EMAIL"),
+    # This is the default and can be omitted
+    api_key=os.environ.get("CLOUDFLARE_API_KEY"),
 )
 
 
@@ -76,10 +80,10 @@ Functionality between the synchronous and asynchronous clients is otherwise iden
 
 ## Using types
 
-Nested request parameters are [TypedDicts](https://docs.python.org/3/library/typing.html#typing.TypedDict). Responses are [Pydantic models](https://docs.pydantic.dev), which provide helper methods for things like:
+Nested request parameters are [TypedDicts](https://docs.python.org/3/library/typing.html#typing.TypedDict). Responses are [Pydantic models](https://docs.pydantic.dev) which also provide helper methods for things like:
 
-- Serializing back into JSON, `model.model_dump_json(indent=2, exclude_unset=True)`
-- Converting to a dictionary, `model.model_dump(exclude_unset=True)`
+- Serializing back into JSON, `model.to_json()`
+- Converting to a dictionary, `model.to_dict()`
 
 Typed requests and responses provide autocomplete and documentation within your editor. If you would like to see type errors in VS Code to help catch bugs earlier, set `python.analysis.typeCheckingMode` to `basic`.
 
@@ -352,13 +356,12 @@ You can directly override the [httpx client](https://www.python-httpx.org/api/#c
 - Additional [advanced](https://www.python-httpx.org/advanced/#client-instances) functionality
 
 ```python
-import httpx
-from cloudflare import Cloudflare
+from cloudflare import Cloudflare, DefaultHttpxClient
 
 client = Cloudflare(
     # Or use the `CLOUDFLARE_BASE_URL` env var
     base_url="http://my.test.server.example.com:8083",
-    http_client=httpx.Client(
+    http_client=DefaultHttpxClient(
         proxies="http://my.test.proxy.example.com",
         transport=httpx.HTTPTransport(local_address="0.0.0.0"),
     ),

pyproject.toml

@@ -1,6 +1,6 @@
 [project]
 name = "cloudflare"
-version = "3.0.0-beta.7"
+version = "3.0.0-beta.8"
 description = "The official Python library for the cloudflare API"
 dynamic = ["readme"]
 license = "Apache-2.0"
@@ -48,7 +48,7 @@ Repository = "https://github.com/cloudflare/cloudflare-python"
 managed = true
 # version pins are in requirements-dev.lock
 dev-dependencies = [
-    "pyright",
+    "pyright>=1.1.359",
     "mypy",
     "respx",
     "pytest",
@@ -162,7 +162,9 @@ select = [
   "T201",
   "T203",
   # misuse of typing.TYPE_CHECKING
-  "TCH004"
+  "TCH004",
+  # import rules
+  "TID251",
 ]
 ignore = [
   # mutable defaults
@@ -178,6 +180,9 @@ ignore-init-module-imports = true
 [tool.ruff.format]
 docstring-code-format = true
 
+[tool.ruff.lint.flake8-tidy-imports.banned-api]
+"functools.lru_cache".msg = "This function does not retain type information for the wrapped function's arguments; The `lru_cache` function from `_utils` should be used instead"
+
 [tool.ruff.lint.isort]
 length-sort = true
 length-sort-straight = true

requirements-dev.lock

@@ -63,7 +63,7 @@ pydantic==2.4.2
     # via cloudflare
 pydantic-core==2.10.1
     # via pydantic
-pyright==1.1.353
+pyright==1.1.359
 pytest==7.1.1
     # via pytest-asyncio
 pytest-asyncio==0.21.1

src/cloudflare/__init__.py

@@ -34,6 +34,7 @@
     UnprocessableEntityError,
     APIResponseValidationError,
 )
+from ._base_client import DefaultHttpxClient, DefaultAsyncHttpxClient
 from ._utils._logs import setup_logging as _setup_logging
 
 __all__ = [
@@ -72,6 +73,8 @@
     "DEFAULT_TIMEOUT",
     "DEFAULT_MAX_RETRIES",
     "DEFAULT_CONNECTION_LIMITS",
+    "DefaultHttpxClient",
+    "DefaultAsyncHttpxClient",
 ]
 
 _setup_logging()

src/cloudflare/_base_client.py

@@ -29,7 +29,6 @@
     cast,
     overload,
 )
-from functools import lru_cache
 from typing_extensions import Literal, override, get_origin
 
 import anyio
@@ -61,7 +60,7 @@
     RequestOptions,
     ModelBuilderProtocol,
 )
-from ._utils import is_dict, is_list, is_given, is_mapping
+from ._utils import is_dict, is_list, is_given, lru_cache, is_mapping
 from ._compat import model_copy, model_dump
 from ._models import GenericModel, FinalRequestOptions, validate_type, construct_type
 from ._response import (
@@ -715,7 +714,27 @@ def _idempotency_key(self) -> str:
         return f"stainless-python-retry-{uuid.uuid4()}"
 
 
-class SyncHttpxClientWrapper(httpx.Client):
+class _DefaultHttpxClient(httpx.Client):
+    def __init__(self, **kwargs: Any) -> None:
+        kwargs.setdefault("timeout", DEFAULT_TIMEOUT)
+        kwargs.setdefault("limits", DEFAULT_CONNECTION_LIMITS)
+        kwargs.setdefault("follow_redirects", True)
+        super().__init__(**kwargs)
+
+
+if TYPE_CHECKING:
+    DefaultHttpxClient = httpx.Client
+    """An alias to `httpx.Client` that provides the same defaults that this SDK
+    uses internally.
+
+    This is useful because overriding the `http_client` with your own instance of
+    `httpx.Client` will result in httpx's defaults being used, not ours.
+    """
+else:
+    DefaultHttpxClient = _DefaultHttpxClient
+
+
+class SyncHttpxClientWrapper(DefaultHttpxClient):
     def __del__(self) -> None:
         try:
             self.close()
@@ -1248,7 +1267,27 @@ def get_api_list(
         return self._request_api_list(model, page, opts)
 
 
-class AsyncHttpxClientWrapper(httpx.AsyncClient):
+class _DefaultAsyncHttpxClient(httpx.AsyncClient):
+    def __init__(self, **kwargs: Any) -> None:
+        kwargs.setdefault("timeout", DEFAULT_TIMEOUT)
+        kwargs.setdefault("limits", DEFAULT_CONNECTION_LIMITS)
+        kwargs.setdefault("follow_redirects", True)
+        super().__init__(**kwargs)
+
+
+if TYPE_CHECKING:
+    DefaultAsyncHttpxClient = httpx.AsyncClient
+    """An alias to `httpx.AsyncClient` that provides the same defaults that this SDK
+    uses internally.
+
+    This is useful because overriding the `http_client` with your own instance of
+    `httpx.AsyncClient` will result in httpx's defaults being used, not ours.
+    """
+else:
+    DefaultAsyncHttpxClient = _DefaultAsyncHttpxClient
+
+
+class AsyncHttpxClientWrapper(DefaultAsyncHttpxClient):
     def __del__(self) -> None:
         try:
             # TODO(someday): support non asyncio runtimes here