Skip to content

fields

This module contains extra API models that are not part of the official API specification.

However, this module may still assist in the construction of valid requests to the API, primarily by providing additional type hints for the request and response payloads and validation.

UUID_Identifier

Bases: RootModel[UUID]

Represents a UUID type identifier used by the API.

Source code in horde_sdk/ai_horde_api/fields.py 
 14
 15
 16
 17
 18
 19
 20
 21
 22
 23
 24
 25
 26
 27
 28
 29
 30
 31
 32
 33
 34
 35
 36
 37
 38
 39
 40
 41
 42
 43
 44
 45
 46
 47
 48
 49
 50
 51
 52
 53
 54
 55
 56
 57
 58
 59
 60
 61
 62
 63
 64
 65
 66
 67
 68
 69
 70
 71
 72
 73
 74
 75
 76
 77
 78
 79
 80
 81
 82
 83
 84
 85
 86
 87
 88
 89
 90
 91
 92
 93
 94
 95
 96
 97
 98
 99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
class UUID_Identifier(RootModel[uuid.UUID]):
    """Represents a UUID type identifier used by the API."""

    model_config: ClassVar[ConfigDict] = {"frozen": True}

    root: uuid.UUID
    """The underlying UUID object."""

    @model_serializer
    def ser_model(self) -> str:
        """Serialize the model to a string."""
        return str(self.root)

    @field_validator("root", mode="after")
    def id_must_be_uuid(cls, v: str | uuid.UUID) -> str | uuid.UUID:
        """Ensure that the ID is a valid UUID."""
        if isinstance(v, uuid.UUID):
            return v

        if v == "":  # FIXME? This is a workaround for the swagger doc having `""`
            logger.trace("Empty UUID string being converted to 0")
            return uuid.UUID(int=0)

        try:
            return uuid.UUID(v, version=4)
        except ValueError as e:
            raise ValueError(f"Invalid UUID {v}") from e

    @override
    def __repr__(self) -> str:
        return self.__str__()

    @override
    def __str__(self) -> str:
        return self.root.__str__()

    @override
    def __eq__(self, other: Any) -> bool:
        if other is None or (
            not (isinstance(self.__class__, uuid.UUID) or isinstance(other, uuid.UUID))
            and self.__class__ != other.__class__
        ):
            logger.debug(f"Comparing {self.root.__class__} with {other.__class__}")

        if isinstance(other, UUID_Identifier):
            return self.root == other.root

        if isinstance(other, str):
            return str(self.root) == other

        if isinstance(other, uuid.UUID):
            return self.root == other

        return NotImplemented

    @override
    def __hash__(self) -> int:
        return hash(UUID_Identifier.__name__) + self.root.__hash__()

    def __lt__(self, other: object) -> bool:
        if isinstance(other, UUID_Identifier):
            return self.root < other.root

        if isinstance(other, str):
            return self.root < uuid.UUID(other)

        if isinstance(other, uuid.UUID):
            return self.root < other

        return NotImplemented

    def __gt__(self, other: object) -> bool:
        if isinstance(other, UUID_Identifier):
            return self.root > other.root

        if isinstance(other, str):
            return self.root > uuid.UUID(other)

        if isinstance(other, uuid.UUID):
            return self.root > other

        return NotImplemented

    def __le__(self, other: object) -> bool:
        if isinstance(other, UUID_Identifier):
            return self.root <= other.root

        if isinstance(other, str):
            return self.root <= uuid.UUID(other)

        if isinstance(other, uuid.UUID):
            return self.root <= other

        return NotImplemented

    def __ge__(self, other: object) -> bool:
        if isinstance(other, UUID_Identifier):
            return self.root >= other.root

        if isinstance(other, str):
            return self.root >= uuid.UUID(other)

        if isinstance(other, uuid.UUID):
            return self.root >= other

        return NotImplemented

model_config class-attribute 

model_config: ConfigDict = {'frozen': True}

root instance-attribute 

root: UUID

The underlying UUID object.

ser_model 

ser_model() -> str

Serialize the model to a string.

Source code in horde_sdk/ai_horde_api/fields.py 
22
23
24
25
@model_serializer
def ser_model(self) -> str:
    """Serialize the model to a string."""
    return str(self.root)

id_must_be_uuid 

id_must_be_uuid(v: str | UUID) -> str | uuid.UUID

Ensure that the ID is a valid UUID.

Source code in horde_sdk/ai_horde_api/fields.py 
27
28
29
30
31
32
33
34
35
36
37
38
39
40
@field_validator("root", mode="after")
def id_must_be_uuid(cls, v: str | uuid.UUID) -> str | uuid.UUID:
    """Ensure that the ID is a valid UUID."""
    if isinstance(v, uuid.UUID):
        return v

    if v == "":  # FIXME? This is a workaround for the swagger doc having `""`
        logger.trace("Empty UUID string being converted to 0")
        return uuid.UUID(int=0)

    try:
        return uuid.UUID(v, version=4)
    except ValueError as e:
        raise ValueError(f"Invalid UUID {v}") from e

__repr__ 

__repr__() -> str
Source code in horde_sdk/ai_horde_api/fields.py 
42
43
44
@override
def __repr__(self) -> str:
    return self.__str__()

__str__ 

__str__() -> str
Source code in horde_sdk/ai_horde_api/fields.py 
46
47
48
@override
def __str__(self) -> str:
    return self.root.__str__()

__eq__ 

__eq__(other: Any) -> bool
Source code in horde_sdk/ai_horde_api/fields.py 
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
@override
def __eq__(self, other: Any) -> bool:
    if other is None or (
        not (isinstance(self.__class__, uuid.UUID) or isinstance(other, uuid.UUID))
        and self.__class__ != other.__class__
    ):
        logger.debug(f"Comparing {self.root.__class__} with {other.__class__}")

    if isinstance(other, UUID_Identifier):
        return self.root == other.root

    if isinstance(other, str):
        return str(self.root) == other

    if isinstance(other, uuid.UUID):
        return self.root == other

    return NotImplemented

__hash__ 

__hash__() -> int
Source code in horde_sdk/ai_horde_api/fields.py 
69
70
71
@override
def __hash__(self) -> int:
    return hash(UUID_Identifier.__name__) + self.root.__hash__()

__lt__ 

__lt__(other: object) -> bool
Source code in horde_sdk/ai_horde_api/fields.py 
73
74
75
76
77
78
79
80
81
82
83
def __lt__(self, other: object) -> bool:
    if isinstance(other, UUID_Identifier):
        return self.root < other.root

    if isinstance(other, str):
        return self.root < uuid.UUID(other)

    if isinstance(other, uuid.UUID):
        return self.root < other

    return NotImplemented

__gt__ 

__gt__(other: object) -> bool
Source code in horde_sdk/ai_horde_api/fields.py 
85
86
87
88
89
90
91
92
93
94
95
def __gt__(self, other: object) -> bool:
    if isinstance(other, UUID_Identifier):
        return self.root > other.root

    if isinstance(other, str):
        return self.root > uuid.UUID(other)

    if isinstance(other, uuid.UUID):
        return self.root > other

    return NotImplemented

__le__ 

__le__(other: object) -> bool
Source code in horde_sdk/ai_horde_api/fields.py 
 97
 98
 99
100
101
102
103
104
105
106
107
def __le__(self, other: object) -> bool:
    if isinstance(other, UUID_Identifier):
        return self.root <= other.root

    if isinstance(other, str):
        return self.root <= uuid.UUID(other)

    if isinstance(other, uuid.UUID):
        return self.root <= other

    return NotImplemented

__ge__ 

__ge__(other: object) -> bool
Source code in horde_sdk/ai_horde_api/fields.py 
109
110
111
112
113
114
115
116
117
118
119
def __ge__(self, other: object) -> bool:
    if isinstance(other, UUID_Identifier):
        return self.root >= other.root

    if isinstance(other, str):
        return self.root >= uuid.UUID(other)

    if isinstance(other, uuid.UUID):
        return self.root >= other

    return NotImplemented

GenerationID

Bases: UUID_Identifier

Represents the ID of a generation job. Instances of this class can be compared with a str or a UUID object.

Source code in horde_sdk/ai_horde_api/fields.py 
122
123
class GenerationID(UUID_Identifier):
    """Represents the ID of a generation job. Instances of this class can be compared with a `str` or a UUID object."""

model_config class-attribute 

model_config: ConfigDict = {'frozen': True}

root instance-attribute 

root: UUID

The underlying UUID object.

ser_model 

ser_model() -> str

Serialize the model to a string.

Source code in horde_sdk/ai_horde_api/fields.py 
22
23
24
25
@model_serializer
def ser_model(self) -> str:
    """Serialize the model to a string."""
    return str(self.root)

id_must_be_uuid 

id_must_be_uuid(v: str | UUID) -> str | uuid.UUID

Ensure that the ID is a valid UUID.

Source code in horde_sdk/ai_horde_api/fields.py 
27
28
29
30
31
32
33
34
35
36
37
38
39
40
@field_validator("root", mode="after")
def id_must_be_uuid(cls, v: str | uuid.UUID) -> str | uuid.UUID:
    """Ensure that the ID is a valid UUID."""
    if isinstance(v, uuid.UUID):
        return v

    if v == "":  # FIXME? This is a workaround for the swagger doc having `""`
        logger.trace("Empty UUID string being converted to 0")
        return uuid.UUID(int=0)

    try:
        return uuid.UUID(v, version=4)
    except ValueError as e:
        raise ValueError(f"Invalid UUID {v}") from e

__repr__ 

__repr__() -> str
Source code in horde_sdk/ai_horde_api/fields.py 
42
43
44
@override
def __repr__(self) -> str:
    return self.__str__()

__str__ 

__str__() -> str
Source code in horde_sdk/ai_horde_api/fields.py 
46
47
48
@override
def __str__(self) -> str:
    return self.root.__str__()

__eq__ 

__eq__(other: Any) -> bool
Source code in horde_sdk/ai_horde_api/fields.py 
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
@override
def __eq__(self, other: Any) -> bool:
    if other is None or (
        not (isinstance(self.__class__, uuid.UUID) or isinstance(other, uuid.UUID))
        and self.__class__ != other.__class__
    ):
        logger.debug(f"Comparing {self.root.__class__} with {other.__class__}")

    if isinstance(other, UUID_Identifier):
        return self.root == other.root

    if isinstance(other, str):
        return str(self.root) == other

    if isinstance(other, uuid.UUID):
        return self.root == other

    return NotImplemented

__hash__ 

__hash__() -> int
Source code in horde_sdk/ai_horde_api/fields.py 
69
70
71
@override
def __hash__(self) -> int:
    return hash(UUID_Identifier.__name__) + self.root.__hash__()

__lt__ 

__lt__(other: object) -> bool
Source code in horde_sdk/ai_horde_api/fields.py 
73
74
75
76
77
78
79
80
81
82
83
def __lt__(self, other: object) -> bool:
    if isinstance(other, UUID_Identifier):
        return self.root < other.root

    if isinstance(other, str):
        return self.root < uuid.UUID(other)

    if isinstance(other, uuid.UUID):
        return self.root < other

    return NotImplemented

__gt__ 

__gt__(other: object) -> bool
Source code in horde_sdk/ai_horde_api/fields.py 
85
86
87
88
89
90
91
92
93
94
95
def __gt__(self, other: object) -> bool:
    if isinstance(other, UUID_Identifier):
        return self.root > other.root

    if isinstance(other, str):
        return self.root > uuid.UUID(other)

    if isinstance(other, uuid.UUID):
        return self.root > other

    return NotImplemented

__le__ 

__le__(other: object) -> bool
Source code in horde_sdk/ai_horde_api/fields.py 
 97
 98
 99
100
101
102
103
104
105
106
107
def __le__(self, other: object) -> bool:
    if isinstance(other, UUID_Identifier):
        return self.root <= other.root

    if isinstance(other, str):
        return self.root <= uuid.UUID(other)

    if isinstance(other, uuid.UUID):
        return self.root <= other

    return NotImplemented

__ge__ 

__ge__(other: object) -> bool
Source code in horde_sdk/ai_horde_api/fields.py 
109
110
111
112
113
114
115
116
117
118
119
def __ge__(self, other: object) -> bool:
    if isinstance(other, UUID_Identifier):
        return self.root >= other.root

    if isinstance(other, str):
        return self.root >= uuid.UUID(other)

    if isinstance(other, uuid.UUID):
        return self.root >= other

    return NotImplemented

WorkerID

Bases: UUID_Identifier

Represents the ID of a worker. Instances of this class can be compared with a str or a UUID object.

Source code in horde_sdk/ai_horde_api/fields.py 
126
127
class WorkerID(UUID_Identifier):
    """Represents the ID of a worker. Instances of this class can be compared with a `str` or a UUID object."""

model_config class-attribute 

model_config: ConfigDict = {'frozen': True}

root instance-attribute 

root: UUID

The underlying UUID object.

ser_model 

ser_model() -> str

Serialize the model to a string.

Source code in horde_sdk/ai_horde_api/fields.py 
22
23
24
25
@model_serializer
def ser_model(self) -> str:
    """Serialize the model to a string."""
    return str(self.root)

id_must_be_uuid 

id_must_be_uuid(v: str | UUID) -> str | uuid.UUID

Ensure that the ID is a valid UUID.

Source code in horde_sdk/ai_horde_api/fields.py 
27
28
29
30
31
32
33
34
35
36
37
38
39
40
@field_validator("root", mode="after")
def id_must_be_uuid(cls, v: str | uuid.UUID) -> str | uuid.UUID:
    """Ensure that the ID is a valid UUID."""
    if isinstance(v, uuid.UUID):
        return v

    if v == "":  # FIXME? This is a workaround for the swagger doc having `""`
        logger.trace("Empty UUID string being converted to 0")
        return uuid.UUID(int=0)

    try:
        return uuid.UUID(v, version=4)
    except ValueError as e:
        raise ValueError(f"Invalid UUID {v}") from e

__repr__ 

__repr__() -> str
Source code in horde_sdk/ai_horde_api/fields.py 
42
43
44
@override
def __repr__(self) -> str:
    return self.__str__()

__str__ 

__str__() -> str
Source code in horde_sdk/ai_horde_api/fields.py 
46
47
48
@override
def __str__(self) -> str:
    return self.root.__str__()

__eq__ 

__eq__(other: Any) -> bool
Source code in horde_sdk/ai_horde_api/fields.py 
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
@override
def __eq__(self, other: Any) -> bool:
    if other is None or (
        not (isinstance(self.__class__, uuid.UUID) or isinstance(other, uuid.UUID))
        and self.__class__ != other.__class__
    ):
        logger.debug(f"Comparing {self.root.__class__} with {other.__class__}")

    if isinstance(other, UUID_Identifier):
        return self.root == other.root

    if isinstance(other, str):
        return str(self.root) == other

    if isinstance(other, uuid.UUID):
        return self.root == other

    return NotImplemented

__hash__ 

__hash__() -> int
Source code in horde_sdk/ai_horde_api/fields.py 
69
70
71
@override
def __hash__(self) -> int:
    return hash(UUID_Identifier.__name__) + self.root.__hash__()

__lt__ 

__lt__(other: object) -> bool
Source code in horde_sdk/ai_horde_api/fields.py 
73
74
75
76
77
78
79
80
81
82
83
def __lt__(self, other: object) -> bool:
    if isinstance(other, UUID_Identifier):
        return self.root < other.root

    if isinstance(other, str):
        return self.root < uuid.UUID(other)

    if isinstance(other, uuid.UUID):
        return self.root < other

    return NotImplemented

__gt__ 

__gt__(other: object) -> bool
Source code in horde_sdk/ai_horde_api/fields.py 
85
86
87
88
89
90
91
92
93
94
95
def __gt__(self, other: object) -> bool:
    if isinstance(other, UUID_Identifier):
        return self.root > other.root

    if isinstance(other, str):
        return self.root > uuid.UUID(other)

    if isinstance(other, uuid.UUID):
        return self.root > other

    return NotImplemented

__le__ 

__le__(other: object) -> bool
Source code in horde_sdk/ai_horde_api/fields.py 
 97
 98
 99
100
101
102
103
104
105
106
107
def __le__(self, other: object) -> bool:
    if isinstance(other, UUID_Identifier):
        return self.root <= other.root

    if isinstance(other, str):
        return self.root <= uuid.UUID(other)

    if isinstance(other, uuid.UUID):
        return self.root <= other

    return NotImplemented

__ge__ 

__ge__(other: object) -> bool
Source code in horde_sdk/ai_horde_api/fields.py 
109
110
111
112
113
114
115
116
117
118
119
def __ge__(self, other: object) -> bool:
    if isinstance(other, UUID_Identifier):
        return self.root >= other.root

    if isinstance(other, str):
        return self.root >= uuid.UUID(other)

    if isinstance(other, uuid.UUID):
        return self.root >= other

    return NotImplemented

ImageID

Bases: UUID_Identifier

Represents the ID of an image. Instances of this class can be compared with a str or a UUID object.

Source code in horde_sdk/ai_horde_api/fields.py 
130
131
class ImageID(UUID_Identifier):
    """Represents the ID of an image. Instances of this class can be compared with a `str` or a UUID object."""

model_config class-attribute 

model_config: ConfigDict = {'frozen': True}

root instance-attribute 

root: UUID

The underlying UUID object.

ser_model 

ser_model() -> str

Serialize the model to a string.

Source code in horde_sdk/ai_horde_api/fields.py 
22
23
24
25
@model_serializer
def ser_model(self) -> str:
    """Serialize the model to a string."""
    return str(self.root)

id_must_be_uuid 

id_must_be_uuid(v: str | UUID) -> str | uuid.UUID

Ensure that the ID is a valid UUID.

Source code in horde_sdk/ai_horde_api/fields.py 
27
28
29
30
31
32
33
34
35
36
37
38
39
40
@field_validator("root", mode="after")
def id_must_be_uuid(cls, v: str | uuid.UUID) -> str | uuid.UUID:
    """Ensure that the ID is a valid UUID."""
    if isinstance(v, uuid.UUID):
        return v

    if v == "":  # FIXME? This is a workaround for the swagger doc having `""`
        logger.trace("Empty UUID string being converted to 0")
        return uuid.UUID(int=0)

    try:
        return uuid.UUID(v, version=4)
    except ValueError as e:
        raise ValueError(f"Invalid UUID {v}") from e

__repr__ 

__repr__() -> str
Source code in horde_sdk/ai_horde_api/fields.py 
42
43
44
@override
def __repr__(self) -> str:
    return self.__str__()

__str__ 

__str__() -> str
Source code in horde_sdk/ai_horde_api/fields.py 
46
47
48
@override
def __str__(self) -> str:
    return self.root.__str__()

__eq__ 

__eq__(other: Any) -> bool
Source code in horde_sdk/ai_horde_api/fields.py 
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
@override
def __eq__(self, other: Any) -> bool:
    if other is None or (
        not (isinstance(self.__class__, uuid.UUID) or isinstance(other, uuid.UUID))
        and self.__class__ != other.__class__
    ):
        logger.debug(f"Comparing {self.root.__class__} with {other.__class__}")

    if isinstance(other, UUID_Identifier):
        return self.root == other.root

    if isinstance(other, str):
        return str(self.root) == other

    if isinstance(other, uuid.UUID):
        return self.root == other

    return NotImplemented

__hash__ 

__hash__() -> int
Source code in horde_sdk/ai_horde_api/fields.py 
69
70
71
@override
def __hash__(self) -> int:
    return hash(UUID_Identifier.__name__) + self.root.__hash__()

__lt__ 

__lt__(other: object) -> bool
Source code in horde_sdk/ai_horde_api/fields.py 
73
74
75
76
77
78
79
80
81
82
83
def __lt__(self, other: object) -> bool:
    if isinstance(other, UUID_Identifier):
        return self.root < other.root

    if isinstance(other, str):
        return self.root < uuid.UUID(other)

    if isinstance(other, uuid.UUID):
        return self.root < other

    return NotImplemented

__gt__ 

__gt__(other: object) -> bool
Source code in horde_sdk/ai_horde_api/fields.py 
85
86
87
88
89
90
91
92
93
94
95
def __gt__(self, other: object) -> bool:
    if isinstance(other, UUID_Identifier):
        return self.root > other.root

    if isinstance(other, str):
        return self.root > uuid.UUID(other)

    if isinstance(other, uuid.UUID):
        return self.root > other

    return NotImplemented

__le__ 

__le__(other: object) -> bool
Source code in horde_sdk/ai_horde_api/fields.py 
 97
 98
 99
100
101
102
103
104
105
106
107
def __le__(self, other: object) -> bool:
    if isinstance(other, UUID_Identifier):
        return self.root <= other.root

    if isinstance(other, str):
        return self.root <= uuid.UUID(other)

    if isinstance(other, uuid.UUID):
        return self.root <= other

    return NotImplemented

__ge__ 

__ge__(other: object) -> bool
Source code in horde_sdk/ai_horde_api/fields.py 
109
110
111
112
113
114
115
116
117
118
119
def __ge__(self, other: object) -> bool:
    if isinstance(other, UUID_Identifier):
        return self.root >= other.root

    if isinstance(other, str):
        return self.root >= uuid.UUID(other)

    if isinstance(other, uuid.UUID):
        return self.root >= other

    return NotImplemented

TeamID

Bases: UUID_Identifier

Represents the ID of a team. Instances of this class can be compared with a str or a UUID object.

Source code in horde_sdk/ai_horde_api/fields.py 
134
135
class TeamID(UUID_Identifier):
    """Represents the ID of a team. Instances of this class can be compared with a `str` or a UUID object."""

model_config class-attribute 

model_config: ConfigDict = {'frozen': True}

root instance-attribute 

root: UUID

The underlying UUID object.

ser_model 

ser_model() -> str

Serialize the model to a string.

Source code in horde_sdk/ai_horde_api/fields.py 
22
23
24
25
@model_serializer
def ser_model(self) -> str:
    """Serialize the model to a string."""
    return str(self.root)

id_must_be_uuid 

id_must_be_uuid(v: str | UUID) -> str | uuid.UUID

Ensure that the ID is a valid UUID.

Source code in horde_sdk/ai_horde_api/fields.py 
27
28
29
30
31
32
33
34
35
36
37
38
39
40
@field_validator("root", mode="after")
def id_must_be_uuid(cls, v: str | uuid.UUID) -> str | uuid.UUID:
    """Ensure that the ID is a valid UUID."""
    if isinstance(v, uuid.UUID):
        return v

    if v == "":  # FIXME? This is a workaround for the swagger doc having `""`
        logger.trace("Empty UUID string being converted to 0")
        return uuid.UUID(int=0)

    try:
        return uuid.UUID(v, version=4)
    except ValueError as e:
        raise ValueError(f"Invalid UUID {v}") from e

__repr__ 

__repr__() -> str
Source code in horde_sdk/ai_horde_api/fields.py 
42
43
44
@override
def __repr__(self) -> str:
    return self.__str__()

__str__ 

__str__() -> str
Source code in horde_sdk/ai_horde_api/fields.py 
46
47
48
@override
def __str__(self) -> str:
    return self.root.__str__()

__eq__ 

__eq__(other: Any) -> bool
Source code in horde_sdk/ai_horde_api/fields.py 
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
@override
def __eq__(self, other: Any) -> bool:
    if other is None or (
        not (isinstance(self.__class__, uuid.UUID) or isinstance(other, uuid.UUID))
        and self.__class__ != other.__class__
    ):
        logger.debug(f"Comparing {self.root.__class__} with {other.__class__}")

    if isinstance(other, UUID_Identifier):
        return self.root == other.root

    if isinstance(other, str):
        return str(self.root) == other

    if isinstance(other, uuid.UUID):
        return self.root == other

    return NotImplemented

__hash__ 

__hash__() -> int
Source code in horde_sdk/ai_horde_api/fields.py 
69
70
71
@override
def __hash__(self) -> int:
    return hash(UUID_Identifier.__name__) + self.root.__hash__()

__lt__ 

__lt__(other: object) -> bool
Source code in horde_sdk/ai_horde_api/fields.py 
73
74
75
76
77
78
79
80
81
82
83
def __lt__(self, other: object) -> bool:
    if isinstance(other, UUID_Identifier):
        return self.root < other.root

    if isinstance(other, str):
        return self.root < uuid.UUID(other)

    if isinstance(other, uuid.UUID):
        return self.root < other

    return NotImplemented

__gt__ 

__gt__(other: object) -> bool
Source code in horde_sdk/ai_horde_api/fields.py 
85
86
87
88
89
90
91
92
93
94
95
def __gt__(self, other: object) -> bool:
    if isinstance(other, UUID_Identifier):
        return self.root > other.root

    if isinstance(other, str):
        return self.root > uuid.UUID(other)

    if isinstance(other, uuid.UUID):
        return self.root > other

    return NotImplemented

__le__ 

__le__(other: object) -> bool
Source code in horde_sdk/ai_horde_api/fields.py 
 97
 98
 99
100
101
102
103
104
105
106
107
def __le__(self, other: object) -> bool:
    if isinstance(other, UUID_Identifier):
        return self.root <= other.root

    if isinstance(other, str):
        return self.root <= uuid.UUID(other)

    if isinstance(other, uuid.UUID):
        return self.root <= other

    return NotImplemented

__ge__ 

__ge__(other: object) -> bool
Source code in horde_sdk/ai_horde_api/fields.py 
109
110
111
112
113
114
115
116
117
118
119
def __ge__(self, other: object) -> bool:
    if isinstance(other, UUID_Identifier):
        return self.root >= other.root

    if isinstance(other, str):
        return self.root >= uuid.UUID(other)

    if isinstance(other, uuid.UUID):
        return self.root >= other

    return NotImplemented

SharedKeyID

Bases: UUID_Identifier

Represents the ID of a shared key. Instances of this class can be compared with a str or a UUID object.

Source code in horde_sdk/ai_horde_api/fields.py 
138
139
class SharedKeyID(UUID_Identifier):
    """Represents the ID of a shared key. Instances of this class can be compared with a `str` or a UUID object."""

model_config class-attribute 

model_config: ConfigDict = {'frozen': True}

root instance-attribute 

root: UUID

The underlying UUID object.

ser_model 

ser_model() -> str

Serialize the model to a string.

Source code in horde_sdk/ai_horde_api/fields.py 
22
23
24
25
@model_serializer
def ser_model(self) -> str:
    """Serialize the model to a string."""
    return str(self.root)

id_must_be_uuid 

id_must_be_uuid(v: str | UUID) -> str | uuid.UUID

Ensure that the ID is a valid UUID.

Source code in horde_sdk/ai_horde_api/fields.py 
27
28
29
30
31
32
33
34
35
36
37
38
39
40
@field_validator("root", mode="after")
def id_must_be_uuid(cls, v: str | uuid.UUID) -> str | uuid.UUID:
    """Ensure that the ID is a valid UUID."""
    if isinstance(v, uuid.UUID):
        return v

    if v == "":  # FIXME? This is a workaround for the swagger doc having `""`
        logger.trace("Empty UUID string being converted to 0")
        return uuid.UUID(int=0)

    try:
        return uuid.UUID(v, version=4)
    except ValueError as e:
        raise ValueError(f"Invalid UUID {v}") from e

__repr__ 

__repr__() -> str
Source code in horde_sdk/ai_horde_api/fields.py 
42
43
44
@override
def __repr__(self) -> str:
    return self.__str__()

__str__ 

__str__() -> str
Source code in horde_sdk/ai_horde_api/fields.py 
46
47
48
@override
def __str__(self) -> str:
    return self.root.__str__()

__eq__ 

__eq__(other: Any) -> bool
Source code in horde_sdk/ai_horde_api/fields.py 
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
@override
def __eq__(self, other: Any) -> bool:
    if other is None or (
        not (isinstance(self.__class__, uuid.UUID) or isinstance(other, uuid.UUID))
        and self.__class__ != other.__class__
    ):
        logger.debug(f"Comparing {self.root.__class__} with {other.__class__}")

    if isinstance(other, UUID_Identifier):
        return self.root == other.root

    if isinstance(other, str):
        return str(self.root) == other

    if isinstance(other, uuid.UUID):
        return self.root == other

    return NotImplemented

__hash__ 

__hash__() -> int
Source code in horde_sdk/ai_horde_api/fields.py 
69
70
71
@override
def __hash__(self) -> int:
    return hash(UUID_Identifier.__name__) + self.root.__hash__()

__lt__ 

__lt__(other: object) -> bool
Source code in horde_sdk/ai_horde_api/fields.py 
73
74
75
76
77
78
79
80
81
82
83
def __lt__(self, other: object) -> bool:
    if isinstance(other, UUID_Identifier):
        return self.root < other.root

    if isinstance(other, str):
        return self.root < uuid.UUID(other)

    if isinstance(other, uuid.UUID):
        return self.root < other

    return NotImplemented

__gt__ 

__gt__(other: object) -> bool
Source code in horde_sdk/ai_horde_api/fields.py 
85
86
87
88
89
90
91
92
93
94
95
def __gt__(self, other: object) -> bool:
    if isinstance(other, UUID_Identifier):
        return self.root > other.root

    if isinstance(other, str):
        return self.root > uuid.UUID(other)

    if isinstance(other, uuid.UUID):
        return self.root > other

    return NotImplemented

__le__ 

__le__(other: object) -> bool
Source code in horde_sdk/ai_horde_api/fields.py 
 97
 98
 99
100
101
102
103
104
105
106
107
def __le__(self, other: object) -> bool:
    if isinstance(other, UUID_Identifier):
        return self.root <= other.root

    if isinstance(other, str):
        return self.root <= uuid.UUID(other)

    if isinstance(other, uuid.UUID):
        return self.root <= other

    return NotImplemented

__ge__ 

__ge__(other: object) -> bool
Source code in horde_sdk/ai_horde_api/fields.py 
109
110
111
112
113
114
115
116
117
118
119
def __ge__(self, other: object) -> bool:
    if isinstance(other, UUID_Identifier):
        return self.root >= other.root

    if isinstance(other, str):
        return self.root >= uuid.UUID(other)

    if isinstance(other, uuid.UUID):
        return self.root >= other

    return NotImplemented