Merge remote-tracking branch 'upstream/master' into docs

Rob-Hague · Rob-Hague · commit 243356022502 · 2025-07-04T13:08:34.000+02:00
diff --git a/CsvHelper.sln b/CsvHelper.sln
@@ -20,6 +20,8 @@ Project("{9A19103F-16F7-4668-BE54-9A1E7A4F7556}") = "CsvHelper.Tests", "tests\Cs
 EndProject
 Project("{9A19103F-16F7-4668-BE54-9A1E7A4F7556}") = "CsvHelper.Website", "src\CsvHelper.Website\CsvHelper.Website.csproj", "{3E59CA52-D248-4CBB-BB06-270FA942C4B8}"
 EndProject
+Project("{FAE04EC0-301F-11D3-BF4B-00C04F79EFBC}") = "CsvHelper.Benchmarks", "performance\CsvHelper.Benchmarks\CsvHelper.Benchmarks.csproj", "{4DAB88D4-56B0-C42A-25BB-3E5BBCBB5F1B}"
+EndProject
 Global
 	GlobalSection(SolutionConfigurationPlatforms) = preSolution
 		Debug|Any CPU = Debug|Any CPU
@@ -94,6 +96,26 @@ Global
 		{3E59CA52-D248-4CBB-BB06-270FA942C4B8}.Release|x64.Build.0 = Release|Any CPU
 		{3E59CA52-D248-4CBB-BB06-270FA942C4B8}.Release|x86.ActiveCfg = Release|Any CPU
 		{3E59CA52-D248-4CBB-BB06-270FA942C4B8}.Release|x86.Build.0 = Release|Any CPU
+		{4DAB88D4-56B0-C42A-25BB-3E5BBCBB5F1B}.Debug|Any CPU.ActiveCfg = Debug|Any CPU
+		{4DAB88D4-56B0-C42A-25BB-3E5BBCBB5F1B}.Debug|Any CPU.Build.0 = Debug|Any CPU
+		{4DAB88D4-56B0-C42A-25BB-3E5BBCBB5F1B}.Debug|ARM.ActiveCfg = Debug|Any CPU
+		{4DAB88D4-56B0-C42A-25BB-3E5BBCBB5F1B}.Debug|ARM.Build.0 = Debug|Any CPU
+		{4DAB88D4-56B0-C42A-25BB-3E5BBCBB5F1B}.Debug|Mixed Platforms.ActiveCfg = Debug|Any CPU
+		{4DAB88D4-56B0-C42A-25BB-3E5BBCBB5F1B}.Debug|Mixed Platforms.Build.0 = Debug|Any CPU
+		{4DAB88D4-56B0-C42A-25BB-3E5BBCBB5F1B}.Debug|x64.ActiveCfg = Debug|Any CPU
+		{4DAB88D4-56B0-C42A-25BB-3E5BBCBB5F1B}.Debug|x64.Build.0 = Debug|Any CPU
+		{4DAB88D4-56B0-C42A-25BB-3E5BBCBB5F1B}.Debug|x86.ActiveCfg = Debug|Any CPU
+		{4DAB88D4-56B0-C42A-25BB-3E5BBCBB5F1B}.Debug|x86.Build.0 = Debug|Any CPU
+		{4DAB88D4-56B0-C42A-25BB-3E5BBCBB5F1B}.Release|Any CPU.ActiveCfg = Release|Any CPU
+		{4DAB88D4-56B0-C42A-25BB-3E5BBCBB5F1B}.Release|Any CPU.Build.0 = Release|Any CPU
+		{4DAB88D4-56B0-C42A-25BB-3E5BBCBB5F1B}.Release|ARM.ActiveCfg = Release|Any CPU
+		{4DAB88D4-56B0-C42A-25BB-3E5BBCBB5F1B}.Release|ARM.Build.0 = Release|Any CPU
+		{4DAB88D4-56B0-C42A-25BB-3E5BBCBB5F1B}.Release|Mixed Platforms.ActiveCfg = Release|Any CPU
+		{4DAB88D4-56B0-C42A-25BB-3E5BBCBB5F1B}.Release|Mixed Platforms.Build.0 = Release|Any CPU
+		{4DAB88D4-56B0-C42A-25BB-3E5BBCBB5F1B}.Release|x64.ActiveCfg = Release|Any CPU
+		{4DAB88D4-56B0-C42A-25BB-3E5BBCBB5F1B}.Release|x64.Build.0 = Release|Any CPU
+		{4DAB88D4-56B0-C42A-25BB-3E5BBCBB5F1B}.Release|x86.ActiveCfg = Release|Any CPU
+		{4DAB88D4-56B0-C42A-25BB-3E5BBCBB5F1B}.Release|x86.Build.0 = Release|Any CPU
 	EndGlobalSection
 	GlobalSection(SolutionProperties) = preSolution
 		HideSolutionNode = FALSE
diff --git a/CsvHelper.v3.ncrunchsolution b/CsvHelper.v3.ncrunchsolution
@@ -2,6 +2,7 @@
   <Settings>
     <AllowParallelTestExecution>True</AllowParallelTestExecution>
     <InstrumentationMode>Optimised</InstrumentationMode>
+    <RdiConfigured>True</RdiConfigured>
     <SolutionConfigured>True</SolutionConfigured>
   </Settings>
 </SolutionConfiguration>
diff --git a/performance/CsvHelper.Benchmarks/BenchmarkEnumerateRecords.cs b/performance/CsvHelper.Benchmarks/BenchmarkEnumerateRecords.cs
@@ -0,0 +1,66 @@
+﻿using System;
+using System.Globalization;
+using System.IO;
+
+using BenchmarkDotNet.Attributes;
+
+namespace CsvHelper.Benchmarks;
+
+[MemoryDiagnoser]
+public class BenchmarkEnumerateRecords
+{
+	private const int entryCount = 10000;
+	private readonly MemoryStream stream = new();
+
+	public class Simple
+	{
+		public int Id { get; set; }
+		public string Name { get; set; }
+	}
+
+	[GlobalSetup]
+	public void GlobalSetup()
+	{
+		using var streamWriter = new StreamWriter(this.stream, null, -1, true);
+		using var writer = new CsvWriter(streamWriter, CultureInfo.InvariantCulture, true);
+		var random = new Random(42); // Pick a known seed to keep things consistent
+
+		var chars = new char[10];
+		string getRandomString()
+		{
+			for (int i = 0; i < 10; ++i)
+				chars[i] = (char)random.Next('a', 'z' + 1);
+			return new string(chars);
+		}
+
+		writer.WriteHeader(typeof(Simple));
+		writer.NextRecord();
+		for (int i = 0; i < BenchmarkEnumerateRecords.entryCount; ++i)
+		{
+			writer.WriteRecord(new Simple()
+			{
+				Id = random.Next(),
+				Name = getRandomString()
+			});
+			writer.NextRecord();
+		}
+	}
+
+	[GlobalCleanup]
+	public void GlobalCleanup()
+	{
+		this.stream.Dispose();
+	}
+
+	[Benchmark]
+	public void EnumerateRecords()
+	{
+		this.stream.Position = 0;
+		using var streamReader = new StreamReader(this.stream, null, true, -1, true);
+		using var csv = new CsvReader(streamReader, CultureInfo.InvariantCulture, true);
+		foreach (var record in csv.GetRecords<Simple>())
+		{
+			_ = record;
+		}
+	}
+}
diff --git a/performance/CsvHelper.Benchmarks/BenchmarkMain.cs b/performance/CsvHelper.Benchmarks/BenchmarkMain.cs
@@ -0,0 +1,11 @@
+﻿using BenchmarkDotNet.Running;
+
+namespace CsvHelper.Benchmarks;
+
+internal class BenchmarkMain
+{
+	static void Main(string[] args)
+	{
+		_ = BenchmarkRunner.Run<BenchmarkEnumerateRecords>();
+	}
+}
diff --git a/performance/CsvHelper.Benchmarks/CsvHelper.Benchmarks.csproj b/performance/CsvHelper.Benchmarks/CsvHelper.Benchmarks.csproj
@@ -0,0 +1,16 @@
+﻿<Project Sdk="Microsoft.NET.Sdk">
+
+  <PropertyGroup>
+    <OutputType>Exe</OutputType>
+    <TargetFramework>net9.0</TargetFramework>
+  </PropertyGroup>
+
+  <ItemGroup>
+    <PackageReference Include="BenchmarkDotNet" Version="0.15.0" />
+  </ItemGroup>
+
+  <ItemGroup>
+    <ProjectReference Include="..\..\src\CsvHelper\CsvHelper.csproj" />
+  </ItemGroup>
+
+</Project>
diff --git a/src/CsvHelper.Website/input/change-log/index.md b/src/CsvHelper.Website/input/change-log/index.md
@@ -1,5 +1,19 @@
 ﻿# Change Log
 
+### 33.1.0
+
+#### Features
+
+- Use `Attributes.IsDefined` instead of `Attributes.GetCustomAttributes` to check for attributes on a type. This is more performant.
+- Removed out of support frameworks `net6.0` and `net7.0` and added `net9.0`.
+- Use CacheKey struct for ObjectCreator cache key.
+- Early exit in ObjectCreator when there are no args. This reduces allocations.
+
+#### Bug Fixes
+
+- Add `Dispose` and `DisposeAsync` to writer write async methods.
+- Fixed issue with setting `UseDefaultOnConversionFailure` to `true` when the default value is `null`.
+
 ### 33.0.1
 
 #### Bug Fixes
diff --git a/src/CsvHelper.Website/input/examples/configuration/class-maps/validation/index.md b/src/CsvHelper.Website/input/examples/configuration/class-maps/validation/index.md
@@ -34,7 +34,7 @@ public class FooMap : ClassMap<Foo>
     public FooMap()
     {
         Map(m => m.Id);
-        Map(m => m.Name).Validate(field => !field.Contains("-"));
+        Map(m => m.Name).Validate(args => !args.Field.Contains("-"));
     }
 }
 ```
diff --git a/src/CsvHelper.Website/input/examples/type-conversion/custom-type-converter/index.md b/src/CsvHelper.Website/input/examples/type-conversion/custom-type-converter/index.md
@@ -18,7 +18,7 @@ Id,Name,Json
 ```cs
 void Main()
 {
-    using (var reader = new new StreamReader("path\\to\\file.csv"))
+    using (var reader = new StreamReader("path\\to\\file.csv"))
     using (var csv = new CsvReader(reader, CultureInfo.InvariantCulture))
     {
         // Register globally.
diff --git a/src/CsvHelper.Website/input/examples/type-conversion/type-converter-options/index.md b/src/CsvHelper.Website/input/examples/type-conversion/type-converter-options/index.md
@@ -7,7 +7,7 @@ Any option for these methods should be available through configuration.
 ###### Mapping Example
 
 ```cs
-public sealed class FooMap : ClassMap\<Foo\>
+public sealed class FooMap : ClassMap<Foo>
 {
     public FooMap()
     {
diff --git a/src/CsvHelper.Website/input/getting-started/index.md b/src/CsvHelper.Website/input/getting-started/index.md
@@ -105,7 +105,7 @@ is done against the property name. Both the header and the property name are ran
 header, they will now match. You can use this function to do other things such as remove
 whitespace or other characters.
 
-Let's say out CSV file doesn't have a header at all.
+Let's say our CSV file doesn't have a header at all.
 
 ```
 1,one
diff --git a/src/CsvHelper/Configuration/ClassMap.cs b/src/CsvHelper/Configuration/ClassMap.cs
@@ -346,7 +346,7 @@ protected virtual void AutoMapMembers(ClassMap map, CsvContext context, LinkedLi
 					continue;
 				}
 
-				if (!field.GetCustomAttributes(typeof(CompilerGeneratedAttribute), false).Any())
+				if (!Attribute.IsDefined(field, typeof(CompilerGeneratedAttribute), false))
 				{
 					fields.Add(ReflectionHelper.GetDeclaringField(type, field, flags));
 				}
@@ -357,7 +357,7 @@ protected virtual void AutoMapMembers(ClassMap map, CsvContext context, LinkedLi
 
 		foreach (var member in members)
 		{
-			if (member.GetCustomAttribute<IgnoreAttribute>() != null)
+			if (Attribute.IsDefined(member, typeof(IgnoreAttribute)))
 			{
 				// Ignore this member including its tree if it's a reference.
 				continue;
@@ -459,7 +459,7 @@ protected virtual void AutoMapConstructorParameters(ClassMap map, CsvContext con
 		{
 			var parameterMap = new ParameterMap(parameter);
 
-			if (parameter.GetCustomAttributes<IgnoreAttribute>(true).Any() || parameter.GetCustomAttributes<ConstantAttribute>(true).Any())
+			if (Attribute.IsDefined(parameter, typeof(IgnoreAttribute), true) || Attribute.IsDefined(parameter, typeof(ConstantAttribute), true))
 			{
 				// If there is an IgnoreAttribute or ConstantAttribute, we still need to add a map because a constructor requires
 				// all parameters to be present. A default value will be used later on.
diff --git a/src/CsvHelper/Configuration/CsvConfiguration.cs b/src/CsvHelper/Configuration/CsvConfiguration.cs
@@ -297,8 +297,8 @@ public static CsvConfiguration FromAttributes<T>(CultureInfo cultureInfo)
 	/// <exception cref="CultureNotFoundException">If the argument to the <see cref="CultureInfoAttribute"/> does not specify a supported culture.</exception>
 	public static CsvConfiguration FromAttributes(Type type)
 	{
-		var cultureInfoAttribute = (CultureInfoAttribute?)Attribute.GetCustomAttribute(type, typeof(CultureInfoAttribute));
-		if (cultureInfoAttribute == null)
+		var hasCultureInfoAttribute = Attribute.IsDefined(type, typeof(CultureInfoAttribute));
+		if (!hasCultureInfoAttribute)
 		{
 			throw new ConfigurationException($"A {nameof(CultureInfoAttribute)} is required on type '{type.Name}' to use this method.");
 		}
diff --git a/src/CsvHelper/CsvHelper.csproj b/src/CsvHelper/CsvHelper.csproj
@@ -8,7 +8,7 @@
 
 		<!-- Build -->
 		<AssemblyName>CsvHelper</AssemblyName>
-		<TargetFrameworks>net8.0;net7.0;net6.0;netstandard2.1;netstandard2.0;net48;net47;net462</TargetFrameworks>
+		<TargetFrameworks>net9.0;net8.0;netstandard2.1;netstandard2.0;net48;net47;net462</TargetFrameworks>
 		<!--<TargetFrameworks>net60</TargetFrameworks>-->
 		<LangVersion>latest</LangVersion>
 		<RootNamespace>CsvHelper</RootNamespace>
diff --git a/src/CsvHelper/CsvHelper.net9.0.v3.ncrunchproject b/src/CsvHelper/CsvHelper.net9.0.v3.ncrunchproject
@@ -0,0 +1,5 @@
+﻿<ProjectConfiguration>
+  <Settings>
+    <PreventSigningOfAssembly>True</PreventSigningOfAssembly>
+  </Settings>
+</ProjectConfiguration>
diff --git a/src/CsvHelper/CsvMode.cs b/src/CsvHelper/CsvMode.cs
@@ -12,23 +12,23 @@ namespace CsvHelper;
 public enum CsvMode
 {
 	/// <summary>
-	/// Uses RFC 4180 format (default).
+	/// Uses RFC 4180 format (default).<br/>
 	/// If a field contains a <see cref="CsvConfiguration.Delimiter"/> or <see cref="CsvConfiguration.NewLine"/>,
-	/// it is wrapped in <see cref="CsvConfiguration.Quote"/>s.
+	/// it is wrapped in <see cref="CsvConfiguration.Quote"/>s.<br/>
 	/// If quoted field contains a <see cref="CsvConfiguration.Quote"/>, it is preceded by <see cref="CsvConfiguration.Escape"/>.
 	/// </summary>
 	RFC4180 = 0,
 
 	/// <summary>
-	/// Uses escapes.
+	/// Uses escapes.<br/>
 	/// If a field contains a <see cref="CsvConfiguration.Delimiter"/>, <see cref="CsvConfiguration.NewLine"/>,
-	/// or <see cref="CsvConfiguration.Escape"/>, it is preceded by <see cref="CsvConfiguration.Escape"/>.
+	/// or <see cref="CsvConfiguration.Escape"/>, it is preceded by <see cref="CsvConfiguration.Escape"/>.<br/>
 	/// Newline defaults to \n.
 	/// </summary>
 	Escape,
 
 	/// <summary>
-	/// Doesn't use quotes or escapes.
+	/// Doesn't use quotes or escapes.<br/>
 	/// This will ignore quoting and escape characters. This means a field cannot contain a
 	/// <see cref="CsvConfiguration.Delimiter"/>, <see cref="CsvConfiguration.Quote"/>, or
 	/// <see cref="CsvConfiguration.NewLine"/>, as they cannot be escaped.
diff --git a/src/CsvHelper/CsvWriter.cs b/src/CsvHelper/CsvWriter.cs
@@ -506,9 +506,9 @@ public virtual async Task WriteRecordsAsync(IEnumerable records, CancellationTok
 		}
 		finally
 		{
-			if (enumerator is IDisposable en)
+			if (enumerator is IDisposable disposable)
 			{
-				en.Dispose();
+				disposable.Dispose();
 			}
 		}
 	}
@@ -566,9 +566,9 @@ public virtual async Task WriteRecordsAsync<T>(IEnumerable<T> records, Cancellat
 		}
 		finally
 		{
-			if (enumerator is IDisposable en)
+			if (enumerator is IDisposable disposable)
 			{
-				en.Dispose();
+				disposable.Dispose();
 			}
 		}
 	}
@@ -626,10 +626,7 @@ public virtual async Task WriteRecordsAsync<T>(IAsyncEnumerable<T> records, Canc
 		}
 		finally
 		{
-			if (enumerator is IDisposable en)
-			{
-				en.Dispose();
-			}
+			await enumerator.DisposeAsync().ConfigureAwait(false);
 		}
 	}
 
diff --git a/src/CsvHelper/ObjectCreator.cs b/src/CsvHelper/ObjectCreator.cs
diff --git a/src/CsvHelper/ReflectionHelper.cs b/src/CsvHelper/ReflectionHelper.cs
diff --git a/src/CsvHelper/TypeConversion/DefaultTypeConverter.cs b/src/CsvHelper/TypeConversion/DefaultTypeConverter.cs
diff --git a/tests/CsvHelper.Tests/CsvHelper.Tests.csproj b/tests/CsvHelper.Tests/CsvHelper.Tests.csproj
diff --git a/tests/CsvHelper.Tests/Mocks/ReaderRowMock.cs b/tests/CsvHelper.Tests/Mocks/ReaderRowMock.cs
diff --git a/tests/CsvHelper.Tests/Reading/NumberReadingTests.cs b/tests/CsvHelper.Tests/Reading/NumberReadingTests.cs
diff --git a/tests/CsvHelper.Tests/TypeConversion/NullableConverterTests.cs b/tests/CsvHelper.Tests/TypeConversion/NullableConverterTests.cs

Original file line number	Diff line number	Diff line change
`@@ -34,7 +34,7 @@ public class FooMap : ClassMap<Foo>`
`34`	`34`	`public FooMap()`
`35`	`35`	`{`
`36`	`36`	`Map(m => m.Id);`
`37`		`- Map(m => m.Name).Validate(field => !field.Contains("-"));`
	`37`	`+ Map(m => m.Name).Validate(args => !args.Field.Contains("-"));`
`38`	`38`	`}`
`39`	`39`	`}`
`40`	`40`	```
Original file line number	Diff line number	Diff line change
`@@ -18,7 +18,7 @@ Id,Name,Json`
`18`	`18`	```cs
`19`	`19`	`void Main()`
`20`	`20`	`{`
`21`		`- using (var reader = new new StreamReader("path\\to\\file.csv"))`
	`21`	`+ using (var reader = new StreamReader("path\\to\\file.csv"))`
`22`	`22`	`using (var csv = new CsvReader(reader, CultureInfo.InvariantCulture))`
`23`	`23`	`{`
`24`	`24`	`// Register globally.`
Original file line number	Diff line number	Diff line change
`@@ -7,7 +7,7 @@ Any option for these methods should be available through configuration.`
`7`	`7`	`###### Mapping Example`
`8`	`8`
`9`	`9`	```cs
`10`		`-public sealed class FooMap : ClassMap\<Foo\>`
	`10`	`+public sealed class FooMap : ClassMap<Foo>`
`11`	`11`	`{`
`12`	`12`	`public FooMap()`
`13`	`13`	`{`