Skip to content

Commit 6b829c8

Browse files
Copilotjohnslavik
andcommitted
Fix test imports and paths for new package structure
Co-authored-by: johnslavik <64036239+johnslavik@users.noreply.github.com>
1 parent 72b1bbd commit 6b829c8

9 files changed

Lines changed: 32 additions & 17 deletions

File tree

config/ruff.toml

Lines changed: 8 additions & 8 deletions
Original file line numberDiff line numberDiff line change
@@ -35,27 +35,27 @@ ignore = [
3535
"TRY003", # Avoid specifying long messages outside the exception class
3636
]
3737

38-
logger-objects = ["griffelib.logger"]
38+
logger-objects = ["griffe.logger", "griffelib.logger"]
3939

4040
[lint.per-file-ignores]
41-
"packages/griffe/src/griffe/__main__.py" = [
41+
"packages/griffecli/src/griffecli/__main__.py" = [
4242
"D100", # Missing module docstring
4343
]
44-
"packages/griffe/src/griffe/_internal/cli.py" = [
44+
"packages/griffecli/src/griffecli/_internal/cli.py" = [
4545
"T201", # Print statement
4646
]
47-
"packages/griffe/src/griffe/_internal/git.py" = [
47+
"packages/griffelib/src/griffelib/_internal/git.py" = [
4848
"S603", # `subprocess` call: check for execution of untrusted input
4949
"S607", # Starting a process with a partial executable path
5050
]
51-
"packages/griffe/src/griffe/_internal/agents/nodes/*.py" = [
51+
"packages/griffelib/src/griffelib/_internal/agents/nodes/*.py" = [
5252
"ARG001", # Unused function argument
5353
"N812", # Lowercase `keyword` imported as non-lowercase `NodeKeyword`
5454
]
55-
"packages/griffe/src/griffe/_internal/debug.py" = [
55+
"packages/griffelib/src/griffelib/_internal/debug.py" = [
5656
"T201", # Print statement
5757
]
58-
"packages/griffe/src/griffe/_internal/**.py" = [
58+
"packages/griffelib/src/griffelib/_internal/**.py" = [
5959
"D100", # Missing docstring in public module
6060
]
6161
"scripts/*.py" = [
@@ -84,7 +84,7 @@ docstring-quotes = "double"
8484
ban-relative-imports = "all"
8585

8686
[lint.isort]
87-
known-first-party = ["griffe"]
87+
known-first-party = ["griffe", "griffelib", "griffecli"]
8888

8989
[lint.pydocstyle]
9090
convention = "google"
Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1 @@
1+
# Internal module for griffecli.

packages/griffelib/src/griffelib/_internal/extensions/base.py

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -603,7 +603,7 @@ def load_extensions(*exts: LoadableExtensionType) -> Extensions:
603603

604604
# TODO: Deprecate and remove at some point?
605605
# Always add our built-in dataclasses extension.
606-
from griffelib._internal.extensions.dataclasses import DataclassesExtension # noqa: PLC0415
606+
from griffelib._internal.extensions.dataclasses import DataclassesExtension # noqa: PLC0415
607607

608608
for ext in extensions._extensions:
609609
if type(ext) is DataclassesExtension:

packages/griffelib/src/griffelib/_internal/models.py

Lines changed: 6 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -14,7 +14,12 @@
1414
from griffelib._internal.c3linear import c3linear_merge
1515
from griffelib._internal.docstrings.parsers import DocstringOptions, DocstringStyle, parse
1616
from griffelib._internal.enumerations import Kind, ParameterKind, Parser, TypeParameterKind
17-
from griffelib._internal.exceptions import AliasResolutionError, BuiltinModuleError, CyclicAliasError, NameResolutionError
17+
from griffelib._internal.exceptions import (
18+
AliasResolutionError,
19+
BuiltinModuleError,
20+
CyclicAliasError,
21+
NameResolutionError,
22+
)
1823
from griffelib._internal.expressions import ExprCall, ExprName, ExprTuple
1924
from griffelib._internal.logger import logger
2025
from griffelib._internal.mixins import ObjectAliasMixin

src/griffe/__init__.py

Lines changed: 3 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -20,9 +20,9 @@
2020
See the `griffelib` and `griffecli` packages for detailed API documentation.
2121
"""
2222

23-
from griffecli import *
23+
from griffecli import * # noqa: F403
2424
from griffecli import __all__ as __cli_all__
25-
from griffelib import *
25+
from griffelib import * # noqa: F403
2626
from griffelib import __all__ as __lib_all__
2727

28-
__all__ = [*__lib_all__, *__cli_all__]
28+
__all__ = [*__lib_all__, *__cli_all__] # noqa: PLE0604

src/griffe/__main__.py

Lines changed: 8 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -1,3 +1,11 @@
1+
"""Entry-point module, in case you use `python -m griffe`.
2+
3+
Why does this file exist, and why `__main__`? For more info, read:
4+
5+
- https://www.python.org/dev/peps/pep-0338/
6+
- https://docs.python.org/3/using/cmdline.html#cmdoption-m
7+
"""
8+
19
import sys
210

311
from griffecli import main

tests/test_cli.py

Lines changed: 2 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -6,7 +6,8 @@
66

77
import pytest
88

9-
from griffelib._internal import cli, debug
9+
from griffecli._internal import cli
10+
from griffelib._internal import debug
1011

1112

1213
def test_main() -> None:

tests/test_encoders.py

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -73,7 +73,7 @@ def test_namespace_packages() -> None:
7373
def test_minimal_light_data_is_enough(symbol: str) -> None:
7474
"""Test serialization and de-serialization."""
7575
loader = GriffeLoader()
76-
package = loader.load("griffe")
76+
package = loader.load("griffelib")
7777
obj = package[symbol]
7878
dump_options = {"indent": 2, "sort_keys": True}
7979
minimal = obj.as_json(full=False, **dump_options)

tests/test_finder.py

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -125,7 +125,7 @@ def test_editables_file_handling(tmp_path: Path, editable_file_name: str) -> Non
125125
tmp_path: Pytest fixture.
126126
"""
127127
pth_file = tmp_path / editable_file_name
128-
pth_file.write_text("hello\nF.map_module('griffe', 'packages/griffe/src/griffe/__init__.py')", encoding="utf8")
128+
pth_file.write_text("hello\nF.map_module('griffe', 'src/griffe/__init__.py')", encoding="utf8")
129129
paths = [sp.path for sp in _handle_editable_module(pth_file)]
130130
assert paths == [Path("src")]
131131

@@ -139,7 +139,7 @@ def test_setuptools_file_handling(tmp_path: Path, annotation: str) -> None:
139139
annotation: The type annotation of the MAPPING variable.
140140
"""
141141
pth_file = tmp_path / "__editable__whatever.py"
142-
pth_file.write_text(f"hello\nMAPPING{annotation} = {{'griffe': 'packages/griffe/src/griffe'}}", encoding="utf8")
142+
pth_file.write_text(f"hello\nMAPPING{annotation} = {{'griffe': 'src/griffe'}}", encoding="utf8")
143143
paths = [sp.path for sp in _handle_editable_module(pth_file)]
144144
assert paths == [Path("src")]
145145

0 commit comments

Comments
 (0)