High-level Pythonic Interface in ecCodes

# A GRIB file handle meant for use in a context manager.

# Individual messages can be accessed using the ``next`` method.
# (This is the Iterator Protocol: http://www.diveintopython.net/file_handling/for_loops.html )
# it is also possible to iterate over each message in the file::

# Usage::
>>> with GribFile(filename) as grib:
...     # Print number of messages in file
...     len(grib)
...     # Open all messages in file
...     for msg in grib:
...         print(msg[key_name])
...     len(grib.open_messages)
>>> # When the file is closed, any open messages are closed
>>> len(grib.open_messages)
0

# A GRIB message.

# Each ``GribMessage`` is stored as a key/value pair in a dictionary-like
# structure. It can be used in a context manager or by itself. When the
# ``GribFile`` it belongs to is closed, the ``GribFile`` closes any open
# ``GribMessage``s that belong to it. If a ``GribMessage`` is closed before
# its ``GribFile`` is closed, it informs the ``GribFile`` of its closure.

# Scalar and vector values are set appropriately through the same method.

# ``GribMessage``s can be instantiated from a ``GribFile``, cloned from
# other ``GribMessage``s or taken from samples. Iterating over the members
# of a ``GribFile`` extracts the ``GribMessage``s it contains until the
# ``GribFile`` is exhausted.

# Usage::
>>> with GribFile(filename) as grib:
...     # Iterate through each message in the file
...     for msg in grib:
...         # Access a key from each message
...         print(msg[key_name])
...         # Report number of keys in message
...         len(msg)
...         # Report message size in bytes
...         msg.size()
...         # Report keys in message
...         msg.keys()
...         # Set scalar value
...         msg[scalar_key] = 5
...         # Array values are set transparently
...         msg[array_key] = [1, 2, 3]
...         # Messages can be written to file
...         with open(testfile, "w") as test:
...             msg.write(test)
...         # Messages can be cloned from other messages
...         msg2 = GribMessage(clone=msg)

# A BUFR file handle meant for use in a context manager.

# Individual messages can be accessed using the ``next`` method.
# (This is the Iterator Protocol: http://www.diveintopython.net/file_handling/for_loops.html )
# It is also possible to iterate over each message in the file::

# Usage::
>>> with BufrFile(filename) as bufr:
...     # Print number of messages in file
...     len(bufr)
...     # Open all messages in file
...     for msg in bufr:
...         print(msg[key_name])
...     len(bufr.open_messages)
>>> # When the file is closed, any open messages are closed
>>> len(bufr.open_messages)
0

# A BUFR message.

# Each ``BufrMessage`` is stored as a key/value pair in a dictionary-like
# structure. It can be used in a context manager or by itself. When the
# ``BufrFile`` it belongs to is closed, the ``BufrFile`` closes any open
# ``BufrMessage``s that belong to it. If a ``BufrMessage`` is closed before
# its ``BufrFile`` is closed, it informs the ``BufrFile`` of its closure.

# Scalar and vector values are set appropriately through the same method.

# ``BufrMessage``s can be instantiated from a ``BufrFile``, cloned from
# other ``BufrMessage``s or taken from samples. Iterating over the members
# of a ``BufrFile`` extracts the ``BufrMessage``s it contains until the
# ``BufrFile`` is exhausted.

# Usage::
>>> with BufrFile(filename) as bufr:
...     # Iterate through each message in the file
...     for msg in bufr:
...         # Access a key from each message
...         print(msg[key_name])
...         # Report number of keys in message
...         len(msg)
...         # Report message size in bytes
...         msg.size()
...         # Report keys in message
...         msg.keys()
...         # Set scalar value
...         msg[scalar_key] = 5
...         # Array values are set transparently
...         msg[array_key] = [1, 2, 3]
...         # Messages can be written to file
...         with open(testfile, "w") as test:
...             msg.write(test)
...         # Messages can be cloned from other messages
...         msg2 = BufrMessage(clone=msg)

# The class CodesInternalError is the base class for all the new exceptions

class WrongBitmapSizeError(CodesInternalError):
    """Size of bitmap is incorrect."""
class OutOfRangeError(CodesInternalError):
    """Value out of coding range."""
class UnsupportedEditionError(CodesInternalError):
    """Edition not supported.."""
class AttributeNotFoundError(CodesInternalError):
    """Attribute not found.."""
class TooManyAttributesError(CodesInternalError):
    """Too many attributes. Increase MAX_ACCESSOR_ATTRIBUTES."""
class AttributeClashError(CodesInternalError):
    """Attribute is already present, cannot add."""
class NullPointerError(CodesInternalError):
    """Null pointer."""
class MissingBufrEntryError(CodesInternalError):
    """Missing BUFR table entry for descriptor."""
class WrongConversionError(CodesInternalError):
    """Wrong type conversion."""
class StringTooSmallError(CodesInternalError):
    """String is smaller than requested."""
class InvalidKeyValueError(CodesInternalError):
    """Invalid key value."""
class ValueDifferentError(CodesInternalError):
    """Value is different."""
class DifferentEditionError(CodesInternalError):
    """Edition of two messages is different."""
class InvalidBitsPerValueError(CodesInternalError):
    """Invalid number of bits per value."""
class CorruptedIndexError(CodesInternalError):
    """Index is corrupted."""
class MessageMalformedError(CodesInternalError):
    """Message malformed."""
class UnderflowError(CodesInternalError):
    """Underflow."""
class SwitchNoMatchError(CodesInternalError):
    """Switch unable to find a matching case."""
class ConstantFieldError(CodesInternalError):
    """Constant field."""
class MessageTooLargeError(CodesInternalError):
    """Message is too large for the current architecture."""
class InternalArrayTooSmallError(CodesInternalError):
    """An internal array is too small."""
class PrematureEndOfFileError(CodesInternalError):
    """End of resource reached when reading message."""
class NullIndexError(CodesInternalError):
    """Null index."""
class EndOfIndexError(CodesInternalError):
    """End of index reached."""
class WrongGridError(CodesInternalError):
    """Grid description is wrong or inconsistent."""
class NoValuesError(CodesInternalError):
    """Unable to code a field without values."""
class EndError(CodesInternalError):
    """End of resource."""
class WrongTypeError(CodesInternalError):
    """Wrong type while packing."""
class NoDefinitionsError(CodesInternalError):
    """Definitions files not found."""
class HashArrayNoMatchError(CodesInternalError):
    """Hash array no match."""
class ConceptNoMatchError(CodesInternalError):
    """Concept no match."""
class OutOfAreaError(CodesInternalError):
    """The point is out of the grid area."""
class MissingKeyError(CodesInternalError):
    """Missing a key from the fieldset."""
class InvalidOrderByError(CodesInternalError):
    """Invalid order by."""
class InvalidNearestError(CodesInternalError):
    """Invalid nearest id."""
class InvalidKeysIteratorError(CodesInternalError):
    """Invalid keys iterator id."""
class InvalidIteratorError(CodesInternalError):
    """Invalid iterator id."""
class InvalidIndexError(CodesInternalError):
    """Invalid index id."""
class InvalidGribError(CodesInternalError):
    """Invalid grib id."""
class InvalidFileError(CodesInternalError):
    """Invalid file id."""
class WrongStepUnitError(CodesInternalError):
    """Wrong units for step (step must be integer)."""
class WrongStepError(CodesInternalError):
    """Unable to set step."""
class InvalidTypeError(CodesInternalError):
    """Invalid key type."""
class WrongLengthError(CodesInternalError):
    """Wrong message length."""
class ValueCannotBeMissingError(CodesInternalError):
    """Value cannot be missing."""
class InvalidSectionNumberError(CodesInternalError):
    """Invalid section number."""
class NullHandleError(CodesInternalError):
    """Null handle."""
class InvalidArgumentError(CodesInternalError):
    """Invalid argument."""
class ReadOnlyError(CodesInternalError):
    """Value is read only."""
class MemoryAllocationError(CodesInternalError):
    """Memory allocation error."""
class GeocalculusError(CodesInternalError):
    """Problem with calculation of geographic attributes."""
class NoMoreInSetError(CodesInternalError):
    """Code cannot unpack because of string too small."""
class EncodingError(CodesInternalError):
    """Encoding invalid."""
class DecodingError(CodesInternalError):
    """Decoding invalid."""
class MessageInvalidError(CodesInternalError):
    """Message invalid."""
class IOProblemError(CodesInternalError):
    """Input output problem."""
class KeyValueNotFoundError(CodesInternalError):
    """Key/value not found."""
class WrongArraySizeError(CodesInternalError):
    """Array size mismatch."""
class CodeNotFoundInTableError(CodesInternalError):
    """Code not found in code table."""
class FileNotFoundError(CodesInternalError):
    """File not found."""
class ArrayTooSmallError(CodesInternalError):
    """Passed array is too small."""
class MessageEndNotFoundError(CodesInternalError):
    """Missing 7777 at end of message."""
class FunctionNotImplementedError(CodesInternalError):
    """Function not yet implemented."""
class BufferTooSmallError(CodesInternalError):
    """Passed buffer is too small."""
class InternalError(CodesInternalError):
    """Internal error."""
class EndOfFileError(CodesInternalError):
    """End of resource reached."""