jsonstat-validator 0.1.1__tar.gz → 0.1.3__tar.gz

{jsonstat_validator-0.1.1/jsonstat_validator.egg-info → jsonstat_validator-0.1.3}/PKG-INFO

@@ -1,6 +1,6 @@
 Metadata-Version: 2.2
 Name: jsonstat-validator
-Version: 0.1.1
+Version: 0.1.3
 Summary: A Python validator for the JSON-stat 2.0 standard format, based on Pydantic.
 Author-email: Ahmed Hassan <ahmedhassan.ahmed@fao.org>
 License: # MIT License
@@ -76,6 +76,8 @@ Please note that this implementation is intentionally more strict than the offic
 
 This dataset would be considered valid by the official JSON-stat validator tool, but will fail validation in this package because it violates the rule in the `dataset.size` section of the specification stating that: `size has the same number of elements and in the same order as in id`.
 
+Additionally, we enforce the `role` field as required when class=`dataset`.
+
 ## Table of Contents
 
 - [Installation](#installation)

{jsonstat_validator-0.1.1 → jsonstat_validator-0.1.3}/README.md

@@ -23,6 +23,8 @@ Please note that this implementation is intentionally more strict than the offic
 
 This dataset would be considered valid by the official JSON-stat validator tool, but will fail validation in this package because it violates the rule in the `dataset.size` section of the specification stating that: `size has the same number of elements and in the same order as in id`.
 
+Additionally, we enforce the `role` field as required when class=`dataset`.
+
 ## Table of Contents
 
 - [Installation](#installation)

{jsonstat_validator-0.1.1 → jsonstat_validator-0.1.3}/jsonstat_validator/validator.py

@@ -177,6 +177,15 @@ class Category(JSONStatBaseModel):
         if not self.index and not self.label:
             raise ValueError("At least one of `index` or `label` is required.")
 
+        # Ensure index and label have the same keys if both are dictionaries
+        if self.index and self.label:
+            if isinstance(self.index, dict) and isinstance(self.label, dict):
+                if set(self.index.keys()) != set(self.label.keys()):
+                    raise ValueError(
+                        "If `index` and `label` are both dictionaries, "
+                        "they must have the same keys."
+                    )
+
         # Ensure coordinates are a dictionary where keys are category IDs
         # and values are an array of two numbers (longitude, latitude).
         if self.coordinates:
@@ -300,7 +309,7 @@ class Dimension(JSONStatBaseModel):
         default=None,
         description=(
             "It is used to provide a list of links related to a dataset or a dimension, "
-            "sorted by relation (see relation ID)."
+            "sorted by relation (see https://json-stat.org/full/#relationid)."
         ),
     )
     note: Optional[List[str]] = Field(
@@ -344,6 +353,113 @@ class Dimension(JSONStatBaseModel):
         return v
 
 
+class DatasetDimension(JSONStatBaseModel):
+    """Dataset dimension.
+
+    A dimension model for when the dimension is a child of a Dataset
+    as it has different validation rules than a root Dimension.
+    """
+
+    version: Optional[str] = Field(
+        default=None,
+        description=(
+            "It declares the JSON-stat version of the response. The goal "
+            "of this property is to help clients parsing that particular response."
+        ),
+    )
+    class_: Optional[str] = Field(
+        default="dataset_dimension",
+        alias="class",
+        description=(
+            "JSON-stat supports several classes of responses. "
+            "Possible values of class are: dataset, dimension and collection. "
+            "This is an addition to the standard JSON-stat classes to allow for "
+            "different validation rules for dataset dimensions."
+        ),
+        exclude=True,
+        init=False,
+        frozen=True,
+    )
+    label: Optional[str] = Field(
+        default=None,
+        description=(
+            "It is used to assign a very short (one line) descriptive text to IDs "
+            "at different levels of the response tree. It is language-dependent."
+        ),
+    )
+    category: Optional[Category] = Field(
+        default=None,
+        description=(
+            "It is used to describe the possible values of a dimension. "
+            "It is language-dependent."
+        ),
+    )
+    href: Optional[AnyUrl] = Field(
+        default=None,
+        description=(
+            "It specifies a URL. Providers can use this property to avoid "
+            "sending information that is shared between different requests "
+            "(for example, dimensions)."
+        ),
+    )
+    link: Optional[Dict[str, List[Union[Link, JSONStatSchema]]]] = Field(
+        default=None,
+        description=(
+            "It is used to provide a list of links related to a dataset or a dimension, "
+            "sorted by relation (see https://json-stat.org/full/#relationid)."
+        ),
+    )
+    note: Optional[List[str]] = Field(
+        default=None,
+        description=(
+            "Note allows to assign annotations to datasets (array), dimensions (array) "
+            "and categories (object)."
+        ),
+    )
+    updated: Optional[str] = Field(
+        default=None,
+        description=(
+            "It contains the update time of the dataset. It is a string representing "
+            "a date in an ISO 8601 format recognized by the Javascript Date.parse "
+            "method (see ECMA-262 Date Time String Format: "
+            "https://262.ecma-international.org/6.0/#sec-date-time-string-format)."
+        ),
+    )
+    source: Optional[str] = Field(
+        default=None,
+        description=(
+            "It contains a language-dependent short text describing the source "
+            "of the dataset."
+        ),
+    )
+    extension: Optional[Dict[str, Any]] = Field(
+        default=None,
+        description=(
+            "Extension allows JSON-stat to be extended for particular needs. "
+            "Providers are free to define where they include this property and "
+            "what children are allowed in each case."
+        ),
+    )
+
+    @field_validator("updated", mode="after")
+    @classmethod
+    def validate_updated_date(cls, v: Optional[str]):
+        """Validates the updated date is in ISO 8601 format."""
+        if v and not is_valid_iso_date(v):
+            raise ValueError(f"Updated date: '{v}' is an invalid ISO 8601 format.")
+        return v
+
+    @model_validator(mode="after")
+    def validate_dataset_dimension(self):
+        """Dataset dimension-wide validation checks."""
+        if not self.category and not self.href:
+            raise ValueError(
+                "A category is required if a reference (href) is not provided."
+                "For an example, see: https://json-stat.org/full/#href"
+            )
+        return self
+
+
 class DatasetRole(JSONStatBaseModel):
     """Role of a dataset."""
 
@@ -372,6 +488,13 @@ class DatasetRole(JSONStatBaseModel):
         ),
     )
 
+    @model_validator(mode="after")
+    def validate_dataset_role(self):
+        """Dataset role-wide validation checks."""
+        if not self.time and not self.geo and not self.metric:
+            raise ValueError("At least one role must be provided.")
+        return self
+
 
 class Dataset(JSONStatBaseModel):
     """JSON-stat dataset."""
@@ -430,12 +553,13 @@ class Dataset(JSONStatBaseModel):
             "and in the same order as in id."
         ),
     )
-    role: Optional[DatasetRole] = Field(
+    role: DatasetRole = Field(
         default=None,
         description=(
             "It can be used to assign special roles to dimensions. "
             "At this moment, possible roles are: time, geo and metric. "
             "A role can be shared by several dimensions."
+            "We differ from the specification in that the role is required, not optional"
         ),
     )
     value: Union[
@@ -457,10 +581,11 @@ class Dataset(JSONStatBaseModel):
         ),
     )
 
-    dimension: Dict[str, Dimension] = Field(
+    dimension: Dict[str, DatasetDimension] = Field(
         description=(
             "The dimension property contains information about the dimensions of "
-            "the dataset. dimension must have properties (see dimension ID) with "
+            "the dataset. dimension must have properties "
+            "(see https://json-stat.org/full/#dimensionid) with "
             "the same names of each element in the id array."
         ),
     )
@@ -483,7 +608,7 @@ class Dataset(JSONStatBaseModel):
         default=None,
         description=(
             "It is used to provide a list of links related to a dataset or a dimension, "
-            "sorted by relation (see relation ID)."
+            "sorted by relation (see https://json-stat.org/full/#relationid)."
         ),
     )
 

{jsonstat_validator-0.1.1 → jsonstat_validator-0.1.3/jsonstat_validator.egg-info}/PKG-INFO

@@ -1,6 +1,6 @@
 Metadata-Version: 2.2
 Name: jsonstat-validator
-Version: 0.1.1
+Version: 0.1.3
 Summary: A Python validator for the JSON-stat 2.0 standard format, based on Pydantic.
 Author-email: Ahmed Hassan <ahmedhassan.ahmed@fao.org>
 License: # MIT License
@@ -76,6 +76,8 @@ Please note that this implementation is intentionally more strict than the offic
 
 This dataset would be considered valid by the official JSON-stat validator tool, but will fail validation in this package because it violates the rule in the `dataset.size` section of the specification stating that: `size has the same number of elements and in the same order as in id`.
 
+Additionally, we enforce the `role` field as required when class=`dataset`.
+
 ## Table of Contents
 
 - [Installation](#installation)

{jsonstat_validator-0.1.1 → jsonstat_validator-0.1.3}/pyproject.toml

@@ -4,7 +4,7 @@ build-backend = "setuptools.build_meta"
 
 [project]
 name = "jsonstat-validator"
-version = "0.1.1"
+version = "0.1.3"
 description = "A Python validator for the JSON-stat 2.0 standard format, based on Pydantic."
 readme = "README.md"
 authors = [