forked from Alishahryar1/free-claude-code
-
Notifications
You must be signed in to change notification settings - Fork 0
Expand file tree
/
Copy pathtest_import_boundaries.py
More file actions
844 lines (718 loc) · 27.9 KB
/
Copy pathtest_import_boundaries.py
File metadata and controls
844 lines (718 loc) · 27.9 KB
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
318
319
320
321
322
323
324
325
326
327
328
329
330
331
332
333
334
335
336
337
338
339
340
341
342
343
344
345
346
347
348
349
350
351
352
353
354
355
356
357
358
359
360
361
362
363
364
365
366
367
368
369
370
371
372
373
374
375
376
377
378
379
380
381
382
383
384
385
386
387
388
389
390
391
392
393
394
395
396
397
398
399
400
401
402
403
404
405
406
407
408
409
410
411
412
413
414
415
416
417
418
419
420
421
422
423
424
425
426
427
428
429
430
431
432
433
434
435
436
437
438
439
440
441
442
443
444
445
446
447
448
449
450
451
452
453
454
455
456
457
458
459
460
461
462
463
464
465
466
467
468
469
470
471
472
473
474
475
476
477
478
479
480
481
482
483
484
485
486
487
488
489
490
491
492
493
494
495
496
497
498
499
500
501
502
503
504
505
506
507
508
509
510
511
512
513
514
515
516
517
518
519
520
521
522
523
524
525
526
527
528
529
530
531
532
533
534
535
536
537
538
539
540
541
542
543
544
545
546
547
548
549
550
551
552
553
554
555
556
557
558
559
560
561
562
563
564
565
566
567
568
569
570
571
572
573
574
575
576
577
578
579
580
581
582
583
584
585
586
587
588
589
590
591
592
593
594
595
596
597
598
599
600
601
602
603
604
605
606
607
608
609
610
611
612
613
614
615
616
617
618
619
620
621
622
623
624
625
626
627
628
629
630
631
632
633
634
635
636
637
638
639
640
641
642
643
644
645
646
647
648
649
650
651
652
653
654
655
656
657
658
659
660
661
662
663
664
665
666
667
668
669
670
671
672
673
674
675
676
677
678
679
680
681
682
683
684
685
686
687
688
689
690
691
692
693
694
695
696
697
698
699
700
701
702
703
704
705
706
707
708
709
710
711
712
713
714
715
716
717
718
719
720
721
722
723
724
725
726
727
728
729
730
731
732
733
734
735
736
737
738
739
740
741
742
743
744
745
746
747
748
749
750
751
752
753
754
755
756
757
758
759
760
761
762
763
764
765
766
767
768
769
770
771
772
773
774
775
776
777
778
779
780
781
782
783
784
785
786
787
788
789
790
791
792
793
794
795
796
797
798
799
800
801
802
803
804
805
806
807
808
809
810
811
812
813
814
815
816
817
818
819
820
821
822
823
824
825
826
827
828
829
830
831
832
833
834
835
836
837
838
839
840
841
842
843
844
"""Declarative static import contracts; dynamic imports are deliberately unscanned."""
import ast
import subprocess
import sys
from dataclasses import dataclass
from pathlib import Path
_REPO_ROOT = Path(__file__).resolve().parents[2]
_PACKAGE_ROOT = _REPO_ROOT / "src" / "free_claude_code"
_PACKAGE_NAME = "free_claude_code"
ALLOWED_PACKAGE_DEPENDENCIES: dict[str, set[str]] = {
"config": {"core"},
"core": set(),
"application": {"config", "core"},
"messaging": {"core"},
"providers": {"application", "config", "core"},
"api": {"application", "config", "core"},
"cli": {"config", "core"},
"runtime": {
"api",
"application",
"cli",
"config",
"core",
"messaging",
"providers",
},
}
IMPORT_EXCEPTIONS: dict[tuple[str, str], str] = {
(
"free_claude_code.cli.commands",
"free_claude_code.runtime.bootstrap",
): (
"Owner: installed server command. "
"Reason: the command delegates construction to the process composition root."
),
}
FACADE_ONLY_BOUNDARIES = {
"free_claude_code.core.openai_responses",
"free_claude_code.messaging.trees",
"free_claude_code.providers.openai_chat",
}
OPTIONAL_IMPORT_OWNERS = {
"librosa": "free_claude_code.messaging.transcription",
"torch": "free_claude_code.messaging.transcription",
"transformers": "free_claude_code.messaging.transcription",
"riva": "free_claude_code.providers.nvidia_nim.voice",
}
@dataclass(frozen=True, slots=True)
class ImportRecord:
importer: str
imported: str
path: str
line: int
inside_function: bool
def describe(self) -> str:
return f"{self.path}:{self.line}: {self.importer} -> {self.imported}"
class _ImportVisitor(ast.NodeVisitor):
def __init__(
self,
*,
importer: str,
importer_is_package: bool,
modules: set[str],
path: str,
) -> None:
self._importer = importer
self._importer_is_package = importer_is_package
self._modules = modules
self._path = path
self._function_depth = 0
self.records: list[ImportRecord] = []
def visit_Import(self, node: ast.Import) -> None:
for alias in node.names:
self._record(alias.name, node.lineno)
def visit_ImportFrom(self, node: ast.ImportFrom) -> None:
base = _resolve_import_from_base(
importer=self._importer,
importer_is_package=self._importer_is_package,
level=node.level,
module=node.module,
)
if base is None:
return
for alias in node.names:
candidate = f"{base}.{alias.name}"
imported = candidate if candidate in self._modules else base
self._record(imported, node.lineno)
def visit_FunctionDef(self, node: ast.FunctionDef) -> None:
self._visit_function(node)
def visit_AsyncFunctionDef(self, node: ast.AsyncFunctionDef) -> None:
self._visit_function(node)
def _visit_function(self, node: ast.FunctionDef | ast.AsyncFunctionDef) -> None:
self._function_depth += 1
self.generic_visit(node)
self._function_depth -= 1
def _record(self, imported: str, line: int) -> None:
self.records.append(
ImportRecord(
importer=self._importer,
imported=imported,
path=self._path,
line=line,
inside_function=self._function_depth > 0,
)
)
def test_package_dependencies_follow_declarative_policy() -> None:
modules = _module_paths(_PACKAGE_ROOT)
records = _scan_imports(_PACKAGE_ROOT)
actual_packages = _ownership_roots(set(modules), _PACKAGE_NAME)
assert set(ALLOWED_PACKAGE_DEPENDENCIES) == actual_packages
assert all(
(_PACKAGE_ROOT / package / "__init__.py").is_file()
for package in actual_packages
)
assert all(
dependency in actual_packages and dependency != package
for package, dependencies in ALLOWED_PACKAGE_DEPENDENCIES.items()
for dependency in dependencies
)
observed_dependencies: set[tuple[str, str]] = set()
observed_exceptions: set[tuple[str, str]] = set()
offenders: list[str] = []
for record in records:
source_package = _top_level_package(record.importer)
target_package = _top_level_package(record.imported)
if source_package is None or target_package is None:
continue
if source_package == target_package:
continue
exact_edge = (record.importer, record.imported)
if exact_edge in IMPORT_EXCEPTIONS:
observed_exceptions.add(exact_edge)
continue
if target_package in ALLOWED_PACKAGE_DEPENDENCIES[source_package]:
observed_dependencies.add((source_package, target_package))
continue
offenders.append(record.describe())
declared_dependencies = {
(package, dependency)
for package, dependencies in ALLOWED_PACKAGE_DEPENDENCIES.items()
for dependency in dependencies
}
assert sorted(offenders) == []
assert declared_dependencies - observed_dependencies == set()
assert set(IMPORT_EXCEPTIONS) - observed_exceptions == set()
assert all(
"Owner:" in reason and "Reason:" in reason
for reason in IMPORT_EXCEPTIONS.values()
)
for source, target in IMPORT_EXCEPTIONS:
source_package = _top_level_package(source)
target_package = _top_level_package(target)
assert source_package is not None
assert target_package is not None
assert target_package not in ALLOWED_PACKAGE_DEPENDENCIES[source_package]
expected_package_modules = {
_PACKAGE_NAME,
*(f"{_PACKAGE_NAME}.{package}" for package in actual_packages),
}
assert set(modules) >= expected_package_modules
def test_first_party_imports_use_the_installable_namespace() -> None:
offenders = _legacy_first_party_import_offenders(
_scan_imports(_PACKAGE_ROOT),
set(ALLOWED_PACKAGE_DEPENDENCIES),
)
assert offenders == []
def test_openai_chat_collaborators_have_explicit_ownership_boundaries() -> None:
provider_root = _PACKAGE_ROOT / "providers" / "openai_chat"
assert _provider_backchannel_offenders(provider_root) == []
def test_google_reasoning_wire_fields_have_one_owner() -> None:
owner = _PACKAGE_ROOT / "providers" / "google_openai" / "reasoning.py"
roots = [
_PACKAGE_ROOT / "providers" / "gemini",
_PACKAGE_ROOT / "providers" / "google_openai",
_PACKAGE_ROOT / "providers" / "vertex",
]
owned_fields = {
"include_thoughts",
"reasoning_effort",
"thinking_budget",
"thinking_config",
}
offenders: list[str] = []
for root in roots:
for path in root.rglob("*.py"):
if path == owner:
continue
tree = ast.parse(path.read_text(encoding="utf-8"), filename=str(path))
offenders.extend(
f"{path.relative_to(_REPO_ROOT).as_posix()}:{node.lineno}: {node.value}"
for node in ast.walk(tree)
if isinstance(node, ast.Constant) and node.value in owned_fields
)
assert sorted(offenders) == []
def test_cli_local_http_transport_has_one_owner() -> None:
cli_root = _PACKAGE_ROOT / "cli"
owner = cli_root / "local_http.py"
owned_urllib_names = {"ProxyHandler", "build_opener", "urlopen"}
owned_environment_keys = {"NO_PROXY", "no_proxy"}
offenders: list[str] = []
for path in cli_root.rglob("*.py"):
if path == owner:
continue
tree = ast.parse(path.read_text(encoding="utf-8"), filename=str(path))
relative_path = path.relative_to(_REPO_ROOT).as_posix()
for node in ast.walk(tree):
if isinstance(node, ast.ImportFrom) and node.module == "urllib.request":
offenders.extend(
f"{relative_path}:{node.lineno}: urllib.request.{alias.name}"
for alias in node.names
if alias.name in owned_urllib_names
)
if isinstance(node, ast.Constant) and node.value in owned_environment_keys:
offenders.append(f"{relative_path}:{node.lineno}: {node.value}")
assert sorted(offenders) == []
def test_provider_backchannel_detector_reports_untyped_private_access(
tmp_path: Path,
) -> None:
provider_root = tmp_path / "openai_chat"
_write_module(
provider_root / "sample" / "runner.py",
"from typing import Any\n"
"\n"
"class Runner:\n"
" def __init__(self, provider: object | Any) -> None:\n"
" self._provider = provider\n"
"\n"
" def run(self) -> object:\n"
" return self._provider._send()\n",
)
assert _provider_backchannel_offenders(provider_root) == [
"sample/runner.py:4: untyped provider collaborator",
"sample/runner.py:8: private provider member _send outside provider.py",
]
def test_legacy_first_party_import_detector_rejects_bare_owner_names() -> None:
record = ImportRecord(
importer="free_claude_code.api.routes",
imported="core.anthropic",
path="free_claude_code/api/routes.py",
line=7,
inside_function=False,
)
assert _legacy_first_party_import_offenders([record], {"api", "core"}) == [
"free_claude_code/api/routes.py:7: "
"free_claude_code.api.routes -> core.anthropic"
]
def test_ownership_root_discovery_includes_modules_and_namespace_directories(
tmp_path: Path,
) -> None:
package_root = tmp_path / "sample"
_write_module(package_root / "__init__.py")
_write_module(package_root / "declared" / "__init__.py")
_write_module(package_root / "namespace" / "module.py")
_write_module(package_root / "root_module.py")
roots = _ownership_roots(set(_module_paths(package_root)), "sample")
assert roots == {"declared", "namespace", "root_module"}
def test_descendants_do_not_import_ancestor_package_facades() -> None:
modules = _module_paths(_PACKAGE_ROOT)
packages = {
module for module, path in modules.items() if path.name == "__init__.py"
}
offenders = _ancestor_facade_offenders(_scan_imports(_PACKAGE_ROOT), packages)
assert offenders == []
def test_static_first_party_import_graph_is_acyclic() -> None:
modules = set(_module_paths(_PACKAGE_ROOT))
graph = {module: set() for module in modules}
for record in _scan_imports(_PACKAGE_ROOT):
if record.imported in modules:
graph[record.importer].add(record.imported)
assert _cyclic_components(graph) == []
def test_cycle_detector_reports_exact_strongly_connected_components() -> None:
graph = {
"package.a": {"package.b"},
"package.b": {"package.a"},
"package.c": set(),
"package.self": {"package.self"},
}
assert _cyclic_components(graph) == [
("package.a", "package.b"),
("package.self",),
]
def test_external_consumers_use_owned_package_facades() -> None:
offenders: list[str] = []
for record in _scan_imports(_PACKAGE_ROOT):
for facade in FACADE_ONLY_BOUNDARIES:
if record.importer == facade or record.importer.startswith(f"{facade}."):
continue
if record.imported.startswith(f"{facade}."):
offenders.append(record.describe())
assert sorted(offenders) == []
def test_import_scanner_resolves_absolute_relative_and_lazy_imports(
tmp_path: Path,
) -> None:
package_root = tmp_path / "sample"
_write_module(package_root / "__init__.py")
_write_module(package_root / "alpha" / "__init__.py", "PUBLIC = object()\n")
_write_module(package_root / "alpha" / "sibling.py")
_write_module(package_root / "beta" / "__init__.py")
_write_module(package_root / "beta" / "absolute.py")
_write_module(package_root / "beta" / "relative.py")
_write_module(package_root / "beta" / "lazy.py")
_write_module(
package_root / "alpha" / "consumer.py",
"\n".join(
(
"import sample.beta.absolute",
"from ..beta import relative",
"from . import sibling",
"from . import PUBLIC",
"def load():",
" import sample.beta.lazy",
"",
)
),
)
records = _scan_imports(package_root)
resolved = {
(record.imported, record.inside_function)
for record in records
if record.importer == "sample.alpha.consumer"
}
assert resolved == {
("sample.alpha", False),
("sample.alpha.sibling", False),
("sample.beta.absolute", False),
("sample.beta.relative", False),
("sample.beta.lazy", True),
}
def test_import_scanner_distinguishes_facade_symbols_from_sibling_modules(
tmp_path: Path,
) -> None:
package_root = tmp_path / "sample"
_write_module(package_root / "__init__.py")
_write_module(package_root / "owner" / "__init__.py", "PUBLIC = object()\n")
_write_module(package_root / "owner" / "sibling.py")
_write_module(
package_root / "owner" / "consumer.py",
"from . import PUBLIC, sibling\n",
)
modules = _module_paths(package_root)
packages = {
module for module, path in modules.items() if path.name == "__init__.py"
}
offenders = _ancestor_facade_offenders(_scan_imports(package_root), packages)
assert offenders == [
"sample/owner/consumer.py:1: sample.owner.consumer -> sample.owner"
]
def test_anthropic_request_boundaries_use_the_protocol_model() -> None:
"""Known Messages fields must not cross core/provider boundaries by duck typing."""
roots = [
_PACKAGE_ROOT / "core" / "anthropic",
_PACKAGE_ROOT / "providers",
]
request_names = {"request", "request_data"}
protocol_fields = {
"extra_body",
"max_tokens",
"messages",
"model",
"stop_sequences",
"system",
"temperature",
"thinking",
"tool_choice",
"tools",
"top_k",
"top_p",
}
offenders: list[str] = []
for root in roots:
for path in root.rglob("*.py"):
tree = ast.parse(path.read_text(encoding="utf-8"), filename=str(path))
relative = path.relative_to(_REPO_ROOT).as_posix()
for node in ast.walk(tree):
if isinstance(node, ast.FunctionDef | ast.AsyncFunctionDef):
arguments = [
*node.args.posonlyargs,
*node.args.args,
*node.args.kwonlyargs,
]
for argument in arguments:
if argument.arg.lstrip("_") not in request_names:
continue
annotation_names = (
{
child.id
for child in ast.walk(argument.annotation)
if isinstance(child, ast.Name)
}
if argument.annotation is not None
else set()
)
if argument.annotation is None or annotation_names & {
"Any",
"Mapping",
}:
offenders.append(
f"{relative}:{argument.lineno}: "
f"{node.name}({argument.arg}) is not concrete"
)
if not isinstance(node, ast.Call) or not (
isinstance(node.func, ast.Name)
and node.func.id == "getattr"
and len(node.args) >= 2
and isinstance(node.args[0], ast.Name)
and node.args[0].id.lstrip("_") in request_names
and isinstance(node.args[1], ast.Constant)
and node.args[1].value in protocol_fields
):
continue
offenders.append(
f"{relative}:{node.lineno}: "
f"getattr({node.args[0].id}, {node.args[1].value!r})"
)
assert sorted(offenders) == []
def test_core_does_not_import_provider_transport_sdks() -> None:
forbidden_roots = {"aiohttp", "httpx", "openai"}
offenders = [
record.describe()
for record in _scan_imports(_PACKAGE_ROOT)
if (
record.importer == "free_claude_code.core"
or record.importer.startswith("free_claude_code.core.")
)
and record.imported.split(".", 1)[0] in forbidden_roots
]
assert sorted(offenders) == []
def test_application_and_providers_do_not_import_protocol_request_models() -> None:
forbidden_symbols = {
"Message",
"MessagesRequest",
"SystemContent",
"TokenCountRequest",
"Tool",
}
owner_modules = {
"free_claude_code.core.anthropic",
"free_claude_code.core.anthropic.models",
}
offenders: list[str] = []
for root in (_PACKAGE_ROOT / "application", _PACKAGE_ROOT / "providers"):
for path in root.rglob("*.py"):
tree = ast.parse(path.read_text(encoding="utf-8"), filename=str(path))
relative = path.relative_to(_REPO_ROOT).as_posix()
for node in ast.walk(tree):
if (
not isinstance(node, ast.ImportFrom)
or node.module not in owner_modules
):
continue
offenders.extend(
f"{relative}:{node.lineno}: {node.module}.{alias.name}"
for alias in node.names
if alias.name in forbidden_symbols
)
assert sorted(offenders) == []
def test_removed_request_bridge_modules_do_not_return() -> None:
removed_modules = {
"core/anthropic/conversion.py",
"core/anthropic/openai_tool_names.py",
"core/anthropic/request_serialization.py",
"core/anthropic/request_snapshot.py",
"core/anthropic/streaming/recovery.py",
"core/anthropic/tokens.py",
"core/openai_responses/adapter.py",
"core/openai_responses/input.py",
"core/openai_responses/provider_events.py",
"core/openai_responses/provider_input.py",
"core/openai_responses/tools.py",
}
assert all(not (_PACKAGE_ROOT / module).exists() for module in removed_modules)
def test_providers_do_not_own_wire_error_type_literals() -> None:
wire_types = {
"api_error",
"authentication_error",
"billing_error",
"invalid_request_error",
"not_found_error",
"overloaded_error",
"permission_error",
"rate_limit_error",
"request_too_large",
"timeout_error",
}
offenders: list[str] = []
for path in (_PACKAGE_ROOT / "providers").rglob("*.py"):
tree = ast.parse(path.read_text(encoding="utf-8"), filename=str(path))
offenders.extend(
f"{path.relative_to(_REPO_ROOT).as_posix()}:{node.lineno}: {node.value}"
for node in ast.walk(tree)
if isinstance(node, ast.Constant) and node.value in wire_types
)
assert sorted(offenders) == []
def test_optional_dependencies_have_one_lazy_owner() -> None:
seen: set[str] = set()
offenders: list[str] = []
for record in _scan_imports(_PACKAGE_ROOT):
dependency = record.imported.split(".", 1)[0]
owner = OPTIONAL_IMPORT_OWNERS.get(dependency)
if owner is None:
continue
seen.add(dependency)
if record.importer != owner or not record.inside_function:
offenders.append(record.describe())
assert seen == set(OPTIONAL_IMPORT_OWNERS)
assert sorted(offenders) == []
def test_runtime_imports_without_optional_voice_dependencies() -> None:
blocked = sorted(OPTIONAL_IMPORT_OWNERS)
script = "\n".join(
(
"import importlib.abc",
"import sys",
f"BLOCKED = {blocked!r}",
"class Blocker(importlib.abc.MetaPathFinder):",
" def find_spec(self, fullname, path=None, target=None):",
" if fullname.split('.', 1)[0] in BLOCKED:",
" raise ModuleNotFoundError(fullname)",
" return None",
"sys.meta_path.insert(0, Blocker())",
"import free_claude_code.runtime.bootstrap",
"import free_claude_code.api.app",
)
)
completed = subprocess.run(
[sys.executable, "-c", script],
capture_output=True,
check=False,
text=True,
)
assert completed.returncode == 0, completed.stderr or completed.stdout
def test_supported_messaging_facade_is_explicit() -> None:
import free_claude_code.messaging as facade
from free_claude_code.messaging.managed_protocols import (
ManagedClaudeSessionManagerProtocol,
ManagedClaudeSessionProtocol,
)
from free_claude_code.messaging.models import IncomingMessage, MessageScope
from free_claude_code.messaging.platforms.ports import OutboundMessenger
expected = {
"IncomingMessage": IncomingMessage,
"ManagedClaudeSessionManagerProtocol": ManagedClaudeSessionManagerProtocol,
"ManagedClaudeSessionProtocol": ManagedClaudeSessionProtocol,
"MessageScope": MessageScope,
"OutboundMessenger": OutboundMessenger,
}
assert set(facade.__all__) == set(expected)
assert all(getattr(facade, name) is value for name, value in expected.items())
def test_message_tree_mutability_stays_behind_its_facade() -> None:
import free_claude_code.messaging.trees as facade
for internal_owner in {
"MessageNode",
"MessageTree",
"TreeQueueProcessor",
"TreeRepository",
}:
assert internal_owner not in facade.__all__
assert not hasattr(facade, internal_owner)
def _module_paths(package_root: Path) -> dict[str, Path]:
return {
_module_name(package_root, path): path for path in package_root.rglob("*.py")
}
def _module_name(package_root: Path, path: Path) -> str:
relative = path.relative_to(package_root)
module_parts = (
relative.parent.parts
if path.name == "__init__.py"
else relative.with_suffix("").parts
)
return ".".join((package_root.name, *module_parts))
def _scan_imports(package_root: Path) -> list[ImportRecord]:
module_paths = _module_paths(package_root)
modules = set(module_paths)
records: list[ImportRecord] = []
for importer, path in sorted(module_paths.items()):
visitor = _ImportVisitor(
importer=importer,
importer_is_package=path.name == "__init__.py",
modules=modules,
path=path.relative_to(package_root.parent).as_posix(),
)
visitor.visit(ast.parse(path.read_text(encoding="utf-8"), filename=str(path)))
records.extend(visitor.records)
return records
def _resolve_import_from_base(
*,
importer: str,
importer_is_package: bool,
level: int,
module: str | None,
) -> str | None:
if level == 0:
return module
package_parts = importer.split(".")
if not importer_is_package:
package_parts.pop()
parents_to_remove = level - 1
if parents_to_remove > len(package_parts):
return None
if parents_to_remove:
del package_parts[-parents_to_remove:]
if module is not None:
package_parts.extend(module.split("."))
return ".".join(package_parts) or None
def _top_level_package(module: str) -> str | None:
parts = module.split(".")
if len(parts) < 2 or parts[0] != _PACKAGE_NAME:
return None
return parts[1]
def _ownership_roots(modules: set[str], package_name: str) -> set[str]:
roots: set[str] = set()
for module in modules:
parts = module.split(".")
if len(parts) >= 2 and parts[0] == package_name:
roots.add(parts[1])
return roots
def _legacy_first_party_import_offenders(
records: list[ImportRecord],
owner_names: set[str],
) -> list[str]:
offenders = [
record.describe()
for record in records
if record.imported.split(".", 1)[0] in owner_names
]
return sorted(offenders)
def _provider_backchannel_offenders(provider_root: Path) -> list[str]:
offenders: list[str] = []
for path in sorted(provider_root.rglob("*.py")):
relative_path = path.relative_to(provider_root).as_posix()
tree = ast.parse(path.read_text(encoding="utf-8"), filename=str(path))
for node in ast.walk(tree):
if isinstance(node, ast.FunctionDef | ast.AsyncFunctionDef):
arguments = (
*node.args.posonlyargs,
*node.args.args,
*node.args.kwonlyargs,
)
offenders.extend(
f"{relative_path}:{argument.lineno}: untyped provider collaborator"
for argument in arguments
if argument.arg == "provider"
and _annotation_is_any(argument.annotation)
)
if (
path.name != "provider.py"
and isinstance(node, ast.Attribute)
and node.attr.startswith("_")
and _is_provider_reference(node.value)
):
offenders.append(
f"{relative_path}:{node.lineno}: private provider member "
f"{node.attr} outside provider.py"
)
return sorted(offenders)
def _annotation_is_any(annotation: ast.expr | None) -> bool:
if annotation is None:
return False
return any(
(isinstance(node, ast.Name) and node.id == "Any")
or (isinstance(node, ast.Attribute) and node.attr == "Any")
for node in ast.walk(annotation)
)
def _is_provider_reference(expression: ast.expr) -> bool:
return (isinstance(expression, ast.Name) and expression.id == "provider") or (
isinstance(expression, ast.Attribute)
and isinstance(expression.value, ast.Name)
and expression.value.id == "self"
and expression.attr == "_provider"
)
def _ancestor_facade_offenders(
records: list[ImportRecord],
packages: set[str],
) -> list[str]:
offenders = [
record.describe()
for record in records
if record.imported in packages
and record.importer.startswith(f"{record.imported}.")
]
return sorted(offenders)
def _cyclic_components(graph: dict[str, set[str]]) -> list[tuple[str, ...]]:
index = 0
indices: dict[str, int] = {}
lowlinks: dict[str, int] = {}
stack: list[str] = []
on_stack: set[str] = set()
components: list[tuple[str, ...]] = []
def visit(node: str) -> None:
nonlocal index
indices[node] = index
lowlinks[node] = index
index += 1
stack.append(node)
on_stack.add(node)
for successor in sorted(graph[node]):
if successor not in indices:
visit(successor)
lowlinks[node] = min(lowlinks[node], lowlinks[successor])
elif successor in on_stack:
lowlinks[node] = min(lowlinks[node], indices[successor])
if lowlinks[node] != indices[node]:
return
component: list[str] = []
while True:
member = stack.pop()
on_stack.remove(member)
component.append(member)
if member == node:
break
if len(component) > 1 or node in graph[node]:
components.append(tuple(sorted(component)))
for node in sorted(graph):
if node not in indices:
visit(node)
return sorted(components)
def _write_module(path: Path, text: str = "") -> None:
path.parent.mkdir(parents=True, exist_ok=True)
path.write_text(text, encoding="utf-8")