Whats New

This page keeps a detailed human friendly rendering of what’s new and changed in specific versions.

v2.0.0

Breaking Changes

• Remove flogin.jsonrpc.errors.JsonRPCVersionMismatch

• API Methods now raise flogin.jsonrpc.errors.JsonRPCException instead of returning an instance of flogin.jsonrpc.responses.ErrorResponse

New Features

• Rewrite flogin.jsonrpc.errors.JsonRPCException

• Add flogin.jsonrpc.errors.ParserError

• Add flogin.jsonrpc.errors.InvalidRequest

• Add flogin.jsonrpc.errors.MethodNotFound

• Add flogin.jsonrpc.errors.InvalidParams

• Add flogin.jsonrpc.errors.InternalError

• Add flogin.jsonrpc.errors.FlowError

• Add the ability to use flogin.plugin.Plugin.search() as a classmethod

• Allow flogin.jsonrpc.results.Result.callback() to return bool and None ontop of flogin.jsonrpc.responses.ExecuteResponse

• Add the name argument in the flogin.utils.print() function.

• Add flogin.pip.Pip

• Add flogin.errors.PipException

• Add flogin.errors.UnableToDownloadPip

• Add flogin.errors.PipExecutionError

Bug Fixes

• Fix bugs with how errors were handled inproperly

• Fix bug with flogin.query.Query.keyword showing an empty string instead of * when a star keyword is used.

• Fix bug with log formatting being eager, resulting in unneccessary formatting when logs are disabled.

v1.1.0

New Features

• Add flogin.caching.cached_callable()

• Add flogin.plugin.Plugin.flow_version

• Add flogin.plugin.Plugin.flow_program_dir

• Add flogin.plugin.Plugin.flow_application_dir

• Add the flow_version, flow_program_dir, and flow_application_dir keyword arguments to flogin.testing.plugin_tester.PluginTester

• Add flogin.errors.EnvNotSet

• Add flogin.utils.print()

• Add the ability to use flogin.plugin.Plugin.event() as a classmethod

Bug Fixes

• Fix bug where auto_complete_text, preview, and progress_bar aren’t present in ResultConstructorArgs

• Fix typo in the logs where result is spelled as reuslt in the default flogin.jsonrpc.results.Result.on_error() implementation

• Fix mistake where the logs generated by the default implementation of flogin.search_handler.SearchHandler.on_error() say the error comes from a reuslt callback, and ot a search handler callback.

v1.0.0

Breaking Changes

• Move flogin.jsonrpc.results.Glyph support from flogin.jsonrpc.results.Result.icon to flogin.jsonrpc.results.Result.glyph

• Return None if a setting is not found in flogin.settings.Setting

  • Remove flogin.errors.SettingNotFound

• Rewrite the CLI commands

• Remove flogin.conditions.MultiCondition in favor of flogin.conditions.AnyCondition and flogin.conditions.AllCondition

• Remove Query.from_json

• For flogin.testing.plugin_tester.PluginTester.test_query(), switch from receiving a query object to taking kwargs that will be used to make a query object

• Rename the flogin.flow_api directory to flogin.flow

  • Rename flogin.flow_api.client.py to flogin.flow.api.py

• Undocument flogin.utils.cached_property

• Remove flogin.utils.cached_coro

• Remove flogin.utils.cached_gen

New Features

• Add Query.__repr__

• Let flogin.search_handler.SearchHandler.callback() and flogin.jsonrpc.results.Result.context_menu() return None

• Add Generic to flogin.search_handler.SearchHandler for flogin.search_handler.SearchHandler.plugin

• Add Generic to flogin.jsonrpc.results.Result for flogin.jsonrpc.results.Result.plugin

• Update Query.__init__ to allow for an easier time manually creating query objects.

• Add the ability to supply a default into flogin.settings.Settings.__getitem__

• Add a generic to flogin.plugin.Plugin for a custom flogin.settings.Settings class.

• Document the generic in flogin.jsonrpc.results.Result for a custom plugin class.

• Document the generic in flogin.search_handler.SearchHandler.plugin for a custom plugin class.

• Document the generic in flogin.query.Query for flogin.query.Query.condition_data

• Make flogin.jsonrpc.results.Result.title optional

• Add flogin.conditions.AnyCondition

• Add flogin.conditions.AllCondition

• Add flogin.query.Query.update_results()

• Add flogin.query.Query.update()

• Add flogin.flow.settings.py

  • Add flogin.flow.settings.CustomFileManager

  • Add flogin.flow.settings.CustomBrowser

  • Add flogin.flow.settings.CustomPluginHotkey

  • Add flogin.flow.settings.CustomQueryShortcut

  • Add flogin.flow.settings.HttpProxy

  • Add flogin.flow.settings.PartialPlugin

  • Add flogin.flow.settings.PluginsSettings

  • Add flogin.flow.settings.FlowSettings

• Add flogin.flow.enums.py

  • Add flogin.flow.enums.LastQueryMode

  • Add flogin.flow.enums.SearchWindowScreens

  • Add flogin.flow.enums.SearchWindowAligns

  • Add flogin.flow.enums.AnimationSpeeds

  • Add flogin.flow.enums.SearchPrecisionScore

• Add flogin.plugin.Plugin.fetch_flow_settings()

• Add flogin.plugin.Plugin.last_query

• Add flogin.caching.cached_property()

• Add flogin.caching.cached_coro()

• Add flogin.caching.cached_gen()

• Add flogin.caching.clear_cache()

• Support python 3.13

• Add the ignore_cancellation_requests and settings_no_update parameters to the flogin.plugin.Plugin constructor

• Add SearchHandler.__init_subclassed__ with the same kwargs as flogin.search_handler.SearchHandler() and flogin.plugin.Plugin.search()

• Add keyword, allowed_keywords, text, patterns, and disallowed_keywords kwargs to flogin.search_handler.SearchHandler

• Add keyword, allowed_keywords, and disallowed_keywords kwargs to flogin.plugin.Plugin.search()

• Document the on_close event

Bug Fixes

• Fix bug where flogin.flow.api.FlowLauncherAPI.update_results() does not register the results, so callbacks do not get triggered.

• Fix typing bug with flogin.plugin.Plugin.register_search_handlers() and flogin.plugin.Plugin.register_search_handler() due to flogin.search_handler.SearchHandler being a generic.

• Fix bug where Glyph was not included in ResultConstructorArgs

• Fix bug with the PluginT TypeVar not being marked as covariant

• Fix bug with the default settings reader looking for the wrong path.

• Fix some typos in the docs

• Fix deadlock on shutdown due to flogin not sending a response

Removals

• Remove the CLI docs section

• Remove click as a dependency.

v0.0.5

New Features

• Add flogin.plugin.Plugin.register_search_handlers()

• Add the Whats New section in the docs

• Add flogin.plugin.Plugin.register_event()

• Add flogin gh gitignore CLI command

• Add flogin.jsonrpc.results.ResultPreview

  • Add preview

• Add flogin.jsonrpc.results.ProgressBar

  • Add flogin.jsonrpc.results.Result.progress_bar

• Add flogin.jsonrpc.results.Result.auto_complete_text

• Add flogin.jsonrpc.results.Glyph

  • Allow Glyph objects in flogin.jsonrpc.results.Result.icon

• Add flogin.jsonrpc.results.Result.rounded_icon

• Add flogin create settings CLI command

• Add flogin.utils.cached_gen()

Bug Fixes

• Fixed bug with the create plugin.json CLI command dumping the wrong data.

• Add the missing dependency click

• Fix bug where flogin.search_handler.SearchHandler.plugin is None when flogin.search_handler.SearchHandler.condition is ran.

• Fix an AttributeError that gets raised in a couple of FlowLauncherAPI methods

• Log fatal errors that cause startup crashes to prevent them from being hidden.

• Fix bug where rounded_icon was not present in ResultConstructorArgs

• Fix a NameError that gets raised in the default flogin.jsonrpc.results.Result.callback()

• Fix bug where flogin.plugin.Plugin.settings will be replaced with a new Settings instance every time a new query request is received, preventing making setting changes.