<p>第二个例子是最好的方法,所有的东西都封装在类中。<code>@staticmethod</code>方法没有我能想到的优点——一次只创建一个实例的类没有任何问题。在</p>
<p>全局<code>settings = Settings()</code>赋值应该从<code>plugin_loaded()</code>内部调用,以确保stapi已就绪,否则{<cd4>}可能会失败。在</p>
<p>应该使用回调,以便在用户更改设置时不需要重新启动升华文本来更新设置的值。这些应该在<code>plugin_unloaded()</code>中删除,以防用户卸载插件。在</p>
<p>这是从我的一个插件中提取的一个粗略的模板。它应该是一个很好的起点,从这里可以将设置处理添加到Sublime文本插件中。在</p>
<p>代码也在<a href="https://gist.github.com/mattst/90bf57a9e69b5a02bf604831e3693d66" rel="nofollow noreferrer">GitHub Gist</a>中。在</p>
<pre class="lang-py prettyprint-override"><code>import sublime
import sublime_plugin
# The global scope ensures that the settings can
# be easily accessed from within all the classes.
global settings
def plugin_loaded():
"""
This module level function is called on ST startup when the API is ready.
"""
global settings
settings = Settings()
settings.load_all()
def plugin_unloaded():
"""
This module level function is called just before the plugin is unloaded.
"""
settings.remove_callbacks()
class Settings:
"""
Handles all the settings. A callback method is added for each setting, it
gets called by ST if that setting is changed in the settings file.
"""
def __init__(self):
FILENAME = "YourPluginName.sublime-settings"
self.settings = sublime.load_settings(FILENAME)
# User configurable settings.
self.max_display_length = None
self.monospace_font = None
self.ellipsis_symbols = None
self.prefix_custom = None
self.command_names = None
# ...
def load_all(self):
self.init_setting("max_display_length", self.set_max_display_length)
self.init_setting("monospace_font", self.set_monospace_font)
self.init_setting("ellipsis_symbols", self.set_ellipsis_symbols)
self.init_setting("prefix_custom", self.set_prefix_custom)
self.init_setting("command_names", self.set_command_names)
# ...
def init_setting(self, setting_name, setting_method):
"""
Calls the setting_method to set the setting's value and registers the
setting_method as a callback so that it will be called by ST if the
setting's value is changed by the user.
"""
setting_method()
self.settings.add_on_change(setting_name, setting_method)
def remove_callbacks(self):
self.settings.clear_on_change("max_display_length")
self.settings.clear_on_change("monospace_font")
self.settings.clear_on_change("ellipsis_symbols")
self.settings.clear_on_change("prefix_custom")
self.settings.clear_on_change("command_names")
# ...
# Methods for the user configurable settings.
def set_max_display_length(self):
DEFAULT = 70
MIN_LENGTH = 50
value = self.integer_setting("max_display_length", DEFAULT, MIN_LENGTH)
self.max_display_length = value
def set_monospace_font(self):
DEFAULT = True
value = self.boolean_setting("monospace_font", DEFAULT)
self.monospace_font = value
def set_ellipsis_symbols(self):
DEFAULT = "…"
value = self.string_setting("ellipsis_symbols", DEFAULT)
self.ellipsis_symbols = value
def set_prefix_custom(self):
DEFAULT = ""
# This setting may be set to a string or a list of strings;
# if it is a list then ensure all list elements are strings.
value = self.list_or_string_setting("prefix_custom", DEFAULT)
if isinstance(value, list):
for index, item in enumerate(value):
if not isinstance(item, str):
value[index] = str(item)
self.prefix_custom = value
def set_command_names(self):
DEFAULT = []
value = self.list_setting("command_names", DEFAULT)
self.command_names = value
# Methods for settings retrieval; all will return a
# setting of the required type or the default value.
def string_setting(self, setting, default):
return self.setting_of_type(setting, default, str)
def list_setting(self, setting, default):
return self.setting_of_type(setting, default, list)
def boolean_setting(self, setting, default):
return self.setting_of_type(setting, default, bool)
def list_or_string_setting(self, setting, default):
return self.setting_of_type(setting, default, (str, list))
def setting_of_type(self, setting, default, required_type):
value = self.settings.get(setting, None)
return value if isinstance(value, required_type) else default
# Special case.
def integer_setting(self, setting, default, min_value):
value = self.settings.get(setting, None)
return value if self.is_integer(value) and value >= min_value else default
def is_integer(self, value):
# Bool is a subclass of int; isinstance(False, int) == True.
return isinstance(value, int) and not isinstance(value, bool)
</code></pre>