conda_recipe_manager package

Subpackages

Submodules

conda_recipe_manager.types module

Description:

Provides public types, type aliases, constants, and small classes used by all modules.

class conda_recipe_manager.types.MessageCategory(value, names=None, *, module=None, qualname=None, type=None, start=1, boundary=None)[source]

Bases: StrEnum

Categories to classify messages into.

ERROR = 'error'
EXCEPTION = 'exception'
WARNING = 'warning'
class conda_recipe_manager.types.MessageTable[source]

Bases: object

Stores and tags messages that may come up during library operations. It is up to the client program to handle the logging of these messages. In other words, this class aims to keep logging out of the library code by providing an object that can track debugging information.

add_message(category: MessageCategory, message: str) None[source]

Adds a message to the table

Parameters:
  • category

  • message

get_message_count(category: MessageCategory) int[source]

Returns how many messages are stored in a given category

Parameters:

category -- Category to target

Returns:

A list containing all the messages stored in a category.

get_messages(category: MessageCategory) list[str][source]

Returns all the messages stored in a given category

Parameters:

category -- Category to target

Returns:

A list containing all the messages stored in a category.

get_totals_message() str[source]

Convenience function that returns a displayable count of the number of warnings and errors contained in the messaging object.

Returns:

A message indicating the number of errors and warnings that have been accumulated. If there are none, an empty string is returned.

class conda_recipe_manager.types.SentinelType[source]

Bases: object

A single sentinel class to be used in this project, as an alternative to None when None cannot be used. It is defined in a way such that SentinelType instances survive pickling and allocations in different memory spaces.

Module contents