Add nullability annotations to System.Private.Xml.Linq project #40744

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

Jump to bottom

Merged

jozkee merged 4 commits into dotnet:master from jozkee:nullability_xpath4

Aug 20, 2020

Member

jozkee commented Aug 13, 2020

Contributes to #2339


          Add nullability annotations to Xml.Linq project

66efb7c

jozkee added the area-System.Xml label

jozkee added this to the 5.0.0 milestone

jozkee requested review from a team, buyaa-n and krwq

August 13, 2020 00:07

jozkee self-assigned this

ghost commented Aug 13, 2020

Tagging subscribers to this area: @buyaa-n, @krwq
See info in area-owners.md if you want to be subscribed.


          Fix misplaced assertion

4a6eefd

krwq reviewed

View reviewed changes

src/libraries/System.Private.Xml.Linq/src/System/Xml/Linq/Extensions.cs Outdated Show resolved Hide resolved

krwq reviewed

View reviewed changes

src/libraries/System.Private.Xml.Linq/src/System/Xml/Linq/XAttribute.cs Outdated Show resolved Hide resolved

krwq reviewed

View reviewed changes

src/libraries/System.Private.Xml.Linq/src/System/Xml/Linq/XAttribute.cs Outdated Show resolved Hide resolved

krwq reviewed

View reviewed changes

src/libraries/System.Private.Xml.Linq/src/System/Xml/Linq/XAttribute.cs Show resolved Hide resolved

krwq reviewed

View reviewed changes

src/libraries/System.Private.Xml.Linq/src/System/Xml/Linq/XDocument.cs Show resolved Hide resolved

krwq reviewed

View reviewed changes

src/libraries/System.Private.Xml/src/System/Xml/XPath/XPathNavigator.cs

    
                      }

                      public virtual object Evaluate(string xpath, IXmlNamespaceResolver resolver)

                      public virtual object Evaluate(string xpath, IXmlNamespaceResolver? resolver)

Member

krwq Aug 13, 2020

should all resolvers above also be nullable?

Member Author

jozkee Aug 14, 2020

Yes, and also in other places where a IXmlNamespaceResolver is taken, not sure if everywhere but we should be able to take null in other cases, e.g:

runtime/src/libraries/System.Private.Xml/src/System/Xml/Core/XmlReader.cs

Line 381 in f0461cb

    
           public virtual object ReadContentAs(Type returnType, IXmlNamespaceResolver namespaceResolver)

The docs also mention that the param can be null https://docs.microsoft.com/dotnet/api/system.xml.xmlreader.readcontentas?view=netcore-3.1

Member

jeffhandley Aug 20, 2020

Do the other places IXmlNamespaceResolver is taken still need to be updated to be nulalble?

Member Author

jozkee Aug 20, 2020 •

edited

Loading

XmlReader.ReadContentAs(Type, IXmlNamespaceResolver) is yet as not-nullable so I assume is the same for the other cases if they exists.

Member Author

jozkee Aug 20, 2020

I did a scan through the methods that can take IXmlNamespaceResolver and found a few ones that could be changed to IXmlNamespaceResolver?. I submitted #41079 with the changes.

krwq reviewed

View reviewed changes

src/libraries/System.Private.Xml.Linq/src/System/Xml/Linq/XDocumentType.cs Show resolved Hide resolved

jaredpar mentioned this pull request

OSX machines are de-provisioned during CI / PR runs leading to failures #34472

Closed

krwq reviewed

View reviewed changes

src/libraries/System.Private.Xml.Linq/src/System/Xml/Linq/XElement.cs Show resolved Hide resolved

krwq reviewed

View reviewed changes

src/libraries/System.Private.Xml.Linq/src/System/Xml/Linq/XElement.cs Outdated Show resolved Hide resolved

krwq reviewed

View reviewed changes

src/libraries/System.Private.Xml.Linq/src/System/Xml/Linq/XElement.cs Show resolved Hide resolved

krwq reviewed

View reviewed changes

src/libraries/System.Private.Xml.Linq/src/System/Xml/Linq/XElement.cs Show resolved Hide resolved

krwq reviewed

View reviewed changes

src/libraries/System.Private.Xml.Linq/src/System/Xml/Linq/XHashtable.cs Show resolved Hide resolved

krwq reviewed

View reviewed changes

src/libraries/System.Private.Xml.Linq/src/System/Xml/Linq/XLinq.cs Show resolved Hide resolved

krwq reviewed

View reviewed changes

src/libraries/System.Private.Xml.Linq/src/System/Xml/Linq/XNodeReader.cs Show resolved Hide resolved

jozkee added 2 commits

August 13, 2020 21:51


          Address feedback

9542f02


          Add missing NotNullIfNotNull attributes to operators

43ba8e1

jozkee force-pushed the nullability_xpath4 branch from 66f7021 to 43ba8e1 Compare

August 18, 2020 22:49

jozkee mentioned this pull request

Change nullability of public IXmlNamespaceResolver parameters where appropriate #41079

Merged

jozkee changed the title ~~Add nullability annotations to Xml.Linq project~~ Add nullability annotations to System.Private.Xml.Linq project

krwq approved these changes

View reviewed changes

Member

krwq left a comment

LGTM, thanks for fixing, please ensure build errors are fixed or known issues

Member Author

jozkee commented Aug 20, 2020

CI issues are unrelated, see #41006.

jozkee merged commit 9d26606 into dotnet:master

jozkee deleted the nullability_xpath4 branch

August 20, 2020 08:56

carlossanlop mentioned this pull request

[release/5.0] Backport nullability annotations to release/5.0 #41348

Merged

14 tasks

ghost locked as resolved and limited conversation to collaborators

Sign up for free to subscribe to this conversation on GitHub. Already have an account? Sign in.

Labels

area-System.Xml