Supporting Modules

This section provides details around the supporting modules used in the highspot package, which are listed below.

• Classes & Exceptions

  • Errors Module (highspot.errors)

    • Exceptions Module (highspot.errors.exceptions)

    • Handlers Module (highspot.errors.handlers)

• Tools & Utilities

  • Logging Utilities Module (highspot.utils.log_utils)

  • Version Module (highspot.utils.version)

Classes & Exceptions

This section includes modules that contain the classes and exceptions used throughout the package.

Errors Module (highspot.errors)

This module contains all of the exception classes and error handling functions leveraged throughout the library.

Package

highspot.errors

Synopsis

This module includes custom exceptions and handlers

Created By

Jeff Shurtliff

Last Modified

Jeff Shurtliff

Modified Date

11 Oct 2022

Return to Top

Exceptions Module (highspot.errors.exceptions)

This sub-module contains all of the exception classes leveraged in functions throughout the library.

Module

highspot.errors.exceptions

Synopsis

Collection of exception classes relating to the highspot library

Created By

Jeff Shurtliff

Last Modified

Jeff Shurtliff

Modified Date

16 Oct 2022

exception highspot.errors.exceptions.APIConnectionError(*args, **kwargs)

This exception is used when the API query could not be completed due to connection aborts and/or timeouts.

exception highspot.errors.exceptions.APIRequestError(*args, **kwargs)

This exception is used for generic API request errors when there isn’t a more specific exception.

exception highspot.errors.exceptions.CurrentlyUnsupportedError(*args, **kwargs)

This exception is used when a feature or functionality being used is currently unsupported.

exception highspot.errors.exceptions.DataMismatchError(*args, **kwargs)

This exception is used when there is a mismatch between two data sources.

exception highspot.errors.exceptions.HighspotError

This is the base class for Highspot exceptions.

exception highspot.errors.exceptions.InvalidFieldError(*args, **kwargs)

This exception is used when an invalid field is provided.

exception highspot.errors.exceptions.MissingAuthDataError(*args, **kwargs)

This exception is used when authentication data is not supplied and therefore a connection cannot occur.

exception highspot.errors.exceptions.MissingRequiredDataError(*args, **kwargs)

This exception is used when a function or method is missing one or more required arguments.

Return to Top

Handlers Module (highspot.errors.handlers)

This sub-module contains various error handling functions that are leveraged throughout the library.

Module

highspot.errors.handlers

Synopsis

Functions that handle various error situations within the namespace

Created By

Jeff Shurtliff

Last Modified

Jeff Shurtliff

Modified Date

11 Oct 2022

highspot.errors.handlers.eprint(*args, **kwargs)

This function behaves the same as the print() function but is leveraged to print errors to sys.stderr.

Return to Top

Tools & Utilities

This section includes modules that contain tools and utilities leveraged by other scripts.

Logging Utilities Module (highspot.utils.log_utils)

This module includes various utilities to assist with logging.

Module

highspot.utils.log_utils

Synopsis

Collection of logging utilities and functions

Usage

from highspot.utils import log_utils

Example

logger = log_utils.initialize_logging(__name__)

Created By

Jeff Shurtliff

Last Modified

Jeff Shurtliff

Modified Date

16 Oct 2022

class highspot.utils.log_utils.LessThanFilter(exclusive_maximum, name='')

This class allows filters to be set to limit log levels to only less than a specified level.

See also

Zoey Greer is the original author of this class which was provided on Stack Overflow.

filter(record)

This method returns a Boolean integer value indicating whether or not a message should be logged.

Note

A non-zero return indicates that the message will be logged.

highspot.utils.log_utils.initialize_logging(logger_name=None, log_level=None, formatter=None, debug=None, no_output=None, file_output=None, file_log_level=None, log_file=None, overwrite_log_files=None, console_output=None, console_log_level=None, syslog_output=None, syslog_log_level=None, syslog_address=None, syslog_port=None)

This function initializes logging for the highspot library.

Return to Top

Version Module (highspot.utils.version)

This module is the primary source of the current version of the highspot package.

Module

highspot.utils.version

Synopsis

This simple script contains the package version

Created By

Jeff Shurtliff

Last Modified

Jeff Shurtliff

Modified Date

11 Dec 2022

highspot.utils.version.get_full_version()

This function returns the current full version of the highspot package.

highspot.utils.version.get_major_minor_version()

This function returns the current major.minor (i.e. X.Y) version of the highspot package.

Return to Top