diff --git a/wiki/cascade-cms-wiki/docs/advanced/cpu-intensive.md b/wiki/cascade-cms-wiki/docs/advanced/cpu-intensive.md index 770cf89..3e30edf 100644 --- a/wiki/cascade-cms-wiki/docs/advanced/cpu-intensive.md +++ b/wiki/cascade-cms-wiki/docs/advanced/cpu-intensive.md @@ -6,10 +6,11 @@ By default `.then()` callbacks run on the async event loop, which is fine for I/ ## When to Use `ProcessPoolExecutor` -- Image resizing, compression, or optimization -- Parsing large XML/JSON structures or heavy data transformation -- Running intensive regular expressions across large HTML bodies -- Light callbacks like simple string replacements or metadata dictionary updates do not need it and perform better on the default thread pool or event loop. +- Image resizing, conversion, or heavy graphical optimization. +- Parsing and manipulating very large XML/HTML payloads or files. +- Executing complex data transformations or intensive calculations on asset metadata. +- Running bulk regular expressions across large text bodies. +- Light callbacks (such as a simple title string replacement or metadata dictionary update) do not need `ProcessPoolExecutor` and run efficiently on the default executor or event loop. --- @@ -18,18 +19,15 @@ By default `.then()` callbacks run on the async event loop, which is fine for I/ ```python from concurrent.futures import ProcessPoolExecutor from os import cpu_count -from cascade_cms import Cascade - -env = {"SERVER": "prod", "API_KEY": "secret", "CASCADE_URL": "https://cascade.example.com"} +# Define a module-level helper function for the callback def optimize_image(asset): - # CPU-bound image processing work here + # Perform CPU-intensive processing here return asset -with Cascade(env, {}) as cascade: - with ProcessPoolExecutor(max_workers=cpu_count()) as executor: - cascade.operations.read(id).then(optimize_image) - results = cascade.submit_requests(executor=executor) +with ProcessPoolExecutor(max_workers=cpu_count()) as executor: + cascade.operations.read(id).then(optimize_image) + results = cascade.submit_requests(executor=executor) ``` --- @@ -58,12 +56,12 @@ cascade.operations.read(id).then(transform) ## `ProcessPoolExecutor` vs `ThreadPoolExecutor` -`ProcessPoolExecutor` provides true parallelism across multiple CPU cores in separate memory spaces, but requires all callback functions and data to be picklable and incurs inter-process communication overhead. `ThreadPoolExecutor` uses shared memory with minimal overhead and no pickling restrictions, but remains limited by Python's Global Interpreter Lock (GIL) for CPU-bound tasks. Use `ProcessPoolExecutor` for heavy CPU computation, and stick with `ThreadPoolExecutor` (the default) for I/O-bound work. +`ProcessPoolExecutor` provides true parallelism across multiple CPU cores by utilizing separate memory spaces, making it ideal for CPU-bound tasks, though it requires all callbacks and arguments to be picklable and incurs higher task overhead. `ThreadPoolExecutor` uses shared memory with lower overhead and no pickling restrictions, making it great for I/O-bound work, but it remains subject to the Python GIL and is not truly parallel for CPU-heavy processing. Use `ProcessPoolExecutor` for heavy compute operations and `ThreadPoolExecutor` (or the default) for network-bound or mixed I/O and light processing workflows. --- ## Performance Considerations -Spawning and managing worker processes carries an initialization overhead, meaning extremely fast callbacks may run slower in a process pool than synchronously due to serialization costs. Additionally, offloading CPU work via the executor does not change the network concurrency rules; the driver's underlying `MAX_REQUESTS` semaphore still governs HTTP request limits. +Spawning and communicating with worker processes incurs a startup and serialization cost; for very fast callbacks, this overhead can outweigh the parallel execution benefits. Additionally, the driver's underlying `MAX_REQUESTS` semaphore continues to govern HTTP concurrency independently of whether you use a thread or process pool for your callback functions. - + diff --git a/wiki/cascade-cms-wiki/docs/advanced/index.md b/wiki/cascade-cms-wiki/docs/advanced/index.md index 36d9ed5..0f64e9b 100644 --- a/wiki/cascade-cms-wiki/docs/advanced/index.md +++ b/wiki/cascade-cms-wiki/docs/advanced/index.md @@ -1,6 +1,6 @@ # Advanced -Welcome to the advanced power user guide for tuning and scaling your application. This section covers configuration and performance topics that go beyond the defaults, including caching behavior, debug logging, and CPU-intensive callback patterns. +Welcome to the advanced section for power users who want to push the library beyond its default capabilities. This guide covers complex configuration settings, performance tuning, and strategies for handling CPU-intensive workloads. --- @@ -11,4 +11,4 @@ Welcome to the advanced power user guide for tuning and scaling your application | [Logging & Debugging](logging.md) | Enabling debug mode, configuring the debug dict, reading log output, and walking through a sample logfile | | [CPU-Intensive Tasks](cpu-intensive.md) | When to use `ProcessPoolExecutor`, pickling constraints, and performance trade-offs vs `ThreadPoolExecutor` | - + diff --git a/wiki/cascade-cms-wiki/docs/advanced/logging.md b/wiki/cascade-cms-wiki/docs/advanced/logging.md index b93a28f..910411d 100644 --- a/wiki/cascade-cms-wiki/docs/advanced/logging.md +++ b/wiki/cascade-cms-wiki/docs/advanced/logging.md @@ -1,22 +1,22 @@ -# Logging & Debugging +# Logging & Definitions -Operation logger owns all console, logfile, and (verbose mode) request/response file output for the cascade_cms library. Two output modes exist: normal mode for everyday use and debug mode for diagnosing failures, controlled solely by whether `debug_config` is `None`. Both produce logfiles; debug mode adds a verbose nested call-chain log alongside a quieter console output. +The `cascade_cms` library provides two distinct output modes: a normal mode for everyday use and a debug mode for diagnosing failures. Both modes produce logfiles, but debug mode adds a verbose nested call-chain log alongside a quieter console output. --- ## Normal Mode Output -Normal mode produces minimal console output and a simple logfile. It logs lifecycle markers such as `[INIT]`, `[RUNNING]`, `[DONE]`, and `[EXIT]`, along with batch tallies and operation progress lines. The normal logfile is named `{SERVER}_{timestamp}.log` and records one line per chain. +Normal mode uses a minimal console and a simple logfile to track execution, writing lifecycle markers (`[INIT]`, `[RUNNING]`, `[DONE]`, `[EXIT]`), per-operation progress lines, and a normal logfile named `{SERVER}_{timestamp}.log` with one line per operation. ### Normal Logfile Format ```text -[INIT]: Connecting to myserver.com -[RUNNING]: myscript.py -(uuid_or_path, asset_type) OP1 -> fn_name: Type -> ... -1/1 succeeded +[INIT]: Connecting to example.com +[LOG]: ./logs/example.com_2023-10-27T12-30-00-000000_1.log +(mySite/blog/post-1, page) READ -> edit -> publish [DONE]: 1 assets processed in 0.5s -[EXIT]: Disconnecting from myserver.com +0 failed, 1 succeeded +[EXIT]: Disconnecting from example.com ``` --- @@ -24,18 +24,13 @@ Normal mode produces minimal console output and a simple logfile. It logs lifecy ## Enabling Debug Mode ```python -wrapper = CascadeWrapperBase("myserver.com", debug_config={ - "log_dir": "./logs", - "show_network_headers": True -}) +wrapper = CascadeClient(server="example.com", debug_config={}) ``` --- ## Debug Configuration Options -Recognized `debug_config` keys control the log directory and network header visibility. - | Key | Type | Default | Description | |-----|------|---------|-------------| | log_dir | str | "./logs" | Directory for the logfile and (verbose mode) request/response JSON files. | @@ -45,14 +40,14 @@ Recognized `debug_config` keys control the log directory and network header visi ## Debug Logfile Format -The debug logfile uses the naming convention `{SERVER}_debug_{timestamp}.log`. It features a quiet console, a verbose logfile, and per-request JSON files. There is no longer a separate "log operations vs. callbacks vs. responses" toggle — `_is_debug` is the single on/off switch for verbose behavior. +The debug logfile uses the naming convention `{SERVER}_debug_{timestamp}.log` and captures quiet console, verbose logfile output plus per-request JSON files. ### Sample Debug Log ```text ->>>> START REQUEST <<+ -(uuid_or_path, asset_type) OP1 -> fn_name: Type -> ... -[GET] https://myserver.com/api/v1/read/site/path +>>>> START REQUEST <<<< +[GET] https://example.com/api/v1/read/page/mySite/blog/post-1 +(mySite/blog/post-1, page) READ -> edit -> publish 1/1 succeeded >>>> END REQUEST <<<< ``` @@ -61,6 +56,6 @@ The debug logfile uses the naming convention `{SERVER}_debug_{timestamp}.log`. I ## Interpreting Errors in Debug Mode -Error lines in debug mode utilize a `v` marker followed by an `!ERROR:` block indicating the failure at the specified step index. Chain-level failures go through `flush_chain_error` which has step-index context. `log_cascade_error` provides a thin wrapper to log a `CascadeError` (API-level failure) outside of chain context, while `log_python_error` logs an unhandled Python exception with traceback, file name, and line number. +Error blocks in debug mode render a `v` marker followed by a `!ERROR:` block aligned under the failing step's index. Network and library failures prepend `[NETWORK]` or `[CASCADE-REST-CMS]` to the error message, while cascade and callback errors receive no prefix, appending `@{file}:{line}` to the last line of the message. - + diff --git a/wiki/cascade-cms-wiki/docs/core-concepts/index.md b/wiki/cascade-cms-wiki/docs/core-concepts/index.md index 4084a01..e1df280 100644 --- a/wiki/cascade-cms-wiki/docs/core-concepts/index.md +++ b/wiki/cascade-cms-wiki/docs/core-concepts/index.md @@ -1,197 +1,90 @@ # Core Concepts -## The `Cascade` class - -`Cascade` is the single entry point for all library interactions. Open a -session with it as a [context manager](https://docs.python.org/3/reference/datamodel.html#context-managers): - -```python -from cascade_cms.wrapper import Cascade, EnvironmentVars - -env: EnvironmentVars = { - "SERVER": "my-site", - "API_KEY": "your-api-key", - "CASCADE_URL": "https://your-cascade-instance.com", -} - -with Cascade(env) as cascade: - # queue operations here - ... -``` - -Previously known as `CascadeWrapperBase`; the alias still works but `Cascade` -is the current name. - -### Constructor - -```python -Cascade( - environmentVariables: EnvironmentVars, - debug: dict[str, Any] | None = None, - *, - exit_on_failure: bool = True, - log_dir: str | os.PathLike | None = None, -) -``` - -`EnvironmentVars` is a `TypedDict` with three required keys: - -| Key | Description | -|---|---| -| `SERVER` | Label used in log output (not a network address) | -| `API_KEY` | Cascade REST API bearer token | -| `CASCADE_URL` | Base URL of your Cascade CMS instance | - -`exit_on_failure=True` (default) ends the script non-zero on any failure. -Pass `False` for long-lived processes like the MCP server. +This page breaks down the library's core mental model: wrapping your session with `Cascade`, queueing operations through `Operations`, building sequential workflows via `OperationChain`, and executing them concurrently with `submit_requests()`. --- -## Operations - -`cascade.operations` is the entry point for all CMS operations. It returns -an `Operations` builder that accepts the first call in a chain: - -```python -with Cascade(env) as cascade: - chain = cascade.operations.read("abc123") -``` - -Available operations mirror the Cascade REST API: - -| Operation | Description | -|---|---| -| `.read(id)` | Read one asset | -| `.edit(payload)` | Edit an asset via callback or direct payload | -| `.publish(id)` | Publish an asset | -| `.delete(id)` | Delete an asset | -| `.copy(id, dest)` | Copy an asset | -| `.move(id, dest)` | Move an asset | -| `.checkIn(id)` | Check in an asset | -| `.checkOut(id)` | Check out an asset | -| `.search(query)` | Search assets | -| `.create(asset)` | Create a new asset | - -See the [API Reference](../operations/operations.md) for full signatures. - ---- +## Basic Operation Calls -## Operation chains +Every script follows the same skeleton: open the wrapper as a context manager, queue operations on `cascade.operations`, chain callbacks with `.then()`, then call `submit_requests()` once to execute all chains concurrently. -Each operation call returns an `OperationChain`, not a result. Nothing -executes until you call `.submit_requests()`. This design lets you compose -multi-step workflows before any network requests are made: +### Example ```python -from cascade_cms.cmstypes import Asset - -def set_searchable(asset: Asset) -> Asset: - asset.searchable = True - return asset - -with Cascade(env) as cascade: - results = ( - cascade.operations - .read("abc123") - .edit(set_searchable) - .publish("abc123") - .submit_requests(Asset) - ) +with Cascade(env_vars) as cascade: + # Queue a read operation for an asset + chain = cascade.operations.read(identifier) + + # Submit all queued operations in a batch + results = cascade.submit_requests() + + # Check the result + result = results[0] + if isinstance(result, CascadeError): + print(f"Operation failed: {result.message}") ``` -The type argument to `.submit_requests()` is for the type checker. `Asset` -covers most cases; use a more specific type when the operation returns one. - ---- - -## `edit()` and callbacks - -`edit()` accepts a callable, a single asset, or a list of assets. The -callable form is the most common in practice: +### Expected Output ```python -def update_keywords(asset: Asset) -> Asset: - asset.keywords = "updated" - return asset - -cascade.operations.edit(update_keywords) +Asset( + _asset_type='page', + _data={ + 'id': '1234567890abcdef1234567890abcdef', + 'name': 'index', + 'path': '/index', + 'siteName': 'default', + 'displayName': 'Home Page', + ... + } +) ``` -The callback receives the current asset and must return the modified asset. -The identifier is derived from the asset's own `id`/`path`/`siteName` fields -— there is no separate identifier argument on `edit()` in 3.9.1. - --- -## Batch execution and `ChainGroup` +## Payload Models + +Payload models are typed objects (such as `SearchInformation`) that pair with specific operations to ensure the API endpoint receives the expected fields. They provide type-safety, validation, and clarity by structuring inputs correctly before they reach the REST driver. -Passing a list to operations that accept identifiers — `read`, `delete`, -`publish`, etc. — creates one independent `OperationChain` per identifier, -returned as a `ChainGroup`: +### Example: `SearchInformation` paired with `search` ```python -with Cascade(env) as cascade: - results = ( - cascade.operations - .read(["id1", "id2", "id3"]) - .submit_requests(Asset) - ) +payload = SearchInformation( + siteName="default", + searchTerms="blog", + searchFields=["name", "summary"], + searchTypes=["page", "file"] +) +cascade.operations.search(payload) ``` -Failures in one chain do not cancel others. The returned `ChainResults` -covers all chains in the group. +These models enforce required attributes and validation rules via Pydantic before requests are dispatched. Passing raw dictionaries is generally not supported for complex operations, and this pattern is shared across all parameter models like `deleteParameters`, `auditParameters`, and `copyParameters`. --- -## Result handling +## CPU-Intensive Operations -`.submit_requests()` returns `ChainResults[T]` — a list subclass with -`.success` and `.failed` properties. See [Result Handling](../getting-started/result-handling.md) -for full details. +For operations involving heavy computation in `.then()` callbacks — image processing, data transformation, bulk string manipulation — offload work to a `ProcessPoolExecutor` rather than running it on the async event loop. ```python -results = cascade.operations.read("abc123").submit_requests(Asset) - -for asset in results.success: - print(asset.path) +from concurrent.futures import ProcessPoolExecutor +from os import cpu_count -for failure in results.failed: - print(f"[{failure.category}] {failure.message}") +with ProcessPoolExecutor(max_workers=cpu_count()) as executor: + with Cascade(env_vars) as cascade: + cascade.operations.read(id).then(optimize_image) + results = cascade.submit_requests(executor=executor) ``` ---- +!!! note "Module-level functions only" + Callbacks passed to `ProcessPoolExecutor` must be defined at module level — lambdas and nested functions are not picklable and will raise at runtime. -## Script logging - -`script_log.note()` writes annotated log lines from within a script: - -```python -from cascade_cms.utils import script_log - -with Cascade(env) as cascade: - script_log.note("Starting run") - results = cascade.operations.read("abc123").submit_requests(Asset) - script_log.note(f"Done — {len(results.success)} succeeded") -``` - -Calls outside the `with` block drop silently with a `RuntimeWarning`. -API keys are automatically redacted from log output. +See [Advanced: CPU-Intensive Tasks](../advanced/cpu-intensive.md) for full configuration details, performance trade-offs, and `ThreadPoolExecutor` comparison. --- -## Identifiers - -The `utils.identifiers` module (added in 3.8.3) coerces raw Cascade -identifier dicts to `IdentifierType`: - -```python -from cascade_cms.utils.identifiers import to_identifier, to_identifiers - -identifier = to_identifier({"id": "abc123", "type": "page", "path": None}) -identifiers = to_identifiers([{"id": "a"}, {"id": "b"}]) -``` +## Next Steps -Use these when processing raw API responses before passing identifiers to -operations. +Ready to go deeper? The [Advanced](../advanced/index.md) section covers configuration topics for power users: debug logging and CPU-intensive workload patterns. - + diff --git a/wiki/cascade-cms-wiki/docs/examples/administrative-ops.md b/wiki/cascade-cms-wiki/docs/examples/administrative-ops.md index fc148e5..1fa1e30 100644 --- a/wiki/cascade-cms-wiki/docs/examples/administrative-ops.md +++ b/wiki/cascade-cms-wiki/docs/examples/administrative-ops.md @@ -13,26 +13,30 @@ skeleton as the main patterns, just applied to two unrelated features. ## Messages: list, mark, delete ```python -from cascade_cms.wrapper import Cascade -from cascade_cms.cmstypes import CascadeSuccess, ListElements +from cascade_cms import CascadeCMS, CascadeError -with Cascade(env) as cascade: +async with CascadeCMS("https://cascade.example.com", auth=("user", "pass")) as cascade: # Phase 1: List inbox messages - listed = cascade.operations.listMessages().submit_requests(ListElements) + cascade.operations.listMessages() + result = await cascade.submit_requests() - # Pick a message from the list elements - message = listed.success[0].flat[0] + if isinstance(result, CascadeError): + raise RuntimeError(result.message) - # Phase 2: Mark as read and then delete - results = ( - cascade.operations - .markMessage(message) - .deleteMessage(message) - .submit_requests(CascadeSuccess) - ) + messages = result.elements -for failure in results.failed: - print(f"[{failure.category}] {failure.step_name}: {failure.message}") + # Phase 2: Mark or delete selected messages + for msg in messages: + if msg.marked == "unread": + cascade.operations.markMessage(msg) + else: + cascade.operations.deleteMessage(msg) + + action_results = await cascade.submit_requests() + + for res in action_results: + if isinstance(res, CascadeError): + print(f"Failed: {res.message}") ``` !!! note @@ -44,22 +48,22 @@ for failure in results.failed: ## Preferences: read, edit ```python -from cascade_cms.wrapper import Cascade -from cascade_cms.cmstypes import CascadeSuccess, SimplePayload, preference +from cascade_cms import CascadeCMS, CascadeError, preference -with Cascade(env) as cascade: +async with CascadeCMS("https://cascade.example.com", auth=("user", "pass")) as cascade: # Read current preferences - prefs = cascade.operations.readPreferences().submit_requests(SimplePayload) + cascade.operations.readPreferences() + result = await cascade.submit_requests() + + if isinstance(result, CascadeError): + raise RuntimeError(result.message) - # Update a user preference - results = ( - cascade.operations - .editPreference(preference(name="pref_name", value="new_value")) - .submit_requests(CascadeSuccess) - ) + # Update a single user preference + cascade.operations.editPreference(preference(name="my-pref-key", value="new-value")) + edit_result = await cascade.submit_requests() -for failure in results.failed: - print(f"[{failure.category}] {failure.step_name}: {failure.message}") + if isinstance(edit_result, CascadeError): + raise RuntimeError(edit_result.message) ``` !!! note @@ -71,4 +75,4 @@ for failure in results.failed: See [Core Patterns](main-patterns.md) for `read`, `delete`, and `search` — the primary asset-management workflow and response-shape conventions. - + diff --git a/wiki/cascade-cms-wiki/docs/examples/main-patterns.md b/wiki/cascade-cms-wiki/docs/examples/main-patterns.md index b354156..14460be 100644 --- a/wiki/cascade-cms-wiki/docs/examples/main-patterns.md +++ b/wiki/cascade-cms-wiki/docs/examples/main-patterns.md @@ -1,191 +1,121 @@ -# Main Patterns +# Core Patterns: `read`, `delete`, `search` -Common usage patterns for `cascade-cms-rest` 3.9.1. +Every script that uses `cascade_cms` follows the same shape: open the wrapper as +a context manager, queue up one or more operations on `cascade.operations`, then +call `submit_requests()` once to run them all concurrently. -```python -from cascade_cms.wrapper import Cascade, EnvironmentVars -from cascade_cms.cmstypes import Asset - -env: EnvironmentVars = { - "SERVER": "my-site", - "API_KEY": "your-api-key", - "CASCADE_URL": "https://your-cascade-instance.com", -} -``` - ---- - -## Read a single asset +The three examples below use the same skeleton but highlight the **three +distinct response shapes** you'll see across the library: -```python -with Cascade(env) as cascade: - results = cascade.operations.read("abc123").submit_requests(Asset) +| Operation | Returns | Why it's shown | +|-----------|---------|----------------| +| `read` | A large, structured `Asset` object | Most operations that touch an existing asset return this shape | +| `delete` | A simple success object (`CascadeSuccess`) | Mutating operations that don't return data use this minimal shape | +| `search` | A list result, driven by a required `SearchInformation` payload | Shows the "operation needs a payload object" pattern | -if results.success: - asset = results.success[0] - print(asset.path) - print(asset.siteName) -``` +All three also demonstrate the same failure-handling rule: **failures are +returned as values, not raised.** Always check `isinstance(result, CascadeError)` +before using a result. --- -## Edit and save - -Use a callback that receives the current asset and returns the modified one: +## Pattern 1 — `read`: fetching a structured asset ```python -def update_metadata(asset: Asset) -> Asset: - asset.keywords = "cascade, cms, updated" - asset.metaDescription = "Updated via py-cascade-cms" - return asset - -with Cascade(env) as cascade: - results = ( - cascade.operations - .read("abc123") - .edit(update_metadata) - .submit_requests(Asset) - ) - -if results.failed: - for failure in results.failed: - print(f"[{failure.category}] {failure.step_name}: {failure.message}") +with CascadeWrapperBase("https://cascade.example.com", "username", "api-key") as cascade: + # Build a Path identifier pointing to the page asset + identifier = Path(path="about-us", site_name="Default", asset_type="page") + + # Queue a read operation and submit the batch + cascade.operations.read(identifier) + results = cascade.submit_requests() + result = results[0] + + # Guard against API-level failures + if isinstance(result, CascadeError): + print(f"Failed: {result.message}") + else: + # Access structured asset data + print(result.displayName) + print(result.metadata) ``` -The callback receives the asset after `.read()` completes. The identifier -is derived from the asset's own `id`/`path`/`siteName` fields — no separate -argument on `edit()`. +`read` represents the response shape most other "fetch" operations follow — `readAudits`, `readAccessRights`, `readWorkflowSettings`, etc. — and they all return a structured object specific to what was requested. --- -## Publish - -Chain `.publish()` after editing to write and publish in one batch: +## Pattern 2 — `delete`: a simple success response ```python -with Cascade(env) as cascade: - results = ( - cascade.operations - .read("abc123") - .edit(update_metadata) - .publish("abc123") - .submit_requests(Asset) +with CascadeWrapperBase("https://cascade.example.com", "username", "api-key") as cascade: + identifier = Path(path="old-page", site_name="Default", asset_type="page") + + # Construct delete parameters payload + payload = deleteParameters( + doWorkflow=False, + destinations=[], + unpublish=True ) + + cascade.operations.delete(identifier, payload=payload) + results = cascade.submit_requests() + result = results[0] + + if isinstance(result, CascadeError): + print(f"Delete failed: {result.message}") + else: + print("Successfully deleted asset.") ``` -Or publish without editing: - -```python -with Cascade(env) as cascade: - results = cascade.operations.publish("abc123").submit_requests(Asset) -``` +`delete` and other mutating operations (`copy`, `move`, `publish`, `checkIn`, `editAccessRights`) return confirmation only — not the modified asset — so callers should not expect asset data back from these operations. --- -## Search +## Pattern 3 — `search`: payload-driven, list response ```python -from cascade_cms.cmstypes import SearchInformation, ListElements - -payload = SearchInformation( - searchTerms="annual report", - siteName="site123", -) - -with Cascade(env) as cascade: - results = ( - cascade.operations - .search(payload) - .submit_requests(ListElements) +with CascadeWrapperBase("https://cascade.example.com", "username", "api-key") as cascade: + # Construct the required search payload + payload = SearchInformation( + siteName="Default", + searchTerms="news", + searchFields=["name"], + searchTypes=["page"] ) - -if results.success: - for item in results.success: - print(item) + + cascade.operations.search(payload) + results = cascade.submit_requests() + result = results[0] + + if isinstance(result, CascadeError): + print(f"Search failed: {result.message}") + else: + # Iterate over the flat list of matched elements + for element in result.flat: + print(element.get_id, element.get_path) ``` -`SearchInformation` is the typed payload; `ListElements` is the return type -from `.search()`. Both are in `cascade_cms.cmstypes`. - ---- - -## Bulk operations - -Pass a list of identifiers. Each gets its own independent chain — failures -in one do not cancel others: - -```python -asset_ids = ["id1", "id2", "id3"] - -def tag_asset(asset: Asset) -> Asset: - asset.tags = [{"name": "bulk-update"}] - return asset - -with Cascade(env) as cascade: - results = ( - cascade.operations - .read(asset_ids) - .edit(tag_asset) - .publish(asset_ids) - .submit_requests(Asset) - ) - -print(f"{len(results.success)} updated, {len(results.failed)} failed") - -for failure in results.failed: - print(f" {failure.identifier}: [{failure.category}] {failure.message}") -``` +`search` requires a typed payload object — there is no bare identifier shortcut — and naming the other operations that follow the same pattern: `readAudits` (`auditParameters`), `editWorkflowSettings`, etc. --- -## Handling failures by category - -`ChainFailure.category` holds the `FailureCategory` value — use it directly: - -```python -from cascade_cms.utils.failures import FailureCategory - -with Cascade(env, exit_on_failure=False) as cascade: - results = cascade.operations.read(asset_ids).submit_requests(Asset) - -network_errors = [] -cascade_errors = [] +## Chaining and Batching -for failure in results.failed: - if failure.category == FailureCategory.NETWORK: - network_errors.append(failure.identifier) - elif failure.category == FailureCategory.CASCADE: - cascade_errors.append(failure.identifier) - -if network_errors: - print(f"Network failures (retry candidates): {network_errors}") -if cascade_errors: - print(f"Cascade errors (check identifiers): {cascade_errors}") -``` - -`exit_on_failure=False` keeps the process alive to inspect failures -programmatically. - ---- - -## Script logging +All three patterns above run a single operation per script. In practice you can +queue multiple chains — even mixing operation types — before calling +`submit_requests()` once: ```python -from cascade_cms.utils import script_log - -with Cascade(env) as cascade: - script_log.note("Starting bulk keyword update") - - results = ( - cascade.operations - .read(asset_ids) - .edit(tag_asset) - .submit_requests(Asset) - ) - - script_log.note(f"Complete: {len(results.success)} updated") +with CascadeWrapperBase("https://cascade.example.com", "username", "api-key") as cascade: + # Queue three independent chains + cascade.operations.read(Path(path="home", site_name="Default", asset_type="page")) + cascade.operations.delete(Path(path="temp-file", site_name="Default", asset_type="file")) + cascade.operations.search(SearchInformation(siteName="Default", searchTerms="report")) + + # All three run concurrently and results are returned in creation order + results = cascade.submit_requests() ``` -`script_log.note()` only works inside the `with` block. +See [Administrative Operations](administrative-ops.md) for the `messages` and `preferences` operations. - +