Skip to content

ccproxy.core.types

ccproxy.core.types

Core type definitions for the proxy system.

ProxyMethod

Bases: str, Enum

HTTP methods supported by the proxy.

ProxyProtocol

Bases: str, Enum

Protocols supported by the proxy.

ProxyRequest dataclass

ProxyRequest(
    method,
    url,
    headers=dict(),
    params=dict(),
    body=None,
    protocol=HTTPS,
    timeout=None,
    metadata=dict(),
)

Represents a proxy request.

ProxyResponse dataclass

ProxyResponse(
    status_code, headers=dict(), body=None, metadata=dict()
)

Represents a proxy response.

is_success property

is_success

Check if the response indicates success.

is_error property

is_error

Check if the response indicates an error.

TransformContext dataclass

TransformContext(
    request=None, response=None, metadata=dict()
)

Context passed to transformers during transformation.

get

get(key, default=None)

Get a value from metadata.

Source code in ccproxy/core/types.py
def get(self, key: str, default: Any = None) -> Any:
    """Get a value from metadata."""
    return self.metadata.get(key, default)

set

set(key, value)

Set a value in metadata.

Source code in ccproxy/core/types.py
def set(self, key: str, value: Any) -> None:
    """Set a value in metadata."""
    self.metadata[key] = value

ProxyConfig

Bases: BaseModel

Configuration for proxy behavior.

MiddlewareConfig

Bases: BaseModel

Configuration for middleware behavior.