Use src layout (#2311)

Signed-off-by: Bernát Gábor <[email protected]>
koxudaxi · Feb 7, 2025 · 19134de · 19134de
1 parent dea7b4b
commit 19134de
Show file tree

Hide file tree

Showing 58 changed files with 81 additions and 38 deletions.
diff --git a/.github/workflows/test.yml b/.github/workflows/test.yml
@@ -71,14 +71,8 @@ jobs:
           fetch-depth: 0
       - name: Install the latest version of uv
         uses: astral-sh/setup-uv@v5
-        with:
-          enable-cache: true
-          cache-dependency-glob: "pyproject.toml"
-          github-token: ${{ secrets.GITHUB_TOKEN }}
-      - name: Install hatch
+      - name: Install tox
         run: uv tool install --python-preference only-managed --python 3.13 tox --with tox-uv
-      - name: Build package to generate version
-        run: uv build --python 3.13 --python-preference only-managed --wheel . --out-dir dist
       - name: Setup coverage tool
         run: tox run -e coverage --notest
         env:

diff --git a/pyproject.toml b/pyproject.toml
@@ -74,7 +74,6 @@ dev = [
   { include-group = "type" },
 ]
 test = [
-  "diff-cover>=7.7",
   "freezegun",
   "pytest>=6.1",
   "pytest>=8.3.4",
@@ -85,6 +84,7 @@ test = [
   "pytest-mock>=3.14",
   "pytest-xdist>=3.3.1",
   "setuptools; python_version<'3.9'",
+  { include-group = "coverage" },
 ]
 type = [
   "pyright>=1.1.393",
@@ -107,14 +107,15 @@ isort4-pydantic15 = [ "isort[pyproject]==4.3.21", "pydantic==1.5.1" ]
 fix = [ "pre-commit>=3.5" ]
 pkg-meta = [ "check-wheel-contents>=0.6.1", "twine>=6.1", "uv>=0.5.22" ]
 coverage = [
+  "covdefaults>=2.3",
   "coverage[toml]>=7.6.1",
   "diff-cover>=7.7",
 ]
 
 [tool.hatch]
-build.dev-mode-dirs = [ "." ]
+build.dev-mode-dirs = [ "src" ]
 build.targets.sdist.include = [
-  "/datamodel_code_generator",
+  "/src",
   "/tests",
 ]
 version.source = "vcs"
@@ -151,25 +152,28 @@ filterwarnings = [
 norecursedirs = "tests/data/*"
 
 [tool.coverage]
-run.source = [ "datamodel_code_generator" ]
-run.branch = true
-run.omit = [ "scripts/*", "tests/*" ]
-report.ignore_errors = true
-report.exclude_lines = [
-  "if self.debug:",
-  "pragma: no cover",
-  "raise NotImplementedError",
-  "if __name__ == .__main__.:",
-  "if TYPE_CHECKING:",
-  "if not TYPE_CHECKING:",
-]
+html.skip_covered = false
+html.show_contexts = false
 paths.source = [
-  "datamodel_code_generator",
-  ".tox*/*/lib/python*/site-packages/datamodel_code_generator",
-  ".tox*\\*\\Lib\\site-packages\\datamodel_code_generator",
-  "*/datamodel_code_generator",
-  "*\\datamodel_code_generator",
-]
+  "src",
+  ".tox*/*/lib/python*/site-packages",
+  ".tox*\\*\\Lib\\site-packages",
+  "*/src",
+  "*\\src",
+]
+paths.other = [
+  ".",
+  "*/datamodel-code-generator",
+  "*\\datamodel-code-generator",
+]
+run.dynamic_context = "none"
+run.omit = [ "tests/data/*" ]
+report.fail_under = 94
+run.parallel = true
+run.plugins = [
+  "covdefaults",
+]
+covdefaults.subtract_omit = "*/__main__.py"
 
 [tool.pyright]
 reportPrivateImportUsage = false

diff --git a/datamodel_code_generator/__init__.py → src/datamodel_code_generator/__init__.py b/datamodel_code_generator/__init__.py → src/datamodel_code_generator/__init__.py
diff --git a/datamodel_code_generator/__main__.py → src/datamodel_code_generator/__main__.py b/datamodel_code_generator/__main__.py → src/datamodel_code_generator/__main__.py
diff --git a/datamodel_code_generator/arguments.py → src/datamodel_code_generator/arguments.py b/datamodel_code_generator/arguments.py → src/datamodel_code_generator/arguments.py
diff --git a/datamodel_code_generator/format.py → src/datamodel_code_generator/format.py b/datamodel_code_generator/format.py → src/datamodel_code_generator/format.py
diff --git a/datamodel_code_generator/http.py → src/datamodel_code_generator/http.py b/datamodel_code_generator/http.py → src/datamodel_code_generator/http.py
diff --git a/datamodel_code_generator/imports.py → src/datamodel_code_generator/imports.py b/datamodel_code_generator/imports.py → src/datamodel_code_generator/imports.py
diff --git a/datamodel_code_generator/model/__init__.py → ...atamodel_code_generator/model/__init__.py b/datamodel_code_generator/model/__init__.py → ...atamodel_code_generator/model/__init__.py
diff --git a/datamodel_code_generator/model/base.py → src/datamodel_code_generator/model/base.py b/datamodel_code_generator/model/base.py → src/datamodel_code_generator/model/base.py
diff --git a/datamodel_code_generator/model/dataclass.py → ...tamodel_code_generator/model/dataclass.py b/datamodel_code_generator/model/dataclass.py → ...tamodel_code_generator/model/dataclass.py
diff --git a/datamodel_code_generator/model/enum.py → src/datamodel_code_generator/model/enum.py b/datamodel_code_generator/model/enum.py → src/datamodel_code_generator/model/enum.py
diff --git a/datamodel_code_generator/model/imports.py → ...datamodel_code_generator/model/imports.py b/datamodel_code_generator/model/imports.py → ...datamodel_code_generator/model/imports.py
diff --git a/datamodel_code_generator/model/msgspec.py → ...datamodel_code_generator/model/msgspec.py b/datamodel_code_generator/model/msgspec.py → ...datamodel_code_generator/model/msgspec.py
diff --git a/...code_generator/model/pydantic/__init__.py → ...code_generator/model/pydantic/__init__.py b/...code_generator/model/pydantic/__init__.py → ...code_generator/model/pydantic/__init__.py
diff --git a/...de_generator/model/pydantic/base_model.py → ...de_generator/model/pydantic/base_model.py b/...de_generator/model/pydantic/base_model.py → ...de_generator/model/pydantic/base_model.py
diff --git a/...erator/model/pydantic/custom_root_type.py → ...erator/model/pydantic/custom_root_type.py b/...erator/model/pydantic/custom_root_type.py → ...erator/model/pydantic/custom_root_type.py
diff --git a/...ode_generator/model/pydantic/dataclass.py → ...ode_generator/model/pydantic/dataclass.py b/...ode_generator/model/pydantic/dataclass.py → ...ode_generator/model/pydantic/dataclass.py
diff --git a/..._code_generator/model/pydantic/imports.py → ..._code_generator/model/pydantic/imports.py b/..._code_generator/model/pydantic/imports.py → ..._code_generator/model/pydantic/imports.py
diff --git a/...el_code_generator/model/pydantic/types.py → ...el_code_generator/model/pydantic/types.py b/...el_code_generator/model/pydantic/types.py → ...el_code_generator/model/pydantic/types.py
diff --git a/...e_generator/model/pydantic_v2/__init__.py → ...e_generator/model/pydantic_v2/__init__.py b/...e_generator/model/pydantic_v2/__init__.py → ...e_generator/model/pydantic_v2/__init__.py
diff --git a/...generator/model/pydantic_v2/base_model.py → ...generator/model/pydantic_v2/base_model.py b/...generator/model/pydantic_v2/base_model.py → ...generator/model/pydantic_v2/base_model.py
diff --git a/...de_generator/model/pydantic_v2/imports.py → ...de_generator/model/pydantic_v2/imports.py b/...de_generator/model/pydantic_v2/imports.py → ...de_generator/model/pydantic_v2/imports.py
diff --git a/...generator/model/pydantic_v2/root_model.py → ...generator/model/pydantic_v2/root_model.py b/...generator/model/pydantic_v2/root_model.py → ...generator/model/pydantic_v2/root_model.py
diff --git a/...code_generator/model/pydantic_v2/types.py → ...code_generator/model/pydantic_v2/types.py b/...code_generator/model/pydantic_v2/types.py → ...code_generator/model/pydantic_v2/types.py
diff --git a/datamodel_code_generator/model/rootmodel.py → ...tamodel_code_generator/model/rootmodel.py b/datamodel_code_generator/model/rootmodel.py → ...tamodel_code_generator/model/rootmodel.py
diff --git a/datamodel_code_generator/model/scalar.py → src/datamodel_code_generator/model/scalar.py b/datamodel_code_generator/model/scalar.py → src/datamodel_code_generator/model/scalar.py
diff --git a/...code_generator/model/template/Enum.jinja2 → ...code_generator/model/template/Enum.jinja2 b/...code_generator/model/template/Enum.jinja2 → ...code_generator/model/template/Enum.jinja2
diff --git a/...de_generator/model/template/Scalar.jinja2 → ...de_generator/model/template/Scalar.jinja2 b/...de_generator/model/template/Scalar.jinja2 → ...de_generator/model/template/Scalar.jinja2
diff --git a/...generator/model/template/TypedDict.jinja2 → ...generator/model/template/TypedDict.jinja2 b/...generator/model/template/TypedDict.jinja2 → ...generator/model/template/TypedDict.jinja2
diff --git a/...ator/model/template/TypedDictClass.jinja2 → ...ator/model/template/TypedDictClass.jinja2 b/...ator/model/template/TypedDictClass.jinja2 → ...ator/model/template/TypedDictClass.jinja2
diff --git a/...r/model/template/TypedDictFunction.jinja2 → ...r/model/template/TypedDictFunction.jinja2 b/...r/model/template/TypedDictFunction.jinja2 → ...r/model/template/TypedDictFunction.jinja2
diff --git a/...ode_generator/model/template/Union.jinja2 → ...ode_generator/model/template/Union.jinja2 b/...ode_generator/model/template/Union.jinja2 → ...ode_generator/model/template/Union.jinja2
diff --git a/...generator/model/template/dataclass.jinja2 → ...generator/model/template/dataclass.jinja2 b/...generator/model/template/dataclass.jinja2 → ...generator/model/template/dataclass.jinja2
diff --git a/...e_generator/model/template/msgspec.jinja2 → ...e_generator/model/template/msgspec.jinja2 b/...e_generator/model/template/msgspec.jinja2 → ...e_generator/model/template/msgspec.jinja2
diff --git a/.../model/template/pydantic/BaseModel.jinja2 → .../model/template/pydantic/BaseModel.jinja2 b/.../model/template/pydantic/BaseModel.jinja2 → .../model/template/pydantic/BaseModel.jinja2
diff --git a/...l/template/pydantic/BaseModel_root.jinja2 → ...l/template/pydantic/BaseModel_root.jinja2 b/...l/template/pydantic/BaseModel_root.jinja2 → ...l/template/pydantic/BaseModel_root.jinja2
diff --git a/...tor/model/template/pydantic/Config.jinja2 → ...tor/model/template/pydantic/Config.jinja2 b/...tor/model/template/pydantic/Config.jinja2 → ...tor/model/template/pydantic/Config.jinja2
diff --git a/.../model/template/pydantic/dataclass.jinja2 → .../model/template/pydantic/dataclass.jinja2 b/.../model/template/pydantic/dataclass.jinja2 → .../model/template/pydantic/dataclass.jinja2
diff --git a/...del/template/pydantic_v2/BaseModel.jinja2 → ...del/template/pydantic_v2/BaseModel.jinja2 b/...del/template/pydantic_v2/BaseModel.jinja2 → ...del/template/pydantic_v2/BaseModel.jinja2
diff --git a/...el/template/pydantic_v2/ConfigDict.jinja2 → ...el/template/pydantic_v2/ConfigDict.jinja2 b/...el/template/pydantic_v2/ConfigDict.jinja2 → ...el/template/pydantic_v2/ConfigDict.jinja2
diff --git a/...del/template/pydantic_v2/RootModel.jinja2 → ...del/template/pydantic_v2/RootModel.jinja2 b/...del/template/pydantic_v2/RootModel.jinja2 → ...del/template/pydantic_v2/RootModel.jinja2
diff --git a/...code_generator/model/template/root.jinja2 → ...code_generator/model/template/root.jinja2 b/...code_generator/model/template/root.jinja2 → ...code_generator/model/template/root.jinja2
diff --git a/datamodel_code_generator/model/typed_dict.py → ...amodel_code_generator/model/typed_dict.py b/datamodel_code_generator/model/typed_dict.py → ...amodel_code_generator/model/typed_dict.py
diff --git a/datamodel_code_generator/model/types.py → src/datamodel_code_generator/model/types.py b/datamodel_code_generator/model/types.py → src/datamodel_code_generator/model/types.py
diff --git a/datamodel_code_generator/model/union.py → src/datamodel_code_generator/model/union.py b/datamodel_code_generator/model/union.py → src/datamodel_code_generator/model/union.py
diff --git a/datamodel_code_generator/parser/__init__.py → ...tamodel_code_generator/parser/__init__.py b/datamodel_code_generator/parser/__init__.py → ...tamodel_code_generator/parser/__init__.py
diff --git a/datamodel_code_generator/parser/base.py → src/datamodel_code_generator/parser/base.py b/datamodel_code_generator/parser/base.py → src/datamodel_code_generator/parser/base.py
diff --git a/datamodel_code_generator/parser/graphql.py → ...atamodel_code_generator/parser/graphql.py b/datamodel_code_generator/parser/graphql.py → ...atamodel_code_generator/parser/graphql.py
diff --git a/...model_code_generator/parser/jsonschema.py → ...model_code_generator/parser/jsonschema.py b/...model_code_generator/parser/jsonschema.py → ...model_code_generator/parser/jsonschema.py
diff --git a/datamodel_code_generator/parser/openapi.py → ...atamodel_code_generator/parser/openapi.py b/datamodel_code_generator/parser/openapi.py → ...atamodel_code_generator/parser/openapi.py
diff --git a/datamodel_code_generator/py.typed → src/datamodel_code_generator/py.typed b/datamodel_code_generator/py.typed → src/datamodel_code_generator/py.typed
diff --git a/datamodel_code_generator/pydantic_patch.py → ...atamodel_code_generator/pydantic_patch.py b/datamodel_code_generator/pydantic_patch.py → ...atamodel_code_generator/pydantic_patch.py
diff --git a/datamodel_code_generator/reference.py → src/datamodel_code_generator/reference.py b/datamodel_code_generator/reference.py → src/datamodel_code_generator/reference.py
diff --git a/datamodel_code_generator/types.py → src/datamodel_code_generator/types.py b/datamodel_code_generator/types.py → src/datamodel_code_generator/types.py
diff --git a/datamodel_code_generator/util.py → src/datamodel_code_generator/util.py b/datamodel_code_generator/util.py → src/datamodel_code_generator/util.py
diff --git a/tox.ini b/tox.ini
@@ -1,7 +1,7 @@
 [tox]
 requires =
     tox>=4.24.1
-    tox-uv>=1.12
+    tox-uv>=1.23
 env_list =
     fix
     3.13
@@ -33,8 +33,9 @@ set_env =
     COVERAGE_FILE = {work_dir}/.coverage.{env_name}
 commands =
     pytest {posargs: \
-      --cov datamodel_code_generator --cov {tox_root}{/}tests \
-      --cov-config=pyproject.toml --no-cov-on-fail --cov-report term-missing:skip-covered --cov-context=test \
+      -p no:codspeed --benchmark-disable \
+      --cov {env_site_packages_dir}{/}datamodel_code_generator --cov {tox_root}{/}tests \
+      --cov-config=pyproject.toml --no-cov-on-fail --cov-report term-missing:skip-covered \
       --cov-report html:{env_tmp_dir}{/}htmlcov \
       --cov-report xml:{env:COVERAGE_XML:{work_dir}{/}coverage.{env_name}.xml} \
       --junitxml {work_dir}{/}junit.{env_name}.xml \
@@ -72,13 +73,13 @@ parallel_show_output = true
 pass_env =
     DIFF_AGAINST
 set_env =
-    COVERAGE_FILE = {toxworkdir}/.coverage
+    COVERAGE_FILE = {work_dir}/.coverage
 commands =
     coverage combine
     coverage report --skip-covered --show-missing
-    coverage xml -o {toxworkdir}/coverage.xml
-    coverage html -d {toxworkdir}/htmlcov
-    diff-cover --compare-branch {env:DIFF_AGAINST:origin/main} {toxworkdir}/coverage.xml
+    coverage xml -o {work_dir}/coverage.xml
+    coverage html -d {work_dir}/htmlcov
+    diff-cover --compare-branch {env:DIFF_AGAINST:origin/main} {work_dir}/coverage.xml
 depends =
     3.13
     3.12
@@ -103,7 +104,7 @@ dependency_groups = pkg-meta
 [testenv:type]
 description = run type check on code base
 commands =
-    pyright datamodel_code_generator
+    pyright src
 dependency_groups = type
 
 [testenv:docs]

diff --git a/uv.lock b/uv.lock