stackmachine 0.3.0__py3-none-any.whl → 0.3.2__py3-none-any.whl

stackmachine/__init__.py

@@ -32,27 +32,97 @@ from ._models import (
     Viewer,
 )
 from ._pagination import AsyncStackMachineList, StackMachineList
+from ._types import (
+    AppAliasSortBy,
+    AppsDomainsCreateInput,
+    AppsDomainsListInput,
+    AppsSshAuthorizedKeysCreateInput,
+    AppsSshAuthorizedKeysDeleteInput,
+    AppsSshAuthorizedKeysListInput,
+    AppsSshServerUpdateInput,
+    AppsSshUsersListInput,
+    AppsSshUsersUpdateInput,
+    AppsVersionsListInput,
+    AppsVersionsLogsListInput,
+    AsyncStackMachineInitSettings,
+    CreateZipFiles,
+    DeployAppAutobuildExtraData,
+    DeployAppAutobuildInput,
+    DeployAppEnvVarInput,
+    DeployAppJobDefinitionInput,
+    DeployAppsListInput,
+    DeployAppsSortBy,
+    DeployAppVersionsSortBy,
+    DeployAppWordPressExtraData,
+    DeploymentProgressCallback,
+    FileInput,
+    Headers,
+    LogStream,
+    PaginationOptions,
+    Readable,
+    RequestOptionsInput,
+    RequestOptionsLike,
+    SshAuthenticationMethod,
+    SshTokenCreateResult,
+    SshUserPasswordRevealResult,
+    SshUserPasswordRotateResult,
+    StackMachineInitSettings,
+    UploadProgressCallback,
+)
 from ._uploads import create_zip
 
 try:
     __version__ = version("stackmachine")
 except PackageNotFoundError:
-    __version__ = "0.3.0"
+    __version__ = "0.3.2"
 
 __all__ = [
     "AppAlias",
+    "AppAliasSortBy",
     "AppSshServer",
+    "AppsDomainsCreateInput",
+    "AppsDomainsListInput",
+    "AppsSshAuthorizedKeysCreateInput",
+    "AppsSshAuthorizedKeysDeleteInput",
+    "AppsSshAuthorizedKeysListInput",
+    "AppsSshServerUpdateInput",
+    "AppsSshUsersListInput",
+    "AppsSshUsersUpdateInput",
+    "AppsVersionsListInput",
+    "AppsVersionsLogsListInput",
     "AsyncStackMachine",
+    "AsyncStackMachineInitSettings",
     "AsyncStackMachineList",
+    "CreateZipFiles",
     "DeployApp",
+    "DeployAppAutobuildExtraData",
+    "DeployAppAutobuildInput",
+    "DeployAppEnvVarInput",
+    "DeployAppJobDefinitionInput",
     "DeployAppKindWordPress",
     "DeployAppVersion",
+    "DeployAppVersionsSortBy",
+    "DeployAppWordPressExtraData",
+    "DeployAppsListInput",
+    "DeployAppsSortBy",
     "DeploymentProgress",
+    "DeploymentProgressCallback",
     "ExpectedDNSRecord",
+    "FileInput",
+    "Headers",
     "Log",
+    "LogStream",
+    "PaginationOptions",
+    "Readable",
     "RequestOptions",
+    "RequestOptionsInput",
+    "RequestOptionsLike",
+    "SshAuthenticationMethod",
     "SshAuthorizedKey",
+    "SshTokenCreateResult",
     "SshUser",
+    "SshUserPasswordRevealResult",
+    "SshUserPasswordRotateResult",
     "StackMachine",
     "StackMachineAPIError",
     "StackMachineAuthenticationError",
@@ -61,10 +131,12 @@ __all__ = [
     "StackMachineGraphQLError",
     "StackMachineInvalidRequestError",
     "StackMachineList",
+    "StackMachineInitSettings",
     "StackMachinePermissionError",
     "StackMachineRateLimitError",
     "StackMachineValidationError",
     "UploadProgress",
+    "UploadProgressCallback",
     "Viewer",
     "__version__",
     "create_zip",

stackmachine/_async_client.py

@@ -13,6 +13,7 @@ from ._config import (
 from ._graphql import operations as gql
 from ._models import Viewer
 from ._transport import AsyncTransport
+from ._types import AsyncStackMachineInitSettings, Headers, RequestOptionsLike
 from ._uploads import AsyncUploader
 from .resources.apps import AsyncDeployAppsResource
 from .resources.deployments import AsyncDeploymentsResource
@@ -24,24 +25,36 @@ class AsyncStackMachine:
         self,
         api_key: str,
         *,
-        api_url: str = DEFAULT_API_URL,
-        headers: Optional[Mapping[str, str]] = None,
+        api_url: Optional[str] = None,
+        apiUrl: Optional[str] = None,
+        headers: Optional[Headers] = None,
         timeout: float = DEFAULT_TIMEOUT,
-        max_network_retries: int = DEFAULT_MAX_NETWORK_RETRIES,
+        max_network_retries: Optional[int] = None,
+        maxNetworkRetries: Optional[int] = None,
         http_client: Optional[httpx.AsyncClient] = None,
         http_transport: Optional[httpx.AsyncBaseTransport] = None,
     ) -> None:
+        resolved_api_url = (
+            api_url if api_url is not None else apiUrl or DEFAULT_API_URL
+        )
+        resolved_max_retries = (
+            max_network_retries
+            if max_network_retries is not None
+            else maxNetworkRetries
+            if maxNetworkRetries is not None
+            else DEFAULT_MAX_NETWORK_RETRIES
+        )
         self.api_key = api_key
-        self.api_url = api_url
-        self.apiUrl = api_url
+        self.api_url = resolved_api_url
+        self.apiUrl = resolved_api_url
         self.timeout = timeout
-        self.max_network_retries = max_network_retries
-        self.maxNetworkRetries = max_network_retries
+        self.max_network_retries = resolved_max_retries
+        self.maxNetworkRetries = resolved_max_retries
         self._config = ClientConfig(
-            api_url=api_url,
+            api_url=resolved_api_url,
             headers=headers,
             timeout=timeout,
-            max_network_retries=max_network_retries,
+            max_network_retries=resolved_max_retries,
         )
         self._transport = AsyncTransport(
             api_key,
@@ -56,16 +69,79 @@ class AsyncStackMachine:
     @classmethod
     def init(
         cls,
-        settings: Optional[Mapping[str, Any]] = None,
-        **kwargs: Any,
+        settings: Optional[AsyncStackMachineInitSettings] = None,
+        *,
+        api_key: Optional[str] = None,
+        apiKey: Optional[str] = None,
+        token: Optional[str] = None,
+        api_url: Optional[str] = None,
+        apiUrl: Optional[str] = None,
+        headers: Optional[Headers] = None,
+        timeout: Optional[float] = None,
+        max_network_retries: Optional[int] = None,
+        maxNetworkRetries: Optional[int] = None,
+        http_client: Optional[httpx.AsyncClient] = None,
+        http_transport: Optional[httpx.AsyncBaseTransport] = None,
     ) -> "AsyncStackMachine":
-        values = {**dict(settings or {}), **kwargs}
-        api_key = values.pop("api_key", None) or values.pop("token", None) or ""
-        if "apiUrl" in values:
-            values["api_url"] = values.pop("apiUrl")
-        if "maxNetworkRetries" in values:
-            values["max_network_retries"] = values.pop("maxNetworkRetries")
-        return cls(api_key, **values)
+        values: AsyncStackMachineInitSettings = {} if settings is None else settings
+        resolved_api_key = (
+            api_key
+            if api_key is not None
+            else apiKey
+            if apiKey is not None
+            else token
+            if token is not None
+            else values.get("api_key")
+            or values.get("apiKey")
+            or values.get("token")
+            or ""
+        )
+        settings_timeout = values.get("timeout")
+        resolved_timeout = (
+            timeout
+            if timeout is not None
+            else settings_timeout
+            if settings_timeout is not None
+            else DEFAULT_TIMEOUT
+        )
+        resolved_api_url = (
+            api_url
+            if api_url is not None
+            else apiUrl
+            if apiUrl is not None
+            else values.get("api_url")
+            or values.get("apiUrl")
+            or DEFAULT_API_URL
+        )
+        settings_max_retries = (
+            values.get("max_network_retries")
+            if values.get("max_network_retries") is not None
+            else values.get("maxNetworkRetries")
+        )
+        resolved_max_retries = (
+            max_network_retries
+            if max_network_retries is not None
+            else maxNetworkRetries
+            if maxNetworkRetries is not None
+            else settings_max_retries
+            if settings_max_retries is not None
+            else DEFAULT_MAX_NETWORK_RETRIES
+        )
+        return cls(
+            resolved_api_key,
+            api_url=resolved_api_url,
+            headers=headers if headers is not None else values.get("headers"),
+            timeout=resolved_timeout,
+            max_network_retries=resolved_max_retries,
+            http_client=(
+                http_client if http_client is not None else values.get("http_client")
+            ),
+            http_transport=(
+                http_transport
+                if http_transport is not None
+                else values.get("http_transport")
+            ),
+        )
 
     async def close(self) -> None:
         await self._transport.close()
@@ -81,7 +157,7 @@ class AsyncStackMachine:
         query: str,
         variables: Optional[Mapping[str, Any]] = None,
         *,
-        request_options: Optional[Mapping[str, Any]] = None,
+        request_options: Optional[RequestOptionsLike] = None,
     ) -> Any:
         return await self._transport.execute(
             query,
@@ -94,7 +170,7 @@ class AsyncStackMachine:
         query: str,
         variables: Optional[Mapping[str, Any]] = None,
         *,
-        request_options: Optional[Mapping[str, Any]] = None,
+        request_options: Optional[RequestOptionsLike] = None,
     ) -> Any:
         return await self._transport.execute(
             query,
@@ -104,7 +180,7 @@ class AsyncStackMachine:
         )
 
     def _subscribe_deployment(
-        self, build_id: str, request_options: Optional[Mapping[str, Any]] = None
+        self, build_id: str, request_options: Optional[RequestOptionsLike] = None
     ):
         return self._transport.subscribe(
             gql.AUTOBUILD_SUBSCRIPTION,
@@ -113,7 +189,7 @@ class AsyncStackMachine:
         )
 
     async def viewer(
-        self, *, request_options: Optional[Mapping[str, Any]] = None
+        self, *, request_options: Optional[RequestOptionsLike] = None
     ) -> Optional[Viewer]:
         response = await self._query(
             gql.VIEWER_QUERY, {}, request_options=request_options

stackmachine/_client.py

@@ -13,6 +13,7 @@ from ._config import (
 from ._graphql import operations as gql
 from ._models import Viewer
 from ._transport import SyncTransport
+from ._types import Headers, RequestOptionsLike, StackMachineInitSettings
 from ._uploads import SyncUploader
 from .resources.apps import DeployAppsResource
 from .resources.deployments import DeploymentsResource
@@ -24,24 +25,36 @@ class StackMachine:
         self,
         api_key: str,
         *,
-        api_url: str = DEFAULT_API_URL,
-        headers: Optional[Mapping[str, str]] = None,
+        api_url: Optional[str] = None,
+        apiUrl: Optional[str] = None,
+        headers: Optional[Headers] = None,
         timeout: float = DEFAULT_TIMEOUT,
-        max_network_retries: int = DEFAULT_MAX_NETWORK_RETRIES,
+        max_network_retries: Optional[int] = None,
+        maxNetworkRetries: Optional[int] = None,
         http_client: Optional[httpx.Client] = None,
         http_transport: Optional[httpx.BaseTransport] = None,
     ) -> None:
+        resolved_api_url = (
+            api_url if api_url is not None else apiUrl or DEFAULT_API_URL
+        )
+        resolved_max_retries = (
+            max_network_retries
+            if max_network_retries is not None
+            else maxNetworkRetries
+            if maxNetworkRetries is not None
+            else DEFAULT_MAX_NETWORK_RETRIES
+        )
         self.api_key = api_key
-        self.api_url = api_url
-        self.apiUrl = api_url
+        self.api_url = resolved_api_url
+        self.apiUrl = resolved_api_url
         self.timeout = timeout
-        self.max_network_retries = max_network_retries
-        self.maxNetworkRetries = max_network_retries
+        self.max_network_retries = resolved_max_retries
+        self.maxNetworkRetries = resolved_max_retries
         self._config = ClientConfig(
-            api_url=api_url,
+            api_url=resolved_api_url,
             headers=headers,
             timeout=timeout,
-            max_network_retries=max_network_retries,
+            max_network_retries=resolved_max_retries,
         )
         self._transport = SyncTransport(
             api_key,
@@ -56,16 +69,79 @@ class StackMachine:
     @classmethod
     def init(
         cls,
-        settings: Optional[Mapping[str, Any]] = None,
-        **kwargs: Any,
+        settings: Optional[StackMachineInitSettings] = None,
+        *,
+        api_key: Optional[str] = None,
+        apiKey: Optional[str] = None,
+        token: Optional[str] = None,
+        api_url: Optional[str] = None,
+        apiUrl: Optional[str] = None,
+        headers: Optional[Headers] = None,
+        timeout: Optional[float] = None,
+        max_network_retries: Optional[int] = None,
+        maxNetworkRetries: Optional[int] = None,
+        http_client: Optional[httpx.Client] = None,
+        http_transport: Optional[httpx.BaseTransport] = None,
     ) -> "StackMachine":
-        values = {**dict(settings or {}), **kwargs}
-        api_key = values.pop("api_key", None) or values.pop("token", None) or ""
-        if "apiUrl" in values:
-            values["api_url"] = values.pop("apiUrl")
-        if "maxNetworkRetries" in values:
-            values["max_network_retries"] = values.pop("maxNetworkRetries")
-        return cls(api_key, **values)
+        values: StackMachineInitSettings = {} if settings is None else settings
+        resolved_api_key = (
+            api_key
+            if api_key is not None
+            else apiKey
+            if apiKey is not None
+            else token
+            if token is not None
+            else values.get("api_key")
+            or values.get("apiKey")
+            or values.get("token")
+            or ""
+        )
+        settings_timeout = values.get("timeout")
+        resolved_timeout = (
+            timeout
+            if timeout is not None
+            else settings_timeout
+            if settings_timeout is not None
+            else DEFAULT_TIMEOUT
+        )
+        resolved_api_url = (
+            api_url
+            if api_url is not None
+            else apiUrl
+            if apiUrl is not None
+            else values.get("api_url")
+            or values.get("apiUrl")
+            or DEFAULT_API_URL
+        )
+        settings_max_retries = (
+            values.get("max_network_retries")
+            if values.get("max_network_retries") is not None
+            else values.get("maxNetworkRetries")
+        )
+        resolved_max_retries = (
+            max_network_retries
+            if max_network_retries is not None
+            else maxNetworkRetries
+            if maxNetworkRetries is not None
+            else settings_max_retries
+            if settings_max_retries is not None
+            else DEFAULT_MAX_NETWORK_RETRIES
+        )
+        return cls(
+            resolved_api_key,
+            api_url=resolved_api_url,
+            headers=headers if headers is not None else values.get("headers"),
+            timeout=resolved_timeout,
+            max_network_retries=resolved_max_retries,
+            http_client=(
+                http_client if http_client is not None else values.get("http_client")
+            ),
+            http_transport=(
+                http_transport
+                if http_transport is not None
+                else values.get("http_transport")
+            ),
+        )
 
     def close(self) -> None:
         self._transport.close()
@@ -81,7 +157,7 @@ class StackMachine:
         query: str,
         variables: Optional[Mapping[str, Any]] = None,
         *,
-        request_options: Optional[Mapping[str, Any]] = None,
+        request_options: Optional[RequestOptionsLike] = None,
     ) -> Any:
         return self._transport.execute(
             query,
@@ -94,7 +170,7 @@ class StackMachine:
         query: str,
         variables: Optional[Mapping[str, Any]] = None,
         *,
-        request_options: Optional[Mapping[str, Any]] = None,
+        request_options: Optional[RequestOptionsLike] = None,
     ) -> Any:
         return self._transport.execute(
             query,
@@ -104,7 +180,7 @@ class StackMachine:
         )
 
     def _subscribe_deployment(
-        self, build_id: str, request_options: Optional[Mapping[str, Any]] = None
+        self, build_id: str, request_options: Optional[RequestOptionsLike] = None
     ):
         return self._transport.subscribe(
             gql.AUTOBUILD_SUBSCRIPTION,
@@ -113,7 +189,7 @@ class StackMachine:
         )
 
     def viewer(
-        self, *, request_options: Optional[Mapping[str, Any]] = None
+        self, *, request_options: Optional[RequestOptionsLike] = None
     ) -> Optional[Viewer]:
         response = self._query(gql.VIEWER_QUERY, {}, request_options=request_options)
         viewer = response.get("viewer") if response else None

stackmachine/_config.py

@@ -11,11 +11,15 @@ DEFAULT_MAX_NETWORK_RETRIES = 1
 @dataclass
 class RequestOptions:
     api_key: Optional[str] = None
+    apiKey: Optional[str] = None
     headers: Optional[Mapping[str, str]] = None
     timeout: Optional[float] = None
     max_network_retries: Optional[int] = None
+    maxNetworkRetries: Optional[int] = None
     idempotency_key: Optional[str] = None
+    idempotencyKey: Optional[str] = None
     client_mutation_id: Optional[str] = None
+    clientMutationId: Optional[str] = None
     force: Optional[bool] = None
 
 

stackmachine/_pagination.py

@@ -12,6 +12,7 @@ from typing import (
     Mapping,
     Optional,
     TypeVar,
+    cast,
 )
 
 from ._errors import StackMachineValidationError
@@ -299,7 +300,7 @@ class AsyncStackMachineList(Generic[T]):
         async for item in self:
             result = handler(item)
             if hasattr(result, "__await__"):
-                result = await result  # type: ignore[assignment]
+                result = await cast(Awaitable[Optional[bool]], result)
             if result is False:
                 return