cowbird.utils

Module Contents

Classes

ExtendedEnum	Utility enum.Enum methods.
SingletonMeta	A metaclass that creates a Singleton base class when called.
NullType	Represents a null value to differentiate from None.

Functions

get_logger(name: str, level: Optional[int] = None, force_stdout: bool = None, message_format: Optional[str] = None, datetime_format: Optional[str] = None) → logging.Logger	Immediately sets the logger level to avoid duplicate log outputs from the root logger and this logger when
set_logger_config(logger: logging.Logger, force_stdout: bool = False, message_format: Optional[str] = None, datetime_format: Optional[str] = None) → logging.Logger	Applies the provided logging configuration settings to the logger.
print_log(msg: str, logger: Optional[logging.Logger] = None, level: int = logging.INFO, **kwargs: Any) → None	Logs the requested message to the logger and optionally enforce printing to the console according to configuration
raise_log(msg: str, exception: Type[Exception] = Exception, logger: Optional[logging.Logger] = None, level: int = logging.ERROR) → NoReturn	Logs the provided message to the logger and raises the corresponding exception afterwards.
bool2str(value: Any) → str	Converts value to explicit "true" or "false" str with permissive variants comparison
islambda(func: Any) → bool	Evaluate if argument is a callable lambda expression.
configure_celery(config, config_ini)
get_app_config(container: cowbird.typedefs.AnySettingsContainer) → pyramid.config.Configurator	Generates application configuration with all required utilities and settings configured.
get_settings_from_config_ini(config_ini_path, section=None)	Loads configuration INI settings with additional handling.
get_registry(container: cowbird.typedefs.AnyRegistryContainer, nothrow: bool = False) → Optional[pyramid.registry.Registry]	Retrieves the application registry from various containers referencing to it.
get_json(response)	Retrieves the ‘JSON’ body of a response using the property/callable according to the response’s implementation.
get_header(header_name: str, header_container: cowbird.typedefs.AnyHeadersType, default: Optional[str] = None, split: Optional[Union[str, List[str]]] = None) → Optional[str]	Retrieves header_name by fuzzy match (independently of upper/lower-case and underscore/dash) from various
convert_response(response: cowbird.typedefs.AnyResponseType) → pyramid.response.Response	Converts a requests.Response object to an equivalent pyramid.response.Response object.
get_settings(container: Optional[cowbird.typedefs.AnySettingsContainer], app: bool = False) → cowbird.typedefs.SettingsType	Retrieve application settings from a supported container.
fully_qualified_name(obj: Union[Any, Type[Any]]) → str	Obtains the '<module>.<name>' full path definition of the object to allow finding and importing it.
log_request_format(request: pyramid.request.Request) → str
log_request(event: pyramid.events.NewRequest) → None	Subscriber event that logs basic details about the incoming requests.
log_exception_tween(handler, registry)	Tween factory that logs any exception before re-raising it.
is_json_body(body: Any) → bool
is_null(item)
get_config_path()
get_ssl_verify(container: Optional[cowbird.typedefs.AnySettingsContainer]) → bool

Attributes

CONTENT_TYPE_ANY
CONTENT_TYPE_JSON
CONTENT_TYPE_FORM
CONTENT_TYPE_HTML
CONTENT_TYPE_PLAIN
CONTENT_TYPE_APP_XML
CONTENT_TYPE_TXT_XML
FORMAT_TYPE_MAPPING
SUPPORTED_ACCEPT_TYPES
SUPPORTED_FORMAT_TYPES
KNOWN_CONTENT_TYPES
CLI_MODE_CFG
USE_TEST_CELERY_APP_CFG
LOGGER
null

cowbird.utils.CONTENT_TYPE_ANY = */*

cowbird.utils.CONTENT_TYPE_JSON = application/json

cowbird.utils.CONTENT_TYPE_FORM = application/x-www-form-urlencoded

cowbird.utils.CONTENT_TYPE_HTML = text/html

cowbird.utils.CONTENT_TYPE_PLAIN = text/plain

cowbird.utils.CONTENT_TYPE_APP_XML = application/xml

cowbird.utils.CONTENT_TYPE_TXT_XML = text/xml

cowbird.utils.FORMAT_TYPE_MAPPING

cowbird.utils.SUPPORTED_ACCEPT_TYPES

cowbird.utils.SUPPORTED_FORMAT_TYPES

cowbird.utils.KNOWN_CONTENT_TYPES

cowbird.utils.CLI_MODE_CFG = cli_mode

cowbird.utils.USE_TEST_CELERY_APP_CFG = use_test_celery_app

cowbird.utils.get_logger(name: str, level: Optional[int] = None, force_stdout: bool = None, message_format: Optional[str] = None, datetime_format: Optional[str] = None) → logging.Logger

Immediately sets the logger level to avoid duplicate log outputs from the root logger and this logger when level is logging.NOTSET.

cowbird.utils.LOGGER

cowbird.utils.set_logger_config(logger: logging.Logger, force_stdout: bool = False, message_format: Optional[str] = None, datetime_format: Optional[str] = None) → logging.Logger

Applies the provided logging configuration settings to the logger.

cowbird.utils.print_log(msg: str, logger: Optional[logging.Logger] = None, level: int = logging.INFO, **kwargs: Any) → None

Logs the requested message to the logger and optionally enforce printing to the console according to configuration value defined by COWBIRD_LOG_PRINT.

cowbird.utils.raise_log(msg: str, exception: Type[Exception] = Exception, logger: Optional[logging.Logger] = None, level: int = logging.ERROR) → NoReturn

Logs the provided message to the logger and raises the corresponding exception afterwards.

Raises

exception – whichever exception provided is raised systematically after logging.

cowbird.utils.bool2str(value: Any) → str

Converts value to explicit "true" or "false" str with permissive variants comparison that can represent common falsy or truthy values.

cowbird.utils.islambda(func: Any) → bool

Evaluate if argument is a callable lambda expression.

cowbird.utils.configure_celery(config, config_ini)

cowbird.utils.get_app_config(container: cowbird.typedefs.AnySettingsContainer) → pyramid.config.Configurator

Generates application configuration with all required utilities and settings configured.

cowbird.utils.get_settings_from_config_ini(config_ini_path, section=None)

Loads configuration INI settings with additional handling.

cowbird.utils.get_registry(container: cowbird.typedefs.AnyRegistryContainer, nothrow: bool = False) → Optional[pyramid.registry.Registry]

Retrieves the application registry from various containers referencing to it.

cowbird.utils.get_json(response)

Retrieves the ‘JSON’ body of a response using the property/callable according to the response’s implementation.

cowbird.utils.get_header(header_name: str, header_container: cowbird.typedefs.AnyHeadersType, default: Optional[str] = None, split: Optional[Union[str, List[str]]] = None) → Optional[str]

Retrieves header_name by fuzzy match (independently of upper/lower-case and underscore/dash) from various framework implementations of Headers.

If split is specified, the matched header_name is first split with it and the first item is returned. This allows to parse complex headers (e.g.: text/plain; charset=UTF-8 to text/plain with split=';').

Parameters

• header_name – header to find.

• header_container – where to look for header_name.

• default – value to returned if header_container is invalid or header_name could not be found.

• split – character(s) to use to split the found header_name.

cowbird.utils.convert_response(response: cowbird.typedefs.AnyResponseType) → pyramid.response.Response

Converts a requests.Response object to an equivalent pyramid.response.Response object.

Content of the response is expected to be JSON.

Parameters

response – response to be converted

Returns

converted response

cowbird.utils.get_settings(container: Optional[cowbird.typedefs.AnySettingsContainer], app: bool = False) → cowbird.typedefs.SettingsType

Retrieve application settings from a supported container.

Parameters

• container – supported container with an handle to application settings.

• app – allow retrieving from current thread registry if no container was defined.

Returns

found application settings dictionary.

Raises

TypeError – when no application settings could be found or unsupported container.

cowbird.utils.fully_qualified_name(obj: Union[Any, Type[Any]]) → str

Obtains the '<module>.<name>' full path definition of the object to allow finding and importing it.

cowbird.utils.log_request_format(request: pyramid.request.Request) → str

cowbird.utils.log_request(event: pyramid.events.NewRequest) → None

Subscriber event that logs basic details about the incoming requests.

cowbird.utils.log_exception_tween(handler, registry)

Tween factory that logs any exception before re-raising it.

Application errors are marked as ERROR while non critical HTTP errors are marked as WARNING.

cowbird.utils.is_json_body(body: Any) → bool

class cowbird.utils.ExtendedEnum

Bases: enum.Enum

Utility enum.Enum methods.

Create an extended enum with these utilities as follows:

class CustomEnum(ExtendedEnum):
    ItemA = "A"
    ItemB = "B"

classmethod names(cls) → List[str]

Returns the member names assigned to corresponding enum elements.

classmethod values(cls) → List[cowbird.typedefs.AnyKey]

Returns the literal values assigned to corresponding enum elements.

classmethod get(cls: cowbird.typedefs.AnyKey, key_or_value: Optional[Any], default=None) → Optional[_TC]

Finds an enum entry by defined name or its value.

Returns the entry directly if it is already a valid enum.

class cowbird.utils.SingletonMeta

Bases: type

A metaclass that creates a Singleton base class when called.

Create a class such that.

class A(object, metaclass=SingletonMeta):
    pass

class B(object, metaclass=SingletonMeta):
    pass

a1 = A()
a2 = A()
b1 = B()
b2 = B()
a1 is a2    # True
b1 is b2    # True
a1 is b1    # False

_instances

__call__(cls, *args, **kwargs)

Call self as a function.

class cowbird.utils.NullType

Bases: object

Represents a null value to differentiate from None.

__bool__

__len__

__repr__(self)

Return repr(self).

static __nonzero__()

cowbird.utils.null

cowbird.utils.is_null(item)

cowbird.utils.get_config_path()

cowbird.utils.get_ssl_verify(container: Optional[cowbird.typedefs.AnySettingsContainer]) → bool