Extra python units (#434)

phlptp · pre-commit-ci[bot] · web-flow · commit 6ba9541f4fa4 · 2026-03-12T06:54:49.000-07:00
* add python methods for generating units from strings for the extra unit standard r20, x12,dod * add some tests for the x12_unit_string and r20_unit_string methods * [pre-commit.ci] auto fixes from pre-commit.com hooks for more information, see https://pre-commit.ci * update clang-tidy to clang 19 * fix clang tidy issues * [pre-commit.ci] auto fixes from pre-commit.com hooks for more information, see https://pre-commit.ci * more clang-tidy fixes * [pre-commit.ci] auto fixes from pre-commit.com hooks for more information, see https://pre-commit.ci * more clang-tidy fixes and cppcheck suppressions * [pre-commit.ci] auto fixes from pre-commit.com hooks for more information, see https://pre-commit.ci * more clang tidy * [pre-commit.ci] auto fixes from pre-commit.com hooks for more information, see https://pre-commit.ci * more clang-tidy updates * clang-tidy fixes * [pre-commit.ci] auto fixes from pre-commit.com hooks for more information, see https://pre-commit.ci * some additional clang-tidy fixes * ignore clang-tidy line * update r20_conv headers for clang-tidy * more clang-tidy * cleanup clang-tidy for tests * try to figure out why the test .clang-tidy isn't being used * .clang-tidy fixes * remove misc category from test clang-tidy * more clang-tidy * [pre-commit.ci] auto fixes from pre-commit.com hooks for more information, see https://pre-commit.ci * more clang-tidy * more clang-tidy * [pre-commit.ci] auto fixes from pre-commit.com hooks for more information, see https://pre-commit.ci * more clang-tidy * [pre-commit.ci] auto fixes from pre-commit.com hooks for more information, see https://pre-commit.ci * remove modernize type traits since it is not compatible with C++11 * more clang-tidy fixes --------- Co-authored-by: pre-commit-ci[bot] <66853113+pre-commit-ci[bot]@users.noreply.github.com>
diff --git a/.clang-tidy b/.clang-tidy
@@ -21,6 +21,7 @@ Checks: "
   -bugprone-easily-swappable-parameters,
   misc-*,
   -misc-no-recursion,
+  -misc-use-anonymous-namespace,
   cppcoreguidelines-*,
   -cppcoreguidelines-narrowing-conversions,
   -cppcoreguidelines-avoid-magic-numbers,
@@ -37,6 +38,7 @@ Checks: "
   -readability-magic-numbers,
   -readability-identifier-length,
   -readability-function-cognitive-complexity,
+  -readability-avoid-nested-conditional-operator,
   performance-*
   "
 
@@ -58,6 +60,7 @@ WarningsAsErrors: "
   -bugprone-easily-swappable-parameters,
   misc-*,
   -misc-no-recursion,
+  -misc-use-anonymous-namespace,
   cppcoreguidelines-*,
   -cppcoreguidelines-narrowing-conversions,
   -cppcoreguidelines-avoid-magic-numbers,
@@ -71,6 +74,7 @@ WarningsAsErrors: "
   -readability-magic-numbers,
   -readability-identifier-length,
   -readability-function-cognitive-complexity,
+  -readability-avoid-nested-conditional-operator,
   performance-*
   "
 
diff --git a/.github/actions/quick_cmake/action.yml b/.github/actions/quick_cmake/action.yml
@@ -13,7 +13,7 @@ runs:
   using: composite
   steps:
     - name: CMake ${{ inputs.cmake-version }}
-      uses: jwlawson/actions-setup-cmake@v1.13
+      uses: jwlawson/actions-setup-cmake@v2.1.1
       with:
         cmake-version: "${{ inputs.cmake-version }}"
     - run: |
diff --git a/azure-pipelines.yml b/azure-pipelines.yml
@@ -26,7 +26,7 @@ jobs:
       CMAKE_BUILD_PARALLEL_LEVEL: 1
     pool:
       vmImage: 'ubuntu-latest'
-    container: helics/buildenv:clang14-builder
+    container: helics/buildenv:clang19-builder
     steps:
       - template: .ci/azure-build.yml
       - script: git diff --exit-code --color
diff --git a/config/cppcheck_suppressions.txt b/config/cppcheck_suppressions.txt
@@ -1,15 +1,15 @@
 unusedFunction:units/x12_conv.cpp:1024
 unusedFunction:units/x12_conv.cpp:1009
-passedByValue:units/units.cpp:224
+passedByValue:units/units.cpp:234
 passedByValue:units/units.cpp:1160
 passedByValue:units/units.cpp:1177
-passedByValue:units/units.cpp:3069
+passedByValue:units/units.cpp:3082
 passedByValue:units/units.hpp:413
-passedByValue:units/units.hpp:590
-passedByValue:units/units.hpp:1020
-passedByValue:units/units.hpp:1032
+passedByValue:units/units.hpp:593
+passedByValue:units/units.hpp:1026
+passedByValue:units/units.hpp:1038
 returnByReference:units/units.hpp:363
-returnByReference:units/units.hpp:576
-returnByReference:units/units.hpp:1017
-returnByReference:units/units.hpp:1246
-returnByReference:units/units.hpp:1485
+returnByReference:units/units.hpp:579
+returnByReference:units/units.hpp:1023
+returnByReference:units/units.hpp:1252
+returnByReference:units/units.hpp:1494
diff --git a/docs/details/commodities.rst b/docs/details/commodities.rst
@@ -90,7 +90,7 @@ Normal Commodity with Form Factor
 =============================
 Frequently commodities come in a specific form factor.  With a form factor code in place this can represent a form factor independent of the actual commodity material.  For example a drum of oil vs a drum of gasoline.
   the container is wrapped in a 8-bit code bits 21-28.  The commodity itself is contained in bits 0-20.
-  The bit codes for packaging is 001[FFFFFFFF][CCCCCCC][CCCCCCC][CCCCCCC].  To the extent possible the form factor codes in use are those used in recommendation 20 of international trade for use in conjunction with harmonized code.  This covers the trade of goods but in general is insufficient to cover all the required packaging modes necessary for general description so it is not used exactly. The codes 0-99 if used correspond to codes used in recommendation 20.  The way this is a encoded is the lowest 7 bits correspond to the recommendation if the value < 99 since that is a 2 digit decimal numerical code.  Numbers 100-127 and 228-255 are local user definitions defined as required for other purposes.  Numbers 128 to 227 correspond to alternate names for recommendation 20 codes, this is to disambiguate strings when converting to and from string representations.   In Rec 20 codes 70-79 are reserved for future use but may be used in the units library as needed.
+  The bit codes for packaging is 001[FFFFFFFF][CCCCCCC][CCCCCCC][CCCCCCC].  To the extent possible the form factor codes in use are those used in recommendation 21 of international trade for use in conjunction with harmonized code.  This covers the trade of goods but in general is insufficient to cover all the required packaging modes necessary for general description so it is not used exactly. The codes 0-99 if used correspond to codes used in recommendation 21.  The way this is a encoded is the lowest 7 bits correspond to the recommendation if the value < 99 since that is a 2 digit decimal numerical code.  Numbers 100-127 and 228-255 are local user definitions defined as required for other purposes.  Numbers 128 to 227 correspond to alternate names for recommendation 21 codes, this is to disambiguate strings when converting to and from string representations.   In Rec 21 codes 70-79 are reserved for future use but may be used in the units library as needed.
 
 Normal Commodity
 ============================
diff --git a/python/units_llnl/__init__.py b/python/units_llnl/__init__.py
@@ -6,6 +6,11 @@
     convert,
     convert_pu,
     default_unit,
+    x12_unit,
+    x12_unit_string,
+    dod_unit,
+    r20_unit,
+    r20_unit_string,
     add_user_defined_unit,
     defined_units_from_file,
     __doc__,
diff --git a/python/units_python.cpp b/python/units_python.cpp
@@ -732,7 +732,12 @@ NB_MODULE(units_llnl_ext, mod)
                             units::precise::generate_custom_count_unit(
                                   static_cast<std::uint16_t>(value));
                     } else {
-                        def = def * (units::default_unit(key).pow(value));
+                        const auto base_unit = units::default_unit(key);
+                        if (!units::is_valid(base_unit)) {
+                            throw std::invalid_argument(
+                                "Invalid dimension key in composition: " + key);
+                        }
+                        def = def * (base_unit.pow(value));
                     }
                 }
                 new (dim) Dimension{def};
@@ -934,6 +939,28 @@ NB_MODULE(units_llnl_ext, mod)
         "default_unit",
         &units::default_unit,
         "get the default unit to use for a particular type of measurement");
+#ifndef UNITS_DISABLE_EXTRA_UNIT_STANDARDS
+    mod.def(
+        "x12_unit",
+        &units::x12_unit,
+        "generate a Unit from an ANSI X12 unit code string");
+    mod.def(
+        "x12_unit_string",
+        &units::x12_unit_string,
+        "generate an ANSI X12 unit code string from a matching Unit");
+    mod.def(
+        "dod_unit",
+        &units::dod_unit,
+        "generate a Unit from a US DOD unit code string");
+    mod.def(
+        "r20_unit",
+        &units::r20_unit,
+        "generate a Unit from an UN recommendation 20 unit code string");
+    mod.def(
+        "r20_unit_string",
+        &units::r20_unit_string,
+        "generate an UN recommendation 20 unit code string from a matching Unit");
+#endif
     mod.def(
         "add_user_defined_unit",
         [](const char* unit_name, const units::precise_unit& unit_definition) {
diff --git a/test/.clang-tidy b/test/.clang-tidy
@@ -14,6 +14,7 @@ Checks: "
   modernize*,
   -modernize-pass-by-value,
   -modernize-use-trailing-return-type,
+  -modernize-type-traits,
   clang-analyzer-*,
   bugprone-*,
   -bugprone-narrowing-conversions,
@@ -24,20 +25,22 @@ Checks: "
   readability-*,
   -readability-magic-numbers,
   -readability-identifier-length,
-  performance-*
+  -readability-avoid-nested-conditional-operator,
+  performance-*,
   "
 
 WarningsAsErrors: "
   -*,
   google-*,
   -google-runtime-int,
   -google-runtime-references,
-  -google-build-using-namespace
+  -google-build-using-namespace,
   llvm-include-order,
   llvm-namespace-comment,
   modernize*,
   -modernize-pass-by-value,
   -modernize-use-trailing-return-type,
+  -modernize-type-traits,
   clang-analyzer-*,
   bugprone-*,
   -bugprone-narrowing-conversions,
@@ -46,12 +49,12 @@ WarningsAsErrors: "
   readability-*,
   -readability-magic-numbers,
   -readability-identifier-length,
-  performance-*
+  -readability-avoid-nested-conditional-operator,
+  performance-*,
   "
 
-HeaderFilterRegex: "*test.*cpp"
+HeaderFilterRegex: "test.*cpp"
 
-AnalyzeTemporaryDtors: false
 CheckOptions:
   - key: cert-dcl59-cpp.HeaderFileExtensions
     value: h,hh,hpp,hxx
diff --git a/test/fuzz_issue_tests.cpp b/test/fuzz_issue_tests.cpp
@@ -263,7 +263,7 @@ TEST(fuzzFailures, rtripSingleProblems)
     auto u1 = unit_from_string(cdata);
     if (!is_error(u1)) {
         auto str = to_string(u1);
-        std::cout << str << std::endl;
+        std::cout << str << '\n';
         auto u2 = unit_from_string(str);
         EXPECT_FALSE(is_error(u2));
         if (u2 == u1) {
diff --git a/test/python/test_units.py b/test/python/test_units.py
@@ -273,3 +273,17 @@ class val1:
     assert v2.value1 == v.value1
     v.value1 = u.Unit("50 m")
     assert v2.value1 == u.Unit("10 m")
+
+
+def test_x12_unit_string_round_trip():
+    code = u.x12_unit_string(u.x12_unit("17"))
+    assert code != ""
+    assert u.x12_unit(code).is_exactly_the_same(u.x12_unit("17"))
+    assert u.x12_unit_string(u.Unit("error")) == ""
+
+
+def test_r20_unit_string_round_trip():
+    code = u.r20_unit_string(u.r20_unit("A65"))
+    assert code != ""
+    assert u.r20_unit(code).is_exactly_the_same(u.r20_unit("A65"))
+    assert u.r20_unit_string(u.Unit("error")) == ""
diff --git a/test/test_google_units.cpp b/test/test_google_units.cpp
@@ -103,7 +103,7 @@ TEST(googleUnits, unitNames)
         }
         if (invalidMatches > 0) {
             std::cout << "Unable to match " << invalidMatches << " units "
-                      << std::endl;
+                      << '\n';
         }
     }
 }
diff --git a/test/test_measurement_strings.cpp b/test/test_measurement_strings.cpp
@@ -82,7 +82,10 @@ TEST(PreciseMeasurement, countAddition)
     auto m3 = 1.0 * precise::Bq;
 
     auto m4 = m1 + m2 + m3;
+    EXPECT_TRUE(is_valid(m4));
     auto str = to_string(m4);
+    // string  should probably be 3 Hz but that may change
+    EXPECT_LT(str.size(), 6);
 }
 
 TEST(MeasurementToString, one)
diff --git a/test/test_r20.cpp b/test/test_r20.cpp
@@ -140,4 +140,10 @@ TEST(r20, units)
             1.0, mass::tonne, units::commodities::packaging::theoretical));
 
     EXPECT_FALSE(is_valid(units::r20_unit("chaos")));
+
+    auto r20_code = units::r20_unit_string(units::r20_unit("A65"));
+    EXPECT_FALSE(r20_code.empty());
+    EXPECT_TRUE(
+        units::r20_unit(r20_code).is_exactly_the_same(units::r20_unit("A65")));
+    EXPECT_EQ(units::r20_unit_string(units::precise::invalid), "");
 }
diff --git a/test/test_udunits.cpp b/test/test_udunits.cpp
@@ -20,7 +20,7 @@ TEST(UDUNITS, acceptedNameSymbols)
 {
     tinyxml2::XMLDocument doc;
     auto err = doc.LoadFile(TEST_FILE_FOLDER "/UDUNITS2/udunits2-accepted.xml");
-    ASSERT_FALSE(err) << err << std::endl;
+    ASSERT_FALSE(err) << err << '\n';
     auto cs = doc.FirstChildElement("unit-system")->FirstChildElement("unit");
     int failConvert = 0;
     while (cs != nullptr) {
@@ -76,7 +76,7 @@ TEST(UDUNITS, acceptedAlias)
 {
     tinyxml2::XMLDocument doc;
     auto err = doc.LoadFile(TEST_FILE_FOLDER "/UDUNITS2/udunits2-accepted.xml");
-    ASSERT_FALSE(err) << err << std::endl;
+    ASSERT_FALSE(err) << err << '\n';
     auto cs = doc.FirstChildElement("unit-system")->FirstChildElement("unit");
     int failConvert{0};
     while (cs != nullptr) {
@@ -139,7 +139,7 @@ TEST(UDUNITS, derivedNameSymbols)
 {
     tinyxml2::XMLDocument doc;
     auto err = doc.LoadFile(TEST_FILE_FOLDER "/UDUNITS2/udunits2-derived.xml");
-    ASSERT_FALSE(err) << err << std::endl;
+    ASSERT_FALSE(err) << err << '\n';
     auto cs = doc.FirstChildElement("unit-system")->FirstChildElement("unit");
     int failConvert = 0;
     while (cs != nullptr) {
@@ -200,7 +200,7 @@ TEST(UDUNITS, derivedAlias)
 {
     tinyxml2::XMLDocument doc;
     auto err = doc.LoadFile(TEST_FILE_FOLDER "/UDUNITS2/udunits2-derived.xml");
-    ASSERT_FALSE(err) << err << std::endl;
+    ASSERT_FALSE(err) << err << '\n';
     auto cs = doc.FirstChildElement("unit-system")->FirstChildElement("unit");
     int failConvert = 0;
     while (cs != nullptr) {
@@ -265,7 +265,7 @@ TEST(UDUNITS, commonAlias)
 {
     tinyxml2::XMLDocument doc;
     auto err = doc.LoadFile(TEST_FILE_FOLDER "/UDUNITS2/udunits2-common.xml");
-    ASSERT_FALSE(err) << err << std::endl;
+    ASSERT_FALSE(err) << err << '\n';
     auto cs = doc.FirstChildElement("unit-system")->FirstChildElement("unit");
     int failConvert{0};
     int mismatchUnit{0};
diff --git a/test/test_unit_ops.cpp b/test/test_unit_ops.cpp
@@ -165,6 +165,7 @@ TEST(unitOps, valid)
     EXPECT_FALSE(is_valid(invalid));
     EXPECT_TRUE(is_valid(defunit));
     EXPECT_TRUE(is_valid(V));
+    EXPECT_TRUE(is_valid(unit(10.0, invalid.base_units())));
     EXPECT_TRUE(is_valid(unit(std::numeric_limits<double>::quiet_NaN(), m)));
     EXPECT_FALSE(is_valid(
         unit(std::numeric_limits<double>::quiet_NaN(), invalid.base_units())));
@@ -390,9 +391,9 @@ while (diff < 2.75e-6)
 
     std::cout << "diff (" << diff << ") compares "
               << ((u1 == u2) ? std::string("equal") : std::string("not equal"))
-<< std::endl; std::cout << "diff (-" << diff << ") compares "
+<< '\n'; std::cout << "diff (-" << diff << ") compares "
               << ((u1 == u2) ? std::string("equal") : std::string("not equal"))
-<< std::endl;
+<< '\n';
 
     diff += 1e-8;
 }
@@ -590,6 +591,7 @@ TEST(preciseUnitOps, valid)
     EXPECT_FALSE(is_valid(precise::invalid));
     EXPECT_TRUE(is_valid(precise::defunit));
     EXPECT_TRUE(is_valid(precise::V));
+    EXPECT_TRUE(is_valid(precise_unit(10.0, precise::invalid.base_units())));
     EXPECT_TRUE(is_valid(
         precise_unit(std::numeric_limits<double>::quiet_NaN(), precise::m)));
     EXPECT_FALSE(is_valid(precise_unit(
@@ -762,9 +764,9 @@ auto u2 = unit(start + diff, V);
 auto u3 = unit(start - diff, V);
 
 std::cout << "diff (" << diff << ") compares "
-<< ((u1 == u2) ? std::string("equal") : std::string("not equal")) << std::endl;
+<< ((u1 == u2) ? std::string("equal") : std::string("not equal")) << '\n';
 std::cout << "diff (-" << diff << ") compares "
-<< ((u1 == u2) ? std::string("equal") : std::string("not equal")) << std::endl;
+<< ((u1 == u2) ? std::string("equal") : std::string("not equal")) << '\n';
 
 diff += 1e-8;
 }
diff --git a/test/test_x12.cpp b/test/test_x12.cpp
@@ -177,8 +177,6 @@ TEST(x12, X12R20MappingVerification)
 
         // Parse CSV line (handle quoted fields)
         std::vector<std::string> fields;
-        std::stringstream ss(line);
-        std::string field;
         bool in_quotes = false;
         std::string current_field;
 
@@ -265,4 +263,7 @@ TEST(x12, units)
             100.0, units::precise::lb, units::commodities::packaging::drum));
 
     EXPECT_FALSE(is_valid(units::x12_unit("chaos")));
+
+    EXPECT_EQ(units::x12_unit_string(units::x12_unit("17")), "17");
+    EXPECT_EQ(units::x12_unit_string(units::precise::invalid), "");
 }
diff --git a/units/commodities.cpp b/units/commodities.cpp
@@ -5,17 +5,15 @@ See the top-level NOTICE for additional details. All rights reserved.
 SPDX-License-Identifier: BSD-3-Clause
 */
 #include "commodity_conversion_maps.hpp"
+#include "commodity_definitions.hpp"
 #include "units.hpp"
+#include "units_decl.hpp"
 #include <algorithm>
-#include <array>
 #include <atomic>
 #include <cctype>
-#include <cstring>
-#include <iomanip>
-#include <iostream>
-#include <sstream>
+#include <cstdint>
+#include <cstdlib>
 #include <string>
-#include <tuple>
 #include <unordered_map>
 
 /*
@@ -196,7 +194,7 @@ namespace hashcodes {
     static constexpr std::uint32_t firstH{37}; /* also prime */
 }  // namespace hashcodes
 
-uint32_t stringHash(const std::string& str)
+static uint32_t stringHash(const std::string& str)
 {
     std::uint32_t hash{hashcodes::firstH};
     for (auto c : str) {
diff --git a/units/r20_conv.cpp b/units/r20_conv.cpp
diff --git a/units/unit_definitions.hpp b/units/unit_definitions.hpp
diff --git a/units/units.cpp b/units/units.cpp
diff --git a/units/units.hpp b/units/units.hpp
diff --git a/units/units_decl.hpp b/units/units_decl.hpp
diff --git a/units/units_util.hpp b/units/units_util.hpp
diff --git a/units/x12_conv.cpp b/units/x12_conv.cpp
diff --git a/webserver/unit_web_server.cpp b/webserver/unit_web_server.cpp
