ghostcrawl 2.1.0__py3-none-any.whl

ghostcrawl/__init__.py

@@ -0,0 +1,271 @@
+# This file was auto-generated by Fern from our API Definition.
+
+# isort: skip_file
+
+import typing
+from importlib import import_module
+
+if typing.TYPE_CHECKING:
+    from .types import (
+        AuditEventOut,
+        AuditEventsResponse,
+        CookieDict,
+        CookieDictSameSite,
+        DeviceAuthEnvelope,
+        DevicePollRequest,
+        EnrollResponse,
+        HttpValidationError,
+        LinkConfirmResponse,
+        LinkDeclineResponse,
+        PasswordResetConfirmResponse,
+        PasswordResetRequestResponse,
+        RegenerateResponse,
+        ResendResponse,
+        RetryDeliveryResponse,
+        RotateSecretResponse,
+        SignupResponse,
+        TokenCreateResponse,
+        TokenListItem,
+        TokenListResponse,
+        UnlinkResponse,
+        UserShape,
+        ValidationError,
+        ValidationErrorLocItem,
+        VerifyResponse,
+        WebhookCreateResponse,
+        WebhookDeliveryListResponse,
+        WebhookDeliveryPublic,
+        WebhookListResponse,
+        WebhookPublic,
+        WebhooksQueueResponse,
+    )
+    from .errors import UnprocessableEntityError
+    from . import (
+        audit,
+        auth,
+        auth_tokens,
+        budgets,
+        crawl_runs,
+        datasets,
+        management,
+        mfa,
+        oauth,
+        observability,
+        page,
+        profiles,
+        recordings,
+        screenshot_blobs,
+        script,
+        sessions,
+        storage_states,
+        webhooks,
+    )
+    from ._default_clients import DefaultAioHttpClient, DefaultAsyncHttpxClient
+    from .audit import ListEventsAuditRequestOutcome
+    from .client import AsyncGhostcrawlClient, GhostcrawlClient
+    from .page import ScrollBodyDirection
+_dynamic_imports: typing.Dict[str, str] = {
+    "AsyncGhostcrawlClient": ".client",
+    "AuditEventOut": ".types",
+    "AuditEventsResponse": ".types",
+    "CookieDict": ".types",
+    "CookieDictSameSite": ".types",
+    "DefaultAioHttpClient": "._default_clients",
+    "DefaultAsyncHttpxClient": "._default_clients",
+    "DeviceAuthEnvelope": ".types",
+    "DevicePollRequest": ".types",
+    "EnrollResponse": ".types",
+    "GhostcrawlClient": ".client",
+    "HttpValidationError": ".types",
+    "LinkConfirmResponse": ".types",
+    "LinkDeclineResponse": ".types",
+    "ListEventsAuditRequestOutcome": ".audit",
+    "PasswordResetConfirmResponse": ".types",
+    "PasswordResetRequestResponse": ".types",
+    "RegenerateResponse": ".types",
+    "ResendResponse": ".types",
+    "RetryDeliveryResponse": ".types",
+    "RotateSecretResponse": ".types",
+    "ScrollBodyDirection": ".page",
+    "SignupResponse": ".types",
+    "TokenCreateResponse": ".types",
+    "TokenListItem": ".types",
+    "TokenListResponse": ".types",
+    "UnlinkResponse": ".types",
+    "UnprocessableEntityError": ".errors",
+    "UserShape": ".types",
+    "ValidationError": ".types",
+    "ValidationErrorLocItem": ".types",
+    "VerifyResponse": ".types",
+    "WebhookCreateResponse": ".types",
+    "WebhookDeliveryListResponse": ".types",
+    "WebhookDeliveryPublic": ".types",
+    "WebhookListResponse": ".types",
+    "WebhookPublic": ".types",
+    "WebhooksQueueResponse": ".types",
+    "audit": ".audit",
+    "auth": ".auth",
+    "auth_tokens": ".auth_tokens",
+    "budgets": ".budgets",
+    "crawl_runs": ".crawl_runs",
+    "datasets": ".datasets",
+    "management": ".management",
+    "mfa": ".mfa",
+    "oauth": ".oauth",
+    "observability": ".observability",
+    "page": ".page",
+    "profiles": ".profiles",
+    "recordings": ".recordings",
+    "screenshot_blobs": ".screenshot_blobs",
+    "script": ".script",
+    "sessions": ".sessions",
+    "storage_states": ".storage_states",
+    "webhooks": ".webhooks",
+    # --- Phase 140.4-24 — hand-written surface from ._ghostcrawl ---------------
+    # These are eagerly imported at the bottom of this module via
+    # `from ._ghostcrawl import ...`. Registering them in `_dynamic_imports`
+    # makes them visible to `__dir__()` and documents the canonical lazy-import
+    # path that Fern's regeneration is expected to preserve (sdk-f013, sdk-f014).
+    "Ghostcrawl": "._ghostcrawl",
+    "identity": "._ghostcrawl",
+    "Client": "._ghostcrawl",
+    "GhostcrawlError": "._ghostcrawl",
+    "AuthenticationError": "._ghostcrawl",
+    "InvalidRequestError": "._ghostcrawl",
+    "APIError": "._ghostcrawl",
+    "ProviderConfigError": "._ghostcrawl",
+}
+
+
+def __getattr__(attr_name: str) -> typing.Any:
+    module_name = _dynamic_imports.get(attr_name)
+    if module_name is None:
+        raise AttributeError(f"No {attr_name} found in _dynamic_imports for module name -> {__name__}")
+    try:
+        module = import_module(module_name, __package__)
+        if module_name == f".{attr_name}":
+            return module
+        else:
+            return getattr(module, attr_name)
+    except ImportError as e:
+        raise ImportError(f"Failed to import {attr_name} from {module_name}: {e}") from e
+    except AttributeError as e:
+        raise AttributeError(f"Failed to get {attr_name} from {module_name}: {e}") from e
+
+
+def __dir__():
+    lazy_attrs = list(_dynamic_imports.keys())
+    return sorted(lazy_attrs)
+
+
+__all__ = [
+    "AsyncGhostcrawlClient",
+    "AuditEventOut",
+    "AuditEventsResponse",
+    "CookieDict",
+    "CookieDictSameSite",
+    "DefaultAioHttpClient",
+    "DefaultAsyncHttpxClient",
+    "DeviceAuthEnvelope",
+    "DevicePollRequest",
+    "EnrollResponse",
+    "GhostcrawlClient",
+    "HttpValidationError",
+    "LinkConfirmResponse",
+    "LinkDeclineResponse",
+    "ListEventsAuditRequestOutcome",
+    "PasswordResetConfirmResponse",
+    "PasswordResetRequestResponse",
+    "RegenerateResponse",
+    "ResendResponse",
+    "RetryDeliveryResponse",
+    "RotateSecretResponse",
+    "ScrollBodyDirection",
+    "SignupResponse",
+    "TokenCreateResponse",
+    "TokenListItem",
+    "TokenListResponse",
+    "UnlinkResponse",
+    "UnprocessableEntityError",
+    "UserShape",
+    "ValidationError",
+    "ValidationErrorLocItem",
+    "VerifyResponse",
+    "WebhookCreateResponse",
+    "WebhookDeliveryListResponse",
+    "WebhookDeliveryPublic",
+    "WebhookListResponse",
+    "WebhookPublic",
+    "WebhooksQueueResponse",
+    "audit",
+    "auth",
+    "auth_tokens",
+    "budgets",
+    "crawl_runs",
+    "datasets",
+    "management",
+    "mfa",
+    "oauth",
+    "observability",
+    "page",
+    "profiles",
+    "recordings",
+    "screenshot_blobs",
+    "script",
+    "sessions",
+    "storage_states",
+    "webhooks",
+    # --- Phase 117 additions (NOT Fern-generated) ---
+    "Ghostcrawl",
+    "identity",
+    "GhostcrawlError",
+    "AuthenticationError",
+    "InvalidRequestError",
+    "APIError",
+    "ProviderConfigError",
+]
+
+
+# =============================================================================
+# Phase 117 — SaaS public SDK surface
+# =============================================================================
+# NOTE: This section is hand-written and is NOT generated by Fern.
+# Future Fern regeneration will only touch the section above.
+# Fern regeneration is safe because this block is appended after __all__ and
+# uses only absolute imports within the same package.
+#
+# Phase 140.4-24 (sdk-f001/013/014): the 322-line `Ghostcrawl` class + the
+# functional `identity` wrapper + the `Client` alias + the error re-exports
+# now live in `_ghostcrawl.py`. Keeping them out of this Fern-managed file
+# means `fern generate` cannot clobber them. The re-export below is the
+# canonical surface; do NOT inline the class back here.
+# =============================================================================
+
+import typing as _typing  # noqa: F401 — kept for downstream re-export hygiene
+import os as _os  # noqa: F401
+
+from ._ghostcrawl import (
+    Ghostcrawl,
+    identity,
+    Client,
+    GhostcrawlError,
+    AuthenticationError,
+    InvalidRequestError,
+    APIError,
+    ProviderConfigError,
+)
+
+
+
+# =============================================================================
+# Phase 140.2 Wave 2 — SDK ergonomic extensions (SDK-PY-01/02/03)
+# =============================================================================
+# NOTE: Hand-written. Not Fern-generated. Future fern generate will not touch
+# this block (it is appended after the generated __all__ + Phase 117 section).
+# =============================================================================
+
+from .params import encode_js_snippet, format_cookies, format_cookies_urlencoded, build_extract_rules, build_js_scenario
+from .retry_policy import RetryPolicy, with_retries
+from .branded import branded_client, _ua_string as _ghostcrawl_ua_string
+
+

ghostcrawl/_default_clients.py

@@ -0,0 +1,30 @@
+# This file was auto-generated by Fern from our API Definition.
+
+import typing
+
+import httpx
+
+SDK_DEFAULT_TIMEOUT = 60
+
+try:
+    import httpx_aiohttp  # type: ignore[import-not-found]
+except ImportError:
+
+    class DefaultAioHttpClient(httpx.AsyncClient):  # type: ignore
+        def __init__(self, **kwargs: typing.Any) -> None:
+            raise RuntimeError("To use the aiohttp client, install the aiohttp extra: pip install package[aiohttp]")
+
+else:
+
+    class DefaultAioHttpClient(httpx_aiohttp.HttpxAiohttpClient):  # type: ignore
+        def __init__(self, **kwargs: typing.Any) -> None:
+            kwargs.setdefault("timeout", SDK_DEFAULT_TIMEOUT)
+            kwargs.setdefault("follow_redirects", True)
+            super().__init__(**kwargs)
+
+
+class DefaultAsyncHttpxClient(httpx.AsyncClient):
+    def __init__(self, **kwargs: typing.Any) -> None:
+        kwargs.setdefault("timeout", SDK_DEFAULT_TIMEOUT)
+        kwargs.setdefault("follow_redirects", True)
+        super().__init__(**kwargs)