Skip to content

CHANGELOG.md

Latest commit

 

History

History
118 lines (100 loc) · 5.82 KB

CHANGELOG.md

File metadata and controls

118 lines (100 loc) · 5.82 KB
Raw

Changelog

All notable changes to this project are documented in this file.

The format is based on Keep a Changelog and this project adheres to Semantic Versioning.

Unreleased

Changed

  • SOAP DataInventory calls now go through a dedicated retrying requests.Session (_SOAP_SESSION) that retries POST as well as GET on transient failures (429/5xx). Gives the data-inventory path the same resiliency the REST path already had.

0.5.0

Major modernization release. Every layer of the project was touched — build system, CI/CD, internal structure, testing, and docs. Behavior for existing users is almost entirely unchanged; two small backward-compatible behavioral changes are called out under Changed below.

Added

  • Module-level HTTP session with automatic retries on transient failures (429, 500, 502, 503, 504) via a urllib3.util.retry.Retry adapter (noaa_coops/_http.py). All calls — including get_stations_from_bbox — share the session's connection pool and retry policy.
  • Warn-and-continue behavior on multi-block fetches: when one block in a multi-month fetch fails, a RuntimeWarning is emitted and df.attrs["missing_blocks"] is populated with {begin, end, error} entries instead of silently dropping the block.
  • Declarative product registry (noaa_coops/_products.py) replacing the historical 186-line _check_product_params if/elif tree + 150-line _build_request_url if/elif tree. Adding a new NOAA product is now a one-place change.
  • Public export: COOPSAPIError is now importable as from noaa_coops import COOPSAPIError (the old from noaa_coops.station import COOPSAPIError path still works).
  • Offline test suite using pytest-recording VCR cassettes. Default pytest runs in ~1.5s with zero network calls.
  • Nightly live canary (.github/workflows/nightly.yml) runs pytest -m live daily at 06:00 UTC. On failure, opens a tracking issue so NOAA drift is visible without flooding the inbox.
  • Manual publish workflows mirroring the PyPA pattern: .github/workflows/test-publish.yml publishes to TestPyPI, .github/workflows/publish.yml publishes to PyPI + creates the v{VERSION} tag + cuts a GitHub Release with an auto-generated changelog from git log. Both workflow_dispatch.
  • Dependabot configured for github-actions and the uv ecosystems.
  • pre-commit hooks (.pre-commit-config.yaml) — ruff check + format + standard hygiene hooks. Free auto-fix PRs via pre-commit.ci.

Changed

  • Build backend swapped to hatchling. Version is read from noaa_coops/__init__.py by hatchling.build. No more poetry-core.
  • CI swapped to uv + hatchling. Jobs: lint (ruff), typecheck (mypy), and test (pytest matrix across Python 3.10 – 3.13 on ubuntu-latest).
  • Added HTTP timeouts everywhere. Every requests.get / _SESSION.get passes timeout=(5.0, 30.0) (connect, read). No more hangs on stalled NOAA endpoints.
  • Narrower exception handling. Bare except: in Station.__init__ replaced with (requests.RequestException, zeep.exceptions.Error, AttributeError, TypeError) + a logging.warning. KeyboardInterrupt and SystemExit now propagate correctly.
  • Internal module split. station.py shrunk from 825 lines to ~350. New internal modules: _exceptions.py, _endpoints.py, _http.py, _parsing.py, _products.py, _metadata.py, plus the public api.py. All previous import paths continue to work.
  • pyproject.toml converted to PEP 621 [project] table with classifiers, keywords, and [project.urls] so the PyPI page renders useful metadata.
  • station.data_inventory is always set. An empty dict {} now indicates the SOAP fetch failed, rather than the attribute being unset. Callers using hasattr(station, 'data_inventory') should switch to if not station.data_inventory:.

Fixed

  • O(n²) memory in multi-block fetches. The multi-block loop used to rebuild the full DataFrame on every iteration via df = pd.concat([df, df_block]). Now appends to a list and concatenates once at the end.
  • Silent KeyError crash in get_data_inventory. If the SOAP response lacked a "parameter" key, the error escaped the narrow catch in Station.__init__ and crashed construction. Now handled locally via try/except (KeyError, TypeError).
  • _parse_known_date_formats UnboundLocalError trap. The old match = False flag pattern (set only in the except branch) could raise UnboundLocalError in edge cases. Rewritten as a clean for/try/continue loop that raises ValueError after exhausting all known formats.
  • stale --cov=reflekt config. pytest coverage was pointing at the wrong project. Fixed to --cov=noaa_coops.

Removed

  • Python 3.9 support. 3.9 went EOL in October 2025 and the modern testing stack (vcrpy 8.x, urllib3 2.x, types-requests 2.32.4+) requires ≥3.10. Supported versions: 3.10, 3.11, 3.12, 3.13.
  • Dead files. .bumpversion.cfg (stuck at 0.1.9 targeting nonexistent setup.py), .flake8 (superseded by ruff), mypy.ini (migrated into pyproject.toml), pytest.ini (same), old poetry.lock, and a 96-line if __name__ == "__main__": debug block in station.py.
  • Third-party publish action. Replaced JRubics/poetry-publish with the PyPA-official pypa/gh-action-pypi-publish.

0.4.0 - 2023-xx-xx

Earlier releases are documented in the GitHub release history.