Using Code Contracts to specify a return value may be null

Question

Is there a way of explicitly specifying that a return value can be null using Code Contracts?

My worry is that methods without a Contract.Ensures(Contract.Result<object>() != null) may be incorrectly 'fixed' in the future to include the post-condition, even though the original intention may have been to allow null results.

There's no way to specify that. `(x == null) || (x != null)` is both silly and confusing. — H H, Feb 16 '12 at 18:35
No, and I don't think that 'fix' would ever happen. It would just break things. — porges, Feb 16 '12 at 20:14
@Porges - I'd have to disagree to some extent. If I was an original author revisiting some of my code, I may scan over the Code Contracts and assume it was neglect over intention that the condition is not there. — Lawrence Wagerfield, Feb 16 '12 at 20:31
@LawrenceWagerfield: ah sorry, I thought you meant CC would assume not-null in the future. I see what you mean now :) — porges, Feb 16 '12 at 20:49
Another point: if someone *does* add the `Ensures`, the static checker will catch it. — porges, Feb 16 '12 at 21:59

score 9 · Accepted Answer · answered Feb 16 '12 at 21:00

9

If there are any other post-conditions then these will indicate that null is a valid return value. For example, if a method should return a positive value but uses null if an error occurs:

Contract.Ensures(Contract.Result<int?>() == null || 0 <= Contract.Result<int?>());

If you're worried about regression, though, the best solution might be to add a unit test for an expected null return value.

answered Feb 16 '12 at 21:00

Matthew Strawbridge

19,940
10
72
93

'Regression' - that's the word I should have used :) – Lawrence Wagerfield Feb 16 '12 at 21:11

score 3 · Answer 2 · answered Nov 07 '12 at 12:20

If you are using resharper you can get it to produce warnings by marking methods with the CanBeNull attribute as described here: http://blogs.jetbrains.com/dotnet/2010/11/resharper-nullreferenceexception-analysis-and-its-contracts/

Its done using some resharper classes, but convieniently you dont have to reference a library - theres a button in the options to let you get your hands on the annotations. Little thing to be careful of: you need to keep the namespace they are in the same - it appears the actual marking is done by fully qualified name (so putting the classes in your own ns and using them wont produce the warnings you want).

This is very useful for properties that can be null on classes (eg where a user decision is yet to be made/can be removed) but where the assignment is a data object that means it is inappropriate to use the null object pattern. We've got one of those in a project im working on which always trips up new coders who dont realise it can be null.

Using Code Contracts to specify a return value may be null

2 Answers2