Add mp_warning() and use it in place of warning() to allow redirecting console output.

Author: rdzman

CHANGES.md

@@ -5,6 +5,15 @@ Change history for MP-Test
 since 8.1
 ---------
 
+#### 8/4/26
+  - Use recently added `mp_warning()` in place of `warning()` everywhere to
+    allow redirecting of console output.
+  - Add `mp_warning()` function which can be used as a drop-in replacement for
+    `warning()` for throwing warnings, but not for querying/controling warning
+    status. By default it behaves identically, but can use an `mp.logger` object
+    to redirect the output to a file, or elsewhere via a custom `mp.logger`
+    subclass.
+
 #### 7/30/26
   - Use recently added `mp_printf()` in place of `fprintf()` everywhere to
     allow redirecting of console output.

README.md

@@ -290,6 +290,17 @@ particular function.
   object, or elsewhere via a custom `mp.logger` subclass. If the first
   argument is a file ID, it does not redirect anything.
 
+- __mp_warning__ — drop-in replacement for `warning()`
+  ```
+  mp_warning(msg)
+  mp_warning(format_str, arg1, ...)
+  ```
+  Optionally redirects the output of `warning()` to a file via an `mp.logger`
+  object, or elsewhere via a custom `mp.logger` subclass. Inputs are identical
+  to those of `warning()`. Note that this function is only for throwing a
+  warning, not querying or controlling warning status, and the on/off state
+  of a warning has no effect on redirected output.
+
 - __mp.logger_manager__ — manage redirection for `mp_disp()` and `mp_printf()`
   ```
   mp.logger.manager('init', 'path/to/my/log-file.txt')

docs/sphinx/source/functions/mp_warning.rst

@@ -0,0 +1,8 @@
+.. currentmodule:: mptest
+
+:raw-html:`<div style="float: right"><a href="https://github.com/MATPOWER/mptest/blob/master/lib/mp_warning.m" target=_blank><svg height="32" aria-hidden="true" viewBox="0 0 16 16" version="1.1" width="32" data-view-component="true" class="octicon octicon-mark-github v-align-middle color-fg-default"><path d="M8 0c4.42 0 8 3.58 8 8a8.013 8.013 0 0 1-5.45 7.59c-.4.08-.55-.17-.55-.38 0-.27.01-1.13.01-2.2 0-.75-.25-1.23-.54-1.48 1.78-.2 3.65-.88 3.65-3.95 0-.88-.31-1.59-.82-2.15.08-.2.36-1.02-.08-2.12 0 0-.67-.22-2.2.82-.64-.18-1.32-.27-2-.27-.68 0-1.36.09-2 .27-1.53-1.03-2.2-.82-2.2-.82-.44 1.1-.16 1.92-.08 2.12-.51.56-.82 1.28-.82 2.15 0 3.06 1.86 3.75 3.64 3.95-.23.2-.44.55-.51 1.07-.46.21-1.61.55-2.33-.66-.15-.24-.6-.83-1.23-.82-.67.01-.27.38.01.53.34.19.73.9.82 1.13.16.45.68 1.31 2.69.94 0 .67.01 1.3.01 1.49 0 .21-.15.45-.55.38A7.995 7.995 0 0 1 0 8c0-4.42 3.58-8 8-8Z"></path></svg></a></div>`
+
+mp_warning
+----------
+
+.. autofunction:: mp_warning

docs/sphinx/source/matlab-source/mptest/mp_warning.m

@@ -0,0 +1 @@
+../../../../../lib/mp_warning.m

docs/sphinx/source/reference.rst

@@ -34,6 +34,7 @@ optional functionality and to check the version of the installed MP-Test.
    functions/mptestver
    functions/mp_disp
    functions/mp_printf
+   functions/mp_warning
    classes/mp/logger
    functions/toggle_debug_mode
 

lib/+mp/logger.m

@@ -19,6 +19,7 @@
 %   * init - initialize logger object (open log file)
 %   * set_file - open log file, after closing any already open
 %   * printf - prints to log
+%   * warning - warnings to log
 %   * manage - handle actions forwarded from mp.logger.manager
 %   * finalize - finalize logger object (close log file)
 %   * manager - manage the logger object used by mp_printf and mp_disp
@@ -167,6 +168,52 @@
             end
         end
 
+        function obj = warning(obj, varargin)
+            % Warnings to log.
+            % ::
+            %
+            %   obj.warning(...)
+            %
+            % Inputs are identical to those of ``warning()``. Note, this
+            % function is only for throwing a warning, not querying or
+            % controlling warning status.
+
+            if nargin < 2
+                error('mp.logger.warning: no warning message');
+            else
+                if obj.fid > 0      %% warn to log file
+                    msg = sprintf(varargin{:});
+                    lastwarn(msg);
+                    st = dbstack('-completenames');
+                    if have_feature('matlab')
+                        fprintf(obj.fid, 'Warning: %s\n', msg);
+                        if length(st) > 0
+                            fprintf(obj.fid, '> ');
+                        end
+                        for k = 2:length(st)
+                            fprintf(obj.fid, 'In %s (line %d)\n', ...
+                                st(k).name, st(k).line);
+                        end
+                    else
+                        fprintf(obj.fid, 'warning: %s\n', msg);
+                        if length(st) > 0
+                            fprintf(obj.fid, 'warning: called from\n');
+                        end
+                        for k = 2:length(st)
+                            fprintf(obj.fid, '    %s at line %d column %d\n', ...
+                                st(k).name, st(k).line, st(k).column);
+                        end
+                        fprintf(obj.fid, '\n');
+                    end
+                    if obj.manual_flush
+                        fflush(obj.fid);
+                    end
+                else
+                    error('mp.logger.warning: log file not open');
+                end
+            end
+        end
+
         function varargout = manage(obj, action, varargin)
             % Handle actions forwarded from mp.logger.manager.
             % ::

lib/have_feature.m

@@ -110,7 +110,7 @@
 %     have_feature(cache, 'set_cache')
 
 %   MP-Test
-%   Copyright (c) 2004-2024, Power Systems Engineering Research Center (PSERC)
+%   Copyright (c) 2004-2026, Power Systems Engineering Research Center (PSERC)
 %   by Ray Zimmerman, PSERC Cornell
 %
 %   This file is part of MP-Test.
@@ -174,7 +174,7 @@
         %% check for feature
         fcn = ['have_feature_' tag];
         if isempty(which(fcn))
-            warning('have_feature: unknown functionality ''%s''', tag);
+            mp_warning('have_feature: unknown functionality ''%s''', tag);
             vstr = 'unknown';
         else
             [TorF, vstr, rdate] = feval(fcn);

lib/have_feature_matlab.m

@@ -7,7 +7,7 @@
 %   See also have_feature.
 
 %   MP-Test
-%   Copyright (c) 2004-2024, Power Systems Engineering Research Center (PSERC)
+%   Copyright (c) 2004-2026, Power Systems Engineering Research Center (PSERC)
 %   by Ray Zimmerman, PSERC Cornell
 %
 %   This file is part of MP-Test.
@@ -16,7 +16,7 @@
 
 v = ver('matlab');
 if length(v) > 1
-    warning('The built-in VER command is behaving strangely, probably as a result of installing a 3rd party toolbox in a directory named ''matlab'' on your path. Check each element of the output of ver(''matlab'') to find the offending toolbox, then move the toolbox to a more appropriately named directory.');
+    mp_warning('The built-in VER command is behaving strangely, probably as a result of installing a 3rd party toolbox in a directory named ''matlab'' on your path. Check each element of the output of ver(''matlab'') to find the offending toolbox, then move the toolbox to a more appropriately named directory.');
     v = v(1);
 end
 if ~isempty(v) && isfield(v, 'Version') && ~isempty(v.Version)

lib/mp_disp.m

@@ -6,6 +6,9 @@ function mp_disp(obj)
 %   mp_disp(something_to_be_displayed);
 %   mp.logger.manager('clear');
 %
+% Optionally redirects the output of ``disp()`` to a file via an mp.logger
+% object, or elsewhere via a custom mp.logger subclass.
+%
 % See also mp.logger.manager, mp.logger.
 
 %   MP-Test

lib/mp_printf.m

@@ -6,6 +6,10 @@ function mp_printf(varargin)
 %   mp_printf('A line of %s to be printed.\n', 'text');
 %   mp.logger.manager('clear');
 %
+% Optionally redirects the output of ``fprintf()`` to a file via an mp.logger
+% object, or elsewhere via a custom mp.logger subclass. If the first argument
+% is a file ID, it does not redirect anything.
+%
 % See also mp.logger.manager, mp.logger.
 
 %   MP-Test