Supporting Modules

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

• Classes & Exceptions

  • Errors Module (freshpy.errors)

    • Exceptions Module (freshpy.errors.exceptions)

    • Handlers Module (freshpy.errors.handlers)

• Tools & Utilities

  • Core Utilities Module (freshpy.utils.core_utils)

  • Logging Utilities Module (freshpy.utils.log_utils)

  • Version Module (freshpy.utils.version)

Classes & Exceptions

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

Errors Module (freshpy.errors)

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

Package:

freshpy.errors

Synopsis:

This module includes custom exceptions

Created By:

Jeff Shurtliff

Last Modified:

Jeff Shurtliff

Modified Date:

28 Dec 2021

Return to Top

Exceptions Module (freshpy.errors.exceptions)

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

Module:

freshpy.errors.exceptions

Synopsis:

Collection of exception classes relating to the freshpy library

Created By:

Jeff Shurtliff

Last Modified:

Jeff Shurtliff

Modified Date:

28 Dec 2021

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

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

New in version 1.0.0.

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

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

New in version 1.0.0.

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

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

New in version 1.0.0.

exception freshpy.errors.exceptions.DELETERequestError(*args, **kwargs)

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

New in version 1.0.0.

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

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

New in version 1.0.0.

exception freshpy.errors.exceptions.FeatureNotConfiguredError(*args, **kwargs)

This exception is used when an API request fails because a feature is not configured.

New in version 1.0.0.

exception freshpy.errors.exceptions.FreshPyError

This is the base class for FreshPy exceptions.

New in version 1.0.0.

exception freshpy.errors.exceptions.GETRequestError(*args, **kwargs)

This exception is used for generic GET request errors when there is not a more specific exception.

New in version 1.0.0.

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

This exception is used when an invalid field is provided.

New in version 1.0.0.

exception freshpy.errors.exceptions.InvalidFilterLogicError(*args, **kwargs)

This exception is used when an invalid filter logic operator is supplied.

New in version 1.0.0.

exception freshpy.errors.exceptions.InvalidPayloadValueError(*args, **kwargs)

This exception is used when an invalid value is provided for a payload field.

New in version 1.0.0.

exception freshpy.errors.exceptions.InvalidPredefinedFilterError(*args, **kwargs)

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

New in version 1.0.0.

exception freshpy.errors.exceptions.InvalidRequestTypeError(*args, **kwargs)

This exception is used when an invalid API request type is provided.

New in version 1.0.0.

exception freshpy.errors.exceptions.InvalidURLError(*args, **kwargs)

This exception is used when a provided URL is invalid.

New in version 1.0.0.

exception freshpy.errors.exceptions.LookupMismatchError(*args, **kwargs)

This exception is used when an a lookup value does not match the supplied lookup type.

New in version 1.0.0.

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

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

New in version 1.0.0.

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

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

New in version 1.0.0.

exception freshpy.errors.exceptions.NotFoundResponseError(*args, **kwargs)

This exception is used when an API query returns a 404 response and there isn’t a more specific class.

New in version 1.0.0.

exception freshpy.errors.exceptions.POSTRequestError(*args, **kwargs)

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

New in version 1.0.0.

exception freshpy.errors.exceptions.PUTRequestError(*args, **kwargs)

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

New in version 1.0.0.

Return to Top

Handlers Module (freshpy.errors.handlers)

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

Module:

freshpy.errors.handlers

Synopsis:

Functions that handle various error situations within the namespace

Created By:

Jeff Shurtliff

Last Modified:

Jeff Shurtliff

Modified Date:

28 Dec 2021

freshpy.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.

Core Utilities Module (freshpy.utils.core_utils)

This module includes various utilities to assist in converting dictionaries to JSON, formatting timestamps, etc.

Module:

freshpy.utils.core_utils

Synopsis:

Collection of supporting utilities and functions to complement the primary modules

Created By:

Jeff Shurtliff

Last Modified:

Jeff Shurtliff

Modified Date:

30 Dec 2021

freshpy.utils.core_utils.construct_query_string(existing_query=None, appendage=None)

This function assists in constructing query strings for URIs to ensure they follow the appropriate format.

New in version 1.0.0.

Parameters:

• existing_query (str, None) – The existing query string (if any)

• appendage (str, None) – The new addition to the query string to be appended (if any)

Returns:

The constructed query string

freshpy.utils.core_utils.url_decode(encoded_string)

This function decodes a url-encoded string.

New in version 1.0.0.

Parameters:

encoded_string (str) – The url-encoded string

Returns:

The unencoded string

freshpy.utils.core_utils.url_encode(raw_string)

This function encodes a string for use in URLs.

New in version 1.0.0.

Parameters:

raw_string (str) – The raw string to be encoded

Returns:

The encoded string

Return to Top

Logging Utilities Module (freshpy.utils.log_utils)

This module includes various utilities to assist with logging.

Module:

freshpy.utils.log_utils

Synopsis:

Collection of logging utilities and functions

Usage:

from freshpy.utils import log_utils

Example:

logger = log_utils.initialize_logging(__name__)

Created By:

Jeff Shurtliff

Last Modified:

Jeff Shurtliff

Modified Date:

27 Dec 2021

class freshpy.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.

New in version 1.0.0.

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.

New in version 1.0.0.

Note

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

freshpy.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 within a specific module.

New in version 1.0.0.

Todo

Add details about the parameters

Return to Top

Version Module (freshpy.utils.version)

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

Module:

freshpy.utils.version

Synopsis:

This simple script contains the package version

Created By:

Jeff Shurtliff

Last Modified:

Jeff Shurtliff

Modified Date:

04 Jan 2022

freshpy.utils.version.get_full_version()

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

New in version 1.0.0.

freshpy.utils.version.get_major_minor_version()

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

Return to Top