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

+49
src/atpasser/recordKeys/__init__.py
···

       1
       1
       +
       class RecordKey:

     

       2
       2
       +
           """

     

       3
       3
       +
           A class representing a RecordKey.

     

       4
       4
       +
       

     

       5
       5
       +
       

     

       6
       6
       +
           Attributes:

     

       7
       7
       +
               recordKey (str): The RecordKey URI.

     

       8
       8
       +
           """

     

       9
       9
       +
       

     

       10
       10
       +
           def __init__(self, recordKey: str) -> None:

     

       11
       11
       +
               """

     

       12
       12
       +
               Initalizes an RecordKey object.

     

       13
       13
       +
       

     

       14
       14
       +
               Parameters:

     

       15
       15
       +
                   recordKey (str): The RecordKey.

     

       16
       16
       +
               """

     

       17
       17
       +
       

     

       18
       18
       +
               if recordKey == "" or len(recordKey) > 512:

     

       19
       19
       +
                   raise ValueError("null record key or record key longer than 512 chars")

     

       20
       20
       +
       

     

       21
       21
       +
               if recordKey == ".." or recordKey == ".":

     

       22
       22
       +
                   raise ValueError("reserved value . and ..")

     

       23
       23
       +
       

     

       24
       24
       +
               if not set(recordKey).issubset(

     

       25
       25
       +
                   set("ABCDEFGHIJKLMNOPQRSTUVWXYZabcdefghijklmnopqrstuvwxyz0123456789.-_:~")

     

       26
       26
       +
               ):

     

       27
       27
       +
                   raise ValueError("invalid char")

     

       28
       28
       +
       

     

       29
       29
       +
               self.recordKey = recordKey

     

       30
       30
       +
       

     

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

     

       32
       32
       +
               """

     

       33
       33
       +
       

     

       34
       34
       +
               Convert the RecordKey to a string by given the URI.

     

       35
       35
       +
               """

     

       36
       36
       +
               return self.recordKey

     

       37
       37
       +
       

     

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

     

       39
       39
       +
               """

     

       40
       40
       +
       

     

       41
       41
       +
               Check if the 2 values are exactly the same.

     

       42
       42
       +
               """

     

       43
       43
       +
       

     

       44
       44
       +
               if isinstance(value, RecordKey):

     

       45
       45
       +
       

     

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

     

       47
       47
       +
               else:

     

       48
       48
       +
       

     

       49
       49
       +
                   raise TypeError