pyureq 0.1.7__tar.gz

pyureq-0.1.7/.github/workflows/benchmarks.yml

@@ -0,0 +1,102 @@
+name: Benchmarks
+
+on:
+  push:
+    branches: ["**"]
+  workflow_dispatch:
+    inputs:
+      iterations:
+        description: "Iterations per scenario (bench.py and bench_gil.py)"
+        default: "200"
+        required: false
+      thread_requests:
+        description: "Requests per thread (bench_threads.py)"
+        default: "10"
+        required: false
+      stress_threads:
+        description: "Thread sweep for bench_stress.py (comma-separated)"
+        default: "50,100,200"
+        required: false
+
+jobs:
+  benchmark:
+    name: Benchmark (${{ matrix.os }})
+    runs-on: ${{ matrix.os }}
+    strategy:
+      fail-fast: false
+      matrix:
+        os: [ubuntu-latest, windows-latest]
+    defaults:
+      run:
+        shell: bash
+    # Force UTF-8 I/O on all platforms so Unicode box-drawing characters in
+    # benchmark output don't crash on Windows' default cp1252 console encoding.
+    env:
+      PYTHONUTF8: "1"
+
+    steps:
+      - uses: actions/checkout@v4
+
+      - name: Set up Python
+        uses: actions/setup-python@v5
+        with:
+          python-version: "3.12"
+
+      - name: Install Rust toolchain
+        uses: dtolnay/rust-toolchain@stable
+
+      - name: Cache Rust build artifacts
+        uses: Swatinem/rust-cache@v2
+
+      - name: Build pyureq wheel
+        uses: PyO3/maturin-action@v1
+        with:
+          command: build
+          args: --release --out dist
+
+      - name: Install pyureq
+        run: pip install dist/*.whl
+
+      - name: Install benchmark dependencies
+        run: pip install requests httpx curl_cffi flask
+
+      - name: Create results directory
+        run: mkdir -p results
+
+      - name: Run latency benchmark (bench.py)
+        run: |
+          python benchmarks/bench.py \
+            --iterations ${{ github.event.inputs.iterations || '50' }} \
+            --warmup 3 \
+            --json results/bench_latency.json \
+          | tee results/bench_latency.txt
+
+      - name: Run GIL benchmark (bench_gil.py)
+        run: |
+          python benchmarks/bench_gil.py \
+            --iterations ${{ github.event.inputs.iterations || '30' }} \
+          | tee results/bench_gil.txt
+
+      - name: Run concurrency benchmark (bench_threads.py)
+        run: |
+          python benchmarks/bench_threads.py \
+            --threads 100 \
+            --requests ${{ github.event.inputs.thread_requests || '3' }} \
+          | tee results/bench_threads.txt
+
+      - name: Run stress test (bench_stress.py)
+        run: |
+          python benchmarks/bench_stress.py \
+            --duration 5 \
+            --warmup 1 \
+            --threads ${{ github.event.inputs.stress_threads || '50,100,200' }} \
+            --json results/bench_stress.json \
+          | tee results/bench_stress.txt
+
+      - name: Upload benchmark results
+        if: always()
+        uses: actions/upload-artifact@v4
+        with:
+          name: benchmark-results-${{ matrix.os }}-${{ github.sha }}
+          path: results/
+          retention-days: 90

pyureq-0.1.7/.github/workflows/ci.yml

@@ -0,0 +1,185 @@
+name: CI
+
+on:
+  push:
+    branches: ["**"]
+    tags: ["v*"]
+  pull_request:
+    branches: ["**"]
+
+jobs:
+  lint:
+    name: Lint
+    runs-on: ubuntu-latest
+
+    steps:
+      - uses: actions/checkout@v4
+
+      - name: Set up Python
+        uses: actions/setup-python@v5
+        with:
+          python-version: "3.12"
+
+      - name: Install ruff
+        run: pip install ruff
+
+      - name: Lint Python (ruff)
+        run: ruff check python/
+
+      - name: Install Rust toolchain (with clippy + rustfmt)
+        shell: bash
+        run: |
+          for attempt in 1 2 3 4; do
+            rustup toolchain install stable --profile minimal --no-self-update \
+              --component clippy --component rustfmt \
+              && rustup default stable \
+              && break
+            echo "Attempt $attempt failed, retrying in $((attempt * 15))s..."
+            sleep $((attempt * 15))
+          done
+
+      - name: Cache Rust build artifacts
+        uses: Swatinem/rust-cache@v2
+
+      - name: Lint Rust (clippy)
+        run: cargo clippy -- -D warnings
+
+      - name: Check Rust formatting
+        run: cargo fmt --check
+
+  test:
+    name: Test (Python ${{ matrix.python-version }})
+    runs-on: ubuntu-latest
+    strategy:
+      matrix:
+        python-version: ["3.9", "3.10", "3.11", "3.12", "3.13", "3.14"]
+
+    steps:
+      - uses: actions/checkout@v4
+
+      - name: Set up Python ${{ matrix.python-version }}
+        uses: actions/setup-python@v5
+        with:
+          python-version: ${{ matrix.python-version }}
+
+      - name: Install Rust toolchain
+        shell: bash
+        run: |
+          for attempt in 1 2 3 4; do
+            rustup toolchain install stable --profile minimal --no-self-update \
+              && rustup default stable \
+              && break
+            echo "Attempt $attempt failed, retrying in $((attempt * 15))s..."
+            sleep $((attempt * 15))
+          done
+
+      - name: Cache Rust build artifacts
+        uses: Swatinem/rust-cache@v2
+
+      - name: Install maturin
+        run: pip install maturin
+
+      - name: Build and install wheel
+        run: |
+          maturin build --release
+          pip install target/wheels/*.whl
+
+      - name: Install test dependencies
+        run: pip install pytest pytest-cov flask
+
+      - name: Run tests with coverage
+        run: pytest tests/ -v --cov=pyureq --cov-report=xml --cov-report=term-missing
+
+      - name: Upload coverage report
+        uses: actions/upload-artifact@v4
+        with:
+          name: coverage-py${{ matrix.python-version }}
+          path: coverage.xml
+
+  build-wheels:
+    name: Build wheels (${{ matrix.os }})
+    runs-on: ${{ matrix.os }}
+    strategy:
+      matrix:
+        os: [ubuntu-latest, macos-latest, windows-latest]
+
+    steps:
+      - uses: actions/checkout@v4
+
+      - name: Install Rust toolchain
+        shell: bash
+        run: |
+          for attempt in 1 2 3 4; do
+            rustup toolchain install stable --profile minimal --no-self-update \
+              && rustup default stable \
+              && break
+            echo "Attempt $attempt failed, retrying in $((attempt * 15))s..."
+            sleep $((attempt * 15))
+          done
+
+      - name: Cache Rust build artifacts
+        uses: Swatinem/rust-cache@v2
+
+      - name: Build wheels
+        uses: PyO3/maturin-action@v1
+        with:
+          command: build
+          # abi3-py39 + generate-import-lib: one cp39-abi3 wheel per platform,
+          # no Python interpreter required (works on Windows without python3.9).
+          args: --release --out dist
+
+      - name: Upload wheels
+        uses: actions/upload-artifact@v4
+        with:
+          name: wheels-${{ matrix.os }}
+          path: dist/
+
+  release:
+    name: Publish to PyPI + GitHub Release
+    runs-on: ubuntu-latest
+    needs: [lint, test, build-wheels]
+    if: github.event_name == 'push' && startsWith(github.ref, 'refs/tags/v')
+    environment: pypi
+    permissions:
+      id-token: write
+      contents: write   # required for GitHub Release creation
+
+    steps:
+      - uses: actions/checkout@v4
+
+      - uses: actions/download-artifact@v4
+        with:
+          pattern: wheels-*
+          merge-multiple: true
+          path: dist/
+
+      - name: Publish to PyPI
+        uses: pypa/gh-action-pypi-publish@release/v1
+
+      - name: Create GitHub Release
+        uses: softprops/action-gh-release@v2
+        with:
+          files: dist/*
+          generate_release_notes: true
+          body: |
+            ## Installation
+
+            ```
+            pip install pyureq==${{ github.ref_name }}
+            ```
+
+            Full changelog: https://github.com/${{ github.repository }}/blob/main/CHANGELOG.md
+
+      - name: Update repository About description
+        env:
+          GH_TOKEN: ${{ github.token }}
+        run: |
+          gh api --method PATCH /repos/${{ github.repository }} \
+            -f description="A requests-compatible Python HTTP library powered by Rust's ureq" \
+            -f homepage="https://pypi.org/project/pyureq/" \
+            -f topics[]="python" \
+            -f topics[]="rust" \
+            -f topics[]="http" \
+            -f topics[]="requests" \
+            -f topics[]="pyo3" \
+            -f topics[]="ureq" || true

pyureq-0.1.7/.gitignore

@@ -0,0 +1,44 @@
+# Generated by Cargo
+# will have compiled files and executables
+debug
+target
+
+# These are backup files generated by rustfmt
+**/*.rs.bk
+
+# MSVC Windows builds of rustc generate these, which store debugging information
+*.pdb
+
+# Generated by cargo mutants
+# Contains mutation testing data
+**/mutants.out*/
+
+# Python
+__pycache__/
+*.py[cod]
+*.egg-info/
+dist/
+*.whl
+
+# RustRover
+#  JetBrains specific template is maintained in a separate JetBrains.gitignore that can
+#  be found at https://github.com/github/gitignore/blob/main/Global/JetBrains.gitignore
+#  and can be added to the global gitignore or merged into this file.  For a more nuclear
+#  option (not recommended) you can uncomment the following to ignore the entire idea folder.
+#.idea/
+
+# Secrets / credentials
+.env
+.env.*
+*.key
+*.pem
+*.p12
+*.pfx
+
+# Benchmark output
+results/
+
+# Coverage reports
+coverage.xml
+.coverage
+htmlcov/

pyureq-0.1.7/CHANGELOG.md

@@ -0,0 +1,204 @@
+# Changelog
+
+All notable changes to pyureq are documented here.
+Format follows [Keep a Changelog](https://keepachangelog.com/en/1.1.0/).
+
+---
+
+## [0.1.7] — 2026-08-06
+
+### Fixed
+- **Headers you set explicitly were sent twice.** When a request supplied a
+  header that pyureq also derives on its own, both copies went out on the
+  wire:
+
+  | you pass | pyureq also derives | result |
+  |---|---|---|
+  | `headers={"Content-Type": ...}` + `json=` / `data=` | `Content-Type` | sent 2× |
+  | `headers={"Cookie": ...}` + `cookies=` | `Cookie` | sent 2× |
+  | `headers={"Authorization": ...}` + `auth=` | `Authorization` | sent 2× |
+
+  This is a regression introduced in 0.1.6 by the ureq 2 → ureq 3 migration.
+  ureq 2's `Request::set` **replaced** an existing header; ureq 3 builds
+  through `http::request::Builder::header`, which calls `try_append` and
+  therefore **appends**. The three call sites were migrated verbatim, so each
+  derived header stacked on top of the caller's.
+
+  Most servers tolerate a repeated header, which is why this went unnoticed —
+  it only breaks against strict gateways. Crypto.com's exchange API answers a
+  duplicated `Content-Type` with `{"code": 50001, "message": "ERR_INTERNAL"}`,
+  a generic error that points nowhere near the real cause; the same request
+  through `requests` succeeded, making it look like a server-side or
+  authentication problem.
+
+  pyureq now follows `requests`' rule: a derived header is only applied when
+  the caller did not supply one, so an explicit header always wins. Matching
+  is case-insensitive (`content-type` and `Content-Type` are the same header
+  per RFC 9110). Deriving still works unchanged when you pass no header of
+  your own.
+
+### Testing
+- New `tests/test_duplicate_headers.py` (12 tests) asserts on the **raw
+  request bytes** read off a socket. The existing WSGI/Flask test server
+  collapses repeated headers into a single mapping entry, so it structurally
+  could not observe this bug. Verified by rebuilding with the fix reverted:
+  8 of the 12 fail, while the four "derived headers still work" cases keep
+  passing — the suite targets the defect rather than pinning current
+  behaviour. Full suite: 135 passing.
+
+---
+
+## [0.1.6] — 2026-08-01
+
+### Fixed
+- **Timeouts were reported as `ConnectionError` instead of `Timeout`.** The
+  transport error was classified by searching the OS error message for
+  `"timed out"`/`"deadline"`. Windows reports `WSAETIMEDOUT` (os error 10060)
+  with a message containing neither phrase, so every timeout on Windows raised
+  `ConnectionError`. Errors are now matched on ureq's typed `Error::Timeout`
+  variant, so classification is platform-independent.
+- **`Session` did not pool connections.** A new agent — and therefore a new
+  connection pool — was constructed for *every* request, so five sequential
+  `Session.get()` calls opened five TCP connections despite the documented
+  keep-alive behaviour. `Session` now holds one long-lived agent, so repeated
+  requests to the same host reuse a single connection.
+- **`deflate` responses came back still compressed.** The default
+  `Accept-Encoding` advertised `gzip, deflate`, but the Rust core only decodes
+  gzip and brotli. A server honouring `deflate` returned raw zlib bytes, and
+  `.text` / `.json()` failed with `UnicodeDecodeError`. `deflate` is no longer
+  advertised. (Same class of bug as the brotli fix in 0.1.3.)
+- **Per-request `verify=` was ignored on the `Session` path.** `verify` was
+  never forwarded to the Rust client, so `session.get(url, verify=False)`
+  still performed full certificate verification. It is now honoured, and a
+  per-request `verify` gets its own connection pool: ureq keys pooled
+  connections on `(scheme, authority, proxy)` without regard to TLS config, so
+  sharing one pool would have let a `verify=False` connection be reused to
+  serve a later `verify=True` request — silently skipping validation.
+
+### Changed
+- Upgraded **ureq 2.12 → 3.3** and **pyo3 0.23 → 0.29**.
+- Dropped the unused `serde_json` dependency and ureq's default features, which
+  were compiling a second TLS stack (rustls + ring + webpki) that the crate
+  never used. TLS is native-tls only, so the OS trust store stays authoritative
+  — preserving the 0.1.5 `UnknownIssuer` fix.
+- Response bodies are no longer capped at ureq 3's default 10 MB read limit.
+- The extension is now declared free-threading safe (`gil_used = false`); it
+  holds no Python state while performing I/O.
+- Building from source now requires Rust 1.85 or newer (a ureq 3 requirement).
+  Installing from a published wheel is unaffected.
+
+### Added
+- Regression tests covering all four fixes above, including a hermetic
+  self-signed HTTPS fixture for the `verify` cases — no network access needed.
+- Type stubs now match the real extension signatures; `RustClient.__init__` was
+  missing `timeout`/`no_proxy_all` and `RustClient.request` was missing `proxy`.
+
+[0.1.7]: https://github.com/vuongphu/pyureq/releases/tag/v0.1.7
+[0.1.6]: https://github.com/vuongphu/pyureq/releases/tag/v0.1.6
+
+---
+
+## [0.1.5] — 2026-04-05
+
+### Fixed
+- **TLS `UnknownIssuer` error on some HTTPS domains** — The `native-tls`
+  backend (via `schannel 0.1.28` on Windows) changed how it initialises the
+  TLS connector, causing certificate chain validation to fail for domains whose
+  intermediate CA had not previously been cached by Windows.  The fix is to
+  always construct an explicit `TlsConnector` (even when `verify=True`) so that
+  the OS trust store is properly loaded on every platform (Windows CryptoAPI,
+  macOS Security framework, Linux OpenSSL).
+
+### Added
+- `verify` now accepts a **path string** to a PEM CA-bundle file, matching
+  `requests` semantics:
+  - `verify=True` (default) — system / OS CA store
+  - `verify=False` — skip all certificate verification
+  - `verify="/path/to/ca-bundle.pem"` — use the supplied PEM file
+
+[0.1.5]: https://github.com/vuongphu/pyureq/releases/tag/v0.1.5
+
+---
+
+## [0.1.4] — 2026-02-28
+
+### Added
+- Proxy support via the `proxies` parameter, matching the `requests` API:
+  `proxies={"http": "http://host:port", "https": "http://user:pass@host:port"}`.
+  HTTP, HTTPS, SOCKS4, SOCKS4A, SOCKS5, and SOCKS5H proxy URLs are all
+  accepted.  `Session.proxies` dict is also supported for session-wide defaults.
+
+[0.1.4]: https://github.com/vuongphu/pyureq/releases/tag/v0.1.4
+
+---
+
+## [0.1.3] — 2026-02-28
+
+### Fixed
+- Remove `br` from the default `Accept-Encoding` session header.  pyureq was
+  advertising brotli support it could not fulfil, causing servers to return
+  brotli-compressed bodies that the Rust backend cannot decompress.  The raw
+  bytes then raised `UnicodeDecodeError` when callers accessed `.text` or
+  `.json()`.
+
+[0.1.3]: https://github.com/vuongphu/pyureq/releases/tag/v0.1.3
+
+---
+
+## [0.1.2] — 2026-02-28
+
+### Fixed
+- Bytes header values are now decoded with latin-1 (matching `requests`
+  behaviour) instead of `str()`, which produced `"b'...'"` and caused HMAC
+  signature verification failures (`40009 sign signature error`) on APIs such
+  as Bitget.
+
+### Removed
+- `SessionPool` / `pool.py` — removed from the public API.
+
+[0.1.2]: https://github.com/vuongphu/pyureq/releases/tag/v0.1.2
+
+---
+
+## [0.1.0] — 2026-02-28
+
+### Added
+
+- Initial release of **pyureq** — a `requests`-compatible Python HTTP library
+  backed by Rust's [ureq](https://github.com/algesten/ureq) crate.
+- Full `requests`-compatible surface:
+  - `pyureq.get / post / put / patch / delete / head / options / request`
+  - `Session` with connection pooling, shared headers, cookies, auth, and
+    timeout defaults
+  - `Response` with `.status_code`, `.text`, `.content`, `.json()`,
+    `.headers`, `.url`, `.ok`, `.elapsed`, `.raise_for_status()`, and more
+  - `CaseInsensitiveDict` for response headers
+  - Complete `requests.exceptions` hierarchy
+    (`Timeout`, `HTTPError`, `ConnectionError`, `TooManyRedirects`, …)
+- Rust core (`_pyureq` extension module) built with
+  [PyO3](https://github.com/PyO3/pyo3) + ureq 2.x:
+  - GIL released for the entire network call (connection → TLS → send →
+    recv → response parsing)
+  - `RustClient` for persistent connection pooling per `Session`
+  - One-shot stateless `http_request` for top-level convenience functions
+  - `native-tls` for TLS (system TLS on macOS/Windows, bundled OpenSSL
+    on Linux)
+  - `verify=False` support via `danger_accept_invalid_certs`
+  - Basic Auth, custom headers, cookies, query params, timeout, redirects,
+    and proxy disable (`proxies={"http": "", "https": ""}`)
+- Pre-built `abi3-py39` wheels for Linux, macOS, Windows (x86-64 and
+  ARM64 on macOS)
+- Distributed as `pyureq` on PyPI; import name is `pyureq`
+- GitHub Actions CI: lint (ruff + clippy), test matrix (Python 3.9–3.13),
+  cross-platform wheel build, coverage report, and automated PyPI publish
+  on `v*` tag push via OIDC Trusted Publishing
+
+### Performance (vs requests, on local server)
+
+| Metric | pyureq | requests |
+|--------|--------|----------|
+| Mean latency (single-thread) | 1.49 ms | 2.75 ms (+85%) |
+| Throughput (1 000 threads) | 268 req/s | 203 req/s (+32%) |
+| GIL hold per request | ~0.3 ms | ~1.2 ms |
+
+[0.1.0]: https://github.com/vuongphu/pyureq/releases/tag/v0.1.0