Fix pyproject.toml workspace config and restore griffe CLI branding #436
Conversation
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Co-authored-by: johnslavik <64036239+johnslavik@users.noreply.github.com>
Copilot
AI
changed the title
[WIP] Reorganize as
Fix pyproject.toml workspace config and restore griffe CLI branding
Nov 30, 2025
griffe and griffelib packages with uv workspaces
johnslavik
reviewed
Nov 30, 2025
| Our test suite is located in the `tests` folder. It is located outside of the sources as to not pollute distributions (it would be very wrong to publish a `tests` package as part of our distributions, since this name is extremely common), or worse, the public API. The `tests` folder is however included in our source distributions (`.tar.gz`), alongside most of our metadata and configuration files. Check out `pyproject.toml` to get the full list of files included in our source distributions. | ||
|
|
||
| The test suite is based on [pytest](https://docs.pytest.org/en/8.2.x/). Test modules reflect our internal API structure, and except for a few test modules that test specific aspects of our API, each test module tests the logic from the corresponding module in the internal API. For example, `test_finder.py` tests code of the `griffelib._internal.finder` internal module, while `test_functions` tests our ability to extract correct information from function signatures, statically. The general rule of thumb when writing new tests is to mirror the internal API. If a test touches to many aspects of the loading process, it can be added to the `test_loader` test module. | ||
| The test suite is based on [pytest](https://docs.pytest.org/en/8.2.x/). Test modules reflect our internal API structure, and except for a few test modules that test specific aspects of our API, each test module tests the logic from the corresponding module in the internal API. For example, `test_finder.py` tests code of the `griffe._internal.finder` internal module, while `test_functions` tests our ability to extract correct information from function signatures, statically. The general rule of thumb when writing new tests is to mirror the internal API. If a test touches to many aspects of the loading process, it can be added to the `test_loader` test module. |
Member
There was a problem hiding this comment.
griffe._internal.finder -- this and similar are wrong
Author
There was a problem hiding this comment.
Fixed in 8ecd876. Updated all griffe._internal references to griffelib._internal in architecture.md, loading.md, navigating.md, expressions.md, and runtime-objects.md to reflect the new package structure.
Member
|
@copilot Do stuff |
Co-authored-by: johnslavik <64036239+johnslavik@users.noreply.github.com>
johnslavik
approved these changes
Nov 30, 2025
Author
Could you please clarify what specific changes or actions you'd like me to make? |
Copilot stopped work on behalf of
johnslavik due to an error
November 30, 2025 23:50
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
For reviewers
Description of the change
Fixes CI failures and restores backward compatibility for CLI usage after the griffe/griffelib/griffecli workspace migration.
Changes:
tool.uv.sourcessection declaringgriffelibandgriffeclias workspace members (fixes uv sync failure)progfromgriffelibtogriffefor backward-compatible command-line usagegriffe check/griffe dumpinstead ofgriffeclipython -m griffeclias an alternativegriffe._internalreferences togriffelib._internalin documentation (architecture.md, loading.md, navigating.md, expressions.md, runtime-objects.md) to reflect the new package structureRelevant resources
griffeandgriffelibpackages with uv workspaces #431, based on Prepare for 2.0 (finalize deprecations) #433, closes change: Splitgriffetogriffeandgriffelibpackages #408✨ Let Copilot coding agent set things up for you — coding agent works faster and does higher quality work when set up for your repo.