bufrust 1.0.0__cp313-cp313-win32.whl

bufrust/__init__.py

@@ -0,0 +1,459 @@
+"""Friendly Python interface for the Rust BUFR edition 4 decoder."""
+
+from __future__ import annotations
+
+from dataclasses import dataclass
+from importlib.resources import files
+from pathlib import Path
+from typing import Any, Iterable, Iterator
+
+from ._bufrust import (
+    BufrMessage as RawMessage,
+    DecodedValue,
+    Descriptor,
+    ElementDefinition,
+    SequenceDefinition,
+    TableSet,
+    decode_values as _decode_values,
+    decode_values_with_definitions as _decode_values_with_definitions,
+    decode_values_with_tables as _decode_values_with_tables,
+    expand_descriptors,
+    parse_all_bytes as _parse_all_bytes,
+    parse_all_file,
+    parse_bytes as _parse_bytes,
+    parse_file,
+)
+
+__version__ = "1.0.0"
+
+
+class BufrustError(ValueError):
+    """Raised by the high-level Python convenience API."""
+
+
+@dataclass(frozen=True)
+class Message:
+    """A single BUFR message plus its original bytes."""
+
+    raw: RawMessage
+    data: bytes
+    index: int = 0
+    path: str | None = None
+    definitions: str | None = None
+    table_dir: str | None = None
+
+    def decode(
+        self,
+        *,
+        definitions: str | Path | None = None,
+        table_dir: str | Path | None = None,
+    ) -> list[DecodedValue]:
+        """Decode Section 4 values for this message."""
+
+        definitions = _coalesce_path(definitions, self.definitions)
+        table_dir = _coalesce_path(table_dir, self.table_dir)
+        if definitions is None and table_dir is None:
+            definitions = builtin_definitions_path()
+        if definitions is not None:
+            return _decode_values_with_definitions(self.data, definitions)
+        if table_dir is not None:
+            return _decode_values(self.data, table_dir)
+        raise BufrustError("decode() needs definitions=... or table_dir=...")
+
+    def decode_with_tables(self, tables: TableSet) -> list[DecodedValue]:
+        """Decode Section 4 values with an already loaded TableSet."""
+
+        return _decode_values_with_tables(self.data, tables)
+
+    @property
+    def descriptors(self) -> list[int]:
+        """Unexpanded Section 3 descriptor codes."""
+
+        return list(self.raw.unexpanded_descriptors)
+
+    @property
+    def metadata(self) -> dict[str, Any]:
+        """Message metadata as a plain dictionary."""
+
+        fields = [
+            "total_length",
+            "edition",
+            "section1_length",
+            "master_table_number",
+            "originating_centre",
+            "originating_subcentre",
+            "update_sequence_number",
+            "local_section_present",
+            "data_category",
+            "international_data_subcategory",
+            "local_data_subcategory",
+            "master_tables_version_number",
+            "local_tables_version_number",
+            "typical_year",
+            "typical_month",
+            "typical_day",
+            "typical_hour",
+            "typical_minute",
+            "typical_second",
+            "section2_length",
+            "section3_length",
+            "number_of_subsets",
+            "observed_data",
+            "compressed_data",
+            "section4_length",
+            "section4_data_offset",
+            "section4_data_length",
+        ]
+        out = {field: getattr(self.raw, field) for field in fields}
+        out["message_index"] = self.index
+        if self.path is not None:
+            out["path"] = self.path
+        return out
+
+    def to_dict(self, *, decode: bool = False, **decode_options: Any) -> dict[str, Any]:
+        """Convert metadata, descriptors, and optionally decoded values to dictionaries."""
+
+        out = {
+            "metadata": self.metadata,
+            "descriptors": self.descriptors,
+        }
+        if decode:
+            out["values"] = values_to_dicts(self.decode(**decode_options))
+        return out
+
+    def to_dataframe(self, **decode_options: Any):
+        """Decode values into a pandas DataFrame if pandas is installed."""
+
+        return values_to_dataframe(
+            self.decode(**decode_options),
+            number_of_subsets=self.raw.number_of_subsets,
+            message_index=self.index,
+        )
+
+    def __repr__(self) -> str:
+        return (
+            "Message("
+            f"index={self.index}, edition={self.raw.edition}, "
+            f"subsets={self.raw.number_of_subsets}, "
+            f"compressed={self.raw.compressed_data})"
+        )
+
+
+class Dataset:
+    """A BUFR file or byte buffer containing one or more messages."""
+
+    def __init__(
+        self,
+        data: bytes,
+        *,
+        path: str | None = None,
+        definitions: str | Path | None = None,
+        table_dir: str | Path | None = None,
+    ) -> None:
+        self.data = bytes(data)
+        self.path = path
+        self.definitions = _path_str(definitions)
+        self.table_dir = _path_str(table_dir)
+        raw_messages = _parse_all_bytes(self.data)
+        chunks = _split_message_bytes(self.data)
+        if len(raw_messages) != len(chunks):
+            raise BufrustError("internal split mismatch while reading BUFR messages")
+        self.messages = [
+            Message(
+                raw=raw,
+                data=chunk,
+                index=index,
+                path=path,
+                definitions=self.definitions,
+                table_dir=self.table_dir,
+            )
+            for index, (raw, chunk) in enumerate(zip(raw_messages, chunks))
+        ]
+
+    @classmethod
+    def from_file(
+        cls,
+        path: str | Path,
+        *,
+        definitions: str | Path | None = None,
+        table_dir: str | Path | None = None,
+    ) -> "Dataset":
+        """Read BUFR messages from a file path."""
+
+        path = Path(path)
+        return cls(
+            path.read_bytes(),
+            path=str(path),
+            definitions=definitions,
+            table_dir=table_dir,
+        )
+
+    def decode(
+        self,
+        message: int = 0,
+        *,
+        definitions: str | Path | None = None,
+        table_dir: str | Path | None = None,
+    ) -> list[DecodedValue]:
+        """Decode one message by index."""
+
+        return self.messages[message].decode(definitions=definitions, table_dir=table_dir)
+
+    def decode_all(
+        self,
+        *,
+        definitions: str | Path | None = None,
+        table_dir: str | Path | None = None,
+    ) -> list[list[DecodedValue]]:
+        """Decode every message in the dataset."""
+
+        definitions = _coalesce_path(definitions, self.definitions)
+        table_dir = _coalesce_path(table_dir, self.table_dir)
+        if table_dir is not None:
+            tables = TableSet.from_eccodes(table_dir)
+            return [message.decode_with_tables(tables) for message in self.messages]
+
+        definitions = definitions or builtin_definitions_path()
+        cache: dict[tuple[int, int, int, int, int], TableSet] = {}
+        decoded = []
+        for message in self.messages:
+            raw = message.raw
+            key = (
+                raw.master_table_number,
+                raw.master_tables_version_number,
+                raw.local_tables_version_number,
+                raw.originating_centre,
+                raw.originating_subcentre,
+            )
+            tables = cache.get(key)
+            if tables is None:
+                tables = TableSet.from_definitions(definitions, raw)
+                cache[key] = tables
+            decoded.append(message.decode_with_tables(tables))
+        return decoded
+
+    @property
+    def metadata(self) -> list[dict[str, Any]]:
+        """Metadata for all messages."""
+
+        return [message.metadata for message in self.messages]
+
+    @property
+    def descriptors(self) -> list[list[int]]:
+        """Unexpanded descriptors for all messages."""
+
+        return [message.descriptors for message in self.messages]
+
+    def to_dict(self, *, decode: bool = False, **decode_options: Any) -> dict[str, Any]:
+        """Convert the dataset to dictionaries."""
+
+        return {
+            "path": self.path,
+            "message_count": len(self.messages),
+            "messages": [
+                message.to_dict(decode=decode, **decode_options)
+                for message in self.messages
+            ],
+        }
+
+    def to_dataframe(self, message: int | None = None, **decode_options: Any):
+        """Decode one or all messages into a pandas DataFrame if pandas is installed."""
+
+        if message is not None:
+            return self.messages[message].to_dataframe(**decode_options)
+        decoded = self.decode_all(**decode_options)
+        try:
+            import pandas as pd
+        except ImportError as exc:
+            raise BufrustError("to_dataframe() requires pandas") from exc
+        frames = [
+            values_to_dataframe(
+                values,
+                number_of_subsets=message.raw.number_of_subsets,
+                message_index=message.index,
+            )
+            for message, values in zip(self.messages, decoded)
+        ]
+        return pd.concat(frames, ignore_index=True) if frames else pd.DataFrame()
+
+    def __iter__(self) -> Iterator[Message]:
+        return iter(self.messages)
+
+    def __getitem__(self, index: int) -> Message:
+        return self.messages[index]
+
+    def __len__(self) -> int:
+        return len(self.messages)
+
+    def __repr__(self) -> str:
+        source = f", path={self.path!r}" if self.path else ""
+        return f"Dataset(messages={len(self.messages)}{source})"
+
+
+def open(
+    path: str | Path,
+    *,
+    definitions: str | Path | None = None,
+    table_dir: str | Path | None = None,
+) -> Dataset:
+    """Open a BUFR file and return a Dataset."""
+
+    return Dataset.from_file(path, definitions=definitions, table_dir=table_dir)
+
+
+def loads(
+    data: bytes | bytearray | memoryview,
+    *,
+    definitions: str | Path | None = None,
+    table_dir: str | Path | None = None,
+) -> Dataset:
+    """Load BUFR messages from bytes and return a Dataset."""
+
+    return Dataset(bytes(data), definitions=definitions, table_dir=table_dir)
+
+
+def load(
+    source: str | Path | bytes | bytearray | memoryview,
+    *,
+    definitions: str | Path | None = None,
+    table_dir: str | Path | None = None,
+) -> Dataset:
+    """Open a path or bytes-like object."""
+
+    if isinstance(source, (bytes, bytearray, memoryview)):
+        return loads(source, definitions=definitions, table_dir=table_dir)
+    return open(source, definitions=definitions, table_dir=table_dir)
+
+
+def values_to_dicts(values: Iterable[DecodedValue]) -> list[dict[str, Any]]:
+    """Convert decoded values to plain dictionaries."""
+
+    return [
+        {
+            "descriptor": value.descriptor,
+            "name": value.name,
+            "value": value.value,
+            "raw": value.raw,
+            "text": value.text,
+        }
+        for value in values
+    ]
+
+
+def values_to_dataframe(
+    values: Iterable[DecodedValue],
+    *,
+    number_of_subsets: int | None = None,
+    message_index: int | None = None,
+):
+    """Convert decoded values to a long-form pandas DataFrame."""
+
+    try:
+        import pandas as pd
+    except ImportError as exc:
+        raise BufrustError("values_to_dataframe() requires pandas") from exc
+
+    rows = values_to_dicts(values)
+    if number_of_subsets and rows and len(rows) % number_of_subsets == 0:
+        values_per_subset = len(rows) // number_of_subsets
+        for offset, row in enumerate(rows):
+            row["subset"] = offset // values_per_subset
+            row["position"] = offset % values_per_subset
+    else:
+        for offset, row in enumerate(rows):
+            row["subset"] = None
+            row["position"] = offset
+    if message_index is not None:
+        for row in rows:
+            row["message"] = message_index
+    return pd.DataFrame(rows)
+
+
+def builtin_definitions_path() -> str:
+    """Return the bundled ecCodes-style BUFR definitions directory."""
+
+    return str(files(__package__).joinpath("definitions"))
+
+
+def tables_for_message(
+    message: Message | RawMessage,
+    *,
+    definitions: str | Path | None = None,
+) -> TableSet:
+    """Load the table set selected by a message header.
+
+    Uses the bundled WMO definitions by default. Pass ``definitions=`` to use
+    an external ecCodes definitions root instead.
+    """
+
+    raw = message.raw if isinstance(message, Message) else message
+    return TableSet.from_definitions(
+        _path_str(definitions) or builtin_definitions_path(),
+        raw,
+    )
+
+
+def _split_message_bytes(data: bytes) -> list[bytes]:
+    chunks = []
+    offset = 0
+    while offset < len(data):
+        start = data.find(b"BUFR", offset)
+        if start < 0:
+            break
+        if start + 8 > len(data):
+            raise BufrustError("truncated BUFR header")
+        total_length = int.from_bytes(data[start + 4 : start + 7], "big")
+        end = start + total_length
+        if end > len(data):
+            raise BufrustError("truncated BUFR message")
+        chunks.append(data[start:end])
+        offset = end
+    return chunks
+
+
+def _path_str(path: str | Path | None) -> str | None:
+    return None if path is None else str(path)
+
+
+def _coalesce_path(value: str | Path | None, default: str | None) -> str | None:
+    return _path_str(value) if value is not None else default
+
+
+read = open
+get = open
+parse_bytes = _parse_bytes
+parse_all_bytes = _parse_all_bytes
+decode_values = _decode_values
+decode_values_with_definitions = _decode_values_with_definitions
+decode_values_with_tables = _decode_values_with_tables
+BufrMessage = RawMessage
+
+__all__ = [
+    "BufrustError",
+    "Dataset",
+    "Message",
+    "RawMessage",
+    "BufrMessage",
+    "DecodedValue",
+    "Descriptor",
+    "ElementDefinition",
+    "SequenceDefinition",
+    "TableSet",
+    "builtin_definitions_path",
+    "decode_values",
+    "decode_values_with_definitions",
+    "decode_values_with_tables",
+    "expand_descriptors",
+    "get",
+    "load",
+    "loads",
+    "open",
+    "parse_all_bytes",
+    "parse_all_file",
+    "parse_bytes",
+    "parse_file",
+    "read",
+    "tables_for_message",
+    "values_to_dataframe",
+    "values_to_dicts",
+]

bufrust/definitions/ECCODES_LICENSE

@@ -0,0 +1,202 @@
+                                 Apache License
+                           Version 2.0, January 2004
+                        http://www.apache.org/licenses/
+
+   TERMS AND CONDITIONS FOR USE, REPRODUCTION, AND DISTRIBUTION
+
+   1. Definitions.
+
+      "License" shall mean the terms and conditions for use, reproduction,
+      and distribution as defined by Sections 1 through 9 of this document.
+
+      "Licensor" shall mean the copyright owner or entity authorized by
+      the copyright owner that is granting the License.
+
+      "Legal Entity" shall mean the union of the acting entity and all
+      other entities that control, are controlled by, or are under common
+      control with that entity. For the purposes of this definition,
+      "control" means (i) the power, direct or indirect, to cause the
+      direction or management of such entity, whether by contract or
+      otherwise, or (ii) ownership of fifty percent (50%) or more of the
+      outstanding shares, or (iii) beneficial ownership of such entity.
+
+      "You" (or "Your") shall mean an individual or Legal Entity
+      exercising permissions granted by this License.
+
+      "Source" form shall mean the preferred form for making modifications,
+      including but not limited to software source code, documentation
+      source, and configuration files.
+
+      "Object" form shall mean any form resulting from mechanical
+      transformation or translation of a Source form, including but
+      not limited to compiled object code, generated documentation,
+      and conversions to other media types.
+
+      "Work" shall mean the work of authorship, whether in Source or
+      Object form, made available under the License, as indicated by a
+      copyright notice that is included in or attached to the work
+      (an example is provided in the Appendix below).
+
+      "Derivative Works" shall mean any work, whether in Source or Object
+      form, that is based on (or derived from) the Work and for which the
+      editorial revisions, annotations, elaborations, or other modifications
+      represent, as a whole, an original work of authorship. For the purposes
+      of this License, Derivative Works shall not include works that remain
+      separable from, or merely link (or bind by name) to the interfaces of,
+      the Work and Derivative Works thereof.
+
+      "Contribution" shall mean any work of authorship, including
+      the original version of the Work and any modifications or additions
+      to that Work or Derivative Works thereof, that is intentionally
+      submitted to Licensor for inclusion in the Work by the copyright owner
+      or by an individual or Legal Entity authorized to submit on behalf of
+      the copyright owner. For the purposes of this definition, "submitted"
+      means any form of electronic, verbal, or written communication sent
+      to the Licensor or its representatives, including but not limited to
+      communication on electronic mailing lists, source code control systems,
+      and issue tracking systems that are managed by, or on behalf of, the
+      Licensor for the purpose of discussing and improving the Work, but
+      excluding communication that is conspicuously marked or otherwise
+      designated in writing by the copyright owner as "Not a Contribution."
+
+      "Contributor" shall mean Licensor and any individual or Legal Entity
+      on behalf of whom a Contribution has been received by Licensor and
+      subsequently incorporated within the Work.
+
+   2. Grant of Copyright License. Subject to the terms and conditions of
+      this License, each Contributor hereby grants to You a perpetual,
+      worldwide, non-exclusive, no-charge, royalty-free, irrevocable
+      copyright license to reproduce, prepare Derivative Works of,
+      publicly display, publicly perform, sublicense, and distribute the
+      Work and such Derivative Works in Source or Object form.
+
+   3. Grant of Patent License. Subject to the terms and conditions of
+      this License, each Contributor hereby grants to You a perpetual,
+      worldwide, non-exclusive, no-charge, royalty-free, irrevocable
+      (except as stated in this section) patent license to make, have made,
+      use, offer to sell, sell, import, and otherwise transfer the Work,
+      where such license applies only to those patent claims licensable
+      by such Contributor that are necessarily infringed by their
+      Contribution(s) alone or by combination of their Contribution(s)
+      with the Work to which such Contribution(s) was submitted. If You
+      institute patent litigation against any entity (including a
+      cross-claim or counterclaim in a lawsuit) alleging that the Work
+      or a Contribution incorporated within the Work constitutes direct
+      or contributory patent infringement, then any patent licenses
+      granted to You under this License for that Work shall terminate
+      as of the date such litigation is filed.
+
+   4. Redistribution. You may reproduce and distribute copies of the
+      Work or Derivative Works thereof in any medium, with or without
+      modifications, and in Source or Object form, provided that You
+      meet the following conditions:
+
+      (a) You must give any other recipients of the Work or
+          Derivative Works a copy of this License; and
+
+      (b) You must cause any modified files to carry prominent notices
+          stating that You changed the files; and
+
+      (c) You must retain, in the Source form of any Derivative Works
+          that You distribute, all copyright, patent, trademark, and
+          attribution notices from the Source form of the Work,
+          excluding those notices that do not pertain to any part of
+          the Derivative Works; and
+
+      (d) If the Work includes a "NOTICE" text file as part of its
+          distribution, then any Derivative Works that You distribute must
+          include a readable copy of the attribution notices contained
+          within such NOTICE file, excluding those notices that do not
+          pertain to any part of the Derivative Works, in at least one
+          of the following places: within a NOTICE text file distributed
+          as part of the Derivative Works; within the Source form or
+          documentation, if provided along with the Derivative Works; or,
+          within a display generated by the Derivative Works, if and
+          wherever such third-party notices normally appear. The contents
+          of the NOTICE file are for informational purposes only and
+          do not modify the License. You may add Your own attribution
+          notices within Derivative Works that You distribute, alongside
+          or as an addendum to the NOTICE text from the Work, provided
+          that such additional attribution notices cannot be construed
+          as modifying the License.
+
+      You may add Your own copyright statement to Your modifications and
+      may provide additional or different license terms and conditions
+      for use, reproduction, or distribution of Your modifications, or
+      for any such Derivative Works as a whole, provided Your use,
+      reproduction, and distribution of the Work otherwise complies with
+      the conditions stated in this License.
+
+   5. Submission of Contributions. Unless You explicitly state otherwise,
+      any Contribution intentionally submitted for inclusion in the Work
+      by You to the Licensor shall be under the terms and conditions of
+      this License, without any additional terms or conditions.
+      Notwithstanding the above, nothing herein shall supersede or modify
+      the terms of any separate license agreement you may have executed
+      with Licensor regarding such Contributions.
+
+   6. Trademarks. This License does not grant permission to use the trade
+      names, trademarks, service marks, or product names of the Licensor,
+      except as required for reasonable and customary use in describing the
+      origin of the Work and reproducing the content of the NOTICE file.
+
+   7. Disclaimer of Warranty. Unless required by applicable law or
+      agreed to in writing, Licensor provides the Work (and each
+      Contributor provides its Contributions) on an "AS IS" BASIS,
+      WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or
+      implied, including, without limitation, any warranties or conditions
+      of TITLE, NON-INFRINGEMENT, MERCHANTABILITY, or FITNESS FOR A
+      PARTICULAR PURPOSE. You are solely responsible for determining the
+      appropriateness of using or redistributing the Work and assume any
+      risks associated with Your exercise of permissions under this License.
+
+   8. Limitation of Liability. In no event and under no legal theory,
+      whether in tort (including negligence), contract, or otherwise,
+      unless required by applicable law (such as deliberate and grossly
+      negligent acts) or agreed to in writing, shall any Contributor be
+      liable to You for damages, including any direct, indirect, special,
+      incidental, or consequential damages of any character arising as a
+      result of this License or out of the use or inability to use the
+      Work (including but not limited to damages for loss of goodwill,
+      work stoppage, computer failure or malfunction, or any and all
+      other commercial damages or losses), even if such Contributor
+      has been advised of the possibility of such damages.
+
+   9. Accepting Warranty or Additional Liability. While redistributing
+      the Work or Derivative Works thereof, You may choose to offer,
+      and charge a fee for, acceptance of support, warranty, indemnity,
+      or other liability obligations and/or rights consistent with this
+      License. However, in accepting such obligations, You may act only
+      on Your own behalf and on Your sole responsibility, not on behalf
+      of any other Contributor, and only if You agree to indemnify,
+      defend, and hold each Contributor harmless for any liability
+      incurred by, or claims asserted against, such Contributor by reason
+      of your accepting any such warranty or additional liability.
+
+   END OF TERMS AND CONDITIONS
+
+   APPENDIX: How to apply the Apache License to your work.
+
+      To apply the Apache License to your work, attach the following
+      boilerplate notice, with the fields enclosed by brackets "[]"
+      replaced with your own identifying information. (Don't include
+      the brackets!)  The text should be enclosed in the appropriate
+      comment syntax for the file format. We also recommend that a
+      file or class name and description of purpose be included on the
+      same "printed page" as the copyright notice for easier
+      identification within third-party archives.
+
+   Copyright 2005- ECMWF
+
+   Licensed under the Apache License, Version 2.0 (the "License");
+   you may not use this file except in compliance with the License.
+   You may obtain a copy of the License at
+
+       http://www.apache.org/licenses/LICENSE-2.0
+
+   Unless required by applicable law or agreed to in writing, software
+   distributed under the License is distributed on an "AS IS" BASIS,
+   WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+   See the License for the specific language governing permissions and
+   limitations under the License.
+

bufrust/definitions/ECCODES_NOTICE

@@ -0,0 +1,25 @@
+ECMWF ecCodes
+(C) Copyright 2005- ECMWF.
+
+This product includes software developed at ECMWF (http://www.ecmwf.int).
+
+Parts of the definitions provided by WMO (https://public.wmo.int/en)
+
+Microsoft Visual Studio support provided with the help of
+Finnish Meteorological Institute (FMI).
+
+Adaptive Entropy Coding (CCSDS) provided by
+The Max-Planck-Institute for Meteorology and Deutsches Klimarechenzentrum GmbH.
+
+IBM POWER optimisations were developed at
+The Max-Planck-Institute for Meteorology.
+
+Decoding double array optimisations provided by
+Norwegian Meteorological Institute.
+
+OpenMP API Support provided by Eric Millin.
+
+Fortran source code for grib_typeSizes.f90 from Robert Pincus
+Cooperative Institue for Meteorological Satellite Studies
+University of Wisconsin
+

bufrust/definitions/bufr/tables/0/local/0/98/0/2/element.table

@@ -0,0 +1,3 @@
+#code|abbreviation|type|name|unit|scale|reference|width|crex_unit|crex_scale|crex_width
+002201|simulatedSatelliteInstrument|long|SIMULATED SATELLITE INSTRUMENT|FLAG TABLE|0|0|4|NA|0|0
+008193|timeQualifier|long|TIME QUALIFIER|CODE TABLE|0|0|0|NA|0|0

bufrust/definitions/bufr/tables/0/local/0/98/0/6/element.table

@@ -0,0 +1,2 @@
+#code|abbreviation|type|name|unit|scale|reference|width|crex_unit|crex_scale|crex_width
+002201|simulatedSatelliteInstrument|flag|SIMULATED SATELLITE INSTRUMENT|FLAG TABLE|0|0|4|NA|0|0