Skip to content

4.0.0b1

Pre-release
Pre-release

Choose a tag to compare

@TKIPisalegacycipher TKIPisalegacycipher released this 06 May 03:43
904f954

Hello, httpx!

This release is the first pre-release version of the library that has been refactored to use httpx instead of requests and aiohttp.

Summary

This migration offers us a number of meaningful benefits:

  1. One library, one codebase - eliminates ~80% duplicated logic between sync (rest_session.py, 670 lines) and async (aio/rest_session.py, 547 lines)
  2. Fixes real bugs - bare except Exception in async, inconsistent error handling, blocking time.sleep() in the async event loop
  3. Drops two pinned deps (requests<3, aiohttp<4) for one (httpx)
  4. Identical sync/async API - httpx.Client and httpx.AsyncClient share the same surface, so shared base class becomes trivial
  5. Type-annotated from the start - natural opportunity to add typing to core modules
  6. Simpler async - response body is buffered after await, so .json() is sync even on the async client; eliminates all async with await patterns

Decision logic (retry, backoff, error classification) lives in a single base class, and sync/async layers are thin I/O shells differing only in sleep vs await asyncio.sleep.

Breaking changes

For normal SDK users, these changes are invisible. Most scripts will "just work" without updates. The SDK's public API (DashboardAPI, AsyncDashboardAPI, all endpoint methods) is unchanged.

The actual breaks live in import paths, exception internals, and the HTTP dependency swap.

Dependencies

  • requests + aiohttp replaced by httpx>=0.28,<1: Anyone pinning or importing these transitively loses them.
  • responses (test library) replaced by respx: Only affects contributors running the test suite.

Module structure

  • meraki/rest_session.py deleted: from meraki.rest_session import RestSession breaks
  • meraki/aio/rest_session.py deleted: from meraki.aio.rest_session import AsyncRestSession breaks
  • New location: meraki/session/sync.py, meraki/session/async_.py: If you need to, use from meraki.session import RestSession, AsyncRestSession (most users will not need this)
  • New shared base: meraki/session/base.py: Internal; not part of the SDK's public API
  • New encoding module: meraki/encoding.py: Internal; replaces the old monkey-patch

Exceptions

  • AsyncAPIError is now a deprecated subclass of APIError: except AsyncAPIError still catches, but emits DeprecationWarning. Use except APIError for both sync and async going forward.
  • .reason attribute preserved on exception objects: Still works; internally, now reads from response.reason_phrase.

Internals (private SDK API)

  • _req_session attribute removed; there is no compatibility shim.
  • Monkey-patch of requests.models.RequestEncodingMixin._encode_params removed; anyone relying on this SDK side-effecting the requests module loses it.
  • response.status (from aiohttp) is now response.status_code (httpx); only visible if you accessed raw response objects from session internals.

More info, why, etc.

For more information, please consult HTTPX-MIGRATION.md.

Full Changelog: 3.0.2...4.0.0b1