Consinstent BaseColumnMock naming

Author: Somtom

docsource/faq.md

@@ -17,15 +17,15 @@ You might want to create a settings class as well in case you need some specific
 
 ### Create your `ColumnMocks`
 
-Your database system might support specific database types. In order to make them available as column types, you can use the `sql_mock.column_mocks.ColumnMock` class as a base and inherit your specific column types from it.
+Your database system might support specific database types. In order to make them available as column types, you can use the `sql_mock.column_mocks.BaseColumnMock` class as a base and inherit your specific column types from it.
 For most of your column mocks you might only need to specify the `dtype` that should be used to parse the inputs.
 
-A good practise is to create a `ColumnMock` class that is specific to your database and inherit all your column types from it, e.g.:
+A good practise is to create a `BaseColumnMock` class that is specific to your database and inherit all your column types from it, e.g.:
 
 ```python
-from sql_mock.column_mocks import ColumnMock
+from sql_mock.column_mocks import BaseColumnMock
 
-class MyFanceDatabaseColumnMock(ColumnMock):
+class MyFanceDatabaseColumnMock(BaseColumnMock):
     # In case you need some specific logic that overwrites the default behavior, you can do so here
     pass
 
@@ -41,11 +41,11 @@ class String(MyFanceDatabaseColumnMock):
 There will definitely be folks in the community that are in the need of support for the database you just created all the setup for.
 Feel free to create a PR on this repository that we can start supporting your database system!
 
-## I am missing a specific ColumnMock type for my model fields
+## I am missing a specific BaseColumnMock type for my model fields
 
 We implemented some basic column types but it could happen that you don't find the one you need.
 Luckily, you can easily create those with the tools provided.
-The only thing you need to do is to inherit from the `ColumnMock` that is specific to your database system (e.g. `BigQueryColumnMock`) and write classes for the column mocks you are missing. Usually you only need to set the correct `dtype`. This would later be used in the `cast(col to <dtype>)` expression.
+The only thing you need to do is to inherit from the `BaseColumnMock` that is specific to your database system (e.g. `BigQueryColumnMock`) and write classes for the column mocks you are missing. Usually you only need to set the correct `dtype`. This would later be used in the `cast(col to <dtype>)` expression.
 
 ```python
 # Replace the import with the database system you are using

src/sql_mock/bigquery/column_mocks.py

@@ -1,7 +1,7 @@
-from sql_mock.column_mocks import ColumnMock
+from sql_mock.column_mocks import BaseColumnMock
 
 
-class BigQueryColumnMock(ColumnMock):
+class BigQueryColumnMock(BaseColumnMock):
     pass
 
 

src/sql_mock/clickhouse/column_mocks.py

@@ -1,7 +1,7 @@
-from sql_mock.column_mocks import ColumnMock
+from sql_mock.column_mocks import BaseColumnMock
 
 
-class ClickhouseColumnMock(ColumnMock):
+class ClickhouseColumnMock(BaseColumnMock):
     def __init__(self, default, nullable=False) -> None:
         super().__init__(default, nullable)
         if nullable:

src/sql_mock/column_mocks.py

@@ -2,7 +2,7 @@
 from sql_mock.constants import NO_INPUT, NoInput
 
 
-class ColumnMock:
+class BaseColumnMock:
     """
     Represents a mock column in a database table.
 
@@ -20,7 +20,7 @@ class ColumnMock:
 
     def __init__(self, default=None, nullable=False) -> None:
         """
-        Initialize a ColumnMock instance.
+        Initialize a BaseColumnMock instance.
 
         Args:
             default: The default value for the column.

src/sql_mock/redshift/column_mocks.py

@@ -1,7 +1,7 @@
-from sql_mock.column_mocks import ColumnMock
+from sql_mock.column_mocks import BaseColumnMock
 
 
-class RedshiftColumnMock(ColumnMock):
+class RedshiftColumnMock(BaseColumnMock):
     pass
 
 

src/sql_mock/snowflake/column_mocks.py

@@ -1,7 +1,7 @@
-from sql_mock.column_mocks import ColumnMock
+from sql_mock.column_mocks import BaseColumnMock
 
 
-class SnowflakeColumnMock(ColumnMock):
+class SnowflakeColumnMock(BaseColumnMock):
     pass
 
 

src/sql_mock/table_mocks.py

@@ -5,7 +5,7 @@
 from jinja2 import Template
 from pydantic import BaseModel, ConfigDict, SkipValidation
 
-from sql_mock.column_mocks import ColumnMock
+from sql_mock.column_mocks import BaseColumnMock
 from sql_mock.constants import NO_INPUT
 from sql_mock.helpers import (
     get_keys_from_list_of_dicts,
@@ -57,7 +57,7 @@ class SQLMockData(BaseModel):
 
     model_config = ConfigDict(arbitrary_types_allowed=True)
 
-    columns: dict[str, Type[ColumnMock]] = None
+    columns: dict[str, Type[BaseColumnMock]] = None
     data: list[dict] = None
     input_data: list[dict] = None
     rendered_query: str = None
@@ -95,7 +95,7 @@ def __init__(self, data: list[dict] = None, sql_mock_data: SQLMockData = None) -
             self._sql_mock_data = SQLMockData()
 
         self._sql_mock_data.columns = {
-            field: getattr(self, field) for field in dir(self) if isinstance(getattr(self, field), ColumnMock)
+            field: getattr(self, field) for field in dir(self) if isinstance(getattr(self, field), BaseColumnMock)
         }
 
         if data is not None:

tests/sql_mock/test_column_mocks.py

@@ -1,21 +1,21 @@
 import pytest
 
-from sql_mock.column_mocks import ColumnMock
+from sql_mock.column_mocks import BaseColumnMock
 
 
 def test_init_no_default_not_nullable():
     """
     ...then it should raise an error.
     """
     with pytest.raises(ValueError, match="Default cannot be None if column is not nullable"):
-        ColumnMock(default=None, nullable=False)
+        BaseColumnMock(default=None, nullable=False)
 
 
 def test_init_default_not_nullable():
     """
     ...then it should set the default value and nullable should be False.
     """
-    column = ColumnMock(default=42)
+    column = BaseColumnMock(default=42)
     assert column.default == 42
     assert not column.nullable
 
@@ -24,7 +24,7 @@ def test_init_default_nullable():
     """
     ...then it should set the default value and nullable should be True.
     """
-    column = ColumnMock(default="Hello", nullable=True)
+    column = BaseColumnMock(default="Hello", nullable=True)
     assert column.default == "Hello"
     assert column.nullable
 
@@ -33,7 +33,7 @@ def test_to_sql_with_value():
     """
     ...then it should return the SQL cast expression using the provided value.
     """
-    column = ColumnMock(default=3.14)
+    column = BaseColumnMock(default=3.14)
     sql = column.to_sql("price", value=42)
     assert sql == "cast('42' AS None) AS price"
 
@@ -43,7 +43,7 @@ def test_to_sql_without_value():
     ...then it should return the SQL cast expression using the default value.
     """
 
-    class ColumnTestMock(ColumnMock):
+    class ColumnTestMock(BaseColumnMock):
         dtype = "String"
 
     column = ColumnTestMock(default="OpenAI")
@@ -56,7 +56,7 @@ def test_to_sql_with_none_for_nullable_column():
     ...then it should return the SQL cast expression using the default value.
     """
 
-    class ColumnTestMock(ColumnMock):
+    class ColumnTestMock(BaseColumnMock):
         dtype = "String"
 
     column = ColumnTestMock(default="OpenAI", nullable=True)
@@ -69,7 +69,7 @@ def test_to_sql_without_value_and_no_default():
     ...then it should return the SQL cast expression using the default value.
     """
 
-    class ColumnTestMock(ColumnMock):
+    class ColumnTestMock(BaseColumnMock):
         dtype = "String"
 
     column = ColumnTestMock(default=None, nullable=True)
@@ -82,7 +82,7 @@ def test_to_sql_not_use_quotes_for_casting():
     ...then it should not quote the value in the cast expression.
     """
 
-    class ColumnTestMock(ColumnMock):
+    class ColumnTestMock(BaseColumnMock):
         dtype = "Integer"
         use_quotes_for_casting = False
 

tests/sql_mock/test_helpers.py

@@ -2,7 +2,7 @@
 import pytest
 import sqlglot
 
-from sql_mock.column_mocks import ColumnMock
+from sql_mock.column_mocks import BaseColumnMock
 from sql_mock.exceptions import ValidationError
 from sql_mock.helpers import (
     _validate_input_mocks_have_table_ref,
@@ -26,11 +26,11 @@ def _get_results(self):
         return []
 
 
-class IntTestColumn(ColumnMock):
+class IntTestColumn(BaseColumnMock):
     dtype = "Integer"
 
 
-class StringTestColumn(ColumnMock):
+class StringTestColumn(BaseColumnMock):
     dtype = "String"
 
 

tests/sql_mock/test_table_mocks.py

@@ -1,14 +1,14 @@
 import pytest
 
-from sql_mock.column_mocks import ColumnMock
+from sql_mock.column_mocks import BaseColumnMock
 from sql_mock.table_mocks import BaseTableMock, TableMockMeta, table_meta
 
 
-class IntTestColumn(ColumnMock):
+class IntTestColumn(BaseColumnMock):
     dtype = "Integer"
 
 
-class StringTestColumn(ColumnMock):
+class StringTestColumn(BaseColumnMock):
     dtype = "String"