scholar_flux.exceptions package

Submodules

scholar_flux.exceptions.api_exceptions module

Implements exceptions involving the creation of requests and retrieval of responses from API Providers.

exception scholar_flux.exceptions.api_exceptions.APIException

Bases: Exception

Base exception for API-related errors.

exception scholar_flux.exceptions.api_exceptions.APIParameterException

Bases: APIException

Exception raised for API Parameter-related errors.

exception scholar_flux.exceptions.api_exceptions.InvalidResponseException(response: Response | ResponseProtocol | None = None, *args: Any, **kwargs: Any)

Bases: RequestFailedException

Exception raised for invalid responses from the API.

__init__(response: Response | ResponseProtocol | None = None, *args: Any, **kwargs: Any) → None

Initializes the InvalidResponseException class with a response or response-like parameter.

exception scholar_flux.exceptions.api_exceptions.InvalidResponseReconstructionException

Bases: InvalidResponseStructureException

Exception raised on the attempted creation of a ReconstructedResponse if an exception is encountered.

exception scholar_flux.exceptions.api_exceptions.InvalidResponseStructureException

Bases: APIException

Exception raised when encountering a non-response/response-like object where a valid response is expected.

exception scholar_flux.exceptions.api_exceptions.MissingAPIKeyException

Bases: ValueError

Exception raised when a blank string is provided yet invalid.

exception scholar_flux.exceptions.api_exceptions.MissingAPISpecificParameterException

Bases: ValueError

Exception raised when an API specific parameter is required but not provided in the config.

exception scholar_flux.exceptions.api_exceptions.MissingProviderException

Bases: ValueError

Exception raised when the specification of a provider is required but not provided in the config.

exception scholar_flux.exceptions.api_exceptions.MissingResponseException

Bases: ValueError

Exception raised when a response or response-like object is required but not provided.

exception scholar_flux.exceptions.api_exceptions.NoRecordsAvailableException

Bases: APIException

Exception raised when an operation depends on the presence of records but none exist.

exception scholar_flux.exceptions.api_exceptions.PageUnavailableFromCacheException(*args: Any, message: str = '', **kwargs: Any)

Bases: RequestFailedException

Exception raised when a valid response cannot be retrieved from the session cache.

__init__(*args: Any, message: str = '', **kwargs: Any) → None

Initializes the PageUnavailableFromCacheException class with a response or response-like parameter.

property error_details: str

Added for interface compatibility.

property response: None

Added for interface compatibility.

exception scholar_flux.exceptions.api_exceptions.QueryValidationException

Bases: APIException

Exception raised when a requested resource is not found.

exception scholar_flux.exceptions.api_exceptions.RateLimitExceededException

Bases: APIException

Exception raised when the API’s rate limit is exceeded.

exception scholar_flux.exceptions.api_exceptions.RequestCacheException

Bases: APIException

Exception raised for API request-cache related errors.

exception scholar_flux.exceptions.api_exceptions.RequestCreationException

Bases: APIException

Exception raised when the preparation of an API request fails.

exception scholar_flux.exceptions.api_exceptions.RequestFailedException

Bases: APIException

Exception raised for failed API requests.

classmethod extract_error_details(response: Response | ResponseProtocol) → str

Extracts detailed error message from response body.

exception scholar_flux.exceptions.api_exceptions.RetryAfterDelayExceededException(response: Response | ResponseProtocol | None, *args: Any, message: str = '', **kwargs: Any)

Bases: RequestFailedException

Exception raised when a Retry-After field from a rate limited (429) response exceeds the user-specified limit.

__init__(response: Response | ResponseProtocol | None, *args: Any, message: str = '', **kwargs: Any) → None

Initializes the RetryAfterDelayExceededException class with a response or response-like parameter.

exception scholar_flux.exceptions.api_exceptions.RetryLimitExceededException

Bases: APIException

Exception raised when the retry limit is exceeded.

scholar_flux.exceptions.coordinator_exceptions module

Implements exceptions involving the creation of coordinators, the coordination of requests, response processing, and caching.

exception scholar_flux.exceptions.coordinator_exceptions.CoordinatorException

Bases: Exception

Base exception for Coordinator-related errors.

exception scholar_flux.exceptions.coordinator_exceptions.InvalidCoordinatorParameterException

Bases: CoordinatorException

Coordinator exception raised when attempting to set an unintended injectable class dependency as an attribute of a Coordinator or parameter to a method.

scholar_flux.exceptions.data_exceptions module

Implements exceptions for handling scenarios that could occur during the parsing, extraction, and processing of response data.

exception scholar_flux.exceptions.data_exceptions.DataExtractionException

Bases: ResponseProcessingException

Base exception for errors that occur during data extraction.

exception scholar_flux.exceptions.data_exceptions.DataParsingException

Bases: ResponseProcessingException

Base exception for errors that occur during data parsing.

exception scholar_flux.exceptions.data_exceptions.DataProcessingException

Bases: ResponseProcessingException

Base exception for errors that occur during data processing.

exception scholar_flux.exceptions.data_exceptions.DataValidationException

Bases: DataProcessingException

Exception raised for data validation errors.

exception scholar_flux.exceptions.data_exceptions.FieldNotFoundException

Bases: DataExtractionException

Exception raised when an expected field is not found in the data.

exception scholar_flux.exceptions.data_exceptions.InvalidDataFormatException

Bases: DataParsingException

Exception raised for errors in the input data format.

exception scholar_flux.exceptions.data_exceptions.ResponseProcessingException

Bases: Exception

Base Exception for handling errors in response parsing and processing.

scholar_flux.exceptions.import_exceptions module

The scholar_flux.exceptions.import_exceptions module implements exceptions for handling missing dependencies when using the scholar_flux package. Although several packages are optional, attempting to use functionality that directly depends on an uninstalled dependency should raise an error.

This package module produces the basic exceptions necessary to clearly identify when a dependency is missing.

exception scholar_flux.exceptions.import_exceptions.CryptographyImportError

Bases: OptionalDependencyImportError

Exception for cryptography Dependency Issues.

__init__() → None

Initializes the cryptography import exception for improved logging before the exception is raised.

exception scholar_flux.exceptions.import_exceptions.ItsDangerousImportError

Bases: OptionalDependencyImportError

Exception for itsdangerous Dependency Issues.

__init__() → None

Initializes the itsdangerous import exception for improved logging before the exception is raised.

exception scholar_flux.exceptions.import_exceptions.MongoDBImportError

Bases: OptionalDependencyImportError

Exception for Mongo Dependency Issues.

__init__() → None

Initializes the pymongo import exception for improved logging before the exception is raised.

exception scholar_flux.exceptions.import_exceptions.OptionalDependencyImportError(message: str = 'Optional Dependency not found')

Bases: Exception

Base exception for Optional Dependency Issues.

__init__(message: str = 'Optional Dependency not found') → None

Initializes the foundational OptionalDependencyImportError that forms the basis of more specific error handling when dependencies are missing.

exception scholar_flux.exceptions.import_exceptions.RedisImportError

Bases: OptionalDependencyImportError

Exception for missing redis backend.

__init__() → None

Initializes the redis import exception for improved logging before the exception is raised.

exception scholar_flux.exceptions.import_exceptions.SQLAlchemyImportError

Bases: OptionalDependencyImportError

Exception for missing sql alchemy backend.

__init__() → None

Initializes the sqlalchemy import exception for improved logging before the exception is raised.

exception scholar_flux.exceptions.import_exceptions.XMLToDictImportError

Bases: OptionalDependencyImportError

Exception for xmltodict Dependency Issues.

__init__() → None

Initializes the xmltodict import exception for improved logging before the exception is raised.

exception scholar_flux.exceptions.import_exceptions.YAMLImportError

Bases: OptionalDependencyImportError

Exception for yaml Dependency Issues.

__init__() → None

Initializes the yaml import exception for improved logging before the exception is raised.

scholar_flux.exceptions.path_exceptions module

The scholar_flux.exceptions.path_exceptions module implements the fundamental exception types necessary to interact with various path processing utilities while accounting for any potential errors that are specific to path processing.

exception scholar_flux.exceptions.path_exceptions.InvalidComponentTypeError

Bases: PathUtilsError

Exception class raised for invalid inputs to ProcessingPath component types.

exception scholar_flux.exceptions.path_exceptions.InvalidPathDelimiterError

Bases: InvalidProcessingPathError

Exception raised for invalid delimiters used in ProcessingPath.

exception scholar_flux.exceptions.path_exceptions.InvalidPathNodeError

Bases: PathUtilsError

Exception raised for invalid operations resulting from the handling of PathNodes.

exception scholar_flux.exceptions.path_exceptions.InvalidProcessingPathError

Bases: PathUtilsError

Exception class raised for invalid operations on ProcessingPaths.

exception scholar_flux.exceptions.path_exceptions.PathCacheError

Bases: PathUtilsError

Exception raised when attempting to perform an invalid operation on the PathProcessingCache.

exception scholar_flux.exceptions.path_exceptions.PathCombinationError

Bases: PathUtilsError

Exception raised when an invalid operation occurs during the combination of PathNodes within a PathNodeIndex.

exception scholar_flux.exceptions.path_exceptions.PathDiscoveryError

Bases: PathUtilsError

Exception raised for invalid operations resulting from the handling of PathNodes.

exception scholar_flux.exceptions.path_exceptions.PathIndexingError

Bases: InvalidProcessingPathError

Exception raised when attempting to retrieve the first element of a ProcessingPath as a record/page index.

exception scholar_flux.exceptions.path_exceptions.PathNodeIndexError

Bases: PathUtilsError

Exception raised when performing an invalid operation on a PathNodeIndex.

exception scholar_flux.exceptions.path_exceptions.PathNodeMapError

Bases: PathUtilsError

Exception raised when attempting to perform an invalid operation on a PathNodeMap.

exception scholar_flux.exceptions.path_exceptions.PathSimplificationError

Bases: PathUtilsError

Exception raised for when encountering invalid values during simplification.

exception scholar_flux.exceptions.path_exceptions.PathUtilsError

Bases: Exception

Exception class raised for invalid operations in Path Utilities.

exception scholar_flux.exceptions.path_exceptions.RecordPathChainMapError

Bases: PathUtilsError

Exception raised for invalid operations on a RecordPathChainMap.

exception scholar_flux.exceptions.path_exceptions.RecordPathNodeMapError

Bases: PathNodeMapError

Exception raised when attempting to perform an invalid operation on a RecordPathNodeMap.

scholar_flux.exceptions.storage_exceptions module

Implements exceptions involving both potential edge-cases and common issues involving data and cache storage.

exception scholar_flux.exceptions.storage_exceptions.CacheDeletionException

Bases: StorageCacheException

Exception raised when record deletion from a storage device fails.

exception scholar_flux.exceptions.storage_exceptions.CacheParameterValidationException

Bases: StorageCacheException

Exception raised when invalid parameters are passed to a CacheStorage device.

exception scholar_flux.exceptions.storage_exceptions.CacheRetrievalException

Bases: StorageCacheException

Exception raised when retrieval from a storage device fails.

exception scholar_flux.exceptions.storage_exceptions.CacheUpdateException

Bases: StorageCacheException

Exception raised when updating a cache storage device fails.

exception scholar_flux.exceptions.storage_exceptions.CacheVerificationException

Bases: StorageCacheException

Exception raised when the cache validation from a storage device fails.

exception scholar_flux.exceptions.storage_exceptions.ConnectionFailed

Bases: StorageCacheException

Exception arising from storage connection errors.

exception scholar_flux.exceptions.storage_exceptions.KeyNotFound

Bases: KeyError

Exception resulting from a missing or empty key being provided.

exception scholar_flux.exceptions.storage_exceptions.StorageCacheException

Bases: Exception

Base exception for Storage Issues.

scholar_flux.exceptions.util_exceptions module

Implements exceptions for handling edge-cases when processing JSON files using custom path processing utilities.

exception scholar_flux.exceptions.util_exceptions.CachedSessionValidationError

Bases: SessionInitializationError

Exception class raised when the validation of a CachedSession instance fails.

exception scholar_flux.exceptions.util_exceptions.LogDirectoryError

Bases: Exception

Exception class raised for errors related to the creation of the package logging directory.

exception scholar_flux.exceptions.util_exceptions.PackageInitializationError

Bases: Exception

Exception raised when the ScholarFlux package cannot be initialized due to an unexpected error.

exception scholar_flux.exceptions.util_exceptions.SecretKeyError

Bases: ValueError

Raised when the provided Fernet secret key is invalid.

exception scholar_flux.exceptions.util_exceptions.SessionCacheDirectoryError

Bases: SessionCreationError

Exception class raised for errors related to the creation of the package cache directory used by SessionCache.

exception scholar_flux.exceptions.util_exceptions.SessionConfigurationError

Bases: SessionCreationError

Exception class raised for invalid operations in configuration of session objects.

exception scholar_flux.exceptions.util_exceptions.SessionCreationError

Bases: Exception

Exception class raised for invalid operations in the creation of session objects.

exception scholar_flux.exceptions.util_exceptions.SessionInitializationError

Bases: SessionCreationError

Exception class raised for invalid operations in the initialization of session objects.

Module contents

The scholar_flux.exceptions module implements different types of exceptions used within the scholar_flux package with customized exceptions with applications to client setup, API retrieval, API processing, and caching.

Modules:

api_exceptions: Exceptions crafted for unforeseen issues in API client creation and errors in response retrieval data_exceptions: Exceptions that could occur during the parsing, extraction, and processing of response data util_exceptions: Exceptions used in the creation of utilities used throughout the module coordinator_exceptions: Exceptions revolving around the coordination of requests, response processing and caching storage_exceptions: Exceptions involving potential and common issues involving storage path_exceptions: Exceptions for edge-cases when processing JSON files using custom path processing utilities import_exceptions: Exceptions for handling missing dependencies

exception scholar_flux.exceptions.APIException

Bases: Exception

Base exception for API-related errors.

exception scholar_flux.exceptions.APIParameterException

Bases: APIException

Exception raised for API Parameter-related errors.

exception scholar_flux.exceptions.CacheDeletionException

Bases: StorageCacheException

Exception raised when record deletion from a storage device fails.

exception scholar_flux.exceptions.CacheParameterValidationException

Bases: StorageCacheException

Exception raised when invalid parameters are passed to a CacheStorage device.

exception scholar_flux.exceptions.CacheRetrievalException

Bases: StorageCacheException

Exception raised when retrieval from a storage device fails.

exception scholar_flux.exceptions.CacheUpdateException

Bases: StorageCacheException

Exception raised when updating a cache storage device fails.

exception scholar_flux.exceptions.CacheVerificationException

Bases: StorageCacheException

Exception raised when the cache validation from a storage device fails.

exception scholar_flux.exceptions.CachedSessionValidationError

Bases: SessionInitializationError

Exception class raised when the validation of a CachedSession instance fails.

exception scholar_flux.exceptions.CoordinatorException

Bases: Exception

Base exception for Coordinator-related errors.

exception scholar_flux.exceptions.CryptographyImportError

Bases: OptionalDependencyImportError

Exception for cryptography Dependency Issues.

__init__() → None

Initializes the cryptography import exception for improved logging before the exception is raised.

exception scholar_flux.exceptions.DataExtractionException

Bases: ResponseProcessingException

Base exception for errors that occur during data extraction.

exception scholar_flux.exceptions.DataParsingException

Bases: ResponseProcessingException

Base exception for errors that occur during data parsing.

exception scholar_flux.exceptions.DataProcessingException

Bases: ResponseProcessingException

Base exception for errors that occur during data processing.

exception scholar_flux.exceptions.DataValidationException

Bases: DataProcessingException

Exception raised for data validation errors.

exception scholar_flux.exceptions.DuckDBImportError

Bases: OptionalDependencyImportError

Exception for missing DuckDB engine for SQL Alchemy.

__init__() → None

Initializes the duckdb-engine import exception for improved logging before the exception is raised.

exception scholar_flux.exceptions.FieldNotFoundException

Bases: DataExtractionException

Exception raised when an expected field is not found in the data.

exception scholar_flux.exceptions.InvalidComponentTypeError

Bases: PathUtilsError

Exception class raised for invalid inputs to ProcessingPath component types.

exception scholar_flux.exceptions.InvalidCoordinatorParameterException

Bases: CoordinatorException

Coordinator exception raised when attempting to set an unintended injectable class dependency as an attribute of a Coordinator or parameter to a method.

exception scholar_flux.exceptions.InvalidDataFormatException

Bases: DataParsingException

Exception raised for errors in the input data format.

exception scholar_flux.exceptions.InvalidPathDelimiterError

Bases: InvalidProcessingPathError

Exception raised for invalid delimiters used in ProcessingPath.

exception scholar_flux.exceptions.InvalidPathNodeError

Bases: PathUtilsError

Exception raised for invalid operations resulting from the handling of PathNodes.

exception scholar_flux.exceptions.InvalidProcessingPathError

Bases: PathUtilsError

Exception class raised for invalid operations on ProcessingPaths.

exception scholar_flux.exceptions.InvalidResponseException(response: Response | ResponseProtocol | None = None, *args: Any, **kwargs: Any)

Bases: RequestFailedException

Exception raised for invalid responses from the API.

__init__(response: Response | ResponseProtocol | None = None, *args: Any, **kwargs: Any) → None

Initializes the InvalidResponseException class with a response or response-like parameter.

exception scholar_flux.exceptions.InvalidResponseReconstructionException

Bases: InvalidResponseStructureException

Exception raised on the attempted creation of a ReconstructedResponse if an exception is encountered.

exception scholar_flux.exceptions.InvalidResponseStructureException

Bases: APIException

Exception raised when encountering a non-response/response-like object where a valid response is expected.

exception scholar_flux.exceptions.ItsDangerousImportError

Bases: OptionalDependencyImportError

Exception for itsdangerous Dependency Issues.

__init__() → None

Initializes the itsdangerous import exception for improved logging before the exception is raised.

exception scholar_flux.exceptions.KeyNotFound

Bases: KeyError

Exception resulting from a missing or empty key being provided.

exception scholar_flux.exceptions.LogDirectoryError

Bases: Exception

Exception class raised for errors related to the creation of the package logging directory.

exception scholar_flux.exceptions.MissingAPIKeyException

Bases: ValueError

Exception raised when a blank string is provided yet invalid.

exception scholar_flux.exceptions.MissingAPISpecificParameterException

Bases: ValueError

Exception raised when an API specific parameter is required but not provided in the config.

exception scholar_flux.exceptions.MissingProviderException

Bases: ValueError

Exception raised when the specification of a provider is required but not provided in the config.

exception scholar_flux.exceptions.MissingResponseException

Bases: ValueError

Exception raised when a response or response-like object is required but not provided.

exception scholar_flux.exceptions.MongoDBImportError

Bases: OptionalDependencyImportError

Exception for Mongo Dependency Issues.

__init__() → None

Initializes the pymongo import exception for improved logging before the exception is raised.

exception scholar_flux.exceptions.NoRecordsAvailableException

Bases: APIException

Exception raised when an operation depends on the presence of records but none exist.

exception scholar_flux.exceptions.OptionalDependencyImportError(message: str = 'Optional Dependency not found')

Bases: Exception

Base exception for Optional Dependency Issues.

__init__(message: str = 'Optional Dependency not found') → None

Initializes the foundational OptionalDependencyImportError that forms the basis of more specific error handling when dependencies are missing.

exception scholar_flux.exceptions.PackageInitializationError

Bases: Exception

Exception raised when the ScholarFlux package cannot be initialized due to an unexpected error.

exception scholar_flux.exceptions.PageUnavailableFromCacheException(*args: Any, message: str = '', **kwargs: Any)

Bases: RequestFailedException

Exception raised when a valid response cannot be retrieved from the session cache.

__init__(*args: Any, message: str = '', **kwargs: Any) → None

Initializes the PageUnavailableFromCacheException class with a response or response-like parameter.

property error_details: str

Added for interface compatibility.

property response: None

Added for interface compatibility.

exception scholar_flux.exceptions.PathCacheError

Bases: PathUtilsError

Exception raised when attempting to perform an invalid operation on the PathProcessingCache.

exception scholar_flux.exceptions.PathCombinationError

Bases: PathUtilsError

Exception raised when an invalid operation occurs during the combination of PathNodes within a PathNodeIndex.

exception scholar_flux.exceptions.PathDiscoveryError

Bases: PathUtilsError

Exception raised for invalid operations resulting from the handling of PathNodes.

exception scholar_flux.exceptions.PathIndexingError

Bases: InvalidProcessingPathError

Exception raised when attempting to retrieve the first element of a ProcessingPath as a record/page index.

exception scholar_flux.exceptions.PathNodeIndexError

Bases: PathUtilsError

Exception raised when performing an invalid operation on a PathNodeIndex.

exception scholar_flux.exceptions.PathNodeMapError

Bases: PathUtilsError

Exception raised when attempting to perform an invalid operation on a PathNodeMap.

exception scholar_flux.exceptions.PathSimplificationError

Bases: PathUtilsError

Exception raised for when encountering invalid values during simplification.

exception scholar_flux.exceptions.PathUtilsError

Bases: Exception

Exception class raised for invalid operations in Path Utilities.

exception scholar_flux.exceptions.QueryValidationException

Bases: APIException

Exception raised when a requested resource is not found.

exception scholar_flux.exceptions.RateLimitExceededException

Bases: APIException

Exception raised when the API’s rate limit is exceeded.

exception scholar_flux.exceptions.RecordNormalizationException

Bases: APIException

Exception raised when the normalization of a response record cannot be completed.

exception scholar_flux.exceptions.RecordPathChainMapError

Bases: PathUtilsError

Exception raised for invalid operations on a RecordPathChainMap.

exception scholar_flux.exceptions.RecordPathNodeMapError

Bases: PathNodeMapError

Exception raised when attempting to perform an invalid operation on a RecordPathNodeMap.

exception scholar_flux.exceptions.RedisImportError

Bases: OptionalDependencyImportError

Exception for missing redis backend.

__init__() → None

Initializes the redis import exception for improved logging before the exception is raised.

exception scholar_flux.exceptions.RequestCacheException

Bases: APIException

Exception raised for API request-cache related errors.

exception scholar_flux.exceptions.RequestCreationException

Bases: APIException

Exception raised when the preparation of an API request fails.

exception scholar_flux.exceptions.RequestFailedException

Bases: APIException

Exception raised for failed API requests.

classmethod extract_error_details(response: Response | ResponseProtocol) → str

Extracts detailed error message from response body.

exception scholar_flux.exceptions.ResponseProcessingException

Bases: Exception

Base Exception for handling errors in response parsing and processing.

exception scholar_flux.exceptions.RetryAfterDelayExceededException(response: Response | ResponseProtocol | None, *args: Any, message: str = '', **kwargs: Any)

Bases: RequestFailedException

Exception raised when a Retry-After field from a rate limited (429) response exceeds the user-specified limit.

__init__(response: Response | ResponseProtocol | None, *args: Any, message: str = '', **kwargs: Any) → None

Initializes the RetryAfterDelayExceededException class with a response or response-like parameter.

exception scholar_flux.exceptions.RetryLimitExceededException

Bases: APIException

Exception raised when the retry limit is exceeded.

exception scholar_flux.exceptions.SQLAlchemyImportError

Bases: OptionalDependencyImportError

Exception for missing sql alchemy backend.

__init__() → None

Initializes the sqlalchemy import exception for improved logging before the exception is raised.

exception scholar_flux.exceptions.SecretKeyError

Bases: ValueError

Raised when the provided Fernet secret key is invalid.

exception scholar_flux.exceptions.SessionCacheDirectoryError

Bases: SessionCreationError

Exception class raised for errors related to the creation of the package cache directory used by SessionCache.

exception scholar_flux.exceptions.SessionConfigurationError

Bases: SessionCreationError

Exception class raised for invalid operations in configuration of session objects.

exception scholar_flux.exceptions.SessionCreationError

Bases: Exception

Exception class raised for invalid operations in the creation of session objects.

exception scholar_flux.exceptions.SessionInitializationError

Bases: SessionCreationError

Exception class raised for invalid operations in the initialization of session objects.

exception scholar_flux.exceptions.StorageCacheException

Bases: Exception

Base exception for Storage Issues.

exception scholar_flux.exceptions.XMLToDictImportError

Bases: OptionalDependencyImportError

Exception for xmltodict Dependency Issues.

__init__() → None

Initializes the xmltodict import exception for improved logging before the exception is raised.

exception scholar_flux.exceptions.YAMLImportError

Bases: OptionalDependencyImportError

Exception for yaml Dependency Issues.

__init__() → None

Initializes the yaml import exception for improved logging before the exception is raised.