Allow for an option to close other outputs for all scripts in pyrevit settings #2793
+227
−22
There are no files selected for viewing
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
|
|
@@ -35,6 +35,12 @@ public enum PyRevitLogLevels | |
| Debug | ||
| } | ||
|
|
||
| public enum OutputCloseMode | ||
| { | ||
| CurrentCommand, | ||
| CloseAll | ||
| } | ||
|
|
||
| public static class PyRevitConfigs | ||
| { | ||
| private static readonly Logger logger = LogManager.GetCurrentClassLogger(); | ||
|
|
@@ -505,6 +511,45 @@ public static void SetLoadBetaTools(bool state) | |
| cfg.SetValue(PyRevitConsts.ConfigsCoreSection, PyRevitConsts.ConfigsLoadBetaKey, state); | ||
| } | ||
|
|
||
| // close other outputs config | ||
| public static bool GetCloseOtherOutputs() | ||
| { | ||
| var cfg = GetConfigFile(); | ||
| var status = cfg.GetValue(PyRevitConsts.ConfigsCoreSection, PyRevitConsts.ConfigsCloseOtherOutputsKey); | ||
| return status != null ? bool.Parse(status) : PyRevitConsts.ConfigsCloseOtherOutputsDefault; | ||
| } | ||
|
|
||
| public static void SetCloseOtherOutputs(bool state) | ||
| { | ||
| var cfg = GetConfigFile(); | ||
| cfg.SetValue(PyRevitConsts.ConfigsCoreSection, PyRevitConsts.ConfigsCloseOtherOutputsKey, state); | ||
| } | ||
|
|
||
| public static OutputCloseMode GetCloseOutputMode() | ||
| { | ||
| var cfg = GetConfigFile(); | ||
| var raw = cfg.GetValue(PyRevitConsts.ConfigsCoreSection, PyRevitConsts.ConfigsCloseOutputModeKey); | ||
|
|
||
| var s = (raw ?? PyRevitConsts.ConfigsCloseOutputModeDefault).Trim().Trim('"', '\''); | ||
|
There was a problem hiding this comment. @dosymep is there a better way than trimming the config value ? There was a problem hiding this comment. As far as I remember, you don't need to trim it yourself, it should do it automatically There was a problem hiding this comment. The string trimming logic with both quotation marks seems unusual and may indicate a configuration parsing issue. The standard pyRevit configuration pattern doesn't typically require quote trimming. Consider whether this complexity is necessary or if it masks an underlying issue. var s = (raw ?? PyRevitConsts.ConfigsCloseOutputModeDefault).Trim();actionsFeedback: Rate this comment to help me improve future code reviews:
There was a problem hiding this comment. remove trim, the pyRevit library trimmed values by default There was a problem hiding this comment. public static OutputCloseMode GetCloseOutputMode()
{
var cfg = GetConfigFile();
var raw = cfg.GetValue(PyRevitConsts.ConfigsCoreSection, PyRevitConsts.ConfigsCloseOutputModeKey);
return Enum.TryParse<OutputCloseMode>(raw, true, out OutputCloseMode outCloseMode)
? outCloseMode
: OutputCloseMode.CurrentCommand;
} |
||
|
|
||
| if (s.Equals(PyRevitConsts.ConfigsCloseOutputModeCloseAll, StringComparison.InvariantCultureIgnoreCase)) | ||
| { | ||
| return OutputCloseMode.CloseAll; | ||
| } | ||
|
|
||
| return OutputCloseMode.CurrentCommand; | ||
| } | ||
|
|
||
| public static void SetCloseOutputMode(OutputCloseMode mode) | ||
| { | ||
| var cfg = GetConfigFile(); | ||
| var value = (mode == OutputCloseMode.CloseAll) | ||
| ? PyRevitConsts.ConfigsCloseOutputModeCloseAll | ||
| : PyRevitConsts.ConfigsCloseOutputModeCurrentCommand; | ||
|
|
||
| cfg.SetValue(PyRevitConsts.ConfigsCoreSection, PyRevitConsts.ConfigsCloseOutputModeKey, value); | ||
| } | ||
|
Comment on lines
+543
to
+551
There was a problem hiding this comment. public static void SetCloseOutputMode(OutputCloseMode outputCloseMode)
{
var cfg = GetConfigFile();
cfg.SetValue(PyRevitConsts.ConfigsCoreSection, PyRevitConsts.ConfigsCloseOutputModeKey, outputCloseMode.ToString());
} |
||
|
|
||
| // cpythonengine | ||
| public static int GetCpythonEngineVersion() | ||
| { | ||
|
|
||
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
|
|
@@ -305,31 +305,47 @@ def load_beta(self, state): | |
| def output_close_others(self): | ||
| """Whether to close other output windows.""" | ||
| return self.core.get_option( | ||
| CONSTS.ConfigsCloseOtherOutputsKey, | ||
| default_value=CONSTS.ConfigsCloseOtherOutputsDefault, | ||
| ) | ||
|
|
||
| @output_close_others.setter | ||
| def output_close_others(self, state): | ||
| self.core.set_option( | ||
| CONSTS.ConfigsCloseOtherOutputsKey, | ||
| value=state | ||
| ) | ||
|
|
||
| @property | ||
| def output_close_mode_enum(self): | ||
| """Output window closing mode as enum (CurrentCommand | CloseAll).""" | ||
| value = self.core.get_option( | ||
| CONSTS.ConfigsCloseOutputModeKey, | ||
| default_value=CONSTS.ConfigsCloseOutputModeDefault, | ||
| ) | ||
| if not value: | ||
| value = CONSTS.ConfigsCloseOutputModeDefault | ||
|
|
||
| value_lc = str(value).lower() | ||
|
|
||
| if value_lc == str(CONSTS.ConfigsCloseOutputModeCloseAll).lower(): | ||
| return PyRevit.OutputCloseMode.CloseAll | ||
| else: | ||
| return PyRevit.OutputCloseMode.CurrentCommand | ||
|
|
||
| @output_close_mode_enum.setter | ||
| def output_close_mode_enum(self, mode): | ||
| """Store string in INI, mapped from enum.""" | ||
| if mode == PyRevit.OutputCloseMode.CloseAll: | ||
| self.core.set_option( | ||
| CONSTS.ConfigsCloseOutputModeKey, | ||
| value=CONSTS.ConfigsCloseOutputModeCloseAll | ||
| ) | ||
| else: | ||
| self.core.set_option( | ||
| CONSTS.ConfigsCloseOutputModeKey, | ||
| value=CONSTS.ConfigsCloseOutputModeCurrentCommand | ||
|
Comment on lines
+336
to
+347
There was a problem hiding this comment. @property
def output_close_mode(self):
"""Output window closing mode as enum (CurrentCommand | CloseAll)."""
value = self.core.get_option(
CONSTS.ConfigsCloseOutputModeKey,
default_value=CONSTS.ConfigsCloseOutputModeDefault,
)
if System.Enum.TryParse[PyRevit.OutputCloseMode](value, true, out PyRevit.OutputCloseMode output_close_mode):
return output_close_mode
return PyRevit.OutputCloseMode.CurrentCommand
@output_close_mode.setter
def output_close_mode(self, output_close_mode):
"""Store string in INI, mapped from enum."""
self.core.set_option(
CONSTS.ConfigsCloseOutputModeKey,
value=str(output_close_mode)
)There was a problem hiding this comment. I renamed methods (remove |
||
| ) | ||
|
Comment on lines
320
to
348
There was a problem hiding this comment. @dosymep With enum, I had to deal with mapping somewhere. There was a problem hiding this comment. I think it's good, I hope in the future I will rewrite all the code for working with settings, and there will be a more convenient option There was a problem hiding this comment. remove only the enum suffix in name, I don't think users need to see it |
||
|
|
||
| @property | ||
| def cpython_engine_version(self): | ||
|
|
||
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Using
BeginInvokefor UI marshalling may introduce unnecessary delay. Consider whether the console closing operation needs to be asynchronous or ifInvoke(synchronous) would be more appropriate for immediate feedback.The current implementation may cause timing issues where the new console opens before others finish closing.
actions
Feedback: Rate this comment to help me improve future code reviews: