From ba0c02a4fc1f3d31a59fbf8cc46ae4bf08a3f810 Mon Sep 17 00:00:00 2001 From: codeasier Date: Sun, 12 Apr 2026 17:13:02 +0800 Subject: [PATCH] refactor: migrate from flat-layout to src-layout Move pt_snap_cli/ to src/pt_snap_cli/ and update pyproject.toml package discovery to where = ["src"]. This follows the Python packaging best practice of src-layout to prevent accidental imports of the working tree instead of the installed package. Also update project structure diagrams in README.md and README_zh.md. --- README.md | 25 ++++++++++--------- README_zh.md | 25 ++++++++++--------- pyproject.toml | 2 +- {pt_snap_cli => src/pt_snap_cli}/__init__.py | 0 {pt_snap_cli => src/pt_snap_cli}/cli.py | 0 {pt_snap_cli => src/pt_snap_cli}/config.py | 0 {pt_snap_cli => src/pt_snap_cli}/context.py | 0 .../pt_snap_cli}/models/__init__.py | 0 .../pt_snap_cli}/models/_enums.py | 0 .../pt_snap_cli}/models/block.py | 0 .../pt_snap_cli}/models/event.py | 0 .../pt_snap_cli}/query/__init__.py | 0 .../pt_snap_cli}/query/builder.py | 0 .../pt_snap_cli}/query/condition.py | 0 .../pt_snap_cli}/query/config.py | 0 .../pt_snap_cli}/query/executor.py | 0 .../pt_snap_cli}/query/mapper.py | 0 .../pt_snap_cli}/query/registry.py | 0 .../query/templates/active_blocks.yaml | 0 .../query/templates/blocks_by_size.yaml | 0 .../query/templates/callstack_analysis.yaml | 0 .../query/templates/events_by_action.yaml | 0 .../query/templates/leak_detection.yaml | 0 .../query/templates/memory_summary.yaml | 0 .../query/templates/memory_timeline.yaml | 0 {pt_snap_cli => src/pt_snap_cli}/version.py | 0 26 files changed, 27 insertions(+), 25 deletions(-) rename {pt_snap_cli => src/pt_snap_cli}/__init__.py (100%) rename {pt_snap_cli => src/pt_snap_cli}/cli.py (100%) rename {pt_snap_cli => src/pt_snap_cli}/config.py (100%) rename {pt_snap_cli => src/pt_snap_cli}/context.py (100%) rename {pt_snap_cli => src/pt_snap_cli}/models/__init__.py (100%) rename {pt_snap_cli => src/pt_snap_cli}/models/_enums.py (100%) rename {pt_snap_cli => src/pt_snap_cli}/models/block.py (100%) rename {pt_snap_cli => src/pt_snap_cli}/models/event.py (100%) rename {pt_snap_cli => src/pt_snap_cli}/query/__init__.py (100%) rename {pt_snap_cli => src/pt_snap_cli}/query/builder.py (100%) rename {pt_snap_cli => src/pt_snap_cli}/query/condition.py (100%) rename {pt_snap_cli => src/pt_snap_cli}/query/config.py (100%) rename {pt_snap_cli => src/pt_snap_cli}/query/executor.py (100%) rename {pt_snap_cli => src/pt_snap_cli}/query/mapper.py (100%) rename {pt_snap_cli => src/pt_snap_cli}/query/registry.py (100%) rename {pt_snap_cli => src/pt_snap_cli}/query/templates/active_blocks.yaml (100%) rename {pt_snap_cli => src/pt_snap_cli}/query/templates/blocks_by_size.yaml (100%) rename {pt_snap_cli => src/pt_snap_cli}/query/templates/callstack_analysis.yaml (100%) rename {pt_snap_cli => src/pt_snap_cli}/query/templates/events_by_action.yaml (100%) rename {pt_snap_cli => src/pt_snap_cli}/query/templates/leak_detection.yaml (100%) rename {pt_snap_cli => src/pt_snap_cli}/query/templates/memory_summary.yaml (100%) rename {pt_snap_cli => src/pt_snap_cli}/query/templates/memory_timeline.yaml (100%) rename {pt_snap_cli => src/pt_snap_cli}/version.py (100%) diff --git a/README.md b/README.md index c70c35a..ca1de5e 100644 --- a/README.md +++ b/README.md @@ -342,18 +342,19 @@ Supported type converters: ``` pt-snap-cli/ -├── pt_snap_cli/ -│ ├── cli.py # CLI entry point -│ ├── context.py # Context management -│ ├── query/ -│ │ ├── builder.py # Query builder -│ │ ├── executor.py # Query executor -│ │ ├── mapper.py # Result mapper -│ │ ├── registry.py # Query registry -│ │ ├── condition.py # Query conditions -│ │ ├── config.py # Query configuration -│ │ └── templates/ # Query templates -│ └── models/ # Data models +├── src/ +│ └── pt_snap_cli/ +│ ├── cli.py # CLI entry point +│ ├── context.py # Context management +│ ├── query/ +│ │ ├── builder.py # Query builder +│ │ ├── executor.py # Query executor +│ │ ├── mapper.py # Result mapper +│ │ ├── registry.py # Query registry +│ │ ├── condition.py # Query conditions +│ │ ├── config.py # Query configuration +│ │ └── templates/ # Query templates +│ └── models/ # Data models ├── tests/ # Test files ├── examples/ # Example data └── docs/ # Documentation diff --git a/README_zh.md b/README_zh.md index 50c5d7c..0eed506 100644 --- a/README_zh.md +++ b/README_zh.md @@ -342,18 +342,19 @@ mapped_all = map_results(rows, schema) ``` pt-snap-cli/ -├── pt_snap_cli/ -│ ├── cli.py # CLI 入口 -│ ├── context.py # 上下文管理 -│ ├── query/ -│ │ ├── builder.py # 查询构建器 -│ │ ├── executor.py # 查询执行器 -│ │ ├── mapper.py # 结果映射器 -│ │ ├── registry.py # 查询注册表 -│ │ ├── condition.py # 查询条件 -│ │ ├── config.py # 查询配置 -│ │ └── templates/ # 查询模板 -│ └── models/ # 数据模型 +├── src/ +│ └── pt_snap_cli/ +│ ├── cli.py # CLI 入口 +│ ├── context.py # 上下文管理 +│ ├── query/ +│ │ ├── builder.py # 查询构建器 +│ │ ├── executor.py # 查询执行器 +│ │ ├── mapper.py # 结果映射器 +│ │ ├── registry.py # 查询注册表 +│ │ ├── condition.py # 查询条件 +│ │ ├── config.py # 查询配置 +│ │ └── templates/ # 查询模板 +│ └── models/ # 数据模型 ├── tests/ # 测试文件 ├── examples/ # 示例数据 └── docs/ # 文档 diff --git a/pyproject.toml b/pyproject.toml index 8d3e7ea..707aebd 100644 --- a/pyproject.toml +++ b/pyproject.toml @@ -53,7 +53,7 @@ rag = [ pt-snap = "pt_snap_cli.cli:app" [tool.setuptools.packages.find] -where = ["."] +where = ["src"] include = ["pt_snap_cli*"] [tool.setuptools.package-data] diff --git a/pt_snap_cli/__init__.py b/src/pt_snap_cli/__init__.py similarity index 100% rename from pt_snap_cli/__init__.py rename to src/pt_snap_cli/__init__.py diff --git a/pt_snap_cli/cli.py b/src/pt_snap_cli/cli.py similarity index 100% rename from pt_snap_cli/cli.py rename to src/pt_snap_cli/cli.py diff --git a/pt_snap_cli/config.py b/src/pt_snap_cli/config.py similarity index 100% rename from pt_snap_cli/config.py rename to src/pt_snap_cli/config.py diff --git a/pt_snap_cli/context.py b/src/pt_snap_cli/context.py similarity index 100% rename from pt_snap_cli/context.py rename to src/pt_snap_cli/context.py diff --git a/pt_snap_cli/models/__init__.py b/src/pt_snap_cli/models/__init__.py similarity index 100% rename from pt_snap_cli/models/__init__.py rename to src/pt_snap_cli/models/__init__.py diff --git a/pt_snap_cli/models/_enums.py b/src/pt_snap_cli/models/_enums.py similarity index 100% rename from pt_snap_cli/models/_enums.py rename to src/pt_snap_cli/models/_enums.py diff --git a/pt_snap_cli/models/block.py b/src/pt_snap_cli/models/block.py similarity index 100% rename from pt_snap_cli/models/block.py rename to src/pt_snap_cli/models/block.py diff --git a/pt_snap_cli/models/event.py b/src/pt_snap_cli/models/event.py similarity index 100% rename from pt_snap_cli/models/event.py rename to src/pt_snap_cli/models/event.py diff --git a/pt_snap_cli/query/__init__.py b/src/pt_snap_cli/query/__init__.py similarity index 100% rename from pt_snap_cli/query/__init__.py rename to src/pt_snap_cli/query/__init__.py diff --git a/pt_snap_cli/query/builder.py b/src/pt_snap_cli/query/builder.py similarity index 100% rename from pt_snap_cli/query/builder.py rename to src/pt_snap_cli/query/builder.py diff --git a/pt_snap_cli/query/condition.py b/src/pt_snap_cli/query/condition.py similarity index 100% rename from pt_snap_cli/query/condition.py rename to src/pt_snap_cli/query/condition.py diff --git a/pt_snap_cli/query/config.py b/src/pt_snap_cli/query/config.py similarity index 100% rename from pt_snap_cli/query/config.py rename to src/pt_snap_cli/query/config.py diff --git a/pt_snap_cli/query/executor.py b/src/pt_snap_cli/query/executor.py similarity index 100% rename from pt_snap_cli/query/executor.py rename to src/pt_snap_cli/query/executor.py diff --git a/pt_snap_cli/query/mapper.py b/src/pt_snap_cli/query/mapper.py similarity index 100% rename from pt_snap_cli/query/mapper.py rename to src/pt_snap_cli/query/mapper.py diff --git a/pt_snap_cli/query/registry.py b/src/pt_snap_cli/query/registry.py similarity index 100% rename from pt_snap_cli/query/registry.py rename to src/pt_snap_cli/query/registry.py diff --git a/pt_snap_cli/query/templates/active_blocks.yaml b/src/pt_snap_cli/query/templates/active_blocks.yaml similarity index 100% rename from pt_snap_cli/query/templates/active_blocks.yaml rename to src/pt_snap_cli/query/templates/active_blocks.yaml diff --git a/pt_snap_cli/query/templates/blocks_by_size.yaml b/src/pt_snap_cli/query/templates/blocks_by_size.yaml similarity index 100% rename from pt_snap_cli/query/templates/blocks_by_size.yaml rename to src/pt_snap_cli/query/templates/blocks_by_size.yaml diff --git a/pt_snap_cli/query/templates/callstack_analysis.yaml b/src/pt_snap_cli/query/templates/callstack_analysis.yaml similarity index 100% rename from pt_snap_cli/query/templates/callstack_analysis.yaml rename to src/pt_snap_cli/query/templates/callstack_analysis.yaml diff --git a/pt_snap_cli/query/templates/events_by_action.yaml b/src/pt_snap_cli/query/templates/events_by_action.yaml similarity index 100% rename from pt_snap_cli/query/templates/events_by_action.yaml rename to src/pt_snap_cli/query/templates/events_by_action.yaml diff --git a/pt_snap_cli/query/templates/leak_detection.yaml b/src/pt_snap_cli/query/templates/leak_detection.yaml similarity index 100% rename from pt_snap_cli/query/templates/leak_detection.yaml rename to src/pt_snap_cli/query/templates/leak_detection.yaml diff --git a/pt_snap_cli/query/templates/memory_summary.yaml b/src/pt_snap_cli/query/templates/memory_summary.yaml similarity index 100% rename from pt_snap_cli/query/templates/memory_summary.yaml rename to src/pt_snap_cli/query/templates/memory_summary.yaml diff --git a/pt_snap_cli/query/templates/memory_timeline.yaml b/src/pt_snap_cli/query/templates/memory_timeline.yaml similarity index 100% rename from pt_snap_cli/query/templates/memory_timeline.yaml rename to src/pt_snap_cli/query/templates/memory_timeline.yaml diff --git a/pt_snap_cli/version.py b/src/pt_snap_cli/version.py similarity index 100% rename from pt_snap_cli/version.py rename to src/pt_snap_cli/version.py