dapla-toolbelt-metadata 0.7.0__py3-none-any.whl → 0.7.2__py3-none-any.whl

dapla_metadata/variable_definitions/_generated/vardef_client/models/get_vardok_vardef_mapping_by_id200_response.py

@@ -0,0 +1,158 @@
+"""Internal Variable Definitions Administration API
+
+## Introduction  Variable Definitions are centralized definitions of concrete variables which are typically present in multiple datasets. Variable Definitions support standardization of data and metadata and facilitate sharing and joining of data by clarifying when variables have an identical definition.  ## Maintenance of Variable Definitions This API allows for creation, maintenance and access of Variable Definitions.  ### Ownership Creation and maintenance of variables may only be performed by Statistics Norway employees representing a specific Dapla team, who are defined as the owners of a given Variable Definition. The team an owner represents must be specified when making a request through the `active_group` query parameter. All maintenance is to be performed by the owners, with no intervention from administrators.  ### Status All Variable Definitions have an associated status. The possible values for status are `DRAFT`, `PUBLISHED_INTERNAL` and `PUBLISHED_EXTERNAL`.  #### Draft When a Variable Definition is created it is assigned the status `DRAFT`. Under this status the Variable Definition is:  - Only visible to Statistics Norway employees. - Mutable (it may be changed directly without need for versioning). - Not suitable to refer to from other systems.  This status may be changed to `PUBLISHED_INTERNAL` or `PUBLISHED_EXTERNAL` with a direct update.  #### Published Internal Under this status the Variable Definition is:  - Only visible to Statistics Norway employees. - Immutable (all changes are versioned). - Suitable to refer to in internal systems for statistics production. - Not suitable to refer to for external use (for example in Statistikkbanken).  This status may be changed to `PUBLISHED_EXTERNAL` by creating a Patch version.  #### Published External Under this status the Variable Definition is:  - Visible to the general public. - Immutable (all changes are versioned). - Suitable to refer to from any system.  This status may not be changed as it would break immutability. If a Variable Definition is no longer relevant then its period of validity should be ended by specifying a `valid_until` date in a Patch version.  ### Immutability Variable Definitions are immutable. This means that any changes must be performed in a strict versioning system. Consumers can avoid being exposed to breaking changes by specifying a `date_of_validity` when they request a Variable Definition.  #### Patches Patches are for changes which do not affect the fundamental meaning of the Variable Definition.  #### Validity Periods Validity Periods are versions with a period defined by a `valid_from` date and optionally a `valid_until` date. If the fundamental meaning of a Variable Definition is to be changed, it should be done by creating a new Validity Period.
+
+The version of the OpenAPI document: 0.1
+Contact: metadata@ssb.no
+Generated by OpenAPI Generator (https://openapi-generator.tech)
+
+Do not edit the class manually.
+"""
+
+from __future__ import annotations
+
+import json
+import pprint
+from typing import Any
+
+from pydantic import BaseModel
+from pydantic import ConfigDict
+from pydantic import ValidationError
+from pydantic import field_validator
+from typing_extensions import Self
+
+from ..models.complete_response import CompleteResponse
+from ..models.vardok_id_response import VardokIdResponse
+
+GETVARDOKVARDEFMAPPINGBYID200RESPONSE_ONE_OF_SCHEMAS = [
+    "CompleteResponse",
+    "VardokIdResponse",
+]
+
+
+class GetVardokVardefMappingById200Response(BaseModel):
+    """GetVardokVardefMappingById200Response"""
+
+    # data type: CompleteResponse
+    oneof_schema_1_validator: CompleteResponse | None = None
+    # data type: VardokIdResponse
+    oneof_schema_2_validator: VardokIdResponse | None = None
+    actual_instance: CompleteResponse | VardokIdResponse | None = None
+    one_of_schemas: set[str] = {"CompleteResponse", "VardokIdResponse"}
+
+    model_config = ConfigDict(
+        validate_assignment=True,
+        protected_namespaces=(),
+    )
+
+    def __init__(self, *args, **kwargs) -> None:
+        if args:
+            if len(args) > 1:
+                raise ValueError(
+                    "If a position argument is used, only 1 is allowed to set `actual_instance`"
+                )
+            if kwargs:
+                raise ValueError(
+                    "If a position argument is used, keyword arguments cannot be used."
+                )
+            super().__init__(actual_instance=args[0])
+        else:
+            super().__init__(**kwargs)
+
+    @field_validator("actual_instance")
+    def actual_instance_must_validate_oneof(cls, v):
+        instance = GetVardokVardefMappingById200Response.model_construct()
+        error_messages = []
+        match = 0
+        # validate data type: CompleteResponse
+        if not isinstance(v, CompleteResponse):
+            error_messages.append(
+                f"Error! Input type `{type(v)}` is not `CompleteResponse`"
+            )
+        else:
+            match += 1
+        # validate data type: VardokIdResponse
+        if not isinstance(v, VardokIdResponse):
+            error_messages.append(
+                f"Error! Input type `{type(v)}` is not `VardokIdResponse`"
+            )
+        else:
+            match += 1
+        if match > 1:
+            # more than 1 match
+            raise ValueError(
+                "Multiple matches found when setting `actual_instance` in GetVardokVardefMappingById200Response with oneOf schemas: CompleteResponse, VardokIdResponse. Details: "
+                + ", ".join(error_messages)
+            )
+        if match == 0:
+            # no match
+            raise ValueError(
+                "No match found when setting `actual_instance` in GetVardokVardefMappingById200Response with oneOf schemas: CompleteResponse, VardokIdResponse. Details: "
+                + ", ".join(error_messages)
+            )
+        return v
+
+    @classmethod
+    def from_dict(cls, obj: str | dict[str, Any]) -> Self:
+        return cls.from_json(json.dumps(obj))
+
+    @classmethod
+    def from_json(cls, json_str: str) -> Self:
+        """Returns the object represented by the json string"""
+        instance = cls.model_construct()
+        error_messages = []
+        match = 0
+
+        # deserialize data into CompleteResponse
+        try:
+            instance.actual_instance = CompleteResponse.from_json(json_str)
+            match += 1
+        except (ValidationError, ValueError) as e:
+            error_messages.append(str(e))
+        # deserialize data into VardokIdResponse
+        try:
+            instance.actual_instance = VardokIdResponse.from_json(json_str)
+            match += 1
+        except (ValidationError, ValueError) as e:
+            error_messages.append(str(e))
+
+        if match > 1:
+            # more than 1 match
+            raise ValueError(
+                "Multiple matches found when deserializing the JSON string into GetVardokVardefMappingById200Response with oneOf schemas: CompleteResponse, VardokIdResponse. Details: "
+                + ", ".join(error_messages)
+            )
+        if match == 0:
+            # no match
+            raise ValueError(
+                "No match found when deserializing the JSON string into GetVardokVardefMappingById200Response with oneOf schemas: CompleteResponse, VardokIdResponse. Details: "
+                + ", ".join(error_messages)
+            )
+        return instance
+
+    def to_json(self) -> str:
+        """Returns the JSON representation of the actual instance"""
+        if self.actual_instance is None:
+            return "null"
+
+        if hasattr(self.actual_instance, "to_json") and callable(
+            self.actual_instance.to_json
+        ):
+            return self.actual_instance.to_json()
+        return json.dumps(self.actual_instance)
+
+    def to_dict(self) -> dict[str, Any] | CompleteResponse | VardokIdResponse | None:
+        """Returns the dict representation of the actual instance"""
+        if self.actual_instance is None:
+            return None
+
+        if hasattr(self.actual_instance, "to_dict") and callable(
+            self.actual_instance.to_dict
+        ):
+            return self.actual_instance.to_dict()
+        # primitive type
+        return self.actual_instance
+
+    def to_str(self) -> str:
+        """Returns the string representation of the actual instance"""
+        return pprint.pformat(self.model_dump())

dapla_metadata/variable_definitions/_generated/vardef_client/models/language_string_type.py

@@ -96,10 +96,6 @@ class LanguageStringType(BaseModel):
             return cls.model_validate(obj)
 
         _obj = cls.model_validate(
-            {
-                "nb": obj.get("nb"),
-                "nn": obj.get("nn"),
-                "en": obj.get("en"),
-            }
+            {"nb": obj.get("nb"), "nn": obj.get("nn"), "en": obj.get("en")}
         )
         return _obj

dapla_metadata/variable_definitions/_generated/vardef_client/models/owner.py

@@ -82,9 +82,6 @@ class Owner(BaseModel):
             return cls.model_validate(obj)
 
         _obj = cls.model_validate(
-            {
-                "team": obj.get("team"),
-                "groups": obj.get("groups"),
-            }
+            {"team": obj.get("team"), "groups": obj.get("groups")}
         )
         return _obj

dapla_metadata/variable_definitions/_generated/vardef_client/models/vardok_id_response.py

@@ -0,0 +1,81 @@
+"""Internal Variable Definitions Administration API
+
+## Introduction  Variable Definitions are centralized definitions of concrete variables which are typically present in multiple datasets. Variable Definitions support standardization of data and metadata and facilitate sharing and joining of data by clarifying when variables have an identical definition.  ## Maintenance of Variable Definitions This API allows for creation, maintenance and access of Variable Definitions.  ### Ownership Creation and maintenance of variables may only be performed by Statistics Norway employees representing a specific Dapla team, who are defined as the owners of a given Variable Definition. The team an owner represents must be specified when making a request through the `active_group` query parameter. All maintenance is to be performed by the owners, with no intervention from administrators.  ### Status All Variable Definitions have an associated status. The possible values for status are `DRAFT`, `PUBLISHED_INTERNAL` and `PUBLISHED_EXTERNAL`.  #### Draft When a Variable Definition is created it is assigned the status `DRAFT`. Under this status the Variable Definition is:  - Only visible to Statistics Norway employees. - Mutable (it may be changed directly without need for versioning). - Not suitable to refer to from other systems.  This status may be changed to `PUBLISHED_INTERNAL` or `PUBLISHED_EXTERNAL` with a direct update.  #### Published Internal Under this status the Variable Definition is:  - Only visible to Statistics Norway employees. - Immutable (all changes are versioned). - Suitable to refer to in internal systems for statistics production. - Not suitable to refer to for external use (for example in Statistikkbanken).  This status may be changed to `PUBLISHED_EXTERNAL` by creating a Patch version.  #### Published External Under this status the Variable Definition is:  - Visible to the general public. - Immutable (all changes are versioned). - Suitable to refer to from any system.  This status may not be changed as it would break immutability. If a Variable Definition is no longer relevant then its period of validity should be ended by specifying a `valid_until` date in a Patch version.  ### Immutability Variable Definitions are immutable. This means that any changes must be performed in a strict versioning system. Consumers can avoid being exposed to breaking changes by specifying a `date_of_validity` when they request a Variable Definition.  #### Patches Patches are for changes which do not affect the fundamental meaning of the Variable Definition.  #### Validity Periods Validity Periods are versions with a period defined by a `valid_from` date and optionally a `valid_until` date. If the fundamental meaning of a Variable Definition is to be changed, it should be done by creating a new Validity Period.
+
+The version of the OpenAPI document: 0.1
+Contact: metadata@ssb.no
+Generated by OpenAPI Generator (https://openapi-generator.tech)
+
+Do not edit the class manually.
+"""
+
+from __future__ import annotations
+
+import json
+import pprint
+import re  # noqa: F401
+from typing import Any
+from typing import ClassVar
+
+from pydantic import BaseModel
+from pydantic import ConfigDict
+from pydantic import StrictStr
+from typing_extensions import Self
+
+
+class VardokIdResponse(BaseModel):
+    """VardokIdResponse"""
+
+    vardok_id: StrictStr
+    __properties: ClassVar[list[str]] = ["vardok_id"]
+
+    model_config = ConfigDict(
+        populate_by_name=True,
+        validate_assignment=True,
+        protected_namespaces=(),
+    )
+
+    def to_str(self) -> str:
+        """Returns the string representation of the model using alias"""
+        return pprint.pformat(self.model_dump(by_alias=True))
+
+    def to_json(self) -> str:
+        """Returns the JSON representation of the model using alias"""
+        # TODO: pydantic v2: use .model_dump_json(by_alias=True, exclude_unset=True) instead
+        return json.dumps(self.to_dict())
+
+    @classmethod
+    def from_json(cls, json_str: str) -> Self | None:
+        """Create an instance of VardokIdResponse from a JSON string"""
+        return cls.from_dict(json.loads(json_str))
+
+    def to_dict(self) -> dict[str, Any]:
+        """Return the dictionary representation of the model using alias.
+
+        This has the following differences from calling pydantic's
+        `self.model_dump(by_alias=True)`:
+
+        * `None` is only added to the output dict for nullable fields that
+          were set at model initialization. Other fields with value `None`
+          are ignored.
+        """
+        excluded_fields: set[str] = set([])
+
+        _dict = self.model_dump(
+            by_alias=True,
+            exclude=excluded_fields,
+            exclude_none=True,
+        )
+        return _dict
+
+    @classmethod
+    def from_dict(cls, obj: dict[str, Any] | None) -> Self | None:
+        """Create an instance of VardokIdResponse from a dict"""
+        if obj is None:
+            return None
+
+        if not isinstance(obj, dict):
+            return cls.model_validate(obj)
+
+        _obj = cls.model_validate({"vardok_id": obj.get("vardok_id")})
+        return _obj

dapla_metadata/variable_definitions/_generated/vardef_client/models/vardok_vardef_id_pair_response.py

@@ -0,0 +1,84 @@
+"""Internal Variable Definitions Administration API
+
+## Introduction  Variable Definitions are centralized definitions of concrete variables which are typically present in multiple datasets. Variable Definitions support standardization of data and metadata and facilitate sharing and joining of data by clarifying when variables have an identical definition.  ## Maintenance of Variable Definitions This API allows for creation, maintenance and access of Variable Definitions.  ### Ownership Creation and maintenance of variables may only be performed by Statistics Norway employees representing a specific Dapla team, who are defined as the owners of a given Variable Definition. The team an owner represents must be specified when making a request through the `active_group` query parameter. All maintenance is to be performed by the owners, with no intervention from administrators.  ### Status All Variable Definitions have an associated status. The possible values for status are `DRAFT`, `PUBLISHED_INTERNAL` and `PUBLISHED_EXTERNAL`.  #### Draft When a Variable Definition is created it is assigned the status `DRAFT`. Under this status the Variable Definition is:  - Only visible to Statistics Norway employees. - Mutable (it may be changed directly without need for versioning). - Not suitable to refer to from other systems.  This status may be changed to `PUBLISHED_INTERNAL` or `PUBLISHED_EXTERNAL` with a direct update.  #### Published Internal Under this status the Variable Definition is:  - Only visible to Statistics Norway employees. - Immutable (all changes are versioned). - Suitable to refer to in internal systems for statistics production. - Not suitable to refer to for external use (for example in Statistikkbanken).  This status may be changed to `PUBLISHED_EXTERNAL` by creating a Patch version.  #### Published External Under this status the Variable Definition is:  - Visible to the general public. - Immutable (all changes are versioned). - Suitable to refer to from any system.  This status may not be changed as it would break immutability. If a Variable Definition is no longer relevant then its period of validity should be ended by specifying a `valid_until` date in a Patch version.  ### Immutability Variable Definitions are immutable. This means that any changes must be performed in a strict versioning system. Consumers can avoid being exposed to breaking changes by specifying a `date_of_validity` when they request a Variable Definition.  #### Patches Patches are for changes which do not affect the fundamental meaning of the Variable Definition.  #### Validity Periods Validity Periods are versions with a period defined by a `valid_from` date and optionally a `valid_until` date. If the fundamental meaning of a Variable Definition is to be changed, it should be done by creating a new Validity Period.
+
+The version of the OpenAPI document: 0.1
+Contact: metadata@ssb.no
+Generated by OpenAPI Generator (https://openapi-generator.tech)
+
+Do not edit the class manually.
+"""
+
+from __future__ import annotations
+
+import json
+import pprint
+import re  # noqa: F401
+from typing import Any
+from typing import ClassVar
+
+from pydantic import BaseModel
+from pydantic import ConfigDict
+from pydantic import StrictStr
+from typing_extensions import Self
+
+
+class VardokVardefIdPairResponse(BaseModel):
+    """VardokVardefIdPairResponse"""
+
+    vardok_id: StrictStr
+    vardef_id: StrictStr
+    __properties: ClassVar[list[str]] = ["vardok_id", "vardef_id"]
+
+    model_config = ConfigDict(
+        populate_by_name=True,
+        validate_assignment=True,
+        protected_namespaces=(),
+    )
+
+    def to_str(self) -> str:
+        """Returns the string representation of the model using alias"""
+        return pprint.pformat(self.model_dump(by_alias=True))
+
+    def to_json(self) -> str:
+        """Returns the JSON representation of the model using alias"""
+        # TODO: pydantic v2: use .model_dump_json(by_alias=True, exclude_unset=True) instead
+        return json.dumps(self.to_dict())
+
+    @classmethod
+    def from_json(cls, json_str: str) -> Self | None:
+        """Create an instance of VardokVardefIdPairResponse from a JSON string"""
+        return cls.from_dict(json.loads(json_str))
+
+    def to_dict(self) -> dict[str, Any]:
+        """Return the dictionary representation of the model using alias.
+
+        This has the following differences from calling pydantic's
+        `self.model_dump(by_alias=True)`:
+
+        * `None` is only added to the output dict for nullable fields that
+          were set at model initialization. Other fields with value `None`
+          are ignored.
+        """
+        excluded_fields: set[str] = set([])
+
+        _dict = self.model_dump(
+            by_alias=True,
+            exclude=excluded_fields,
+            exclude_none=True,
+        )
+        return _dict
+
+    @classmethod
+    def from_dict(cls, obj: dict[str, Any] | None) -> Self | None:
+        """Create an instance of VardokVardefIdPairResponse from a dict"""
+        if obj is None:
+            return None
+
+        if not isinstance(obj, dict):
+            return cls.model_validate(obj)
+
+        _obj = cls.model_validate(
+            {"vardok_id": obj.get("vardok_id"), "vardef_id": obj.get("vardef_id")}
+        )
+        return _obj

dapla_metadata/variable_definitions/_utils/variable_definition_files.py

@@ -1,6 +1,7 @@
 """Utilities for writing and reading existing variable definition files."""
 
 import logging
+from io import StringIO
 from os import PathLike
 from pathlib import Path
 from typing import Any
@@ -19,6 +20,7 @@ from dapla_metadata.variable_definitions._utils.files import (
     _model_to_yaml_with_comments,
 )
 from dapla_metadata.variable_definitions._utils.files import configure_yaml
+from dapla_metadata.variable_definitions._utils.files import pre_process_data
 
 logger = logging.getLogger(__name__)
 
@@ -118,3 +120,24 @@ def _read_file_to_model(
         msg = f"Could not read data from {file_path}"
         raise FileNotFoundError(msg)
     return model
+
+
+def _convert_to_yaml_output(model: BaseModel) -> str:
+    """Convert a Pydantic model to YAML format.
+
+    Args:
+        model: A Pydantic model instance
+
+    Returns:
+        YAML string representation of the model
+    """
+    stream = StringIO()
+    with YAML(output=stream) as yaml:
+        configure_yaml(yaml)
+        data = model.model_dump(
+            mode="json",
+            serialize_as_any=True,
+            warnings="error",
+        )
+        yaml.dump(pre_process_data(data))
+    return stream.getvalue()

dapla_metadata/variable_definitions/vardef.py

@@ -12,9 +12,15 @@ from dapla_metadata.variable_definitions._generated.vardef_client.api.draft_vari
 from dapla_metadata.variable_definitions._generated.vardef_client.api.variable_definitions_api import (
     VariableDefinitionsApi,
 )
+from dapla_metadata.variable_definitions._generated.vardef_client.models.complete_response import (
+    CompleteResponse,
+)
 from dapla_metadata.variable_definitions._generated.vardef_client.models.draft import (
     Draft,
 )
+from dapla_metadata.variable_definitions._generated.vardef_client.models.vardok_id_response import (
+    VardokIdResponse,
+)
 from dapla_metadata.variable_definitions._utils import config
 from dapla_metadata.variable_definitions._utils._client import VardefClient
 from dapla_metadata.variable_definitions._utils.template_files import (
@@ -29,6 +35,8 @@ from dapla_metadata.variable_definitions._utils.variable_definition_files import
 from dapla_metadata.variable_definitions.exceptions import VariableNotFoundError
 from dapla_metadata.variable_definitions.exceptions import vardef_exception_handler
 from dapla_metadata.variable_definitions.exceptions import vardef_file_error_handler
+from dapla_metadata.variable_definitions.vardok_id import VardokId
+from dapla_metadata.variable_definitions.vardok_vardef_id_pair import VardokVardefIdPair
 from dapla_metadata.variable_definitions.variable_definition import VariableDefinition
 
 logger = logging.getLogger(__name__)
@@ -171,6 +179,76 @@ class Vardef:
         )
         return migrated_variable
 
+    @classmethod
+    @vardef_exception_handler
+    def list_vardok_vardef_mapping(cls) -> list[VardokVardefIdPair]:
+        """List the mapping between vardok and vardef.
+
+        Returns:
+            List[VardokVardefIdPair]: The list with mappings between Vardok and Vardef
+        """
+        return [
+            VardokVardefIdPair.from_model(definition)
+            for definition in DataMigrationApi(
+                VardefClient.get_client(),
+            ).get_vardok_vardef_mapping()
+        ]
+
+    @classmethod
+    @vardef_exception_handler
+    def get_variable_definition_by_vardok_id(
+        cls,
+        vardok_id: str,
+    ) -> VariableDefinition:
+        """Get a Variable Definition by its Vardok ID.
+
+        Args:
+            vardok_id (str): The Vardok ID of the desired Variable Definition
+
+        Returns:
+            VariableDefinition: The Variable Definition.
+
+        Raises:
+            TypeError: If the incorrect type is returned.
+        """
+        raw_response = DataMigrationApi(
+            VardefClient.get_client()
+        ).get_vardok_vardef_mapping_by_id(
+            vardok_id,
+        )
+
+        if isinstance(raw_response.actual_instance, CompleteResponse):
+            return VariableDefinition.from_model(raw_response.actual_instance)
+        msg = "Unexpected response type"
+        raise TypeError(msg)
+
+    @classmethod
+    @vardef_exception_handler
+    def get_vardok_id_by_short_name(
+        cls,
+        short_name: str,
+    ) -> VardokId:
+        """Retrieve a Vardok id by short name.
+
+        Args:
+            short_name (str): The short name of the desired Variable Definition
+
+        Raises:
+            TypeError: If the incorrect type is returned.
+        """
+        variable_definition = cls.get_variable_definition_by_shortname(short_name)
+
+        raw_response = DataMigrationApi(
+            VardefClient.get_client()
+        ).get_vardok_vardef_mapping_by_id(
+            variable_definition.id,
+        )
+
+        if isinstance(raw_response.actual_instance, VardokIdResponse):
+            return VardokId.from_model(raw_response.actual_instance)
+        msg = "Unexpected response type"
+        raise TypeError(msg)
+
     @classmethod
     @vardef_exception_handler
     def list_variable_definitions(
@@ -235,7 +313,7 @@ class Vardef:
         short_name: str,
         date_of_validity: date | None = None,
     ) -> VariableDefinition:
-        """Retrieve a Variable Definition by ID or short name.
+        """Retrieve a Variable Definition by short name.
 
         Args:
             short_name (str): The short name of the Variable Definition.

dapla_metadata/variable_definitions/vardok_id.py

@@ -0,0 +1,44 @@
+import logging
+from pathlib import Path
+
+from pydantic import ConfigDict
+from pydantic import PrivateAttr
+
+from dapla_metadata.variable_definitions._generated.vardef_client.models.vardok_id_response import (
+    VardokIdResponse,
+)
+from dapla_metadata.variable_definitions._utils.variable_definition_files import (
+    _convert_to_yaml_output,
+)
+
+logger = logging.getLogger(__name__)
+
+
+class VardokId(VardokIdResponse):
+    """A Vardok id.
+
+    - Provides access to the Vardok id filed.
+    - Provides methods allowing maintenance for nicer output of the Vardok id.
+
+    Args:
+        VardokIdResponse: The Pydantic model superclass, representing a Vardok id response.
+    """
+
+    _file_path: Path | None = PrivateAttr(None)
+
+    model_config = ConfigDict(use_enum_values=True, str_strip_whitespace=True)
+
+    @staticmethod
+    def from_model(
+        model: VardokIdResponse,
+    ) -> "VardokId":
+        """Create a VariableDefinition instance from a CompleteResponse."""
+        return VardokId.model_construct(**model.model_dump())
+
+    def __str__(self) -> str:
+        """Format as indented YAML."""
+        return _convert_to_yaml_output(self)
+
+    def __repr__(self) -> str:
+        """Format as indented YAML."""
+        return _convert_to_yaml_output(self)

dapla_metadata/variable_definitions/vardok_vardef_id_pair.py

@@ -0,0 +1,43 @@
+import logging
+from pathlib import Path
+
+from pydantic import ConfigDict
+from pydantic import PrivateAttr
+
+from dapla_metadata.variable_definitions._generated.vardef_client.models.vardok_vardef_id_pair_response import (
+    VardokVardefIdPairResponse,
+)
+from dapla_metadata.variable_definitions._utils.variable_definition_files import (
+    _convert_to_yaml_output,
+)
+
+logger = logging.getLogger(__name__)
+
+
+class VardokVardefIdPair(VardokVardefIdPairResponse):
+    """A Vardok id.
+
+    - Provides access to the fields of a Vardok Vardef id pair.
+    - Provides methods allowing for nicer output of the Vardok Vardef id pair.
+
+    Args:
+        VardokVardefIdPairResponse: The Pydantic model superclass, representing a Vardok Vardef id pair response.
+    """
+
+    _file_path: Path | None = PrivateAttr(None)
+    model_config = ConfigDict(use_enum_values=True, str_strip_whitespace=True)
+
+    @staticmethod
+    def from_model(
+        model: VardokVardefIdPairResponse,
+    ) -> "VardokVardefIdPair":
+        """Create a VardokVardefIdPair instance from a VardokVardefIdPairResponse."""
+        return VardokVardefIdPair.model_construct(**model.model_dump())
+
+    def __str__(self) -> str:
+        """Format as indented YAML."""
+        return _convert_to_yaml_output(self)
+
+    def __repr__(self) -> str:
+        """Format as indented YAML."""
+        return _convert_to_yaml_output(self)

dapla_metadata/variable_definitions/variable_definition.py

@@ -1,10 +1,8 @@
 import logging
 from datetime import date
-from io import StringIO
 from os import PathLike
 from pathlib import Path
 
-import ruamel.yaml
 from pydantic import ConfigDict
 from pydantic import PrivateAttr
 
@@ -34,8 +32,9 @@ from dapla_metadata.variable_definitions._generated.vardef_client.models.variabl
 )
 from dapla_metadata.variable_definitions._utils import config
 from dapla_metadata.variable_definitions._utils._client import VardefClient
-from dapla_metadata.variable_definitions._utils.files import configure_yaml
-from dapla_metadata.variable_definitions._utils.files import pre_process_data
+from dapla_metadata.variable_definitions._utils.variable_definition_files import (
+    _convert_to_yaml_output,
+)
 from dapla_metadata.variable_definitions._utils.variable_definition_files import (
     _read_file_to_model,
 )
@@ -399,20 +398,8 @@ class VariableDefinition(CompleteResponse):
 
     def __str__(self) -> str:
         """Format as indented YAML."""
-        return self._convert_to_yaml_output()
+        return _convert_to_yaml_output(self)
 
     def __repr__(self) -> str:
         """Format as indented YAML."""
-        return self._convert_to_yaml_output()
-
-    def _convert_to_yaml_output(self) -> str:
-        stream = StringIO()
-        with ruamel.yaml.YAML(output=stream) as yaml:
-            configure_yaml(yaml)
-            data = self.model_dump(
-                mode="json",
-                serialize_as_any=True,
-                warnings="error",
-            )
-            yaml.dump(pre_process_data(data))
-        return stream.getvalue()
+        return _convert_to_yaml_output(self)

{dapla_toolbelt_metadata-0.7.0.dist-info → dapla_toolbelt_metadata-0.7.2.dist-info}/METADATA

@@ -1,6 +1,6 @@
 Metadata-Version: 2.3
 Name: dapla-toolbelt-metadata
-Version: 0.7.0
+Version: 0.7.2
 Summary: Dapla Toolbelt Metadata
 License: MIT
 Author: Team Metadata