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

+1 -91

poetry.lock

···

       285
       285
        
       ]

     

       286
       286
        
       

     

       287
       287
        
       [[package]]

     

       288
       288
       -
       name = "colorama"

     

       289
       289
       -
       version = "0.4.6"

     

       290
       290
       -
       description = "Cross-platform colored terminal text."

     

       291
       291
       -
       optional = false

     

       292
       292
       -
       python-versions = "!=3.0.*,!=3.1.*,!=3.2.*,!=3.3.*,!=3.4.*,!=3.5.*,!=3.6.*,>=2.7"

     

       293
       293
       -
       groups = ["main"]

     

       294
       294
       -
       markers = "sys_platform == \"win32\""

     

       295
       295
       -
       files = [

     

       296
       296
       -
           {file = "colorama-0.4.6-py2.py3-none-any.whl", hash = "sha256:4f1d9991f5acc0ca119f9d443620b77f9d6b33703e51011c16baf57afb285fc6"},

     

       297
       297
       -
           {file = "colorama-0.4.6.tar.gz", hash = "sha256:08695f5cb7ed6e0531a20572697297273c47b8cae5a63ffc6d6ed5c201be6e44"},

     

       298
       298
       -
       ]

     

       299
       299
       -
       

     

       300
       300
       -
       [[package]]

     

       301
       288
        
       name = "cryptography"

     

       302
       289
        
       version = "45.0.7"

     

       303
       290
        
       description = "cryptography is a package which provides cryptographic recipes and primitives to Python developers."

     
···

       441
       428
        
       

     

       442
       429
        
       [package.extras]

     

       443
       430
        
       all = ["flake8 (>=7.1.1)", "mypy (>=1.11.2)", "pytest (>=8.3.2)", "ruff (>=0.6.2)"]

     

       444
       444
       -
       

     

       445
       445
       -
       [[package]]

     

       446
       446
       -
       name = "iniconfig"

     

       447
       447
       -
       version = "2.1.0"

     

       448
       448
       -
       description = "brain-dead simple config-ini parsing"

     

       449
       449
       -
       optional = false

     

       450
       450
       -
       python-versions = ">=3.8"

     

       451
       451
       -
       groups = ["main"]

     

       452
       452
       -
       files = [

     

       453
       453
       -
           {file = "iniconfig-2.1.0-py3-none-any.whl", hash = "sha256:9deba5723312380e77435581c6bf4935c94cbfab9b1ed33ef8d238ea168eb760"},

     

       454
       454
       -
           {file = "iniconfig-2.1.0.tar.gz", hash = "sha256:3abbd2e30b36733fee78f9c7f7308f2d0050e88f0087fd25c2645f63c773e1c7"},

     

       455
       455
       -
       ]

     

       456
       431
        
       

     

       457
       432
        
       [[package]]

     

       458
       433
        
       name = "jsonpath-ng"

     
···

       730
       705
        
       ]

     

       731
       706
        
       

     

       732
       707
        
       [[package]]

     

       733
       733
       -
       name = "packaging"

     

       734
       734
       -
       version = "25.0"

     

       735
       735
       -
       description = "Core utilities for Python packages"

     

       736
       736
       -
       optional = false

     

       737
       737
       -
       python-versions = ">=3.8"

     

       738
       738
       -
       groups = ["main"]

     

       739
       739
       -
       files = [

     

       740
       740
       -
           {file = "packaging-25.0-py3-none-any.whl", hash = "sha256:29572ef2b1f17581046b3a2227d5c611fb25ec70ca1ba8554b24b0e69331a484"},

     

       741
       741
       -
           {file = "packaging-25.0.tar.gz", hash = "sha256:d443872c98d677bf60f6a1f2f8c1cb748e8fe762d2bf9d3148b5599295b0fc4f"},

     

       742
       742
       -
       ]

     

       743
       743
       -
       

     

       744
       744
       -
       [[package]]

     

       745
       745
       -
       name = "pluggy"

     

       746
       746
       -
       version = "1.6.0"

     

       747
       747
       -
       description = "plugin and hook calling mechanisms for python"

     

       748
       748
       -
       optional = false

     

       749
       749
       -
       python-versions = ">=3.9"

     

       750
       750
       -
       groups = ["main"]

     

       751
       751
       -
       files = [

     

       752
       752
       -
           {file = "pluggy-1.6.0-py3-none-any.whl", hash = "sha256:e920276dd6813095e9377c0bc5566d94c932c33b27a3e3945d8389c374dd4746"},

     

       753
       753
       -
           {file = "pluggy-1.6.0.tar.gz", hash = "sha256:7dcc130b76258d33b90f61b658791dede3486c3e6bfb003ee5c9bfb396dd22f3"},

     

       754
       754
       -
       ]

     

       755
       755
       -
       

     

       756
       756
       -
       [package.extras]

     

       757
       757
       -
       dev = ["pre-commit", "tox"]

     

       758
       758
       -
       testing = ["coverage", "pytest", "pytest-benchmark"]

     

       759
       759
       -
       

     

       760
       760
       -
       [[package]]

     

       761
       708
        
       name = "ply"

     

       762
       709
        
       version = "3.11"

     

       763
       710
        
       description = "Python Lex & Yacc"

     
···

       840
       787
        
       ]

     

       841
       788
        
       

     

       842
       789
        
       [[package]]

     

       843
       843
       -
       name = "pygments"

     

       844
       844
       -
       version = "2.19.2"

     

       845
       845
       -
       description = "Pygments is a syntax highlighting package written in Python."

     

       846
       846
       -
       optional = false

     

       847
       847
       -
       python-versions = ">=3.8"

     

       848
       848
       -
       groups = ["main"]

     

       849
       849
       -
       files = [

     

       850
       850
       -
           {file = "pygments-2.19.2-py3-none-any.whl", hash = "sha256:86540386c03d588bb81d44bc3928634ff26449851e99741617ecb9037ee5ec0b"},

     

       851
       851
       -
           {file = "pygments-2.19.2.tar.gz", hash = "sha256:636cb2477cec7f8952536970bc533bc43743542f70392ae026374600add5b887"},

     

       852
       852
       -
       ]

     

       853
       853
       -
       

     

       854
       854
       -
       [package.extras]

     

       855
       855
       -
       windows-terminal = ["colorama (>=0.4.6)"]

     

       856
       856
       -
       

     

       857
       857
       -
       [[package]]

     

       858
       790
        
       name = "pyld"

     

       859
       791
        
       version = "2.0.4"

     

       860
       792
        
       description = "Python implementation of the JSON-LD API"

     
···

       895
       827
        
       sha3 = ["pysha3"]

     

       896
       828
        
       

     

       897
       829
        
       [[package]]

     

       898
       898
       -
       name = "pytest"

     

       899
       899
       -
       version = "8.4.2"

     

       900
       900
       -
       description = "pytest: simple powerful testing with Python"

     

       901
       901
       -
       optional = false

     

       902
       902
       -
       python-versions = ">=3.9"

     

       903
       903
       -
       groups = ["main"]

     

       904
       904
       -
       files = [

     

       905
       905
       -
           {file = "pytest-8.4.2-py3-none-any.whl", hash = "sha256:872f880de3fc3a5bdc88a11b39c9710c3497a547cfa9320bc3c5e62fbf272e79"},

     

       906
       906
       -
           {file = "pytest-8.4.2.tar.gz", hash = "sha256:86c0d0b93306b961d58d62a4db4879f27fe25513d4b969df351abdddb3c30e01"},

     

       907
       907
       -
       ]

     

       908
       908
       -
       

     

       909
       909
       -
       [package.dependencies]

     

       910
       910
       -
       colorama = {version = ">=0.4", markers = "sys_platform == \"win32\""}

     

       911
       911
       -
       iniconfig = ">=1"

     

       912
       912
       -
       packaging = ">=20"

     

       913
       913
       -
       pluggy = ">=1.5,<2"

     

       914
       914
       -
       pygments = ">=2.7.2"

     

       915
       915
       -
       

     

       916
       916
       -
       [package.extras]

     

       917
       917
       -
       dev = ["argcomplete", "attrs (>=19.2)", "hypothesis (>=3.56)", "mock", "requests", "setuptools", "xmlschema"]

     

       918
       918
       -
       

     

       919
       919
       -
       [[package]]

     

       920
       830
        
       name = "python-baseconv"

     

       921
       831
        
       version = "1.2.2"

     

       922
       832
        
       description = "Convert numbers from base 10 integers to base X strings and back again."

     
···

       993
       903
        
       [metadata]

     

       994
       904
        
       lock-version = "2.1"

     

       995
       905
        
       python-versions = ">=3.13"

     

       996
       996
       -
       content-hash = "959bc6b01857f65b67d47c12c46abc7af95aecf9913baf195392232500f2253a"

     

       906
       906
       +
       content-hash = "5f4e5fd166bf6b2010ec5acaf545a0cfe376dcc5437530f3add4b58f10ce439f"

-1

pyproject.toml

···

       14
       14
        
           "jsonpath-ng (>=1.7.0,<2.0.0)",    # for URI fragment support

     

       15
       15
        
           "cryptography (>=45.0.7,<46.0.0)", # just keep it

     

       16
       16
        
           "langcodes (>=3.5.0,<4.0.0)",      # language codes support

     

       17
       17
       -
           "pytest (>=8.4.2,<9.0.0)",

     

       18
       17
        
       ]

     

       19
       18
        
       license = "MIT OR Apache-2.0"

     

       20
       19
        
       license-files = ["LICEN[CS]E.*"]

+1 -49

src/atpasser/data/__init__.py

···

       1
       1
       -
       """

     

       2
       2
       -
       JSON module wrapper for ATProto data model.

     

       3
       3
       -
       

     

       4
       4
       -
       This module provides a JSON encoder and decoder that handle ATProto-specific

     

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

     

       6
       6
       -
       """

     

       7
       7
       -
       

     

       8
       8
       -
       from .encoder import JsonEncoder

     

       9
       9
       -
       from .decoder import JsonDecoder, TypedObject

     

       10
       10
       -
       from .hooks import TypeHookRegistry, type_handler

     

       11
       11
       -
       from .types import (

     

       12
       12
       -
           TypeProcessor,

     

       13
       13
       -
           TypeProcessorRegistry,

     

       14
       14
       -
           register_type,

     

       15
       15
       -
           register_type_encoder,

     

       16
       16
       -
           register_type_class,

     

       17
       17
       -
           unregister_type,

     

       18
       18
       -
           get_type_decoder,

     

       19
       19
       -
           get_type_encoder,

     

       20
       20
       -
           has_type_processor,

     

       21
       21
       -
           clear_type_processors,

     

       22
       22
       -
           get_registered_types,

     

       23
       23
       -
           create_processor_registry,

     

       24
       24
       -
       )

     

       25
       25
       -
       from .wrapper import dump, dumps, load, loads

     

       26
       26
       -
       

     

       27
       27
       -
       __all__ = [

     

       28
       28
       -
           "JsonEncoder",

     

       29
       29
       -
           "JsonDecoder",

     

       30
       30
       -
           "TypedObject",

     

       31
       31
       -
           "TypeHookRegistry",

     

       32
       32
       -
           "type_handler",

     

       33
       33
       -
           "TypeProcessor",

     

       34
       34
       -
           "TypeProcessorRegistry",

     

       35
       35
       -
           "register_type",

     

       36
       36
       -
           "register_type_encoder",

     

       37
       37
       -
           "register_type_class",

     

       38
       38
       -
           "unregister_type",

     

       39
       39
       -
           "get_type_decoder",

     

       40
       40
       -
           "get_type_encoder",

     

       41
       41
       -
           "has_type_processor",

     

       42
       42
       -
           "clear_type_processors",

     

       43
       43
       -
           "get_registered_types",

     

       44
       44
       -
           "create_processor_registry",

     

       45
       45
       -
           "dump",

     

       46
       46
       -
           "dumps",

     

       47
       47
       -
           "load",

     

       48
       48
       -
           "loads",

     

       49
       49
       -
       ]

     

       1
       1
       +
       from ._wrapper import *

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

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

+4 -1

tests/__init__.py

···

       1
       1
       -
       """Test package for atpasser."""

     

       1
       1
       +
       if __name__ != "__main__":

     

       2
       2
       +
           raise Exception("name != main")

     

       3
       3
       +
       

     

       4
       4
       +
       import _strings

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