Module: json_content

Expand source code

# Copyright (C) 2023-present The Project Contributors
#
# Licensed under the Apache License, Version 2.0 (the "License");
# you may not use this file except in compliance with the License.
# You may obtain a copy of the License at
#
#    http://www.apache.org/licenses/LICENSE-2.0
#
# Unless required by applicable law or agreed to in writing, software
# distributed under the License is distributed on an "AS IS" BASIS,
# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
# See the License for the specific language governing permissions and
# limitations under the License.

from abc import abstractmethod
from dataclasses import dataclass
from typing_extensions import Self
from cl.runtime.records.dataclasses_extensions import missing
from cl.convince.content.content import Content


@dataclass(slots=True, kw_only=True)
class JsonContent(Content):
    """Single-page content in text format."""

    json_bytes: bytes = missing()
    """JSON document as bytes without escaping Unicode characters."""

    @abstractmethod
    def as_str(self) -> str:
        raise NotImplementedError()

    @classmethod
    @abstractmethod
    def from_str(cls, value: str) -> Self:
        raise NotImplementedError()

Classes

class JsonContent (*, content_id: str = None, json_bytes: bytes = None)

Single-page content in text format.

Expand source code

@dataclass(slots=True, kw_only=True)
class JsonContent(Content):
    """Single-page content in text format."""

    json_bytes: bytes = missing()
    """JSON document as bytes without escaping Unicode characters."""

    @abstractmethod
    def as_str(self) -> str:
        raise NotImplementedError()

    @classmethod
    @abstractmethod
    def from_str(cls, value: str) -> Self:
        raise NotImplementedError()

Ancestors

Content
ContentKey
KeyMixin
RecordMixin
abc.ABC
typing.Generic

Static methods

def from_str(value: str) -> Self: Inherited from: Content.from_str

Convert from string format.
def get_key_type() -> Type: Inherited from: Content.get_key_type

Return key type even when called from a record.

Fields

var content_id -> str: Inherited from: Content.content_id

Unique content identifier.
var json_bytes -> bytes: JSON document as bytes without escaping Unicode characters.

Methods

def as_str(self) -> str: Inherited from: Content.as_str

Convert to string format.
def get_key(self) -> ContentKey: Inherited from: Content.get_key

Return a new key object whose fields populated from self, do not return self.
def init_all(self) -> None: Inherited from: Content.init_all

Invoke ‘init’ for each class in the order from base to derived, then validate against schema.