Overview
SpecklePy defines custom exception types that inherit from SpeckleException. Catch this base exception to handle all Speckle-related errors.
from specklepy.logging.exceptions import SpeckleException
try:
result = client.project.get("project_id")
except SpeckleException as e:
print(f"Error: {e.message}")
Exception Types
SpeckleException
Base exception for all Speckle-related errors.
class SpeckleException(Exception):
message: str
exception: Optional[Exception]
GraphQLException
Raised when GraphQL queries or mutations fail.
class GraphQLException(SpeckleException):
message: str
errors: Optional[List[Any]]
data: Optional[Any]
- Invalid object IDs
- Resource not found
- Permission denied
- Server errors
Example:
from specklepy.logging.exceptions import GraphQLException
try:
project = client.project.get("invalid_id")
except GraphQLException as e:
print(f"GraphQL error: {e.message}")
SerializationException
Raised when object serialization or deserialization fails.
class SerializationException(SpeckleException):
message: str
obj: Any
unhandled_type: type
exception: Optional[Exception]
- Non-Speckle objects without conversion
- Circular references
- Unsupported data types
UnsupportedException
Raised when an operation or feature is not supported.
class UnsupportedException(SpeckleException):
message: str
- Features unavailable on older server versions
- Unsupported object types
- Platform-specific features
SpeckleInvalidUnitException
Raised when invalid units are provided.
class SpeckleInvalidUnitException(SpeckleException):
# Expected string units like "m", "ft", "mm", etc.
WorkspacePermissionException
Raised when workspace operations fail due to insufficient permissions.
class WorkspacePermissionException(SpeckleException):
message: str
- Insufficient workspace permissions
- Workspace features not available on server
- Not a member of the workspace
Last modified on January 28, 2026
