pytest-graphql 0.1.0a1__tar.gz

pytest_graphql-0.1.0a1/.gitignore

@@ -0,0 +1,221 @@
+# Byte-compiled / optimized / DLL files
+__pycache__/
+*.py[codz]
+*$py.class
+
+# C extensions
+*.so
+
+# Distribution / packaging
+.Python
+build/
+develop-eggs/
+dist/
+downloads/
+eggs/
+.eggs/
+lib/
+lib64/
+parts/
+sdist/
+var/
+wheels/
+share/python-wheels/
+*.egg-info/
+.installed.cfg
+*.egg
+MANIFEST
+
+# PyInstaller
+#   Usually these files are written by a python script from a template
+#   before PyInstaller builds the exe, so as to inject date/other infos into it.
+*.manifest
+*.spec
+
+# Installer logs
+pip-log.txt
+pip-delete-this-directory.txt
+
+# Unit test / coverage reports
+htmlcov/
+.tox/
+.nox/
+.coverage
+.coverage.*
+.cache
+nosetests.xml
+coverage.xml
+*.cover
+*.py.cover
+.hypothesis/
+.pytest_cache/
+cover/
+
+# Translations
+*.mo
+*.pot
+
+# Django stuff:
+*.log
+local_settings.py
+db.sqlite3
+db.sqlite3-journal
+
+# Flask stuff:
+instance/
+.webassets-cache
+
+# Scrapy stuff:
+.scrapy
+
+# Sphinx documentation
+docs/_build/
+
+# PyBuilder
+.pybuilder/
+target/
+
+# Jupyter Notebook
+.ipynb_checkpoints
+
+# IPython
+profile_default/
+ipython_config.py
+
+# pyenv
+#   For a library or package, you might want to ignore these files since the code is
+#   intended to run in multiple environments; otherwise, check them in:
+# .python-version
+
+# pipenv
+#   According to pypa/pipenv#598, it is recommended to include Pipfile.lock in version control.
+#   However, in case of collaboration, if having platform-specific dependencies or dependencies
+#   having no cross-platform support, pipenv may install dependencies that don't work, or not
+#   install all needed dependencies.
+# Pipfile.lock
+
+# UV
+#   Similar to Pipfile.lock, it is generally recommended to include uv.lock in version control.
+#   This is especially recommended for binary packages to ensure reproducibility, and is more
+#   commonly ignored for libraries.
+# uv.lock
+
+# poetry
+#   Similar to Pipfile.lock, it is generally recommended to include poetry.lock in version control.
+#   This is especially recommended for binary packages to ensure reproducibility, and is more
+#   commonly ignored for libraries.
+#   https://python-poetry.org/docs/basic-usage/#commit-your-poetrylock-file-to-version-control
+# poetry.lock
+# poetry.toml
+
+# pdm
+#   Similar to Pipfile.lock, it is generally recommended to include pdm.lock in version control.
+#   pdm recommends including project-wide configuration in pdm.toml, but excluding .pdm-python.
+#   https://pdm-project.org/en/latest/usage/project/#working-with-version-control
+# pdm.lock
+# pdm.toml
+.pdm-python
+.pdm-build/
+
+# pixi
+#   Similar to Pipfile.lock, it is generally recommended to include pixi.lock in version control.
+# pixi.lock
+#   Pixi creates a virtual environment in the .pixi directory, just like venv module creates one
+#   in the .venv directory. It is recommended not to include this directory in version control.
+.pixi
+
+# PEP 582; used by e.g. github.com/David-OConnor/pyflow and github.com/pdm-project/pdm
+__pypackages__/
+
+# Celery stuff
+celerybeat-schedule
+celerybeat.pid
+
+# Redis
+*.rdb
+*.aof
+*.pid
+
+# RabbitMQ
+mnesia/
+rabbitmq/
+rabbitmq-data/
+
+# ActiveMQ
+activemq-data/
+
+# SageMath parsed files
+*.sage.py
+
+# Environments
+.env
+.envrc
+.venv
+env/
+venv/
+ENV/
+env.bak/
+venv.bak/
+
+# Spyder project settings
+.spyderproject
+.spyproject
+
+# Rope project settings
+.ropeproject
+
+# mkdocs documentation
+/site
+
+# mypy
+.mypy_cache/
+.dmypy.json
+dmypy.json
+
+# Pyre type checker
+.pyre/
+
+# pytype static type analyzer
+.pytype/
+
+# Cython debug symbols
+cython_debug/
+
+# PyCharm
+#   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/
+
+# Abstra
+#   Abstra is an AI-powered process automation framework.
+#   Ignore directories containing user credentials, local state, and settings.
+#   Learn more at https://abstra.io/docs
+.abstra/
+
+# Visual Studio Code
+#   Visual Studio Code specific template is maintained in a separate VisualStudioCode.gitignore 
+#   that can be found at https://github.com/github/gitignore/blob/main/Global/VisualStudioCode.gitignore
+#   and can be added to the global gitignore or merged into this file. However, if you prefer, 
+#   you could uncomment the following to ignore the entire vscode folder
+# .vscode/
+# Temporary file for partial code execution
+tempCodeRunnerFile.py
+
+# Ruff stuff:
+.ruff_cache/
+
+# PyPI configuration file
+.pypirc
+
+# Marimo
+marimo/_static/
+marimo/_lsp/
+__marimo__/
+
+# Streamlit
+.streamlit/secrets.toml
+
+# Local agent coordination state (review handoff logs), repository root only
+/tmp/

pytest_graphql-0.1.0a1/CHANGELOG.md

@@ -0,0 +1,80 @@
+# Changelog
+
+All notable changes to this project are documented in this file.
+
+The format follows [Keep a Changelog](https://keepachangelog.com/en/1.1.0/),
+and this project follows [Semantic Versioning](https://semver.org/spec/v2.0.0.html)
+from `1.0.0` onward. While the version is `0.x`, the API may change between minor
+versions. Every change is recorded here with a migration note, and no deprecation
+cycle is promised.
+
+## [Unreleased]
+
+## [0.1.0a1] - 2026-10-03
+
+First alpha. It contains a working client, transport, response model and one
+pytest fixture.
+
+It requires `graphql-core` 3.2. graphql-core 3.3 is not supported yet, and the
+dependency is declared as `>=3.2,<3.3` so that an install never selects it.
+
+### Added
+
+- `GraphQLClient`, `ClientConfig` and `build_client()`. `query()` and
+  `mutation()` call an operation by name and build its selection set from the
+  schema. `execute()` sends a raw document and returns the response. Names are
+  snake_case in Python and the schema's own spelling on the wire.
+- Automatic selection with depth, field count and cycle limits, set through
+  `SelectionPolicy` and `CyclePolicy`. Explicit selections use `Selection`,
+  `Field` and `AUTO`. A field left out of an automatic selection is recorded,
+  not dropped silently.
+- Local validation of each operation against the schema before it is sent, on
+  by default. `validate=False` turns it off. Variables are always checked
+  against their declared types.
+- Schema loading through `IntrospectionSource` or `SDLFileSource`.
+- `HttpxTransport`, behind the `Transport` protocol. Requests are always a JSON
+  `POST`. Timeouts, connect retries and the response size are bounded. Redirects
+  are not followed, and proxy and other environment settings are ignored unless
+  `trust_env=True`.
+- Connection isolation with the default `HttpxTransport`. The test clients of
+  one pytest session share one connection pool, and a clone shares the pool of
+  the client it came from. Each `build_client()` call without `transport=`
+  creates its own pool. Every such client has its own cookie jar. Under the
+  default `cookie_scope="none"`, no cookie survives a call. A transport you
+  supply, through `build_client(transport=...)` or an overridden
+  `gql_transport` fixture, keeps its own connection and cookie behavior.
+- `GraphQLResponse`, `Node` and `NodeList`. Data is converted using the schema,
+  and errors and partial data raise unless that is turned off.
+- Diagnostics. `DiagnosticSnapshot` and `as_curl()` describe a call with
+  headers, variables and known credential values redacted. Recorded calls are
+  bounded, and truncation is always stated.
+- `Auth`, `BearerAuth` and `HeaderAuth`, and the `Middleware` protocol with
+  `BaseMiddleware`. `with_headers()`, `with_auth()`, `as_()` and `anonymous()`
+  return a client with another identity.
+- Ownership rules for closing resources. Closing a client closes what it owns,
+  exactly once. A failure while building a client closes everything built so
+  far.
+- The pytest fixtures `gql_url`, `gql_transport` and `gql`, and the
+  `--gql-url` flag. The schema loads once per session. Each test gets its own
+  client, which is closed after the test, whether it passed or failed.
+- Packaging skeleton: `pyproject.toml` with a hatchling backend, PEP 621
+  metadata and a `src/` layout, the `pytest_graphql` package with `__version__`
+  and `py.typed`, and the `pytest11` entry point.
+- Tooling configuration: ruff lint and format, `mypy --strict` on `src/`, and
+  pytest defaults.
+- `scripts/check_core_purity.py`, which fails when any module outside the
+  pytest plugin package imports pytest.
+- The `test` workflow, running the representative CI matrix on Linux, the test
+  suite on macOS and Windows at the newest supported Python, the core purity
+  check and the no-pytest install job.
+- The `release` workflow, which builds one artifact set, records a digest for
+  every file, runs the artifact checks, and verifies the release back from
+  TestPyPI before any upload to PyPI. It publishes nothing until the first
+  release gate.
+- `CONTRIBUTING.md` with the development setup and the release checklist.
+- `requirements/build.in` and a pinned `requirements/build.txt` covering the
+  build backend and its dependencies, used both as build constraints for the
+  release build and as the environment for the sdist install-back.
+
+[Unreleased]: https://github.com/skhomenko/pytest-graphql/compare/v0.1.0a1...HEAD
+[0.1.0a1]: https://github.com/skhomenko/pytest-graphql/releases/tag/v0.1.0a1

pytest_graphql-0.1.0a1/CONTRIBUTING.md

@@ -0,0 +1,184 @@
+# Contributing
+
+## Development setup
+
+```bash
+git clone git@github.com:skhomenko/pytest-graphql.git
+cd pytest-graphql
+uv sync --all-extras
+git config core.hooksPath .githooks
+```
+
+The hooks are tracked in `.githooks/` and do nothing until that last command
+runs. A linked worktree needs the same setting of its own.
+
+## Checks
+
+Run all of these before you open a pull request. CI runs the same set.
+
+```bash
+uv run ruff check .
+uv run ruff format --check .
+uv run mypy --strict src/
+uv run pytest -q
+python3 scripts/check_core_purity.py
+```
+
+`scripts/` holds contributor tooling that runs on the standard library alone, so
+those scripts work before the project environment exists. Each one has a
+`--self-test` mode, and the test suite runs it.
+
+Text intended for publication is scanned separately:
+
+```bash
+python3 scripts/check_publication_hygiene.py README.md CHANGELOG.md
+```
+
+## Layout rules
+
+- Library code lives in `src/pytest_graphql/`.
+- The pytest layer is confined to `src/pytest_graphql/plugin/`. No module
+  outside that package may import pytest. `scripts/check_core_purity.py`
+  enforces this, and CI fails when it reports a finding.
+- Tests live in `tests/`. A unit test never opens a non-loopback socket.
+
+## Branches and commits
+
+Branch names use a type prefix and a short hyphenated description: `feat/`,
+`fix/`, `docs/`, `chore/`, `refactor/`, `test/` or `security/`.
+
+Commit subjects use conventional-commits prefixes and stay at or under 72
+characters. Body lines wrap at 72. The commit-message hook enforces both, and
+`docs/reference/COMMIT_MESSAGE_RULES.md` states exactly how a line is measured.
+Never bypass a hook.
+
+## Supported versions
+
+The supported set is Python 3.10 through 3.14 with pytest 7.4 or newer. That
+range is the compatibility promise and it is what the dependency metadata
+declares.
+
+CI does not run the whole cross product. It runs one job per row of the
+representative matrix in the compatibility section of
+`docs/reference/DESIGN_DECISIONS.md`. Those rows are a sample of the supported
+range, never a narrower supported set. Adding or removing a row is one change
+that edits that table and `.github/workflows/test.yml` together.
+
+Linux, macOS and Windows are supported. The matrix rows run on Linux. Two more
+jobs run the test suite on macOS and on Windows at the newest supported Python.
+The same section states that rule.
+
+`requires-python` declares both ends of the range, `>=3.10,<3.15`. Raising the
+ceiling means editing that section, `pyproject.toml` and the matrix together,
+then running `uv lock`.
+
+## Pinned build tooling
+
+Two programs run during a release build, and both are pinned so the reviewed
+tree selects them.
+
+- The uv version lives in the `UV_VERSION` variable at the top of each workflow.
+  Dependabot moves action SHAs but not this value, so bump it by commit.
+- `requirements/build.txt` pins the build backend and its own dependencies.
+  `requirements/build.in` holds the direct requirement. Regenerate the pinned
+  file with:
+
+```
+uv pip compile --universal --python-version 3.10 requirements/build.in \
+    -o requirements/build.txt
+```
+
+The release build passes that file to `uv build --build-constraints`, and the
+sdist install-back job installs it before building with isolation disabled.
+
+## Release checklist
+
+Publication happens at three gates. The release machinery exists from the first
+milestone and publishes nothing before the alpha gate.
+
+| Gate | Version | Requires |
+|---|---|---|
+| Alpha | `0.1.0a1` | Working client, transport, response model and one fixture |
+| Beta | `0.1.0b1` | Complete pytest plugin |
+| Stable | `0.1.0` | Complete documentation and release acceptance |
+
+Every gate runs the same steps. Steps 1 to 6 are the contributor's. Steps 7 and
+8 are the maintainer's, and no agent performs them.
+
+1. Confirm the branch is green.
+
+   ```bash
+   uv run ruff check . && uv run ruff format --check . \
+     && uv run mypy --strict src/ && uv run pytest -q
+   ```
+
+2. Set the version in one place and check it.
+
+   ```bash
+   $EDITOR src/pytest_graphql/__init__.py
+   uv run python -c "import pytest_graphql; print(pytest_graphql.__version__)"
+   ```
+
+3. Move the `Unreleased` entries into a dated section for that version in
+   `CHANGELOG.md`, and scan the text that will be published.
+
+   ```bash
+   python3 scripts/check_publication_hygiene.py README.md CHANGELOG.md
+   ```
+
+4. Merge the release branch, then tag the merge commit. The tag is `v` followed
+   by the exact version. The release workflow refuses a tag that disagrees with
+   `__version__`.
+
+   ```bash
+   git tag "v$(uv run python -c 'import pytest_graphql; print(pytest_graphql.__version__)')"
+   git push origin --tags
+   ```
+
+5. Watch the `release` workflow. It builds one artifact set, records a digest
+   for every file, and runs the artifact checks: `twine check`, PEP 621
+   metadata completeness, long-description rendering, wheel and sdist contents,
+   and `__version__` agreeing with the tag.
+
+6. Before the first gate the workflow stops there, leaving the artifact set
+   built, checked and retained. The upload jobs are gated on the repository
+   variable `RELEASE_PUBLISH`, which is unset until the maintainer opens the
+   alpha gate. From that point the run continues into the upload jobs, which
+   wait for review in the protected `pypi` environment.
+
+7. Approve the TestPyPI upload. The workflow then enumerates that release
+   through the TestPyPI index, compares the complete remote file set with the
+   build manifest in both directions, fetches each file by its index URL,
+   rechecks every digest, and installs and tests the wheel and the sdist in
+   separate clean environments.
+
+8. Approve the PyPI upload. It uploads the same files that TestPyPI verified.
+   Nothing is rebuilt between the two indexes, because a rebuild is a different
+   artifact.
+
+Two properties of the indexes shape this checklist. A version can be uploaded
+once per index and cannot be replaced, only yanked, so a failed check burns that
+version number and the next attempt increments it. Before `0.1.0` exists, no
+stable version satisfies `pytest-graphql`, so an ordinary unpinned install can
+select `0.1.0a1`. Publishing the alpha to PyPI therefore exposes it to ordinary
+installs, and the maintainer accepts that exposure at the gate. The alternative
+is to keep the alpha on TestPyPI until a stable version exists.
+
+Trusted publishing is configured as a pending publisher on PyPI and on TestPyPI,
+so no upload token is stored. The token exchange is first exercised at the alpha
+gate, because a pending publisher cannot be tested without a real upload.
+
+### Repository configuration
+
+These settings live in GitHub and on the two indexes, not in the repository, so
+the maintainer applies them once. The release workflow assumes all of them.
+
+| Where | Setting |
+|---|---|
+| PyPI | A pending publisher for `pytest-graphql`, owner `skhomenko`, repository `pytest-graphql`, workflow `release.yml`, environment `pypi` |
+| TestPyPI | The same pending publisher, with the same values |
+| GitHub environment `pypi` | Protected, with a required reviewer. Both upload jobs run in it |
+| GitHub variable `RELEASE_PUBLISH` | Unset until the alpha gate. Set it to `true` to let the upload jobs run |
+
+No upload token is stored anywhere. The install-back job runs outside the
+environment and holds no publishing credential of any kind.

pytest_graphql-0.1.0a1/LICENSE

@@ -0,0 +1,21 @@
+MIT License
+
+Copyright (c) 2026 Sergii Khomenko
+
+Permission is hereby granted, free of charge, to any person obtaining a copy
+of this software and associated documentation files (the "Software"), to deal
+in the Software without restriction, including without limitation the rights
+to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
+copies of the Software, and to permit persons to whom the Software is
+furnished to do so, subject to the following conditions:
+
+The above copyright notice and this permission notice shall be included in all
+copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
+AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
+OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
+SOFTWARE.

pytest_graphql-0.1.0a1/PKG-INFO

@@ -0,0 +1,120 @@
+Metadata-Version: 2.5
+Name: pytest-graphql
+Version: 0.1.0a1
+Summary: Schema-aware GraphQL API testing for pytest: a GraphQL client, an httpx transport and a pytest fixture.
+Project-URL: Documentation, https://skhomenko.github.io/pytest-graphql/
+Project-URL: Source, https://github.com/skhomenko/pytest-graphql
+Project-URL: Changelog, https://github.com/skhomenko/pytest-graphql/blob/main/CHANGELOG.md
+Project-URL: Issues, https://github.com/skhomenko/pytest-graphql/issues
+Author: Sergii Khomenko
+License-Expression: MIT
+License-File: LICENSE
+Keywords: api,graphql,integration,pytest,testing
+Classifier: Development Status :: 3 - Alpha
+Classifier: Framework :: Pytest
+Classifier: Intended Audience :: Developers
+Classifier: Operating System :: OS Independent
+Classifier: Programming Language :: Python :: 3
+Classifier: Programming Language :: Python :: 3.10
+Classifier: Programming Language :: Python :: 3.11
+Classifier: Programming Language :: Python :: 3.12
+Classifier: Programming Language :: Python :: 3.13
+Classifier: Programming Language :: Python :: 3.14
+Classifier: Topic :: Software Development :: Testing
+Classifier: Typing :: Typed
+Requires-Python: <3.15,>=3.10
+Requires-Dist: certifi
+Requires-Dist: graphql-core<3.3,>=3.2
+Requires-Dist: httpx<1,>=0.27
+Provides-Extra: dev
+Requires-Dist: coverage[toml]>=7.4; extra == 'dev'
+Requires-Dist: hypothesis>=6.100; extra == 'dev'
+Requires-Dist: mypy>=1.11; extra == 'dev'
+Requires-Dist: pytest>=7.4; extra == 'dev'
+Requires-Dist: ruff>=0.6; extra == 'dev'
+Provides-Extra: pytest
+Requires-Dist: pytest>=7.4; extra == 'pytest'
+Description-Content-Type: text/markdown
+
+# pytest-graphql
+
+Schema-aware GraphQL API testing for pytest.
+
+## Status
+
+Alpha. This release contains a working client, an `httpx` transport, a response
+model and one pytest fixture. The API may still change before `0.1.0`.
+
+What `0.1.0a1` contains:
+
+- `GraphQLClient` and `build_client()`. The client reads your schema and builds
+  the selection set for an operation. By default it checks the operation
+  against the schema before it sends anything, and `validate=False` turns that
+  check off. Arguments and fields are snake_case in Python and use the schema's
+  own names on the wire.
+- An `httpx` transport with explicit timeout, retry and response size limits.
+  With this transport, tests share one connection pool and each client keeps
+  its own cookie jar. A transport you supply manages its own connections and
+  cookies.
+- A response model. Failures carry a redacted summary of the request.
+  `RequestInfo.as_curl()`, available to middleware, renders a `curl` command
+  that reproduces a request, with credentials replaced by placeholders.
+- Bearer and header auth, and request middleware.
+- The pytest fixtures `gql`, `gql_url` and `gql_transport`, and the
+  `--gql-url` flag. The schema loads once per session, and each test gets its
+  own client.
+
+Not in this release yet: ini options, environment variables and hooks, response
+matching, fake data, error assertions and polling.
+
+The changelog records what each release contains:
+https://github.com/skhomenko/pytest-graphql/blob/main/CHANGELOG.md
+
+## Usage
+
+With pytest, pass the endpoint on the command line:
+
+```
+pytest --gql-url=http://localhost:8000/graphql
+```
+
+```python
+def test_user_has_a_name(gql):
+    user = gql.query("user", id="123")
+    assert user.name
+```
+
+For a URL known only at run time, override the `gql_url` fixture in your
+`conftest.py`. The `--gql-url` flag still wins when both are given.
+
+Without pytest, use `build_client()`, and close the client when you are done:
+
+```python
+from pytest_graphql import build_client
+
+with build_client(url="http://localhost:8000/graphql") as gql:
+    user = gql.query("user", id="123")
+```
+
+## Install
+
+```
+pip install pytest-graphql
+```
+
+The required dependencies are `graphql-core`, `httpx`, and `certifi`. `pytest`
+is optional, so the client can be used outside a test suite:
+
+```
+pip install "pytest-graphql[pytest]"
+```
+
+## Supported versions
+
+Python 3.10 through 3.14, with pytest 7.4 or newer when the pytest extra is
+installed. CI tests a representative sample of that range rather than the whole
+cross product.
+
+## License
+
+MIT. See https://github.com/skhomenko/pytest-graphql/blob/main/LICENSE