Add `as_dict`

[lmazuel]

Design:

Step 1: AzureJSONEncoder

• Restart back from azure-core AzureJSONEncode (so we can migrate it back to azure-core later)
• Add two kwargs exclude_readonly and exclude_none

This means this should look like this:

class AzureJSONEncoder(JSONEncoder):
   def __init__(self, *args, *, exclude_readonly: bool = False, exclude_none: bool = False, **kwargs):
         super().__init__(*args, **kwargs)
         self.exclude_readonly = exclude_readonly
         self.exclude_none = exclude_none

This design allows to call json.dumps this way:

json.dumps(my_model, exclude_readonly=True, exclude_none=True, cls=AzureJSONEncoder)

This works since json.dumps inject kwargs into the constructor of cls, so we have access to custom kwargs.

Step 2:

• Add a as_dict in all model that is literally:

def as_dict(self, *, exclude_readonly: bool = False, exclude_none: bool = False):
   return json.dumps(self, exclude_readonly=exclude_readonly, exclude_none=exclude_none, cls=AzureJSONEncoder)

Step 3:

• Update our operation template to call as_dict(exclude_readonly=True, exclude_none=True)

[tadelesh]

@lmazuel could you share some context about this as_dict. I went through all the discussion from Teams group but got no idea about the original reason for introducing this feature.

[tadelesh]

@iscai-msft do you have some context about this?

[lmazuel]

@tadelesh people should have a way to serialize with/without read-only/None, like it was possible with msrest.

[tadelesh]

@lmazuel should exclude_readonly default be True? Also, what exclude_none actually mean? Any unset property will all be None, if this flag set true, they will all generated with null?

[iscai-msft]

@tadelesh yeah the defaults for both exclude_readonly and exclude_none should be True, this is what we're currently sending to the service.

So, if we had the model representation of JSON object {"foo": "bar", "readonlyProp": "value", "noneProp": None} we would send '{"foo": "bar"}' to the service.

Right now if a property is set to None, we will just pop it out of the dict before sending to the service, and we'll only send a property with value null if a user explicitly passes in value azure.core.serialization.NULL

[msyyc]

current logic of DPG model for None/azure.core.serialization.NULL:

[msyyc]

from typing import Optional, overload
from azure.core.serialization import NULL
from azure.ai.anomalydetector._model_base import Model, rest_field

class DpgModel(Model):
    a: Optional[str] = rest_field()
    ...


m = DpgModel(a=NULL)
print(m.a == m['a'] == NULL)  # A1 expected: True
print(m.as_dict()) # A2 expected: {'a': None}
print(m.as_dict(exclude_none=True)) # A3 expected: {}

m = DpgModel({'a': NULL})
print(m.a == m['a'] == NULL)  # B1 expected: True
print(m.as_dict())  # B2 expected: {'a': None}
print(m.as_dict(exclude_none=True)) # B3 expected: {}

m = DpgModel() # or m = DpgModel(a=None)
print(m.a is None, m['a'] is None)  # C1 expected: True True
print(m.as_dict())  # C2 expected: {'a': None}
print(m.as_dict(exclude_none=True)) # C3 expected: {}

m = DpgModel({'a': None}) 
print(m.a is None, m['a'] is None)  # D1 expected: True True
print(m.as_dict())  # D2 expected: {'a': None}
print(m.as_dict(exclude_none=True)) # D3 expected: {}

Is my understanding right?

[tadelesh]

@msyyc some correctness for the third part:

m = DpgModel() # or m = DpgModel(a=None)
print(m.a is None, 'a' not in m)  # C1 expected: True True
print(m.as_dict())  # C2 expected: {}
print(m.as_dict(exclude_none=True)) # C3 expected: {}

[msyyc]

updated:

from typing import Optional, overload
from azure.core.serialization import NULL
from azure.ai.anomalydetector._model_base import Model, rest_field

class DpgModel(Model):
    a: Optional[str] = rest_field()
    ...


m = DpgModel(a=NULL)
print(m.a == m['a'] == NULL)  # A1 expected: True
print(m.as_dict()) # A2 expected: {'a': None}
print(m.as_dict(exclude_none=True)) # A3 expected: {}

m = DpgModel({'a': NULL})
print(m.a == m['a'] == NULL)  # B1 expected: True
print(m.as_dict())  # B2 expected: {'a': None}
print(m.as_dict(exclude_none=True)) # B3 expected: {}

m = DpgModel() # or m = DpgModel(a=None)
print(m.a is None, 'a' not in m)  # C1 expected: True True
print(m.as_dict())  # C2 expected: {}
print(m.as_dict(exclude_none=True)) # C3 expected: {}

m = DpgModel({'a': None}) 
print(m.a is None, m['a'] is None)  # D1 expected: True True
print(m.as_dict())  # D2 expected: {'a': None}
print(m.as_dict(exclude_none=True)) # D3 expected: {}