Merge branch 'main' into feat/models-only-mode

Author: amin-farjadi

.github/workflows/prepare_release.yml

@@ -3,7 +3,7 @@ name: Prepare release
 on:
   push:
     tags:
-      - '*'
+      - "*"
   workflow_call:
   workflow_dispatch:
 
@@ -22,7 +22,23 @@ jobs:
     needs:
       - build
     runs-on: ubuntu-latest
+    permissions:
+      contents: write
     steps:
+      - name: Checkout
+        uses: actions/checkout@v4
+        with:
+          fetch-depth: 0
+      - name: Generate release notes
+        id: release-notes
+        uses: orhun/git-cliff-action@v4
+        with:
+          config: cliff.toml
+          args: --latest --strip all
+        env:
+          OUTPUT: RELEASE_NOTES.md
+          GITHUB_REPO: ${{ github.repository }}
+          GITHUB_TOKEN: ${{ secrets.GITHUB_TOKEN }}
       - name: Download all the dists
         uses: actions/download-artifact@v4
         with:
@@ -35,6 +51,7 @@ jobs:
           files: |
             ./dist/*
           draft: true
+          body_path: RELEASE_NOTES.md
       - name: Summary
         run: |
           echo "# Release summary" >> $GITHUB_STEP_SUMMARY

.github/workflows/test.yml

@@ -38,10 +38,7 @@ jobs:
       uses: pypa/hatch@257e27e51a6a5616ed08a39a408a21c35c9931bc
 
     - name: Run static analysis
-      run: hatch fmt --check
-
-    - name: Run type checking
-      run: hatch run types:check
+      run: hatch run lint
 
     - name: Run tests
       run: hatch test -c -py ${{ matrix.python-version }}

CHANGELOG.md

@@ -1,159 +1,13 @@
 # CHANGELOG
 
-## 0.15.2 (2025-08-28)
+All notable unreleased changes to this project will be documented in this file.
 
-- Changed code typing to satisfy MyPy 1.11.0 version
-- Added support for `async_client=false` to work with `enable_custom_operations=true`
-- Fix propagating `convert_to_snake_case` to clients during package generation
-- Added ClientForwardRefsPlugin to standard plugins.
-- Re-added model_rebuild calls for input types with forward references.
-- Fixed fragments on interfaces being omitted from generated client.
-- Fixed @include directive result type when using convert_to_snake_case option.
-- Added Custom query builder feature.
+For released versions, see the [Releases](https://github.com/mirumee/ariadne-codegen/releases) page.
 
-## 0.14.0 (2024-07-17)
+## Unreleased
 
-- Added `ClientForwardRefsPlugin` to standard plugins.
-- Re-added `model_rebuild` calls for input types with forward references.
-- Fixed fragments on interfaces being omitted from generated client.
-- Fixed `@Include` directive result type when using `convert_to_snake_case` option.
-- Added Custom query builder feature.
+### ⚠️ Breaking Changes
 
+### 📚 Documentation
 
-## 0.13.0 (2024-03-4)
-
-- Fixed `str_to_snake_case` utility to capture fully capitalized words followed by an underscore.
-- Re-added `model_rebuild` calls for models with forward references.
-- Fixed potential name conflicts between field args and generated client's method code.
-
-
-## 0.12.0 (2024-02-05)
-
-- Fixed `graphql-transport-ws` protocol implementation not waiting for the `connection_ack` message on new connection.
-- Fixed `get_client_settings` mutating `config_dict` instance.
-- Added support to `graphqlschema` for saving schema as a GraphQL file.
-- Restored `model_rebuild` calls for top level fragment models.
-
-
-## 0.11.0 (2023-12-05)
-
-- Removed `model_rebuild` calls for generated input, fragment and result models. 
-- Added `NoReimportsPlugin` that makes the `__init__.py` of generated client package empty.
-- Added `include_all_inputs` config flag to generate only inputs used in supplied operations.
-- Added `include_all_enums` config flag to generate only enums used in supplied operations.
-- Added `operationName` to payload sent by generated client's methods.
-- Fixed base clients to pass `mypy --strict` without installed optional dependencies.
-- Renamed `GraphQlClientInvalidResponseError` to `GraphQLClientInvalidResponseError` (breaking change).
-- Changed base clients to raise `GraphQLClientGraphQLMultiError` for payloads with `errors` key but no `data` (breaking change).
-
-
-## 0.10.0 (2023-11-15)
-
-- Fixed generating results for nullable fields with nullable directives.
-- Changed `include_comments` option to accept enum value, changed default to `"stable"`, deprecated boolean support. Added `get_file_comment` plugin hook.
-- Changed `str_to_snake_case` utility to correctly handle capitalized words.
-- Digits in Python names are now preceded by an underscore (breaking change).
-- Fixed parsing of unions and interfaces to always add `__typename` to generated result models.
-- Added escaping of enum values which are Python keywords by appending `_` to them.
-- Fixed `enums_module_name` option not being passed to generators.
-- Added additional base clients supporting the Open Telemetry tracing. Added `opentelemetry_client` config option.
-- Changed generated client's methods to pass `**kwargs` to base client's `execute` and `execute_ws` methods (breaking change for custom base clients).
-- Added `operation_definition` argument to `generate_client_method` plugin hook.
-- Added `ExtractOperationsPlugin` that extracts operation strings from client methods to separate module.
-- Added Python 3.12 to tested versions.
-
-
-## 0.9.0 (2023-09-11)
-
-- Fixed generating operation string for nested inline fragments.
-- Removed scalars module. Changed generated models and client to use annotated types for custom scalars. Removed `scalars_module_name` option. Removed `generate_scalars_module`, `generate_scalars_cod`, `generate_scalar_annotation` and `generate_scalar_imports` plugin hooks.
-- Removed pydantic warnings for fields with `model_` prefix.
-- Fixed generating result types with nullable directives.
-
-
-## 0.8.0 (2023-08-22)
-
-- Added support for `Upload` scalar. Added support for file uploads to `AsyncBaseClient` and `BaseClient`.
-- Added validation of defined operations against the schema.
-- Removed `mixin` directive from fragment string included in operation string sent to server.
-- Added support for `mixin` directive on fragments definitions.
-- Added support for fragments defined on subtype of field's type.
-- Added default representation for a field name consisting only of underscores.
-- Changed generated client and models to use pydantic v2.
-- Changed custom scalars implementation to utilize pydantic's `BeforeValidator` and `PlainSerializer`. Added `scalars_module_name` option. Replaced `generate_scalars_parse_dict` and `generate_scalars_serialize_dict` with `generate_scalar_annotation` and `generate_scalar_imports` plugin hooks.
-- Unified annotations in generated client to be compatible with python < 3.9.
-- Fixed generating default values of input types from remote schemas.
-- Changed generating of input and result field names to add `_` to names reserved by pydantic.
-
-
-## 0.7.1 (2023-06-06)
-
-- Fixed `AsyncBaseClient` and `BaseClient` to send `Content-Type` header with requests.
-
-
-## 0.7.0 (2023-06-01)
-
-- Added support for subscriptions as async generators.
-- Changed how fragments are handled to generate separate module with fragments as mixins.
-- Fixed `ResultTypesGenerator` to trigger `generate_result_class` for each result model.
-- Changed processing of models fields to trim leading underscores.
-- Added `ShorterResultsPlugin` to standard plugins.
-- Fixed handling of inline fragments inside other fragments.
-- Changed generated unions to use pydantic's discriminated unions feature.
-- Replaced HTTPX's `json=` serializer for query payloads with pydantic's `pydantic_encoder`.
-- Removed `mixin` directive from operation string sent to server.
-- Fixed `ShorterResultsPlugin` that generated faulty code for discriminated unions.
-- Changed generator to ignore unused fragments which should be unpacked in queries.
-- Changed type hints for parse and serialize methods of scalars to `typing.Any`.
-- Added `process_schema` plugin hook.
-
-
-## 0.6.0 (2023-04-18)
-
-- Changed logic how custom scalar imports are generated. Deprecated `import_` key.
-- Added escaping of GraphQL names which are Python keywords by appending `_` to them.
-- Fixed parsing of list variables.
-- Changed base clients to remove unset arguments and input fields from variables payload.
-- Added `process_name` plugin hook.
-
-
-## 0.5.0 (2023-04-05)
-
-- Added generation of GraphQL schema's Python representation.
-- Fixed annotations for lists.
-- Fixed support of custom operation types names.
-- Unlocked versions of black, isort, autoflake and dev dependencies
-- Added `remote_schema_verify_ssl` option.
-- Changed how default values for inputs are generated to handle potential cycles.
-- Fixed `BaseModel` incorrectly calling `parse` and `serialize` methods on entire list instead of its items for `list[Scalar]`.
-
-
-## 0.4.0 (2023-03-20)
-
-- Fixed generating models from interfaces with inline fragments.
-- Added default `None` values for generated methods optional arguments.
-- Added basic plugin system.
-- Added `InitFileGenerator`, `EnumsGenerator`, `ClientGenerator` and `ArgumentsGenerator` plugin hooks.
-- Added `InputTypesGenerator` and `ResultTypesGenerator` plugin hooks.
-- Added `ScalarsDefinitionsGenerator` and `PackageGenerator` plugin hooks.
-- Added support for `[tool.ariadne-codegen]` section key. Deprecated `[ariadne-codegen]`.
-- Added support for environment variables to remote schema headers values.
-- Added `--config` argument to `ariadne-codegen` script, to support reading configuration from custom path.
-
-
-## 0.3.0 (2023-02-21)
-
-- Changed generated code to pass `mypy --strict`.
-- Changed base clients to get full url from user.
-- Added support for custom scalars.
-
-
-## 0.2.1 (2023-02-13)
-
-- Fixed incorrectly raised exception when using custom scalar as query argument type.
-
-
-## 0.2.0 (2023-02-02)
-
-- Added `remote_schema_url` and `remote_schema_headers` settings to support reading remote schemas.
-- Added `headers` argument to `__init__` methods of `BaseClient` and `AsyncBaseClient`.
+### 🛠️ Build System

CONTRIBUTING.md

@@ -6,40 +6,44 @@ We welcome bug reports, questions, pull requests, and general feedback.
 
 We also ask all contributors to familiarize themselves with and follow code of conduct, available in the [CODE_OF_CONDUCT.md](https://github.com/mirumee/ariadne/blob/master/CODE_OF_CONDUCT.md) file kept in the main project's repository.
 
-
-# Reporting bugs, asking for help, offering feedback and ideas
+## Reporting bugs, asking for help, offering feedback and ideas
 
 You can use [GitHub issues](https://github.com/mirumee/ariadne-codegen/issues) to report bugs, ask for help, share your ideas, or simply offer feedback. We are curious what you think of Ariadne!
 
-
 ## Development setup
 
-Ariadne Code Generator is written to support Python 3.9, 3.10, 3.11, 3.12 and 3.13.
+Ariadne Code Generator is written to support Python 3.10, 3.11, 3.12, 3.13 and 3.14.
 
 We use [Hatch](https://github.com/pypa/hatch) for project management.
 
-The codebase is formatted using [ruff](https://github.com/astral-sh/ruff).
-To format the code, use the following command:
+Formatting and linting (including typing-related rules) use [ruff](https://github.com/astral-sh/ruff). To format the code, run:
+
 ```bash
 hatch fmt
 ```
 
-The contents of the `ariadne-codegen` package are annotated with types and validated using [mypy](http://mypy-lang.org/index.html). To run type checking with mypy, use:
+The contents of the `ariadne-codegen` package are annotated with types and validated using [ty](https://github.com/astral-sh/ty). To run type checking, use:
+
 ```bash
 hatch run types:check
 ```
 
-
 Tests are developed using [pytest](https://pytest.org/) and are managed with Hatch.
 
-
 To run the tests, use:
+
 ```bash
 hatch test
 ```
 
+To run linting (formatting check + type checking):
+
+```bash
+hatch run lint
+```
+
+To run all checks (formatting, type checking, and tests):
 
-To run all checks (formatting, type checking, and tests), you can use:
 ```bash
 hatch run check
 ```
@@ -48,14 +52,12 @@ We require all changes to be done via pull requests, and to be approved by membe
 
 All changes should pass these linter checks.
 
-
 ## Working on issues
 
 We consider all issues which are not assigned to anybody as being available for contributors. The **[help wanted](https://github.com/mirumee/ariadne-codegen/labels/help%20wanted)** label is used to single out issues that we consider easier or higher priority on the list of things that we would like to see.
 
 If you've found issue you want to help with, please add your comment to it - this lets other contributors know what issues are being worked on, as well as allowing maintainers to offer guidance and help.
 
-
 ## Pull requests
 
 We don't require pull requests to be followed with bug reports. If you've found a typo or a silly little bug that has no issue or pull request already, you can open your own pull request. We only ask that this PR provides context or explanation for what problem it fixes, or which area of the project it improves.

PLUGINS.md

@@ -5,12 +5,12 @@
 Plugin is a class extending `ariadne_codegen.plugins.base.Plugin`.
 
 Plugins are instantiated once, at the beginning of `ariadne-codegen` command, with following arguments:
+
 - `schema: GraphQLSchema`: parsed graphql schema
 - `config_dict: dict`: parsed `pyproject.toml` file represented as a dictionary
 
 To handle specific events custom plugins need to override [hook methods](#hooks) from default `Plugin`. Default hook methods from `Plugin` don't implement any logic on their own.
 
-
 ## Enabling plugins
 
 Plugins can be enabled in `ariadne-codegen` by assigning list of strings to `plugins` key in config file.
@@ -20,7 +20,6 @@ Every element of the list can enable plugins in 2 ways:
 
 2. Providing only package name, eg. `my_package`. In this case all plugins from selected package will be used. For class to be accessible this way, it needs to be in package's public api. Plugin has to be importable from package, eg. `from my_package import MyPlugin` has to work.
 
-
 ## Hooks
 
 ### generate_init_module
@@ -99,6 +98,7 @@ def generate_client_method(
 
 Hook executed on generation of client's method, which represents single graphql operation. Depends on the configuration method can be either async or not.
 `
+
 ### generate_arguments
 
 ```py
@@ -185,8 +185,7 @@ def generate_result_class(
 ) -> ast.ClassDef:
 ```
 
-Hook executed on generation of single model, part of result of given query or mutation. 
-
+Hook executed on generation of single model, part of result of given query or mutation.
 
 ### generate_result_field
 
@@ -201,7 +200,6 @@ def generate_result_field(
 
 Hook executed on generation of single model field.
 
-
 ### generate_client_code
 
 ```py
@@ -228,7 +226,7 @@ Hook executed on generation of input models code. Result is used as content of `
 
 ### generate_result_types_code
 
-```py    
+```py
 def generate_result_types_code(self, generated_code: str) -> str:
 ```
 
@@ -242,12 +240,12 @@ def copy_code(self, copied_code: str) -> str:
 
 Hook executed on coping file's content to result package.
 Files hook is called for:
+
 - `base_client.py` or `async_base_client.py` or custom base client `base_client_file_path`
 - `base_model.py`
 - `exceptions.py`
 - all files from config's `files_to_include`
 
-
 ### generate_init_code
 
 ```py
@@ -276,16 +274,14 @@ def generate_fragments_module(
 
 Hook executed on generation of fragments module. Module has classes representing all fragments from provided queries. Later this module will be saved as `{fragments_module_name}.py`, `fragments_module_name` is taken from config.
 
-
 ### process_schema
 
 ```py
 def process_schema(self, schema: GraphQLSchema) -> GraphQLSchema:
 ```
 
 Hook executed on creating `GraphQLSchema` object from path or url provided in settings. During parsing `assume_valid` is set to `True`. Then this hook is called, and only after that `graphql.assert_valid_schema` is used to validate schema.
-To ensure all plugins have current version of schema, result of this hook is propagated to all plugins, updating their `schema` field. 
-
+To ensure all plugins have current version of schema, result of this hook is propagated to all plugins, updating their `schema` field.
 
 ### get_file_comment
 
@@ -297,7 +293,6 @@ def get_file_comment(
 
 Hook executed on generating comment included at the beginning of a generated code.
 
-
 ## Example
 
 This example plugin adds `__version__ = "..."` to generated `__init__.py` file.