`QuantityInfo`: internalizing the `UnitInfo` construction #1555

lipchev · 2025-04-21T05:35:28Z

QuantityInfo: internalizing the UnitInfo construction
QuantityInfo: introducing a delegate for constructing the quantity (required only for net standard)
QuantityInfo: introducing an optional ResourceDictionary
QuantityInfo: replacing the TUnit[] with an IReadOnlyCollection<TUnit>
UnitInfo: introducing a back-reference to the QuantityInfo (making the QuantityName [Obsolete])
IQuantity: added the QuantityInfo<TQuantity, TUnit>, the From(double, TUnit) method and default implementations for the non-generic properties
QuantityInfoLookup: added another collection for the quantity by type mapping (replacing the generated code in Quantity.g.s).
UnitAbbreviationsCache: ReadAbbreviationsFromResourceFile implemented using the provided ResourceManager (if available)
updating the QuantityInfo definitions for all quantities (introducing a concrete class, such as MassInfo) with helpers for creating a derived configuration
HowMuch upgraded to IQuantity<HowMuch, HowMuchUnit> (the original QuantityInfo is now abstract)
Quantity refactored the Parse / From* methods using the default QuantityParser / QuantityInfoLookup
Quantity replaced the ByName dictionary with an IReadOnlyDictionary
UnitsNet.csproj / UnitsNet.Tests.csproj: added some (specific) implicit usings

- QuantityInfo: introducing a delegate for constructing the quantity (required only for net standard) - QuantityInfo: introducing an optional ResourceDictionary - UnitInfo: introducing a back-reference to the QuantityInfo (making the QuantityName [Obsolete]) - IQuantity: added the QuantityInfo<TQuantity, TUnit>, the From(double, TUnit) method and default implementations for the non-generic properties - UnitAbbreviationsCache: ReadAbbreviationsFromResourceFile implemented using the provided ResourceDictionary (if available) - updating the QuantityInfo definitions for all quantities (introducing a concrete class, such as MassInfo) with helpers for creating a derried configuration - HowMuch upgraded to IQuantity<HowMuch, HowMuchUnit> (the original QuantityInfo is now abstract) - UnitsNet.csproj / UnitsNet.Tests.csproj: added some (specific) implicit usings

…e methods for dynamically adding a UnitInfo

lipchev · 2025-04-21T15:47:58Z

@angularsen The most breaking thing here should be the change from MassUnit[] to IReadOnlyCollection<MassUnit>: we still have the IReadOnlyList<UnitInfo>, so if anybody want to do a for-loop that's still an option, but in my opinion, having the indexer (backed by a dictionary) is more interesting than having 2 read-only lists, but if you want I could switch it.

Providing a delegate and resource dictionary in the QuantityInfo does look like we're mixing the domain with the infrastructure, but since we want to support nestandard2.0 this was the simplest way to have an all in one definition, that can support both internal and external quantities.

PS The UnitInfo is still missing the conversion expressions, that should be used by the UnitConverter, and we still don't have a way to configure/customize the UnitsNetSetup.Default, but for the rest of the classes (UnitParser, UnitAbbreviationsCache etc)- we're pretty close to my final version.

PS2 The new size is:

2.53 MB (2 661 376 bytes)

which is up from

2.18 MB (2 287 616 bytes)

but that would go down again, when I remove all the RegisterDefaultConversions and the switch expressions:

1.78 MB (1 867 776 bytes)

UnitsNet.Benchmark/Initializations/UnitAbbreviationsCacheInitializationBenchmarks.cs

UnitsNet.Benchmark/Initializations/QuantityInfoInitializationBenchmarks.cs

lipchev · 2025-04-23T04:54:29Z

UnitsNet/GeneratedCode/Quantities/Mass.g.cs

+            /// <summary>
+            ///     Creates a new instance of the <see cref="MassInfo"/> class with the default settings for the Mass quantity and a callback for customizing the default unit mappings.
+            /// </summary>
+            /// <param name="customizeUnits">
+            ///     A callback function for customizing the default unit mappings.
+            /// </param>
+            /// <returns>
+            ///     A new instance of the <see cref="MassInfo"/> class with the default settings.
+            /// </returns>
+            public static MassInfo CreateDefault(Func<IEnumerable<UnitDefinition<MassUnit>>, IEnumerable<IUnitDefinition<MassUnit>>> customizeUnits)
+            {
+                return new MassInfo(nameof(Mass), DefaultBaseUnit, customizeUnits(GetDefaultMappings()), new Mass(0, DefaultBaseUnit), DefaultBaseDimensions);
+            }


Ah, you might be wondering about this thing here (currently uncovered by tests). It allows us to include, exclude or re-configure certain units (not very useful In the current version, where the conversion expressions are still not available).

Here's how this is covered in #1544 : MassTestsBase.g.cs.

The problem is that this it uses these extensions, (tested here) which, I just realized, are using two generic type parameters, making them susceptible to the bug with ReSharper.

If you think we can Ignore and Continue (and you agree with the rest of the changes so far), then I can add them here.

PS Note that in #1544 I went to even further and (with the use of some dazzling re-directions) was able to make the default Mass.Info configurable from the UnitsNetSetup.DefaultConfigurationBuilder, but that's still ahead of us (should you decide to take the red pill 🤣 ).

FYI - the re-sharper bug was actually closed (as fixed in the EAP version)- I'm expecting the official version to come out next week or so (according to a post I saw 2 weeks ago).

ReSharper bug is apparently fixed in 2025.2 EAP 5, 2025.2 EAP 6

angularsen · 2025-04-24T19:04:10Z

@lipchev just a heads up that this week is crazy for me and I'm traveling this weekend, not sure I'll get around to much

github-actions · 2025-06-24T02:34:13Z

This PR is stale because it has been open 60 days with no activity. Remove stale label or comment or this will be closed in 7 days.

github-actions · 2025-07-01T02:42:45Z

This PR was automatically closed due to inactivity.

angularsen

Very nice, I like the overall direction. Mostly minor comments and suggestions that can be addressed later, I tried pushing fixes but don't have permission to push to your fork. Will push a few commits after merging this PR.

UnitsNet.Tests/UnitsNet.Tests.csproj

UnitsNet/CustomCode/Quantity.cs

UnitsNet/CustomCode/QuantityInfo/QuantityInfoExtensions.cs

UnitsNet/GeneratedCode/Quantity.g.cs

angularsen · 2025-07-25T17:35:00Z

UnitsNet/GeneratedCode/Quantities/Acceleration.g.cs

+        /// <summary>
+        ///     Provides detailed information about the <see cref="Acceleration"/> quantity, including its name, base unit, unit mappings, base dimensions, and conversion functions.
+        /// </summary>
+        public sealed class AccelerationInfo: QuantityInfo<Acceleration, AccelerationUnit>
        {


I'm a little on the fence on the usefulness of having a concrete class for each quantity's info, and we have 100+ quantities that will add to the binary size.

If it's about syntax, a type alias would achieve much the same.
I don't expect to pass AccelerationInfo around or something consumers of UnitsNet should think about.
For extensibility, it doesn't seem to offer much.

I gave it a go to refactor to private static factories, with minimal diff. Please take a look.
#1580

I think unless we actually need the concrete type for quantity info, let's just reuse the generics we already have to reduce generated code.

Fixup of #1555

lipchev added 2 commits April 21, 2025 08:32

Merge branch 'master' into quantity-info-definition

cae7d78

lipchev added the breaking-change label Apr 21, 2025

refactored the Quantity methods using the QuantityInfo and removed th…

b3844a6

…e methods for dynamically adding a UnitInfo

lipchev changed the title ~~QuantityInfo: internalizing the UnitInfo construction (WIP)~~ QuantityInfo: internalizing the UnitInfo construction Apr 21, 2025

updating the affected benchmarks

65ba6f6

lipchev commented Apr 23, 2025

View reviewed changes

UnitsNet.Benchmark/Initializations/UnitAbbreviationsCacheInitializationBenchmarks.cs Outdated Show resolved Hide resolved

adding the QuantityInfoInitializationBenchmarks

272252a

lipchev commented Apr 23, 2025

View reviewed changes

UnitsNet.Benchmark/Initializations/QuantityInfoInitializationBenchmarks.cs Outdated Show resolved Hide resolved

lipchev commented Apr 23, 2025

View reviewed changes

github-actions bot added the no-pr-activity label Jun 24, 2025

github-actions bot closed this Jul 1, 2025

angularsen reopened this Jul 25, 2025

angularsen approved these changes Jul 25, 2025

View reviewed changes

Merge branch 'master' into quantity-info-definition

1f504da

angularsen merged commit 48ac5df into angularsen:master Jul 25, 2025
1 check was pending

This was referenced Jul 25, 2025

refactor: Remove obsolete FromQuantityInfo method #1574

Merged

refactor: change DefaultQuantities to use property initializer #1575

Closed

refactor: rename to Quantity.DefaultProvider.Quantities #1576

Merged

angularsen added a commit that referenced this pull request Jul 25, 2025

refactor: Remove obsolete FromQuantityInfo method (#1574)

77ada0e

Fixup of #1555

lipchev pushed a commit that referenced this pull request Jul 25, 2025

refactor: rename to Quantity.DefaultProvider.Quantities (#1576)

d21e526

Fixup of #1555

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

Uh oh!

`QuantityInfo`: internalizing the `UnitInfo` construction #1555

`QuantityInfo`: internalizing the `UnitInfo` construction #1555

Uh oh!

lipchev commented Apr 21, 2025 •

edited

Loading

Uh oh!

lipchev commented Apr 21, 2025 •

edited

Loading

Uh oh!

Uh oh!

Uh oh!

lipchev Apr 23, 2025

Uh oh!

lipchev Jul 25, 2025

Uh oh!

angularsen Jul 25, 2025

Uh oh!

angularsen commented Apr 24, 2025 •

edited

Loading

Uh oh!

github-actions bot commented Jun 24, 2025

Uh oh!

github-actions bot commented Jul 1, 2025

Uh oh!

angularsen left a comment

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

angularsen Jul 25, 2025

Uh oh!

angularsen Jul 25, 2025

Uh oh!

Uh oh!

Uh oh!

QuantityInfo: internalizing the UnitInfo construction #1555

QuantityInfo: internalizing the UnitInfo construction #1555

Uh oh!

Conversation

lipchev commented Apr 21, 2025 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Uh oh!

lipchev commented Apr 21, 2025 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Uh oh!

Uh oh!

Uh oh!

lipchev Apr 23, 2025

Choose a reason for hiding this comment

Uh oh!

lipchev Jul 25, 2025

Choose a reason for hiding this comment

Uh oh!

angularsen Jul 25, 2025

Choose a reason for hiding this comment

Uh oh!

angularsen commented Apr 24, 2025 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Uh oh!

github-actions bot commented Jun 24, 2025

Uh oh!

github-actions bot commented Jul 1, 2025

Uh oh!

angularsen left a comment

Choose a reason for hiding this comment

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

angularsen Jul 25, 2025

Choose a reason for hiding this comment

Uh oh!

angularsen Jul 25, 2025

Choose a reason for hiding this comment

Uh oh!

Uh oh!

Uh oh!

`QuantityInfo`: internalizing the `UnitInfo` construction #1555

`QuantityInfo`: internalizing the `UnitInfo` construction #1555

lipchev commented Apr 21, 2025 •

edited

Loading

lipchev commented Apr 21, 2025 •

edited

Loading

angularsen commented Apr 24, 2025 •

edited

Loading