Change Log

Change log of Keypirinha

v2.9.9 - 2016-11-22

Application

  • Fixed a bug that prevented the use of the “Predefined variables” listed in Configuration, in the configuration files
  • The noisy error messages Failed to get path of KnownFolder ... are only printed when they should (i.e. when the OS should actually support the given Known Folder)

RegBrowser package

  • Fixed issue #135: could not open registry values in regedit (i.e. only keys)

WebSearch package

  • Fixed issue #136 implied by an unexpected behavior of the API (see below)

Documentation

API

v2.9.8 - 2016-11-20

RegBrowser package

  • Added the Copy full path, Copy parent's path and Copy value actions (thanks to @ueffel)

WebSearch package

  • If a search site is assigned several URLs, they will be launched altogether if the configured/detected web browser supports it (Chrome, Firefox, Iridium, Opera, Palemoon, Vivaldi). Edge and Internet Explorer do not support this. Note that the web_browser_new_window option must probably be disabled to allow this to be taken into account by the browser (with Chrome at least).

API

v2.9.7 - 2016-10-10

General Notes

Application

  • Added the Shift+Enter shortcut to execute an item without closing the LaunchBox, and reset the search (issue #122)
  • Added the Ctrl+Shift+Enter shortcut to execute an item without closing the LaunchBox, and go back to the initial step of the current search (issue #122)
  • Added a launch-and-paste hotkey so the content of the clipboard is pasted to the LaunchBox when shown (see the new hotkey_paste setting; issue #123)
  • Catalog’s insertion speed and memory usage have been improved

RegBrowser package

  • Show the currently selected key so it can be opened instead of having to open a subkey
  • Show the “(Default)” value

WebSearch package

  • Added Bitbucket and GitHub to the list of predefined search sites

API

  • Overhaul of the keypirinha_wintypes module
  • keypirinha.CatalogItem comparison operators have been improved and __hash__ uses the internal unique id of the item.

v2.9.6 - 2016-09-29

General Notes

Application

  • Added the [network] section in application’s configuration file, that can now be used by the plugins through the new network-dedicated API
  • Got rid of the Test package that has been obsoleted by the SDK
  • Do not log anymore the message: Monitors configuration changed.
  • Fixed issue #124 where configuration could not be edited with an other editor than the default one and when the paths to the files to edit contain space character(s)

Apps package

  • Added the elevated setting to the Custom Commands feature

Bookmarks package

  • Added support for the Iridium browser

FileBrowser package

  • Fixed: command switch / was always changed to \ (issue #119)

FileZilla package

  • Referenced FileZilla executable can now be passed arguments when executed (issue #126)

PuTTY package

  • Referenced PuTTY executable can now be passed arguments when executed (issue #126)

RegBrowser package

WebSearch package

  • Added Baidu and Qwant to the list of predefined search sites

WinSCP package

  • Referenced WinSCP executable can now be passed arguments when executed (issue #126)

API

v2.9.5 - 2016-09-10

Application

  • Fixed the Explore action that did not work for some items issue #118
  • Fixed a bug that crashed the application when trying to Backspace from the Action step, after doing a Ctrl+Enter

Apps package

  • Corrected the documentation of the Custom Commands feature in the configuration file (i.e. placeholders format)

v2.9.4 - 2016-09-08

CAUTION

  • KNOWNFOLDER_... configuration values now expand to the final path of the known folder. Former values (i.e. the GUIDs) can still be used via the new KNOWNFOLDERGUID_... variables.

Application

  • Added the KNOWNFOLDERGUID_... predefined variables to configuration files ([var] section). Note that they replace the former KNOWNFOLDER_... variables which are now assigned the final path of their respective known folder. See the Configuration chapter for more info.
  • Fixed a bug that would prevent the LaunchBox to be resized properly when search is reset issue #113
  • Fixed a bug that would move the LaunchBox out of screen when using the persistent mode of the geometry setting issue #116
  • Fixed a bug that prevented history items to be loaded if they had a non-standard category ID
  • Fixed a bug that appeared in 2.9.2 and prevented similar items from history to be added to the results list when no argument were typed

Apps package

  • Added the Custom Commands feature, which is similar to Launchy’s Runner plugin, in a more flexible fashion

API

v2.9.3 - 2016-08-25

Application

  • Fixed a bug that appeared in 2.9.2 and crashed the application when typing arguments to a selected item issue #112

v2.9.2 - 2016-08-25

Application

  • Drastically optimized catalog search speed, most notably for big catalogs (up to 15 times faster)
  • Drastically optimized catalog insertions/updates speed (up to 19 times faster) Note that this optimization only includes the indexing part of the catalog building process. It excludes the time taken by a plugin to actually build its list of items before pushing it to Keypirinha (for example, a list of files resulting from a hard-drive scan).
  • Stability tested on large catalogs, containing up to 360,000 items

API

  • Fixed a long-standing bug that prevented some resources to be found/loaded from a loose package issue #111

v2.9.1 - 2016-08-23

Application

  • Search speed improved in some cases
  • Application and packages are more permissive with file paths specified in configuration files that have unix-style separators (/) instead of windows-style ones (\)

Calc package

  • Added the rounding_precision setting
  • Fixed: representation of floating point numbers issue #104

Everything package

  • Fixed: search items created by versions pre-2.9 were not working issue #106

API

v2.9 - 2016-08-20

Application

  • Improved geometry setting for both LaunchBox and Console that also allows auto positioning according to current context: current working monitor, mouse current monitor or nearby mouse position. issue #50
  • Persistent geometry state for both LaunchBox and Console remembers positioning and sizing according to current monitors configuration. issue #39
  • LaunchBox’s Y position is now automatically pushed up in order to have enough room to display at least one result item in case it was too low (only in persistent geometry mode)
  • LaunchBox position is not forcefully restored to default anymore when user has moved it, until search is reset or window re-displayed
  • LaunchBox now accepts the Alt+Left shortcut to forcefully go back to the previous search step. The Alt+Right shortcut is equivalent to Tab. issue #97
  • LaunchBox displays the list of history items when Ctrl+Down is pressed (or Down if search state is clean) issue #45
  • .keypirinha-package files can now be updated at runtime issue #73
  • Fixed: Keypirinha does not rely on Windows’ Shell anymore to get a folder icon and tries instead to get system’s default from registry. issue #89
  • Keypirinha now tries to detect automatically the working directory of the launched applications issue #101
  • The editor, terminal and web_browser application settings now accept shortcuts (link’s arguments will be prepended to the extra ones specified in the setting value)
  • Fixed a long standing bug that prevented Keypirinha to properly auto-detect configured editor’s type (Atom, SublimeText, ...) via the editor setting

Calc package

  • Improved results readability: result is in item’s label instead of its description
  • Got rid of most common rounding precision problems that occured with floating point numbers issue #98
  • The = keyword can be specified as a prefix to query the plugin to evaluate the remaining of the typed string issue #93
  • Added the decimal_separator setting issue #70
  • Integer results are now automatically declined in multiple bases (i.e. decimal, hexadecimal, binary and octal)
  • Currency formatting is now available (see the currency configuration section for more information)
  • Added support for the bin() function issue #96
  • Added support for bitwise operators: | (or OR), ~ (or XOR) and & (or AND)
  • ^ is now an alias to the ** (power of) operator
  • Added support for Python’s FloorDiv operator (//), also referred as Integer Division
  • Added the ans constant that evaluates to the last valid result (reset to zero at Keypirinha’s startup or when package is reloaded)
  • Added support for Metric System suffixes (e.g. “K”, “da”, ...). See documentation for more info.
  • Added support for suffixes of Orders of Magnitude of Data (e.g. “Ki”, “Gi”, ...). See documentation for more info.
  • Upgraded the underlying Python module that is used to evaluate mathematical expressions (i.e. simpleeval)

Everything package

  • Added: predefined search patterns in the configuration file to ease the searches you do often (contributed by @psistorm) issue #94

FileBrowser package

  • Added the follow_shell_links setting

TaskSwitcher package

  • Fixed a bug that prevented the plugin to show its suggestions when the always_suggest option was enabled issue #102

WebSearch package

  • Made the {plugin_name} format field less confusing (i.e. WebSearch instead of WebSearch.WebSearch)

Documentation

API

v2.8 - 2016-07-11

Application

  • Fixed a bug that prevented the results to be displayed when the retain_last_search option was enabled issue #88
  • Added the ability to erase all the references of a package from history by selecting a result item and clicking the dedicated action in its contextual menu (mouse only; documentation updated) issue #65
  • The show_history_hits setting does not depend on show_scores anymore so items hits counts can be shown without having to enable the show_scores option as well issue #84
  • Added the KNOWNFOLDER_... predefined variables to configuration files ([var] section). They may come handy for some the Apps and FileBrowser packages at least. See the Configuration chapter for more info.

Bookmarks package

  • Firefox’s padding bookmarks are now filtered out issue #66

FileBrowser package

  • Fixed: typing C:\W would lead to an empty results list instead of returning at least a C:\Windows item for example issue #81

WebSearch package

  • Search sites do not require argument anymore. If no argument is provided by the user, the guessed home address of the site will be launched instead of the provided url, unless a home_url setting (new) has been specified issue #85
  • Pre-defined search sites can now be all disabled at once using the new enable_predefined_sites setting (issue #57). Note that the section name of pre-defined sites is now predefined_site/ instead of site/.
  • A single search site (pre-defined or not) can now be enabled/disabled using the new enable boolean setting
  • Added the Python3 Mod predefined site

Documentation

  • Added the Contributions chapter that references available third-party packages and patches to the official packages issue #82

API

  • Plugin.create_error_item now copies the content of the short_desc argument if label is empty. Items with an empty label are filtered out by the application and the created ERROR item would not be displayed.
  • Corrected a potential bug in Settings.get_multiline when the returned fallback value was modified by the caller, then re-used (due to Python’s “mutable default arguments”)

v2.7 - 2016-07-03

Application

  • LaunchBox: item’s data_bag property is now also printed in the Console when Alt+Enter is pressed
  • Ctrl+Backspace conventional shortcut to erase the previously typed word in an edit control is now supported by the LaunchBox and the Console issue #77

Apps package

  • Fixed a bug that occurred when a line in extra_paths was containing only a GUID (i.e. format ::{guid})

Everything package

  • Now takes advantage of the ‘browse directory as you type’ feature introduced with the FileBrowser package. After a search via Everything and once a directory item has been selected, it can be browsed using the Tab key.

FileBrowser package

  • A new package that allows file browsing as you type (request issue #32). More info available in documentation and configuration file.

API

  • Embedded Python interpreter upgraded from 3.5.1 to 3.5.2
  • Signature of Plugin.on_suggest has changed, refer to the documentation for more information. This change breaks retro-compatibility.
  • Corrected GUID.__init__, get_known_folder_path and the declaration of shell32.SHGetKnownFolderPath from the keypirinha_wintypes site module

v2.6.1 - 2016-06-10

API

  • Fixed: the content of the CatalogItem.data_bag property was not copied by the CatalogItem.clone method issue #69

v2.6 - 2016-05-30

Application

  • Configuration is now reloaded if and only if at least one value has changed (previously, it was always reloaded when a change notification was pushed by the file system). This helps preventing the catalog to be updated because of modifications to comments or blank lines for example. This also applies to packages configuration.
  • For the same reasons, the detection of modifications to the environment variables has been improved.

API

  • Replaced Plugin.on_config_changed and Plugin.on_env_changed methods by Plugin.on_events. This change breaks retro-compatibility.
  • Added the show parameter to keypirinha_util.shell_execute() issue #68

v2.5.6 - 2016-05-10

Application

  • Fixed: the Internal package was still loaded on startup despite being specified in the ignored_packages list issue #59
  • The ignored_packages setting is more flexible by allowing the <all> value and the - and + operators
  • Disabled the auto-repeat flag of every hotkeys to avoid trouble
  • Rules for package naming are slightly more strict. See the Packages chapter for more info
  • Minimum auto-width of the LaunchBox is 600 pixels in case 1/3 of the screen width is less than that
  • Log file is now machine specific and is named accordingly. Old “Keypirinha.log” file can be deleted manually (not done by Keypirinha)

TaskSwitcher package

  • Added the item_label setting issue #54
  • Added the always_suggest setting

Documentation

v2.5.5 - 2016-04-26

Bookmarks package

  • Fixed a bug that prevented bookmarks to be extracted in some cases issue #55

API

v2.5.4 - 2016-04-23

WinSCP package

  • Fixed a CPU-eating bug that occurred while listing the configured sessions of WinSCP from the registry issue #48

v2.5.3 - 2016-04-22

CAUTION

  • The type of the hide_on_focus_lost setting has changed to allow a more fine-grained tweaking. While effort has been made to keep retro-compatibility, please ensure your existing configuration complies to this modification.
  • If at least one of your geometry settings is set to persistent, you may have to manually reposition the window(s) the first time you start this new version due to the fix of issue #39.

Application

  • Fixed: icons of remote files are now displayed properly issue #20
  • Fixed: dragging the LaunchBox by its icon in maximized mode was resulting in an unexpected behavior issue #47
  • Fixed: made persistent geometry and more generally, application state, user AND machine-specific issue #39
  • Added the space_as_tab setting issue #49
  • Added the Shift+Alt+Enter shortcut to the LaunchBox to directly invoke the Shell “Properties” dialog of the selected FILE item.
  • The hotkey_run and hotkey_console settings accept new special keys and combinations. A message dialog also pops up in case of malformed value issue #46
  • The hide_on_focus_lost setting is more flexible
  • Application is more verbose about malformed configuration values (console) instead of just silently falling back to hard-coded default

Bookmarks package

  • Try to automatically detect the text encoding of some files the plugins need to read from Chrome, Firefox and others issue #51

API

Documentation

  • Added the “Clear the history” section in the First steps chapter
  • Corrections here and there

v2.5.2 - 2016-04-16

Application

  • Fixed handling of the show_on_taskbar setting issue #43
  • Added the escape_always_closes setting issue #41
  • LaunchBox can now be closed with Shift+Esc

Documentation

  • Added the Keyboard Shortcuts chapter to list the available shortcuts
  • Added the “Drag and Drop” section in the First steps chapter
  • Typo corrections

v2.5.1 - 2016-04-14

URL package

  • Corrected handling of IP addresses and any URL not explicitly prefixed with a scheme issue #40

v2.5 - 2016-04-13

Application

  • New package: URL Package
  • Fixed: the LaunchBox and Console windows now give back the focus to the previous application/window when closed issue #37
  • The LaunchBox can now be maximized by hitting Alt+X or standard Win+Up combination (toggle). Double-click also works. See the Maximize the LaunchBox documentation section.
  • Added the hide_on_focus_lost setting issue #34
  • Added the retain_last_search setting issue #35
  • ERROR items have been implemented. Keypirinha can now display error messages from the plugins directly to the results list so the user can have a direct feedback on what’s going on in some cases. Note that the Console remains the best source of information to track down issues. Best example for now is the = item of the Calc package (try typing an invalid expression like 2+).
  • The LaunchBox now supports drag-and-drop operations:
    • A file can be dropped to the edit box so its full path is inserted
    • FILE items can be dragged out of the results list and be copied/linked to the Windows Explorer or any other application that accepts drops of Shell items
    • URL, CMDLINE, EXPRESSION and ERROR items can also be dragged out and their content (i.e. the target property) will be copied to the drop destination. For example, you could drop a URL item to your web browser.
  • In the LaunchBox, the Alt+Enter combination allows to show up the properties of the currently selected item.
  • User can now press Ctrl+Space or Shift+Space during the initial search to force include a space character instead of switching to the next step.
  • Improved speed when merging a large list of suggestions from plugins

Calc package

  • Added support for the left-shift and right-shift operators (<< and >>).
  • Added the always_evaluate setting issue #38

Everything package

  • Full support of Everything’s search syntax issue #27
  • Added the Regex Search item to allow a search based on regular expression
  • Fixed: the list of returned results was not always complete in case Everything was not fast enough issue #36
  • Fixed: extra arguments could not be added to items that had been executed already (Everything items only)

WebSearch package

  • Added Bing Maps, Google Maps and OpenStreetMaps search sites in the default configuration file.

API

v2.4 - 2016-03-24

CAUTION

  • The default value of the launch_at_startup setting has been changed from yes to no to be less invasive. You may need to update your configuration if you want Keypirinha to keep being launched at startup.
  • WebSearch package: the default value of the new_window setting in the [defaults] section has been changed from yes to no to comply to default system preferences.

Added

  • The Reload Configuration command and menu to reload all configuration files (application and plugins), and to clear the runtime icons cache
  • Non-existent files referenced by items in the history are now filtered out from search results, but kept in history (as it was the case already). Related setting: exclude_nonexistent_remote_files.
  • Docs: some questions in the Frequently Asked Questions (FAQ) chapter

Fixed

  • The new_window and inognito/private_mode settings (global and plugin-specific) where not working when Firefox was the system’s default web browser issue #25
  • LaunchBox: web icons (Bookmarks, WebSearch, ... items) are now refreshed properly when the web_browser setting is changed issue #26
  • Apps package: made extra_paths, env PATH and Start Menu scans more bullet-proof in case an unreadable file/folder gets on its way (issue #19, issue #29)
  • Bookmarks: Firefox bookmarks provider could not read Firefox’s profiles.ini file when its nomenclature format was not exactly the expected one issue #30

Changed

  • LaunchBox: last executed action is now pre-selected in the ACTIONS list. If user skips the ACTIONS list, item will be executed with the default action.
  • The default value of the launch_at_startup setting has been changed from yes to no to be less invasive.
  • WebSearch package: the default value of the new_window setting in the [defaults] section has been changed from yes to no to comply to default system preferences.
  • Minor corrections and improvements

API: Changed

v2.3 - 2016-03-22

WARNING: This version breaks compatibility of the keypirinha.Plugin.on_suggest() API with previous versions. If you are a plugin developer or if you have modified the shipped packages, please ensure to update your code before starting the application. Otherwise, just follow the Install/Update instructions from the documentation.

Added

  • New package: Everything (query Everything to search files and folders from Keypirinha).
  • Docs: the First steps chapter has been stuffed with features that were undocumented so far.
  • geometry settings in the [gui] and [console] sections. Note that due to this addition, default behavior has changed from previous release (i.e. from persistent to auto)
  • web_browser, web_browser_new_window and web_browser_private_mode global settings issue #12
  • Bookmarks package: force_new_window, bookmarks_files, places_files and favorites_dirs settings
  • WebSearch package: Metacritic and MSDN sites in default configuration
  • LaunchBox: the status bar shows the name of the owner package of the currently selected item

Fixed

  • Application was failing to launch if the value of an environment variable had a single dollar sign in it issue #14
  • The default text editor was launched too quickly, which could make its taskbar buttons not to be in order.
  • The windows of the default text editor were not positioned properly on the screen when there were 3 or more configuration files to edit.

Changed

  • Drastically improved the speed of the internal logger in case of flooding
  • Minor corrections, optimizations and improvements
  • Docs: corrections and added some screen shots
  • TaskSwitcher package: item is now kept in history, without its arguments
  • Support chat room has moved

API: Changed

v2.2 - 2016-03-10

Added

  • Bookmarks package: support for the Vivaldi web browser

Fixed

  • Restored compatibility with Windows 7 (Vista support dropped) issue #13
  • Detection of system’s default web browser was incorrect on Windows 10 (impacted packages: Bookmarks and WebSearch) issue #11
  • Bookmarks package: Firefox provider was making the plugin to fail in case user profile was not found.

v2.1 - 2016-03-09

Added

  • New package: Bookmarks (supports Chrome, Firefox and Internet Explorer)
  • Position and size of the LaunchBox and the Console window are now persistent issue #2
  • always_on_top setting issue #1
  • max_height setting
  • Show Change Log menu item and its ChangeLog catalog item
  • Online Documentation menu item and the Online Documentation and Online Help (alias) catalog items
  • Apps package: scan_start_menu and scan_env_path settings issue #4
  • Docs: Update Procedure section
  • Docs: Change Log section
  • Docs: Credits section

Changed

  • GUI: Improved readability by brightening default text colors issue #6
  • Calc package: the = item is not kept in History anymore

API: Deprecated

v2.0 - 2016-03-01

  • First public release

v0 - 2013-05-21

  • Development started