From 6b559bf5859e0e111992f564a64c7b45fce327b6 Mon Sep 17 00:00:00 2001 From: Rakshith Bhyravabhotla Date: Fri, 5 Mar 2021 12:53:47 -0800 Subject: [PATCH] Add NULL to readme (#17076) * null to read me * Update sdk/core/azure-core/README.md --- sdk/core/azure-core/README.md | 17 ++++++++++++++++- 1 file changed, 16 insertions(+), 1 deletion(-) diff --git a/sdk/core/azure-core/README.md b/sdk/core/azure-core/README.md index eade6666623c..09235c818d70 100644 --- a/sdk/core/azure-core/README.md +++ b/sdk/core/azure-core/README.md @@ -179,6 +179,21 @@ class MyCustomEnum(with_metaclass(CaseInsensitiveEnumMeta, str, Enum)): BAR = 'bar' ``` +#### Null Sentinel Value + +A falsy sentinel object which is supposed to be used to specify attributes +with no data. This gets serialized to `null` on the wire. + +```python +from azure.core.serialization import NULL + +assert bool(NULL) is False + +foo = Foo( + attr=NULL +) +``` + ## Contributing This project welcomes contributions and suggestions. Most contributions require you to agree to a Contributor License Agreement (CLA) declaring that you have @@ -198,4 +213,4 @@ or contact [opencode@microsoft.com](mailto:opencode@microsoft.com) with any additional questions or comments. -[package]: https://pypi.org/project/azure-core/ \ No newline at end of file +[package]: https://pypi.org/project/azure-core/