How to Skip Empty Collections in Yamldotnet

Question

I'm trying to figure out how to skip serializing empty collections using YamlDotNet. I have experimented with both a custom ChainedObjectGraphVisitor and IYamlTypeConverter. I'm new to using YamlDotNet and have some knowledge gaps here.

Below is my implementation for the visitor pattern, which results in a YamlDotNet.Core.YamlException "Expected SCALAR, SEQUENCE-START, MAPPING-START, or ALIAS, got MappingEnd" error. I do see some online content for MappingStart/MappingEnd, but I'm not sure how it fits into what I'm trying to do (eliminate clutter from lots of empty collections). Any pointers in the right direction are appreciated.

Instantiating the serializer:

var serializer = new YamlDotNet.Serialization.SerializerBuilder()
                .WithNamingConvention(new YamlDotNet.Serialization.NamingConventions.CamelCaseNamingConvention())
                .WithEmissionPhaseObjectGraphVisitor(args => new YamlIEnumerableSkipEmptyObjectGraphVisitor(args.InnerVisitor))
                .Build();

ChainedObjectGraphVisitor implementation:

    public sealed class YamlIEnumerableSkipEmptyObjectGraphVisitor : ChainedObjectGraphVisitor
{
    public YamlIEnumerableSkipEmptyObjectGraphVisitor(IObjectGraphVisitor<IEmitter> nextVisitor)
        : base(nextVisitor)
    {
    }

    public override bool Enter(IObjectDescriptor value, IEmitter context)
    {
        bool retVal;

        if (typeof(System.Collections.IEnumerable).IsAssignableFrom(value.Value.GetType()))
        {   // We have a collection
            var enumerableObject = (System.Collections.IEnumerable)value.Value;
            if (enumerableObject.GetEnumerator().MoveNext()) // Returns true if the collection is not empty.
            {   // Serialize it as normal.
                retVal = base.Enter(value, context);
            }
            else
            {   // Skip this item.
                retVal = false;
            }
        }
        else
        {   // Not a collection, normal serialization.
            retVal = base.Enter(value, context);
        }

        return retVal;
    }
}

score 3 · Answer 1 · edited Dec 31 '19 at 10:17

I believe the answer is to also override the EnterMapping() method in the base class with logic that is similar to what was done in the Enter() method:

public override bool EnterMapping(IPropertyDescriptor key, IObjectDescriptor value, IEmitter context)
{
    bool retVal = false;

    if (value.Value == null)
        return retVal;

    if (typeof(System.Collections.IEnumerable).IsAssignableFrom(value.Value.GetType()))
    {   // We have a collection
        var enumerableObject = (System.Collections.IEnumerable)value.Value;
        if (enumerableObject.GetEnumerator().MoveNext()) // Returns true if the collection is not empty.
        {   // Don't skip this item - serialize it as normal.
            retVal = base.EnterMapping(key, value, context);
        }
        // Else we have an empty collection and the initialized return value of false is correct.
    }
    else
    {   // Not a collection, normal serialization.
        retVal = base.EnterMapping(key, value, context);
    }

    return retVal;
}

This is the recommended way to achieve your goal. The implementation of [DefaultExclusiveObjectGraphVisitor](https://github.com/aaubry/YamlDotNet/blob/master/YamlDotNet/Serialization/ObjectGraphVisitors/DefaultExclusiveObjectGraphVisitor.cs) uses a similar strategy to avoid emitting default values. — Antoine Aubry, Jun 04 '19 at 21:39

msergey · Answer 2 · 2022-09-29T13:36:48.480

3

you can specify DefaultValuesHandling

in the serializer:

var serializer = new SerializerBuilder()
    .ConfigureDefaultValuesHandling(DefaultValuesHandling.OmitEmptyCollections)
    .Build();

or in an attribute YamlMember for a field/property:

public class MyDtoClass
{

    [YamlMember(DefaultValuesHandling = DefaultValuesHandling.OmitEmptyCollections)]
    public List<string> MyCollection;
}

edited Sep 29 '22 at 13:36

answered Sep 29 '22 at 08:57

msergey

31
1
2

Kees C. Bakker · Answer 3 · 2020-11-08T12:49:51.410

I ended up with the following class:

using System.Collections;
using YamlDotNet.Core;
using YamlDotNet.Serialization;
using YamlDotNet.Serialization.ObjectGraphVisitors;

sealed class YamlIEnumerableSkipEmptyObjectGraphVisitor : ChainedObjectGraphVisitor
{
    public YamlIEnumerableSkipEmptyObjectGraphVisitor(IObjectGraphVisitor<IEmitter> nextVisitor): base(nextVisitor)
    {
    }

    private bool IsEmptyCollection(IObjectDescriptor value)
    {
        if (value.Value == null)
            return true;

        if (typeof(IEnumerable).IsAssignableFrom(value.Value.GetType()))
            return !((IEnumerable)value.Value).GetEnumerator().MoveNext();

        return false;
    }

    public override bool Enter(IObjectDescriptor value, IEmitter context)
    {
        if (IsEmptyCollection(value))
            return false;

        return base.Enter(value, context);
    }

    public override bool EnterMapping(IPropertyDescriptor key, IObjectDescriptor value, IEmitter context)
    {
        if (IsEmptyCollection(value))
            return false;

        return base.EnterMapping(key, value, context);
    }
}

How to Skip Empty Collections in Yamldotnet

3 Answers3