jsonstat-validator 0.1.6__tar.gz → 0.2.0__tar.gz

{jsonstat_validator-0.1.6/jsonstat_validator.egg-info → jsonstat_validator-0.2.0}/PKG-INFO

@@ -1,6 +1,6 @@
 Metadata-Version: 2.4
 Name: jsonstat-validator
-Version: 0.1.6
+Version: 0.2.0
 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
@@ -30,11 +30,11 @@ Project-URL: Bug Tracker, https://github.com/ahmed-hassan19/jsonstat-validator/i
 Project-URL: Documentation, https://github.com/ahmed-hassan19/jsonstat-validator#readme
 Keywords: json-stat,validator,json,data-engineering,pydantic,python,fao
 Classifier: Programming Language :: Python :: 3
-Classifier: Programming Language :: Python :: 3.8
 Classifier: Programming Language :: Python :: 3.9
 Classifier: Programming Language :: Python :: 3.10
 Classifier: Programming Language :: Python :: 3.11
 Classifier: Programming Language :: Python :: 3.12
+Classifier: Programming Language :: Python :: 3.13
 Classifier: License :: OSI Approved :: MIT License
 Classifier: Operating System :: OS Independent
 Classifier: Topic :: Software Development :: Libraries :: Python Modules
@@ -42,7 +42,7 @@ Classifier: Topic :: Software Development :: Quality Assurance
 Requires-Python: >=3.8
 Description-Content-Type: text/markdown
 License-File: LICENSE
-Requires-Dist: pydantic<3.0.0,>=2.0.0
+Requires-Dist: pydantic==2.11.2
 Provides-Extra: dev
 Requires-Dist: pytest>=8.1.1; extra == "dev"
 Requires-Dist: build>=1.0.0; extra == "dev"

{jsonstat_validator-0.1.6 → jsonstat_validator-0.2.0}/jsonstat_validator/__init__.py

@@ -10,27 +10,14 @@ dimensions are organized in categories.
 For more information on JSON-stat, see: https://json-stat.org/
 """
 
-from jsonstat_validator.validator import (
-    Category,
-    Collection,
-    Dataset,
-    DatasetRole,
-    Dimension,
-    JSONStatSchema,
-    Link,
-    Unit,
-    validate_jsonstat,
-)
+from jsonstat_validator.models import Collection, Dataset, Dimension, JSONStatSchema
+from jsonstat_validator.validator import validate_jsonstat
 
-__version__ = "0.1.6"
+__version__ = "0.2.0"
 __all__ = [
     "Dataset",
     "Dimension",
     "Collection",
-    "Link",
-    "Unit",
-    "Category",
-    "DatasetRole",
     "JSONStatSchema",
     "validate_jsonstat",
 ]

jsonstat_validator-0.1.6/jsonstat_validator/validator.py → jsonstat_validator-0.2.0/jsonstat_validator/models.py

@@ -14,9 +14,9 @@ from typing import Any, Dict, List, Literal, Optional, Union
 from pydantic import (
     AnyUrl,
     BaseModel,
+    ConfigDict,
     Field,
     RootModel,
-    ValidationError,
     field_serializer,
     field_validator,
     model_validator,
@@ -46,6 +46,8 @@ class JSONStatBaseModel(BaseModel):
         """Convert AnyUrl to string, if it exists."""
         return str(href) if href else None
 
+    model_config = ConfigDict(extra="forbid", serialize_by_alias=True)
+
 
 class Unit(JSONStatBaseModel):
     """Unit of measurement of a dimension.
@@ -169,6 +171,14 @@ class Category(JSONStatBaseModel):
             "of a dimension with a metric role."
         ),
     )
+    note: Optional[Dict[str, List[str]]] = Field(
+        default=None,
+        description=(
+            "note allows to assign annotations to datasets (array), dimensions "
+            "(array) and categories (object). To assign annotations to individual "
+            "data, use status: https://json-stat.org/full/#status."
+        ),
+    )
 
     @model_validator(mode="after")
     def validate_category(self):
@@ -320,8 +330,9 @@ class Dimension(JSONStatBaseModel):
     note: Optional[List[str]] = Field(
         default=None,
         description=(
-            "Note allows to assign annotations to datasets (array), dimensions (array) "
-            "and categories (object)."
+            "note allows to assign annotations to datasets (array), dimensions "
+            "(array) and categories (object). To assign annotations to individual "
+            "data, use status: https://json-stat.org/full/#status."
         ),
     )
     updated: Optional[str] = Field(
@@ -417,8 +428,9 @@ class DatasetDimension(JSONStatBaseModel):
     note: Optional[List[str]] = Field(
         default=None,
         description=(
-            "Note allows to assign annotations to datasets (array), dimensions (array) "
-            "and categories (object)."
+            "note allows to assign annotations to datasets (array), dimensions "
+            "(array) and categories (object). To assign annotations to individual "
+            "data, use status: https://json-stat.org/full/#status."
         ),
     )
     updated: Optional[str] = Field(
@@ -597,8 +609,9 @@ class Dataset(JSONStatBaseModel):
     note: Optional[List[str]] = Field(
         default=None,
         description=(
-            "Note allows to assign annotations to datasets (array), dimensions (array) "
-            "and categories (object)."
+            "note allows to assign annotations to datasets (array), dimensions "
+            "(array) and categories (object). To assign annotations to individual "
+            "data, use status: https://json-stat.org/full/#status."
         ),
     )
     extension: Optional[Dict[str, Any]] = Field(
@@ -707,6 +720,19 @@ class Collection(JSONStatBaseModel):
             "(datasets, dimensions, collections)."
         ),
     )
+    source: Optional[str] = Field(
+        default=None,
+        description="It contains a language-dependent short text describing the source "
+        "of the collection.",
+    )
+    note: Optional[List[str]] = Field(
+        default=None,
+        description=(
+            "note allows to assign annotations to datasets (array), dimensions "
+            "(array) and categories (object). To assign annotations to individual "
+            "data, use status: https://json-stat.org/full/#status."
+        ),
+    )
     extension: Optional[Dict[str, Any]] = Field(
         default=None,
         description="Extension allows JSON-stat to be extended for particular needs. "
@@ -747,23 +773,3 @@ class JSONStatSchema(RootModel):
     def serialize_any_url(self, href: Optional[AnyUrl]) -> Optional[str]:
         """Convert AnyUrl to string, if it exists."""
         return str(href) if href else None
-
-
-def validate_jsonstat(data: Dict[str, Any]) -> bool:
-    """
-    Validate a JSON-stat 2.0 object against the specification.
-
-    Args:
-        data: A dictionary containing JSON-stat data
-
-    Returns:
-        bool: True if valid, raises ValueError otherwise
-
-    Raises:
-        ValueError: If the data does not conform to the JSON-stat specification
-    """
-    try:
-        JSONStatSchema(**data)
-        return True
-    except ValidationError as e:
-        raise ValueError(e) from e

jsonstat_validator-0.2.0/jsonstat_validator/validator.py

@@ -0,0 +1,70 @@
+from typing import Any, Dict
+
+from pydantic import ValidationError
+
+from jsonstat_validator.models import JSONStatSchema
+
+
+def format_error_location(loc: tuple) -> str:
+    """
+    Format error location to be more human-readable.
+
+    Args:
+        loc: Location tuple from ValidationError
+
+    Returns:
+        str: Formatted location string
+    """
+    parts = []
+    for item in loc:
+        if isinstance(item, int):
+            parts.append(f"[{item}]")
+        elif parts:
+            parts.append(f".{item}")
+        else:
+            parts.append(item)
+    return "".join(parts)
+
+
+def format_validation_errors(e: ValidationError) -> str:
+    """
+    Format ValidationError to be more human-readable.
+
+    Args:
+        e: ValidationError instance
+
+    Returns:
+        str: Formatted error message
+    """
+    errors = []
+    for error in e.errors():
+        # Create a simplified error object without input and url fields
+        loc = format_error_location(error["loc"])
+        msg = error["msg"]
+        type_str = error["type"]
+
+        errors.append(f"Error at '{loc}': {msg} (type={type_str})")
+
+    return "\n".join(errors)
+
+
+def validate_jsonstat(data: Dict[str, Any]) -> bool:
+    """
+    Validate a JSON-stat 2.0 object against the specification.
+
+    Args:
+        data: A dictionary containing JSON-stat data
+
+    Returns:
+        bool: True if valid, raises ValueError otherwise
+
+    Raises:
+        ValueError: If the data does not conform to the JSON-stat specification
+                   with a user-friendly error message
+    """
+    try:
+        JSONStatSchema.model_validate(data)
+        return True
+    except ValidationError as e:
+        error_message = format_validation_errors(e)
+        raise ValueError(f"JSON-stat validation failed:\n{error_message}") from None

{jsonstat_validator-0.1.6 → jsonstat_validator-0.2.0/jsonstat_validator.egg-info}/PKG-INFO

@@ -1,6 +1,6 @@
 Metadata-Version: 2.4
 Name: jsonstat-validator
-Version: 0.1.6
+Version: 0.2.0
 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
@@ -30,11 +30,11 @@ Project-URL: Bug Tracker, https://github.com/ahmed-hassan19/jsonstat-validator/i
 Project-URL: Documentation, https://github.com/ahmed-hassan19/jsonstat-validator#readme
 Keywords: json-stat,validator,json,data-engineering,pydantic,python,fao
 Classifier: Programming Language :: Python :: 3
-Classifier: Programming Language :: Python :: 3.8
 Classifier: Programming Language :: Python :: 3.9
 Classifier: Programming Language :: Python :: 3.10
 Classifier: Programming Language :: Python :: 3.11
 Classifier: Programming Language :: Python :: 3.12
+Classifier: Programming Language :: Python :: 3.13
 Classifier: License :: OSI Approved :: MIT License
 Classifier: Operating System :: OS Independent
 Classifier: Topic :: Software Development :: Libraries :: Python Modules
@@ -42,7 +42,7 @@ Classifier: Topic :: Software Development :: Quality Assurance
 Requires-Python: >=3.8
 Description-Content-Type: text/markdown
 License-File: LICENSE
-Requires-Dist: pydantic<3.0.0,>=2.0.0
+Requires-Dist: pydantic==2.11.2
 Provides-Extra: dev
 Requires-Dist: pytest>=8.1.1; extra == "dev"
 Requires-Dist: build>=1.0.0; extra == "dev"

{jsonstat_validator-0.1.6 → jsonstat_validator-0.2.0}/jsonstat_validator.egg-info/SOURCES.txt

@@ -5,6 +5,7 @@ pyproject.toml
 requirements.txt
 setup.py
 jsonstat_validator/__init__.py
+jsonstat_validator/models.py
 jsonstat_validator/validator.py
 jsonstat_validator.egg-info/PKG-INFO
 jsonstat_validator.egg-info/SOURCES.txt

{jsonstat_validator-0.1.6 → jsonstat_validator-0.2.0}/jsonstat_validator.egg-info/requires.txt

@@ -1,4 +1,4 @@
-pydantic<3.0.0,>=2.0.0
+pydantic==2.11.2
 
 [dev]
 pytest>=8.1.1

{jsonstat_validator-0.1.6 → jsonstat_validator-0.2.0}/pyproject.toml

@@ -4,7 +4,7 @@ build-backend = "setuptools.build_meta"
 
 [project]
 name = "jsonstat-validator"
-version = "0.1.6"
+version = "0.2.0"
 description = "A Python validator for the JSON-stat 2.0 standard format, based on Pydantic."
 readme = "README.md"
 authors = [
@@ -13,11 +13,11 @@ authors = [
 license = {file = "LICENSE"}
 classifiers = [
     "Programming Language :: Python :: 3",
-    "Programming Language :: Python :: 3.8",
     "Programming Language :: Python :: 3.9",
     "Programming Language :: Python :: 3.10",
     "Programming Language :: Python :: 3.11",
     "Programming Language :: Python :: 3.12",
+    "Programming Language :: Python :: 3.13",
     "License :: OSI Approved :: MIT License",
     "Operating System :: OS Independent",
     "Topic :: Software Development :: Libraries :: Python Modules",
@@ -26,7 +26,7 @@ classifiers = [
 keywords = ["json-stat", "validator", "json", "data-engineering", "pydantic", "python", "fao"]
 requires-python = ">=3.8"
 dependencies = [
-    "pydantic>=2.0.0,<3.0.0",
+    "pydantic==2.11.2",
 ]
 
 [project.optional-dependencies]
@@ -55,7 +55,7 @@ testpaths = ["tests"]
 
 [tool.black]
 line-length = 90
-target-version = ["py38", "py39", "py310", "py311", "py312"]
+target-version = ["py39", "py310", "py311", "py312", "py313"]
 include = '\.pyi?$'
 
 [tool.isort]

jsonstat_validator-0.2.0/requirements.txt

@@ -0,0 +1 @@
+pydantic==2.11.2

jsonstat_validator-0.1.6/requirements.txt

@@ -1 +0,0 @@
-pydantic==2.*