v3.6.0

Version 3.6.0

In this release, test coverage is 74%.

💥 New features:

• Improved dark/light mode theme update:
  • The theme mode may be changed during the application lifetime
  • Added methods update_color_mode on CodeEditor and ConsoleBaseWidget widgets

Version 3.5.3

In this release, test coverage is 74%.

🛠️ Bug fixes:

• Configuration initialization on Windows:

  • For various reasons, a PermissionError exception may be raised when trying to remove the configuration file on Windows, just after having created it for the first time. This is due to the fact that the file is still locked by the file system, even if the file has been closed. This is a known issue with Windows file system, and the solution is to wait a little bit before trying to remove the file.
  • To fix this issue, a new try_remove_file function has been added to the userconfig module, which tries multiple times to remove the file before raising an exception.

• Moved back conftest.py to the tests folder (was in the root folder), so that pytest can be executed with proper configuration when running the test suite from the installed package

v3.5.3

In this release, test coverage is 74%.

🛠️ Bug fixes:

• Configuration initialization on Windows:

  • For various reasons, a PermissionError exception may be raised when trying to remove the configuration file on Windows, just after having created it for the first time. This is due to the fact that the file is still locked by the file system, even if the file has been closed. This is a known issue with Windows file system, and the solution is to wait a little bit before trying to remove the file.
  • To fix this issue, a new try_remove_file function has been added to the userconfig module, which tries multiple times to remove the file before raising an exception.

• Moved back conftest.py to the tests folder (was in the root folder), so that pytest can be executed with proper configuration when running the test suite from the installed package

v3.5.2

Version 3.5.2

In this release, test coverage is 74%.

🛠️ Bug fixes:

• Add support for NumPy 2.0:
  • Use numpy.asarray instead of numpy.array(..., copy=False)
  • Remove deprecated numpy.core.multiarray module import

Version 3.5.1

In this release, test coverage is 74%.

🛠️ Bug fixes:

• PR #74 - configtools.font_is_installed: fix PySide2 compat. issue (thanks to @xiaodaxia-2008)
• Creating a dataset using the create class method:
  • Before, passing unknown keyword arguments failed silently (e.g. MyParameters.create(unknown=42)).
  • Now, an AttributeError exception is raised when passing unknown keyword arguments, as expected.
• Processing Qt event loop in unattended mode before closing widgets and quitting the
  application, so that all pending events are processed before quitting: this includes
  for instance the drawing events of widgets, which may be necessary to avoid a crash
  when closing the application (e.g. if drawing the widget is required for some
  reason before closing it) or at least to ensure that test coverage includes all
  possible code paths.

ℹ️ Other changes:

• Preparing for NumPy V2 compatibility: this is a work in progress, as NumPy V2 is not
  yet released. In the meantime, requirements have been updated to exclude NumPy V2.
• Internal package reorganization: moved icons to guidata/data/icons folder
• The delay command line option for environment execution object execenv is now
  expressed in milliseconds (before it was in seconds), for practical reasons
• Explicitely exclude NumPy V2 from the dependencies (not compatible yet)

Version 3.5.0

In this release, test coverage is 74%.

💥 New features:

• New Sphinx autodoc extension:
  • Allows to document dataset classes and functions using Sphinx directives, thus generating a comprehensive documentation for datasets with labels, descriptions, default values, etc.
  • The extension is available in the guidata.dataset.autodoc module
  • Directives:
    • autodataset: document a dataset class
    • autodataset_create: document a dataset creation function
    • datasetnote: add a note explaining how to use a dataset
• BoolItem/TextItem: add support for callbacks when the item value changes

🛠️ Bug fixes:

• Documentation generation: automatic requirement table generation feature was failing
  when using version conditions in the pyproject.toml file (e.g. pyqt5 >= 5.15).
• Issue #72 - unit test leave files during the build usr/lib/python3/dist-packages/test.json
• Issue #73 - ChoiceItem radio buttons are duplicated when using callbacks

v3.5.1

Version 3.5.1

In this release, test coverage is 74%.

🛠️ Bug fixes:

• PR #74 - configtools.font_is_installed: fix PySide2 compat. issue (thanks to @xiaodaxia-2008)
• Creating a dataset using the create class method:
  • Before, passing unknown keyword arguments failed silently (e.g. MyParameters.create(unknown=42)).
  • Now, an AttributeError exception is raised when passing unknown keyword arguments, as expected.
• Processing Qt event loop in unattended mode before closing widgets and quitting the
  application, so that all pending events are processed before quitting: this includes
  for instance the drawing events of widgets, which may be necessary to avoid a crash
  when closing the application (e.g. if drawing the widget is required for some
  reason before closing it) or at least to ensure that test coverage includes all
  possible code paths.

ℹ️ Other changes:

• Preparing for NumPy V2 compatibility: this is a work in progress, as NumPy V2 is not
  yet released. In the meantime, requirements have been updated to exclude NumPy V2.
• Internal package reorganization: moved icons to guidata/data/icons folder
• The delay command line option for environment execution object execenv is now
  expressed in milliseconds (before it was in seconds), for practical reasons
• Explicitely exclude NumPy V2 from the dependencies (not compatible yet)

v3.5.0

In this release, test coverage is 74%.

💥 New features:

• New Sphinx autodoc extension:
  • Allows to document dataset classes and functions using Sphinx directives, thus generating a comprehensive documentation for datasets with labels, descriptions, default values, etc.
  • The extension is available in the guidata.dataset.autodoc module
  • Directives:
    • autodataset: document a dataset class
    • autodataset_create: document a dataset creation function
    • datasetnote: add a note explaining how to use a dataset
• BoolItem/TextItem: add support for callbacks when the item value changes

🛠️ Bug fixes:

• Documentation generation: automatic requirement table generation feature was failing
  when using version conditions in the pyproject.toml file (e.g. pyqt5 >= 5.15).
• Issue #72 - unit test leave files during the build usr/lib/python3/dist-packages/test.json
• Issue #73 - ChoiceItem radio buttons are duplicated when using callbacks

v3.4.1

In this release, test coverage is 76%.

🛠️ Bug fixes:

• Issue #71 - Random segmentation faults with applications embedding CodeEditor
• Issue #70 - PermissionError: [Errno 13] Permission denied: '/usr/lib/python3/dist-packages/guidata/tests/data/genreqs/requirements.rst'

v3.4.0

In this release, test coverage is 76%.

💥 New features:

• dataset.io.h5fmt.HDF5Reader.read method: added new default argument to set
  default value for missing data in the HDF5 file (backward compatible). The default
  value of default is NoDefault (a special value to indicate that no default value
  should be used, and that an exception should be raised if the data is missing).
• widgets.codeeditor.CodeEditor: added new inactivity_timeout argument to set
  the time (in milliseconds) to wait after the user has stopped typing before
  emitting the CodeEditor.SIG_EDIT_STOPPED signal.
• Added execenv.accept_dialogs attribute to control whether dialogs should be
  automatically accepted or not (default is None, meaning no automatic acceptance):
  this allows more coverage of the test suite. For now, this attribute has only been
  proven useful in tests/dataset/test_all_features.py.
• Added unit tests for HDF5 and JSON serialization/deserialization:
  • Testing an arbitrary data model saved/loaded to/from HDF5 and JSON files,
    with various data sets and other data types.
  • Testing for backward compatibility with previous versions of the data model
    (e.g. new attributes, removed attributes, etc.)

⚠️ API breaking changes:

• guidata.dataset.io module is now deprecated and will be removed in a future
  release. Please use guidata.io instead. This change is backward compatible
  (the old module is still available and will be removed in a future release).
  The motivation for this change is to simplify the module structure and to help
  understand that the scope of the io module is not limited to dataset.DataSet
  objects, but may be used for any kind of data serialization/deserialization.

📖 Documentation:

• Added missing DataSetEditDialog and DataSetEditLayout classes
• Added missing inheritance/member details on some classes
• Reduced table of contents depth in left sidebar for better readability

v3.3.0

💥 New features:

• Array editor now supports row/column insertion/deletion:
  • Added variable_size argument to setup_and_check method
  • The feature is disabled by default (backward compatible)
  • It supports standard arrays, masked arrays, record arrays and N-dimensional arrays
• New dataset read-only mode:
  • Added readonly argument to DataSet constructor
  • This is useful to create a dataset that will be displayed in read-only mode
    (e.g. string editing widgets will be in read-only mode: text will be selectable
    but not editable)
  • The items remain modifiable programmatically (e.g. dataset.item = 42)
• New dataset group edit mode:
  • Added mode argument to DataSetGroup.edit method, with the following options:
    • mode='tabs' (default): each dataset is displayed in a separate tab
    • mode='table': all datasets are displayed in a single table
  • In the new table mode, the datasets are displayed in a single table with
    one row per dataset and one column per item
  • Clicking on a row will display the corresponding dataset in a modal dialog box

🛠️ Bug fixes:

• Qt console:
  • Fixed RuntimeError: wrapped C/C++ object of type DockableConsole has been deleted
    when closing the console widget (parent widget, e.g. a QMainWindow, was deleted)
    while an output stream is still writing to the console (e.g. a logging handler
    which will flush the output stream when closing the application)
  • This concerns all console-related widgets: DockableConsole, Console,
    InternalShell, PythonShellWidget and ShellBaseWidget
• Code editor: fixed compatibility issue with PySide6
  (AttributeError: 'QFont' object has no attribute 'Bold')

v3.2.2 - Maintenance release

Version 3.2.2

🛠️ Bug fixes:

• Fixed translation support (gettext):
  • Locale detection has been fixed in 3.1.1 (deprecation of locale.getdefaultlocale)
  • However, on frozen distributions on Windows (e.g. with pyinstaller), function
    locale.getlocale is returning (None, None) instead of proper locale infos
  • Added a workaround: on Windows, if locale can't be detected, we now use the
    Windows API to retrieve it (using the GetUserDefaultLocaleName function)
  • Issue #68 - Windows: gettext translation is not working on frozen applications
• Embedded Qt console:
  • Fixed default encoding detection on frozen applications on Windows
  • Issue #69 - Windows/Qt console: output encoding is not detected on frozen applications

Version 3.2.1

🛠️ Bug fixes:

• Tests only: qthelpers.close_widgets_and_quit now ignores deleted widgets

💥 Changes:

• dataset.ImageChoiceItem and dataset.ButtonItem: added size argument to set the icon size
• dataset.io reader and writer classes: removed deprecated write_unicode method

Version 3.2.0

🛠️ Bug fixes:

• Issue #67 - JSONReader/Deserializing object list: TypeError: 'NoneType' object is not subscriptable

💥 Changes:

• qthelpers.qt_wait: added show_message and parent arguments (backward compatible)
• qthelpers.qt_app_context: removed faulthandler support (this need to be handled at the application level, see for example DataLab's implementation)
• Disabled command line argument parsing in guidata.env module:
  • The guidata library is parsing command line arguments for the purpose of creating the environment execution object named execenv (see guidata.env module). This object is used to determine the execution environment mainly for testing purposes: for example, to bypass the Qt event loop when running tests thanks to the --unattended command line option.
  • However this argument parsing is not always desirable, for example when using guidata as a dependency in another library or application. This is why the parsing mechanism is now disabled by default, and may be enabled by setting the environment variable GUIDATA_PARSE_ARGS to 1 (or any other non-empty value). As of today, it is still unclear if there will be a need to enable this mechanism in the future, so this is why the environment variable is used instead of a function argument.
• Removed deprecated guidata.disthelpers module (we recommend using PyInstaller instead)

v3.2.1 - Maintenance release

Version 3.2.1

🛠️ Bug fixes:

• Tests only: qthelpers.close_widgets_and_quit now ignores deleted widgets

💥 Changes:

• dataset.ImageChoiceItem and dataset.ButtonItem: added size argument to set the icon size
• dataset.io reader and writer classes: removed deprecated write_unicode method