brk-code

gql の API リファレンス

gql (graphql-python/gql) の公開 API 51 件 —— クラス 21、関数 5、メソッド 25。実際のソースを静的解析して抽出した正確なシグネチャを掲載しています。

リポジトリ: graphql-python/gql

種別件数
クラス21
関数5
メソッド25

API 一覧

funcgql.cli.autodetect_transport(url:URL) -> str
Detects which transport should be used depending on url.
funcgql.cli.get_introspection_args(args:Namespace) -> Dict
Get the introspection args depending on the schema_download argument
funcgql.cli.get_parser(with_examples:bool=False) -> ArgumentParser
Provides an ArgumentParser for the gql-cli script.
funcgql.cli.positive_int_or_none(value_str:str) -> Optional[int]
Convert a string argument value into either an int or None.
methodgql.client.AsyncClientSession.fetch_schema() -> None
Fetch the GraphQL schema explicitly using introspection.
methodgql.client.Client.validate(request:GraphQLRequest) -> None
:meta private:
classgql.dsl.DSLDirectable
Mixin class for DSL elements that can have directives.
methodgql.dsl.DSLDirectable.directives(*directives:DSLDirective) -> Self
Add directives to this DSL element.
methodgql.dsl.DSLDirectable.directives_ast() -> Tuple[DirectiveNode, ...]
Get AST directive nodes for this element.
methodgql.dsl.DSLDirectable.is_valid_directive(directive:DSLDirective) -> bool
Check if a directive is valid for this DSL element.
classgql.dsl.DSLDirective
The DSLDirective represents a GraphQL directive for the DSL code.
methodgql.dsl.DSLDirective.name() -> str
Get the directive name.
classgql.dsl.DSLField
The DSLField represents a GraphQL field for the DSL code.
methodgql.dsl.DSLField.directives(*directives:DSLDirective) -> Self
Add directives to this field.
methodgql.dsl.DSLField.is_valid_directive(directive:DSLDirective) -> bool
Check if directive is valid for Field locations.
methodgql.dsl.DSLField.name()
:meta private:
classgql.dsl.DSLFragment
DSLFragment represents a named GraphQL fragment for the DSL code.
methodgql.dsl.DSLFragment.is_valid_directive(directive:DSLDirective) -> bool
Check if directive is valid for Fragment Definition locations.
methodgql.dsl.DSLFragment.name() -> str
:meta private:
methodgql.dsl.DSLFragment.on(type_condition:DSLType) -> Self
Provides the GraphQL type of this fragment.
classgql.dsl.DSLFragmentSpread
Represents a fragment spread (usage) with its own directives.
methodgql.dsl.DSLFragmentSpread.directives(*directives:DSLDirective) -> Self
Add directives to this fragment spread.
methodgql.dsl.DSLFragmentSpread.is_valid_directive(directive:DSLDirective) -> bool
Check if directive is valid for Fragment Spread locations.
methodgql.dsl.DSLFragmentSpread.name() -> str
:meta private:
methodgql.dsl.DSLInlineFragment.directives(*directives:DSLDirective) -> Self
Add directives to this inline fragment.
methodgql.dsl.DSLInlineFragment.is_valid_directive(directive:DSLDirective) -> bool
Check if directive is valid for Inline Fragment locations.
methodgql.dsl.DSLInlineFragment.on(type_condition:DSLType) -> Self
Provides the GraphQL type of this inline fragment.
classgql.dsl.DSLMetaField
DSLMetaField represents a GraphQL meta-field for the DSL code.
classgql.dsl.DSLOperation
Interface for GraphQL operations.
classgql.dsl.DSLSchema
The DSLSchema is the root of the DSL code.
classgql.dsl.DSLType
The DSLType represents a GraphQL type for the DSL code.
funcgql.dsl.ast_from_serialized_value_untyped(serialized:Any) -> Optional[ValueNode]
Given a serialized value, try our best to produce an AST.
classgql.graphql_request.GraphQLRequest
GraphQL Request to be executed.
classgql.transport.appsync_auth.AppSyncApiKeyAuthentication
AWS authentication class using an API key
classgql.transport.appsync_auth.AppSyncIAMAuthentication
AWS authentication class using IAM.
classgql.transport.appsync_auth.AppSyncJWTAuthentication
AWS authentication class using a JWT access token.
methodgql.transport.async_transport.AsyncTransport.execute_batch(reqs:List[GraphQLRequest], *args:Any, **kwargs:Any) -> List[ExecutionResult]
Execute multiple GraphQL requests in a batch.
classgql.transport.common.adapters.connection.AdapterConnection
Abstract interface for subscription connections.
methodgql.transport.common.adapters.connection.AdapterConnection.close() -> None
Close the connection.
methodgql.transport.common.adapters.connection.AdapterConnection.connect() -> None
Connect to the server.
methodgql.transport.common.adapters.connection.AdapterConnection.receive() -> str
Receive message from the server.
methodgql.transport.common.adapters.connection.AdapterConnection.send(message:str) -> None
Send message to the server.
classgql.transport.exceptions.TransportAlreadyConnected
Transport is already connected.
classgql.transport.exceptions.TransportClosed
Transport is already closed.
classgql.transport.exceptions.TransportConnectionFailed
Transport connection failed.
classgql.transport.exceptions.TransportError
Base class for all the Transport exceptions
classgql.transport.exceptions.TransportProtocolError
Transport protocol error.
classgql.transport.exceptions.TransportQueryError
The server returned an error for a specific query.
classgql.transport.exceptions.TransportServerError
The server returned a global error.
methodgql.transport.transport.Transport.execute(request:GraphQLRequest, *args:Any, **kwargs:Any) -> ExecutionResult
Execute GraphQL query.
methodgql.transport.transport.Transport.execute_batch(reqs:List[GraphQLRequest], *args:Any, **kwargs:Any) -> List[ExecutionResult]
Execute multiple GraphQL requests in a batch.

この情報について

掲載しているシグネチャは graphql-python/gql の公開ソースコードを Python の ast モジュールで静的解析し、引数名・デフォルト値・ 型注釈・戻り値型をそのまま抽出したものです。実装コードは保存していません。 詳しくは仕組みの解説をご覧ください。

収録ライブラリ一覧（全 805 件）へ戻る