Exceptions

This section contains documentation for the exceptions module.

---

METADATA:

File: exceptions.py

Project: paperap

Created: 2025-03-04

Version: 0.0.8

Author: Jess Mann Email: jess@jmann.me

Copyright (c) 2025 Jess Mann

---

LAST MODIFIED:

2025-03-04 By Jess Mann

exception paperap.exceptions.PaperapError

Bases: Exception

Base exception for all paperless client errors.

exception paperap.exceptions.ModelValidationError(message=None, model=None)

Bases: PaperapError, ValueError

Raised when a model fails validation.

Parameters:

• message (str | None)

• model (BaseModel | None)

__init__(message=None, model=None)

Parameters:

• message (str | None)

• model (BaseModel | None)

exception paperap.exceptions.ReadOnlyFieldError(message=None, model=None)

Bases: ModelValidationError

Raised when a read-only field is set.

Parameters:

• message (str | None)

• model (BaseModel | None)

exception paperap.exceptions.ConfigurationError

Bases: PaperapError

Raised when the configuration is invalid.

exception paperap.exceptions.PaperlessError

Bases: PaperapError

Raised due to a feature or error of paperless ngx

exception paperap.exceptions.APIError(message=None, status_code=None)

Bases: PaperlessError

Raised when the API returns an error.

Parameters:

• message (str | None)

• status_code (int | None)

__init__(message=None, status_code=None)

Parameters:

• message (str | None)

• status_code (int | None)

status_code: int | None = None

exception paperap.exceptions.AuthenticationError(message=None, status_code=None)

Bases: APIError

Raised when authentication fails.

Parameters:

• message (str | None)

• status_code (int | None)

exception paperap.exceptions.InsufficientPermissionError(message=None, status_code=None)

Bases: APIError

Raised when a user does not have permission to perform an action.

Parameters:

• message (str | None)

• status_code (int | None)

exception paperap.exceptions.FeatureNotAvailableError(message=None, status_code=None)

Bases: APIError

Raised when a feature is not available.

Parameters:

• message (str | None)

• status_code (int | None)

exception paperap.exceptions.FilterDisabledError(message=None, status_code=None)

Bases: FeatureNotAvailableError

Raised when a filter is not available.

Parameters:

• message (str | None)

• status_code (int | None)

exception paperap.exceptions.RequestError(message=None, status_code=None)

Bases: APIError

Raised when an error occurs while making a request.

Parameters:

• message (str | None)

• status_code (int | None)

exception paperap.exceptions.BadResponseError(message=None, status_code=None)

Bases: APIError

Raised when a response is returned, but the status code is not 200.

Parameters:

• message (str | None)

• status_code (int | None)

exception paperap.exceptions.ResponseParsingError(message=None, status_code=None)

Bases: APIError

Raised when the response can’t be parsed.

Parameters:

• message (str | None)

• status_code (int | None)

exception paperap.exceptions.ResourceNotFoundError(message=None, resource_name=None)

Bases: APIError

Raised when a requested resource is not found.

Parameters:

• message (str | None)

• resource_name (str | None)

__init__(message=None, resource_name=None)

Parameters:

• message (str | None)

• resource_name (str | None)

resource_name: str | None = None

exception paperap.exceptions.RelationshipNotFoundError(message=None, resource_name=None)

Bases: ResourceNotFoundError

Raised when a requested relationship is not found.

Parameters:

• message (str | None)

• resource_name (str | None)

exception paperap.exceptions.ObjectNotFoundError(message=None, resource_name=None, model_id=None)

Bases: ResourceNotFoundError

Raised when a requested object is not found.

Parameters:

• message (str | None)

• resource_name (str | None)

• model_id (int | None)

__init__(message=None, resource_name=None, model_id=None)

Parameters:

• message (str | None)

• resource_name (str | None)

• model_id (int | None)

model_id: int | None = None

exception paperap.exceptions.MultipleObjectsFoundError(message=None, status_code=None)

Bases: APIError

Raised when multiple objects are found when only one was expected.

Parameters:

• message (str | None)

• status_code (int | None)

exception paperap.exceptions.DocumentError

Bases: PaperapError

Raised when an error occurs with a local document.

exception paperap.exceptions.NoImagesError

Bases: DocumentError

Raised when no images are found in a pdf.

exception paperap.exceptions.DocumentParsingError

Bases: DocumentError

Raised when a document cannot be parsed.