PipComponent.cs

#nullable disable
namespace Microsoft.ComponentDetection.Contracts.TypedComponent;

using System.Diagnostics.CodeAnalysis;
using System.Text.Json.Serialization;
using PackageUrl;

public class PipComponent : TypedComponent
{
    public PipComponent()
    {
        /* Reserved for deserialization */
    }

    public PipComponent(string name, string version, string author = null, string license = null)
    {
        this.Name = this.ValidateRequiredInput(name, nameof(this.Name), nameof(ComponentType.Pip));
        this.Version = this.ValidateRequiredInput(version, nameof(this.Version), nameof(ComponentType.Pip));
        this.Author = author;
        this.License = license;
    }

    [JsonPropertyName("name")]
    public string Name { get; set; }

    [JsonPropertyName("version")]
    public string Version { get; set; }

#nullable enable
    [JsonIgnore(Condition = JsonIgnoreCondition.WhenWritingNull)]
    [JsonPropertyName("author")]
    public string? Author { get; set; }

    [JsonIgnore(Condition = JsonIgnoreCondition.WhenWritingNull)]
    [JsonPropertyName("license")]
    public string? License { get; set; }
#nullable disable

    [JsonIgnore]
    public override ComponentType Type => ComponentType.Pip;

    [JsonPropertyName("packageUrl")]
    public override PackageURL PackageUrl => new PackageURL("pypi", null, this.Name, this.Version, null, null);

    [SuppressMessage("Usage", "CA1308:Normalize String to Uppercase", Justification = "Casing cannot be overwritten.")]
    protected override string ComputeBaseId() => $"{this.Name} {this.Version} - {this.Type}".ToLowerInvariant();
}