Update to Data Package (v2) (#19)

* Updated profiles

* Added `dialect.type` to the model

* Updatd `schema/field.missingValues`

* Added `categories/categoriesOrdered`

* Added metadata in table schema

* Commented out the properties that are not in v2 yet

dplib/models/dialect/dialect.py

@@ -18,6 +18,11 @@ class Dialect(Model):
     )
     """A profile URL"""
 
+    #  type: Optional[str] = None
+    """
+    Type of the dialect e.g. "delimited"
+    """
+
     title: Optional[str] = None
     """
     A string providing a title or one sentence description for this dialect

dplib/models/field/categories.py

@@ -0,0 +1,14 @@
+from typing import List, Optional, Union
+
+from ...system import Model
+
+
+class CategoryDict(Model):
+    value: str
+    label: Optional[str] = None
+
+
+ICategories = Union[
+    List[str],
+    List[CategoryDict],
+]

dplib/models/field/datatypes/base.py

@@ -1,11 +1,12 @@
 from __future__ import annotations
 
-from typing import Any, List, Optional
+from typing import Any, Optional
 
 import pydantic
 
 from .... import types
 from ....system import Model
+from ...missingValues import IMissingValues
 
 
 class BaseField(Model):
@@ -32,7 +33,7 @@ class BaseField(Model):
     A description for this field e.g. “The recipient of the funds”
     """
 
-    missingValues: List[str] = [""]
+    missingValues: IMissingValues = [""]
     """
     A list of field values to consider as null values
     """

dplib/models/field/datatypes/integer.py

@@ -4,6 +4,7 @@
 
 import pydantic
 
+from ..categories import ICategories
 from ..constraints import ValueConstraints
 from .base import BaseField
 
@@ -15,6 +16,17 @@ class IntegerField(BaseField):
     format: Optional[Literal["default"]] = None
     constraints: ValueConstraints[int] = pydantic.Field(default_factory=ValueConstraints)
 
+    categories: Optional[ICategories] = None
+    """
+    Property to restrict the field to a finite set of possible values
+    """
+
+    categoriesOrdered: bool = False
+    """
+    When categoriesOrdered is true, implementations SHOULD regard the order of
+    appearance of the values in the categories property as their natural order.
+    """
+
     groupChar: Optional[str] = None
     """
     String whose value is used to group digits for integer/number fields

dplib/models/field/datatypes/string.py

@@ -4,6 +4,7 @@
 
 import pydantic
 
+from ..categories import ICategories
 from ..constraints import StringConstraints
 from .base import BaseField
 
@@ -22,3 +23,14 @@ class StringField(BaseField):
     type: Literal["string"] = "string"
     format: Optional[IStringFormat] = None
     constraints: StringConstraints = pydantic.Field(default_factory=StringConstraints)
+
+    categories: Optional[ICategories] = None
+    """
+    Property to restrict the field to a finite set of possible values
+    """
+
+    categoriesOrdered: bool = False
+    """
+    When categoriesOrdered is true, implementations SHOULD regard the order of
+    appearance of the values in the categories property as their natural order.
+    """

dplib/models/missingValues.py

@@ -0,0 +1,14 @@
+from typing import List, Optional, Union
+
+from ..system import Model
+
+
+class MissingValueDict(Model):
+    value: str
+    label: Optional[str] = None
+
+
+IMissingValues = Union[
+    List[str],
+    List[MissingValueDict],
+]

dplib/models/schema/__spec__/test_schema.py

@@ -88,7 +88,7 @@ def test_schema_to_dict():
     assert schema.to_dict() == {
         "$schema": settings.PROFILE_CURRENT_SCHEMA,
     }
-    schema.missingValues.append("x")
+    schema.missingValues.append("x")  # type: ignore
     assert schema.to_dict() == {
         "$schema": settings.PROFILE_CURRENT_SCHEMA,
         "missingValues": ["", "x"],

dplib/models/schema/schema.py

@@ -6,7 +6,10 @@
 
 from ... import settings, types
 from ...system import Model
+
+#  from ..contributor import Contributor
 from ..field import IField
+from ..missingValues import IMissingValues
 from .foreignKey import ForeignKey
 from .types import IFieldsMatch
 
@@ -20,17 +23,47 @@ class Schema(Model):
     )
     """A profile URL"""
 
-    title: Optional[str] = None
+    #  name: Optional[str] = None
+    """
+    A simple name or identifier as for Data Package
+    """
+
+    #  title: Optional[str] = None
     """
     A string providing a title or one sentence description for this schema
     """
 
-    description: Optional[str] = None
+    #  description: Optional[str] = None
     """
     A description of the schema. The description MUST be markdown formatted —
     this also allows for simple plain text as plain text is itself valid markdown.
     """
 
+    #  homepage: Optional[str] = None
+    """
+    A URL for the home on the web that is related to this data package.
+    """
+
+    #  keywords: List[str] = []
+    """
+    The `keywords` property is a list of short keywords related to the schema.
+    """
+
+    #  examples: List[dict[str, str]] = []
+    """
+    The `examples` property contains links to example data resources.
+    """
+
+    #  version: Optional[str] = None
+    """
+    The `version` property stores the version of the schema
+    """
+
+    #  contributors: List[Contributor] = []
+    """
+    The people or organizations who contributed to this Table Schema.
+    """
+
     fields: List[IField] = []
     """
     List of fields in the table schema
@@ -42,7 +75,7 @@ class Schema(Model):
     are defined by the fieldsMatch property.
     """
 
-    missingValues: List[str] = [""]
+    missingValues: IMissingValues = [""]
     """
     A list of field values to consider as null values
     """