Deprecated CmdResult helper class and promoted CommandResult #451
Conversation
These classes are subtly different, particularly in terms of their truthiness. CmdResult - attributes: out, err, war - truthy: if err is falsy CommandResult - attributes: stdout, stderr, data - truthy: if err is falsy AND data is not None So CmdResult was oriented to provide essentially info, error, and warning messages to the user (typically as stirngs), whereas CommandResult is geared towards providing info and error messages to the user as strings in addition to data to the user in a command-specific format which is arbitrary other than it should never be None if the command succeeds.
Codecov Report
@@ Coverage Diff @@
## master #451 +/- ##
==========================================
- Coverage 90.22% 90.18% -0.04%
==========================================
Files 10 10
Lines 2741 2741
==========================================
- Hits 2473 2472 -1
- Misses 268 269 +1
Continue to review full report at Codecov.
|
|
I would appreciate any feedback and opinions. These two classes are slightly different, so it isn't exactly like the new one is clearly 100% better than the now deprecated one in all cases, though I do think it is better in general. But they exist primarily in helper roles and the old one isn't used within cmd2 itself, so it kind of feels awkward to leave it around. As long as everyone thinks this is a good path forward I'm happy with the changes. |
|
@kmvanbrunt @kotfu @anselor |
|
@tleonhardt |
These classes are subtly different, particularly in terms of their truthiness.
CmdResult
CommandResult
So CmdResult was oriented to provide essentially info, error, and warning messages to the user (typically as stirngs), whereas CommandResult is geared towards providing info and error messages to the user as strings in addition to data to the user in a command-specific format which is arbitrary other than it should never be None if the command succeeds.
This closes #449