feat: add schema_paths for loading schema from local paths and installed packages AR-3 by Minister944 · Pull Request #439 · mirumee/ariadne-codegen

Minister944 · 2026-06-28T06:14:52Z

Introduce a new schema_paths setting that builds the GraphQL schema from
multiple sources. Each entry is resolved either as a dotted Python attribute
path (e.g. pkg.SCHEMA_DIR or pkg.get_schema_files) - useful for pulling
type definitions from installed packages - or as a local file/directory path.

schema.py: add resolve_schema_paths and get_graphql_schema_from_paths
main.py: wire schema_paths into both client and graphqlschema strategies
settings.py: add the schema_paths field and make the three schema sources
(schema_path, schema_paths, remote_schema_url) mutually exclusive -
providing more than one now raises InvalidConfiguration; simplify
using_remote_schema accordingly
docs/README: document schema_paths and the mutual-exclusivity rule

CI/CD does not pass. This is an unrelated error that is being fixed as part of AR-6

Acknowledgements

While working on this, we noticed #431 by @esfomeado, which also tackled
loading the schema from more than one source. After discussing it as a team,
we went with a different approach - a dedicated schema_paths setting that
additionally resolves dotted Python attribute paths from installed packages -
which we felt fit the project better. Thanks @esfomeado for raising the problem
and for your contribution! 🙏

Co-authored-by: esfomeado 1906254+esfomeado@users.noreply.github.com

coderabbitai · 2026-06-28T06:15:01Z

Important

Review skipped

Auto reviews are disabled on this repository. Please check the settings in the CodeRabbit UI or the .coderabbit.yaml file in this repository. To trigger a single review, invoke the @coderabbitai review command.

⚙️ Run configuration

Configuration used: Organization UI

Review profile: CHILL

Plan: Pro

Run ID: 15c15ddb-d8ac-4ca6-8ee9-d4b6599e2d15

You can disable this status message by setting the reviews.review_status to false in the CodeRabbit configuration file.

Use the checkbox below for a quick retry:

🔍 Trigger review

✨ Finishing Touches

🧪 Generate unit tests (beta)

Create PR with unit tests
Commit unit tests in branch AR-3-local-schema-external-package-resolution

Thanks for using CodeRabbit! It's free for OSS, and your support helps us grow. If you like it, consider giving us a shout-out.

❤️ Share

_{Comment @coderabbitai help to get the list of available commands.}

…led packages Introduce a new `schema_paths` setting that builds the GraphQL schema from multiple sources. Each entry is resolved either as a dotted Python attribute path (e.g. `pkg.SCHEMA_DIR` or `pkg.get_schema_files`) — useful for pulling type definitions from installed packages — or as a local file/directory path. - schema.py: add `resolve_schema_paths` and `get_graphql_schema_from_paths` - main.py: wire `schema_paths` into both `client` and `graphqlschema` strategies - settings.py: add the `schema_paths` field and make the three schema sources (`schema_path`, `schema_paths`, `remote_schema_url`) mutually exclusive — providing more than one now raises InvalidConfiguration; simplify `using_remote_schema` accordingly - docs/README: document `schema_paths` and the mutual-exclusivity rule

Kwaidan00 · 2026-07-02T05:35:07Z


+### `schema_paths` entries
+
+Each entry in `schema_paths` can be any of the following:


I would say it must, not "can".

Kwaidan00 · 2026-07-02T05:36:22Z

+- **a path to a directory** - all `.graphql`, `.graphqls` and `.gql` files from it are included, eg. `./schemas/`
+- **a path to a specific file** to be used, eg. `./foo/bar.graphql`
+
+An import path that cannot be resolved (missing package, or the attribute no longer exists) raises a configuration error rather than being silently skipped.


Please remove it. You declared the lists of possible values, it's rather obvious it will raise an error. Moreover, we do not have similar mentions like "when providing remote_schema_url which is invalid URL, it will raise an error".

Kwaidan00 · 2026-07-02T05:47:29Z

+def test_resolve_schema_paths_with_single_file(tmp_path, schema_str):
+    schema_file = tmp_path / "schema.graphql"
+    schema_file.write_text(schema_str, encoding="utf-8")
+
+    result = resolve_schema_paths([schema_file.as_posix()])
+
+    assert result == [schema_file]
+
+
+def test_resolve_schema_paths_with_directory(schemas_directory):
+    result = resolve_schema_paths([schemas_directory.as_posix()])
+
+    names = {p.name for p in result}
+    assert "schema.graphql" in names
+    assert "user.graphql" in names
+
+
+def test_resolve_schema_paths_with_multiple_local_sources(
+    tmp_path, schema_str, extra_type_str
+):
+    file1 = tmp_path / "schema.graphql"
+    file1.write_text(schema_str, encoding="utf-8")
+    file2 = tmp_path / "user.graphql"
+    file2.write_text(extra_type_str, encoding="utf-8")
+
+    result = resolve_schema_paths([file1.as_posix(), file2.as_posix()])
+
+    assert file1 in result
+    assert file2 in result
+    assert len(result) == 2


I don't understand what's the point to have three separate test cases here. The first one checks the single file, the second - a single directory, the last one: two files.

WDYT to have just a single test case, which tests reading local files, and provide as an input a list: single file and single directory.

Kwaidan00 · 2026-07-02T05:50:03Z

+        resolve_schema_paths(["some_pkg.SCHEMA_FILE"])
+
+
+def test_resolve_schema_paths_existing_file_skips_importlib(


Why do you propose to have a test like this? What's the purpose?

Kwaidan00 · 2026-07-02T05:50:34Z

+    mock_import.assert_not_called()
+
+
+def test_resolve_schema_paths_accepts_file_with_any_extension(tmp_path, schema_str):


Again, why this test is needed?

Kwaidan00 · 2026-07-02T05:52:26Z

+    mock_import.assert_not_called()
+
+
+def test_resolve_schema_paths_accepts_local_dir_with_dots_in_name(


I understand to show the code works for dots in filenames. But are you sure we absolutely need to have two different test cases for file and for directory?

Kwaidan00 · 2026-07-02T05:54:29Z

+    mock_import.assert_not_called()
+
+
+def test_resolve_schema_paths_with_path_attribute_pointing_to_file(


Is this test case just a "file" version of the "directory" test test_resolve_schema_paths_with_path_attribute_pointing_to_directory? If so, why it lives here in the file, not directly below the other similar tests?

Kwaidan00 · 2026-07-02T05:56:53Z

+    assert result == [schema_file]
+
+
+def test_resolve_schema_paths_raises_invalid_configuration_for_source_without_dot(


I would suggest to keep all the test cases "for this bad data, it raises InvalidConfiguration" in one place. We had some tests like this above, then other test cases, now we have again tests like this.

Kwaidan00 · 2026-07-02T06:05:19Z

    return schema


+def get_graphql_schema_from_path(schema_path: str) -> GraphQLSchema:


Did you consider just

def get_graphql_schema_from_path(schema_path: str) -> GraphQLSchema: return get_graphql_schema_from_paths([Path(schema_path)])

With the current solution, bot "from_path" and "from_paths" uses similar blocks, but call them independently.

Minister944 requested review from DamianCzajkowski and Kwaidan00 June 29, 2026 14:52

DamianCzajkowski reviewed Jun 30, 2026

View reviewed changes

Comment thread ariadne_codegen/schema.py Outdated

DamianCzajkowski reviewed Jun 30, 2026

View reviewed changes

Comment thread ariadne_codegen/settings.py Outdated

DamianCzajkowski approved these changes Jun 30, 2026

View reviewed changes

Kwaidan00 reviewed Jul 1, 2026

View reviewed changes

Comment thread docs/02-configuration.md Outdated

Comment thread ariadne_codegen/schema.py Outdated

Comment thread ariadne_codegen/schema.py Outdated

Comment thread ariadne_codegen/schema.py

Comment thread ariadne_codegen/schema.py

Comment thread ariadne_codegen/schema.py Outdated

Minister944 added 3 commits July 1, 2026 19:10

ruff

2218a09

refactor: address review feedback on schema_paths resolution

79de200

Minister944 force-pushed the AR-3-local-schema-external-package-resolution branch from cee0b53 to 79de200 Compare July 1, 2026 17:11

refactor: extract schema loading into shared read/build helpers

4245c84

Minister944 requested review from DamianCzajkowski and Kwaidan00 July 1, 2026 17:40

Kwaidan00 reviewed Jul 2, 2026

View reviewed changes


		### `schema_paths` entries

		Each entry in `schema_paths` can be any of the following:

		resolve_schema_paths(["some_pkg.SCHEMA_FILE"])


		def test_resolve_schema_paths_existing_file_skips_importlib(

		mock_import.assert_not_called()


		def test_resolve_schema_paths_accepts_file_with_any_extension(tmp_path, schema_str):

		mock_import.assert_not_called()


		def test_resolve_schema_paths_accepts_local_dir_with_dots_in_name(

		mock_import.assert_not_called()


		def test_resolve_schema_paths_with_path_attribute_pointing_to_file(

		assert result == [schema_file]


		def test_resolve_schema_paths_raises_invalid_configuration_for_source_without_dot(

		return schema


		def get_graphql_schema_from_path(schema_path: str) -> GraphQLSchema:

Uh oh!

Conversation

Minister944 commented Jun 28, 2026 • edited by atlassian Bot Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Acknowledgements

Uh oh!

coderabbitai Bot commented Jun 28, 2026 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Review skipped

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Reviewers

Assignees

Labels

Projects

Milestone

Development

Uh oh!

3 participants

Minister944 commented Jun 28, 2026 •

edited by atlassian Bot

Loading

coderabbitai Bot commented Jun 28, 2026 •

edited

Loading