Merge pull request #8 from tophat/rename

feat: Rename PostgresJSONB to JSONB and PostgresUUID to UUID

README.md

@@ -26,7 +26,7 @@ python -m pip install ormar-postgres-extensions
 
 ### Fields
 
-Two native PG fields are provided. The `PostgresJSONB` and `PostgresUUID` types map to native `JSONB` and `UUID` data types respectively. Using these in an Ormar model is as simple as importing the fields and using them in the model.
+Two native PG fields are provided. The `JSONB` and `UUID` types map to native `JSONB` and `UUID` data types respectively. Using these in an Ormar model is as simple as importing the fields and using them in the model.
 
 ```python
 from uuid import UUID

src/ormar_postgres_extensions/__init__.py

@@ -1,4 +1,4 @@
 from .fields import (  # noqa: F401
-    PostgresJSONB,
-    PostgresUUID,
+    JSONB,
+    UUID,
 )

src/ormar_postgres_extensions/fields/__init__.py

@@ -1,2 +1,2 @@
-from .jsonb import PostgresJSONB  # noqa: F401
-from .uuid import PostgresUUID  # noqa: F401
+from .jsonb import JSONB  # noqa: F401
+from .uuid import UUID  # noqa: F401

src/ormar_postgres_extensions/fields/jsonb.py

@@ -9,7 +9,7 @@ class PostgresJSONBTypeDecorator(TypeDecorator):
     impl = postgresql.JSONB
 
 
-class PostgresJSONB(ormar.JSON):
+class JSONB(ormar.JSON):
     """
     Custom JSON field uses a native PG JSONB type
     """

src/ormar_postgres_extensions/fields/uuid.py

@@ -39,7 +39,7 @@ def process_result_value(
         return value
 
 
-class PostgresUUID(ormar.UUID):
+class UUID(ormar.UUID):
     """
     Custom UUID field for the schema that uses a native PG UUID type
     """

tests/fields/test_jsonb.py

@@ -4,7 +4,7 @@
 import ormar
 import pytest
 
-from ormar_postgres_extensions.fields import PostgresJSONB
+from ormar_postgres_extensions.fields import JSONB
 from tests.database import (
     database,
     metadata,
@@ -17,7 +17,7 @@ class Meta:
         metadata = metadata
 
     id: int = ormar.Integer(primary_key=True)
-    data: dict = PostgresJSONB()
+    data: dict = JSONB()
 
 
 class NullableJSONBTestModel(ormar.Model):
@@ -26,7 +26,7 @@ class Meta:
         metadata = metadata
 
     id: int = ormar.Integer(primary_key=True)
-    data: Optional[dict] = PostgresJSONB(nullable=True)
+    data: Optional[dict] = JSONB(nullable=True)
 
 
 @pytest.mark.asyncio

tests/fields/test_uuid.py

@@ -7,7 +7,7 @@
 import ormar
 import pytest
 
-from ormar_postgres_extensions.fields import PostgresUUID
+from ormar_postgres_extensions.fields import UUID as UUIDField
 from tests.database import (
     database,
     metadata,
@@ -20,7 +20,7 @@ class Meta:
         metadata = metadata
 
     id: int = ormar.Integer(primary_key=True)
-    uid: UUID = PostgresUUID(default=uuid4)
+    uid: UUID = UUIDField(default=uuid4)
 
 
 class NullableUUIDTestModel(ormar.Model):
@@ -29,7 +29,7 @@ class Meta:
         metadata = metadata
 
     id: int = ormar.Integer(primary_key=True)
-    uid: Optional[UUID] = PostgresUUID(nullable=True)
+    uid: Optional[UUID] = UUIDField(nullable=True)
 
 
 @pytest.mark.asyncio