Skip to content

Add NULL to readme #17076

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
rakshith91 merged 2 commits into from
Mar 5, 2021
Merged

Add NULL to readme #17076

Changes from all commits
Commits
Show all changes
2 commits
Select commit Hold shift + click to select a range
5304fc0
null to read me
rakshith91 Mar 4, 2021
03b6e20
Update sdk/core/azure-core/README.md
Mar 4, 2021
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
17 changes: 16 additions & 1 deletion sdk/core/azure-core/README.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -179,6 +179,21 @@ class MyCustomEnum(with_metaclass(CaseInsensitiveEnumMeta, str, Enum)):
BAR = 'bar'
```

#### Null Sentinel Value
Copy link
Member

@xiangyan99 xiangyan99 Mar 4, 2021

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Just want to double check we expect this to be used by end user or developer or both?

Copy link
Contributor Author

@rakshith91 rakshith91 Mar 4, 2021

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

we expect this to be used by end user - if they want to pass an explicit null on the wire

Copy link
Contributor Author

@rakshith91 rakshith91 Mar 4, 2021

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

it's a rare edge case (which cloud events happen to allow), so decided to add a sentinel


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
Expand All @@ -198,4 +213,4 @@ or contact [opencode@microsoft.com](mailto:opencode@microsoft.com) with any
additional questions or comments.

<!-- LINKS -->
[package]: https://pypi.org/project/azure-core/
[package]: https://pypi.org/project/azure-core/