INSTRUCTION
stringlengths
1
8.43k
RESPONSE
stringlengths
75
104k
Implement highlight specific for C/ C ++.
def highlight_block(self, text): """Implement highlight specific for C/C++.""" text = to_text_string(text) inside_comment = tbh.get_state(self.currentBlock().previous()) == self.INSIDE_COMMENT self.setFormat(0, len(text), self.formats["comment" if inside_comme...
Implement highlight specific for Fortran.
def highlight_block(self, text): """Implement highlight specific for Fortran.""" text = to_text_string(text) self.setFormat(0, len(text), self.formats["normal"]) match = self.PROG.search(text) index = 0 while match: for key, value in list(matc...
Implement highlight specific for Fortran77.
def highlight_block(self, text): """Implement highlight specific for Fortran77.""" text = to_text_string(text) if text.startswith(("c", "C")): self.setFormat(0, len(text), self.formats["comment"]) self.highlight_spaces(text) else: FortranSH.high...
Implement highlight specific Diff/ Patch files.
def highlight_block(self, text): """Implement highlight specific Diff/Patch files.""" text = to_text_string(text) if text.startswith("+++"): self.setFormat(0, len(text), self.formats["keyword"]) elif text.startswith("---"): self.setFormat(0, len(text), self....
Implement highlight specific for CSS and HTML.
def highlight_block(self, text): """Implement highlight specific for CSS and HTML.""" text = to_text_string(text) previous_state = tbh.get_state(self.currentBlock().previous()) if previous_state == self.COMMENT: self.setFormat(0, len(text), self.formats["commen...
Parses the complete text and stores format for each character.
def make_charlist(self): """Parses the complete text and stores format for each character.""" def worker_output(worker, output, error): """Worker finished callback.""" self._charlist = output if error is None and output: self._allow_highlight =...
Parses the complete text and stores format for each character. Uses the attached lexer to parse into a list of tokens and Pygments token types. Then breaks tokens into individual letters each with a Spyder token type attached. Stores this list as self. _charlist. It s attached to the contentsChange signal of the parent...
def _make_charlist(self, tokens, tokmap, formats): """ Parses the complete text and stores format for each character. Uses the attached lexer to parse into a list of tokens and Pygments token types. Then breaks tokens into individual letters, each with a Spyder token type...
Actually highlight the block
def highlightBlock(self, text): """ Actually highlight the block""" # Note that an undefined blockstate is equal to -1, so the first block # will have the correct behaviour of starting at 0. if self._allow_highlight: start = self.previousBlockState() + 1 end...
Get all submodules of a given module
def get_submodules(mod): """Get all submodules of a given module""" def catch_exceptions(module): pass try: m = __import__(mod) submodules = [mod] submods = pkgutil.walk_packages(m.__path__, m.__name__ + '.', catch_exceptions) ...
Get all submodules of the main scientific modules and others of our interest
def get_preferred_submodules(): """ Get all submodules of the main scientific modules and others of our interest """ # Path to the modules database modules_path = get_conf_path('db') # Modules database modules_db = PickleShareDB(modules_path) if 'submodules' in modules_d...
Return true if version is stable i. e. with letters in the final component. Stable version examples: 1. 2 1. 3. 4 1. 0. 5. Non - stable version examples: 1. 3. 4beta 0. 1. 0rc1 3. 0. 0dev0.
def is_stable_version(version): """ Return true if version is stable, i.e. with letters in the final component. Stable version examples: ``1.2``, ``1.3.4``, ``1.0.5``. Non-stable version examples: ``1.3.4beta``, ``0.1.0rc1``, ``3.0.0dev0``. """ if not isinstance(version, tuple): ...
Return whether the dev configuration directory should used.
def use_dev_config_dir(use_dev_config_dir=USE_DEV_CONFIG_DIR): """Return whether the dev configuration directory should used.""" if use_dev_config_dir is not None: if use_dev_config_dir.lower() in {'false', '0'}: use_dev_config_dir = False else: use_dev_config_dir = DEV or ...
Output debug messages to stdout
def debug_print(*message): """Output debug messages to stdout""" warnings.warn("debug_print is deprecated; use the logging module instead.") if get_debug_level(): ss = STDOUT if PY3: # This is needed after restarting and using debug_print for m in message: ...
Return user home directory
def get_home_dir(): """ Return user home directory """ try: # expanduser() returns a raw byte string which needs to be # decoded with the codec that the OS is using to represent # file paths. path = encoding.to_unicode_from_fs(osp.expanduser('~')) except Exce...
Return the path to a temp clean configuration dir for tests and safe mode.
def get_clean_conf_dir(): """ Return the path to a temp clean configuration dir, for tests and safe mode. """ if sys.platform.startswith("win"): current_user = '' else: current_user = '-' + str(getpass.getuser()) conf_dir = osp.join(str(tempfile.gettempdir()), ...
Return absolute path to the config file with the specified filename.
def get_conf_path(filename=None): """Return absolute path to the config file with the specified filename.""" # Define conf_dir if running_under_pytest() or SAFE_MODE: # Use clean config dir if running tests or the user requests it. conf_dir = get_clean_conf_dir() elif sys.platform....
Return module * modname * base path
def get_module_path(modname): """Return module *modname* base path""" return osp.abspath(osp.dirname(sys.modules[modname].__file__))
Return module * modname * data path Note: relpath is ignored if module has an attribute named * attr_name * Handles py2exe/ cx_Freeze distributions
def get_module_data_path(modname, relpath=None, attr_name='DATAPATH'): """Return module *modname* data path Note: relpath is ignored if module has an attribute named *attr_name* Handles py2exe/cx_Freeze distributions""" datapath = getattr(sys.modules[modname], attr_name, '') if datapath: ...
Return module * modname * source path If * basename * is specified return * modname. basename * path where * modname * is a package containing the module * basename * * basename * is a filename ( not a module name ) so it must include the file extension:. py or. pyw Handles py2exe/ cx_Freeze distributions
def get_module_source_path(modname, basename=None): """Return module *modname* source path If *basename* is specified, return *modname.basename* path where *modname* is a package containing the module *basename* *basename* is a filename (not a module name), so it must include the file ex...
Return image absolute path
def get_image_path(name, default="not_found.png"): """Return image absolute path""" for img_path in IMG_PATH: full_path = osp.join(img_path, name) if osp.isfile(full_path): return osp.abspath(full_path) if default is not None: img_path = osp.join(get_module_path('s...
List available translations for spyder based on the folders found in the locale folder. This function checks if LANGUAGE_CODES contain the same information that is found in the locale folder to ensure that when a new language is added LANGUAGE_CODES is updated.
def get_available_translations(): """ List available translations for spyder based on the folders found in the locale folder. This function checks if LANGUAGE_CODES contain the same information that is found in the 'locale' folder to ensure that when a new language is added, LANGUAGE_CODES is u...
If Spyder has a translation available for the locale language it will return the version provided by Spyder adjusted for language subdifferences otherwise it will return DEFAULT_LANGUAGE. Example: 1. ) Spyder provides ( en de fr es hu and pt_BR ) if the locale is either en_US or en or en_UK this function will return en...
def get_interface_language(): """ If Spyder has a translation available for the locale language, it will return the version provided by Spyder adjusted for language subdifferences, otherwise it will return DEFAULT_LANGUAGE. Example: 1.) Spyder provides ('en', 'de', 'fr', 'es' 'hu' and '...
Load language setting from language config file if it exists otherwise try to use the local settings if Spyder provides a translation or return the default if no translation provided.
def load_lang_conf(): """ Load language setting from language config file if it exists, otherwise try to use the local settings if Spyder provides a translation, or return the default if no translation provided. """ if osp.isfile(LANG_FILE): with open(LANG_FILE, 'r') as f: ...
Return translation callback for module * modname *
def get_translation(modname, dirname=None): """Return translation callback for module *modname*""" if dirname is None: dirname = modname def translate_dumb(x): """Dumb function to not use translations.""" if not is_unicode(x): return to_text_string(x, "utf-8") ...
Remove all config files
def reset_config_files(): """Remove all config files""" print("*** Reset Spyder settings to defaults ***", file=STDERR) for fname in SAVED_CONFIG_FILES: cfg_fname = get_conf_path(fname) if osp.isfile(cfg_fname) or osp.islink(cfg_fname): os.remove(cfg_fname) elif os...
Register plugin in Spyder s main window
def register_plugin(self): """Register plugin in Spyder's main window""" ipyconsole = self.main.ipyconsole treewidget = self.fileexplorer.treewidget self.main.add_dockwidget(self) self.fileexplorer.sig_open_file.connect(self.main.open_file) self.register_widget_sh...
Refresh explorer widget
def refresh_plugin(self, new_path=None, force_current=True): """Refresh explorer widget""" self.fileexplorer.treewidget.update_history(new_path) self.fileexplorer.treewidget.refresh(new_path, force_current=force_current)
Return True if obj is type text string False if it is anything else like an instance of a class that extends the basestring class.
def is_type_text_string(obj): """Return True if `obj` is type text string, False if it is anything else, like an instance of a class that extends the basestring class.""" if PY2: # Python 2 return type(obj) in [str, unicode] else: # Python 3 return type(obj) in [s...
Convert obj to binary string ( bytes in Python 3 str in Python 2 )
def to_binary_string(obj, encoding=None): """Convert `obj` to binary string (bytes in Python 3, str in Python 2)""" if PY2: # Python 2 if encoding is None: return str(obj) else: return obj.encode(encoding) else: # Python 3 return byte...
Save history to a text file in user home directory
def save_history(self): """Save history to a text file in user home directory""" open(self.LOG_PATH, 'w').write("\n".join( \ [to_text_string(self.pydocbrowser.url_combo.itemText(index)) for index in range(self.pydocbrowser.url_combo.count())]))
DockWidget visibility has changed
def visibility_changed(self, enable): """DockWidget visibility has changed""" super(SpyderPluginWidget, self).visibility_changed(enable) if enable and not self.pydocbrowser.is_server_running(): self.pydocbrowser.initialize()
Return the widget to give focus to when this plugin s dockwidget is raised on top - level
def get_focus_widget(self): """ Return the widget to give focus to when this plugin's dockwidget is raised on top-level """ self.pydocbrowser.url_combo.lineEdit().selectAll() return self.pydocbrowser.url_combo
Perform actions before parent main window is closed
def closing_plugin(self, cancelable=False): """Perform actions before parent main window is closed""" self.save_history() self.set_option('zoom_factor', self.pydocbrowser.webview.get_zoom_factor()) return True
Synchronize Spyder s path list with PYTHONPATH environment variable Only apply to: current user on Windows platforms
def synchronize(self): """ Synchronize Spyder's path list with PYTHONPATH environment variable Only apply to: current user, on Windows platforms """ answer = QMessageBox.question(self, _("Synchronize"), _("This will synchronize Spyder's path list with " ...
Update path list
def update_list(self): """Update path list""" self.listwidget.clear() for name in self.pathlist+self.ro_pathlist: item = QListWidgetItem(name) item.setIcon(ima.icon('DirClosedIcon')) if name in self.ro_pathlist: item.setFlags(Qt.NoItemFl...
Refresh widget
def refresh(self, row=None): """Refresh widget""" for widget in self.selection_widgets: widget.setEnabled(self.listwidget.currentItem() is not None) not_empty = self.listwidget.count() > 0 if self.sync_button is not None: self.sync_button.setEnabled(not_empt...
Catch clicks outside the object and ESC key press.
def eventFilter(self, widget, event): """Catch clicks outside the object and ESC key press.""" if ((event.type() == QEvent.MouseButtonPress and not self.geometry().contains(event.globalPos())) or (event.type() == QEvent.KeyPress and event.key() == Q...
Activate the edit tab.
def edit_tab(self, index): """Activate the edit tab.""" # Sets focus, shows cursor self.setFocus(True) # Updates tab index self.tab_index = index # Gets tab size and shrinks to avoid overlapping tab borders rect = self.main.tabRect(index) rec...
On clean exit update tab name.
def edit_finished(self): """On clean exit, update tab name.""" # Hides editor self.hide() if isinstance(self.tab_index, int) and self.tab_index >= 0: # We are editing a valid tab, update name tab_text = to_text_string(self.text()) self.main.se...
Reimplement Qt method
def mousePressEvent(self, event): """Reimplement Qt method""" if event.button() == Qt.LeftButton: self.__drag_start_pos = QPoint(event.pos()) QTabBar.mousePressEvent(self, event)
Override Qt method
def dragEnterEvent(self, event): """Override Qt method""" mimeData = event.mimeData() formats = list(mimeData.formats()) if "parent-id" in formats and \ int(mimeData.data("parent-id")) == id(self.ancestor): event.acceptProposedAction() QTabBar.dra...
Override Qt method
def dropEvent(self, event): """Override Qt method""" mimeData = event.mimeData() index_from = int(mimeData.data("source-index")) index_to = self.tabAt(event.pos()) if index_to == -1: index_to = self.count() if int(mimeData.data("tabbar-id")) != id(self)...
Override Qt method to trigger the tab name editor.
def mouseDoubleClickEvent(self, event): """Override Qt method to trigger the tab name editor.""" if self.rename_tabs is True and \ event.buttons() == Qt.MouseButtons(Qt.LeftButton): # Tab index index = self.tabAt(event.pos()) if index >= 0: ...
Update browse tabs menu
def update_browse_tabs_menu(self): """Update browse tabs menu""" self.browse_tabs_menu.clear() names = [] dirnames = [] for index in range(self.count()): if self.menu_use_tooltips: text = to_text_string(self.tabToolTip(index)) else:...
Set tabs corner widgets corner_widgets: dictionary of ( corner widgets ) corner: Qt. TopLeftCorner or Qt. TopRightCorner widgets: list of widgets ( may contains integers to add spacings )
def set_corner_widgets(self, corner_widgets): """ Set tabs corner widgets corner_widgets: dictionary of (corner, widgets) corner: Qt.TopLeftCorner or Qt.TopRightCorner widgets: list of widgets (may contains integers to add spacings) """ assert isinstance(co...
Override Qt method
def contextMenuEvent(self, event): """Override Qt method""" self.setCurrentIndex(self.tabBar().tabAt(event.pos())) if self.menu: self.menu.popup(event.globalPos())
Override Qt method
def mousePressEvent(self, event): """Override Qt method""" if event.button() == Qt.MidButton: index = self.tabBar().tabAt(event.pos()) if index >= 0: self.sig_close_tab.emit(index) event.accept() return QTabWidget.mo...
Override Qt method
def keyPressEvent(self, event): """Override Qt method""" ctrl = event.modifiers() & Qt.ControlModifier key = event.key() handled = False if ctrl and self.count() > 0: index = self.currentIndex() if key == Qt.Key_PageUp: if index > 0...
Ctrl + Tab
def tab_navigate(self, delta=1): """Ctrl+Tab""" if delta > 0 and self.currentIndex() == self.count()-1: index = delta-1 elif delta < 0 and self.currentIndex() == 0: index = self.count()+delta else: index = self.currentIndex()+delta self...
Setting Tabs close function None - > tabs are not closable
def set_close_function(self, func): """Setting Tabs close function None -> tabs are not closable""" state = func is not None if state: self.sig_close_tab.connect(func) try: # Assuming Qt >= 4.5 QTabWidget.setTabsClosable(self, state) ...
Move tab inside a tabwidget
def move_tab(self, index_from, index_to): """Move tab inside a tabwidget""" self.move_data.emit(index_from, index_to) tip, text = self.tabToolTip(index_from), self.tabText(index_from) icon, widget = self.tabIcon(index_from), self.widget(index_from) current_widget = self.cu...
Move tab from a tabwidget to another
def move_tab_from_another_tabwidget(self, tabwidget_from, index_from, index_to): """Move tab from a tabwidget to another""" # We pass self object IDs as QString objs, because otherwise it would # depend on the platform: long for 64bit, i...
Return script * fname * run configuration
def get_run_configuration(fname): """Return script *fname* run configuration""" configurations = _get_run_configurations() for filename, options in configurations: if fname == filename: runconf = RunConfiguration() runconf.set(options) return runconf
Select directory
def select_directory(self): """Select directory""" basedir = to_text_string(self.wd_edit.text()) if not osp.isdir(basedir): basedir = getcwd_or_home() directory = getexistingdirectory(self, _("Select directory"), basedir) if directory: self.wd_edit....
Add widgets/ spacing to dialog vertical layout
def add_widgets(self, *widgets_or_spacings): """Add widgets/spacing to dialog vertical layout""" layout = self.layout() for widget_or_spacing in widgets_or_spacings: if isinstance(widget_or_spacing, int): layout.addSpacing(widget_or_spacing) else: ...
Create dialog button box and add it to the dialog layout
def add_button_box(self, stdbtns): """Create dialog button box and add it to the dialog layout""" bbox = QDialogButtonBox(stdbtns) run_btn = bbox.addButton(_("Run"), QDialogButtonBox.AcceptRole) run_btn.clicked.connect(self.run_btn_clicked) bbox.accepted.connect(self.accept)...
Setup Run Configuration dialog with filename * fname *
def setup(self, fname): """Setup Run Configuration dialog with filename *fname*""" self.filename = fname self.runconfigoptions = RunConfigOptions(self) self.runconfigoptions.set(RunConfiguration(fname).get()) self.add_widgets(self.runconfigoptions) self.add_button_b...
Reimplement Qt method
def accept(self): """Reimplement Qt method""" if not self.runconfigoptions.is_valid(): return configurations = _get_run_configurations() configurations.insert(0, (self.filename, self.runconfigoptions.get())) _set_run_configurations(configurations) QDial...
Setup Run Configuration dialog with filename * fname *
def setup(self, fname): """Setup Run Configuration dialog with filename *fname*""" combo_label = QLabel(_("Select a run configuration:")) self.combo = QComboBox() self.combo.setMaxVisibleItems(20) self.combo.setSizeAdjustPolicy(QComboBox.AdjustToMinimumContentsLength) ...
Reimplement Qt method
def accept(self): """Reimplement Qt method""" configurations = [] for index in range(self.stack.count()): filename = to_text_string(self.combo.itemText(index)) runconfigoptions = self.stack.widget(index) if index == self.stack.currentIndex() and\ ...
Override Qt method.
def paintEvent(self, event): """Override Qt method. Painting line number area """ painter = QPainter(self) painter.fillRect(event.rect(), self.editor.sideareas_color) # This is needed to make that the font size of line numbers # be the same as the text one when z...
Override Qt method.
def mouseMoveEvent(self, event): """Override Qt method. Show code analisis, if left button pressed select lines. """ line_number = self.editor.get_linenumber_from_mouse_event(event) block = self.editor.document().findBlockByNumber(line_number-1) data = block.userData() ...
Override Qt method
def mousePressEvent(self, event): """Override Qt method Select line, and starts selection """ line_number = self.editor.get_linenumber_from_mouse_event(event) self._pressed = line_number self._released = line_number self.editor.select_lines(self._pressed, ...
Compute and return line number area width
def compute_width(self): """Compute and return line number area width""" if not self._enabled: return 0 digits = 1 maxb = max(1, self.editor.blockCount()) while maxb >= 10: maxb /= 10 digits += 1 if self._margin: margin = 3+...
Setup margin settings ( except font now set in editor. set_font )
def setup_margins(self, linenumbers=True, markers=True): """ Setup margin settings (except font, now set in editor.set_font) """ self._margin = linenumbers self._markers_margin = markers self.set_enabled(linenumbers or markers)
Returns a list with line number definition name fold and token.
def process_python_symbol_data(oedata): """Returns a list with line number, definition name, fold and token.""" symbol_list = [] for key in oedata: val = oedata[key] if val and key != 'found_cell_separators': if val.is_class_or_function(): symbol_list.append((key,...
Return a list of icons for oedata of a python file.
def get_python_symbol_icons(oedata): """Return a list of icons for oedata of a python file.""" class_icon = ima.icon('class') method_icon = ima.icon('method') function_icon = ima.icon('function') private_icon = ima.icon('private1') super_private_icon = ima.icon('private2') symbols = process...
Takes a list of paths and tries to intelligently shorten them all. The aim is to make it clear to the user where the paths differ as that is likely what they care about. Note that this operates on a list of paths not on individual paths.
def shorten_paths(path_list, is_unsaved): """ Takes a list of paths and tries to "intelligently" shorten them all. The aim is to make it clear to the user where the paths differ, as that is likely what they care about. Note that this operates on a list of paths not on individual paths. If the p...
Detect when the focus goes out of this widget.
def focusOutEvent(self, event): """ Detect when the focus goes out of this widget. This is used to make the file switcher leave focus on the last selected file by the user. """ self.clicked_outside = True return super(QLineEdit, self).focusOutEvent(event)
Save initial cursors and initial active widget.
def save_initial_state(self): """Save initial cursors and initial active widget.""" paths = self.paths self.initial_widget = self.get_widget() self.initial_cursors = {} for i, editor in enumerate(self.widgets): if editor is self.initial_widget: self.i...
Restores initial cursors and initial active editor.
def restore_initial_state(self): """Restores initial cursors and initial active editor.""" self.list.clear() self.is_visible = False widgets = self.widgets_by_path if not self.edit.clicked_outside: for path in self.initial_cursors: cursor = self.initi...
Positions the file switcher dialog.
def set_dialog_position(self): """Positions the file switcher dialog.""" parent = self.parent() geo = parent.geometry() width = self.list.width() # This has been set in setup left = parent.geometry().width()/2 - width/2 # Note: the +1 pixel on the top makes it look bette...
Get the max size ( width and height ) for the elements of a list of strings as a QLabel.
def get_item_size(self, content): """ Get the max size (width and height) for the elements of a list of strings as a QLabel. """ strings = [] if content: for rich_text in content: label = QLabel(rich_text) label.setTextFormat(Qt...
Adjusts the width and height of the file switcher based on the relative size of the parent and content.
def fix_size(self, content): """ Adjusts the width and height of the file switcher based on the relative size of the parent and content. """ # Update size of dialog based on relative size of the parent if content: width, height = self.get_item_size(content) ...
Select row in list widget based on a number of steps with direction.
def select_row(self, steps): """Select row in list widget based on a number of steps with direction. Steps can be positive (next rows) or negative (previous rows). """ row = self.current_row() + steps if 0 <= row < self.count(): self.set_current_row(row)
Select previous row in list widget.
def previous_row(self): """Select previous row in list widget.""" if self.mode == self.SYMBOL_MODE: self.select_row(-1) return prev_row = self.current_row() - 1 if prev_row >= 0: title = self.list.item(prev_row).text() else: title =...
Select next row in list widget.
def next_row(self): """Select next row in list widget.""" if self.mode == self.SYMBOL_MODE: self.select_row(+1) return next_row = self.current_row() + 1 if next_row < self.count(): if '</b></big><br>' in self.list.item(next_row).text(): ...
Get the real index of the selected item.
def get_stack_index(self, stack_index, plugin_index): """Get the real index of the selected item.""" other_plugins_count = sum([other_tabs[0].count() \ for other_tabs in \ self.plugins_tabs[:plugin_index]]) real_index = stack_...
Get the data object of the plugin s current tab manager.
def get_plugin_data(self, plugin): """Get the data object of the plugin's current tab manager.""" # The data object is named "data" in the editor plugin while it is # named "clients" in the notebook plugin. try: data = plugin.get_current_tab_manager().data except Attr...
Get the tabwidget of the plugin s current tab manager.
def get_plugin_tabwidget(self, plugin): """Get the tabwidget of the plugin's current tab manager.""" # The tab widget is named "tabs" in the editor plugin while it is # named "tabwidget" in the notebook plugin. try: tabwidget = plugin.get_current_tab_manager().tabs ex...
Get widget by index.
def get_widget(self, index=None, path=None, tabs=None): """Get widget by index. If no tabs and index specified the current active widget is returned. """ if (index and tabs) or (path and tabs): return tabs.widget(index) elif self.plugin: return self.get_p...
Set the cursor of an editor.
def set_editor_cursor(self, editor, cursor): """Set the cursor of an editor.""" pos = cursor.position() anchor = cursor.anchor() new_cursor = QTextCursor() if pos == anchor: new_cursor.movePosition(pos) else: new_cursor.movePosition(anchor) ...
Go to specified line number in current active editor.
def goto_line(self, line_number): """Go to specified line number in current active editor.""" if line_number: line_number = int(line_number) try: self.plugin.go_to_line(line_number) except AttributeError: pass
List widget item selection change handler.
def item_selection_changed(self): """List widget item selection change handler.""" row = self.current_row() if self.count() and row >= 0: if '</b></big><br>' in self.list.currentItem().text() and row == 0: self.next_row() if self.mode == self.FILE_MODE: ...
Setup list widget content for file list display.
def setup_file_list(self, filter_text, current_path): """Setup list widget content for file list display.""" short_paths = shorten_paths(self.paths, self.save_status) paths = self.paths icons = self.icons results = [] trying_for_line_number = ':' in filter_text #...
Setup list widget content for symbol list display.
def setup_symbol_list(self, filter_text, current_path): """Setup list widget content for symbol list display.""" # Get optional symbol name filter_text, symbol_text = filter_text.split('@') # Fetch the Outline explorer data, get the icons and values oedata = self.get_symbol_list...
Setup list widget content.
def setup(self): """Setup list widget content.""" if len(self.plugins_tabs) == 0: self.close() return self.list.clear() current_path = self.current_path filter_text = self.filter_text # Get optional line or symbol to define mode and method handle...
Add a plugin to display its files.
def add_plugin(self, plugin, tabs, data, icon): """Add a plugin to display its files.""" self.plugins_tabs.append((tabs, plugin)) self.plugins_data.append((data, icon)) self.plugins_instances.append(plugin)
: param filename: File to check.: returns: True if it s a binary file otherwise False.
def is_binary(filename): """ :param filename: File to check. :returns: True if it's a binary file, otherwise False. """ logger.debug('is_binary: %(filename)r', locals()) # Check if the file extension is in a list of known binary types binary_extensions = ['pyc', 'iso', 'zip', 'pdf'] for...
Return support status dict if path is under VCS root
def get_vcs_info(path): """Return support status dict if path is under VCS root""" for info in SUPPORTED: vcs_path = osp.join(path, info['rootdir']) if osp.isdir(vcs_path): return info
Return VCS root directory path Return None if path is not within a supported VCS repository
def get_vcs_root(path): """Return VCS root directory path Return None if path is not within a supported VCS repository""" previous_path = path while get_vcs_info(path) is None: path = abspardir(path) if path == previous_path: return else: previous...
If path is a valid VCS repository run the corresponding VCS tool Supported VCS actions: commit browse Return False if the VCS tool is not installed
def run_vcs_tool(path, action): """If path is a valid VCS repository, run the corresponding VCS tool Supported VCS actions: 'commit', 'browse' Return False if the VCS tool is not installed""" info = get_vcs_info(get_vcs_root(path)) tools = info['actions'][action] for tool, args in tools: ...
Return Mercurial revision for the repository located at repopath Result is a tuple ( global local branch ) with None values on error For example: >>> get_hg_revision (. ) ( eba7273c69df + 2015 + default )
def get_hg_revision(repopath): """Return Mercurial revision for the repository located at repopath Result is a tuple (global, local, branch), with None values on error For example: >>> get_hg_revision(".") ('eba7273c69df+', '2015+', 'default') """ try: ass...
Return Git revision for the repository located at repopath Result is a tuple ( latest commit hash branch ) with None values on error
def get_git_revision(repopath): """ Return Git revision for the repository located at repopath Result is a tuple (latest commit hash, branch), with None values on error """ try: git = programs.find_program('git') assert git is not None and osp.isdir(osp.join(repopat...
Return Git active branch state branches ( plus tags ).
def get_git_refs(repopath): """ Return Git active branch, state, branches (plus tags). """ tags = [] branches = [] branch = '' files_modifed = [] if os.path.isfile(repopath): repopath = os.path.dirname(repopath) try: git = programs.find_program('git')...
Return True if path is a Python module/ package
def is_module_or_package(path): """Return True if path is a Python module/package""" is_module = osp.isfile(path) and osp.splitext(path)[1] in ('.py', '.pyw') is_package = osp.isdir(path) and osp.isfile(osp.join(path, '__init__.py')) return is_module or is_package
Qt Override. Filter tab keys and process double tab keys.
def event(self, event): """Qt Override. Filter tab keys and process double tab keys. """ if (event.type() == QEvent.KeyPress) and (event.key() == Qt.Key_Tab): self.sig_tab_pressed.emit(True) self.numpress += 1 if self.numpress == 1: ...
Qt Override. Handle key press events.
def keyPressEvent(self, event): """Qt Override. Handle key press events. """ if event.key() == Qt.Key_Return or event.key() == Qt.Key_Enter: if self.add_current_text_if_valid(): self.selected() self.hide_completer() elif event...
When hitting tab it handles if single or double tab
def handle_keypress(self): """When hitting tab, it handles if single or double tab""" if self.numpress == 2: self.sig_double_tab_pressed.emit(True) self.numpress = 0
Add text to combo box: add a new item if text is not found in combo box items.
def add_text(self, text): """Add text to combo box: add a new item if text is not found in combo box items.""" index = self.findText(text) while index != -1: self.removeItem(index) index = self.findText(text) self.insertItem(0, text) index ...