CHANGELOG.md

Changelog

All notable changes to this project will be documented in this file.

The format is based on Keep a Changelog, and this project adheres to Semantic Versioning.

[Unreleased]

Added

• New setup extra test which installs the dependencies for testing.

Changed

Deprecated

Removed

• Support for Python 3.8

Fixed

• #73 Entity.to_xml now detects potentially infinite recursion and prevents an error
• #89 to_xml does not add noscript or TransactionBenchmark tags anymore
• #103 authentication/interface/on_response() does not overwrite auth_token if new value is None
• #119 The diff returned by compare_entities now uses id instead of name as key if either property does not have a name

Security

Documentation

[0.16.0] - 2024-11-13

Added

• ParentList and PropertyList now have a filter function that allows to select a subset of the contained elements by ID and/or name.
• Official support for Python 3.13
• Added arguments to describe_diff that allow customizing the labels for the 'old' and the 'new' diffs.
• Optional realm argument for linkahead_admin.py set_user_password which defaults to None, i.e., the server's default realm.

Changed

• compare_entities is now case insensitive with respect to property and recordtype names
• _ParentList is now called ParentList
• _Properties is now called PropertyList
• ParentList.remove is now case insensitive when a name is used.

Deprecated

• the use of the arguments old_entity and new_entity in compare_entities is now deprecated. Please use entity0 and entity1 respectively instead.

Fixed

• gitlab.indiscale.com#200 linkahead_admin.py prints reasonable error messages when users or roles don't exist.

[0.15.1] - 2024-08-21

Deprecated

• connection.get_username. Use la.Info().user_info.name instead.

Fixed

• #128 Assign datetime.date or datetime.datetime values to DATETIME properties.

Documentation

• Added docstrings for linkahead.models.Info and linkahead.models.UserInfo.

[0.15.0] - 2024-07-09

Added

• Support for Python 3.12
• The linkahead module now opts into type checking and supports mypy.
• #112 Entity.update_acl now supports optional **kwargs that are passed to the Entity.update method that is called internally, thus allowing, e.g., updating the ACL despite possible naming collisions with unique=False.
• a role argument for get_entity_by_name and get_entity_by_id

Changed

• Using environment variable PYLINKAHEADINI instead of PYCAOSDBINI.

Removed

• Support for Python 3.7

Fixed

• #104 Selecting parts of a Container with a slice used to return a list object instead of a Container, removing all useful methods of the Container class. This has been fixed and using a slice such as [:2] now returns a new Container.
• #120 Unwanted subproperties in reference properties.

Documentation

• Added documentation and a tutorial example for the usage of the page_length argument of execute_query.

[0.14.0] - 2024-02-20

Added

• utils.merge_entities now has a merge_id_with_resolved_entity keyword which allows to identify property values with each other in case that one is an id and the other is an Entity with this id. Default is False, so no change to the default behavior.
• apiutils.escape_quoted_text for escaping text in queries.

Changed

• cached_query() now also caches uniqueness related exceptions.

[0.13.2] - 2023-12-15

Fixed

• #113 Container could fail to delete when there were reference properties.
• HTTP status 431 (Headers too long) now also raises an URI too long exception.

[0.13.1] - 2023-10-11

Fixed

• no Error when no configuration file is used Issue

[0.13.0] - 2023-10-10

Added

• New page_length parameter for caosdb.execute_query and caosdb.Query.execute. See docstrings for more details.
• Entity.remove_value_from_property function that removes a given value from a property and optionally removes the property if it is empty afterwards.

Changed

• _Messages is now Messages and inherits from list instead of dict
• Message.__init__ signature changed and type defaults to "Info" now.
• Message.__eq__ changed. Equality is equality of type, code, and description now.
• Rename from CaosDB to LinkAhead. For proper migration, follow the instructions in migration_to_linkahead.md and check the documentation at docs.indiscale.com.

Deprecated

• The API of Messages has been simplified and some ways to interact with messages have been deprecated. Warnings are raised correspondingly.
• Message.get_code. Use the code property instead.

Fixed

• Detection for cyclic references when converting entites using the high level API.

[0.12.0] - 2023-06-02

Added

• Added location argument to src/caosdb/utils/checkFileSystemConsistency.py
• Entity getters: get_entity_by_<name/id/path>
• Cached versions of entity getters and of execute_query (cached_query)

Deprecated

• getOriginUrlIn, getDiffIn, getBranchIn, getCommitIn (formerly apiutils) have been moved to caosdb.utils.git_utils

Fixed

• Fixed src/caosdb/utils/checkFileSystemConsistency.py

Documentation

• #83 - Improved documentation on adding REFERENCE properties, both in the docstring of Entity.add_property and in the data-insertion tutorial.

[0.11.2] - 2023-03-14

Fixed

• root logger is no longer used to create warnings. Fixes undesired output in stderr

[0.11.1] - 2023-03-07

(Florian Spreckelsen)

Changed

• Renamed caosdb.common.models._Parents to caosdb.common.models._ParentList.

Fixed

• caosdb-pylib#90: Entity.get_parents_recursively() did not work for unretrieved parents.

[0.11.0] - 2023-01-19

(Florian Spreckelsen)

Added

• apiutils.EntityMergeConflictError class for unresesolvable merge conflicts when merging two entities
• Re-introduced support for Python 3.7

Changed

• apiutils.merge_entities now raises an EntityMergeConflictError in case of unresolvable merge conflicts.

Fixed

• #82 Merging an entity with properties with missing datatype leads to Exception - The correct exception is raised in case of a missing LIST datatype.

Documentation

• Fixed {action}_entity_permissions help line.

[0.10.0] - 2022-11-14

(Florian Spreckelsen)

Added

• HTTP connections are allowed additionally to HTTPS connections.
• Dependency on the requests package.
• Dependency on the python-dateutil package.
• Connection.https_proxy and Connection.http_proxy option of the pycaosdb.ini and the https_proxy and http_proxy parameter of the configure_connection function. See the documentation of the latter for more information. Note that the HTTP_PROXY and HTTPS_PROXY environment variables are respected as well, unless overridden programmatically.
• apiutils.empty_diff function that returns True if the diffs of two entities found with the compare_entitis function are empty, False otherwise.

Changed

• apiutils.compare_entities now has an optional compare_referenced_records argument to compare referenced Entities recursively (fomerly, only the referenced Python objects would be compared). The default is False to recover the original behavior.
• apiutils.merge_entities now has an optional merge_references_with_empty_diffs argument that determines whether a merge of two entities will be performed if they reference identical records (w.r.t th above empty_diff function). Formerly this would have caused a merge conflict if the referenced record(s) were identical, but stored in different Python objects.
• apiutils.merge_entities now has an optional force argument (defaults to False, i.e., the old behavior) which determines whether in case of merge conflicts errors will be raised or the properties and attributes of entity A will be overwritten by entity B.

Deprecated

• Connection.socket_proxy option of the pycaosdb.ini. Please use Connection.https_proxy or Connection.http_proxy instead. The deprecated option will be removed with the next minor release.

Fixed

• handling of special attributes (name, id, ...) in apiutils.empty_diff

[0.9.0] - 2022-10-24

(Florian Spreckelsen)

Added

• Add TimeZone class and parse the server's time zone in the Info response.

Fixed

• #141 (closed) password_method = unauthenticated not allowed by schema
• Set PyYAML dependency back to PyYaml>=5.4.1 (from 6.0) for better compatibility with docker-compose

Documentation

• Added curator role permissions example to code gallery

[0.8.0] - 2022-07-12

(Timm Fitschen)

Removed

• Support for Python 3.6 and Python 3.7

Fixed

• read() of MockupResponse returns now an appropriate type on modern systems
• caosdb-server#142 Can't create users with dots in their user names

[0.7.4] - 2022-05-31

(Florian Spreckelsen)

Fixed

• #64 Use Dict[] and List[] from typing for type hinting instead of dict[] and list[] for compatibility with Python<3.9.

[0.7.3] - 2022-05-03

(Henrik tom Wörden)

Added