Skip to content

Releases: graphql-python/graphene

v3.3.0

26 Jul 06:47
@erikwrede erikwrede
v3.3.0
f5aba2c
This commit was created on GitHub.com and signed with GitHub’s verified signature. The key has expired.
GPG key ID: 4AEE18F83AFDEB23
Expired
Learn about vigilant mode.
Compare
Choose a tag to compare
v3.3.0 Latest
Latest

This release brings two new features and several fixes and semantic upgrades due to new Python features. Thanks to everyone that contributed! 😊

Default value for InputObjectTypes

⚠️⚠️ACTION REQUIRED⚠️⚠️
In GraphQL, inputs can have fields which are optional. Currently, if those fields are not specified in the query, they are passed to the python inputs as None. This renders them indistinguishable from fields that are actually passed to the query with a value of null. While the alternative would be to check the definition via "key" in input, it is more accessible to mark these fields as explicitly UNDEFINED.
This PR adds a new global override, which allows unspecified fields to be set to graphql.UNDEFINED. In the future, the default Value will be set to UNDEFINED, making this a soft migration and deprecation of the previous situation.

This is a soft migration. Long-Term, the Input Objects will ALWAYS contain the value UNDEFINED Make sure your code supports these cases in None checks. After the default has been set to UNDEFINED, you will still be able to switch back to None for the foreseeable future.

Strict connection types support in Relay

Custom Relay connection classes can now be made NonNull using the strict_types option on the connection meta.

Using this example

  class MyObjectConnection(Connection):
      class Meta:
          node = MyObject
          strict_types = True

will change from

type MyObjectConnection {
   edges: [MyObjectEdge]
}

to

type MyObjectConnection {
   edges: [MyObjectEdge!]!
}

Caveats

We want to make sure you're informed about using NonNull relay connections. While they are a great way to get rid of some null checks in typed frontends, it's important to be mindful of error handling with these connections. When working with NonNull connections, it's crucial to remember that if a requested field or edge is not available or the resolver throws an error, the error will bubble up to the next nullable parent field, which is oftentimes the root node. That way, you cannot handle partial results in case of partial errors anymore. In a nullable connection, only the nullable fields will be set to null and the error will not bubble up.

To address this, we recommend considering waiting for the future release of client-controlled nullability for cases where certain connections might be nullable. By opting for client-controlled nullability, you gain more control over error handling, enabling you to handle potential null values more gracefully and enhance the overall user experience. Read more about client controlled nullability here: graphql/graphql-spec#867

What's Changed

  • Default enum description to "An enumeration." by @firaskafri in #1502
  • Allow the user to change InputObjectType's default value on non-specified inputs to a sentinel value by @flipbit03 in #1506
  • 881: Corrected enum metaclass to fix pickle.dumps() by @senseysensor in #1495
  • chore: Use typing.TYPE_CHECKING instead of MYPY by @rapsealk in #1503
  • test: print schema with InputObjectType with DateTime field with default_value (#1293) by @ransomw in #1513
  • docs: add get_human function by @conao3 in #1380
  • CI: drop python 3.6 by @dulmandakh in #1507
  • types: add option for strict connection types by @shrouxm in #1504

New Contributors

Full Changelog: v3.2.2...v3.3.0

Contributors

dulmandakh, senseysensor, and 6 other contributors
Assets 2

v3.2.2

13 Mar 20:25
@erikwrede erikwrede
v3.2.2
57cbef6
This commit was created on GitHub.com and signed with GitHub’s verified signature. The key has expired.
GPG key ID: 4AEE18F83AFDEB23
Expired
Learn about vigilant mode.
Compare
Choose a tag to compare
v3.2.2

This release provides some internal refactoring to the relay types to improve support for adding custom fields to them.

Assets 2

v3.2.1

11 Dec 20:07
@erikwrede erikwrede
v3.2.1
340d5ed
This commit was created on GitHub.com and signed with GitHub’s verified signature. The key has expired.
GPG key ID: 4AEE18F83AFDEB23
Expired
Learn about vigilant mode.
Compare
Choose a tag to compare
v3.2.1

What's Changed

Non-required InputFields and Arguments can now be marked as deprecated by passing the deprecation_reason keyword argument to the constructor.

  • Complete deprecated fields and arguments support by @vhutov in #1472

New Contributors

Full Changelog: v3.2.0...v3.2.1

Contributors

vhutov
Assets 2

v3.2.0

09 Dec 10:20
@erikwrede erikwrede
v3.2.0
d5dadb7
This commit was created on GitHub.com and signed with GitHub’s verified signature. The key has expired.
GPG key ID: 4AEE18F83AFDEB23
Expired
Learn about vigilant mode.
Compare
Choose a tag to compare
v3.2.0

What's Changed

Support for custom global IDs in relay.Node

The global ID type of a Node can now be customized:

class CustomNode(Node):
    class Meta:
        global_id_type = CustomGlobalIDType


class User(ObjectType):
    class Meta:
        interfaces = [CustomNode]

    name = String()

    @classmethod
    def get_node(cls, _type, _id):
        return self.users[_id]
Available Types

Currently, the following types are available:

  • DefaultGlobalIDType: Default global ID type: base64 encoded version of ": ". (Previously the only option) Scalar: ID
  • SimpleGlobalIDType : Simple global ID type: simply the id of the object. Scalar: ID
  • UUIDGlobalIDType : UUID global ID type. Scalar: UUID
Customization

To create a custom global type, BaseGlobalIDType must be extended:

class CustomGlobalIDType(BaseGlobalIDType):

    graphene_type = CustomScalar

    @classmethod
    def resolve_global_id(cls, info, global_id):
        _type = custom_get_type_from_global_id(global_id)
        return _type, global_id

    @classmethod
    def to_global_id(cls, _type, _id):
        return _id

graphene_type specifies the type of scalar to be used in the schema. Remember, that if you're using ID as a scalar, you might need to deserialize your custom global ID first!

Relevant PR:

Fixes & Improvements:

All Changes

New Contributors

Full Changelog: v3.1.1...v3.2.0

Contributors

bkad, erikwrede, and 4 other contributors
Assets 2

v3.1.1

08 Sep 09:26
@erikwrede erikwrede
v3.1.1
b20bbdc
This commit was created on GitHub.com and signed with GitHub’s verified signature. The key has expired.
GPG key ID: 4AEE18F83AFDEB23
Expired
Learn about vigilant mode.
Compare
Choose a tag to compare
v3.1.1

What's changed

Dataloader

Graphene now includes an updated version of aiodataloader by Syrus Akbary under graphene.utils.dataloader due to inactivity of the old repository. The update fixes an issue some users experienced when trying to use dataloader in conjunction with pytest (syrusakbary/aiodataloader#13). Further contributions and updates to dataloader in this repo are welcome!

Enums

A custom typename can now be added when using from_enum:

    from enum import Enum as PyEnum

    class Color(PyEnum):
        RED = 1
        YELLOW = 2
        BLUE = 3

    GColor = Enum.from_enum(Color, description="original colors")
    UniqueGColor = Enum.from_enum(
        Color, name="UniqueColor", description="unique colors"
    )
type Query {
    color: Color!
    uniqueColor: UniqueColor!
}
"""original colors"""
enum Color {
    RED
    YELLOW
    BLUE
}
"""unique colors"""
enum UniqueColor {
    RED
    YELLOW
    BLUE
}
  • feat: add ability to provide a type name to enum when using from_enum by @tcleonard in #1430

Interfaces

Interfaces extending interfaces is now supported!

    class FooInterface(Interface):
        foo = String()

    class BarInterface(Interface):
        class Meta:
            interfaces = [FooInterface]

        foo = String()
        bar = String()
interface FooInterface {
  foo: String
}

interface BarInterface implements FooInterface {
  foo: String
  bar: String
}

Thank you to everyone that contributed to this release!

Other Changes

New Contributors

Full Changelog: v3.1.0...v3.1.1

Contributors

ulgens, jkimbo, and 12 other contributors
Assets 2

v3.1.0

30 May 12:58
@jkimbo jkimbo
v3.1.0
5475a7a
This commit was created on GitHub.com and signed with GitHub’s verified signature. The key has expired.
GPG key ID: 4AEE18F83AFDEB23
Expired
Learn about vigilant mode.
Compare
Choose a tag to compare
v3.1.0

What's Changed

New Contributors

Full Changelog: v3.0.0...v3.1.0

Contributors

justinrmiller, Cito, and 4 other contributors
Assets 2

v3.0.0

13 Nov 22:20
@mvanlonden mvanlonden
v3.0.0
27f19e5
Compare
Choose a tag to compare
v3.0.0

Release notes

The full release notes including an upgrade guide can be found here: https://github.com/graphql-python/graphene/wiki/v3-release-notes

What's Changed

New Contributors

Read more

Contributors

zbyte64, fabaff, and 40 other contributors
Assets 2

v3.0.0b8

30 Sep 06:47
@ekampf ekampf
v3.0.0b8
0a54094
This commit was created on GitHub.com and signed with GitHub’s verified signature. The key has expired.
GPG key ID: 4AEE18F83AFDEB23
Expired
Learn about vigilant mode.
Compare
Choose a tag to compare
v3.0.0b8 Pre-release
Pre-release

Changes

  • fix: graphql-core dependency resolution. (#1377)

All changes: graphql-python/graphene-django@v3.0.0b7...v3.0.0b8

Assets 2

v2.1.9

16 Jul 20:09
@jkimbo jkimbo
v2.1.9
7d2af31
Compare
Choose a tag to compare
v2.1.9

Changelog

  • Add support for Python 3.10
  • Propagate arguments of relay.NodeField to Field (#1036) (#1307)
Assets 2

v3.0.0b7

06 Jan 10:01
@jkimbo jkimbo
v3.0.0b7
2e87ebe
This commit was created on GitHub.com and signed with GitHub’s verified signature. The key has expired.
GPG key ID: 4AEE18F83AFDEB23
Expired
Learn about vigilant mode.
Compare
Choose a tag to compare
v3.0.0b7 Pre-release
Pre-release

Changes

  • fix(Decimal): parse integers as decimal. (#1295)

All changes: graphql-python/graphene-django@v3.0.0b6...v3.0.0b7

Assets 2