comparing 765cf67638df90a5f715fb09dbbe585cd6d96990 and main on dwn.poxiao-labs.work/atpasser

-96

src/atpasser/handle/__init__.py

···

       1
       1
       -
       import dns.resolver, requests

     

       2
       2
       -
       

     

       3
       3
       -
       from atpasser import did

     

       4
       4
       -
       

     

       5
       5
       -
       

     

       6
       6
       -
       class Handle:

     

       7
       7
       -
           """

     

       8
       8
       -
           A class representing a Handle.

     

       9
       9
       -
       

     

       10
       10
       -
       

     

       11
       11
       -
           Attributes:

     

       12
       12
       -
               handle (str): The Handle.

     

       13
       13
       -
           """

     

       14
       14
       -
       

     

       15
       15
       -
           def __init__(self, handle: str) -> None:

     

       16
       16
       -
               """

     

       17
       17
       -
               Initalizes an Handle object.

     

       18
       18
       -
       

     

       19
       19
       -
               Parameters:

     

       20
       20
       -
                   handle (str): The Handle.

     

       21
       21
       -
               """

     

       22
       22
       -
       

     

       23
       23
       -
               if len(handle) > 253:

     

       24
       24
       -
                   raise ValueError("handle is more than 253 chars")

     

       25
       25
       -
       

     

       26
       26
       -
               labels = handle.lower().split(".")

     

       27
       27
       -
       

     

       28
       28
       -
               if len(labels) < 2:

     

       29
       29
       -
                   raise ValueError("are you tld?")

     

       30
       30
       -
       

     

       31
       31
       -
               if labels[0] == "" or labels[-1] == "":

     

       32
       32
       -
                   raise ValueError("proceeding or tariling ascii periods")

     

       33
       33
       -
       

     

       34
       34
       -
               for label in labels:

     

       35
       35
       -
                   if len(label) not in range(1, 64):

     

       36
       36
       -
                       raise ValueError("two periods or segment longer than 63 char")

     

       37
       37
       -
                   charset = set(label)

     

       38
       38
       -
                   validset = set("abcdefghijklmnopqrstuvwxyz0123456789-")

     

       39
       39
       -
                   if not charset.issubset(validset):

     

       40
       40
       -
                       raise ValueError("invalid char used in segment")

     

       41
       41
       -
                   if label.startswith("-") or label.endswith("-"):

     

       42
       42
       -
                       raise ValueError("segments starts or ends with hyphen")

     

       43
       43
       -
       

     

       44
       44
       -
               tld = labels[-1]

     

       45
       45
       -
               if tld[0] in "0123456789":

     

       46
       46
       -
                   raise ValueError("tld starts with digit")

     

       47
       47
       -
       

     

       48
       48
       -
               self.handle = handle

     

       49
       49
       -
       

     

       50
       50
       -
           def __str__(self) -> str:

     

       51
       51
       -
               """

     

       52
       52
       -
       

     

       53
       53
       -
               Convert the TID to a string by given the URI.

     

       54
       54
       -
               """

     

       55
       55
       -
               return self.handle

     

       56
       56
       -
       

     

       57
       57
       -
           def __eq__(self, value: object, /) -> bool:

     

       58
       58
       -
               """

     

       59
       59
       -
       

     

       60
       60
       -
               Check if the 2 values are exactly the same.

     

       61
       61
       -
               """

     

       62
       62
       -
       

     

       63
       63
       -
               if isinstance(value, Handle):

     

       64
       64
       -
       

     

       65
       65
       -
                   return str(self) == str(value)

     

       66
       66
       -
               else:

     

       67
       67
       -
       

     

       68
       68
       -
                   return False

     

       69
       69
       -
       

     

       70
       70
       -
           def toTID(self):

     

       71
       71
       -
               """

     

       72
       72
       -
               Convert the handle to TID.

     

       73
       73
       -
       

     

       74
       74
       -
               Returns:

     

       75
       75
       -
                   An DID object, or `None` if the handle is invalid.

     

       76
       76
       -
               """

     

       77
       77
       -
               try:

     

       78
       78
       -
                   answers = dns.resolver.resolve("_atproto." + self.handle, "TXT")

     

       79
       79
       -
               except:

     

       80
       80
       -
                   answers = []

     

       81
       81
       -
               for answer in answers:

     

       82
       82
       -
                   if str(answer).startswith('"did='):

     

       83
       83
       -
                       try:

     

       84
       84
       -
                           uri = str(answer)[5:-1]

     

       85
       85
       -
                           return did.DID(uri)

     

       86
       86
       -
                       except:

     

       87
       87
       -
                           pass  # cannot resolve via dns

     

       88
       88
       -
               response = requests.get(f"https://{self.handle}/.well-known/atproto-did")

     

       89
       89
       -
               if response.status_code // 100 != 2:

     

       90
       90
       -
                   return None

     

       91
       91
       -
               if response.headers.get("Content-Type") != "text/plain":

     

       92
       92
       -
                   pass  # Pass for now, because some sites like neocities, breaks this rule

     

       93
       93
       -
               try:

     

       94
       94
       -
                   return did.DID(response.text)

     

       95
       95
       -
               except:

     

       96
       96
       -
                   return None

+61 -17

src/atpasser/uri/handle.py

···

       32
       32
        
               """

     

       33
       33
        
       

     

       34
       34
        
               if len(handle) > 253:

     

       35
       35
       -
                   raise InvalidHandleError(handle, "exceeds maximum length", f"Handle length {len(handle)} exceeds maximum allowed length of 253 characters")

     

       35
       35
       +
                   raise InvalidHandleError(

     

       36
       36
       +
                       handle,

     

       37
       37
       +
                       "exceeds maximum length",

     

       38
       38
       +
                       f"Handle length {len(handle)} exceeds maximum allowed length of 253 characters",

     

       39
       39
       +
                   )

     

       36
       40
        
       

     

       37
       41
        
               labels = handle.lower().split(".")

     

       38
       42
        
       

     

       39
       43
        
               if len(labels) < 2:

     

       40
       40
       -
                   raise InvalidHandleError(handle, "invalid format", "Handle must contain at least one dot separator, e.g., 'example.com'")

     

       44
       44
       +
                   raise InvalidHandleError(

     

       45
       45
       +
                       handle,

     

       46
       46
       +
                       "invalid format",

     

       47
       47
       +
                       "Handle must contain at least one dot separator, e.g., 'example.com'",

     

       48
       48
       +
                   )

     

       41
       49
        
       

     

       42
       50
        
               if labels[0] == "" or labels[-1] == "":

     

       43
       43
       -
                   raise InvalidHandleError(handle, "invalid format", "Handle cannot start or end with a dot")

     

       51
       51
       +
                   raise InvalidHandleError(

     

       52
       52
       +
                       handle, "invalid format", "Handle cannot start or end with a dot"

     

       53
       53
       +
                   )

     

       44
       54
        
       

     

       45
       55
        
               for i, label in enumerate(labels):

     

       46
       56
        
                   if len(label) not in range(1, 64):

     

       47
       47
       -
                       raise InvalidHandleError(handle, "segment length error", f"Handle segment {i+1} length {len(label)} is not in the 1-63 character range")

     

       57
       57
       +
                       raise InvalidHandleError(

     

       58
       58
       +
                           handle,

     

       59
       59
       +
                           "segment length error",

     

       60
       60
       +
                           f"Handle segment {i+1} length {len(label)} is not in the 1-63 character range",

     

       61
       61
       +
                       )

     

       48
       62
        
                   charset = set(label)

     

       49
       63
        
                   validset = set("abcdefghijklmnopqrstuvwxyz0123456789-")

     

       50
       64
        
                   if not charset.issubset(validset):

     

       51
       65
        
                       invalid_chars = charset - validset

     

       52
       52
       -
                       raise InvalidHandleError(handle, "contains invalid characters", f"Handle segment {i+1} contains invalid characters: {', '.join(invalid_chars)}")

     

       66
       66
       +
                       raise InvalidHandleError(

     

       67
       67
       +
                           handle,

     

       68
       68
       +
                           "contains invalid characters",

     

       69
       69
       +
                           f"Handle segment {i+1} contains invalid characters: {', '.join(invalid_chars)}",

     

       70
       70
       +
                       )

     

       53
       71
        
                   if label.startswith("-") or label.endswith("-"):

     

       54
       54
       -
                       raise InvalidHandleError(handle, "invalid format", f"Handle segment {i+1} cannot start or end with a hyphen")

     

       72
       72
       +
                       raise InvalidHandleError(

     

       73
       73
       +
                           handle,

     

       74
       74
       +
                           "invalid format",

     

       75
       75
       +
                           f"Handle segment {i+1} cannot start or end with a hyphen",

     

       76
       76
       +
                       )

     

       55
       77
        
       

     

       56
       78
        
               tld = labels[-1]

     

       57
       79
        
               if tld[0] in "0123456789":

     

       58
       58
       -
                   raise InvalidHandleError(handle, "invalid format", "Handle's top-level domain cannot start with a digit")

     

       80
       80
       +
                   raise InvalidHandleError(

     

       81
       81
       +
                       handle,

     

       82
       82
       +
                       "invalid format",

     

       83
       83
       +
                       "Handle's top-level domain cannot start with a digit",

     

       84
       84
       +
                   )

     

       59
       85
        
       

     

       60
       86
        
               self.handle = handle

     

       61
       87
        
       

     
···

       111
       137
        
                       answers = dns.resolver.resolve("_atproto." + self.handle, "TXT")

     

       112
       138
        
                   except Exception as e:

     

       113
       139
        
                       answers = []

     

       114
       114
       -
                       

     

       140
       140
       +
       

     

       115
       141
        
                   for answer in answers:

     

       116
       142
        
                       answer_str = str(answer)

     

       117
       143
        
                       if answer_str.startswith('"did='):

     
···

       122
       148
        
                               # Continue trying other records or methods

     

       123
       149
        
                               continue

     

       124
       150
        
                           except Exception as e:

     

       125
       125
       -
                               raise ResolutionError(self.handle, "DNS resolution", f"Error parsing DNS TXT record: {str(e)}")

     

       126
       126
       -
                   

     

       151
       151
       +
                               raise ResolutionError(

     

       152
       152
       +
                                   self.handle,

     

       153
       153
       +
                                   "DNS resolution",

     

       154
       154
       +
                                   f"Error parsing DNS TXT record: {str(e)}",

     

       155
       155
       +
                               )

     

       156
       156
       +
       

     

       127
       157
        
                   # If DNS resolution fails, try HTTP method

     

       128
       158
        
                   try:

     

       129
       129
       -
                       response = requests.get(f"https://{self.handle}/.well-known/atproto-did")

     

       159
       159
       +
                       response = requests.get(

     

       160
       160
       +
                           f"https://{self.handle}/.well-known/atproto-did"

     

       161
       161
       +
                       )

     

       130
       162
        
                       if response.status_code // 100 != 2:

     

       131
       163
        
                           return None

     

       132
       132
       -
                           

     

       164
       164
       +
       

     

       133
       165
        
                       # Some websites may return incorrect Content-Type, so here we only warn without throwing an exception

     

       134
       166
        
                       content_type = response.headers.get("Content-Type")

     

       135
       167
        
                       if content_type != "text/plain" and content_type:

     

       136
       168
        
                           # Log warning but don't block processing

     

       137
       169
        
                           pass

     

       138
       138
       -
                           

     

       170
       170
       +
       

     

       139
       171
        
                       try:

     

       140
       172
        
                           return DID(response.text.strip())

     

       141
       173
        
                       except InvalidDIDError:

     

       142
       174
        
                           return None

     

       143
       175
        
                   except requests.RequestException as e:

     

       144
       144
       -
                       raise ResolutionError(self.handle, "HTTP request", f"Error requesting well-known endpoint: {str(e)}")

     

       176
       176
       +
                       raise ResolutionError(

     

       177
       177
       +
                           self.handle,

     

       178
       178
       +
                           "HTTP request",

     

       179
       179
       +
                           f"Error requesting well-known endpoint: {str(e)}",

     

       180
       180
       +
                       )

     

       145
       181
        
                   except Exception as e:

     

       146
       146
       -
                       raise ResolutionError(self.handle, "HTTP parsing", f"Error parsing HTTP response: {str(e)}")

     

       147
       147
       -
                       

     

       182
       182
       +
                       raise ResolutionError(

     

       183
       183
       +
                           self.handle,

     

       184
       184
       +
                           "HTTP parsing",

     

       185
       185
       +
                           f"Error parsing HTTP response: {str(e)}",

     

       186
       186
       +
                       )

     

       187
       187
       +
       

     

       148
       188
        
               except Exception as e:

     

       149
       189
        
                   if isinstance(e, ResolutionError):

     

       150
       190
        
                       raise

     

       151
       151
       -
                   raise ResolutionError(self.handle, "resolution", f"Unknown error occurred while resolving Handle: {str(e)}")

     

       191
       191
       +
                   raise ResolutionError(

     

       192
       192
       +
                       self.handle,

     

       193
       193
       +
                       "resolution",

     

       194
       194
       +
                       f"Unknown error occurred while resolving Handle: {str(e)}",

     

       195
       195
       +
                   )

+82 -20

src/atpasser/uri/nsid.py

···

       36
       36
        
               if "#" in nsid:

     

       37
       37
        
                   parts = nsid.split("#", 1)

     

       38
       38
        
                   if len(parts) != 2:

     

       39
       39
       -
                       raise InvalidNSIDError(nsid, "invalid format", "NSID fragment format is incorrect")

     

       39
       39
       +
                       raise InvalidNSIDError(

     

       40
       40
       +
                           nsid, "invalid format", "NSID fragment format is incorrect"

     

       41
       41
       +
                       )

     

       40
       42
        
                   nsidWithoutFragment, fragment = parts

     

       41
       43
        
               else:

     

       42
       44
        
                   nsidWithoutFragment, fragment = nsid, None

     
···

       45
       47
        
               if not set([x for x in nsidWithoutFragment]).issubset(

     

       46
       48
        
                   set([chr(i) for i in range(0x80)])

     

       47
       49
        
               ):

     

       48
       48
       -
                   raise InvalidNSIDError(nsid, "contains invalid characters", "NSID must only contain ASCII characters")

     

       50
       50
       +
                   raise InvalidNSIDError(

     

       51
       51
       +
                       nsid,

     

       52
       52
       +
                       "contains invalid characters",

     

       53
       53
       +
                       "NSID must only contain ASCII characters",

     

       54
       54
       +
                   )

     

       49
       55
        
       

     

       50
       56
        
               # Check length

     

       51
       57
        
               if len(nsidWithoutFragment) > 317:

     

       52
       52
       -
                   raise InvalidNSIDError(nsid, "exceeds maximum length", f"NSID length {len(nsidWithoutFragment)} exceeds maximum allowed length of 317 characters")

     

       58
       58
       +
                   raise InvalidNSIDError(

     

       59
       59
       +
                       nsid,

     

       60
       60
       +
                       "exceeds maximum length",

     

       61
       61
       +
                       f"NSID length {len(nsidWithoutFragment)} exceeds maximum allowed length of 317 characters",

     

       62
       62
       +
                   )

     

       53
       63
        
       

     

       54
       64
        
               segments = nsidWithoutFragment.split(".")

     

       55
       65
        
       

     

       56
       66
        
               # Check for leading or trailing dots

     

       57
       67
        
               if nsidWithoutFragment.startswith(".") or nsidWithoutFragment.endswith("."):

     

       58
       58
       -
                   raise InvalidNSIDError(nsid, "invalid format", "NSID cannot start or end with a dot")

     

       68
       68
       +
                   raise InvalidNSIDError(

     

       69
       69
       +
                       nsid, "invalid format", "NSID cannot start or end with a dot"

     

       70
       70
       +
                   )

     

       59
       71
        
       

     

       60
       72
        
               # Check segment count

     

       61
       73
        
               if len(segments) < 3:

     

       62
       62
       -
                   raise InvalidNSIDError(nsid, "invalid format", f"NSID must contain at least 3 segments, currently has {len(segments)}")

     

       74
       74
       +
                   raise InvalidNSIDError(

     

       75
       75
       +
                       nsid,

     

       76
       76
       +
                       "invalid format",

     

       77
       77
       +
                       f"NSID must contain at least 3 segments, currently has {len(segments)}",

     

       78
       78
       +
                   )

     

       63
       79
        
       

     

       64
       80
        
               domainAuthority = [segment.lower() for segment in segments[0:-1]]

     

       65
       81
        
       

     

       66
       82
        
               # Check domain authority length

     

       67
       83
        
               if len(".".join(domainAuthority)) > 253:

     

       68
       68
       -
                   raise InvalidNSIDError(nsid, "domain authority length exceeds limit", "Domain authority part length exceeds 253 characters")

     

       84
       84
       +
                   raise InvalidNSIDError(

     

       85
       85
       +
                       nsid,

     

       86
       86
       +
                       "domain authority length exceeds limit",

     

       87
       87
       +
                       "Domain authority part length exceeds 253 characters",

     

       88
       88
       +
                   )

     

       69
       89
        
       

     

       70
       90
        
               # Check each domain segment

     

       71
       91
        
               for i, segment in enumerate(domainAuthority):

     

       72
       92
        
                   if len(segment) > 63 or segment == "":

     

       73
       73
       -
                       raise InvalidNSIDError(nsid, "segment length error", f"Domain authority segment {i+1} length is not in the 1-63 character range")

     

       93
       93
       +
                       raise InvalidNSIDError(

     

       94
       94
       +
                           nsid,

     

       95
       95
       +
                           "segment length error",

     

       96
       96
       +
                           f"Domain authority segment {i+1} length is not in the 1-63 character range",

     

       97
       97
       +
                       )

     

       74
       98
        
                   if not set(segment).issubset(set("abcdefghijklmnopqrstuvwxyz0123456789-")):

     

       75
       75
       -
                       invalid_chars = set(segment) - set("abcdefghijklmnopqrstuvwxyz0123456789-")

     

       76
       76
       -
                       raise InvalidNSIDError(nsid, "contains invalid characters", f"Domain authority segment {i+1} contains invalid characters: {', '.join(invalid_chars)}")

     

       99
       99
       +
                       invalid_chars = set(segment) - set(

     

       100
       100
       +
                           "abcdefghijklmnopqrstuvwxyz0123456789-"

     

       101
       101
       +
                       )

     

       102
       102
       +
                       raise InvalidNSIDError(

     

       103
       103
       +
                           nsid,

     

       104
       104
       +
                           "contains invalid characters",

     

       105
       105
       +
                           f"Domain authority segment {i+1} contains invalid characters: {', '.join(invalid_chars)}",

     

       106
       106
       +
                       )

     

       77
       107
        
                   if segment.startswith("-") or segment.endswith("-"):

     

       78
       78
       -
                       raise InvalidNSIDError(nsid, "invalid format", f"Domain authority segment {i+1} cannot start or end with a hyphen")

     

       79
       79
       -
                       

     

       108
       108
       +
                       raise InvalidNSIDError(

     

       109
       109
       +
                           nsid,

     

       110
       110
       +
                           "invalid format",

     

       111
       111
       +
                           f"Domain authority segment {i+1} cannot start or end with a hyphen",

     

       112
       112
       +
                       )

     

       113
       113
       +
       

     

       80
       114
        
               # Check if top-level domain starts with a digit

     

       81
       115
        
               if segments[0][0] in "0123456789":

     

       82
       82
       -
                   raise InvalidNSIDError(nsid, "invalid format", "NSID's top-level domain cannot start with a digit")

     

       116
       116
       +
                   raise InvalidNSIDError(

     

       117
       117
       +
                       nsid,

     

       118
       118
       +
                       "invalid format",

     

       119
       119
       +
                       "NSID's top-level domain cannot start with a digit",

     

       120
       120
       +
                   )

     

       83
       121
        
       

     

       84
       122
        
               self.domainAuthority = domainAuthority

     

       85
       123
        
               self.domainAuthorityAsText = ".".join(domainAuthority)

     
···

       88
       126
        
       

     

       89
       127
        
               # Check name

     

       90
       128
        
               if name == "" or len(name) > 63:

     

       91
       91
       -
                   raise InvalidNSIDError(nsid, "name length error", "NSID name cannot be empty and length cannot exceed 63 characters")

     

       129
       129
       +
                   raise InvalidNSIDError(

     

       130
       130
       +
                       nsid,

     

       131
       131
       +
                       "name length error",

     

       132
       132
       +
                       "NSID name cannot be empty and length cannot exceed 63 characters",

     

       133
       133
       +
                   )

     

       92
       134
        
       

     

       93
       135
        
               if not set(name).issubset(

     

       94
       136
        
                   set("ABCDEFGHIJKLMNOPQRSTUVWXYZabcdefghijklmnopqrstuvwxyz0123456789")

     

       95
       137
        
               ):

     

       96
       96
       -
                   invalid_chars = set(name) - set("ABCDEFGHIJKLMNOPQRSTUVWXYZabcdefghijklmnopqrstuvwxyz0123456789")

     

       97
       97
       -
                   raise InvalidNSIDError(nsid, "contains invalid characters", f"NSID name contains invalid characters: {', '.join(invalid_chars)}")

     

       138
       138
       +
                   invalid_chars = set(name) - set(

     

       139
       139
       +
                       "ABCDEFGHIJKLMNOPQRSTUVWXYZabcdefghijklmnopqrstuvwxyz0123456789"

     

       140
       140
       +
                   )

     

       141
       141
       +
                   raise InvalidNSIDError(

     

       142
       142
       +
                       nsid,

     

       143
       143
       +
                       "contains invalid characters",

     

       144
       144
       +
                       f"NSID name contains invalid characters: {', '.join(invalid_chars)}",

     

       145
       145
       +
                   )

     

       98
       146
        
       

     

       99
       147
        
               if name[0] in "0123456789":

     

       100
       100
       -
                   raise InvalidNSIDError(nsid, "invalid format", "NSID name cannot start with a digit")

     

       148
       148
       +
                   raise InvalidNSIDError(

     

       149
       149
       +
                       nsid, "invalid format", "NSID name cannot start with a digit"

     

       150
       150
       +
                   )

     

       101
       151
        
       

     

       102
       152
        
               self.name = name

     

       103
       153
        
       

     

       104
       154
        
               # Check fragment

     

       105
       155
        
               if fragment != None:

     

       106
       156
        
                   if fragment == "" or len(fragment) > 63:

     

       107
       107
       -
                       raise InvalidNSIDError(nsid, "fragment length error", "NSID fragment cannot be empty and length cannot exceed 63 characters")

     

       157
       157
       +
                       raise InvalidNSIDError(

     

       158
       158
       +
                           nsid,

     

       159
       159
       +
                           "fragment length error",

     

       160
       160
       +
                           "NSID fragment cannot be empty and length cannot exceed 63 characters",

     

       161
       161
       +
                       )

     

       108
       162
        
       

     

       109
       163
        
                   if not set(fragment).issubset(

     

       110
       164
        
                       set("ABCDEFGHIJKLMNOPQRSTUVWXYZabcdefghijklmnopqrstuvwxyz0123456789")

     

       111
       165
        
                   ):

     

       112
       112
       -
                       invalid_chars = set(fragment) - set("ABCDEFGHIJKLMNOPQRSTUVWXYZabcdefghijklmnopqrstuvwxyz0123456789")

     

       113
       113
       -
                       raise InvalidNSIDError(nsid, "contains invalid characters", f"NSID fragment contains invalid characters: {', '.join(invalid_chars)}")

     

       166
       166
       +
                       invalid_chars = set(fragment) - set(

     

       167
       167
       +
                           "ABCDEFGHIJKLMNOPQRSTUVWXYZabcdefghijklmnopqrstuvwxyz0123456789"

     

       168
       168
       +
                       )

     

       169
       169
       +
                       raise InvalidNSIDError(

     

       170
       170
       +
                           nsid,

     

       171
       171
       +
                           "contains invalid characters",

     

       172
       172
       +
                           f"NSID fragment contains invalid characters: {', '.join(invalid_chars)}",

     

       173
       173
       +
                       )

     

       114
       174
        
       

     

       115
       175
        
                   if fragment[0] in "0123456789":

     

       116
       116
       -
                       raise InvalidNSIDError(nsid, "invalid format", "NSID fragment cannot start with a digit")

     

       176
       176
       +
                       raise InvalidNSIDError(

     

       177
       177
       +
                           nsid, "invalid format", "NSID fragment cannot start with a digit"

     

       178
       178
       +
                       )

     

       117
       179
        
       

     

       118
       180
        
                   self.fragment = fragment

     

       119
       181

-136

src/atpasser/uri/tid.py

···

       1
       1
       -
       import datetime, random

     

       2
       2
       -
       

     

       3
       3
       -
       

     

       4
       4
       -
       class TID:

     

       5
       5
       -
           """A class representing a TID (Time-based Identifier) in the AT Protocol.

     

       6
       6
       -
       

     

       7
       7
       -
           TIDs are time-based identifiers used for ordering and uniquely identifying

     

       8
       8
       -
           records in the AT Protocol. They combine a microsecond-precision timestamp

     

       9
       9
       -
           with a clock identifier to ensure uniqueness even when multiple records

     

       10
       10
       -
           are created in the same microsecond. TIDs are sortable and provide both

     

       11
       11
       -
           temporal ordering and uniqueness guarantees.

     

       12
       12
       -
       

     

       13
       13
       -
           Attributes:

     

       14
       14
       -
               timestamp (datetime.datetime): The timestamp component of the TID.

     

       15
       15
       -
               clockIdentifier (int): Clock identifier (0-1023) for disambiguation.

     

       16
       16
       -
           """

     

       17
       17
       -
       

     

       18
       18
       -
           def __init__(

     

       19
       19
       -
               self, time: datetime.datetime | None = None, clockIdentifier: int | None = None

     

       20
       20
       -
           ) -> None:

     

       21
       21
       -
               """Initializes a TID object with timestamp and clock identifier.

     

       22
       22
       -
       

     

       23
       23
       -
               Creates a new TID with the specified timestamp and clock identifier.

     

       24
       24
       -
               If no timestamp is provided, uses the current time. If no clock identifier

     

       25
       25
       -
               is provided, generates a random value between 0-1023.

     

       26
       26
       -
       

     

       27
       27
       -
               Args:

     

       28
       28
       -
                   time (datetime.datetime, optional): The timestamp for the TID.

     

       29
       29
       -
                       Defaults to current time if not provided.

     

       30
       30
       -
                   clockIdentifier (int, optional): Clock identifier (0-1023) for

     

       31
       31
       -
                       disambiguation. Defaults to random value if not provided.

     

       32
       32
       -
               """

     

       33
       33
       -
               if time == None:

     

       34
       34
       -
                   self.timestamp = datetime.datetime.now()

     

       35
       35
       -
               else:

     

       36
       36
       -
                   self.timestamp = time

     

       37
       37
       -
               if clockIdentifier == None:

     

       38
       38
       -
                   self.clockIdentifier = random.randrange(0, 1024)

     

       39
       39
       -
               else:

     

       40
       40
       -
                   self.clockIdentifier = clockIdentifier

     

       41
       41
       -
       

     

       42
       42
       -
           def __int__(self):

     

       43
       43
       -
               """Convert the TID to its integer representation.

     

       44
       44
       -
       

     

       45
       45
       -
               Combines the timestamp (in microseconds) and clock identifier into

     

       46
       46
       -
               a single 64-bit integer where the high bits represent the timestamp

     

       47
       47
       -
               and the low 10 bits represent the clock identifier.

     

       48
       48
       -
       

     

       49
       49
       -
               Returns:

     

       50
       50
       -
                   int: The integer representation of the TID.

     

       51
       51
       -
               """

     

       52
       52
       -
               timestamp = int(self.timestamp.timestamp() * 1000000)

     

       53
       53
       -
               return timestamp * 1024 + self.clockIdentifier

     

       54
       54
       -
       

     

       55
       55
       -
           def __str__(self):

     

       56
       56
       -
               """Convert the TID to a base32-sortable string representation.

     

       57
       57
       -
       

     

       58
       58
       -
               Encodes the TID as a base32 string using a custom character set that

     

       59
       59
       -
               maintains lexicographical sort order corresponding to temporal order.

     

       60
       60
       -
               This format is commonly used in the AT Protocol for compact,

     

       61
       61
       -
               sortable identifiers.

     

       62
       62
       -
       

     

       63
       63
       -
               Returns:

     

       64
       64
       -
                   str: The base32 string representation of the TID.

     

       65
       65
       -
               """

     

       66
       66
       -
               integer = int(self)

     

       67
       67
       -
               binary = f"{integer:065b}"

     

       68
       68
       -
               return "".join(

     

       69
       69
       -
                   [

     

       70
       70
       -
                       "234567abcdefghijklmnopqrstuvwxyz"[int(binary[i : i + 5], base=2)]

     

       71
       71
       -
                       for i in range(0, len(binary), 5)

     

       72
       72
       -
                   ]

     

       73
       73
       -
               )

     

       74
       74
       -
       

     

       75
       75
       -
           def __eq__(self, value: object, /) -> bool:

     

       76
       76
       -
               """Check if two TID objects represent the same identifier.

     

       77
       77
       -
       

     

       78
       78
       -
               Args:

     

       79
       79
       -
                   value (object): The object to compare with.

     

       80
       80
       -
       

     

       81
       81
       -
               Returns:

     

       82
       82
       -
                   bool: True if the objects represent the same TID, False otherwise.

     

       83
       83
       -
               """

     

       84
       84
       -
               if isinstance(value, TID):

     

       85
       85
       -
                   return int(self) == int(value)

     

       86
       86
       -
               else:

     

       87
       87
       -
                   return False

     

       88
       88
       -
       

     

       89
       89
       -
       

     

       90
       90
       -
       def importTIDfromInteger(value: int | None = None):

     

       91
       91
       -
           """Create a TID object from an integer representation.

     

       92
       92
       -
       

     

       93
       93
       -
           Converts a 64-bit integer back into a TID object by extracting the

     

       94
       94
       -
           timestamp and clock identifier components. If no value is provided,

     

       95
       95
       -
           creates a TID for the current time.

     

       96
       96
       -
       

     

       97
       97
       -
           Args:

     

       98
       98
       -
               value (int, optional): The integer value to convert to a TID.

     

       99
       99
       -
                   Defaults to creating a TID for the current time if not provided.

     

       100
       100
       -
       

     

       101
       101
       -
           Returns:

     

       102
       102
       -
               TID: The TID object created from the integer value.

     

       103
       103
       -
           """

     

       104
       104
       -
           if value == None:

     

       105
       105
       -
               value = int(TID())

     

       106
       106
       -
           clockIdentifier = value % 1024

     

       107
       107
       -
           timestamp = (value >> 10) / 1000000

     

       108
       108
       -
           return TID(datetime.datetime.fromtimestamp(timestamp), clockIdentifier)

     

       109
       109
       -
       

     

       110
       110
       -
       

     

       111
       111
       -
       def importTIDfromBase32(value: str | None = None):

     

       112
       112
       -
           """Create a TID object from a base32 string representation.

     

       113
       113
       -
       

     

       114
       114
       -
           Converts a base32-encoded TID string back into a TID object by decoding

     

       115
       115
       -
           the string to its integer representation and then extracting the timestamp

     

       116
       116
       -
           and clock identifier components. If no value is provided, creates a TID

     

       117
       117
       -
           for the current time.

     

       118
       118
       -
       

     

       119
       119
       -
           Args:

     

       120
       120
       -
               value (str, optional): The base32 string to convert to a TID.

     

       121
       121
       -
                   Defaults to creating a TID for the current time if not provided.

     

       122
       122
       -
       

     

       123
       123
       -
           Returns:

     

       124
       124
       -
               TID: The TID object created from the base32 string.

     

       125
       125
       -
           """

     

       126
       126
       -
           if value == None:

     

       127
       127
       -
               value = str(TID())

     

       128
       128
       -
           b32s = "234567abcdefghijklmnopqrstuvwxyz"

     

       129
       129
       -
           return importTIDfromInteger(

     

       130
       130
       -
               sum(

     

       131
       131
       -
                   [

     

       132
       132
       -
                       b32s.find(value[i]) * (32 ** (len(value) - i - 1))

     

       133
       133
       -
                       for i in range(len(value))

     

       134
       134
       -
                   ]

     

       135
       135
       -
               )

     

       136
       136
       -
           )

src/atpasser/uri/__init__.py

···

       144
       144
        
                           "JSONPath parsing failed",

     

       145
       145
        
                           f"Failed to parse JSONPath fragment '{fragment}': {str(e)}",

     

       146
       146
        
                       )

     

       147
       147
       +
               else:

     

       148
       148
       +
                   self.fragment = None

     

       149
       149
       +
                   self.fragmentAsText = None

     

       147
       150
        
       

     

       148
       151
        
               if query != None:

     

       149
       152
        
                   try:

-182

src/atpasser/data/decoder.py

···

       1
       1
       -
       """

     

       2
       2
       -
       JSON decoder for ATProto data model.

     

       3
       3
       -
       

     

       4
       4
       -
       This module provides a JSON decoder that handles ATProto-specific data types,

     

       5
       5
       -
       including bytes, CID links, and typed objects.

     

       6
       6
       -
       """

     

       7
       7
       -
       

     

       8
       8
       -
       import base64

     

       9
       9
       -
       import json

     

       10
       10
       -
       from typing import Any, Callable, Dict, Optional

     

       11
       11
       -
       from cid import CIDv0, CIDv1, make_cid

     

       12
       12
       -
       

     

       13
       13
       -
       

     

       14
       14
       -
       class JsonDecoder(json.JSONDecoder):

     

       15
       15
       -
           """A JSON decoder that supports ATProto data types.

     

       16
       16
       -
       

     

       17
       17
       -
           This decoder extends the standard JSON decoder to handle ATProto-specific

     

       18
       18
       -
           data types, including bytes, CID links, and typed objects.

     

       19
       19
       -
       

     

       20
       20
       -
           Attributes:

     

       21
       21
       -
               type_hook_registry: Registry for type-specific hooks.

     

       22
       22
       -
               encoding: The encoding to use for string deserialization.

     

       23
       23
       -
           """

     

       24
       24
       -
       

     

       25
       25
       -
           def __init__(

     

       26
       26
       -
               self,

     

       27
       27
       -
               *,

     

       28
       28
       -
               object_hook: Optional[Callable[[Dict[str, Any]], Any]] = None,

     

       29
       29
       -
               type_hook_registry: Optional[Any] = None,

     

       30
       30
       -
               type_processor_registry: Optional[Any] = None,

     

       31
       31
       -
               encoding: str = "utf-8",

     

       32
       32
       -
               **kwargs: Any,

     

       33
       33
       -
           ) -> None:

     

       34
       34
       -
               """Initialize the JSON decoder.

     

       35
       35
       -
       

     

       36
       36
       -
               Args:

     

       37
       37
       -
                   object_hook: Optional function to call with each decoded object.

     

       38
       38
       -
                   type_hook_registry: Registry for type-specific hooks.

     

       39
       39
       -
                   type_processor_registry: Registry for type-specific processors.

     

       40
       40
       -
                   encoding: The encoding to use for string deserialization.

     

       41
       41
       -
                   **kwargs: Additional keyword arguments to pass to the parent class.

     

       42
       42
       -
               """

     

       43
       43
       -
               # Use the type processor registry if provided, otherwise use the type hook registry

     

       44
       44
       -
               if type_processor_registry is not None:

     

       45
       45
       -
                   type_hook_registry = type_processor_registry.to_hook_registry()

     

       46
       46
       -
               elif type_hook_registry is None:

     

       47
       47
       -
                   from .hooks import get_global_registry

     

       48
       48
       -
       

     

       49
       49
       -
                   type_hook_registry = get_global_registry()

     

       50
       50
       -
       

     

       51
       51
       -
               # Create a combined object hook that calls both the custom hook and our hook

     

       52
       52
       -
               combined_hook = self._create_combined_hook(object_hook, type_hook_registry)

     

       53
       53
       -
       

     

       54
       54
       -
               super().__init__(object_hook=combined_hook, **kwargs)

     

       55
       55
       -
               self.type_hook_registry = type_hook_registry

     

       56
       56
       -
               self.type_processor_registry = type_processor_registry

     

       57
       57
       -
               self.encoding = encoding

     

       58
       58
       -
       

     

       59
       59
       -
           def _create_combined_hook(

     

       60
       60
       -
               self,

     

       61
       61
       -
               custom_hook: Optional[Callable[[Dict[str, Any]], Any]],

     

       62
       62
       -
               type_hook_registry: Optional[Any],

     

       63
       63
       -
           ) -> Callable[[Dict[str, Any]], Any]:

     

       64
       64
       -
               """Create a combined object hook function.

     

       65
       65
       -
       

     

       66
       66
       -
               Args:

     

       67
       67
       -
                   custom_hook: Optional custom object hook function.

     

       68
       68
       -
                   type_hook_registry: Registry for type-specific hooks.

     

       69
       69
       -
       

     

       70
       70
       -
               Returns:

     

       71
       71
       -
                   A combined object hook function.

     

       72
       72
       -
               """

     

       73
       73
       -
       

     

       74
       74
       -
               def combined_hook(obj: Dict[str, Any]) -> Any:

     

       75
       75
       -
                   # First, apply our ATProto-specific decoding

     

       76
       76
       -
                   decoded_obj = self._atproto_object_hook(obj)

     

       77
       77
       -
       

     

       78
       78
       -
                   # Then, apply the custom hook if provided

     

       79
       79
       -
                   if custom_hook is not None:

     

       80
       80
       -
                       decoded_obj = custom_hook(decoded_obj)

     

       81
       81
       -
       

     

       82
       82
       -
                   return decoded_obj

     

       83
       83
       -
       

     

       84
       84
       -
               return combined_hook

     

       85
       85
       -
       

     

       86
       86
       -
           def _atproto_object_hook(self, obj: Dict[str, Any]) -> Any:

     

       87
       87
       -
               """Handle ATProto-specific object decoding.

     

       88
       88
       -
       

     

       89
       89
       -
               Args:

     

       90
       90
       -
                   obj: The object to decode.

     

       91
       91
       -
       

     

       92
       92
       -
               Returns:

     

       93
       93
       -
                   The decoded object.

     

       94
       94
       -
               """

     

       95
       95
       -
               # Handle $bytes key (RFC-4648 base64 decoding)

     

       96
       96
       -
               if "$bytes" in obj:

     

       97
       97
       -
                   if len(obj) != 1:

     

       98
       98
       -
                       # If there are other keys, this is invalid

     

       99
       99
       -
                       raise ValueError(f"Invalid $bytes object: {obj}")

     

       100
       100
       -
                   return base64.b64decode(obj["$bytes"].encode(self.encoding))

     

       101
       101
       -
       

     

       102
       102
       -
               # Handle $link key (CID parsing)

     

       103
       103
       -
               elif "$link" in obj:

     

       104
       104
       -
                   if len(obj) != 1:

     

       105
       105
       -
                       # If there are other keys, this is invalid

     

       106
       106
       -
                       raise ValueError(f"Invalid $link object: {obj}")

     

       107
       107
       -
                   return make_cid(obj["$link"])

     

       108
       108
       -
       

     

       109
       109
       -
               # Handle $type key (typed objects)

     

       110
       110
       -
               elif "$type" in obj:

     

       111
       111
       -
                   type_value = obj["$type"]

     

       112
       112
       -
                   remaining_obj = {k: v for k, v in obj.items() if k != "$type"}

     

       113
       113
       -
       

     

       114
       114
       -
                   # Check if there's a registered type handler

     

       115
       115
       -
                   if self.type_hook_registry is not None:

     

       116
       116
       -
                       handler = self.type_hook_registry.get_handler(type_value)

     

       117
       117
       -
                       if handler is not None:

     

       118
       118
       -
                           return handler(remaining_obj)

     

       119
       119
       -
       

     

       120
       120
       -
                   # If no handler is registered, return a typed object

     

       121
       121
       -
                   return TypedObject(type_value, remaining_obj)

     

       122
       122
       -
       

     

       123
       123
       -
               # Handle nested objects recursively

     

       124
       124
       -
               elif isinstance(obj, dict):

     

       125
       125
       -
                   return {

     

       126
       126
       -
                       k: self._atproto_object_hook(v) if isinstance(v, dict) else v

     

       127
       127
       -
                       for k, v in obj.items()

     

       128
       128
       -
                   }

     

       129
       129
       -
       

     

       130
       130
       -
               return obj

     

       131
       131
       -
       

     

       132
       132
       -
       

     

       133
       133
       -
       class TypedObject:

     

       134
       134
       -
           """A typed object in the ATProto data model.

     

       135
       135
       -
       

     

       136
       136
       -
           This class represents an object with a $type field in the ATProto data model.

     

       137
       137
       -
       

     

       138
       138
       -
           Attributes:

     

       139
       139
       -
               type: The type of the object.

     

       140
       140
       -
               data: The data associated with the object.

     

       141
       141
       -
           """

     

       142
       142
       -
       

     

       143
       143
       -
           def __init__(self, type_name: str, data: Dict[str, Any]) -> None:

     

       144
       144
       -
               """Initialize a typed object.

     

       145
       145
       -
       

     

       146
       146
       -
               Args:

     

       147
       147
       -
                   type_name: The type of the object.

     

       148
       148
       -
                   data: The data associated with the object.

     

       149
       149
       -
               """

     

       150
       150
       -
               self.type_name = type_name

     

       151
       151
       -
               self.data = data

     

       152
       152
       -
       

     

       153
       153
       -
           def __repr__(self) -> str:

     

       154
       154
       -
               """Return a string representation of the typed object.

     

       155
       155
       -
       

     

       156
       156
       -
               Returns:

     

       157
       157
       -
                   A string representation of the typed object.

     

       158
       158
       -
               """

     

       159
       159
       -
               return f"TypedObject(type_name={self.type_name!r}, data={self.data!r})"

     

       160
       160
       -
       

     

       161
       161
       -
           def __eq__(self, other: Any) -> bool:

     

       162
       162
       -
               """Check if two typed objects are equal.

     

       163
       163
       -
       

     

       164
       164
       -
               Args:

     

       165
       165
       -
                   other: The object to compare with.

     

       166
       166
       -
       

     

       167
       167
       -
               Returns:

     

       168
       168
       -
                   True if the objects are equal, False otherwise.

     

       169
       169
       -
               """

     

       170
       170
       -
               if not isinstance(other, TypedObject):

     

       171
       171
       -
                   return False

     

       172
       172
       -
               return self.type_name == other.type_name and self.data == other.data

     

       173
       173
       -
       

     

       174
       174
       -
           def __atproto_json_encode__(self) -> Dict[str, Any]:

     

       175
       175
       -
               """Encode the typed object to a JSON-serializable format.

     

       176
       176
       -
       

     

       177
       177
       -
               Returns:

     

       178
       178
       -
                   A JSON-serializable representation of the typed object.

     

       179
       179
       -
               """

     

       180
       180
       -
               result = {"$type": self.type_name}

     

       181
       181
       -
               result.update(self.data)

     

       182
       182
       -
               return result

-82

src/atpasser/data/encoder.py

···

       1
       1
       -
       """

     

       2
       2
       -
       JSON encoder for ATProto data model.

     

       3
       3
       -
       

     

       4
       4
       -
       This module provides a JSON encoder that handles ATProto-specific data types,

     

       5
       5
       -
       including bytes, CID links, and typed objects.

     

       6
       6
       -
       """

     

       7
       7
       -
       

     

       8
       8
       -
       import base64

     

       9
       9
       -
       import json

     

       10
       10
       -
       from typing import Any, Optional

     

       11
       11
       -
       from cid import CIDv0, CIDv1

     

       12
       12
       -
       

     

       13
       13
       -
       

     

       14
       14
       -
       class JsonEncoder(json.JSONEncoder):

     

       15
       15
       -
           """A JSON encoder that supports ATProto data types.

     

       16
       16
       -
       

     

       17
       17
       -
           This encoder extends the standard JSON encoder to handle ATProto-specific

     

       18
       18
       -
           data types, including bytes, CID links, and typed objects.

     

       19
       19
       -
       

     

       20
       20
       -
           Attributes:

     

       21
       21
       -
               encoding (str): The encoding to use for string serialization.

     

       22
       22
       -
               type_processor_registry: Registry for type-specific processors.

     

       23
       23
       -
           """

     

       24
       24
       -
       

     

       25
       25
       -
           def __init__(

     

       26
       26
       -
               self,

     

       27
       27
       -
               *,

     

       28
       28
       -
               encoding: str = "utf-8",

     

       29
       29
       -
               type_processor_registry: Optional[Any] = None,

     

       30
       30
       -
               **kwargs: Any,

     

       31
       31
       -
           ) -> None:

     

       32
       32
       -
               """Initialize the JSON encoder.

     

       33
       33
       -
       

     

       34
       34
       -
               Args:

     

       35
       35
       -
                   encoding: The encoding to use for string serialization.

     

       36
       36
       -
                   type_processor_registry: Registry for type-specific processors.

     

       37
       37
       -
                   **kwargs: Additional keyword arguments to pass to the parent class.

     

       38
       38
       -
               """

     

       39
       39
       -
               super().__init__(**kwargs)

     

       40
       40
       -
               self.encoding = encoding

     

       41
       41
       -
               self.type_processor_registry = type_processor_registry

     

       42
       42
       -
       

     

       43
       43
       -
           def default(self, o: Any) -> Any:

     

       44
       44
       -
               """Convert an object to a serializable format.

     

       45
       45
       -
       

     

       46
       46
       -
               Args:

     

       47
       47
       -
                   o: The object to serialize.

     

       48
       48
       -
       

     

       49
       49
       -
               Returns:

     

       50
       50
       -
                   A serializable representation of the object.

     

       51
       51
       -
       

     

       52
       52
       -
               Raises:

     

       53
       53
       -
                   TypeError: If the object is not serializable.

     

       54
       54
       -
               """

     

       55
       55
       -
               if isinstance(o, bytes):

     

       56
       56
       -
                   # Handle bytes using RFC-4648 base64 encoding

     

       57
       57
       -
                   return {"$bytes": base64.b64encode(o).decode(self.encoding)}

     

       58
       58
       -
               elif isinstance(o, (CIDv0, CIDv1)):

     

       59
       59
       -
                   # Handle CID objects

     

       60
       60
       -
                   return {"$link": str(o)}

     

       61
       61
       -
               elif hasattr(o, "__atproto_json_encode__"):

     

       62
       62
       -
                   # Handle objects with custom ATProto encoding

     

       63
       63
       -
                   return o.__atproto_json_encode__()

     

       64
       64
       -
               elif self.type_processor_registry is not None:

     

       65
       65
       -
                   # Try to find a type processor for this object

     

       66
       66
       -
                   obj_type_name = type(o).__name__

     

       67
       67
       -
                   encoder = self.type_processor_registry.get_encoder(obj_type_name)

     

       68
       68
       -
                   if encoder is not None:

     

       69
       69
       -
                       result = encoder(o)

     

       70
       70
       -
                       # Add $type field if not already present

     

       71
       71
       -
                       if isinstance(result, dict) and "$type" not in result:

     

       72
       72
       -
                           result["$type"] = obj_type_name

     

       73
       73
       -
                       return result

     

       74
       74
       -
               elif isinstance(o, dict):

     

       75
       75
       -
                   # Handle dictionaries recursively

     

       76
       76
       -
                   return {k: self.default(v) for k, v in o.items()}

     

       77
       77
       -
               elif isinstance(o, (list, tuple)):

     

       78
       78
       -
                   # Handle lists and tuples recursively

     

       79
       79
       -
                   return [self.default(item) for item in o]

     

       80
       80
       -
               else:

     

       81
       81
       -
                   # Use the parent class for other types

     

       82
       82
       -
                   return super().default(o)

-227

src/atpasser/data/hooks.py

···

       1
       1
       -
       """

     

       2
       2
       -
       Type hook system for ATProto JSON decoder.

     

       3
       3
       -
       

     

       4
       4
       -
       This module provides a decorator-based system for registering custom type handlers

     

       5
       5
       -
       for objects with $type keys in the ATProto data model.

     

       6
       6
       -
       """

     

       7
       7
       -
       

     

       8
       8
       -
       import functools

     

       9
       9
       -
       from typing import Any, Callable, Dict, Optional, TypeVar, Union

     

       10
       10
       -
       

     

       11
       11
       -
       # Type variable for the decorated function

     

       12
       12
       -
       F = TypeVar("F", bound=Callable[..., Any])

     

       13
       13
       -
       

     

       14
       14
       -
       

     

       15
       15
       -
       class TypeHookRegistry:

     

       16
       16
       -
           """Registry for type-specific hooks in the ATProto JSON decoder.

     

       17
       17
       -
       

     

       18
       18
       -
           This class maintains a registry of type-specific hooks that can be used

     

       19
       19
       -
           to customize the decoding of objects with $type keys in the ATProto data model.

     

       20
       20
       -
       

     

       21
       21
       -
           Attributes:

     

       22
       22
       -
               _handlers: Dictionary mapping type names to handler functions.

     

       23
       23
       -
           """

     

       24
       24
       -
       

     

       25
       25
       -
           def __init__(self) -> None:

     

       26
       26
       -
               """Initialize the type hook registry."""

     

       27
       27
       -
               self._handlers: Dict[str, Callable[[Dict[str, Any]], Any]] = {}

     

       28
       28
       -
       

     

       29
       29
       -
           def register(self, type_name: str) -> Callable[[F], F]:

     

       30
       30
       -
               """Register a type handler function.

     

       31
       31
       -
       

     

       32
       32
       -
               This method can be used as a decorator to register a function as a handler

     

       33
       33
       -
               for a specific type.

     

       34
       34
       -
       

     

       35
       35
       -
               Args:

     

       36
       36
       -
                   type_name: The name of the type to handle.

     

       37
       37
       -
       

     

       38
       38
       -
               Returns:

     

       39
       39
       -
                   A decorator function that registers the decorated function as a handler.

     

       40
       40
       -
       

     

       41
       41
       -
               Example:

     

       42
       42
       -
                   >>> registry = TypeHookRegistry()

     

       43
       43
       -
                   >>>

     

       44
       44
       -
                   >>> @registry.register("app.bsky.feed.post")

     

       45
       45
       -
                   ... def handle_post(data: Dict[str, Any]) -> Any:

     

       46
       46
       -
                   ...     return Post(**data)

     

       47
       47
       -
               """

     

       48
       48
       -
       

     

       49
       49
       -
               def decorator(func: F) -> F:

     

       50
       50
       -
                   self._handlers[type_name] = func

     

       51
       51
       -
                   return func

     

       52
       52
       -
       

     

       53
       53
       -
               return decorator

     

       54
       54
       -
       

     

       55
       55
       -
           def register_handler(

     

       56
       56
       -
               self, type_name: str, handler: Callable[[Dict[str, Any]], Any]

     

       57
       57
       -
           ) -> None:

     

       58
       58
       -
               """Register a type handler function directly.

     

       59
       59
       -
       

     

       60
       60
       -
               Args:

     

       61
       61
       -
                   type_name: The name of the type to handle.

     

       62
       62
       -
                   handler: The function to call when decoding objects of this type.

     

       63
       63
       -
       

     

       64
       64
       -
               Example:

     

       65
       65
       -
                   >>> registry = TypeHookRegistry()

     

       66
       66
       -
                   >>>

     

       67
       67
       -
                   >>> def handle_post(data: Dict[str, Any]) -> Any:

     

       68
       68
       -
                   ...     return Post(**data)

     

       69
       69
       -
                   >>>

     

       70
       70
       -
                   >>> registry.register_handler("app.bsky.feed.post", handle_post)

     

       71
       71
       -
               """

     

       72
       72
       -
               self._handlers[type_name] = handler

     

       73
       73
       -
       

     

       74
       74
       -
           def unregister(self, type_name: str) -> None:

     

       75
       75
       -
               """Unregister a type handler function.

     

       76
       76
       -
       

     

       77
       77
       -
               Args:

     

       78
       78
       -
                   type_name: The name of the type to unregister.

     

       79
       79
       -
               """

     

       80
       80
       -
               if type_name in self._handlers:

     

       81
       81
       -
                   del self._handlers[type_name]

     

       82
       82
       -
       

     

       83
       83
       -
           def get_handler(self, type_name: str) -> Optional[Callable[[Dict[str, Any]], Any]]:

     

       84
       84
       -
               """Get the handler function for a specific type.

     

       85
       85
       -
       

     

       86
       86
       -
               Args:

     

       87
       87
       -
                   type_name: The name of the type to get the handler for.

     

       88
       88
       -
       

     

       89
       89
       -
               Returns:

     

       90
       90
       -
                   The handler function for the specified type, or None if no handler

     

       91
       91
       -
                   is registered.

     

       92
       92
       -
               """

     

       93
       93
       -
               return self._handlers.get(type_name)

     

       94
       94
       -
       

     

       95
       95
       -
           def has_handler(self, type_name: str) -> bool:

     

       96
       96
       -
               """Check if a handler is registered for a specific type.

     

       97
       97
       -
       

     

       98
       98
       -
               Args:

     

       99
       99
       -
                   type_name: The name of the type to check.

     

       100
       100
       -
       

     

       101
       101
       -
               Returns:

     

       102
       102
       -
                   True if a handler is registered for the specified type, False otherwise.

     

       103
       103
       -
               """

     

       104
       104
       -
               return type_name in self._handlers

     

       105
       105
       -
       

     

       106
       106
       -
           def clear(self) -> None:

     

       107
       107
       -
               """Clear all registered handlers."""

     

       108
       108
       -
               self._handlers.clear()

     

       109
       109
       -
       

     

       110
       110
       -
           def get_registered_types(self) -> set:

     

       111
       111
       -
               """Get the set of all registered type names.

     

       112
       112
       -
       

     

       113
       113
       -
               Returns:

     

       114
       114
       -
                   A set of all registered type names.

     

       115
       115
       -
               """

     

       116
       116
       -
               return set(self._handlers.keys())

     

       117
       117
       -
       

     

       118
       118
       -
       

     

       119
       119
       -
       # Global registry instance

     

       120
       120
       -
       _global_registry = TypeHookRegistry()

     

       121
       121
       -
       

     

       122
       122
       -
       

     

       123
       123
       -
       def type_handler(type_name: str) -> Callable[[F], F]:

     

       124
       124
       -
           """Register a global type handler function.

     

       125
       125
       -
       

     

       126
       126
       -
           This decorator registers a function as a global handler for a specific type

     

       127
       127
       -
           in the ATProto data model.

     

       128
       128
       -
       

     

       129
       129
       -
           Args:

     

       130
       130
       -
               type_name: The name of the type to handle.

     

       131
       131
       -
       

     

       132
       132
       -
           Returns:

     

       133
       133
       -
               A decorator function that registers the decorated function as a handler.

     

       134
       134
       -
       

     

       135
       135
       -
           Example:

     

       136
       136
       -
               >>> @type_handler("app.bsky.feed.post")

     

       137
       137
       -
               ... def handle_post(data: Dict[str, Any]) -> Any:

     

       138
       138
       -
               ...     return Post(**data)

     

       139
       139
       -
           """

     

       140
       140
       -
           return _global_registry.register(type_name)

     

       141
       141
       -
       

     

       142
       142
       -
       

     

       143
       143
       -
       def get_global_registry() -> TypeHookRegistry:

     

       144
       144
       -
           """Get the global type hook registry.

     

       145
       145
       -
       

     

       146
       146
       -
           Returns:

     

       147
       147
       -
               The global TypeHookRegistry instance.

     

       148
       148
       -
           """

     

       149
       149
       -
           return _global_registry

     

       150
       150
       -
       

     

       151
       151
       -
       

     

       152
       152
       -
       def register_type_handler(

     

       153
       153
       -
           type_name: str, handler: Callable[[Dict[str, Any]], Any]

     

       154
       154
       -
       ) -> None:

     

       155
       155
       -
           """Register a global type handler function directly.

     

       156
       156
       -
       

     

       157
       157
       -
           Args:

     

       158
       158
       -
               type_name: The name of the type to handle.

     

       159
       159
       -
               handler: The function to call when decoding objects of this type.

     

       160
       160
       -
       

     

       161
       161
       -
           Example:

     

       162
       162
       -
               >>> def handle_post(data: Dict[str, Any]) -> Any:

     

       163
       163
       -
               ...     return Post(**data)

     

       164
       164
       -
               >>>

     

       165
       165
       -
               >>> register_type_handler("app.bsky.feed.post", handle_post)

     

       166
       166
       -
           """

     

       167
       167
       -
           _global_registry.register_handler(type_name, handler)

     

       168
       168
       -
       

     

       169
       169
       -
       

     

       170
       170
       -
       def unregister_type_handler(type_name: str) -> None:

     

       171
       171
       -
           """Unregister a global type handler function.

     

       172
       172
       -
       

     

       173
       173
       -
           Args:

     

       174
       174
       -
               type_name: The name of the type to unregister.

     

       175
       175
       -
           """

     

       176
       176
       -
           _global_registry.unregister(type_name)

     

       177
       177
       -
       

     

       178
       178
       -
       

     

       179
       179
       -
       def get_type_handler(type_name: str) -> Optional[Callable[[Dict[str, Any]], Any]]:

     

       180
       180
       -
           """Get the global handler function for a specific type.

     

       181
       181
       -
       

     

       182
       182
       -
           Args:

     

       183
       183
       -
               type_name: The name of the type to get the handler for.

     

       184
       184
       -
       

     

       185
       185
       -
           Returns:

     

       186
       186
       -
               The handler function for the specified type, or None if no handler

     

       187
       187
       -
               is registered.

     

       188
       188
       -
           """

     

       189
       189
       -
           return _global_registry.get_handler(type_name)

     

       190
       190
       -
       

     

       191
       191
       -
       

     

       192
       192
       -
       def has_type_handler(type_name: str) -> bool:

     

       193
       193
       -
           """Check if a global handler is registered for a specific type.

     

       194
       194
       -
       

     

       195
       195
       -
           Args:

     

       196
       196
       -
               type_name: The name of the type to check.

     

       197
       197
       -
       

     

       198
       198
       -
           Returns:

     

       199
       199
       -
               True if a handler is registered for the specified type, False otherwise.

     

       200
       200
       -
           """

     

       201
       201
       -
           return _global_registry.has_handler(type_name)

     

       202
       202
       -
       

     

       203
       203
       -
       

     

       204
       204
       -
       def clear_type_handlers() -> None:

     

       205
       205
       -
           """Clear all globally registered handlers."""

     

       206
       206
       -
           _global_registry.clear()

     

       207
       207
       -
       

     

       208
       208
       -
       

     

       209
       209
       -
       def get_registered_types() -> set:

     

       210
       210
       -
           """Get the set of all globally registered type names.

     

       211
       211
       -
       

     

       212
       212
       -
           Returns:

     

       213
       213
       -
               A set of all registered type names.

     

       214
       214
       -
           """

     

       215
       215
       -
           return _global_registry.get_registered_types()

     

       216
       216
       -
       

     

       217
       217
       -
       

     

       218
       218
       -
       def create_registry() -> TypeHookRegistry:

     

       219
       219
       -
           """Create a new type hook registry.

     

       220
       220
       -
       

     

       221
       221
       -
           This function creates a new, independent registry that can be used

     

       222
       222
       -
           instead of the global registry.

     

       223
       223
       -
       

     

       224
       224
       -
           Returns:

     

       225
       225
       -
               A new TypeHookRegistry instance.

     

       226
       226
       -
           """

     

       227
       227
       -
           return TypeHookRegistry()

-510

src/atpasser/data/types.py

···

       1
       1
       -
       """

     

       2
       2
       -
       Type processor system for ATProto JSON decoder.

     

       3
       3
       -
       

     

       4
       4
       -
       This module provides an advanced type processor system that allows users to

     

       5
       5
       -
       register custom type converters for objects with $type keys in the ATProto data model.

     

       6
       6
       -
       """

     

       7
       7
       -
       

     

       8
       8
       -
       import inspect

     

       9
       9
       -
       from typing import Any, Callable, Dict, List, Optional, Type, TypeVar, Union

     

       10
       10
       -
       from .hooks import TypeHookRegistry

     

       11
       11
       -
       

     

       12
       12
       -
       # Type variable for the decorated class

     

       13
       13
       -
       T = TypeVar("T")

     

       14
       14
       -
       

     

       15
       15
       -
       

     

       16
       16
       -
       class TypeProcessor:

     

       17
       17
       -
           """A type processor for ATProto JSON objects.

     

       18
       18
       -
       

     

       19
       19
       -
           This class represents a processor for a specific type in the ATProto data model.

     

       20
       20
       -
           It contains information about how to convert JSON data to Python objects and

     

       21
       21
       -
           vice versa.

     

       22
       22
       -
       

     

       23
       23
       -
           Attributes:

     

       24
       24
       -
               type_name: The name of the type this processor handles.

     

       25
       25
       -
               decoder: The function to decode JSON data to a Python object.

     

       26
       26
       -
               encoder: The function to encode a Python object to JSON data.

     

       27
       27
       -
               priority: The priority of this processor (higher values = higher priority).

     

       28
       28
       -
           """

     

       29
       29
       -
       

     

       30
       30
       -
           def __init__(

     

       31
       31
       -
               self,

     

       32
       32
       -
               type_name: str,

     

       33
       33
       -
               decoder: Optional[Callable[[Dict[str, Any]], Any]] = None,

     

       34
       34
       -
               encoder: Optional[Callable[[Any], Dict[str, Any]]] = None,

     

       35
       35
       -
               priority: int = 0,

     

       36
       36
       -
           ) -> None:

     

       37
       37
       -
               """Initialize a type processor.

     

       38
       38
       -
       

     

       39
       39
       -
               Args:

     

       40
       40
       -
                   type_name: The name of the type this processor handles.

     

       41
       41
       -
                   decoder: The function to decode JSON data to a Python object.

     

       42
       42
       -
                   encoder: The function to encode a Python object to JSON data.

     

       43
       43
       -
                   priority: The priority of this processor (higher values = higher priority).

     

       44
       44
       -
               """

     

       45
       45
       -
               self.type_name = type_name

     

       46
       46
       -
               self.decoder = decoder

     

       47
       47
       -
               self.encoder = encoder

     

       48
       48
       -
               self.priority = priority

     

       49
       49
       -
       

     

       50
       50
       -
           def decode(self, data: Dict[str, Any]) -> Any:

     

       51
       51
       -
               """Decode JSON data to a Python object.

     

       52
       52
       -
       

     

       53
       53
       -
               Args:

     

       54
       54
       -
                   data: The JSON data to decode.

     

       55
       55
       -
       

     

       56
       56
       -
               Returns:

     

       57
       57
       -
                   The decoded Python object.

     

       58
       58
       -
       

     

       59
       59
       -
               Raises:

     

       60
       60
       -
                   ValueError: If no decoder is registered.

     

       61
       61
       -
               """

     

       62
       62
       -
               if self.decoder is None:

     

       63
       63
       -
                   raise ValueError(f"No decoder registered for type {self.type_name}")

     

       64
       64
       -
               return self.decoder(data)

     

       65
       65
       -
       

     

       66
       66
       -
           def encode(self, obj: Any) -> Dict[str, Any]:

     

       67
       67
       -
               """Encode a Python object to JSON data.

     

       68
       68
       -
       

     

       69
       69
       -
               Args:

     

       70
       70
       -
                   obj: The Python object to encode.

     

       71
       71
       -
       

     

       72
       72
       -
               Returns:

     

       73
       73
       -
                   The encoded JSON data.

     

       74
       74
       -
       

     

       75
       75
       -
               Raises:

     

       76
       76
       -
                   ValueError: If no encoder is registered.

     

       77
       77
       -
               """

     

       78
       78
       -
               if self.encoder is None:

     

       79
       79
       -
                   raise ValueError(f"No encoder registered for type {self.type_name}")

     

       80
       80
       -
               return self.encoder(obj)

     

       81
       81
       -
       

     

       82
       82
       -
       

     

       83
       83
       -
       class TypeProcessorRegistry:

     

       84
       84
       -
           """Registry for type processors in the ATProto JSON decoder.

     

       85
       85
       -
       

     

       86
       86
       -
           This class maintains a registry of type processors that can be used

     

       87
       87
       -
           to customize the encoding and decoding of objects with $type keys in

     

       88
       88
       -
           the ATProto data model.

     

       89
       89
       -
       

     

       90
       90
       -
           Attributes:

     

       91
       91
       -
               _processors: Dictionary mapping type names to processor lists.

     

       92
       92
       -
           """

     

       93
       93
       -
       

     

       94
       94
       -
           def __init__(self) -> None:

     

       95
       95
       -
               """Initialize the type processor registry."""

     

       96
       96
       -
               self._processors: Dict[str, List[TypeProcessor]] = {}

     

       97
       97
       -
       

     

       98
       98
       -
           def register_processor(self, processor: TypeProcessor) -> None:

     

       99
       99
       -
               """Register a type processor.

     

       100
       100
       -
       

     

       101
       101
       -
               Args:

     

       102
       102
       -
                   processor: The type processor to register.

     

       103
       103
       -
               """

     

       104
       104
       -
               if processor.type_name not in self._processors:

     

       105
       105
       -
                   self._processors[processor.type_name] = []

     

       106
       106
       -
       

     

       107
       107
       -
               self._processors[processor.type_name].append(processor)

     

       108
       108
       -
               # Sort processors by priority (descending)

     

       109
       109
       -
               self._processors[processor.type_name].sort(

     

       110
       110
       -
                   key=lambda p: p.priority, reverse=True

     

       111
       111
       -
               )

     

       112
       112
       -
       

     

       113
       113
       -
           def register(

     

       114
       114
       -
               self, type_name: str, priority: int = 0

     

       115
       115
       -
           ) -> Callable[[Callable[[Dict[str, Any]], Any]], Callable[[Dict[str, Any]], Any]]:

     

       116
       116
       -
               """Register a type decoder function.

     

       117
       117
       -
       

     

       118
       118
       -
               This method can be used as a decorator to register a function as a decoder

     

       119
       119
       -
               for a specific type.

     

       120
       120
       -
       

     

       121
       121
       -
               Args:

     

       122
       122
       -
                   type_name: The name of the type to handle.

     

       123
       123
       -
                   priority: The priority of this processor (higher values = higher priority).

     

       124
       124
       -
       

     

       125
       125
       -
               Returns:

     

       126
       126
       -
                   A decorator function that registers the decorated function as a decoder.

     

       127
       127
       -
       

     

       128
       128
       -
               Example:

     

       129
       129
       -
                   >>> registry = TypeProcessorRegistry()

     

       130
       130
       -
                   >>>

     

       131
       131
       -
                   >>> @registry.register("app.bsky.feed.post", priority=10)

     

       132
       132
       -
                   ... def decode_post(data: Dict[str, Any]) -> Any:

     

       133
       133
       -
                   ...     return Post(**data)

     

       134
       134
       -
               """

     

       135
       135
       -
       

     

       136
       136
       -
               def decorator(

     

       137
       137
       -
                   func: Callable[[Dict[str, Any]], Any],

     

       138
       138
       -
               ) -> Callable[[Dict[str, Any]], Any]:

     

       139
       139
       -
                   processor = TypeProcessor(type_name, decoder=func, priority=priority)

     

       140
       140
       -
                   self.register_processor(processor)

     

       141
       141
       -
                   return func

     

       142
       142
       -
       

     

       143
       143
       -
               return decorator

     

       144
       144
       -
       

     

       145
       145
       -
           def register_encoder(

     

       146
       146
       -
               self, type_name: str, priority: int = 0

     

       147
       147
       -
           ) -> Callable[[Callable[[Any], Dict[str, Any]]], Callable[[Any], Dict[str, Any]]]:

     

       148
       148
       -
               """Register a type encoder function.

     

       149
       149
       -
       

     

       150
       150
       -
               This method can be used as a decorator to register a function as an encoder

     

       151
       151
       -
               for a specific type.

     

       152
       152
       -
       

     

       153
       153
       -
               Args:

     

       154
       154
       -
                   type_name: The name of the type to handle.

     

       155
       155
       -
                   priority: The priority of this processor (higher values = higher priority).

     

       156
       156
       -
       

     

       157
       157
       -
               Returns:

     

       158
       158
       -
                   A decorator function that registers the decorated function as an encoder.

     

       159
       159
       -
       

     

       160
       160
       -
               Example:

     

       161
       161
       -
                   >>> registry = TypeProcessorRegistry()

     

       162
       162
       -
                   >>>

     

       163
       163
       -
                   >>> @registry.register_encoder("app.bsky.feed.post", priority=10)

     

       164
       164
       -
                   ... def encode_post(post: Post) -> Dict[str, Any]:

     

       165
       165
       -
                   ...     return {"text": post.text, "createdAt": post.created_at}

     

       166
       166
       -
               """

     

       167
       167
       -
       

     

       168
       168
       -
               def decorator(

     

       169
       169
       -
                   func: Callable[[Any], Dict[str, Any]],

     

       170
       170
       -
               ) -> Callable[[Any], Dict[str, Any]]:

     

       171
       171
       -
                   # Check if a processor for this type already exists

     

       172
       172
       -
                   if type_name in self._processors:

     

       173
       173
       -
                       for processor in self._processors[type_name]:

     

       174
       174
       -
                           if processor.decoder is not None:

     

       175
       175
       -
                               # Update the existing processor with the encoder

     

       176
       176
       -
                               processor.encoder = func

     

       177
       177
       -
                               break

     

       178
       178
       -
                       else:

     

       179
       179
       -
                           # No decoder found, create a new processor

     

       180
       180
       -
                           processor = TypeProcessor(

     

       181
       181
       -
                               type_name, encoder=func, priority=priority

     

       182
       182
       -
                           )

     

       183
       183
       -
                           self.register_processor(processor)

     

       184
       184
       -
                   else:

     

       185
       185
       -
                       # No processor exists, create a new one

     

       186
       186
       -
                       processor = TypeProcessor(type_name, encoder=func, priority=priority)

     

       187
       187
       -
                       self.register_processor(processor)

     

       188
       188
       -
       

     

       189
       189
       -
                   return func

     

       190
       190
       -
       

     

       191
       191
       -
               return decorator

     

       192
       192
       -
       

     

       193
       193
       -
           def register_class(

     

       194
       194
       -
               self, type_name: str, priority: int = 0

     

       195
       195
       -
           ) -> Callable[[Type[T]], Type[T]]:

     

       196
       196
       -
               """Register a class for both encoding and decoding.

     

       197
       197
       -
       

     

       198
       198
       -
               This method can be used as a decorator to register a class for both

     

       199
       199
       -
               encoding and decoding of a specific type.

     

       200
       200
       -
       

     

       201
       201
       -
               The class must have a class method `from_json` that takes a dictionary

     

       202
       202
       -
               and returns an instance of the class, and an instance method `to_json`

     

       203
       203
       -
               that returns a dictionary.

     

       204
       204
       -
       

     

       205
       205
       -
               Args:

     

       206
       206
       -
                   type_name: The name of the type to handle.

     

       207
       207
       -
                   priority: The priority of this processor (higher values = higher priority).

     

       208
       208
       -
       

     

       209
       209
       -
               Returns:

     

       210
       210
       -
                   A decorator function that registers the decorated class.

     

       211
       211
       -
       

     

       212
       212
       -
               Example:

     

       213
       213
       -
                   >>> registry = TypeProcessorRegistry()

     

       214
       214
       -
                   >>>

     

       215
       215
       -
                   >>> @registry.register_class("app.bsky.feed.post", priority=10)

     

       216
       216
       -
                   ... class Post:

     

       217
       217
       -
                   ...     def __init__(self, text: str, created_at: str) -> None:

     

       218
       218
       -
                   ...         self.text = text

     

       219
       219
       -
                   ...         self.created_at = created_at

     

       220
       220
       -
                   ...

     

       221
       221
       -
                   ...     @classmethod

     

       222
       222
       -
                   ...     def from_json(cls, data: Dict[str, Any]) -> "Post":

     

       223
       223
       -
                   ...         return cls(data["text"], data["createdAt"])

     

       224
       224
       -
                   ...

     

       225
       225
       -
                   ...     def to_json(self) -> Dict[str, Any]:

     

       226
       226
       -
                   ...         return {"text": self.text, "createdAt": self.created_at}

     

       227
       227
       -
               """

     

       228
       228
       -
       

     

       229
       229
       -
               def decorator(cls: Type[T]) -> Type[T]:

     

       230
       230
       -
                   # Create decoder from class method

     

       231
       231
       -
                   if hasattr(cls, "from_json"):

     

       232
       232
       -
                       decoder = lambda data: getattr(cls, "from_json")(data)

     

       233
       233
       -
                   else:

     

       234
       234
       -
                       # Try to create a decoder from the constructor

     

       235
       235
       -
                       init_signature = inspect.signature(cls.__init__)

     

       236
       236
       -
                       if init_signature.parameters:

     

       237
       237
       -
                           # Create a decoder that passes the data as keyword arguments

     

       238
       238
       -
                           decoder = lambda data: cls(**data)

     

       239
       239
       -
                       else:

     

       240
       240
       -
                           raise ValueError(

     

       241
       241
       -
                               f"Class {cls.__name__} has no from_json method or compatible __init__"

     

       242
       242
       -
                           )

     

       243
       243
       -
       

     

       244
       244
       -
                   # Create encoder from instance method

     

       245
       245
       -
                   if hasattr(cls, "to_json"):

     

       246
       246
       -
                       encoder = lambda obj: obj.to_json()

     

       247
       247
       -
                   else:

     

       248
       248
       -
                       raise ValueError(f"Class {cls.__name__} has no to_json method")

     

       249
       249
       -
       

     

       250
       250
       -
                   # Register the processor

     

       251
       251
       -
                   processor = TypeProcessor(

     

       252
       252
       -
                       type_name, decoder=decoder, encoder=encoder, priority=priority

     

       253
       253
       -
                   )

     

       254
       254
       -
                   self.register_processor(processor)

     

       255
       255
       -
       

     

       256
       256
       -
                   return cls

     

       257
       257
       -
       

     

       258
       258
       -
               return decorator

     

       259
       259
       -
       

     

       260
       260
       -
           def unregister(self, type_name: str, priority: Optional[int] = None) -> None:

     

       261
       261
       -
               """Unregister type processors.

     

       262
       262
       -
       

     

       263
       263
       -
               Args:

     

       264
       264
       -
                   type_name: The name of the type to unregister.

     

       265
       265
       -
                   priority: If specified, only unregister processors with this priority.

     

       266
       266
       -
               """

     

       267
       267
       -
               if type_name in self._processors:

     

       268
       268
       -
                   if priority is not None:

     

       269
       269
       -
                       # Remove processors with the specified priority

     

       270
       270
       -
                       self._processors[type_name] = [

     

       271
       271
       -
                           p for p in self._processors[type_name] if p.priority != priority

     

       272
       272
       -
                       ]

     

       273
       273
       -
                   else:

     

       274
       274
       -
                       # Remove all processors for this type

     

       275
       275
       -
                       del self._processors[type_name]

     

       276
       276
       -
       

     

       277
       277
       -
           def get_decoder(self, type_name: str) -> Optional[Callable[[Dict[str, Any]], Any]]:

     

       278
       278
       -
               """Get the decoder function for a specific type.

     

       279
       279
       -
       

     

       280
       280
       -
               Args:

     

       281
       281
       -
                   type_name: The name of the type to get the decoder for.

     

       282
       282
       -
       

     

       283
       283
       -
               Returns:

     

       284
       284
       -
                   The decoder function for the specified type, or None if no decoder

     

       285
       285
       -
                   is registered.

     

       286
       286
       -
               """

     

       287
       287
       -
               if type_name in self._processors and self._processors[type_name]:

     

       288
       288
       -
                   # Return the decoder of the highest priority processor

     

       289
       289
       -
                   return self._processors[type_name][0].decoder

     

       290
       290
       -
               return None

     

       291
       291
       -
       

     

       292
       292
       -
           def get_encoder(self, type_name: str) -> Optional[Callable[[Any], Dict[str, Any]]]:

     

       293
       293
       -
               """Get the encoder function for a specific type.

     

       294
       294
       -
       

     

       295
       295
       -
               Args:

     

       296
       296
       -
                   type_name: The name of the type to get the encoder for.

     

       297
       297
       -
       

     

       298
       298
       -
               Returns:

     

       299
       299
       -
                   The encoder function for the specified type, or None if no encoder

     

       300
       300
       -
                   is registered.

     

       301
       301
       -
               """

     

       302
       302
       -
               if type_name in self._processors and self._processors[type_name]:

     

       303
       303
       -
                   # Return the encoder of the highest priority processor

     

       304
       304
       -
                   return self._processors[type_name][0].encoder

     

       305
       305
       -
               return None

     

       306
       306
       -
       

     

       307
       307
       -
           def has_processor(self, type_name: str) -> bool:

     

       308
       308
       -
               """Check if a processor is registered for a specific type.

     

       309
       309
       -
       

     

       310
       310
       -
               Args:

     

       311
       311
       -
                   type_name: The name of the type to check.

     

       312
       312
       -
       

     

       313
       313
       -
               Returns:

     

       314
       314
       -
                   True if a processor is registered for the specified type, False otherwise.

     

       315
       315
       -
               """

     

       316
       316
       -
               return type_name in self._processors and bool(self._processors[type_name])

     

       317
       317
       -
       

     

       318
       318
       -
           def clear(self) -> None:

     

       319
       319
       -
               """Clear all registered processors."""

     

       320
       320
       -
               self._processors.clear()

     

       321
       321
       -
       

     

       322
       322
       -
           def get_registered_types(self) -> set:

     

       323
       323
       -
               """Get the set of all registered type names.

     

       324
       324
       -
       

     

       325
       325
       -
               Returns:

     

       326
       326
       -
                   A set of all registered type names.

     

       327
       327
       -
               """

     

       328
       328
       -
               return set(self._processors.keys())

     

       329
       329
       -
       

     

       330
       330
       -
           def to_hook_registry(self) -> TypeHookRegistry:

     

       331
       331
       -
               """Convert this processor registry to a hook registry.

     

       332
       332
       -
       

     

       333
       333
       -
               This method creates a TypeHookRegistry that uses the decoders from

     

       334
       334
       -
               this processor registry.

     

       335
       335
       -
       

     

       336
       336
       -
               Returns:

     

       337
       337
       -
                   A TypeHookRegistry with the same decoders as this processor registry.

     

       338
       338
       -
               """

     

       339
       339
       -
               hook_registry = TypeHookRegistry()

     

       340
       340
       -
       

     

       341
       341
       -
               for type_name, processors in self._processors.items():

     

       342
       342
       -
                   if processors and processors[0].decoder is not None:

     

       343
       343
       -
                       hook_registry.register_handler(type_name, processors[0].decoder)

     

       344
       344
       -
       

     

       345
       345
       -
               return hook_registry

     

       346
       346
       -
       

     

       347
       347
       -
       

     

       348
       348
       -
       # Global registry instance

     

       349
       349
       -
       _global_processor_registry = TypeProcessorRegistry()

     

       350
       350
       -
       

     

       351
       351
       -
       

     

       352
       352
       -
       def register_type(

     

       353
       353
       -
           type_name: str, priority: int = 0

     

       354
       354
       -
       ) -> Callable[[Callable[[Dict[str, Any]], Any]], Callable[[Dict[str, Any]], Any]]:

     

       355
       355
       -
           """Register a global type decoder function.

     

       356
       356
       -
       

     

       357
       357
       -
           This decorator registers a function as a global decoder for a specific type

     

       358
       358
       -
           in the ATProto data model.

     

       359
       359
       -
       

     

       360
       360
       -
           Args:

     

       361
       361
       -
               type_name: The name of the type to handle.

     

       362
       362
       -
               priority: The priority of this processor (higher values = higher priority).

     

       363
       363
       -
       

     

       364
       364
       -
           Returns:

     

       365
       365
       -
               A decorator function that registers the decorated function as a decoder.

     

       366
       366
       -
       

     

       367
       367
       -
           Example:

     

       368
       368
       -
               >>> @register_type("app.bsky.feed.post", priority=10)

     

       369
       369
       -
               ... def decode_post(data: Dict[str, Any]) -> Any:

     

       370
       370
       -
               ...     return Post(**data)

     

       371
       371
       -
           """

     

       372
       372
       -
           return _global_processor_registry.register(type_name, priority)

     

       373
       373
       -
       

     

       374
       374
       -
       

     

       375
       375
       -
       def get_global_processor_registry() -> TypeProcessorRegistry:

     

       376
       376
       -
           """Get the global type processor registry.

     

       377
       377
       -
       

     

       378
       378
       -
           Returns:

     

       379
       379
       -
               The global TypeProcessorRegistry instance.

     

       380
       380
       -
           """

     

       381
       381
       -
           return _global_processor_registry

     

       382
       382
       -
       

     

       383
       383
       -
       

     

       384
       384
       -
       def register_type_encoder(

     

       385
       385
       -
           type_name: str, priority: int = 0

     

       386
       386
       -
       ) -> Callable[[Callable[[Any], Dict[str, Any]]], Callable[[Any], Dict[str, Any]]]:

     

       387
       387
       -
           """Register a global type encoder function.

     

       388
       388
       -
       

     

       389
       389
       -
           This decorator registers a function as a global encoder for a specific type

     

       390
       390
       -
           in the ATProto data model.

     

       391
       391
       -
       

     

       392
       392
       -
           Args:

     

       393
       393
       -
               type_name: The name of the type to handle.

     

       394
       394
       -
               priority: The priority of this processor (higher values = higher priority).

     

       395
       395
       -
       

     

       396
       396
       -
           Returns:

     

       397
       397
       -
               A decorator function that registers the decorated function as an encoder.

     

       398
       398
       -
       

     

       399
       399
       -
           Example:

     

       400
       400
       -
               >>> @register_type_encoder("app.bsky.feed.post", priority=10)

     

       401
       401
       -
               ... def encode_post(post: Post) -> Dict[str, Any]:

     

       402
       402
       -
               ...     return {"text": post.text, "createdAt": post.created_at}

     

       403
       403
       -
           """

     

       404
       404
       -
           return _global_processor_registry.register_encoder(type_name, priority)

     

       405
       405
       -
       

     

       406
       406
       -
       

     

       407
       407
       -
       def register_type_class(

     

       408
       408
       -
           type_name: str, priority: int = 0

     

       409
       409
       -
       ) -> Callable[[Type[T]], Type[T]]:

     

       410
       410
       -
           """Register a class for both global encoding and decoding.

     

       411
       411
       -
       

     

       412
       412
       -
           This decorator registers a class for both encoding and decoding of a specific type

     

       413
       413
       -
           in the ATProto data model.

     

       414
       414
       -
       

     

       415
       415
       -
           Args:

     

       416
       416
       -
               type_name: The name of the type to handle.

     

       417
       417
       -
               priority: The priority of this processor (higher values = higher priority).

     

       418
       418
       -
       

     

       419
       419
       -
           Returns:

     

       420
       420
       -
               A decorator function that registers the decorated class.

     

       421
       421
       -
       

     

       422
       422
       -
           Example:

     

       423
       423
       -
               >>> @register_type_class("app.bsky.feed.post", priority=10)

     

       424
       424
       -
               ... class Post:

     

       425
       425
       -
               ...     def __init__(self, text: str, created_at: str) -> None:

     

       426
       426
       -
               ...         self.text = text

     

       427
       427
       -
               ...         self.created_at = created_at

     

       428
       428
       -
               ...

     

       429
       429
       -
               ...     @classmethod

     

       430
       430
       -
               ...     def from_json(cls, data: Dict[str, Any]) -> "Post":

     

       431
       431
       -
               ...         return cls(data["text"], data["createdAt"])

     

       432
       432
       -
               ...

     

       433
       433
       -
               ...     def to_json(self) -> Dict[str, Any]:

     

       434
       434
       -
               ...         return {"text": self.text, "createdAt": self.created_at}

     

       435
       435
       -
           """

     

       436
       436
       -
           return _global_processor_registry.register_class(type_name, priority)

     

       437
       437
       -
       

     

       438
       438
       -
       

     

       439
       439
       -
       def unregister_type(type_name: str, priority: Optional[int] = None) -> None:

     

       440
       440
       -
           """Unregister global type processors.

     

       441
       441
       -
       

     

       442
       442
       -
           Args:

     

       443
       443
       -
               type_name: The name of the type to unregister.

     

       444
       444
       -
               priority: If specified, only unregister processors with this priority.

     

       445
       445
       -
           """

     

       446
       446
       -
           _global_processor_registry.unregister(type_name, priority)

     

       447
       447
       -
       

     

       448
       448
       -
       

     

       449
       449
       -
       def get_type_decoder(type_name: str) -> Optional[Callable[[Dict[str, Any]], Any]]:

     

       450
       450
       -
           """Get the global decoder function for a specific type.

     

       451
       451
       -
       

     

       452
       452
       -
           Args:

     

       453
       453
       -
               type_name: The name of the type to get the decoder for.

     

       454
       454
       -
       

     

       455
       455
       -
           Returns:

     

       456
       456
       -
               The decoder function for the specified type, or None if no decoder

     

       457
       457
       -
               is registered.

     

       458
       458
       -
           """

     

       459
       459
       -
           return _global_processor_registry.get_decoder(type_name)

     

       460
       460
       -
       

     

       461
       461
       -
       

     

       462
       462
       -
       def get_type_encoder(type_name: str) -> Optional[Callable[[Any], Dict[str, Any]]]:

     

       463
       463
       -
           """Get the global encoder function for a specific type.

     

       464
       464
       -
       

     

       465
       465
       -
           Args:

     

       466
       466
       -
               type_name: The name of the type to get the encoder for.

     

       467
       467
       -
       

     

       468
       468
       -
           Returns:

     

       469
       469
       -
               The encoder function for the specified type, or None if no encoder

     

       470
       470
       -
               is registered.

     

       471
       471
       -
           """

     

       472
       472
       -
           return _global_processor_registry.get_encoder(type_name)

     

       473
       473
       -
       

     

       474
       474
       -
       

     

       475
       475
       -
       def has_type_processor(type_name: str) -> bool:

     

       476
       476
       -
           """Check if a global processor is registered for a specific type.

     

       477
       477
       -
       

     

       478
       478
       -
           Args:

     

       479
       479
       -
               type_name: The name of the type to check.

     

       480
       480
       -
       

     

       481
       481
       -
           Returns:

     

       482
       482
       -
               True if a processor is registered for the specified type, False otherwise.

     

       483
       483
       -
           """

     

       484
       484
       -
           return _global_processor_registry.has_processor(type_name)

     

       485
       485
       -
       

     

       486
       486
       -
       

     

       487
       487
       -
       def clear_type_processors() -> None:

     

       488
       488
       -
           """Clear all globally registered processors."""

     

       489
       489
       -
           _global_processor_registry.clear()

     

       490
       490
       -
       

     

       491
       491
       -
       

     

       492
       492
       -
       def get_registered_types() -> set:

     

       493
       493
       -
           """Get the set of all globally registered type names.

     

       494
       494
       -
       

     

       495
       495
       -
           Returns:

     

       496
       496
       -
               A set of all registered type names.

     

       497
       497
       -
           """

     

       498
       498
       -
           return _global_processor_registry.get_registered_types()

     

       499
       499
       -
       

     

       500
       500
       -
       

     

       501
       501
       -
       def create_processor_registry() -> TypeProcessorRegistry:

     

       502
       502
       -
           """Create a new type processor registry.

     

       503
       503
       -
       

     

       504
       504
       -
           This function creates a new, independent registry that can be used

     

       505
       505
       -
           instead of the global registry.

     

       506
       506
       -
       

     

       507
       507
       -
           Returns:

     

       508
       508
       -
               A new TypeProcessorRegistry instance.

     

       509
       509
       -
           """

     

       510
       510
       -
           return TypeProcessorRegistry()

-346

src/atpasser/data/wrapper.py

···

       1
       1
       -
       """

     

       2
       2
       -
       JSON wrapper functions for ATProto data model.

     

       3
       3
       -
       

     

       4
       4
       -
       This module provides wrapper functions that mirror the standard json module

     

       5
       5
       -
       but with support for ATProto-specific data types.

     

       6
       6
       -
       """

     

       7
       7
       -
       

     

       8
       8
       -
       import json

     

       9
       9
       -
       import io

     

       10
       10
       -
       from typing import Any, Callable, Dict, Optional, TextIO, Union

     

       11
       11
       -
       from .encoder import JsonEncoder

     

       12
       12
       -
       from .decoder import JsonDecoder

     

       13
       13
       -
       from .hooks import TypeHookRegistry

     

       14
       14
       -
       from .types import TypeProcessorRegistry

     

       15
       15
       -
       

     

       16
       16
       -
       

     

       17
       17
       -
       def dump(

     

       18
       18
       -
           obj: Any,

     

       19
       19
       -
           fp: TextIO,

     

       20
       20
       -
           *,

     

       21
       21
       -
           skipkeys: bool = False,

     

       22
       22
       -
           ensure_ascii: bool = True,

     

       23
       23
       -
           check_circular: bool = True,

     

       24
       24
       -
           allow_nan: bool = True,

     

       25
       25
       -
           cls: Optional[type[JsonEncoder]] = None,

     

       26
       26
       -
           indent: Optional[Union[int, str]] = None,

     

       27
       27
       -
           separators: Optional[tuple[str, str]] = None,

     

       28
       28
       -
           default: Optional[Callable[[Any], Any]] = None,

     

       29
       29
       -
           sort_keys: bool = False,

     

       30
       30
       -
           encoding: str = "utf-8",

     

       31
       31
       -
           type_processor_registry: Optional[TypeProcessorRegistry] = None,

     

       32
       32
       -
           **kwargs: Any,

     

       33
       33
       -
       ) -> None:

     

       34
       34
       -
           """Serialize obj as a JSON formatted stream to fp.

     

       35
       35
       -
       

     

       36
       36
       -
           This function is similar to json.dump() but supports ATProto-specific

     

       37
       37
       -
           data types, including bytes, CID links, and typed objects.

     

       38
       38
       -
       

     

       39
       39
       -
           Args:

     

       40
       40
       -
               obj: The object to serialize.

     

       41
       41
       -
               fp: A file-like object with a write() method.

     

       42
       42
       -
               skipkeys: If True, dict keys that are not basic types (str, int, float,

     

       43
       43
       -
                   bool, None) will be skipped instead of raising a TypeError.

     

       44
       44
       -
               ensure_ascii: If True, the output is guaranteed to have all incoming

     

       45
       45
       -
                   non-ASCII characters escaped. If False, these characters will be

     

       46
       46
       -
                   output as-is.

     

       47
       47
       -
               check_circular: If True, circular references will be checked and

     

       48
       48
       -
                   a CircularReferenceError will be raised if one is found.

     

       49
       49
       -
               allow_nan: If True, NaN, Infinity, and -Infinity will be encoded as

     

       50
       50
       -
                   such. This behavior is not JSON specification compliant, but it

     

       51
       51
       -
                   is consistent with most JavaScript based encoders and decoders.

     

       52
       52
       -
                   Otherwise, it will raise a ValueError.

     

       53
       53
       -
               cls: A custom JSONEncoder subclass. If not specified, JsonEncoder is used.

     

       54
       54
       -
               indent: If indent is a non-negative integer or string, then JSON array

     

       55
       55
       -
                   elements and object members will be pretty-printed with that indent

     

       56
       56
       -
                   level. An indent level of 0, negative, or "" will only insert newlines.

     

       57
       57
       -
                   None (the default) selects the most compact representation.

     

       58
       58
       -
               separators: If specified, separators should be an (item_separator, key_separator)

     

       59
       59
       -
                   tuple. The default is (', ', ': ') if indent is None and (',', ': ') otherwise.

     

       60
       60
       -
                   To get the most compact JSON representation, you should specify (',', ':')

     

       61
       61
       -
                   to eliminate whitespace.

     

       62
       62
       -
               default: If specified, default should be a function that gets called for

     

       63
       63
       -
                   objects that can't otherwise be serialized. It should return a JSON

     

       64
       64
       -
                   encodable version of the object or raise a TypeError.

     

       65
       65
       -
               sort_keys: If sort_keys is True, then the output of dictionaries will be

     

       66
       66
       -
                   sorted by key.

     

       67
       67
       -
               encoding: The encoding to use for string serialization.

     

       68
       68
       -
               type_processor_registry: Registry for type-specific processors.

     

       69
       69
       -
               **kwargs: Additional keyword arguments to pass to the JSON encoder.

     

       70
       70
       -
           """

     

       71
       71
       -
           if cls is None:

     

       72
       72
       -
               cls = JsonEncoder

     

       73
       73
       -
       

     

       74
       74
       -
           # Use the global type processor registry if none is provided

     

       75
       75
       -
           if type_processor_registry is None:

     

       76
       76
       -
               from .types import get_global_processor_registry

     

       77
       77
       -
       

     

       78
       78
       -
               type_processor_registry = get_global_processor_registry()

     

       79
       79
       -
       

     

       80
       80
       -
           # Create an encoder instance with the specified encoding and type processor registry

     

       81
       81
       -
           encoder = cls(

     

       82
       82
       -
               encoding=encoding, type_processor_registry=type_processor_registry, **kwargs

     

       83
       83
       -
           )

     

       84
       84
       -
       

     

       85
       85
       -
           # Use the standard json.dump with our custom encoder

     

       86
       86
       -
           json.dump(

     

       87
       87
       -
               obj,

     

       88
       88
       -
               fp,

     

       89
       89
       -
               skipkeys=skipkeys,

     

       90
       90
       -
               ensure_ascii=ensure_ascii,

     

       91
       91
       -
               check_circular=check_circular,

     

       92
       92
       -
               allow_nan=allow_nan,

     

       93
       93
       -
               cls=cls,

     

       94
       94
       -
               indent=indent,

     

       95
       95
       -
               separators=separators,

     

       96
       96
       -
               default=default,

     

       97
       97
       -
               sort_keys=sort_keys,

     

       98
       98
       -
               **kwargs,

     

       99
       99
       -
           )

     

       100
       100
       -
       

     

       101
       101
       -
       

     

       102
       102
       -
       def dumps(

     

       103
       103
       -
           obj: Any,

     

       104
       104
       -
           *,

     

       105
       105
       -
           skipkeys: bool = False,

     

       106
       106
       -
           ensure_ascii: bool = True,

     

       107
       107
       -
           check_circular: bool = True,

     

       108
       108
       -
           allow_nan: bool = True,

     

       109
       109
       -
           cls: Optional[type[JsonEncoder]] = None,

     

       110
       110
       -
           indent: Optional[Union[int, str]] = None,

     

       111
       111
       -
           separators: Optional[tuple[str, str]] = None,

     

       112
       112
       -
           default: Optional[Callable[[Any], Any]] = None,

     

       113
       113
       -
           sort_keys: bool = False,

     

       114
       114
       -
           encoding: str = "utf-8",

     

       115
       115
       -
           type_processor_registry: Optional[TypeProcessorRegistry] = None,

     

       116
       116
       -
           **kwargs: Any,

     

       117
       117
       -
       ) -> str:

     

       118
       118
       -
           """Serialize obj to a JSON formatted string.

     

       119
       119
       -
       

     

       120
       120
       -
           This function is similar to json.dumps() but supports ATProto-specific

     

       121
       121
       -
           data types, including bytes, CID links, and typed objects.

     

       122
       122
       -
       

     

       123
       123
       -
           Args:

     

       124
       124
       -
               obj: The object to serialize.

     

       125
       125
       -
               skipkeys: If True, dict keys that are not basic types (str, int, float,

     

       126
       126
       -
                   bool, None) will be skipped instead of raising a TypeError.

     

       127
       127
       -
               ensure_ascii: If True, the output is guaranteed to have all incoming

     

       128
       128
       -
                   non-ASCII characters escaped. If False, these characters will be

     

       129
       129
       -
                   output as-is.

     

       130
       130
       -
               check_circular: If True, circular references will be checked and

     

       131
       131
       -
                   a CircularReferenceError will be raised if one is found.

     

       132
       132
       -
               allow_nan: If True, NaN, Infinity, and -Infinity will be encoded as

     

       133
       133
       -
                   such. This behavior is not JSON specification compliant, but it

     

       134
       134
       -
                   is consistent with most JavaScript based encoders and decoders.

     

       135
       135
       -
                   Otherwise, it will raise a ValueError.

     

       136
       136
       -
               cls: A custom JSONEncoder subclass. If not specified, JsonEncoder is used.

     

       137
       137
       -
               indent: If indent is a non-negative integer or string, then JSON array

     

       138
       138
       -
                   elements and object members will be pretty-printed with that indent

     

       139
       139
       -
                   level. An indent level of 0, negative, or "" will only insert newlines.

     

       140
       140
       -
                   None (the default) selects the most compact representation.

     

       141
       141
       -
               separators: If specified, separators should be an (item_separator, key_separator)

     

       142
       142
       -
                   tuple. The default is (', ', ': ') if indent is None and (',', ': ') otherwise.

     

       143
       143
       -
                   To get the most compact JSON representation, you should specify (',', ':')

     

       144
       144
       -
                   to eliminate whitespace.

     

       145
       145
       -
               default: If specified, default should be a function that gets called for

     

       146
       146
       -
                   objects that can't otherwise be serialized. It should return a JSON

     

       147
       147
       -
                   encodable version of the object or raise a TypeError.

     

       148
       148
       -
               sort_keys: If sort_keys is True, then the output of dictionaries will be

     

       149
       149
       -
                   sorted by key.

     

       150
       150
       -
               encoding: The encoding to use for string serialization.

     

       151
       151
       -
               type_processor_registry: Registry for type-specific processors.

     

       152
       152
       -
               **kwargs: Additional keyword arguments to pass to the JSON encoder.

     

       153
       153
       -
       

     

       154
       154
       -
           Returns:

     

       155
       155
       -
               A JSON formatted string.

     

       156
       156
       -
           """

     

       157
       157
       -
           if cls is None:

     

       158
       158
       -
               cls = JsonEncoder

     

       159
       159
       -
       

     

       160
       160
       -
           # Create an encoder instance with the specified encoding and type processor registry

     

       161
       161
       -
           encoder = cls(

     

       162
       162
       -
               encoding=encoding, type_processor_registry=type_processor_registry, **kwargs

     

       163
       163
       -
           )

     

       164
       164
       -
       

     

       165
       165
       -
           # Use the standard json.dumps with our custom encoder

     

       166
       166
       -
           return json.dumps(

     

       167
       167
       -
               obj,

     

       168
       168
       -
               skipkeys=skipkeys,

     

       169
       169
       -
               ensure_ascii=ensure_ascii,

     

       170
       170
       -
               check_circular=check_circular,

     

       171
       171
       -
               allow_nan=allow_nan,

     

       172
       172
       -
               cls=cls,

     

       173
       173
       -
               indent=indent,

     

       174
       174
       -
               separators=separators,

     

       175
       175
       -
               default=default,

     

       176
       176
       -
               sort_keys=sort_keys,

     

       177
       177
       -
               **kwargs,

     

       178
       178
       -
           )

     

       179
       179
       -
       

     

       180
       180
       -
       

     

       181
       181
       -
       def load(

     

       182
       182
       -
           fp: TextIO,

     

       183
       183
       -
           *,

     

       184
       184
       -
           cls: Optional[type[JsonDecoder]] = None,

     

       185
       185
       -
           object_hook: Optional[Callable[[Dict[str, Any]], Any]] = None,

     

       186
       186
       -
           parse_float: Optional[Callable[[str], Any]] = None,

     

       187
       187
       -
           parse_int: Optional[Callable[[str], Any]] = None,

     

       188
       188
       -
           parse_constant: Optional[Callable[[str], Any]] = None,

     

       189
       189
       -
           object_pairs_hook: Optional[Callable[[list[tuple[str, Any]]], Any]] = None,

     

       190
       190
       -
           type_hook_registry: Optional[TypeHookRegistry] = None,

     

       191
       191
       -
           type_processor_registry: Optional[TypeProcessorRegistry] = None,

     

       192
       192
       -
           encoding: str = "utf-8",

     

       193
       193
       -
           **kwargs: Any,

     

       194
       194
       -
       ) -> Any:

     

       195
       195
       -
           """Deserialize fp (a .read()-supporting text file or binary file containing

     

       196
       196
       -
           a JSON document) to a Python object.

     

       197
       197
       -
       

     

       198
       198
       -
           This function is similar to json.load() but supports ATProto-specific

     

       199
       199
       -
           data types, including bytes, CID links, and typed objects.

     

       200
       200
       -
       

     

       201
       201
       -
           Args:

     

       202
       202
       -
               fp: A .read()-supporting text file or binary file containing a JSON document.

     

       203
       203
       -
               cls: A custom JSONDecoder subclass. If not specified, JsonDecoder is used.

     

       204
       204
       -
               object_hook: Optional function that will be called with the result of

     

       205
       205
       -
                   every JSON object decoded and its return value will be used in place

     

       206
       206
       -
                   of the given dict.

     

       207
       207
       -
               parse_float: Optional function that will be called with the string of

     

       208
       208
       -
                   every JSON float to be decoded. By default, this is equivalent to

     

       209
       209
       -
                   float(num_str). This can be used to use another datatype or parser

     

       210
       210
       -
                   for JSON floats (e.g. decimal.Decimal).

     

       211
       211
       -
               parse_int: Optional function that will be called with the string of

     

       212
       212
       -
                   every JSON int to be decoded. By default, this is equivalent to

     

       213
       213
       -
                   int(num_str). This can be used to use another datatype or parser

     

       214
       214
       -
                   for JSON integers (e.g. float).

     

       215
       215
       -
               parse_constant: Optional function that will be called with the string of

     

       216
       216
       -
                   every JSON constant to be decoded. By default, this is equivalent to

     

       217
       217
       -
                   constant_mapping[constant_str]. This can be used to use another

     

       218
       218
       -
                   datatype or parser for JSON constants (e.g. decimal.Decimal).

     

       219
       219
       -
               object_pairs_hook: Optional function that will be called with the result

     

       220
       220
       -
                   of every JSON object decoded with an ordered list of pairs. The return

     

       221
       221
       -
                   value of object_pairs_hook will be used instead of the dict. This

     

       222
       222
       -
                   feature can be used to implement custom decoders. If object_hook is

     

       223
       223
       -
                   also defined, the object_pairs_hook takes priority.

     

       224
       224
       -
               type_hook_registry: Registry for type-specific hooks.

     

       225
       225
       -
               type_processor_registry: Registry for type-specific processors.

     

       226
       226
       -
               encoding: The encoding to use for string deserialization.

     

       227
       227
       -
               **kwargs: Additional keyword arguments to pass to the JSON decoder.

     

       228
       228
       -
       

     

       229
       229
       -
           Returns:

     

       230
       230
       -
               A Python object.

     

       231
       231
       -
           """

     

       232
       232
       -
           if cls is None:

     

       233
       233
       -
               cls = JsonDecoder

     

       234
       234
       -
       

     

       235
       235
       -
           # Use the global type hook registry if none is provided

     

       236
       236
       -
           if type_hook_registry is None and type_processor_registry is None:

     

       237
       237
       -
               from .hooks import get_global_registry

     

       238
       238
       -
       

     

       239
       239
       -
               type_hook_registry = get_global_registry()

     

       240
       240
       -
           elif type_processor_registry is not None:

     

       241
       241
       -
               # Convert the type processor registry to a hook registry

     

       242
       242
       -
               type_hook_registry = type_processor_registry.to_hook_registry()

     

       243
       243
       -
       

     

       244
       244
       -
           # Create a decoder instance with the specified parameters

     

       245
       245
       -
           decoder = cls(

     

       246
       246
       -
               object_hook=object_hook,

     

       247
       247
       -
               type_hook_registry=type_hook_registry,

     

       248
       248
       -
               encoding=encoding,

     

       249
       249
       -
               **kwargs,

     

       250
       250
       -
           )

     

       251
       251
       -
       

     

       252
       252
       -
           # Use the standard json.load with our custom decoder

     

       253
       253
       -
           return json.load(

     

       254
       254
       -
               fp,

     

       255
       255
       -
               cls=cls,

     

       256
       256
       -
               object_hook=object_hook,

     

       257
       257
       -
               parse_float=parse_float,

     

       258
       258
       -
               parse_int=parse_int,

     

       259
       259
       -
               parse_constant=parse_constant,

     

       260
       260
       -
               object_pairs_hook=object_pairs_hook,

     

       261
       261
       -
               **kwargs,

     

       262
       262
       -
           )

     

       263
       263
       -
       

     

       264
       264
       -
       

     

       265
       265
       -
       def loads(

     

       266
       266
       -
           s: Union[str, bytes],

     

       267
       267
       -
           *,

     

       268
       268
       -
           cls: Optional[type[JsonDecoder]] = None,

     

       269
       269
       -
           object_hook: Optional[Callable[[Dict[str, Any]], Any]] = None,

     

       270
       270
       -
           parse_float: Optional[Callable[[str], Any]] = None,

     

       271
       271
       -
           parse_int: Optional[Callable[[str], Any]] = None,

     

       272
       272
       -
           parse_constant: Optional[Callable[[str], Any]] = None,

     

       273
       273
       -
           object_pairs_hook: Optional[Callable[[list[tuple[str, Any]]], Any]] = None,

     

       274
       274
       -
           type_hook_registry: Optional[TypeHookRegistry] = None,

     

       275
       275
       -
           type_processor_registry: Optional[TypeProcessorRegistry] = None,

     

       276
       276
       -
           encoding: str = "utf-8",

     

       277
       277
       -
           **kwargs: Any,

     

       278
       278
       -
       ) -> Any:

     

       279
       279
       -
           """Deserialize s (a str, bytes or bytearray instance containing a JSON document)

     

       280
       280
       -
           to a Python object.

     

       281
       281
       -
       

     

       282
       282
       -
           This function is similar to json.loads() but supports ATProto-specific

     

       283
       283
       -
           data types, including bytes, CID links, and typed objects.

     

       284
       284
       -
       

     

       285
       285
       -
           Args:

     

       286
       286
       -
               s: A str, bytes or bytearray instance containing a JSON document.

     

       287
       287
       -
               cls: A custom JSONDecoder subclass. If not specified, JsonDecoder is used.

     

       288
       288
       -
               object_hook: Optional function that will be called with the result of

     

       289
       289
       -
                   every JSON object decoded and its return value will be used in place

     

       290
       290
       -
                   of the given dict.

     

       291
       291
       -
               parse_float: Optional function that will be called with the string of

     

       292
       292
       -
                   every JSON float to be decoded. By default, this is equivalent to

     

       293
       293
       -
                   float(num_str). This can be used to use another datatype or parser

     

       294
       294
       -
                   for JSON floats (e.g. decimal.Decimal).

     

       295
       295
       -
               parse_int: Optional function that will be called with the string of

     

       296
       296
       -
                   every JSON int to be decoded. By default, this is equivalent to

     

       297
       297
       -
                   int(num_str). This can be used to use another datatype or parser

     

       298
       298
       -
                   for JSON integers (e.g. float).

     

       299
       299
       -
               parse_constant: Optional function that will be called with the string of

     

       300
       300
       -
                   every JSON constant to be decoded. By default, this is equivalent to

     

       301
       301
       -
                   constant_mapping[constant_str]. This can be used to use another

     

       302
       302
       -
                   datatype or parser for JSON constants (e.g. decimal.Decimal).

     

       303
       303
       -
               object_pairs_hook: Optional function that will be called with the result

     

       304
       304
       -
                   of every JSON object decoded with an ordered list of pairs. The return

     

       305
       305
       -
                   value of object_pairs_hook will be used instead of the dict. This

     

       306
       306
       -
                   feature can be used to implement custom decoders. If object_hook is

     

       307
       307
       -
                   also defined, the object_pairs_hook takes priority.

     

       308
       308
       -
               type_hook_registry: Registry for type-specific hooks.

     

       309
       309
       -
               type_processor_registry: Registry for type-specific processors.

     

       310
       310
       -
               encoding: The encoding to use for string deserialization.

     

       311
       311
       -
               **kwargs: Additional keyword arguments to pass to the JSON decoder.

     

       312
       312
       -
       

     

       313
       313
       -
           Returns:

     

       314
       314
       -
               A Python object.

     

       315
       315
       -
           """

     

       316
       316
       -
           if cls is None:

     

       317
       317
       -
               cls = JsonDecoder

     

       318
       318
       -
       

     

       319
       319
       -
           # Use the global type hook registry if none is provided

     

       320
       320
       -
           if type_hook_registry is None and type_processor_registry is None:

     

       321
       321
       -
               from .hooks import get_global_registry

     

       322
       322
       -
       

     

       323
       323
       -
               type_hook_registry = get_global_registry()

     

       324
       324
       -
           elif type_processor_registry is not None:

     

       325
       325
       -
               # Convert the type processor registry to a hook registry

     

       326
       326
       -
               type_hook_registry = type_processor_registry.to_hook_registry()

     

       327
       327
       -
       

     

       328
       328
       -
           # Create a decoder instance with the specified parameters

     

       329
       329
       -
           decoder = cls(

     

       330
       330
       -
               object_hook=object_hook,

     

       331
       331
       -
               type_hook_registry=type_hook_registry,

     

       332
       332
       -
               encoding=encoding,

     

       333
       333
       -
               **kwargs,

     

       334
       334
       -
           )

     

       335
       335
       -
       

     

       336
       336
       -
           # Use the standard json.loads with our custom decoder

     

       337
       337
       -
           return json.loads(

     

       338
       338
       -
               s,

     

       339
       339
       -
               cls=cls,

     

       340
       340
       -
               object_hook=object_hook,

     

       341
       341
       -
               parse_float=parse_float,

     

       342
       342
       -
               parse_int=parse_int,

     

       343
       343
       -
               parse_constant=parse_constant,

     

       344
       344
       -
               object_pairs_hook=object_pairs_hook,

     

       345
       345
       -
               **kwargs,

     

       346
       346
       -
           )

+6 -1

.gitignore

···

       213
       213
        
       __marimo__/

     

       214
       214
        
       

     

       215
       215
        
       # Streamlit

     

       216
       216
       -
       .streamlit/secrets.toml
     

       216
       216
       +
       .streamlit/secrets.toml

     

       217
       217
       +
       

     

       218
       218
       +
       #####

     

       219
       219
       +
       

     

       220
       220
       +
       # Added by DWN - temp dir

     

       221
       221
       +
       tmp/

+10 -2

README.md

···

       1
       1
       -
       # ATPasser ╬<!

     

       1
       1
       +
       # ATPasser!

     

       2
       2
        
       

     

       3
       3
        
       A simple library for the [Authenticated Transfer Protocol](https://atproto.com/specs/atp) (AT Protocol or atproto for short).

     

       4
       4
        
       

     
···

       6
       6
        
       

     

       7
       7
        
       ---

     

       8
       8
        
       

     

       9
       9
       -
       [See the roadmap](docs/roadmap.md)

     

       9
       9
       +
       ## Other ATProto libraries

     

       10
       10
       +
       

     

       11
       11
       +
       [There's an ATProto SDK already (and used by lots of projects) by MarshalX,](https://github.com/MarshalX/atproto) and why do this exists?

     

       12
       12
       +
       

     

       13
       13
       +
       The first reason is that I'm recovering the now-closed [Tietiequan](https://tangled.org/@dwn.dwnfonts.cc/bluesky-circle) app and found that some API has changed so I have to rewrite it via vanilla JS.

     

       14
       14
       +
       

     

       15
       15
       +
       The second reason is that I'm a newbie in ATProto, wanting to know how ATProto is, and how this can be represented in Python.

     

       16
       16
       +
       

     

       17
       17
       +
       The architecture will be small, only containing the data model and the client.

     

       10
       18
        
       

     

       11
       19
        
       ---

     

       12
       20

-16

src/atpasser/blob/__init__.py

···

       1
       1
       -
       import cid

     

       2
       2
       -
       import multihash, hashlib

     

       3
       3
       -
       

     

       4
       4
       -
       

     

       5
       5
       -
       def generateCID(file):

     

       6
       6
       -
           hasher = hashlib.new("sha-256")

     

       7
       7
       -
           while True:

     

       8
       8
       -
               chunk = file.read(8192)

     

       9
       9
       -
               if not chunk:

     

       10
       10
       -
                   break

     

       11
       11
       -
               hasher.update(chunk)

     

       12
       12
       -
       

     

       13
       13
       -
           digest = hasher.digest

     

       14
       14
       -
           mh = multihash.encode(digest, "sha-256")

     

       15
       15
       -
       

     

       16
       16
       -
           return cid.CIDv1(codec="raw", multihash=mh)

-76

src/atpasser/data/_data.py

···

       1
       1
       -
       import base64

     

       2
       2
       -
       from cid import CIDv0, CIDv1, cid, make_cid

     

       3
       3
       -
       import json

     

       4
       4
       -
       

     

       5
       5
       -
       

     

       6
       6
       -
       class Data:

     

       7
       7
       -
           """

     

       8
       8
       -
           A class representing data with "$type" key.

     

       9
       9
       -
       

     

       10
       10
       -
           Attributes:

     

       11
       11
       -
               type (str): The type of the data.

     

       12
       12
       -
               json (str): Original object in JSON format.

     

       13
       13
       -
           """

     

       14
       14
       -
       

     

       15
       15
       -
           def __init__(self, dataType: str, json: str = "{}") -> None:

     

       16
       16
       -
               """

     

       17
       17
       -
               Initalizes data object.

     

       18
       18
       -
       

     

       19
       19
       -
               Parameters:

     

       20
       20
       -
                   type (str): The type of the data.

     

       21
       21
       -
                   json (str): Original object in JSON format.

     

       22
       22
       -
               """

     

       23
       23
       -
               self.type = dataType

     

       24
       24
       -
               self.json = json

     

       25
       25
       -
       

     

       26
       26
       -
           def data(self):

     

       27
       27
       -
               """

     

       28
       28
       -
               Loads data as a Python-friendly format.

     

       29
       29
       -
       

     

       30
       30
       -
               Returns:

     

       31
       31
       -
                   dict: Converted data from JSON object.

     

       32
       32
       -
               """

     

       33
       33
       -
               return json.loads(self.json, object_hook=dataHook)

     

       34
       34
       -
       

     

       35
       35
       -
       

     

       36
       36
       -
       def dataHook(data: dict):

     

       37
       37
       -
           """

     

       38
       38
       -
           Treated as `JSONDecoder`'s `object_hook`

     

       39
       39
       -
       

     

       40
       40
       -
           Parameters:

     

       41
       41
       -
               data: data in format that `JSONDecoder` like ;)

     

       42
       42
       -
           """

     

       43
       43
       -
           if "$bytes" in data:

     

       44
       44
       -
               return base64.b64decode(data["$bytes"])

     

       45
       45
       -
           elif "$link" in data:

     

       46
       46
       -
               return make_cid(data["$link"])

     

       47
       47
       -
           elif "$type" in data:

     

       48
       48
       -
               dataType = data["$type"]

     

       49
       49
       -
               del data["$type"]

     

       50
       50
       -
               return Data(dataType, json.dumps(data))

     

       51
       51
       -
           else:

     

       52
       52
       -
               return data

     

       53
       53
       -
       

     

       54
       54
       -
       

     

       55
       55
       -
       def _convertDataToFakeJSON(data):

     

       56
       56
       -
           if isinstance(data, bytes):

     

       57
       57
       -
               return {"$bytes": base64.b64encode(data)}

     

       58
       58
       -
           elif isinstance(data, (CIDv0, CIDv1)):

     

       59
       59
       -
               return {"link": data.encode()}

     

       60
       60
       -
           elif isinstance(data, dict):

     

       61
       61
       -
               for item in data:

     

       62
       62
       -
                   data[item] = _convertDataToFakeJSON(data[item])

     

       63
       63
       -
           elif isinstance(data, (tuple, list, set)):

     

       64
       64
       -
               return [_convertDataToFakeJSON(item) for item in data]

     

       65
       65
       -
           else:

     

       66
       66
       -
               return data

     

       67
       67
       -
       

     

       68
       68
       -
       

     

       69
       69
       -
       class DataEncoder(json.JSONEncoder):

     

       70
       70
       -
           """

     

       71
       71
       -
           A superset of `JSONEncoder` to support ATProto data.

     

       72
       72
       -
           """

     

       73
       73
       -
       

     

       74
       74
       -
           def default(self, o):

     

       75
       75
       -
               result = _convertDataToFakeJSON(o)

     

       76
       76
       -
               return super().default(result)

-61

src/atpasser/data/_wrapper.py

···

       1
       1
       -
       from json import loads

     

       2
       2
       -
       from typing import Callable, Any

     

       3
       3
       -
       from ._data import *

     

       4
       4
       -
       import functools

     

       5
       5
       -
       

     

       6
       6
       -
       # Pyright did the whole job. Thank it.

     

       7
       7
       -
       

     

       8
       8
       -
       

     

       9
       9
       -
       class DataDecoder(json.JSONDecoder):

     

       10
       10
       -
           """

     

       11
       11
       -
           A superset of `JSONDecoder` to support ATProto data.

     

       12
       12
       -
           """

     

       13
       13
       -
       

     

       14
       14
       -
           def __init__(

     

       15
       15
       -
               self,

     

       16
       16
       -
               *,

     

       17
       17
       -
               object_hook: Callable[[dict[str, Any]], Any] | None = dataHook,

     

       18
       18
       -
               parse_float: Callable[[str], Any] | None = None,

     

       19
       19
       -
               parse_int: Callable[[str], Any] | None = None,

     

       20
       20
       -
               parse_constant: Callable[[str], Any] | None = None,

     

       21
       21
       -
               strict: bool = True,

     

       22
       22
       -
               object_pairs_hook: Callable[[list[tuple[str, Any]]], Any] | None = None,

     

       23
       23
       -
           ) -> None:

     

       24
       24
       -
               super().__init__(

     

       25
       25
       -
                   object_hook=object_hook,

     

       26
       26
       -
                   parse_float=parse_float,

     

       27
       27
       -
                   parse_int=parse_int,

     

       28
       28
       -
                   parse_constant=parse_constant,

     

       29
       29
       -
                   strict=strict,

     

       30
       30
       -
                   object_pairs_hook=object_pairs_hook,

     

       31
       31
       -
               )

     

       32
       32
       -
       

     

       33
       33
       -
       

     

       34
       34
       -
       # Screw it. I have to make 4 `json`-like functions.

     

       35
       35
       -
       

     

       36
       36
       -
       

     

       37
       37
       -
       def _dataDecoratorForDump(func):

     

       38
       38
       -
           @functools.wraps(func)

     

       39
       39
       -
           def wrapper(obj, *args, **kwargs):

     

       40
       40
       -
               kwargs.setdefault("cls", DataEncoder)

     

       41
       41
       -
               return func(obj, *args, **kwargs)

     

       42
       42
       -
       

     

       43
       43
       -
           return wrapper

     

       44
       44
       -
       

     

       45
       45
       -
       

     

       46
       46
       -
       def _dataDecoratorForLoad(func):

     

       47
       47
       -
           @functools.wraps(func)

     

       48
       48
       -
           def wrapper(obj, *args, **kwargs):

     

       49
       49
       -
               kwargs.setdefault("cls", DataDecoder)

     

       50
       50
       -
               return func(obj, *args, **kwargs)

     

       51
       51
       -
       

     

       52
       52
       -
           return wrapper

     

       53
       53
       -
       

     

       54
       54
       -
       

     

       55
       55
       -
       dump = _dataDecoratorForDump(json.dump)

     

       56
       56
       -
       dumps = _dataDecoratorForDump(json.dumps)

     

       57
       57
       -
       load = _dataDecoratorForLoad(json.load)

     

       58
       58
       -
       loads = _dataDecoratorForLoad(json.loads)

     

       59
       59
       -
       """

     

       60
       60
       -
       Wrapper of the JSON functions to support ATProto data.

     

       61
       61
       -
       """

-137

src/atpasser/data/cbor.py

···

       1
       1
       -
       from datetime import tzinfo

     

       2
       2
       -
       import typing

     

       3
       3
       -
       import cbor2

     

       4
       4
       -
       import cid

     

       5
       5
       -
       

     

       6
       6
       -
       from .data import dataHook, Data

     

       7
       7
       -
       

     

       8
       8
       -
       

     

       9
       9
       -
       def tagHook(decoder: cbor2.CBORDecoder, tag: cbor2.CBORTag, shareable_index=None):

     

       10
       10
       -
           """

     

       11
       11
       -
           A simple tag hook for CID support.

     

       12
       12
       -
           """

     

       13
       13
       -
           return cid.from_bytes(tag.value) if tag.tag == 42 else tag

     

       14
       14
       -
       

     

       15
       15
       -
       

     

       16
       16
       -
       class CBOREncoder(cbor2.CBOREncoder):

     

       17
       17
       -
           """

     

       18
       18
       -
           Wrapper of cbor2.CBOREncoder.

     

       19
       19
       -
           """

     

       20
       20
       -
       

     

       21
       21
       -
           def __init__(

     

       22
       22
       -
               self,

     

       23
       23
       -
               fp: typing.IO[bytes],

     

       24
       24
       -
               datetime_as_timestamp: bool = False,

     

       25
       25
       -
               timezone: tzinfo | None = None,

     

       26
       26
       -
               value_sharing: bool = False,

     

       27
       27
       -
               default: (

     

       28
       28
       -
                   typing.Callable[[cbor2.CBOREncoder, typing.Any], typing.Any] | None

     

       29
       29
       -
               ) = None,

     

       30
       30
       -
               canonical: bool = False,

     

       31
       31
       -
               date_as_datetime: bool = False,

     

       32
       32
       -
               string_referencing: bool = False,

     

       33
       33
       -
               indefinite_containers: bool = False,

     

       34
       34
       -
           ):

     

       35
       35
       -
               super().__init__(

     

       36
       36
       -
                   fp,

     

       37
       37
       -
                   datetime_as_timestamp,

     

       38
       38
       -
                   timezone,

     

       39
       39
       -
                   value_sharing,

     

       40
       40
       -
                   default,

     

       41
       41
       -
                   canonical,

     

       42
       42
       -
                   date_as_datetime,

     

       43
       43
       -
                   string_referencing,

     

       44
       44
       -
                   indefinite_containers,

     

       45
       45
       -
               )

     

       46
       46
       -
       

     

       47
       47
       -
           @cbor2.shareable_encoder

     

       48
       48
       -
           def cidOrDataEncoder(self: cbor2.CBOREncoder, value: cid.CIDv0 | cid.CIDv1 | Data):

     

       49
       49
       -
               """

     

       50
       50
       -
               Encode CID or Data to CBOR Tag.

     

       51
       51
       -
               """

     

       52
       52
       -
               if isinstance(value, (cid.CIDv0, cid.CIDv1)):

     

       53
       53
       -
                   self.encode(cbor2.CBORTag(42, value.encode()))

     

       54
       54
       -
               elif isinstance(value, Data):

     

       55
       55
       -
                   self.encode(value.data())

     

       56
       56
       -
       

     

       57
       57
       -
       

     

       58
       58
       -
       def _cborObjectHook(decoder: cbor2.CBORDecoder, value):

     

       59
       59
       -
           return dataHook(value)

     

       60
       60
       -
       

     

       61
       61
       -
       

     

       62
       62
       -
       class CBORDecoder(cbor2.CBORDecoder):

     

       63
       63
       -
           """

     

       64
       64
       -
           Wrapper of cbor2.CBORDecoder.

     

       65
       65
       -
           """

     

       66
       66
       -
       

     

       67
       67
       -
           def __init__(

     

       68
       68
       -
               self,

     

       69
       69
       -
               fp: typing.IO[bytes],

     

       70
       70
       -
               tag_hook: (

     

       71
       71
       -
                   typing.Callable[[cbor2.CBORDecoder, cbor2.CBORTag], typing.Any] | None

     

       72
       72
       -
               ) = tagHook,

     

       73
       73
       -
               object_hook: (

     

       74
       74
       -
                   typing.Callable[

     

       75
       75
       -
                       [cbor2.CBORDecoder, dict[typing.Any, typing.Any]], typing.Any

     

       76
       76
       -
                   ]

     

       77
       77
       -
                   | None

     

       78
       78
       -
               ) = _cborObjectHook,

     

       79
       79
       -
               str_errors: typing.Literal["strict", "error", "replace"] = "strict",

     

       80
       80
       -
           ):

     

       81
       81
       -
               super().__init__(fp, tag_hook, object_hook, str_errors)

     

       82
       82
       -
       

     

       83
       83
       -
       

     

       84
       84
       -
       # Make things for CBOR again.

     

       85
       85
       -
       

     

       86
       86
       -
       from io import BytesIO

     

       87
       87
       -
       

     

       88
       88
       -
       

     

       89
       89
       -
       def dumps(

     

       90
       90
       -
           obj: object,

     

       91
       91
       -
           datetime_as_timestamp: bool = False,

     

       92
       92
       -
           timezone: tzinfo | None = None,

     

       93
       93
       -
           value_sharing: bool = False,

     

       94
       94
       -
           default: typing.Callable[[cbor2.CBOREncoder, typing.Any], typing.Any] | None = None,

     

       95
       95
       -
           canonical: bool = False,

     

       96
       96
       -
           date_as_datetime: bool = False,

     

       97
       97
       -
           string_referencing: bool = False,

     

       98
       98
       -
           indefinite_containers: bool = False,

     

       99
       99
       -
       ) -> bytes:

     

       100
       100
       -
           with BytesIO() as fp:

     

       101
       101
       -
               CBOREncoder(

     

       102
       102
       -
                   fp,

     

       103
       103
       -
                   datetime_as_timestamp=datetime_as_timestamp,

     

       104
       104
       -
                   timezone=timezone,

     

       105
       105
       -
                   value_sharing=value_sharing,

     

       106
       106
       -
                   default=default,

     

       107
       107
       -
                   canonical=canonical,

     

       108
       108
       -
                   date_as_datetime=date_as_datetime,

     

       109
       109
       -
                   string_referencing=string_referencing,

     

       110
       110
       -
                   indefinite_containers=indefinite_containers,

     

       111
       111
       -
               ).encode(obj)

     

       112
       112
       -
               return fp.getvalue()

     

       113
       113
       -
       

     

       114
       114
       -
       

     

       115
       115
       -
       def dump(

     

       116
       116
       -
           obj: object,

     

       117
       117
       -
           fp: typing.IO[bytes],

     

       118
       118
       -
           datetime_as_timestamp: bool = False,

     

       119
       119
       -
           timezone: tzinfo | None = None,

     

       120
       120
       -
           value_sharing: bool = False,

     

       121
       121
       -
           default: typing.Callable[[cbor2.CBOREncoder, typing.Any], typing.Any] | None = None,

     

       122
       122
       -
           canonical: bool = False,

     

       123
       123
       -
           date_as_datetime: bool = False,

     

       124
       124
       -
           string_referencing: bool = False,

     

       125
       125
       -
           indefinite_containers: bool = False,

     

       126
       126
       -
       ) -> None:

     

       127
       127
       -
           CBOREncoder(

     

       128
       128
       -
               fp,

     

       129
       129
       -
               datetime_as_timestamp=datetime_as_timestamp,

     

       130
       130
       -
               timezone=timezone,

     

       131
       131
       -
               value_sharing=value_sharing,

     

       132
       132
       -
               default=default,

     

       133
       133
       -
               canonical=canonical,

     

       134
       134
       -
               date_as_datetime=date_as_datetime,

     

       135
       135
       -
               string_referencing=string_referencing,

     

       136
       136
       -
               indefinite_containers=indefinite_containers,

     

       137
       137
       -
           ).encode(obj)

-179

tests/_strings.py

···

       1
       1
       -
       from atpasser import did, handle, nsid, rKey, uri

     

       2
       2
       -
       

     

       3
       3
       -
       

     

       4
       4
       -
       testStrings, testMethods = {}, {}

     

       5
       5
       -
       

     

       6
       6
       -
       

     

       7
       7
       -
       testStrings[

     

       8
       8
       -
           "did"

     

       9
       9
       -
       

     

       10
       10
       -
       ] = """did:plc:z72i7hdynmk6r22z27h6tvur

     

       11
       11
       -
       

     

       12
       12
       -
       did:web:blueskyweb.xyz

     

       13
       13
       -
       

     

       14
       14
       -
       did:method:val:two

     

       15
       15
       -
       

     

       16
       16
       -
       did:m:v

     

       17
       17
       -
       

     

       18
       18
       -
       did:method::::val

     

       19
       19
       -
       

     

       20
       20
       -
       did:method:-:_:.

     

       21
       21
       -
       

     

       22
       22
       -
       did:key:zQ3shZc2QzApp2oymGvQbzP8eKheVshBHbU4ZYjeXqwSKEn6N

     

       23
       23
       -
       

     

       24
       24
       -
       did:METHOD:val

     

       25
       25
       -
       

     

       26
       26
       -
       did:m123:val

     

       27
       27
       -
       

     

       28
       28
       -
       DID:method:val

     

       29
       29
       -
       did:method:

     

       30
       30
       -
       

     

       31
       31
       -
       did:method:val/two

     

       32
       32
       -
       

     

       33
       33
       -
       did:method:val?two

     

       34
       34
       -
       

     

       35
       35
       -
       did:method:val#two"""

     

       36
       36
       -
       

     

       37
       37
       -
       testMethods["did"] = did.DID

     

       38
       38
       -
       

     

       39
       39
       -
       

     

       40
       40
       -
       testStrings[

     

       41
       41
       -
           "handle"

     

       42
       42
       -
       

     

       43
       43
       -
       ] = """jay.bsky.social

     

       44
       44
       -
       

     

       45
       45
       -
       8.cn

     

       46
       46
       -
       

     

       47
       47
       -
       name.t--t

     

       48
       48
       -
       

     

       49
       49
       -
       XX.LCS.MIT.EDU

     

       50
       50
       -
       a.co

     

       51
       51
       -
       

     

       52
       52
       -
       xn--notarealidn.com

     

       53
       53
       -
       

     

       54
       54
       -
       xn--fiqa61au8b7zsevnm8ak20mc4a87e.xn--fiqs8s

     

       55
       55
       -
       

     

       56
       56
       -
       xn--ls8h.test

     

       57
       57
       -
       example.t

     

       58
       58
       -
       

     

       59
       59
       -
       jo@hn.test

     

       60
       60
       -
       

     

       61
       61
       -
       💩.tes

     

       62
       62
       -
       t

     

       63
       63
       -
       john..test

     

       64
       64
       -
       

     

       65
       65
       -
       xn--bcher-.tld

     

       66
       66
       -
       

     

       67
       67
       -
       john.0

     

       68
       68
       -
       

     

       69
       69
       -
       cn.8

     

       70
       70
       -
       

     

       71
       71
       -
       www.masełkowski.pl.com

     

       72
       72
       -
       

     

       73
       73
       -
       org

     

       74
       74
       -
       

     

       75
       75
       -
       name.org.

     

       76
       76
       -
       

     

       77
       77
       -
       2gzyxa5ihm7nsggfxnu52rck2vv4rvmdlkiu3zzui5du4xyclen53wid.onion

     

       78
       78
       -
       laptop.local

     

       79
       79
       -
       

     

       80
       80
       -
       blah.arpa"""

     

       81
       81
       -
       

     

       82
       82
       -
       testMethods["handle"] = handle.Handle

     

       83
       83
       -
       

     

       84
       84
       -
       

     

       85
       85
       -
       testStrings[

     

       86
       86
       -
           "nsid"

     

       87
       87
       -
       

     

       88
       88
       -
       ] = """com.example.fooBar

     

       89
       89
       -
       

     

       90
       90
       -
       net.users.bob.ping

     

       91
       91
       -
       

     

       92
       92
       -
       a-0.b-1.c

     

       93
       93
       -
       

     

       94
       94
       -
       a.b.c

     

       95
       95
       -
       

     

       96
       96
       -
       com.example.fooBarV2

     

       97
       97
       -
       

     

       98
       98
       -
       cn.8.lex.stuff

     

       99
       99
       -
       

     

       100
       100
       -
       com.exa💩ple.thin

     

       101
       101
       -
       com.example

     

       102
       102
       -
       

     

       103
       103
       -
       com.example.3"""

     

       104
       104
       -
       

     

       105
       105
       -
       testMethods["nsid"] = nsid.NSID

     

       106
       106
       -
       

     

       107
       107
       -
       

     

       108
       108
       -
       testStrings[

     

       109
       109
       -
       

     

       110
       110
       -
           "rkey"

     

       111
       111
       -
       

     

       112
       112
       -
       ] = """3jui7kd54zh2y

     

       113
       113
       -
       self

     

       114
       114
       -
       example.com

     

       115
       115
       -
       

     

       116
       116
       -
       ~1.2-3_

     

       117
       117
       -
       

     

       118
       118
       -
       dHJ1ZQ

     

       119
       119
       -
       pre:fix

     

       120
       120
       -
       

     

       121
       121
       -
       _

     

       122
       122
       -
       

     

       123
       123
       -
       alpha/beta

     

       124
       124
       -
       .

     

       125
       125
       -
       ..

     

       126
       126
       -
       

     

       127
       127
       -
       #extra

     

       128
       128
       -
       

     

       129
       129
       -
       @handle

     

       130
       130
       -
       

     

       131
       131
       -
       any space

     

       132
       132
       -
       

     

       133
       133
       -
       any+space

     

       134
       134
       -
       

     

       135
       135
       -
       number[3]

     

       136
       136
       -
       

     

       137
       137
       -
       number(3)

     

       138
       138
       -
       

     

       139
       139
       -
       "quote"

     

       140
       140
       -
       

     

       141
       141
       -
       dHJ1ZQ=="""

     

       142
       142
       -
       

     

       143
       143
       -
       testMethods["rkey"] = rKey.RKey

     

       144
       144
       -
       

     

       145
       145
       -
       

     

       146
       146
       -
       testStrings[

     

       147
       147
       -
           "uri"

     

       148
       148
       -
       

     

       149
       149
       -
       ] = """at://foo.com/com.example.foo/123

     

       150
       150
       -
       

     

       151
       151
       -
       at://foo.com/example/123

     

       152
       152
       -
       

     

       153
       153
       -
       at://computer

     

       154
       154
       -
       

     

       155
       155
       -
       at://example.com:3000

     

       156
       156
       -
       

     

       157
       157
       -
       at://foo.com/

     

       158
       158
       -
       

     

       159
       159
       -
       at://user:pass@foo.com"""

     

       160
       160
       -
       

     

       161
       161
       -
       testMethods["uri"] = uri.URI

     

       162
       162
       -
       

     

       163
       163
       -
       

     

       164
       164
       -
       for item in testMethods:

     

       165
       165
       -
       

     

       166
       166
       -
           print(f"START TEST {item}")

     

       167
       167
       -
       

     

       168
       168
       -
           for value in testStrings[item].splitlines():

     

       169
       169
       -
       

     

       170
       170
       -
               print(f"Value: {value}")

     

       171
       171
       -
       

     

       172
       172
       -
               try:

     

       173
       173
       -
       

     

       174
       174
       -
                   print(f"str(): {str(testMethods[item](value))}")

     

       175
       175
       -
       

     

       176
       176
       -
               except Exception as e:

     

       177
       177
       -
       

     

       178
       178
       -
                   print(f"× {e}")

     

       179
       179
       -

+41

src/atpasser/model/typed.py

···

       1
       1
       +
       from typing import Any

     

       2
       2
       +
       from pydantic import field_serializer

     

       3
       3
       +
       from .base import DataModel

     

       4
       4
       +
       

     

       5
       5
       +
       class TypedDataModel(DataModel):

     

       6
       6
       +
           """

     

       7
       7
       +
           Model for AT Protocol data with type information.

     

       8
       8
       +
       

     

       9
       9
       +
           Includes support for $type field that specifies Lexicon schema.

     

       10
       10
       +
           """

     

       11
       11
       +
       

     

       12
       12
       +
           type: str | None = None

     

       13
       13
       +
           """Lexicon schema type identifier"""

     

       14
       14
       +
       

     

       15
       15
       +
           def __init__(self, **data: Any) -> None:

     

       16
       16
       +
               """

     

       17
       17
       +
               Initialize typed data model with automatic $type handling.

     

       18
       18
       +
       

     

       19
       19
       +
               Args:

     

       20
       20
       +
                   **data: Data including optional $type field

     

       21
       21
       +
               """

     

       22
       22
       +
               # Extract $type if present

     

       23
       23
       +
               dataType = data.pop("$type", None)

     

       24
       24
       +
               if dataType:

     

       25
       25
       +
                   data["type"] = dataType

     

       26
       26
       +
               super().__init__(**data)

     

       27
       27
       +
       

     

       28
       28
       +
           @field_serializer("type")

     

       29
       29
       +
           def serializeType(self, v: str | None) -> dict[str, str] | None:

     

       30
       30
       +
               """

     

       31
       31
       +
               Serialize type field to $type object.

     

       32
       32
       +
       

     

       33
       33
       +
               Args:

     

       34
       34
       +
                   v: Type value to serialize

     

       35
       35
       +
       

     

       36
       36
       +
               Returns:

     

       37
       37
       +
                   $type object if type is not None

     

       38
       38
       +
               """

     

       39
       39
       +
               if v is not None:

     

       40
       40
       +
                   return {"$type": v}

     

       41
       41
       +
               return None

+36

src/atpasser/model/exceptions.py

···

       1
       1
       +
       class AtprotoModelError(Exception):

     

       2
       2
       +
           """Base exception for all AT Protocol model errors"""

     

       3
       3
       +
           pass

     

       4
       4
       +
       

     

       5
       5
       +
       class ValidationError(AtprotoModelError):

     

       6
       6
       +
           """Raised when data validation fails"""

     

       7
       7
       +
           def __init__(self, field: str, message: str):

     

       8
       8
       +
               self.field = field

     

       9
       9
       +
               self.message = message

     

       10
       10
       +
               super().__init__(f"Validation error for field '{field}': {message}")

     

       11
       11
       +
       

     

       12
       12
       +
       class SerializationError(AtprotoModelError):

     

       13
       13
       +
           """Raised when data serialization fails"""

     

       14
       14
       +
           def __init__(self, field: str, message: str):

     

       15
       15
       +
               self.field = field

     

       16
       16
       +
               self.message = message

     

       17
       17
       +
               super().__init__(f"Serialization error for field '{field}': {message}")

     

       18
       18
       +
       

     

       19
       19
       +
       class DeserializationError(AtprotoModelError):

     

       20
       20
       +
           """Raised when data deserialization fails"""

     

       21
       21
       +
           def __init__(self, field: str, message: str):

     

       22
       22
       +
               self.field = field

     

       23
       23
       +
               self.message = message

     

       24
       24
       +
               super().__init__(f"Deserialization error for field '{field}': {message}")

     

       25
       25
       +
       

     

       26
       26
       +
       class InvalidCIDError(AtprotoModelError):

     

       27
       27
       +
           """Raised when CID validation fails"""

     

       28
       28
       +
           pass

     

       29
       29
       +
       

     

       30
       30
       +
       class InvalidBlobError(AtprotoModelError):

     

       31
       31
       +
           """Raised when blob validation fails"""

     

       32
       32
       +
           pass

     

       33
       33
       +
       

     

       34
       34
       +
       class TypeMismatchError(AtprotoModelError):

     

       35
       35
       +
           """Raised when type validation fails"""

     

       36
       36
       +
           pass

src/atpasser/model/__init__.py

···

       38
       38
        
           ProcedureModel,

     

       39
       39
        
           SubscriptionModel

     

       40
       40
        
       )

     

       41
       41
       +
       from .converter import LexiconConverter

     

       41
       42
        
       

     

       42
       43
        
       __all__ = [

     

       43
       44
        
           "DataModel",

     
···

       61
       62
        
           "QueryModel",

     

       62
       63
        
           "ProcedureModel",

     

       63
       64
        
           "SubscriptionModel",

     

       65
       65
       +
           # Converter

     

       66
       66
       +
           "LexiconConverter",

     

       64
       67
        
           # Exceptions

     

       65
       68
        
           "AtprotoModelError",

     

       66
       69
        
           "ValidationError",

-5

src/atpasser/model/base.py

···

       1
       1
        
       import base64

     

       2
       2
       -
       import re

     

       3
       3
       -
       from datetime import datetime

     

       4
       2
        
       from typing import Any

     

       5
       5
       -
       from collections.abc import Mapping

     

       6
       3
        
       from cid.cid import CIDv1, make_cid

     

       7
       4
        
       from pydantic import BaseModel, field_serializer, field_validator, ConfigDict

     

       8
       8
       -
       from pydantic.fields import FieldInfo

     

       9
       5
        
       from .exceptions import (

     

       10
       10
       -
           ValidationError,

     

       11
       6
        
           SerializationError,

     

       12
       7
        
           DeserializationError,

     

       13
       8
        
           InvalidCIDError

+5 -5

src/atpasser/model/blob.py

···

       1
       1
        
       from typing import Any

     

       2
       2
        
       from pydantic import field_validator, ConfigDict

     

       3
       3
        
       from .base import DataModel

     

       4
       4
       -
       from .exceptions import ValidationError, InvalidBlobError

     

       4
       4
       +
       from .exceptions import ValidationError

     

       5
       5
        
       

     

       6
       6
        
       class BlobModel(DataModel):

     

       7
       7
        
           """

     
···

       34
       34
        
                   Validated size

     

       35
       35
        
       

     

       36
       36
        
               Raises:

     

       37
       37
       -
                   ValueError: If size is not positive

     

       37
       37
       +
                   ValidationError: If size is not positive

     

       38
       38
        
               """

     

       39
       39
        
               if v <= 0:

     

       40
       40
       -
                   raise ValueError("Blob size must be positive and non-zero")

     

       40
       40
       +
                   raise ValidationError(field="size", message="must be positive and non-zero")

     

       41
       41
        
               return v

     

       42
       42
        
       

     

       43
       43
        
           @field_validator("mimeType")

     
···

       52
       52
        
                   Validated MIME type

     

       53
       53
        
       

     

       54
       54
        
               Raises:

     

       55
       55
       -
                   ValueError: If MIME type is empty

     

       55
       55
       +
                   ValidationError: If MIME type is empty

     

       56
       56
        
               """

     

       57
       57
        
               if not v:

     

       58
       58
       -
                   raise ValueError("MIME type cannot be empty")

     

       58
       58
       +
                   raise ValidationError(field="mimeType", message="cannot be empty")

     

       59
       59
        
               return v

pyproject.toml

···

       26
       26
        
       [tool.poetry.group.dev.dependencies]

     

       27
       27
        
       pytest = "^8.2.0"

     

       28
       28
        
       pytest-cov = "^5.0.0"

     

       29
       29
       +
       pygithub = "^2.8.1"

     

       29
       30
        
       

     

       30
       31
        
       

     

       31
       32
        
       [build-system]

src/atpasser/model/converter.py

···

       15
       15
        
           UnknownModel, RecordModel, QueryModel,

     

       16
       16
        
           ProcedureModel, SubscriptionModel

     

       17
       17
        
       )

     

       18
       18
       +
       from .types.binary import BytesModel, CidLinkModel

     

       19
       19
       +
       from .blob import BlobModel

     

       18
       20
        
       

     

       19
       21
        
       class LexiconConverter:

     

       20
       22
        
           """

     
···

       31
       33
        
               "integer": IntegerModel,

     

       32
       34
        
               "string": StringModel,

     

       33
       35
        
               

     

       36
       36
       +
               # Binary types

     

       37
       37
       +
               "bytes": BytesModel,

     

       38
       38
       +
               "cid-link": CidLinkModel,

     

       39
       39
       +
               "blob": BlobModel,

     

       40
       40
       +
               

     

       34
       41
        
               # Complex types

     

       35
       42
        
               "array": ArrayModel,

     

       36
       43
        
               "object": ObjectModel,

+214

src/atpasser/model/types/complex.py

···

       1
       1
       +
       from typing import Any

     

       2
       2
       +
       from pydantic import field_validator

     

       3
       3
       +
       from ..base import DataModel

     

       4
       4
       +
       

     

       5
       5
       +
       class ArrayModel(DataModel):

     

       6
       6
       +
           """

     

       7
       7
       +
           Model for AT Protocol array type.

     

       8
       8
       +
           

     

       9
       9
       +
           Represents an array of elements with support for item schema definition,

     

       10
       10
       +
           minimum/maximum length constraints as specified in Lexicon.

     

       11
       11
       +
           """

     

       12
       12
       +
           

     

       13
       13
       +
           items: Any

     

       14
       14
       +
           """Schema definition for array elements"""

     

       15
       15
       +
           

     

       16
       16
       +
           minLength: int | None = None

     

       17
       17
       +
           """Minimum number of elements"""

     

       18
       18
       +
           

     

       19
       19
       +
           maxLength: int | None = None

     

       20
       20
       +
           """Maximum number of elements"""

     

       21
       21
       +
           

     

       22
       22
       +
           value: list[Any]

     

       23
       23
       +
           """Array values"""

     

       24
       24
       +
           

     

       25
       25
       +
           def __init__(self, **data: Any) -> None:

     

       26
       26
       +
               """

     

       27
       27
       +
               Initialize array model with validation.

     

       28
       28
       +
               

     

       29
       29
       +
               Args:

     

       30
       30
       +
                   **data: Input data containing array values

     

       31
       31
       +
                   

     

       32
       32
       +
               Raises:

     

       33
       33
       +
                   ValueError: If array violates constraints

     

       34
       34
       +
               """

     

       35
       35
       +
               super().__init__(**data)

     

       36
       36
       +
               

     

       37
       37
       +
           @field_validator("value", mode="before")

     

       38
       38
       +
           def validate_array(cls, v: Any) -> list[Any]:

     

       39
       39
       +
               """

     

       40
       40
       +
               Validate array structure and elements.

     

       41
       41
       +
               

     

       42
       42
       +
               Args:

     

       43
       43
       +
                   v: Value to validate

     

       44
       44
       +
                   

     

       45
       45
       +
               Returns:

     

       46
       46
       +
                   Validated array

     

       47
       47
       +
                   

     

       48
       48
       +
               Raises:

     

       49
       49
       +
                   ValueError: If array violates constraints

     

       50
       50
       +
               """

     

       51
       51
       +
               if not isinstance(v, list):

     

       52
       52
       +
                   raise ValueError("Value must be an array")

     

       53
       53
       +
                   

     

       54
       54
       +
               # Validate length constraints

     

       55
       55
       +
               if cls.minLength is not None and len(v) < cls.minLength:

     

       56
       56
       +
                   raise ValueError(f"Array must have at least {cls.minLength} items")

     

       57
       57
       +
                   

     

       58
       58
       +
               if cls.maxLength is not None and len(v) > cls.maxLength:

     

       59
       59
       +
                   raise ValueError(f"Array must have at most {cls.maxLength} items")

     

       60
       60
       +
                   

     

       61
       61
       +
               return v

     

       62
       62
       +
       

     

       63
       63
       +
       class ObjectModel(DataModel):

     

       64
       64
       +
           """

     

       65
       65
       +
           Model for AT Protocol object type.

     

       66
       66
       +
           

     

       67
       67
       +
           Represents a generic object schema with properties definitions,

     

       68
       68
       +
           required fields and nullable fields as specified in Lexicon.

     

       69
       69
       +
           """

     

       70
       70
       +
           

     

       71
       71
       +
           properties: dict[str, Any]

     

       72
       72
       +
           """Map of property names to their schema definitions"""

     

       73
       73
       +
           

     

       74
       74
       +
           required: list[str] | None = None

     

       75
       75
       +
           """List of required property names"""

     

       76
       76
       +
           

     

       77
       77
       +
           nullable: list[str] | None = None

     

       78
       78
       +
           """List of properties that can be null"""

     

       79
       79
       +
           

     

       80
       80
       +
           value: dict[str, Any]

     

       81
       81
       +
           """Object property values"""

     

       82
       82
       +
           

     

       83
       83
       +
           def __init__(self, **data: Any) -> None:

     

       84
       84
       +
               """

     

       85
       85
       +
               Initialize object model with validation.

     

       86
       86
       +
               

     

       87
       87
       +
               Args:

     

       88
       88
       +
                   **data: Input data containing object properties

     

       89
       89
       +
                   

     

       90
       90
       +
               Raises:

     

       91
       91
       +
                   ValueError: If object violates constraints

     

       92
       92
       +
               """

     

       93
       93
       +
               super().__init__(**data)

     

       94
       94
       +
               

     

       95
       95
       +
           @field_validator("value", mode="before")

     

       96
       96
       +
           def validate_object(cls, v: Any) -> dict[str, Any]:

     

       97
       97
       +
               """

     

       98
       98
       +
               Validate object structure and properties.

     

       99
       99
       +
               

     

       100
       100
       +
               Args:

     

       101
       101
       +
                   v: Value to validate

     

       102
       102
       +
                   

     

       103
       103
       +
               Returns:

     

       104
       104
       +
                   Validated object

     

       105
       105
       +
                   

     

       106
       106
       +
               Raises:

     

       107
       107
       +
                   ValueError: If object violates constraints

     

       108
       108
       +
               """

     

       109
       109
       +
               if not isinstance(v, dict):

     

       110
       110
       +
                   raise ValueError("Value must be an object")

     

       111
       111
       +
                   

     

       112
       112
       +
               # Validate required fields

     

       113
       113
       +
               if cls.required:

     

       114
       114
       +
                   for field in cls.required:

     

       115
       115
       +
                       if field not in v:

     

       116
       116
       +
                           raise ValueError(f"Missing required field: {field}")

     

       117
       117
       +
                           

     

       118
       118
       +
               # Validate nullable fields

     

       119
       119
       +
               if cls.nullable:

     

       120
       120
       +
                   for field, value in v.items():

     

       121
       121
       +
                       if field not in cls.nullable and value is None:

     

       122
       122
       +
                           raise ValueError(f"Field {field} cannot be null")

     

       123
       123
       +
                           

     

       124
       124
       +
               return v

     

       125
       125
       +
       

     

       126
       126
       +
       class ParamsModel(DataModel):

     

       127
       127
       +
           """

     

       128
       128
       +
           Model for AT Protocol params type.

     

       129
       129
       +
           

     

       130
       130
       +
           Specialized for HTTP query parameters with support for boolean,

     

       131
       131
       +
           integer, string and unknown types as specified in Lexicon.

     

       132
       132
       +
           """

     

       133
       133
       +
           

     

       134
       134
       +
           required: list[str] | None = None

     

       135
       135
       +
           """List of required parameter names"""

     

       136
       136
       +
           

     

       137
       137
       +
           properties: dict[str, Any]

     

       138
       138
       +
           """Map of parameter names to their schema definitions"""

     

       139
       139
       +
           

     

       140
       140
       +
           value: dict[str, Any]

     

       141
       141
       +
           """Parameter values

     

       142
       142
       +
           

     

       143
       143
       +
           Supported types:

     

       144
       144
       +
           - boolean

     

       145
       145
       +
           - integer

     

       146
       146
       +
           - string

     

       147
       147
       +
           - array (of boolean/integer/string/unknown)

     

       148
       148
       +
           - unknown (object)

     

       149
       149
       +
           """

     

       150
       150
       +
           

     

       151
       151
       +
           def __init__(self, **data: Any) -> None:

     

       152
       152
       +
               """

     

       153
       153
       +
               Initialize params model with validation.

     

       154
       154
       +
               

     

       155
       155
       +
               Args:

     

       156
       156
       +
                   **data: Input data containing parameter values

     

       157
       157
       +
                   

     

       158
       158
       +
               Raises:

     

       159
       159
       +
                   ValueError: If parameters violate constraints

     

       160
       160
       +
               """

     

       161
       161
       +
               super().__init__(**data)

     

       162
       162
       +
               

     

       163
       163
       +
           @field_validator("value", mode="before")

     

       164
       164
       +
           def validate_params(cls, v: Any) -> dict[str, Any]:

     

       165
       165
       +
               """

     

       166
       166
       +
               Validate parameters structure and values.

     

       167
       167
       +
               

     

       168
       168
       +
               Args:

     

       169
       169
       +
                   v: Value to validate

     

       170
       170
       +
                   

     

       171
       171
       +
               Returns:

     

       172
       172
       +
                   Validated parameters

     

       173
       173
       +
                   

     

       174
       174
       +
               Raises:

     

       175
       175
       +
                   ValueError: If parameters violate constraints

     

       176
       176
       +
               """

     

       177
       177
       +
               if not isinstance(v, dict):

     

       178
       178
       +
                   raise ValueError("Value must be a dictionary of parameters")

     

       179
       179
       +
                   

     

       180
       180
       +
               # Validate required parameters

     

       181
       181
       +
               if cls.required:

     

       182
       182
       +
                   for param in cls.required:

     

       183
       183
       +
                       if param not in v:

     

       184
       184
       +
                           raise ValueError(f"Missing required parameter: {param}")

     

       185
       185
       +
                           

     

       186
       186
       +
               # Validate parameter types

     

       187
       187
       +
               for param, value in v.items():

     

       188
       188
       +
                   if param in cls.properties:

     

       189
       189
       +
                       prop_type = cls.properties[param].get("type")

     

       190
       190
       +
                       if prop_type == "boolean" and not isinstance(value, bool):

     

       191
       191
       +
                           raise ValueError(f"Parameter {param} must be boolean")

     

       192
       192
       +
                       elif prop_type == "integer" and not isinstance(value, int):

     

       193
       193
       +
                           raise ValueError(f"Parameter {param} must be integer")

     

       194
       194
       +
                       elif prop_type == "string" and not isinstance(value, str):

     

       195
       195
       +
                           raise ValueError(f"Parameter {param} must be string")

     

       196
       196
       +
                       elif prop_type == "array":

     

       197
       197
       +
                           if not isinstance(value, list):

     

       198
       198
       +
                               raise ValueError(f"Parameter {param} must be array")

     

       199
       199
       +
                           # Validate array items if schema is specified

     

       200
       200
       +
                           if "items" in cls.properties[param]:

     

       201
       201
       +
                               item_type = cls.properties[param]["items"].get("type")

     

       202
       202
       +
                               for item in value:

     

       203
       203
       +
                                   if item_type == "boolean" and not isinstance(item, bool):

     

       204
       204
       +
                                       raise ValueError(f"Array item in {param} must be boolean")

     

       205
       205
       +
                                   elif item_type == "integer" and not isinstance(item, int):

     

       206
       206
       +
                                       raise ValueError(f"Array item in {param} must be integer")

     

       207
       207
       +
                                   elif item_type == "string" and not isinstance(item, str):

     

       208
       208
       +
                                       raise ValueError(f"Array item in {param} must be string")

     

       209
       209
       +
                                   elif item_type == "unknown" and not isinstance(item, dict):

     

       210
       210
       +
                                       raise ValueError(f"Array item in {param} must be object")

     

       211
       211
       +
                       elif prop_type == "unknown" and not isinstance(value, dict):

     

       212
       212
       +
                           raise ValueError(f"Parameter {param} must be object")

     

       213
       213
       +
                           

     

       214
       214
       +
               return v

+172

src/atpasser/model/types/primitive.py

···

       1
       1
       +
       from typing import Any

     

       2
       2
       +
       from pydantic import field_validator

     

       3
       3
       +
       from ..base import DataModel

     

       4
       4
       +
       

     

       5
       5
       +
       class NullModel(DataModel):

     

       6
       6
       +
           """

     

       7
       7
       +
           Model for AT Protocol null type.

     

       8
       8
       +
           

     

       9
       9
       +
           Represents a null value in AT Protocol data model. This model ensures proper

     

       10
       10
       +
           serialization and validation of null values according to Lexicon specification.

     

       11
       11
       +
           """

     

       12
       12
       +
           

     

       13
       13
       +
           value: None = None

     

       14
       14
       +
           """Always None for null type"""

     

       15
       15
       +
           

     

       16
       16
       +
           def __init__(self, **data: Any) -> None:

     

       17
       17
       +
               """

     

       18
       18
       +
               Initialize null model with validation.

     

       19
       19
       +
               

     

       20
       20
       +
               Args:

     

       21
       21
       +
                   **data: Input data (must be empty or contain only None values)

     

       22
       22
       +
                   

     

       23
       23
       +
               Raises:

     

       24
       24
       +
                   ValueError: If non-null value is provided

     

       25
       25
       +
               """

     

       26
       26
       +
               if data and any(v is not None for v in data.values()):

     

       27
       27
       +
                   raise ValueError("NullModel only accepts None values")

     

       28
       28
       +
               super().__init__(**data)

     

       29
       29
       +
           

     

       30
       30
       +
           @field_validator("*", mode="before")

     

       31
       31
       +
           def validate_null(cls, v: Any) -> None:

     

       32
       32
       +
               """

     

       33
       33
       +
               Validate that value is null.

     

       34
       34
       +
               

     

       35
       35
       +
               Args:

     

       36
       36
       +
                   v: Value to validate

     

       37
       37
       +
                   

     

       38
       38
       +
               Returns:

     

       39
       39
       +
                   None if validation succeeds

     

       40
       40
       +
                   

     

       41
       41
       +
               Raises:

     

       42
       42
       +
                   ValueError: If value is not null

     

       43
       43
       +
               """

     

       44
       44
       +
               if v is not None:

     

       45
       45
       +
                   raise ValueError("NullModel only accepts None values")

     

       46
       46
       +
               return None

     

       47
       47
       +
       

     

       48
       48
       +
       class BooleanModel(DataModel):

     

       49
       49
       +
           """

     

       50
       50
       +
           Model for AT Protocol boolean type.

     

       51
       51
       +
           

     

       52
       52
       +
           Represents a boolean value in AT Protocol data model with support for

     

       53
       53
       +
           default values and constants as specified in Lexicon.

     

       54
       54
       +
           """

     

       55
       55
       +
           

     

       56
       56
       +
           value: bool

     

       57
       57
       +
           """Boolean value"""

     

       58
       58
       +
           

     

       59
       59
       +
           default: bool | None = None

     

       60
       60
       +
           """Default value if not provided"""

     

       61
       61
       +
           

     

       62
       62
       +
           const: bool | None = None

     

       63
       63
       +
           """Fixed constant value if specified"""

     

       64
       64
       +
           

     

       65
       65
       +
           def __init__(self, **data: Any) -> None:

     

       66
       66
       +
               """

     

       67
       67
       +
               Initialize boolean model with validation.

     

       68
       68
       +
               

     

       69
       69
       +
               Args:

     

       70
       70
       +
                   **data: Input data containing boolean value

     

       71
       71
       +
                   

     

       72
       72
       +
               Raises:

     

       73
       73
       +
                   ValueError: If value doesn't match const or is not boolean

     

       74
       74
       +
               """

     

       75
       75
       +
               super().__init__(**data)

     

       76
       76
       +
               if self.const is not None and self.value != self.const:

     

       77
       77
       +
                   raise ValueError(f"Boolean value must be {self.const}")

     

       78
       78
       +
           

     

       79
       79
       +
           @field_validator("value", mode="before")

     

       80
       80
       +
           def validate_boolean(cls, v: Any) -> bool:

     

       81
       81
       +
               """

     

       82
       82
       +
               Validate and convert input to boolean.

     

       83
       83
       +
               

     

       84
       84
       +
               Args:

     

       85
       85
       +
                   v: Value to validate

     

       86
       86
       +
                   

     

       87
       87
       +
               Returns:

     

       88
       88
       +
                   Validated boolean value

     

       89
       89
       +
                   

     

       90
       90
       +
               Raises:

     

       91
       91
       +
                   ValueError: If value cannot be converted to boolean

     

       92
       92
       +
               """

     

       93
       93
       +
               if isinstance(v, bool):

     

       94
       94
       +
                   return v

     

       95
       95
       +
               if isinstance(v, str):

     

       96
       96
       +
                   if v.lower() in ("true", "1"):

     

       97
       97
       +
                       return True

     

       98
       98
       +
                   if v.lower() in ("false", "0"):

     

       99
       99
       +
                       return False

     

       100
       100
       +
               raise ValueError("Value must be a boolean")

     

       101
       101
       +
       

     

       102
       102
       +
       class IntegerModel(DataModel):

     

       103
       103
       +
           """

     

       104
       104
       +
           Model for AT Protocol integer type.

     

       105
       105
       +
           

     

       106
       106
       +
           Represents a signed integer number with support for minimum/maximum values,

     

       107
       107
       +
           enumeration sets, default values and constraints as specified in Lexicon.

     

       108
       108
       +
           """

     

       109
       109
       +
           

     

       110
       110
       +
           value: int

     

       111
       111
       +
           """Integer value"""

     

       112
       112
       +
           

     

       113
       113
       +
           minimum: int | None = None

     

       114
       114
       +
           """Minimum acceptable value"""

     

       115
       115
       +
           

     

       116
       116
       +
           maximum: int | None = None

     

       117
       117
       +
           """Maximum acceptable value"""

     

       118
       118
       +
           

     

       119
       119
       +
           enum: list[int] | None = None

     

       120
       120
       +
           """Closed set of allowed values"""

     

       121
       121
       +
           

     

       122
       122
       +
           default: int | None = None

     

       123
       123
       +
           """Default value if not provided"""

     

       124
       124
       +
           

     

       125
       125
       +
           const: int | None = None

     

       126
       126
       +
           """Fixed constant value if specified"""

     

       127
       127
       +
           

     

       128
       128
       +
           def __init__(self, **data: Any) -> None:

     

       129
       129
       +
               """

     

       130
       130
       +
               Initialize integer model with validation.

     

       131
       131
       +
               

     

       132
       132
       +
               Args:

     

       133
       133
       +
                   **data: Input data containing integer value

     

       134
       134
       +
                   

     

       135
       135
       +
               Raises:

     

       136
       136
       +
                   ValueError: If value violates constraints

     

       137
       137
       +
               """

     

       138
       138
       +
               super().__init__(**data)

     

       139
       139
       +
               if self.const is not None and self.value != self.const:

     

       140
       140
       +
                   raise ValueError(f"Integer value must be {self.const}")

     

       141
       141
       +
           

     

       142
       142
       +
           @field_validator("value", mode="before")

     

       143
       143
       +
           def validate_integer(cls, v: Any) -> int:

     

       144
       144
       +
               """

     

       145
       145
       +
               Validate and convert input to integer.

     

       146
       146
       +
               

     

       147
       147
       +
               Args:

     

       148
       148
       +
                   v: Value to validate

     

       149
       149
       +
                   

     

       150
       150
       +
               Returns:

     

       151
       151
       +
                   Validated integer value

     

       152
       152
       +
                   

     

       153
       153
       +
               Raises:

     

       154
       154
       +
                   ValueError: If value violates constraints

     

       155
       155
       +
               """

     

       156
       156
       +
               if not isinstance(v, int):

     

       157
       157
       +
                   try:

     

       158
       158
       +
                       v = int(v)

     

       159
       159
       +
                   except (TypeError, ValueError):

     

       160
       160
       +
                       raise ValueError("Value must be an integer")

     

       161
       161
       +
               

     

       162
       162
       +
               # Validate against instance attributes

     

       163
       163
       +
               if cls.enum and v not in cls.enum:

     

       164
       164
       +
                   raise ValueError(f"Value must be one of {cls.enum}")

     

       165
       165
       +
                   

     

       166
       166
       +
               if cls.minimum is not None and v < cls.minimum:

     

       167
       167
       +
                   raise ValueError(f"Value must be >= {cls.minimum}")

     

       168
       168
       +
                   

     

       169
       169
       +
               if cls.maximum is not None and v > cls.maximum:

     

       170
       170
       +
                   raise ValueError(f"Value must be <= {cls.maximum}")

     

       171
       171
       +
                   

     

       172
       172
       +
               return v

+131

src/atpasser/model/types/reference.py

···

       1
       1
       +
       from typing import Any

     

       2
       2
       +
       from pydantic import field_validator

     

       3
       3
       +
       from ..base import DataModel

     

       4
       4
       +
       

     

       5
       5
       +
       class TokenModel(DataModel):

     

       6
       6
       +
           """

     

       7
       7
       +
           Model for AT Protocol token type.

     

       8
       8
       +
           

     

       9
       9
       +
           Represents empty data values which exist only to be referenced by name.

     

       10
       10
       +
           Tokens encode as string data with the string being the fully-qualified

     

       11
       11
       +
           reference to the token itself (NSID followed by optional fragment).

     

       12
       12
       +
           """

     

       13
       13
       +
           

     

       14
       14
       +
           name: str

     

       15
       15
       +
           """Token name/identifier"""

     

       16
       16
       +
           

     

       17
       17
       +
           description: str | None = None

     

       18
       18
       +
           """Description clarifying the meaning of the token"""

     

       19
       19
       +
           

     

       20
       20
       +
           def __init__(self, **data: Any) -> None:

     

       21
       21
       +
               """

     

       22
       22
       +
               Initialize token model.

     

       23
       23
       +
               

     

       24
       24
       +
               Args:

     

       25
       25
       +
                   **data: Input data containing token name

     

       26
       26
       +
               """

     

       27
       27
       +
               super().__init__(**data)

     

       28
       28
       +
               

     

       29
       29
       +
           @field_validator("name")

     

       30
       30
       +
           def validate_name(cls, v: str) -> str:

     

       31
       31
       +
               """

     

       32
       32
       +
               Validate token name format.

     

       33
       33
       +
               

     

       34
       34
       +
               Args:

     

       35
       35
       +
                   v: Name to validate

     

       36
       36
       +
                   

     

       37
       37
       +
               Returns:

     

       38
       38
       +
                   Validated name

     

       39
       39
       +
                   

     

       40
       40
       +
               Raises:

     

       41
       41
       +
                   ValueError: If name contains whitespace

     

       42
       42
       +
               """

     

       43
       43
       +
               if any(c.isspace() for c in v):

     

       44
       44
       +
                   raise ValueError("Token name must not contain whitespace")

     

       45
       45
       +
               return v

     

       46
       46
       +
       

     

       47
       47
       +
       class RefModel(DataModel):

     

       48
       48
       +
           """

     

       49
       49
       +
           Model for AT Protocol ref type.

     

       50
       50
       +
           

     

       51
       51
       +
           Represents a reference to another schema definition, either globally

     

       52
       52
       +
           (using NSID) or locally (using #-delimited name).

     

       53
       53
       +
           """

     

       54
       54
       +
           

     

       55
       55
       +
           ref: str

     

       56
       56
       +
           """Reference to schema definition (NSID or #name)"""

     

       57
       57
       +
           

     

       58
       58
       +
           description: str | None = None

     

       59
       59
       +
           """Description of the reference"""

     

       60
       60
       +
           

     

       61
       61
       +
           def __init__(self, **data: Any) -> None:

     

       62
       62
       +
               """

     

       63
       63
       +
               Initialize reference model.

     

       64
       64
       +
               

     

       65
       65
       +
               Args:

     

       66
       66
       +
                   **data: Input data containing reference

     

       67
       67
       +
               """

     

       68
       68
       +
               super().__init__(**data)

     

       69
       69
       +
               

     

       70
       70
       +
           @field_validator("ref")

     

       71
       71
       +
           def validate_ref(cls, v: str) -> str:

     

       72
       72
       +
               """

     

       73
       73
       +
               Validate reference format.

     

       74
       74
       +
               

     

       75
       75
       +
               Args:

     

       76
       76
       +
                   v: Reference to validate

     

       77
       77
       +
                   

     

       78
       78
       +
               Returns:

     

       79
       79
       +
                   Validated reference

     

       80
       80
       +
                   

     

       81
       81
       +
               Raises:

     

       82
       82
       +
                   ValueError: If reference is empty or invalid

     

       83
       83
       +
               """

     

       84
       84
       +
               if not v:

     

       85
       85
       +
                   raise ValueError("Reference cannot be empty")

     

       86
       86
       +
               return v

     

       87
       87
       +
       

     

       88
       88
       +
       class UnionModel(DataModel):

     

       89
       89
       +
           """

     

       90
       90
       +
           Model for AT Protocol union type.

     

       91
       91
       +
           

     

       92
       92
       +
           Represents that multiple possible types could be present at a location.

     

       93
       93
       +
           The references follow the same syntax as `ref`, allowing references to

     

       94
       94
       +
           both global or local schema definitions.

     

       95
       95
       +
           """

     

       96
       96
       +
           

     

       97
       97
       +
           refs: list[str]

     

       98
       98
       +
           """References to schema definitions"""

     

       99
       99
       +
           

     

       100
       100
       +
           closed: bool = False

     

       101
       101
       +
           """Indicates if union is open (can be extended) or closed"""

     

       102
       102
       +
           

     

       103
       103
       +
           description: str | None = None

     

       104
       104
       +
           """Description of the union"""

     

       105
       105
       +
           

     

       106
       106
       +
           def __init__(self, **data: Any) -> None:

     

       107
       107
       +
               """

     

       108
       108
       +
               Initialize union model.

     

       109
       109
       +
               

     

       110
       110
       +
               Args:

     

       111
       111
       +
                   **data: Input data containing union references

     

       112
       112
       +
               """

     

       113
       113
       +
               super().__init__(**data)

     

       114
       114
       +
               

     

       115
       115
       +
           @field_validator("refs")

     

       116
       116
       +
           def validate_refs(cls, v: list[str]) -> list[str]:

     

       117
       117
       +
               """

     

       118
       118
       +
               Validate union references.

     

       119
       119
       +
               

     

       120
       120
       +
               Args:

     

       121
       121
       +
                   v: References to validate

     

       122
       122
       +
                   

     

       123
       123
       +
               Returns:

     

       124
       124
       +
                   Validated references

     

       125
       125
       +
                   

     

       126
       126
       +
               Raises:

     

       127
       127
       +
                   ValueError: If references list is empty for closed union

     

       128
       128
       +
               """

     

       129
       129
       +
               if cls.closed and not v:

     

       130
       130
       +
                   raise ValueError("Closed union must have at least one reference")

     

       131
       131
       +
               return v

+323

src/atpasser/model/types/special.py

···

       1
       1
       +
       from typing import Any

     

       2
       2
       +
       from pydantic import field_validator

     

       3
       3
       +
       from ..base import DataModel

     

       4
       4
       +
       

     

       5
       5
       +
       class UnknownModel(DataModel):

     

       6
       6
       +
           """

     

       7
       7
       +
           Model for AT Protocol unknown type.

     

       8
       8
       +
           

     

       9
       9
       +
           Indicates that any data object could appear at this location,

     

       10
       10
       +
           with no specific validation. The top-level data must be an object.

     

       11
       11
       +
           """

     

       12
       12
       +
           

     

       13
       13
       +
           description: str | None = None

     

       14
       14
       +
           """Description of the unknown type usage"""

     

       15
       15
       +
           

     

       16
       16
       +
           def __init__(self, **data: Any) -> None:

     

       17
       17
       +
               """

     

       18
       18
       +
               Initialize unknown model.

     

       19
       19
       +
               

     

       20
       20
       +
               Args:

     

       21
       21
       +
                   **data: Input data containing unknown object

     

       22
       22
       +
               """

     

       23
       23
       +
               super().__init__(**data)

     

       24
       24
       +
               

     

       25
       25
       +
           @field_validator("*", mode="before")

     

       26
       26
       +
           def validate_unknown(cls, v: Any) -> Any:

     

       27
       27
       +
               """

     

       28
       28
       +
               Validate unknown data is an object.

     

       29
       29
       +
               

     

       30
       30
       +
               Args:

     

       31
       31
       +
                   v: Value to validate

     

       32
       32
       +
                   

     

       33
       33
       +
               Returns:

     

       34
       34
       +
                   Validated value

     

       35
       35
       +
                   

     

       36
       36
       +
               Raises:

     

       37
       37
       +
                   ValueError: If value is not an object

     

       38
       38
       +
               """

     

       39
       39
       +
               if not isinstance(v, dict):

     

       40
       40
       +
                   raise ValueError("Unknown type must be an object")

     

       41
       41
       +
               return v

     

       42
       42
       +
       

     

       43
       43
       +
       class RecordModel(DataModel):

     

       44
       44
       +
           """

     

       45
       45
       +
           Model for AT Protocol record type.

     

       46
       46
       +
           

     

       47
       47
       +
           Describes an object that can be stored in a repository record.

     

       48
       48
       +
           Records must include a $type field indicating their schema.

     

       49
       49
       +
           """

     

       50
       50
       +
           

     

       51
       51
       +
           key: str

     

       52
       52
       +
           """Specifies the Record Key type"""

     

       53
       53
       +
           

     

       54
       54
       +
           record: dict[str, Any]

     

       55
       55
       +
           """Schema definition with type 'object'"""

     

       56
       56
       +
           

     

       57
       57
       +
           type: str

     

       58
       58
       +
           """Lexicon schema type identifier"""

     

       59
       59
       +
           

     

       60
       60
       +
           def __init__(self, **data: Any) -> None:

     

       61
       61
       +
               """

     

       62
       62
       +
               Initialize record model with validation.

     

       63
       63
       +
               

     

       64
       64
       +
               Args:

     

       65
       65
       +
                   **data: Input data containing record values

     

       66
       66
       +
                   

     

       67
       67
       +
               Raises:

     

       68
       68
       +
                   ValueError: If record is missing required fields

     

       69
       69
       +
               """

     

       70
       70
       +
               # Extract $type if present

     

       71
       71
       +
               data_type = data.pop("$type", None)

     

       72
       72
       +
               if data_type:

     

       73
       73
       +
                   data["type"] = data_type

     

       74
       74
       +
               super().__init__(**data)

     

       75
       75
       +
               

     

       76
       76
       +
           @field_validator("type")

     

       77
       77
       +
           def validate_type(cls, v: str) -> str:

     

       78
       78
       +
               """

     

       79
       79
       +
               Validate record type field.

     

       80
       80
       +
               

     

       81
       81
       +
               Args:

     

       82
       82
       +
                   v: Type value to validate

     

       83
       83
       +
                   

     

       84
       84
       +
               Returns:

     

       85
       85
       +
                   Validated type

     

       86
       86
       +
                   

     

       87
       87
       +
               Raises:

     

       88
       88
       +
                   ValueError: If type is empty

     

       89
       89
       +
               """

     

       90
       90
       +
               if not v:

     

       91
       91
       +
                   raise ValueError("Record must have a type")

     

       92
       92
       +
               return v

     

       93
       93
       +
               

     

       94
       94
       +
           @field_validator("record", mode="before")

     

       95
       95
       +
           def validate_record(cls, v: Any) -> dict[str, Any]:

     

       96
       96
       +
               """

     

       97
       97
       +
               Validate record structure.

     

       98
       98
       +
               

     

       99
       99
       +
               Args:

     

       100
       100
       +
                   v: Record value to validate

     

       101
       101
       +
                   

     

       102
       102
       +
               Returns:

     

       103
       103
       +
                   Validated record

     

       104
       104
       +
                   

     

       105
       105
       +
               Raises:

     

       106
       106
       +
                   ValueError: If record is not an object

     

       107
       107
       +
               """

     

       108
       108
       +
               if not isinstance(v, dict):

     

       109
       109
       +
                   raise ValueError("Record must be an object")

     

       110
       110
       +
               return v

     

       111
       111
       +
       

     

       112
       112
       +
       class QueryModel(DataModel):

     

       113
       113
       +
           """

     

       114
       114
       +
           Model for AT Protocol query type.

     

       115
       115
       +
           

     

       116
       116
       +
           Describes an XRPC Query endpoint (HTTP GET) with support for

     

       117
       117
       +
           parameters, output schema and error responses.

     

       118
       118
       +
           """

     

       119
       119
       +
           

     

       120
       120
       +
           parameters: dict[str, Any] | None = None

     

       121
       121
       +
           """HTTP query parameters schema"""

     

       122
       122
       +
           

     

       123
       123
       +
           output: dict[str, Any] | None = None

     

       124
       124
       +
           """HTTP response body schema"""

     

       125
       125
       +
           

     

       126
       126
       +
           errors: list[dict[str, str]] | None = None

     

       127
       127
       +
           """Possible error responses"""

     

       128
       128
       +
           

     

       129
       129
       +
           def __init__(self, **data: Any) -> None:

     

       130
       130
       +
               """

     

       131
       131
       +
               Initialize query model with validation.

     

       132
       132
       +
               

     

       133
       133
       +
               Args:

     

       134
       134
       +
                   **data: Input data containing query definition

     

       135
       135
       +
               """

     

       136
       136
       +
               super().__init__(**data)

     

       137
       137
       +
               

     

       138
       138
       +
           @field_validator("output")

     

       139
       139
       +
           def validate_output(cls, v: dict[str, Any] | None) -> dict[str, Any] | None:

     

       140
       140
       +
               """

     

       141
       141
       +
               Validate output schema.

     

       142
       142
       +
               

     

       143
       143
       +
               Args:

     

       144
       144
       +
                   v: Output schema to validate

     

       145
       145
       +
                   

     

       146
       146
       +
               Returns:

     

       147
       147
       +
                   Validated output schema

     

       148
       148
       +
                   

     

       149
       149
       +
               Raises:

     

       150
       150
       +
                   ValueError: If output schema is invalid

     

       151
       151
       +
               """

     

       152
       152
       +
               if v and "encoding" not in v:

     

       153
       153
       +
                   raise ValueError("Output must specify encoding")

     

       154
       154
       +
               return v

     

       155
       155
       +
               

     

       156
       156
       +
           @field_validator("errors")

     

       157
       157
       +
           def validate_errors(cls, v: list[dict[str, str]] | None) -> list[dict[str, str]] | None:

     

       158
       158
       +
               """

     

       159
       159
       +
               Validate error definitions.

     

       160
       160
       +
               

     

       161
       161
       +
               Args:

     

       162
       162
       +
                   v: Error definitions to validate

     

       163
       163
       +
                   

     

       164
       164
       +
               Returns:

     

       165
       165
       +
                   Validated error definitions

     

       166
       166
       +
                   

     

       167
       167
       +
               Raises:

     

       168
       168
       +
                   ValueError: If any error definition is invalid

     

       169
       169
       +
               """

     

       170
       170
       +
               if v:

     

       171
       171
       +
                   for error in v:

     

       172
       172
       +
                       if "name" not in error:

     

       173
       173
       +
                           raise ValueError("Error must have a name")

     

       174
       174
       +
               return v

     

       175
       175
       +
       

     

       176
       176
       +
       class ProcedureModel(DataModel):

     

       177
       177
       +
           """

     

       178
       178
       +
           Model for AT Protocol procedure type.

     

       179
       179
       +
           

     

       180
       180
       +
           Describes an XRPC Procedure endpoint (HTTP POST) with support for

     

       181
       181
       +
           parameters, input/output schemas and error responses.

     

       182
       182
       +
           """

     

       183
       183
       +
           

     

       184
       184
       +
           parameters: dict[str, Any] | None = None

     

       185
       185
       +
           """HTTP query parameters schema"""

     

       186
       186
       +
           

     

       187
       187
       +
           input: dict[str, Any] | None = None

     

       188
       188
       +
           """HTTP request body schema"""

     

       189
       189
       +
           

     

       190
       190
       +
           output: dict[str, Any] | None = None

     

       191
       191
       +
           """HTTP response body schema"""

     

       192
       192
       +
           

     

       193
       193
       +
           errors: list[dict[str, str]] | None = None

     

       194
       194
       +
           """Possible error responses"""

     

       195
       195
       +
           

     

       196
       196
       +
           def __init__(self, **data: Any) -> None:

     

       197
       197
       +
               """

     

       198
       198
       +
               Initialize procedure model with validation.

     

       199
       199
       +
               

     

       200
       200
       +
               Args:

     

       201
       201
       +
                   **data: Input data containing procedure definition

     

       202
       202
       +
               """

     

       203
       203
       +
               super().__init__(**data)

     

       204
       204
       +
               

     

       205
       205
       +
           @field_validator("input")

     

       206
       206
       +
           def validate_input(cls, v: dict[str, Any] | None) -> dict[str, Any] | None:

     

       207
       207
       +
               """

     

       208
       208
       +
               Validate input schema.

     

       209
       209
       +
               

     

       210
       210
       +
               Args:

     

       211
       211
       +
                   v: Input schema to validate

     

       212
       212
       +
                   

     

       213
       213
       +
               Returns:

     

       214
       214
       +
                   Validated input schema

     

       215
       215
       +
                   

     

       216
       216
       +
               Raises:

     

       217
       217
       +
                   ValueError: If input schema is invalid

     

       218
       218
       +
               """

     

       219
       219
       +
               if v and "encoding" not in v:

     

       220
       220
       +
                   raise ValueError("Input must specify encoding")

     

       221
       221
       +
               return v

     

       222
       222
       +
               

     

       223
       223
       +
           @field_validator("output")

     

       224
       224
       +
           def validate_output(cls, v: dict[str, Any] | None) -> dict[str, Any] | None:

     

       225
       225
       +
               """

     

       226
       226
       +
               Validate output schema.

     

       227
       227
       +
               

     

       228
       228
       +
               Args:

     

       229
       229
       +
                   v: Output schema to validate

     

       230
       230
       +
                   

     

       231
       231
       +
               Returns:

     

       232
       232
       +
                   Validated output schema

     

       233
       233
       +
                   

     

       234
       234
       +
               Raises:

     

       235
       235
       +
                   ValueError: If output schema is invalid

     

       236
       236
       +
               """

     

       237
       237
       +
               if v and "encoding" not in v:

     

       238
       238
       +
                   raise ValueError("Output must specify encoding")

     

       239
       239
       +
               return v

     

       240
       240
       +
               

     

       241
       241
       +
           @field_validator("errors")

     

       242
       242
       +
           def validate_errors(cls, v: list[dict[str, str]] | None) -> list[dict[str, str]] | None:

     

       243
       243
       +
               """

     

       244
       244
       +
               Validate error definitions.

     

       245
       245
       +
               

     

       246
       246
       +
               Args:

     

       247
       247
       +
                   v: Error definitions to validate

     

       248
       248
       +
                   

     

       249
       249
       +
               Returns:

     

       250
       250
       +
                   Validated error definitions

     

       251
       251
       +
                   

     

       252
       252
       +
               Raises:

     

       253
       253
       +
                   ValueError: If any error definition is invalid

     

       254
       254
       +
               """

     

       255
       255
       +
               if v:

     

       256
       256
       +
                   for error in v:

     

       257
       257
       +
                       if "name" not in error:

     

       258
       258
       +
                           raise ValueError("Error must have a name")

     

       259
       259
       +
               return v

     

       260
       260
       +
       

     

       261
       261
       +
       class SubscriptionModel(DataModel):

     

       262
       262
       +
           """

     

       263
       263
       +
           Model for AT Protocol subscription type.

     

       264
       264
       +
           

     

       265
       265
       +
           Describes an Event Stream (WebSocket) with support for parameters,

     

       266
       266
       +
           message schemas and error responses.

     

       267
       267
       +
           """

     

       268
       268
       +
           

     

       269
       269
       +
           parameters: dict[str, Any] | None = None

     

       270
       270
       +
           """HTTP query parameters schema"""

     

       271
       271
       +
           

     

       272
       272
       +
           message: dict[str, Any] | None = None

     

       273
       273
       +
           """Specifies what messages can be"""

     

       274
       274
       +
           

     

       275
       275
       +
           errors: list[dict[str, str]] | None = None

     

       276
       276
       +
           """Possible error responses"""

     

       277
       277
       +
           

     

       278
       278
       +
           def __init__(self, **data: Any) -> None:

     

       279
       279
       +
               """

     

       280
       280
       +
               Initialize subscription model with validation.

     

       281
       281
       +
               

     

       282
       282
       +
               Args:

     

       283
       283
       +
                   **data: Input data containing subscription definition

     

       284
       284
       +
               """

     

       285
       285
       +
               super().__init__(**data)

     

       286
       286
       +
               

     

       287
       287
       +
           @field_validator("message")

     

       288
       288
       +
           def validate_message(cls, v: dict[str, Any] | None) -> dict[str, Any] | None:

     

       289
       289
       +
               """

     

       290
       290
       +
               Validate message schema.

     

       291
       291
       +
               

     

       292
       292
       +
               Args:

     

       293
       293
       +
                   v: Message schema to validate

     

       294
       294
       +
                   

     

       295
       295
       +
               Returns:

     

       296
       296
       +
                   Validated message schema

     

       297
       297
       +
                   

     

       298
       298
       +
               Raises:

     

       299
       299
       +
                   ValueError: If message schema is invalid

     

       300
       300
       +
               """

     

       301
       301
       +
               if v and "schema" not in v:

     

       302
       302
       +
                   raise ValueError("Message must specify schema")

     

       303
       303
       +
               return v

     

       304
       304
       +
               

     

       305
       305
       +
           @field_validator("errors")

     

       306
       306
       +
           def validate_errors(cls, v: list[dict[str, str]] | None) -> list[dict[str, str]] | None:

     

       307
       307
       +
               """

     

       308
       308
       +
               Validate error definitions.

     

       309
       309
       +
               

     

       310
       310
       +
               Args:

     

       311
       311
       +
                   v: Error definitions to validate

     

       312
       312
       +
                   

     

       313
       313
       +
               Returns:

     

       314
       314
       +
                   Validated error definitions

     

       315
       315
       +
                   

     

       316
       316
       +
               Raises:

     

       317
       317
       +
                   ValueError: If any error definition is invalid

     

       318
       318
       +
               """

     

       319
       319
       +
               if v:

     

       320
       320
       +
                   for error in v:

     

       321
       321
       +
                       if "name" not in error:

     

       322
       322
       +
                           raise ValueError("Error must have a name")

     

       323
       323
       +
               return v

+249

src/atpasser/model/types/string.py

···

       1
       1
       +
       from typing import Any

     

       2
       2
       +
       import re

     

       3
       3
       +
       from datetime import datetime

     

       4
       4
       +
       from pydantic import field_validator

     

       5
       5
       +
       from ..base import DataModel

     

       6
       6
       +
       

     

       7
       7
       +
       class StringModel(DataModel):

     

       8
       8
       +
           """

     

       9
       9
       +
           Model for AT Protocol string type.

     

       10
       10
       +
           

     

       11
       11
       +
           Represents a Unicode string with support for format restrictions, length limits,

     

       12
       12
       +
           known values, enumeration sets, default values and constants as specified in Lexicon.

     

       13
       13
       +
           """

     

       14
       14
       +
           

     

       15
       15
       +
           value: str

     

       16
       16
       +
           """String value"""

     

       17
       17
       +
           

     

       18
       18
       +
           format: str | None = None

     

       19
       19
       +
           """String format restriction (e.g. 'datetime', 'uri')"""

     

       20
       20
       +
           

     

       21
       21
       +
           maxLength: int | None = None

     

       22
       22
       +
           """Maximum length in UTF-8 bytes"""

     

       23
       23
       +
           

     

       24
       24
       +
           minLength: int | None = None

     

       25
       25
       +
           """Minimum length in UTF-8 bytes"""

     

       26
       26
       +
           

     

       27
       27
       +
           knownValues: list[str] | None = None

     

       28
       28
       +
           """Suggested/common values (not enforced)"""

     

       29
       29
       +
           

     

       30
       30
       +
           enum: list[str] | None = None

     

       31
       31
       +
           """Closed set of allowed values"""

     

       32
       32
       +
           

     

       33
       33
       +
           default: str | None = None

     

       34
       34
       +
           """Default value if not provided"""

     

       35
       35
       +
           

     

       36
       36
       +
           const: str | None = None

     

       37
       37
       +
           """Fixed constant value if specified"""

     

       38
       38
       +
           

     

       39
       39
       +
           def __init__(self, **data: Any) -> None:

     

       40
       40
       +
               """

     

       41
       41
       +
               Initialize string model with validation.

     

       42
       42
       +
               

     

       43
       43
       +
               Args:

     

       44
       44
       +
                   **data: Input data containing string value

     

       45
       45
       +
                   

     

       46
       46
       +
               Raises:

     

       47
       47
       +
                   ValueError: If value violates constraints

     

       48
       48
       +
               """

     

       49
       49
       +
               super().__init__(**data)

     

       50
       50
       +
               if self.const is not None and self.value != self.const:

     

       51
       51
       +
                   raise ValueError(f"String value must be {self.const}")

     

       52
       52
       +
           

     

       53
       53
       +
           @field_validator("value", mode="before")

     

       54
       54
       +
           def validate_string(cls, v: Any) -> str:

     

       55
       55
       +
               """

     

       56
       56
       +
               Validate and convert input to string.

     

       57
       57
       +
               

     

       58
       58
       +
               Args:

     

       59
       59
       +
                   v: Value to validate

     

       60
       60
       +
                   

     

       61
       61
       +
               Returns:

     

       62
       62
       +
                   Validated string value

     

       63
       63
       +
                   

     

       64
       64
       +
               Raises:

     

       65
       65
       +
                   ValueError: If value violates constraints

     

       66
       66
       +
               """

     

       67
       67
       +
               if not isinstance(v, str):

     

       68
       68
       +
                   v = str(v)

     

       69
       69
       +
                   

     

       70
       70
       +
               # Validate length constraints

     

       71
       71
       +
               if cls.minLength is not None and len(v.encode()) < cls.minLength:

     

       72
       72
       +
                   raise ValueError(f"String must be at least {cls.minLength} bytes")

     

       73
       73
       +
                   

     

       74
       74
       +
               if cls.maxLength is not None and len(v.encode()) > cls.maxLength:

     

       75
       75
       +
                   raise ValueError(f"String must be at most {cls.maxLength} bytes")

     

       76
       76
       +
                   

     

       77
       77
       +
               # Validate enum

     

       78
       78
       +
               if cls.enum and v not in cls.enum:

     

       79
       79
       +
                   raise ValueError(f"Value must be one of {cls.enum}")

     

       80
       80
       +
                   

     

       81
       81
       +
               # Validate format if specified

     

       82
       82
       +
               if cls.format:

     

       83
       83
       +
                   if cls.format == "datetime":

     

       84
       84
       +
                       cls._validate_datetime(v)

     

       85
       85
       +
                   elif cls.format == "uri":

     

       86
       86
       +
                       cls._validate_uri(v)

     

       87
       87
       +
                   elif cls.format == "did":

     

       88
       88
       +
                       cls._validate_did(v)

     

       89
       89
       +
                   elif cls.format == "handle":

     

       90
       90
       +
                       cls._validate_handle(v)

     

       91
       91
       +
                   elif cls.format == "at-identifier":

     

       92
       92
       +
                       cls._validate_at_identifier(v)

     

       93
       93
       +
                   elif cls.format == "at-uri":

     

       94
       94
       +
                       cls._validate_at_uri(v)

     

       95
       95
       +
                   elif cls.format == "cid":

     

       96
       96
       +
                       cls._validate_cid(v)

     

       97
       97
       +
                   elif cls.format == "nsid":

     

       98
       98
       +
                       cls._validate_nsid(v)

     

       99
       99
       +
                   elif cls.format == "tid":

     

       100
       100
       +
                       cls._validate_tid(v)

     

       101
       101
       +
                   elif cls.format == "record-key":

     

       102
       102
       +
                       cls._validate_record_key(v)

     

       103
       103
       +
                   elif cls.format == "language":

     

       104
       104
       +
                       cls._validate_language(v)

     

       105
       105
       +
                   

     

       106
       106
       +
               return v

     

       107
       107
       +
           

     

       108
       108
       +
           @classmethod

     

       109
       109
       +
           def _validate_datetime(cls, v: str) -> None:

     

       110
       110
       +
               """Validate RFC 3339 datetime format"""

     

       111
       111
       +
               try:

     

       112
       112
       +
                   datetime.fromisoformat(v.replace("Z", "+00:00"))

     

       113
       113
       +
               except ValueError:

     

       114
       114
       +
                   raise ValueError("Invalid datetime format, must be RFC 3339")

     

       115
       115
       +
           

     

       116
       116
       +
           @classmethod

     

       117
       117
       +
           def _validate_uri(cls, v: str) -> None:

     

       118
       118
       +
               """Validate URI format"""

     

       119
       119
       +
               if len(v) > 8192:  # 8KB max

     

       120
       120
       +
                   raise ValueError("URI too long, max 8KB")

     

       121
       121
       +
               if not re.match(r"^[a-zA-Z][a-zA-Z0-9+.-]*:.+", v):

     

       122
       122
       +
                   raise ValueError("Invalid URI format")

     

       123
       123
       +
           

     

       124
       124
       +
           @classmethod

     

       125
       125
       +
           def _validate_did(cls, v: str) -> None:

     

       126
       126
       +
               """Validate DID format"""

     

       127
       127
       +
               if len(v) > 2048:

     

       128
       128
       +
                   raise ValueError("DID too long, max 2048 chars")

     

       129
       129
       +
               if not re.match(r"^did:[a-z]+:[a-zA-Z0-9._:%-]*[a-zA-Z0-9._-]$", v):

     

       130
       130
       +
                   raise ValueError("Invalid URI format")

     

       131
       131
       +
           

     

       132
       132
       +
           @classmethod

     

       133
       133
       +
           def _validate_handle(cls, v: str) -> None:

     

       134
       134
       +
               """Validate handle format"""

     

       135
       135
       +
               if not re.match(r"^([a-zA-Z0-9]([a-zA-Z0-9-]{0,61}[a-zA-Z0-9])?\.)+[a-zA-Z]([a-zA-Z0-9-]{0,61}[a-zA-Z0-9])?$", v):

     

       136
       136
       +
                   raise ValueError("Handle contains invalid characters")

     

       137
       137
       +
               if len(v) > 253:

     

       138
       138
       +
                   raise ValueError("Handle too long, max 253 chars")

     

       139
       139
       +
       

     

       140
       140
       +
           @classmethod

     

       141
       141
       +
           def _validate_at_identifier(cls, v: str) -> None:

     

       142
       142
       +
               """Validate at-identifier format (DID or handle)"""

     

       143
       143
       +
               try:

     

       144
       144
       +
                   if v.startswith("did:"):

     

       145
       145
       +
                       cls._validate_did(v)

     

       146
       146
       +
                   else:

     

       147
       147
       +
                       cls._validate_handle(v)

     

       148
       148
       +
               except ValueError as e:

     

       149
       149
       +
                   raise ValueError(f"Invalid at-identifier: {e}")

     

       150
       150
       +
       

     

       151
       151
       +
           @classmethod

     

       152
       152
       +
           def _validate_at_uri(cls, v: str) -> None:

     

       153
       153
       +
               """

     

       154
       154
       +
               Validate AT-URI format according to AT Protocol specification.

     

       155
       155
       +
               

     

       156
       156
       +
               Args:

     

       157
       157
       +
                   v: AT-URI string to validate

     

       158
       158
       +
                   

     

       159
       159
       +
               Raises:

     

       160
       160
       +
                   ValueError: If URI violates any of these rules:

     

       161
       161
       +
                       - Must start with 'at://'

     

       162
       162
       +
                       - Max length 8KB

     

       163
       163
       +
                       - No trailing slash

     

       164
       164
       +
                       - Authority must be valid DID or handle

     

       165
       165
       +
                       - Path segments must follow NSID/RKEY rules if present

     

       166
       166
       +
               """

     

       167
       167
       +
               if not v.startswith("at://"):

     

       168
       168
       +
                   raise ValueError("AT-URI must start with 'at://'")

     

       169
       169
       +
               if len(v) > 8192:  # 8KB

     

       170
       170
       +
                   raise ValueError("AT-URI too long, max 8KB")

     

       171
       171
       +
               if v.endswith('/'):

     

       172
       172
       +
                   raise ValueError("AT-URI cannot have trailing slash")

     

       173
       173
       +
                   

     

       174
       174
       +
               # Split into parts

     

       175
       175
       +
               parts = v[5:].split('/')  # Skip 'at://'

     

       176
       176
       +
               authority = parts[0]

     

       177
       177
       +
               

     

       178
       178
       +
               # Validate authority (DID or handle)

     

       179
       179
       +
               if not authority:

     

       180
       180
       +
                   raise ValueError("AT-URI must have authority")

     

       181
       181
       +
                   

     

       182
       182
       +
               if authority.startswith('did:'):

     

       183
       183
       +
                   # Basic DID format check - actual DID validation is done elsewhere

     

       184
       184
       +
                   if len(authority) > 2048:

     

       185
       185
       +
                       raise ValueError("DID too long")

     

       186
       186
       +
                   if ':' not in authority[4:]:

     

       187
       187
       +
                       raise ValueError("Invalid DID format")

     

       188
       188
       +
               else:

     

       189
       189
       +
                   # Handle validation

     

       190
       190
       +
                   if not re.match(r'^[a-z0-9.-]+$', authority):

     

       191
       191
       +
                       raise ValueError("Invalid handle characters")

     

       192
       192
       +
                   if len(authority) > 253:

     

       193
       193
       +
                       raise ValueError("Handle too long")

     

       194
       194
       +
                       

     

       195
       195
       +
               # Validate path segments if present

     

       196
       196
       +
               if len(parts) > 1:

     

       197
       197
       +
                   if len(parts) > 3:

     

       198
       198
       +
                       raise ValueError("AT-URI path too deep")

     

       199
       199
       +
                       

     

       200
       200
       +
                   collection = parts[1]

     

       201
       201
       +
                   if not re.match(r'^[a-zA-Z0-9.-]+$', collection):

     

       202
       202
       +
                       raise ValueError("Invalid collection NSID")

     

       203
       203
       +
                       

     

       204
       204
       +
                   if len(parts) > 2:

     

       205
       205
       +
                       rkey = parts[2]

     

       206
       206
       +
                       if not rkey:

     

       207
       207
       +
                           raise ValueError("Record key cannot be empty")

     

       208
       208
       +
                       if not re.match(r'^[a-zA-Z0-9._:%-~]+$', rkey):

     

       209
       209
       +
                           raise ValueError("Invalid record key characters")

     

       210
       210
       +
       

     

       211
       211
       +
           @classmethod

     

       212
       212
       +
           def _validate_cid(cls, v: str) -> None:

     

       213
       213
       +
               """Validate CID string format"""

     

       214
       214
       +
               if len(v) > 100:

     

       215
       215
       +
                   raise ValueError("CID too long, max 100 chars")

     

       216
       216
       +
               if not re.match(r"^[a-zA-Z0-9]+$", v):

     

       217
       217
       +
                   raise ValueError("CID contains invalid characters")

     

       218
       218
       +
       

     

       219
       219
       +
           @classmethod

     

       220
       220
       +
           def _validate_nsid(cls, v: str) -> None:

     

       221
       221
       +
               """Validate NSID format"""

     

       222
       222
       +
               if len(v) > 317:

     

       223
       223
       +
                   raise ValueError("NSID too long, max 317 chars")

     

       224
       224
       +
               if not re.match(r"^[a-zA-Z]([a-zA-Z0-9-]{0,61}[a-zA-Z0-9])?(\.[a-zA-Z0-9]([a-zA-Z0-9-]{0,61}[a-zA-Z0-9])?)+(\.[a-zA-Z]([a-zA-Z0-9]{0,62})?)$", v):

     

       225
       225
       +
                   raise ValueError("NSID contains invalid characters")

     

       226
       226
       +
       

     

       227
       227
       +
           @classmethod

     

       228
       228
       +
           def _validate_tid(cls, v: str) -> None:

     

       229
       229
       +
               """Validate TID format"""

     

       230
       230
       +
               if len(v) > 13:

     

       231
       231
       +
                   raise ValueError("TID too long, max 13 chars")

     

       232
       232
       +
               if not re.match(r"^[234567abcdefghij][234567abcdefghijklmnopqrstuvwxyz]{12}$", v):

     

       233
       233
       +
                   raise ValueError("TID contains invalid characters")

     

       234
       234
       +
       

     

       235
       235
       +
           @classmethod

     

       236
       236
       +
           def _validate_record_key(cls, v: str) -> None:

     

       237
       237
       +
               """Validate record-key format"""

     

       238
       238
       +
               if len(v) > 512:

     

       239
       239
       +
                   raise ValueError("Record key too long, max 512 chars")

     

       240
       240
       +
               if v == "." or v == "..":

     

       241
       241
       +
                   raise ValueError(f"Record key is {v}, which is not allowed")

     

       242
       242
       +
               if not re.match(r"^[a-zA-Z0-9._:%-~]+$", v):

     

       243
       243
       +
                   raise ValueError("Record key contains invalid characters")

     

       244
       244
       +
       

     

       245
       245
       +
           @classmethod

     

       246
       246
       +
           def _validate_language(cls, v: str) -> None:

     

       247
       247
       +
               """Validate BCP 47 language tag"""

     

       248
       248
       +
               if not re.match(r"^[a-zA-Z]{1,8}(-[a-zA-Z0-9]{1,8})*$", v):

     

       249
       249
       +
                   raise ValueError("Invalid language tag format")

Compare changes