fix: migrate from Pydantic v1 .dict() to v2 .model_dump() for iscc-schema compatibility

Replace deprecated skip_defaults parameter with exclude_none and by_alias
in model_dump() calls. Update test expectations for new iscc-schema 0.5.0
versioned URLs. Includes formatting fixes from linter.

Author: titusz

develop/format_openapi.py

@@ -2,7 +2,6 @@
 import pathlib
 import yaml
 
-
 HERE = pathlib.Path(__file__).parent.absolute()
 OPENAPI = HERE.parent / "iscc_web/static/docs/openapi.yaml"
 

develop/lf.py

@@ -1,4 +1,5 @@
 """Poor Windows Users :) - Convert line endings to LF"""
+
 import pathlib
 
 HERE = pathlib.Path(__file__).parent.parent.absolute()

iscc_web/api/common.py

@@ -1,4 +1,5 @@
 """Common helper functions"""
+
 from blacksheep import Request
 import shutil
 from aiofiles.os import wrap

iscc_web/api/iscc.py

@@ -50,4 +50,6 @@ async def create_iscc(self, request: Request):
         location = f"{base_url(request)}/media/{result.media_id}"
         proc_result.media_id = result.media_id
         proc_result.content = location
-        return self.created(location=location_header, value=proc_result.dict(skip_defaults=False))
+        return self.created(
+            location=location_header, value=proc_result.model_dump(exclude_none=True, by_alias=True)
+        )

iscc_web/api/metadata.py

@@ -29,7 +29,7 @@ async def extract(self, media_id: str, pool: Pool):
 
         loop = asyncio.get_event_loop()
         metadata = await loop.run_in_executor(pool, idk.extract_metadata, file_path)
-        cleaned = metadata.dict(
+        cleaned = metadata.model_dump(
             include={
                 "name",
                 "description",
@@ -42,7 +42,7 @@ async def extract(self, media_id: str, pool: Pool):
             }
         )
         obj = InlineMetadata(**cleaned)
-        return self.json(obj.dict(exclude_none=True))
+        return self.json(obj.model_dump(exclude_none=True))
 
     @post("{mid:media_id}")
     async def embed(self, request: Request, media_id: str, meta: InlineMetadata, pool: Pool):
@@ -89,4 +89,6 @@ async def embed(self, request: Request, media_id: str, meta: InlineMetadata, poo
         location_header = f"/api/v1/media/{new_media_id}".encode("ascii")
         proc_result.media_id = new_media_id
         proc_result.content = location
-        return self.created(location=location_header, value=proc_result.dict(skip_defaults=False))
+        return self.created(
+            location=location_header, value=proc_result.model_dump(exclude_none=True, by_alias=True)
+        )

iscc_web/api/schema.py

@@ -1,11 +1,10 @@
 # generated by datamodel-codegen:
 #   filename:  openapi.yaml
-#   version:   0.30.1
+#   version:   0.55.0
 
 from __future__ import annotations
 
-from enum import Enum
-from typing import List, Optional, Union
+from enum import StrEnum
 
 from pydantic import AnyUrl, BaseModel, Field, RootModel, confloat, conint, constr
 
@@ -21,10 +20,7 @@ class MediaID(RootModel[constr(pattern=r"[a-v0-9]{13}$", min_length=13, max_leng
 class Iscc(RootModel[constr(pattern=r"^ISCC:[A-Z2-7]{10,73}$", min_length=15, max_length=73)]):
     root: constr(pattern=r"^ISCC:[A-Z2-7]{10,73}$", min_length=15, max_length=73) = Field(
         ...,
-        description=(
-            "An **ISCC** in canonical representation. This is the minimal required field for a"
-            " valid ISCC Metadata object."
-        ),
+        description="An **ISCC** in canonical representation. This is the minimal required field for a valid ISCC Metadata object.",
         examples=["ISCC:KACYPXW445FTYNJ3CYSXHAFJMA2HUWULUNRFE3BLHRSCXYH2M5AEGQY"],
     )
 
@@ -34,13 +30,11 @@ class UploadResponse(BaseModel):
     Information required to download the newly created media resource.
     """
 
-    content: Optional[str] = Field(
-        None, examples=["http://localhost:8000/api/v1/media/061knt35ejv6o"]
-    )
-    media_id: Optional[MediaID] = None
+    content: str | None = Field(None, examples=["http://localhost:8000/api/v1/media/061knt35ejv6o"])
+    media_id: MediaID | None = None
 
 
-class FieldType(Enum):
+class FieldType(StrEnum):
     """
     The type of digital content according to schema.org classes (TextDigitalDocument, ImageObject, AudioObject, VideoObject).
     """
@@ -57,108 +51,82 @@ class BasicMetadata(BaseModel):
     Minimal ISCC Metadata
     """
 
-    field_context: Optional[AnyUrl] = Field(
+    field_context: AnyUrl | None = Field(
         None,
         alias="@context",
         description="The [JSON-LD](https://json-ld.org/) Context URI for ISCC metadata.",
         examples=["http://purl.org/iscc/context/0.4.0.jsonld"],
     )
-    field_type: Optional[FieldType] = Field(
+    field_type: FieldType | None = Field(
         "CreativeWork",
         alias="@type",
-        description=(
-            "The type of digital content according to schema.org classes (TextDigitalDocument,"
-            " ImageObject, AudioObject, VideoObject)."
-        ),
+        description="The type of digital content according to schema.org classes (TextDigitalDocument, ImageObject, AudioObject, VideoObject).",
     )
-    field_schema: Optional[AnyUrl] = Field(
+    field_schema: AnyUrl | None = Field(
         None,
         alias="$schema",
         description="The [JSON Schema](https://json-schema.org/) URI for ISCC metadata.",
         examples=["http://purl.org/iscc/schema/0.4.0.json"],
     )
-    iscc: Optional[Iscc] = None
+    iscc: Iscc | None = None
 
 
 class InlineMetadata(BaseModel):
     """
     Metadata intended to be embedded into the media asset.
     """
 
-    name: Optional[constr(max_length=128)] = Field(
+    name: constr(max_length=128) | None = Field(
         None,
-        description=(
-            "The title or name of the intangible creation manifested by the identified *digital"
-            " content*. **Used as input for ISCC Meta-Code generation**."
-        ),
+        description="The title or name of the intangible creation manifested by the identified *digital content*. **Used as input for ISCC Meta-Code generation**.",
         examples=["The Never Ending Story"],
     )
-    description: Optional[constr(max_length=4096)] = Field(
+    description: constr(max_length=4096) | None = Field(
         None,
-        description=(
-            "Description of the *digital content* identified by the **ISCC**. **Used as input for"
-            " ISCC Meta-Code generation**. Any user presentable text string (including Markdown"
-            " text) indicative of the identity  of the referent may be used."
-        ),
+        description="Description of the *digital content* identified by the **ISCC**. **Used as input for ISCC Meta-Code generation**. Any user presentable text string (including Markdown text) indicative of the identity  of the referent may be used.",
         examples=["a 1984 fantasy film co-written and directed by *Wolfgang Petersen*"],
     )
-    meta: Optional[constr(max_length=16384)] = Field(
+    meta: constr(max_length=16384) | None = Field(
         None,
         description="Subject, industry, or use-case specific metadata encoded as Data-URL.",
         examples=["data:application/json;charset=utf-8;base64,eyJleHRlbmRlZCI6Im1ldGFkYXRhIn0="],
     )
-    identifier: Optional[str] = Field(
+    identifier: str | None = Field(
         None,
-        description=(
-            "Other identifier(s) referencing the work, product or other abstraction of which the"
-            " referenced **digital content** is a full or partial manifestation."
-        ),
+        description="Other identifier(s) referencing the work, product or other abstraction of which the referenced **digital content** is a full or partial manifestation.",
     )
-    creator: Optional[str] = Field(
+    creator: str | None = Field(
         None,
         description="An entity primarily responsible for making the resource.",
         examples=["Joanne K. Rowling"],
     )
-    license: Optional[str] = Field(
+    license: str | None = Field(
         None,
         description="URI of license for the identified *digital content*.",
         examples=["https://example.com/license-terms-for-this-item"],
     )
-    acquire: Optional[AnyUrl] = Field(
+    acquire: AnyUrl | None = Field(
         None,
-        description=(
-            "This field must contain a valid URL referring to a page showing information about how"
-            " one can acquire a license for the item. This may be a page of a web shop or NFT"
-            " marketplace ready for providing a license."
-        ),
+        description="This field must contain a valid URL referring to a page showing information about how one can acquire a license for the item. This may be a page of a web shop or NFT marketplace ready for providing a license.",
         examples=["https://example.com/buy-license-for-item-here"],
     )
-    credit: Optional[str] = Field(
+    credit: str | None = Field(
         None,
-        description=(
-            "A line of text that you expect users of the image (such as Google Images) to display"
-            " alongside the image."
-        ),
+        description="A line of text that you expect users of the image (such as Google Images) to display alongside the image.",
         examples=["Frank Farian - Getty Images"],
     )
-    rights: Optional[str] = Field(
+    rights: str | None = Field(
         None,
-        description=(
-            "Contains any necessary copyright notice and should identify the current owner of the"
-            " copyright of this work with associated intellectual property rights."
-        ),
+        description="Contains any necessary copyright notice and should identify the current owner of the copyright of this work with associated intellectual property rights.",
         examples=["Copyright 2022 ISCC Foundation - www.iscc.codes"],
     )
-    keywords: Optional[Union[str, List[str]]] = Field(
+    keywords: str | list[str] | None = Field(
         None,
-        description=(
-            "Keywords or tags used to describe this content. Multiple entries in a keywords list"
-            " are typically delimited by commas."
-        ),
+        description="Keywords or tags used to describe this content. Multiple entries in a keywords list are typically delimited by commas.",
     )
 
 
-class Mode(Enum):
+class Mode(StrEnum):
     """
     The perceptual mode used to create the ISCC.
     """
@@ -175,53 +143,45 @@ class TechnicalMetadata(BaseModel):
     Technical ISCC Metadata automaticaly inferred from the media file by the ISCC processor
     """
 
-    mode: Optional[Mode] = Field(
+    mode: Mode | None = Field(
         None, description="The perceptual mode used to create the ISCC.", examples=["image"]
     )
-    filename: Optional[str] = Field(
+    filename: str | None = Field(
         None,
         description="Filename of the referenced **digital content**",
         examples=["your-media-file.jpg"],
     )
-    filesize: Optional[int] = Field(
-        None, description="File size of media asset in number of bytes."
-    )
-    mediatype: Optional[str] = Field(
+    filesize: int | None = Field(None, description="File size of media asset in number of bytes.")
+    mediatype: str | None = Field(
         None,
-        description=(
-            "An [IANA Media Type](https://www.iana.org/assignments/media-types/media-types.xhtml)"
-            " (MIME type)"
-        ),
+        description="An [IANA Media Type](https://www.iana.org/assignments/media-types/media-types.xhtml) (MIME type)",
         examples=["image/jpeg"],
     )
-    duration: Optional[int] = Field(
+    duration: int | None = Field(
         None, description="Duration of audio-visual media in seconds.", examples=[60]
     )
-    fps: Optional[confloat(ge=1.0)] = Field(
+    fps: confloat(ge=1.0) | None = Field(
         None, description="Frames per second of video assets.", examples=[24]
     )
-    width: Optional[int] = Field(
+    width: int | None = Field(
         None, description="Width of visual media in number of pixels.", examples=[640]
     )
-    height: Optional[conint(ge=1)] = Field(
+    height: conint(ge=1) | None = Field(
         None, description="Height of visual media in number of pixels.", examples=[480]
     )
-    characters: Optional[int] = Field(
+    characters: int | None = Field(
         None,
         description="Number of text characters (code points after Unicode normalization)",
         examples=[55689],
     )
-    language: Optional[str] = Field(
+    language: str | None = Field(
         None,
         description="Primary language of content [BCP 47](https://tools.ietf.org/search/bcp47).",
         examples=["en-US"],
     )
-    thumbnail: Optional[AnyUrl] = Field(
+    thumbnail: AnyUrl | None = Field(
         None,
-        description=(
-            "URI an autogenerated user-presentable thumbnail-image that serves as a preview of the"
-            " digital content. The URI may be a Data-URL RFC2397."
-        ),
+        description="URI an autogenerated user-presentable thumbnail-image that serves as a preview of the digital content. The URI may be a Data-URL RFC2397.",
         examples=["https://picsum.photos/200/300.jpg"],
     )
 
@@ -231,25 +191,25 @@ class Unit(BaseModel):
     An ISCC-UNIT in different representations
     """
 
-    iscc_unit: Optional[str] = Field(
+    iscc_unit: str | None = Field(
         None,
         description="Canonical representation of ISCC-UNIT",
         examples=["ISCC:AAA4RJYGHHVRCZ5T"],
     )
-    readable: Optional[str] = Field(
+    readable: str | None = Field(
         None,
         description="Human readable version of ISCC-UNIT",
         examples=["META-NONE-V0-64-c8a70639eb1167b3"],
     )
-    hash_hex: Optional[str] = Field(
+    hash_hex: str | None = Field(
         None, description="Hex representation of ISCC-BODY", examples=["e1fb7dc4e3dbb4be"]
     )
-    hash_uint: Optional[str] = Field(
+    hash_uint: str | None = Field(
         None,
         description="Unsigned integer representation of ISCC-BODY",
         examples=["16283747162278048958"],
     )
-    hash_bits: Optional[str] = Field(
+    hash_bits: str | None = Field(
         None,
         description="Bitpattern of ISCC-BODY",
         examples=["1110000111111011011111011100010011100011110110111011010010111110"],
@@ -261,25 +221,25 @@ class IsccDetail(BaseModel):
     Detailed decomposition of an ISCC
     """
 
-    iscc: Optional[Iscc] = None
-    readable: Optional[str] = Field(
+    iscc: Iscc | None = None
+    readable: str | None = Field(
         None,
         description="Human readable version of ISCC",
         examples=[
             "ISCC-VIDEO-V0-MSDI-c8a70639eb1167b367a9c3787c65c1e582e2e662f728b4fa42485e3a0a5d2f34"
         ],
     )
-    multiformat: Optional[str] = Field(
+    multiformat: str | None = Field(
         None,
         description="Multiformats representation base64url representation of ISCC",
         examples=["uzAFTBsinBjnrEWezZ6nDeHxlweWC4uZi9yi0-kJIXjoKXS80"],
     )
-    decomposed: Optional[str] = Field(
+    decomposed: str | None = Field(
         None,
         description="ISCC decomomposed into a dash seperated secquence of ISCC-UNITs",
         examples=["AAA4RJYGHHVRCZ5T-CMAWPKODPB6GLQPF-GAAYFYXGML3SRNH2-IAAUESC6HIFF2LZU"],
     )
-    units: Optional[List[Unit]] = Field(
+    units: list[Unit] | None = Field(
         None, description="Different representations of the individial units of the ISCC"
     )
 

iscc_web/asgi.py

@@ -1,4 +1,5 @@
 """ASGI entrypoint for uvicorn dev server."""
+
 from iscc_web.main import app
 
 application = app

iscc_web/vite.py

@@ -6,7 +6,6 @@
 from typing import Optional
 from iscc_web.options import opts
 
-
 PROJECT_DIR = pathlib.Path(__file__).parent.parent
 
 VITE_DEV_MODE = opts.environment == "development"