v1.1.0

Codegen Fixes

• Add missing std::json (#387)
• Support optional argument (#387)
• Fix camelcase generation (#387)
• Allow symlinks in project dir (#387)
• Use Executor on generated code for Client/Tx (#390)

v1.0.0

This is the v1.0 release for the edgedb-python client library. It is accompanied by the introduction of a new module edgedb.codegen which can be executed to generate code from .edgeql files.

Breaking Changes

Query Result Type Changes

#366

1. In edgedb-python 1.0, we dropped many custom data structure implementations, and replaced them with Python builtins:

   Impl Dropped	Replacement	Breaking Changes
   edgedb.Tuple	tuple	weakref.ref() will stop working on tuples
   edgedb.Set	list	* Immutability is broken * weakref.ref() will stop working on sets * hash() will stop working on sets * repr() produces different results
   edgedb.Array	list	* Immutability is broken * weakref.ref() will stop working on lists * hash() will stop working on lists

   While the implementations are dropped, the reference name is still there, like edgedb.Tuple is simply an alias of the builtin tuple.

2. edgedb.NamedTuple is reimplemented.

   • [Breaking Change] weakref.ref() will stop working on named tuples.
   • edgedb.NamedTuple is now a subclass of Python builtin tuple.
   • Before named tuple instances are created, a transient heap type DerivedNamedTuple will be created first as a subclass of edgedb.NamedTuple, which is then used to create instances with naming data.
   • DerivedNamedTuple classes are usually cached in codecs, and garbage-collected when all its references are cleared.

3. edgedb.EnumValue is reimplemented.

   • [Breaking Change] The result of repr() is slightly changed to have the edgedb. prefix.
   • edgedb.EnumValue is now a subclass of Python builtin enum.Enum.
   • Before enum values are created, a transient heap type DerivedEnumValue will be created first as a subclass of edgedb.EnumValue, which is then used to create instances with full enumeration. Enum member names are simply upper case strings of corresponding values.
   • DerivedEnumValue classes are usually cached in codecs, and garbage-collected when all its references are cleared.

4. edgedb.Object changes.

   • [Breaking Change] The custom implementation of __hash__() on edgedb.Object is dropped, now hash() simply returns a hash on the memory address.
   • [Breaking Change] The custom implementation of rich comparion is dropped, that means <, >, <=, >= will stop working on edgedb.Object instances, and == is now equivalent to is for edgedb.Object instances.
   • edgedb.Object instances will now yield True for dataclasses.is_dataclass() check.
   • edgedb.Object instances can now be used in dataclasses.as_dict() to recursively generate a dict containing all properties and links (excluding link properties).

5. The performance impact is minimal. We are still using the most efficient C-API and C/Cython implementations to offer query results,

No more Python 3.6

As Python 3.6 is no longer supported itself 10 months ago, edgedb-python is also dropping support for Python 3.6.

edgedb-python 1.0 now supprots only Pyhton 3.7 to Python 3.11.

New Features

Code generation

#363

Now you can create one or more .edgeql files in your EdgeDB project directory, and run:

$ python -m edgedb.codegen

or alternatively:

$ edgedb-py

This command will search through the EdgeDB project directory and generate typesafe query code for the .edgeql files.

Access of link properties

#379

edgedb.Link and edgedb.LinkSet types, as well as the way to access them, are deprecated in edgedb-python 1.0 and will be dropped in 2.0. For example, with a given schema:

type Person {
    multi link friends -> Person {
        property strength -> float32;
    }
}

Expression like person["friends"] will now emit a DeprecationWarning. This deprecates the old way to access link properties like person["friends"][0].strength. Instead, a new way is introduced: you should now use person.friends[0]["@strength"].

Detail Changelog

Changes

• Implement dataclass for EdgeObject (#359) (by @fantix in dfb8c8b for #359)

• Redo edgedb basic types to inherit from builtin types (#366) (by @fantix in b11b991 for #366)

• Officially drop 3.6 support (#373) (by @msullivan in 7b76bc7 for #373)

• Support Python 3.11 (#375) (by @msullivan in 04b0da2 for #375)

• Codegen with the describe_query() API (#363) (by @fantix in 361221d for #363)

• Add codegen docs (#380) (by @colinhacks in 23dd42e for #380)

• Use typing_extension.Literal in codegen for Python 3.7 (by @fantix in 6d0d6ab)

• Add all to edgedb/init.py (by @fmoor in d3ef6d9)

Fixes

• Improve duration parsing (by @fmoor in 241c80d)

• Tweak wording in query_single() error messages (#369) (by @msullivan in e24bb53 for #369)

• Fix flake tests on python3.7 (#371) (by @msullivan in 583e1cb for #371)

• Don't reject tuple arguments on the client side (#370) (by @msullivan in 09c950f for #370)

• Correct edgedb.Client.close() timeout behavior (by @fantix in 33a912c)

• Ping first if conn is idle for too long (#365) (by @fantix in 99cf78a for #365)

• Use @-prefixed keys in object codec for link properties (#384) (by @fantix in 68480f9 for #377)

Deprecations

• Deprecate object links and simplify link property access (#379) (by @fantix in 2c5dcc7 for #379)

v0.24.0

Changes

• Remove DSN from create_client()
  (by @elprans in 9081105 for #303)

• Add support for protocol v1.0
  (by @fantix in 51344fe for #306)

• improve error when passing empty query arguments
  (by @nsidnev in 7a393ec)

• Accept args in execute() and use the new Execute message
  (by @fantix in 5298701 for #310)

• drop legacy agruments encoding with named tuple codec
  (by @nsidnev in ef96e76)

• Stop using Parse, replace use of headers with fields
  (by @elprans in b2c9e4b)

• Change headers format to str:json
  (by @fantix in f17a4fd for #319)

• Document rolling back a transaction
  (by @fmoor in 266f18b)

• Support EDGEDB_WAIT_UNTIL_AVAILABLE environment variable
  (by @fmoor in c27ab36)

• Add with_globals() and friends through state over the protocol
  (by @fantix in 8582ec1 for #315)

• Implement support for range types
  (by @elprans in a415b9f for #332)

• Implement support for cal::date_duration
  (by @elprans in e77615b for #335)

• Recover from failed COMMIT
  (by @fantix in 9f09e78)

• Allow <array<range>> arguments
  (by @fmoor in 243250c for #351)

v0.23.0

Changes

• Retry on TransactionError when attempting to commit
  (by @msullivan in f1bf68d for #299)

v0.22.0

Changes

• Implementation refactor for Client-based interface
  (by @fantix in 33175f1 for #286)

v0.18.0

Changes

• support protocol version 0.12
  (by @fmoor in 5ce52ed)

• Update to protocol version 0.13
  (by @1st1 in c690250, 8by @fmoor in 5ce52ed, by @jaclarke in a5a6218 for #253)

• Lookup edgedb.toml recursively in parent directories
  (by @fmoor in d9a12b8 for #245)

• Update connection parameter resolution
  (by @jaclarke in 085f574 for #241)

• Implement EDGEDB_CLIENT_SECURITY
  (by @fmoor in ac46c37)

• Add optional/required query_single* methods + rename retrying_transaction + update pool to create_client API
  (by @jaclarke in f2ae0d0 for #249)

Deprecations

• Deprecate Pool.acquire() and Pool.release()
  (by @fmoor in 2d501e9 for #217)

• Rename tls_verify_hostname to tls_security
  (by @fmoor in 2086b86)

Fixes

• Do not attempt to del transport in connection_lost if it has been already
  (by @elprans in c719e79 for #215)

• Retry if start() raises a retryable error (#228)
  (by @fantix in ffaae01 for #228)

• Fix broken pool connection cleanup
  (by @fantix in be44959 for #222)

• Fix deprecated usage of SSLContext (#231)
  (by @elprans in f73f999 for #231)

• Bugfix: _borrowed_for is now set entering a transaction (#233)
  (by @fantix in bf763d1 for #233)

• Send zero arguments as zero-length bytes in proto 0.12 (#238)
  (by @tailhook in f51dd51 for #238)

• Fix retrying_transaction() on network errors
  (by @fmoor in cc001e6)

• Fix connection and retry options on AsyncIOPool (#237)
  (by @tailhook in 44e279f for #237)

• Auto retry read-only queries outside transactions (#243)
  (by @fmoor in 76bb586 for #243)

• Fix credentials_file argument typo on async_connect (#252)
  (by @mkniewallner in b21b70a for #252)

v0.17.2

null

v0.17.0

Fixes

• Fix failing tests regarding --help (#207)
  (by @fantix in 956a2ca for #207)

• Fix confusing error when no arguments are passed to a query with named params (#208)
  (by @elprans in 8e0b334 for #208)

• Add Python 3.10 compatibility (#209)
  (by @elprans in 3472f17 for #209)

• Fix asyncio SSL unclosed warning (#210)
  (by @fantix in d718839 for #210)

• More reliable transport double-closing
  (by @fantix in 337b779)

• Rename query_one to query_single
  (by @fmoor in f6900b0)

v0.13.0

• New APIs: conn.retrying_transaction() and conn.raw_transaction().
• conn.transaction() has been deprecated.
• conn.aclose() implements graceful disconnect from the DB server.
• Starting transactions in conn.execute() is no longer allowed.
• wait_until_available parameter for connection APIs.

v0.7.0a5

Fixes

• Fix SCRAM implementation to adhere to the spec
  (by @tailhook in 9935129 for #60)

• Update SASL-related protocol messages
  (by @tailhook in cc95d8d)

• Set protocol version to 0.7
  (by @1st1 in 919a4c7)