commit e343e796480eb536c6b1aeaa4b7d586f67787a9c · dwn.poxiao-labs.work/atpasser

+103 -4

src/atpasser/uri/__init__.py

···

       1
       1
        
       import urllib.parse as up

     

       2
       2
       -
       from . import handle, did

     

       2
       2
       +
       from .identifier import Handle, DID

     

       3
       3
        
       import jsonpath_ng

     

       4
       4
       -
       from .exceptions import InvalidURIError, ValidationError, URIError

     

       4
       4
       +
       from .exceptions import (

     

       5
       5
       +
           InvalidURIError,

     

       6
       6
       +
           ValidationError,

     

       7
       7
       +
           URIError,

     

       8
       8
       +
           InvalidRestrictedURIError,

     

       9
       9
       +
       )

     

       5
       10
        
       

     

       6
       11
        
       

     

       7
       12
        
       class URI:

     
···

       159
       164
        
       

     

       160
       165
        
               self.authorityAsText = authorityValue

     

       161
       166
        
               try:

     

       162
       162
       -
                   authority = handle.Handle(authorityValue)

     

       167
       167
       +
                   authority = Handle(authorityValue)

     

       163
       168
        
               except Exception as e:

     

       164
       169
        
                   try:

     

       165
       165
       -
                       authority = did.DID(authorityValue)

     

       170
       170
       +
                       authority = DID(authorityValue)

     

       166
       171
        
                   except Exception as e2:

     

       167
       172
        
                       # Don't throw exception, just set authority to None

     

       168
       173
        
                       authority = None

     
···

       207
       212
        
               else:

     

       208
       213
        
       

     

       209
       214
        
                   return False

     

       215
       215
       +
       

     

       216
       216
       +
       

     

       217
       217
       +
       from .identifier import Handle

     

       218
       218
       +
       from . import nsid

     

       219
       219
       +
       from . import rkey as rKey

     

       220
       220
       +
       from . import URI

     

       221
       221
       +
       

     

       222
       222
       +
       

     

       223
       223
       +
       class RestrictedURI(URI):

     

       224
       224
       +
           """A class representing a restricted AT Protocol URI for record access.

     

       225
       225
       +
       

     

       226
       226
       +
           RestrictedURIs provide a specialized form of AT Protocol URIs that specifically

     

       227
       227
       +
           address records within repositories. They follow the format 'at://authority/collection/rkey'

     

       228
       228
       +
           where collection identifies the record type (via NSID) and rkey identifies the specific

     

       229
       229
       +
           record instance. This format is commonly used for referencing specific social records

     

       230
       230
       +
           like posts, profiles, and other user-generated content.

     

       231
       231
       +
       

     

       232
       232
       +
           Attributes:

     

       233
       233
       +
               collection (atpasser.uri.NSID): The record collection identified by NSID.

     

       234
       234
       +
               rkey (atpasser.uri.RKey): The record key identifying a specific record instance.

     

       235
       235
       +
           """

     

       236
       236
       +
       

     

       237
       237
       +
           def __init__(self, uri: str) -> None:

     

       238
       238
       +
               """Initializes a restricted URI with validation.

     

       239
       239
       +
       

     

       240
       240
       +
               Parses and validates an AT Protocol URI specifically for record access.

     

       241
       241
       +
               Restricted URIs must have a valid authority (DID or handle), may include

     

       242
       242
       +
               a collection (NSID), and optionally a record key (rkey). Query parameters

     

       243
       243
       +
               and fragments are not allowed in restricted URIs.

     

       244
       244
       +
       

     

       245
       245
       +
               Args:

     

       246
       246
       +
                   uri (str): The AT Protocol URI string to parse as a restricted URI.

     

       247
       247
       +
       

     

       248
       248
       +
               Raises:

     

       249
       249
       +
                   InvalidRestrictedURIError: If the URI has query parameters or fragments, invalid authority,

     

       250
       250
       +
                                           or too many path segments for a restricted URI format.

     

       251
       251
       +
                   InvalidURIError: If the underlying URI validation fails.

     

       252
       252
       +
               """

     

       253
       253
       +
       

     

       254
       254
       +
               try:

     

       255
       255
       +
                   super().__init__(uri)

     

       256
       256
       +
               except InvalidURIError:

     

       257
       257
       +
                   raise

     

       258
       258
       +
               except Exception as e:

     

       259
       259
       +
                   raise InvalidURIError(

     

       260
       260
       +
                       uri, "base URI validation failed", f"Failed to parse base URI: {str(e)}"

     

       261
       261
       +
                   )

     

       262
       262
       +
       

     

       263
       263
       +
               if self.query is not None:

     

       264
       264
       +
                   raise InvalidRestrictedURIError(

     

       265
       265
       +
                       uri,

     

       266
       266
       +
                       "query parameters not supported",

     

       267
       267
       +
                       "Restricted URI cannot contain query parameters",

     

       268
       268
       +
                   )

     

       269
       269
       +
       

     

       270
       270
       +
               if self.fragment is not None:

     

       271
       271
       +
                   raise InvalidRestrictedURIError(

     

       272
       272
       +
                       uri,

     

       273
       273
       +
                       "fragments not supported",

     

       274
       274
       +
                       "Restricted URI cannot contain fragments",

     

       275
       275
       +
                   )

     

       276
       276
       +
       

     

       277
       277
       +
               if self.authority is None:

     

       278
       278
       +
                   raise InvalidRestrictedURIError(

     

       279
       279
       +
                       uri,

     

       280
       280
       +
                       "invalid authority",

     

       281
       281
       +
                       "Restricted URI must contain a valid DID or Handle",

     

       282
       282
       +
                   )

     

       283
       283
       +
       

     

       284
       284
       +
               try:

     

       285
       285
       +
                   if len(self.path) == 0:

     

       286
       286
       +
                       self.collection, self.rkey = None, None

     

       287
       287
       +
       

     

       288
       288
       +
                   elif len(self.path) == 1:

     

       289
       289
       +
                       self.collection = nsid.NSID(self.path[0])

     

       290
       290
       +
                       self.rkey = None

     

       291
       291
       +
       

     

       292
       292
       +
                   elif len(self.path) == 2:

     

       293
       293
       +
                       self.collection = nsid.NSID(self.path[0])

     

       294
       294
       +
                       self.rkey = rKey.RKey(self.path[1])

     

       295
       295
       +
                   else:

     

       296
       296
       +
                       raise InvalidRestrictedURIError(

     

       297
       297
       +
                           uri,

     

       298
       298
       +
                           "too many path segments",

     

       299
       299
       +
                           f"Restricted URI can have at most 2 path segments, currently has {len(self.path)}",

     

       300
       300
       +
                       )

     

       301
       301
       +
               except Exception as e:

     

       302
       302
       +
                   if isinstance(e, (InvalidRestrictedURIError, InvalidURIError)):

     

       303
       303
       +
                       raise

     

       304
       304
       +
                   raise InvalidRestrictedURIError(

     

       305
       305
       +
                       uri,

     

       306
       306
       +
                       "parsing error",

     

       307
       307
       +
                       f"Error occurred while parsing Restricted URI: {str(e)}",

     

       308
       308
       +
                   )

-112

src/atpasser/uri/did.py

···

       1
       1
       -
       import re

     

       2
       2
       -
       from pyld import jsonld

     

       3
       3
       -
       from .exceptions import InvalidDIDError, ResolutionError

     

       4
       4
       -
       

     

       5
       5
       -
       

     

       6
       6
       -
       class DID:

     

       7
       7
       -
           """A class representing a DID (Decentralized Identifier) in the AT Protocol.

     

       8
       8
       -
       

     

       9
       9
       -
           Decentralized Identifiers (DIDs) are a key component of the AT Protocol's identity system.

     

       10
       10
       -
           They provide cryptographically verifiable, persistent identifiers for users and services

     

       11
       11
       -
           in the decentralized network. DIDs follow the format 'did:method:specific-identifier'

     

       12
       12
       -
           where method defines the resolution mechanism (e.g., 'plc' for PLC directory, 'web' for web-based).

     

       13
       13
       -
       

     

       14
       14
       -
           Attributes:

     

       15
       15
       -
               uri (str): The complete DID URI string.

     

       16
       16
       -
           """

     

       17
       17
       -
       

     

       18
       18
       -
           def __init__(self, uri: str) -> None:

     

       19
       19
       -
               """Initializes a DID object with validation.

     

       20
       20
       -
       

     

       21
       21
       -
               Parses and validates a DID URI string according to the W3C DID specification

     

       22
       22
       -
               and AT Protocol requirements. The DID must follow the format 'did:method:identifier'

     

       23
       23
       -
               and contain only valid characters.

     

       24
       24
       -
       

     

       25
       25
       -
               Args:

     

       26
       26
       -
                   uri (str): The DID URI string to validate.

     

       27
       27
       -
       

     

       28
       28
       -
               Raises:

     

       29
       29
       -
                   InvalidDIDError: If the URI doesn't match the DID format or exceeds maximum length.

     

       30
       30
       -
               """

     

       31
       31
       -
               pattern = re.compile("^did:[a-z]+:[a-zA-Z0-9._:%-]*[a-zA-Z0-9._-]$")

     

       32
       32
       -
               patternMatch = pattern.match(uri)

     

       33
       33
       -
       

     

       34
       34
       -
               if not patternMatch:

     

       35
       35
       -
                   raise InvalidDIDError(

     

       36
       36
       -
                       uri, "invalid format", "DID must follow 'did:method:identifier' format"

     

       37
       37
       -
                   )

     

       38
       38
       -
       

     

       39
       39
       -
               if len(uri) > 2048:

     

       40
       40
       -
                   raise InvalidDIDError(

     

       41
       41
       -
                       uri,

     

       42
       42
       -
                       "exceeds maximum length",

     

       43
       43
       -
                       f"DID length {len(uri)} exceeds maximum allowed length of 2048 characters",

     

       44
       44
       -
                   )

     

       45
       45
       -
       

     

       46
       46
       -
               self.uri = patternMatch[0]

     

       47
       47
       -
       

     

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

     

       49
       49
       -
               """Convert the DID object to its string representation.

     

       50
       50
       -
       

     

       51
       51
       -
               Returns:

     

       52
       52
       -
                   str: The canonical DID URI string.

     

       53
       53
       -
               """

     

       54
       54
       -
               return self.uri

     

       55
       55
       -
       

     

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

     

       57
       57
       -
               """Check if two DID objects represent the same identifier.

     

       58
       58
       -
       

     

       59
       59
       -
               Args:

     

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

     

       61
       61
       -
       

     

       62
       62
       -
               Returns:

     

       63
       63
       -
                   bool: True if the objects represent the same DID, False otherwise.

     

       64
       64
       -
               """

     

       65
       65
       -
               if isinstance(value, DID):

     

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

     

       67
       67
       -
               else:

     

       68
       68
       -
                   return False

     

       69
       69
       -
       

     

       70
       70
       -
           def fetch(self):

     

       71
       71
       -
               """Fetch the DID document metadata from the appropriate resolver.

     

       72
       72
       -
       

     

       73
       73
       -
               Resolves the DID to its associated DID document by querying the appropriate

     

       74
       74
       -
               resolver based on the DID method. Currently supports 'did:plc:' (resolved via

     

       75
       75
       -
               PLC directory) and 'did:web:' (resolved via well-known HTTP endpoint).

     

       76
       76
       -
       

     

       77
       77
       -
               Returns:

     

       78
       78
       -
                   list: The expanded JSON-LD document representing the DID document,

     

       79
       79
       -
                         compatible with the PyLD library for further processing.

     

       80
       80
       -
       

     

       81
       81
       -
               Raises:

     

       82
       82
       -
                   ResolutionError: If the DID document cannot be fetched or parsed.

     

       83
       83
       -
                   InvalidDIDError: If the DID method is not supported.

     

       84
       84
       -
       

     

       85
       85
       -
               Note:

     

       86
       86
       -
                   - For 'did:plc:' DIDs, queries https://plc.directory/{did}

     

       87
       87
       -
                   - For 'did:web:' DIDs, queries https://{domain}/.well-known/did.json

     

       88
       88
       -
               """

     

       89
       89
       -
               try:

     

       90
       90
       -
                   if self.uri.startswith("did:plc:"):

     

       91
       91
       -
                       return jsonld.expand(f"https://plc.directory/{self.uri}")

     

       92
       92
       -
                   elif self.uri.startswith("did:web:"):

     

       93
       93
       -
                       domain = self.uri.replace("did:web:", "")

     

       94
       94
       -
                       if not domain:

     

       95
       95
       -
                           raise InvalidDIDError(

     

       96
       96
       -
                               self.uri, "invalid format", "did:web DID must contain a domain"

     

       97
       97
       -
                           )

     

       98
       98
       -
                       return jsonld.expand(f"https://{domain}/.well-known/did.json")

     

       99
       99
       -
                   else:

     

       100
       100
       -
                       raise InvalidDIDError(

     

       101
       101
       -
                           self.uri,

     

       102
       102
       -
                           "unsupported DID method",

     

       103
       103
       -
                           f"Unsupported DID method: {self.uri.split(':')[1]}",

     

       104
       104
       -
                       )

     

       105
       105
       -
               except Exception as e:

     

       106
       106
       -
                   if isinstance(e, (InvalidDIDError, ResolutionError)):

     

       107
       107
       -
                       raise

     

       108
       108
       -
                   raise ResolutionError(

     

       109
       109
       -
                       self.uri,

     

       110
       110
       -
                       "fetch DID document",

     

       111
       111
       -
                       f"Failed to fetch or parse DID document: {str(e)}",

     

       112
       112
       -
                   )

+116 -2

src/atpasser/uri/handle.py src/atpasser/uri/identifier.py

···

       1
       1
       +
       import re

     

       2
       2
       +
       from pyld import jsonld

     

       1
       3
        
       import dns.resolver, requests

     

       4
       4
       +
       from .exceptions import (

     

       5
       5
       +
           InvalidDIDError,

     

       6
       6
       +
           InvalidHandleError,

     

       7
       7
       +
           ResolutionError,

     

       8
       8
       +
           InvalidDIDError,

     

       9
       9
       +
       )

     

       2
       10
        
       

     

       3
       3
       -
       from .did import DID

     

       4
       4
       -
       from .exceptions import InvalidHandleError, ResolutionError, InvalidDIDError

     

       11
       11
       +
       

     

       12
       12
       +
       class DID:

     

       13
       13
       +
           """A class representing a DID (Decentralized Identifier) in the AT Protocol.

     

       14
       14
       +
       

     

       15
       15
       +
           Decentralized Identifiers (DIDs) are a key component of the AT Protocol's identity system.

     

       16
       16
       +
           They provide cryptographically verifiable, persistent identifiers for users and services

     

       17
       17
       +
           in the decentralized network. DIDs follow the format 'did:method:specific-identifier'

     

       18
       18
       +
           where method defines the resolution mechanism (e.g., 'plc' for PLC directory, 'web' for web-based).

     

       19
       19
       +
       

     

       20
       20
       +
           Attributes:

     

       21
       21
       +
               uri (str): The complete DID URI string.

     

       22
       22
       +
           """

     

       23
       23
       +
       

     

       24
       24
       +
           def __init__(self, uri: str) -> None:

     

       25
       25
       +
               """Initializes a DID object with validation.

     

       26
       26
       +
       

     

       27
       27
       +
               Parses and validates a DID URI string according to the W3C DID specification

     

       28
       28
       +
               and AT Protocol requirements. The DID must follow the format 'did:method:identifier'

     

       29
       29
       +
               and contain only valid characters.

     

       30
       30
       +
       

     

       31
       31
       +
               Args:

     

       32
       32
       +
                   uri (str): The DID URI string to validate.

     

       33
       33
       +
       

     

       34
       34
       +
               Raises:

     

       35
       35
       +
                   InvalidDIDError: If the URI doesn't match the DID format or exceeds maximum length.

     

       36
       36
       +
               """

     

       37
       37
       +
               pattern = re.compile("^did:[a-z]+:[a-zA-Z0-9._:%-]*[a-zA-Z0-9._-]$")

     

       38
       38
       +
               patternMatch = pattern.match(uri)

     

       39
       39
       +
       

     

       40
       40
       +
               if not patternMatch:

     

       41
       41
       +
                   raise InvalidDIDError(

     

       42
       42
       +
                       uri, "invalid format", "DID must follow 'did:method:identifier' format"

     

       43
       43
       +
                   )

     

       44
       44
       +
       

     

       45
       45
       +
               if len(uri) > 2048:

     

       46
       46
       +
                   raise InvalidDIDError(

     

       47
       47
       +
                       uri,

     

       48
       48
       +
                       "exceeds maximum length",

     

       49
       49
       +
                       f"DID length {len(uri)} exceeds maximum allowed length of 2048 characters",

     

       50
       50
       +
                   )

     

       51
       51
       +
       

     

       52
       52
       +
               self.uri = patternMatch[0]

     

       53
       53
       +
       

     

       54
       54
       +
           def __str__(self) -> str:

     

       55
       55
       +
               """Convert the DID object to its string representation.

     

       56
       56
       +
       

     

       57
       57
       +
               Returns:

     

       58
       58
       +
                   str: The canonical DID URI string.

     

       59
       59
       +
               """

     

       60
       60
       +
               return self.uri

     

       61
       61
       +
       

     

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

     

       63
       63
       +
               """Check if two DID objects represent the same identifier.

     

       64
       64
       +
       

     

       65
       65
       +
               Args:

     

       66
       66
       +
                   value (object): The object to compare with.

     

       67
       67
       +
       

     

       68
       68
       +
               Returns:

     

       69
       69
       +
                   bool: True if the objects represent the same DID, False otherwise.

     

       70
       70
       +
               """

     

       71
       71
       +
               if isinstance(value, DID):

     

       72
       72
       +
                   return str(self) == str(value)

     

       73
       73
       +
               else:

     

       74
       74
       +
                   return False

     

       75
       75
       +
       

     

       76
       76
       +
           def fetch(self):

     

       77
       77
       +
               """Fetch the DID document metadata from the appropriate resolver.

     

       78
       78
       +
       

     

       79
       79
       +
               Resolves the DID to its associated DID document by querying the appropriate

     

       80
       80
       +
               resolver based on the DID method. Currently supports 'did:plc:' (resolved via

     

       81
       81
       +
               PLC directory) and 'did:web:' (resolved via well-known HTTP endpoint).

     

       82
       82
       +
       

     

       83
       83
       +
               Returns:

     

       84
       84
       +
                   list: The expanded JSON-LD document representing the DID document,

     

       85
       85
       +
                         compatible with the PyLD library for further processing.

     

       86
       86
       +
       

     

       87
       87
       +
               Raises:

     

       88
       88
       +
                   ResolutionError: If the DID document cannot be fetched or parsed.

     

       89
       89
       +
                   InvalidDIDError: If the DID method is not supported.

     

       90
       90
       +
       

     

       91
       91
       +
               Note:

     

       92
       92
       +
                   - For 'did:plc:' DIDs, queries https://plc.directory/{did}

     

       93
       93
       +
                   - For 'did:web:' DIDs, queries https://{domain}/.well-known/did.json

     

       94
       94
       +
               """

     

       95
       95
       +
               try:

     

       96
       96
       +
                   if self.uri.startswith("did:plc:"):

     

       97
       97
       +
                       return jsonld.expand(f"https://plc.directory/{self.uri}")

     

       98
       98
       +
                   elif self.uri.startswith("did:web:"):

     

       99
       99
       +
                       domain = self.uri.replace("did:web:", "")

     

       100
       100
       +
                       if not domain:

     

       101
       101
       +
                           raise InvalidDIDError(

     

       102
       102
       +
                               self.uri, "invalid format", "did:web DID must contain a domain"

     

       103
       103
       +
                           )

     

       104
       104
       +
                       return jsonld.expand(f"https://{domain}/.well-known/did.json")

     

       105
       105
       +
                   else:

     

       106
       106
       +
                       raise InvalidDIDError(

     

       107
       107
       +
                           self.uri,

     

       108
       108
       +
                           "unsupported DID method",

     

       109
       109
       +
                           f"Unsupported DID method: {self.uri.split(':')[1]}",

     

       110
       110
       +
                       )

     

       111
       111
       +
               except Exception as e:

     

       112
       112
       +
                   if isinstance(e, (InvalidDIDError, ResolutionError)):

     

       113
       113
       +
                       raise

     

       114
       114
       +
                   raise ResolutionError(

     

       115
       115
       +
                       self.uri,

     

       116
       116
       +
                       "fetch DID document",

     

       117
       117
       +
                       f"Failed to fetch or parse DID document: {str(e)}",

     

       118
       118
       +
                   )

     

       5
       119
        
       

     

       6
       120
        
       

     

       7
       121
        
       class Handle:

-92

src/atpasser/uri/restricted.py

···

       1
       1
       -
       from . import handle, nsid

     

       2
       2
       -
       from . import rkey as rKey

     

       3
       3
       -
       from . import URI

     

       4
       4
       -
       from .exceptions import InvalidRestrictedURIError, InvalidURIError

     

       5
       5
       -
       

     

       6
       6
       -
       

     

       7
       7
       -
       class RestrictedURI(URI):

     

       8
       8
       -
           """A class representing a restricted AT Protocol URI for record access.

     

       9
       9
       -
       

     

       10
       10
       -
           RestrictedURIs provide a specialized form of AT Protocol URIs that specifically

     

       11
       11
       -
           address records within repositories. They follow the format 'at://authority/collection/rkey'

     

       12
       12
       -
           where collection identifies the record type (via NSID) and rkey identifies the specific

     

       13
       13
       -
           record instance. This format is commonly used for referencing specific social records

     

       14
       14
       -
           like posts, profiles, and other user-generated content.

     

       15
       15
       -
       

     

       16
       16
       -
           Attributes:

     

       17
       17
       -
               collection (atpasser.uri.NSID): The record collection identified by NSID.

     

       18
       18
       -
               rkey (atpasser.uri.RKey): The record key identifying a specific record instance.

     

       19
       19
       -
           """

     

       20
       20
       -
       

     

       21
       21
       -
           def __init__(self, uri: str) -> None:

     

       22
       22
       -
               """Initializes a restricted URI with validation.

     

       23
       23
       -
       

     

       24
       24
       -
               Parses and validates an AT Protocol URI specifically for record access.

     

       25
       25
       -
               Restricted URIs must have a valid authority (DID or handle), may include

     

       26
       26
       -
               a collection (NSID), and optionally a record key (rkey). Query parameters

     

       27
       27
       -
               and fragments are not allowed in restricted URIs.

     

       28
       28
       -
       

     

       29
       29
       -
               Args:

     

       30
       30
       -
                   uri (str): The AT Protocol URI string to parse as a restricted URI.

     

       31
       31
       -
       

     

       32
       32
       -
               Raises:

     

       33
       33
       -
                   InvalidRestrictedURIError: If the URI has query parameters or fragments, invalid authority,

     

       34
       34
       -
                                           or too many path segments for a restricted URI format.

     

       35
       35
       -
                   InvalidURIError: If the underlying URI validation fails.

     

       36
       36
       -
               """

     

       37
       37
       -
       

     

       38
       38
       -
               try:

     

       39
       39
       -
                   super().__init__(uri)

     

       40
       40
       -
               except InvalidURIError:

     

       41
       41
       -
                   raise

     

       42
       42
       -
               except Exception as e:

     

       43
       43
       -
                   raise InvalidURIError(

     

       44
       44
       -
                       uri, "base URI validation failed", f"Failed to parse base URI: {str(e)}"

     

       45
       45
       -
                   )

     

       46
       46
       -
       

     

       47
       47
       -
               if self.query is not None:

     

       48
       48
       -
                   raise InvalidRestrictedURIError(

     

       49
       49
       -
                       uri,

     

       50
       50
       -
                       "query parameters not supported",

     

       51
       51
       -
                       "Restricted URI cannot contain query parameters",

     

       52
       52
       -
                   )

     

       53
       53
       -
       

     

       54
       54
       -
               if self.fragment is not None:

     

       55
       55
       -
                   raise InvalidRestrictedURIError(

     

       56
       56
       -
                       uri,

     

       57
       57
       -
                       "fragments not supported",

     

       58
       58
       -
                       "Restricted URI cannot contain fragments",

     

       59
       59
       -
                   )

     

       60
       60
       -
       

     

       61
       61
       -
               if self.authority is None:

     

       62
       62
       -
                   raise InvalidRestrictedURIError(

     

       63
       63
       -
                       uri,

     

       64
       64
       -
                       "invalid authority",

     

       65
       65
       -
                       "Restricted URI must contain a valid DID or Handle",

     

       66
       66
       -
                   )

     

       67
       67
       -
       

     

       68
       68
       -
               try:

     

       69
       69
       -
                   if len(self.path) == 0:

     

       70
       70
       -
                       self.collection, self.rkey = None, None

     

       71
       71
       -
       

     

       72
       72
       -
                   elif len(self.path) == 1:

     

       73
       73
       -
                       self.collection = nsid.NSID(self.path[0])

     

       74
       74
       -
                       self.rkey = None

     

       75
       75
       -
       

     

       76
       76
       -
                   elif len(self.path) == 2:

     

       77
       77
       -
                       self.collection = nsid.NSID(self.path[0])

     

       78
       78
       -
                       self.rkey = rKey.RKey(self.path[1])

     

       79
       79
       -
                   else:

     

       80
       80
       -
                       raise InvalidRestrictedURIError(

     

       81
       81
       -
                           uri,

     

       82
       82
       -
                           "too many path segments",

     

       83
       83
       -
                           f"Restricted URI can have at most 2 path segments, currently has {len(self.path)}",

     

       84
       84
       -
                       )

     

       85
       85
       -
               except Exception as e:

     

       86
       86
       -
                   if isinstance(e, (InvalidRestrictedURIError, InvalidURIError)):

     

       87
       87
       -
                       raise

     

       88
       88
       -
                   raise InvalidRestrictedURIError(

     

       89
       89
       -
                       uri,

     

       90
       90
       -
                       "parsing error",

     

       91
       91
       -
                       f"Error occurred while parsing Restricted URI: {str(e)}",

     

       92
       92
       -
                   )

+157

src/atpasser/uri/rkey.py

···

       90
       90
        
                   return str(self) == str(value)

     

       91
       91
        
               else:

     

       92
       92
        
                   return False

     

       93
       93
       +
       

     

       94
       94
       +
       

     

       95
       95
       +
       import datetime, random

     

       96
       96
       +
       

     

       97
       97
       +
       

     

       98
       98
       +
       class TID(RKey):

     

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

     

       100
       100
       +
       

     

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

     

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

     

       103
       103
       +
           with a clock identifier to ensure uniqueness even when multiple records

     

       104
       104
       +
           are created in the same microsecond. TIDs are sortable and provide both

     

       105
       105
       +
           temporal ordering and uniqueness guarantees.

     

       106
       106
       +
       

     

       107
       107
       +
           Attributes:

     

       108
       108
       +
               timestamp (datetime.datetime): The timestamp component of the TID.

     

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

     

       110
       110
       +
               recordKey (str): The record key string identifying a specific record.

     

       111
       111
       +
           """

     

       112
       112
       +
       

     

       113
       113
       +
           def __init__(

     

       114
       114
       +
               self, time: datetime.datetime | None = None, clockIdentifier: int | None = None

     

       115
       115
       +
           ) -> None:

     

       116
       116
       +
               """Initializes a TID object with timestamp and clock identifier.

     

       117
       117
       +
       

     

       118
       118
       +
               Creates a new TID with the specified timestamp and clock identifier.

     

       119
       119
       +
               If no timestamp is provided, uses the current time. If no clock identifier

     

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

     

       121
       121
       +
       

     

       122
       122
       +
               Args:

     

       123
       123
       +
                   time (datetime.datetime, optional): The timestamp for the TID.

     

       124
       124
       +
                       Defaults to current time if not provided.

     

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

     

       126
       126
       +
                       disambiguation. Defaults to random value if not provided.

     

       127
       127
       +
               """

     

       128
       128
       +
               if time == None:

     

       129
       129
       +
                   self.timestamp = datetime.datetime.now()

     

       130
       130
       +
               else:

     

       131
       131
       +
                   self.timestamp = time

     

       132
       132
       +
               if clockIdentifier == None:

     

       133
       133
       +
                   self.clockIdentifier = random.randrange(0, 1024)

     

       134
       134
       +
               else:

     

       135
       135
       +
                   self.clockIdentifier = clockIdentifier

     

       136
       136
       +
       

     

       137
       137
       +
               # Generate TID string representation, then call parent class constructor

     

       138
       138
       +
               tid_string = self._generate_tid_string()

     

       139
       139
       +
               super().__init__(tid_string)

     

       140
       140
       +
       

     

       141
       141
       +
           def _generate_tid_string(self) -> str:

     

       142
       142
       +
               """Generate TID string representation.

     

       143
       143
       +
       

     

       144
       144
       +
               Returns:

     

       145
       145
       +
                   str: The base32 string representation of the TID.

     

       146
       146
       +
               """

     

       147
       147
       +
               integer = (

     

       148
       148
       +
                   int(self.timestamp.timestamp() * 1000000) * 1024 + self.clockIdentifier

     

       149
       149
       +
               )

     

       150
       150
       +
               binary = f"{integer:065b}"

     

       151
       151
       +
               return "".join(

     

       152
       152
       +
                   [

     

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

     

       154
       154
       +
                       for i in range(0, len(binary), 5)

     

       155
       155
       +
                   ]

     

       156
       156
       +
               )

     

       157
       157
       +
       

     

       158
       158
       +
           def __int__(self):

     

       159
       159
       +
               """Convert the TID to its integer representation.

     

       160
       160
       +
       

     

       161
       161
       +
               Combines the timestamp (in microseconds) and clock identifier into

     

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

     

       163
       163
       +
               and the low 10 bits represent the clock identifier.

     

       164
       164
       +
       

     

       165
       165
       +
               Returns:

     

       166
       166
       +
                   int: The integer representation of the TID.

     

       167
       167
       +
               """

     

       168
       168
       +
               timestamp = int(self.timestamp.timestamp() * 1000000)

     

       169
       169
       +
               return timestamp * 1024 + self.clockIdentifier

     

       170
       170
       +
       

     

       171
       171
       +
           def __str__(self):

     

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

     

       173
       173
       +
       

     

       174
       174
       +
               Encodes the TID as a base32 string using a custom character set that

     

       175
       175
       +
               maintains lexicographical sort order corresponding to temporal order.

     

       176
       176
       +
               This format is commonly used in the AT Protocol for compact,

     

       177
       177
       +
               sortable identifiers.

     

       178
       178
       +
       

     

       179
       179
       +
               Returns:

     

       180
       180
       +
                   str: The base32 string representation of the TID.

     

       181
       181
       +
               """

     

       182
       182
       +
               # Use parent class __str__ method, which returns recordKey

     

       183
       183
       +
               return super().__str__()

     

       184
       184
       +
       

     

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

     

       186
       186
       +
               """Check if two TID objects represent the same identifier.

     

       187
       187
       +
       

     

       188
       188
       +
               Args:

     

       189
       189
       +
                   value (object): The object to compare with.

     

       190
       190
       +
       

     

       191
       191
       +
               Returns:

     

       192
       192
       +
                   bool: True if the objects represent the same TID, False otherwise.

     

       193
       193
       +
               """

     

       194
       194
       +
               if isinstance(value, TID):

     

       195
       195
       +
                   return int(self) == int(value)

     

       196
       196
       +
               elif isinstance(value, RKey):

     

       197
       197
       +
                   # If comparing with RKey, use string comparison

     

       198
       198
       +
                   return str(self) == str(value)

     

       199
       199
       +
               else:

     

       200
       200
       +
                   return False

     

       201
       201
       +
       

     

       202
       202
       +
       

     

       203
       203
       +
       def importTIDfromInteger(value: int | None = None):

     

       204
       204
       +
           """Create a TID object from an integer representation.

     

       205
       205
       +
       

     

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

     

       207
       207
       +
           timestamp and clock identifier components. If no value is provided,

     

       208
       208
       +
           creates a TID for the current time.

     

       209
       209
       +
       

     

       210
       210
       +
           Args:

     

       211
       211
       +
               value (int, optional): The integer value to convert to a TID.

     

       212
       212
       +
                   Defaults to creating a TID for the current time if not provided.

     

       213
       213
       +
       

     

       214
       214
       +
           Returns:

     

       215
       215
       +
               TID: The TID object created from the integer value.

     

       216
       216
       +
           """

     

       217
       217
       +
           if value == None:

     

       218
       218
       +
               value = int(TID())

     

       219
       219
       +
           clockIdentifier = value % 1024

     

       220
       220
       +
           timestamp = (value >> 10) / 1000000

     

       221
       221
       +
           return TID(datetime.datetime.fromtimestamp(timestamp), clockIdentifier)

     

       222
       222
       +
       

     

       223
       223
       +
       

     

       224
       224
       +
       def importTIDfromBase32(value: str | None = None):

     

       225
       225
       +
           """Create a TID object from a base32 string representation.

     

       226
       226
       +
       

     

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

     

       228
       228
       +
           the string to its integer representation and then extracting the timestamp

     

       229
       229
       +
           and clock identifier components. If no value is provided, creates a TID

     

       230
       230
       +
           for the current time.

     

       231
       231
       +
       

     

       232
       232
       +
           Args:

     

       233
       233
       +
               value (str, optional): The base32 string to convert to a TID.

     

       234
       234
       +
                   Defaults to creating a TID for the current time if not provided.

     

       235
       235
       +
       

     

       236
       236
       +
           Returns:

     

       237
       237
       +
               TID: The TID object created from the base32 string.

     

       238
       238
       +
           """

     

       239
       239
       +
           if value == None:

     

       240
       240
       +
               value = str(TID())

     

       241
       241
       +
           b32s = "234567abcdefghijklmnopqrstuvwxyz"

     

       242
       242
       +
           return importTIDfromInteger(

     

       243
       243
       +
               sum(

     

       244
       244
       +
                   [

     

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

     

       246
       246
       +
                       for i in range(len(value))

     

       247
       247
       +
                   ]

     

       248
       248
       +
               )

     

       249
       249
       +
           )

-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
       -
           )