working test wireup

Author: anupkalburgi

dbldatagen/spec/compat.py

@@ -0,0 +1,18 @@
+# This module acts as a compatibility layer for Pydantic V1 and V2.
+
+try:
+    # This will succeed on environments with Pydantic V2.x
+    # It imports the V1 API that is bundled within V2.
+    from pydantic.v1 import BaseModel, Field, validator, constr
+
+except ImportError:
+    # This will be executed on environments with only Pydantic V1.x
+    from pydantic import BaseModel, Field, validator, constr
+
+# In your application code, do this:
+# from .compat import BaseModel
+# NOT this:
+# from pydantic import BaseModel
+
+# FastAPI Notes
+# https://github.com/fastapi/fastapi/blob/master/fastapi/_compat.py

dbldatagen/spec/generator.py

@@ -0,0 +1,69 @@
+from .compat import BaseModel
+from typing import Dict, Optional, Union, Any
+
+
+# class ColumnDefinition(BaseModel):
+#     name: str
+#     type: Optional[DbldatagenBasicType] = None
+#     primary: bool = False
+#     options: Optional[Dict[str, Any]] = {}
+#     nullable: Optional[bool] = False
+#     omit: Optional[bool] = False
+#     baseColumn: Optional[str] = "id"
+#     baseColumnType: Optional[str] = "auto"
+
+#     @model_validator(mode="after")
+#     def check_constraints(self):
+#         if self.primary:
+#             if "min" in self.options or "max" in self.options:
+#                 raise ValueError(
+#                     f"Primary column '{self.name}' cannot have min/max options.")
+#             if self.nullable:
+#                 raise ValueError(
+#                     f"Primary column '{self.name}' cannot be nullable.")
+#             if self.primary and self.type is None:
+#                 raise ValueError(
+#                     f"Primary column '{self.name}' must have a type defined.")
+#         return self
+
+
+# class TableDefinition(BaseModel):
+#     number_of_rows: int
+#     partitions: Optional[int] = None
+#     columns: List[ColumnDefinition]
+
+
+# class DatagenSpec(BaseModel):
+#     tables: Dict[str, TableDefinition]
+#     output_destination: Optional[Union[UCSchemaTarget, FilePathTarget]] = None
+#     generator_options: Optional[Dict[str, Any]] = {}
+#     intended_for_databricks: Optional[bool] = None
+
+
+
+#     def display_all_tables(self):
+#         for table_name, table_def in self.tables.items():
+#             print(f"Table: {table_name}")
+
+#             if self.output_destination:
+#                 output = f"{self.output_destination}"
+#                 display(HTML(f"<strong>Output destination:</strong> {output}"))
+#             else:
+#                 message = (
+#                     "<strong>Output destination:</strong> "
+#                     "<span style='color: red; font-weight: bold;'>None</span><br>"
+#                     "<span style='color: gray;'>Set it using the <code>output_destination</code> "
+#                     "attribute on your <code>DatagenSpec</code> object "
+#                     "(e.g., <code>my_spec.output_destination = UCSchemaTarget(...)</code>).</span>"
+#                 )
+#                 display(HTML(message))
+
+#             df = pd.DataFrame([col.dict() for col in table_def.columns])
+#             try:
+#                 display(df)
+#             except NameError:
+#                 print(df.to_string())
+
+
+class DatagenSpec(BaseModel):
+    name: str

makefile

@@ -8,7 +8,7 @@ clean:
 
 .venv/bin/python:
 	pip install hatch
-	hatch env create
+	hatch env create test-pydantic.pydantic==1.10.6-v1
 
 dev: .venv/bin/python
 	@hatch run which python
@@ -20,7 +20,7 @@ fmt:
 	hatch run fmt
 
 test:
-	hatch run test
+	hatch run test-pydantic:test
 
 test-coverage:
 	make test && open htmlcov/index.html

pyproject.toml

@@ -106,18 +106,31 @@ dependencies = [
 ]
 
 python="3.10"
-
-# store virtual env as the child of this folder. Helps VSCode (and PyCharm) to run better
 path = ".venv"
 
 [tool.hatch.envs.default.scripts]
 test    = "pytest tests/ -n 10 --cov --cov-report=html --timeout 600 --durations 20"
-fmt         = ["ruff check . --fix",
-               "mypy .",
-               "pylint --output-format=colorized -j 0 dbldatagen tests"]
-verify      = ["ruff check .",
-               "mypy .",
-               "pylint --output-format=colorized -j 0 dbldatagen tests"]
+fmt     = [
+    "ruff check . --fix",
+    "mypy .",
+    "pylint --output-format=colorized -j 0 dbldatagen tests"
+]
+verify  = [
+    "ruff check .",
+    "mypy .",
+    "pylint --output-format=colorized -j 0 dbldatagen tests"
+]
+
+
+[tool.hatch.envs.test-pydantic]
+template = "default"
+matrix = [
+    { pydantic_version = ["1.10.6", "2.8.2"] }
+]
+extra-dependencies = [
+    "pydantic=={matrix:pydantic_version}"
+]
+
 
 # Ruff configuration - replaces flake8, isort, pydocstyle, etc.
 [tool.ruff]

tests/test_spec.py

@@ -0,0 +1,7 @@
+from dbldatagen.spec.generator import DatagenSpec
+
+def test_spec():
+    spec = DatagenSpec(name="test_spec")
+    assert spec.name == "test_spec"
+
+