Skip to content

Commit 79aba45

Browse files
committed
[FIX] freeze graphql_server
1 parent 38c54c1 commit 79aba45

4 files changed

Lines changed: 24 additions & 24 deletions

File tree

graphql_base/README.rst

Lines changed: 14 additions & 14 deletions
Original file line numberDiff line numberDiff line change
@@ -44,9 +44,9 @@ Usage
4444

4545
To use this module, you need to
4646

47-
- create your graphene schema
48-
- create your controller to expose your GraphQL endpoint, and
49-
optionally a GraphiQL IDE.
47+
- create your graphene schema
48+
- create your controller to expose your GraphQL endpoint, and optionally
49+
a GraphiQL IDE.
5050

5151
This module does not attempt to expose the whole Odoo object model. This
5252
could be the purpose of another module based on this one. We believe
@@ -56,12 +56,12 @@ exposed and needs to be tested when upgrading Odoo.
5656

5757
To start working with this module, we recommend the following approach:
5858

59-
- Learn `GraphQL basics <https://graphql.org/learn/>`__
60-
- Learn `graphene <https://graphene-python.org/>`__, the python library
61-
used to create GraphQL schemas and resolvers.
62-
- Examine the ``graphql_demo`` module in this repo, copy it, adapt the
63-
controller to suit your needs (routes, authentication methods).
64-
- Start building your own schema and resolver.
59+
- Learn `GraphQL basics <https://graphql.org/learn/>`__
60+
- Learn `graphene <https://graphene-python.org/>`__, the python library
61+
used to create GraphQL schemas and resolvers.
62+
- Examine the ``graphql_demo`` module in this repo, copy it, adapt the
63+
controller to suit your needs (routes, authentication methods).
64+
- Start building your own schema and resolver.
6565

6666
Building your schema
6767
--------------------
@@ -71,11 +71,11 @@ The schema can be built using native graphene types. An
7171
convenience. It is a graphene ``ObjectType`` with a default attribute
7272
resolver which:
7373

74-
- converts False to None (except for Boolean types), to avoid Odoo's
75-
weird ``False`` strings being rendered as json ``"false"``;
76-
- adds the user timezone to Datetime fields;
77-
- raises an error if an attribute is absent to avoid field name typing
78-
errors.
74+
- converts False to None (except for Boolean types), to avoid Odoo's
75+
weird ``False`` strings being rendered as json ``"false"``;
76+
- adds the user timezone to Datetime fields;
77+
- raises an error if an attribute is absent to avoid field name typing
78+
errors.
7979

8080
Creating GraphQL controllers
8181
----------------------------

graphql_base/__manifest__.py

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -11,7 +11,7 @@
1111
"website": "https://github.com/OCA/rest-framework",
1212
"depends": ["base"],
1313
"data": ["views/graphiql.xml"],
14-
"external_dependencies": {"python": ["graphene", "graphql_server"]},
14+
"external_dependencies": {"python": ["graphene", "graphql_server==3.0.0b7"]},
1515
"development_status": "Production/Stable",
1616
"maintainers": ["sbidoul"],
1717
"installable": True,

graphql_base/static/description/index.html

Lines changed: 8 additions & 8 deletions
Original file line numberDiff line numberDiff line change
@@ -396,8 +396,8 @@ <h1><a class="toc-backref" href="#toc-entry-1">Usage</a></h1>
396396
<p>To use this module, you need to</p>
397397
<ul class="simple">
398398
<li>create your graphene schema</li>
399-
<li>create your controller to expose your GraphQL endpoint, and
400-
optionally a GraphiQL IDE.</li>
399+
<li>create your controller to expose your GraphQL endpoint, and optionally
400+
a GraphiQL IDE.</li>
401401
</ul>
402402
<p>This module does not attempt to expose the whole Odoo object model. This
403403
could be the purpose of another module based on this one. We believe
@@ -433,24 +433,24 @@ <h2><a class="toc-backref" href="#toc-entry-3">Creating GraphQL controllers</a><
433433
<tt class="docutils literal">odoo.addons.graphql_base.GraphQLControllerMixin</tt> class to help you
434434
build GraphQL controllers providing GraphiQL and/or GraphQL endpoints.</p>
435435
<pre class="code python literal-block">
436-
<span class="kn">from</span> <span class="nn">odoo</span> <span class="kn">import</span> <span class="n">http</span><span class="w">
437-
</span><span class="kn">from</span> <span class="nn">odoo.addons.graphql_base</span> <span class="kn">import</span> <span class="n">GraphQLControllerMixin</span><span class="w">
436+
<span class="kn">from</span><span class="w"> </span><span class="nn">odoo</span><span class="w"> </span><span class="kn">import</span> <span class="n">http</span><span class="w">
437+
</span><span class="kn">from</span><span class="w"> </span><span class="nn">odoo.addons.graphql_base</span><span class="w"> </span><span class="kn">import</span> <span class="n">GraphQLControllerMixin</span><span class="w">
438438

439-
</span><span class="kn">from</span> <span class="nn">..schema</span> <span class="kn">import</span> <span class="n">schema</span><span class="w">
439+
</span><span class="kn">from</span><span class="w"> </span><span class="nn">..schema</span><span class="w"> </span><span class="kn">import</span> <span class="n">schema</span><span class="w">
440440

441441

442-
</span><span class="k">class</span> <span class="nc">GraphQLController</span><span class="p">(</span><span class="n">http</span><span class="o">.</span><span class="n">Controller</span><span class="p">,</span> <span class="n">GraphQLControllerMixin</span><span class="p">):</span><span class="w">
442+
</span><span class="k">class</span><span class="w"> </span><span class="nc">GraphQLController</span><span class="p">(</span><span class="n">http</span><span class="o">.</span><span class="n">Controller</span><span class="p">,</span> <span class="n">GraphQLControllerMixin</span><span class="p">):</span><span class="w">
443443

444444
</span> <span class="c1"># The GraphiQL route, providing an IDE for developers</span><span class="w">
445445
</span> <span class="nd">&#64;http</span><span class="o">.</span><span class="n">route</span><span class="p">(</span><span class="s2">&quot;/graphiql/demo&quot;</span><span class="p">,</span> <span class="n">auth</span><span class="o">=</span><span class="s2">&quot;user&quot;</span><span class="p">)</span><span class="w">
446-
</span> <span class="k">def</span> <span class="nf">graphiql</span><span class="p">(</span><span class="bp">self</span><span class="p">,</span> <span class="o">**</span><span class="n">kwargs</span><span class="p">):</span><span class="w">
446+
</span> <span class="k">def</span><span class="w"> </span><span class="nf">graphiql</span><span class="p">(</span><span class="bp">self</span><span class="p">,</span> <span class="o">**</span><span class="n">kwargs</span><span class="p">):</span><span class="w">
447447
</span> <span class="k">return</span> <span class="bp">self</span><span class="o">.</span><span class="n">_handle_graphiql_request</span><span class="p">(</span><span class="n">schema</span><span class="p">)</span><span class="w">
448448

449449
</span> <span class="c1"># The graphql route, for applications.</span><span class="w">
450450
</span> <span class="c1"># Note csrf=False: you may want to apply extra security</span><span class="w">
451451
</span> <span class="c1"># (such as origin restrictions) to this route.</span><span class="w">
452452
</span> <span class="nd">&#64;http</span><span class="o">.</span><span class="n">route</span><span class="p">(</span><span class="s2">&quot;/graphql/demo&quot;</span><span class="p">,</span> <span class="n">auth</span><span class="o">=</span><span class="s2">&quot;user&quot;</span><span class="p">,</span> <span class="n">csrf</span><span class="o">=</span><span class="kc">False</span><span class="p">)</span><span class="w">
453-
</span> <span class="k">def</span> <span class="nf">graphql</span><span class="p">(</span><span class="bp">self</span><span class="p">,</span> <span class="o">**</span><span class="n">kwargs</span><span class="p">):</span><span class="w">
453+
</span> <span class="k">def</span><span class="w"> </span><span class="nf">graphql</span><span class="p">(</span><span class="bp">self</span><span class="p">,</span> <span class="o">**</span><span class="n">kwargs</span><span class="p">):</span><span class="w">
454454
</span> <span class="k">return</span> <span class="bp">self</span><span class="o">.</span><span class="n">_handle_graphql_request</span><span class="p">(</span><span class="n">schema</span><span class="p">)</span>
455455
</pre>
456456
</div>

requirements.txt

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -3,7 +3,7 @@ a2wsgi>=1.10.6
33
contextvars
44
fastapi>=0.110.0
55
graphene
6-
graphql_server
6+
graphql_server==3.0.0b7
77
parse-accept-language
88
pydantic>=2.0
99
python-multipart

0 commit comments

Comments
 (0)