Add naiad library
This commit is contained in:
Cédric Krier
@@ -373,6 +373,19 @@ test-proteus:
|
|||||||
PACKAGE: proteus
|
PACKAGE: proteus
|
||||||
TAG_PATTERN: '/^proteus-.*/'
|
TAG_PATTERN: '/^proteus-.*/'
|
||||||
|
|
||||||
|
check-doc-naiad:
|
||||||
|
extends: .check-doc
|
||||||
|
variables:
|
||||||
|
PACKAGE: naiad
|
||||||
|
|
||||||
|
test-naiad:
|
||||||
|
extends: .test-tox
|
||||||
|
after_script:
|
||||||
|
- .gitlab-scripts/rewrite-coverage-paths.py "" "${PACKAGE}/" ${PACKAGE}/junit.xml ${PACKAGE}/coverage.xml
|
||||||
|
variables:
|
||||||
|
PACKAGE: naiad
|
||||||
|
TAG_PATTERN: '/^naiad-.*/'
|
||||||
|
|
||||||
check-doc-tryton:
|
check-doc-tryton:
|
||||||
extends: .check-doc
|
extends: .check-doc
|
||||||
variables:
|
variables:
|
||||||
|
|||||||
@@ -22,6 +22,8 @@ pip install -r "${requirements}"
|
|||||||
package="client-desktop"
|
package="client-desktop"
|
||||||
elif [ "${package}" = "proteus" ]; then
|
elif [ "${package}" = "proteus" ]; then
|
||||||
package="client-library"
|
package="client-library"
|
||||||
|
elif [ "${package}" = "naiad" ]; then
|
||||||
|
package="client-rest"
|
||||||
elif [ "${package}" = "trytond-gis" ]; then
|
elif [ "${package}" = "trytond-gis" ]; then
|
||||||
package="backend-gis"
|
package="backend-gis"
|
||||||
elif [ "${package}" = "." ]; then
|
elif [ "${package}" = "." ]; then
|
||||||
|
|||||||
+4
-1
@@ -9,6 +9,7 @@ if base_url:
|
|||||||
trytond_gis_url = base_url + '/backend-gis/'
|
trytond_gis_url = base_url + '/backend-gis/'
|
||||||
tryton_url = base_url + '/client-desktop/'
|
tryton_url = base_url + '/client-desktop/'
|
||||||
proteus_url = base_url + '/client-library/'
|
proteus_url = base_url + '/client-library/'
|
||||||
|
naiad_url = base_url + '/client-rest/'
|
||||||
else:
|
else:
|
||||||
modules_url = (
|
modules_url = (
|
||||||
'https://docs.tryton.org/${series}/modules-{module}/')
|
'https://docs.tryton.org/${series}/modules-{module}/')
|
||||||
@@ -16,6 +17,7 @@ else:
|
|||||||
trytond_gis_url = 'https://docs.tryton.org/${series}/backend-gis/'
|
trytond_gis_url = 'https://docs.tryton.org/${series}/backend-gis/'
|
||||||
tryton_url = 'https://docs.tryton.org/${series}/client-desktop/'
|
tryton_url = 'https://docs.tryton.org/${series}/client-desktop/'
|
||||||
proteus_url = 'https://docs.tryton.org/${series}/client-library/'
|
proteus_url = 'https://docs.tryton.org/${series}/client-library/'
|
||||||
|
naiad_url = 'https://docs.tryton.org/${series}/client-rest/'
|
||||||
|
|
||||||
|
|
||||||
def get_info():
|
def get_info():
|
||||||
@@ -84,6 +86,7 @@ intersphinx_mapping = {
|
|||||||
'trytond_gis': (trytond_gis_url.format(series=version), None),
|
'trytond_gis': (trytond_gis_url.format(series=version), None),
|
||||||
'tryton': (tryton_url.format(series=version), None),
|
'tryton': (tryton_url.format(series=version), None),
|
||||||
'proteus': (proteus_url.format(series=version), None),
|
'proteus': (proteus_url.format(series=version), None),
|
||||||
|
'naiad': (naiad_url.format(series=version), None),
|
||||||
}
|
}
|
||||||
intersphinx_mapping.update({
|
intersphinx_mapping.update({
|
||||||
m: (modules_url.format(
|
m: (modules_url.format(
|
||||||
@@ -93,4 +96,4 @@ intersphinx_mapping.update({
|
|||||||
linkcheck_ignore = [r'/.*', r'https://demo.tryton.org/*']
|
linkcheck_ignore = [r'/.*', r'https://demo.tryton.org/*']
|
||||||
del (
|
del (
|
||||||
get_info, info, base_url, modules_url, trytond_url, trytond_gis_url,
|
get_info, info, base_url, modules_url, trytond_url, trytond_gis_url,
|
||||||
tryton_url, proteus_url)
|
tryton_url, proteus_url, naiad_url)
|
||||||
|
|||||||
@@ -17,6 +17,9 @@ Main
|
|||||||
:doc:`Scripting Client <proteus:index>`
|
:doc:`Scripting Client <proteus:index>`
|
||||||
The library to access models, wizards and reports like a client.
|
The library to access models, wizards and reports like a client.
|
||||||
|
|
||||||
|
:doc:`REST Client <naiad:index>`
|
||||||
|
The library to access REST API.
|
||||||
|
|
||||||
Backend
|
Backend
|
||||||
-------
|
-------
|
||||||
|
|
||||||
|
|||||||
@@ -0,0 +1 @@
|
|||||||
|
* Initial release
|
||||||
@@ -0,0 +1,15 @@
|
|||||||
|
Copyright (C) 2024 Cédric Krier <cedric.krier@b2ck.com>
|
||||||
|
Copyright (C) 2024 B2CK SRL
|
||||||
|
|
||||||
|
This program is free software: you can redistribute it and/or modify
|
||||||
|
it under the terms of the GNU Lesser General Public License as published by
|
||||||
|
the Free Software Foundation, either version 3 of the License, or
|
||||||
|
(at your option) any later version.
|
||||||
|
|
||||||
|
This program is distributed in the hope that it will be useful,
|
||||||
|
but WITHOUT ANY WARRANTY; without even the implied warranty of
|
||||||
|
MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
|
||||||
|
GNU General Public License for more details.
|
||||||
|
|
||||||
|
You should have received a copy of the GNU General Public License
|
||||||
|
along with this program. If not, see <http://www.gnu.org/licenses/>.
|
||||||
+841
@@ -0,0 +1,841 @@
|
|||||||
|
GNU LESSER GENERAL PUBLIC LICENSE
|
||||||
|
Version 3, 29 June 2007
|
||||||
|
|
||||||
|
Copyright (C) 2007 Free Software Foundation, Inc. <http://fsf.org/>
|
||||||
|
Everyone is permitted to copy and distribute verbatim copies
|
||||||
|
of this license document, but changing it is not allowed.
|
||||||
|
|
||||||
|
|
||||||
|
This version of the GNU Lesser General Public License incorporates
|
||||||
|
the terms and conditions of version 3 of the GNU General Public
|
||||||
|
License, supplemented by the additional permissions listed below.
|
||||||
|
|
||||||
|
0. Additional Definitions.
|
||||||
|
|
||||||
|
As used herein, "this License" refers to version 3 of the GNU Lesser
|
||||||
|
General Public License, and the "GNU GPL" refers to version 3 of the GNU
|
||||||
|
General Public License.
|
||||||
|
|
||||||
|
"The Library" refers to a covered work governed by this License,
|
||||||
|
other than an Application or a Combined Work as defined below.
|
||||||
|
|
||||||
|
An "Application" is any work that makes use of an interface provided
|
||||||
|
by the Library, but which is not otherwise based on the Library.
|
||||||
|
Defining a subclass of a class defined by the Library is deemed a mode
|
||||||
|
of using an interface provided by the Library.
|
||||||
|
|
||||||
|
A "Combined Work" is a work produced by combining or linking an
|
||||||
|
Application with the Library. The particular version of the Library
|
||||||
|
with which the Combined Work was made is also called the "Linked
|
||||||
|
Version".
|
||||||
|
|
||||||
|
The "Minimal Corresponding Source" for a Combined Work means the
|
||||||
|
Corresponding Source for the Combined Work, excluding any source code
|
||||||
|
for portions of the Combined Work that, considered in isolation, are
|
||||||
|
based on the Application, and not on the Linked Version.
|
||||||
|
|
||||||
|
The "Corresponding Application Code" for a Combined Work means the
|
||||||
|
object code and/or source code for the Application, including any data
|
||||||
|
and utility programs needed for reproducing the Combined Work from the
|
||||||
|
Application, but excluding the System Libraries of the Combined Work.
|
||||||
|
|
||||||
|
1. Exception to Section 3 of the GNU GPL.
|
||||||
|
|
||||||
|
You may convey a covered work under sections 3 and 4 of this License
|
||||||
|
without being bound by section 3 of the GNU GPL.
|
||||||
|
|
||||||
|
2. Conveying Modified Versions.
|
||||||
|
|
||||||
|
If you modify a copy of the Library, and, in your modifications, a
|
||||||
|
facility refers to a function or data to be supplied by an Application
|
||||||
|
that uses the facility (other than as an argument passed when the
|
||||||
|
facility is invoked), then you may convey a copy of the modified
|
||||||
|
version:
|
||||||
|
|
||||||
|
a) under this License, provided that you make a good faith effort to
|
||||||
|
ensure that, in the event an Application does not supply the
|
||||||
|
function or data, the facility still operates, and performs
|
||||||
|
whatever part of its purpose remains meaningful, or
|
||||||
|
|
||||||
|
b) under the GNU GPL, with none of the additional permissions of
|
||||||
|
this License applicable to that copy.
|
||||||
|
|
||||||
|
3. Object Code Incorporating Material from Library Header Files.
|
||||||
|
|
||||||
|
The object code form of an Application may incorporate material from
|
||||||
|
a header file that is part of the Library. You may convey such object
|
||||||
|
code under terms of your choice, provided that, if the incorporated
|
||||||
|
material is not limited to numerical parameters, data structure
|
||||||
|
layouts and accessors, or small macros, inline functions and templates
|
||||||
|
(ten or fewer lines in length), you do both of the following:
|
||||||
|
|
||||||
|
a) Give prominent notice with each copy of the object code that the
|
||||||
|
Library is used in it and that the Library and its use are
|
||||||
|
covered by this License.
|
||||||
|
|
||||||
|
b) Accompany the object code with a copy of the GNU GPL and this license
|
||||||
|
document.
|
||||||
|
|
||||||
|
4. Combined Works.
|
||||||
|
|
||||||
|
You may convey a Combined Work under terms of your choice that,
|
||||||
|
taken together, effectively do not restrict modification of the
|
||||||
|
portions of the Library contained in the Combined Work and reverse
|
||||||
|
engineering for debugging such modifications, if you also do each of
|
||||||
|
the following:
|
||||||
|
|
||||||
|
a) Give prominent notice with each copy of the Combined Work that
|
||||||
|
the Library is used in it and that the Library and its use are
|
||||||
|
covered by this License.
|
||||||
|
|
||||||
|
b) Accompany the Combined Work with a copy of the GNU GPL and this license
|
||||||
|
document.
|
||||||
|
|
||||||
|
c) For a Combined Work that displays copyright notices during
|
||||||
|
execution, include the copyright notice for the Library among
|
||||||
|
these notices, as well as a reference directing the user to the
|
||||||
|
copies of the GNU GPL and this license document.
|
||||||
|
|
||||||
|
d) Do one of the following:
|
||||||
|
|
||||||
|
0) Convey the Minimal Corresponding Source under the terms of this
|
||||||
|
License, and the Corresponding Application Code in a form
|
||||||
|
suitable for, and under terms that permit, the user to
|
||||||
|
recombine or relink the Application with a modified version of
|
||||||
|
the Linked Version to produce a modified Combined Work, in the
|
||||||
|
manner specified by section 6 of the GNU GPL for conveying
|
||||||
|
Corresponding Source.
|
||||||
|
|
||||||
|
1) Use a suitable shared library mechanism for linking with the
|
||||||
|
Library. A suitable mechanism is one that (a) uses at run time
|
||||||
|
a copy of the Library already present on the user's computer
|
||||||
|
system, and (b) will operate properly with a modified version
|
||||||
|
of the Library that is interface-compatible with the Linked
|
||||||
|
Version.
|
||||||
|
|
||||||
|
e) Provide Installation Information, but only if you would otherwise
|
||||||
|
be required to provide such information under section 6 of the
|
||||||
|
GNU GPL, and only to the extent that such information is
|
||||||
|
necessary to install and execute a modified version of the
|
||||||
|
Combined Work produced by recombining or relinking the
|
||||||
|
Application with a modified version of the Linked Version. (If
|
||||||
|
you use option 4d0, the Installation Information must accompany
|
||||||
|
the Minimal Corresponding Source and Corresponding Application
|
||||||
|
Code. If you use option 4d1, you must provide the Installation
|
||||||
|
Information in the manner specified by section 6 of the GNU GPL
|
||||||
|
for conveying Corresponding Source.)
|
||||||
|
|
||||||
|
5. Combined Libraries.
|
||||||
|
|
||||||
|
You may place library facilities that are a work based on the
|
||||||
|
Library side by side in a single library together with other library
|
||||||
|
facilities that are not Applications and are not covered by this
|
||||||
|
License, and convey such a combined library under terms of your
|
||||||
|
choice, if you do both of the following:
|
||||||
|
|
||||||
|
a) Accompany the combined library with a copy of the same work based
|
||||||
|
on the Library, uncombined with any other library facilities,
|
||||||
|
conveyed under the terms of this License.
|
||||||
|
|
||||||
|
b) Give prominent notice with the combined library that part of it
|
||||||
|
is a work based on the Library, and explaining where to find the
|
||||||
|
accompanying uncombined form of the same work.
|
||||||
|
|
||||||
|
6. Revised Versions of the GNU Lesser General Public License.
|
||||||
|
|
||||||
|
The Free Software Foundation may publish revised and/or new versions
|
||||||
|
of the GNU Lesser General Public License from time to time. Such new
|
||||||
|
versions will be similar in spirit to the present version, but may
|
||||||
|
differ in detail to address new problems or concerns.
|
||||||
|
|
||||||
|
Each version is given a distinguishing version number. If the
|
||||||
|
Library as you received it specifies that a certain numbered version
|
||||||
|
of the GNU Lesser General Public License "or any later version"
|
||||||
|
applies to it, you have the option of following the terms and
|
||||||
|
conditions either of that published version or of any later version
|
||||||
|
published by the Free Software Foundation. If the Library as you
|
||||||
|
received it does not specify a version number of the GNU Lesser
|
||||||
|
General Public License, you may choose any version of the GNU Lesser
|
||||||
|
General Public License ever published by the Free Software Foundation.
|
||||||
|
|
||||||
|
If the Library as you received it specifies that a proxy can decide
|
||||||
|
whether future versions of the GNU Lesser General Public License shall
|
||||||
|
apply, that proxy's public statement of acceptance of any version is
|
||||||
|
permanent authorization for you to choose that version for the
|
||||||
|
Library.
|
||||||
|
|
||||||
|
|
||||||
|
GNU GENERAL PUBLIC LICENSE
|
||||||
|
Version 3, 29 June 2007
|
||||||
|
|
||||||
|
Copyright (C) 2007 Free Software Foundation, Inc. <http://fsf.org/>
|
||||||
|
Everyone is permitted to copy and distribute verbatim copies
|
||||||
|
of this license document, but changing it is not allowed.
|
||||||
|
|
||||||
|
Preamble
|
||||||
|
|
||||||
|
The GNU General Public License is a free, copyleft license for
|
||||||
|
software and other kinds of works.
|
||||||
|
|
||||||
|
The licenses for most software and other practical works are designed
|
||||||
|
to take away your freedom to share and change the works. By contrast,
|
||||||
|
the GNU General Public License is intended to guarantee your freedom to
|
||||||
|
share and change all versions of a program--to make sure it remains free
|
||||||
|
software for all its users. We, the Free Software Foundation, use the
|
||||||
|
GNU General Public License for most of our software; it applies also to
|
||||||
|
any other work released this way by its authors. You can apply it to
|
||||||
|
your programs, too.
|
||||||
|
|
||||||
|
When we speak of free software, we are referring to freedom, not
|
||||||
|
price. Our General Public Licenses are designed to make sure that you
|
||||||
|
have the freedom to distribute copies of free software (and charge for
|
||||||
|
them if you wish), that you receive source code or can get it if you
|
||||||
|
want it, that you can change the software or use pieces of it in new
|
||||||
|
free programs, and that you know you can do these things.
|
||||||
|
|
||||||
|
To protect your rights, we need to prevent others from denying you
|
||||||
|
these rights or asking you to surrender the rights. Therefore, you have
|
||||||
|
certain responsibilities if you distribute copies of the software, or if
|
||||||
|
you modify it: responsibilities to respect the freedom of others.
|
||||||
|
|
||||||
|
For example, if you distribute copies of such a program, whether
|
||||||
|
gratis or for a fee, you must pass on to the recipients the same
|
||||||
|
freedoms that you received. You must make sure that they, too, receive
|
||||||
|
or can get the source code. And you must show them these terms so they
|
||||||
|
know their rights.
|
||||||
|
|
||||||
|
Developers that use the GNU GPL protect your rights with two steps:
|
||||||
|
(1) assert copyright on the software, and (2) offer you this License
|
||||||
|
giving you legal permission to copy, distribute and/or modify it.
|
||||||
|
|
||||||
|
For the developers' and authors' protection, the GPL clearly explains
|
||||||
|
that there is no warranty for this free software. For both users' and
|
||||||
|
authors' sake, the GPL requires that modified versions be marked as
|
||||||
|
changed, so that their problems will not be attributed erroneously to
|
||||||
|
authors of previous versions.
|
||||||
|
|
||||||
|
Some devices are designed to deny users access to install or run
|
||||||
|
modified versions of the software inside them, although the manufacturer
|
||||||
|
can do so. This is fundamentally incompatible with the aim of
|
||||||
|
protecting users' freedom to change the software. The systematic
|
||||||
|
pattern of such abuse occurs in the area of products for individuals to
|
||||||
|
use, which is precisely where it is most unacceptable. Therefore, we
|
||||||
|
have designed this version of the GPL to prohibit the practice for those
|
||||||
|
products. If such problems arise substantially in other domains, we
|
||||||
|
stand ready to extend this provision to those domains in future versions
|
||||||
|
of the GPL, as needed to protect the freedom of users.
|
||||||
|
|
||||||
|
Finally, every program is threatened constantly by software patents.
|
||||||
|
States should not allow patents to restrict development and use of
|
||||||
|
software on general-purpose computers, but in those that do, we wish to
|
||||||
|
avoid the special danger that patents applied to a free program could
|
||||||
|
make it effectively proprietary. To prevent this, the GPL assures that
|
||||||
|
patents cannot be used to render the program non-free.
|
||||||
|
|
||||||
|
The precise terms and conditions for copying, distribution and
|
||||||
|
modification follow.
|
||||||
|
|
||||||
|
TERMS AND CONDITIONS
|
||||||
|
|
||||||
|
0. Definitions.
|
||||||
|
|
||||||
|
"This License" refers to version 3 of the GNU General Public License.
|
||||||
|
|
||||||
|
"Copyright" also means copyright-like laws that apply to other kinds of
|
||||||
|
works, such as semiconductor masks.
|
||||||
|
|
||||||
|
"The Program" refers to any copyrightable work licensed under this
|
||||||
|
License. Each licensee is addressed as "you". "Licensees" and
|
||||||
|
"recipients" may be individuals or organizations.
|
||||||
|
|
||||||
|
To "modify" a work means to copy from or adapt all or part of the work
|
||||||
|
in a fashion requiring copyright permission, other than the making of an
|
||||||
|
exact copy. The resulting work is called a "modified version" of the
|
||||||
|
earlier work or a work "based on" the earlier work.
|
||||||
|
|
||||||
|
A "covered work" means either the unmodified Program or a work based
|
||||||
|
on the Program.
|
||||||
|
|
||||||
|
To "propagate" a work means to do anything with it that, without
|
||||||
|
permission, would make you directly or secondarily liable for
|
||||||
|
infringement under applicable copyright law, except executing it on a
|
||||||
|
computer or modifying a private copy. Propagation includes copying,
|
||||||
|
distribution (with or without modification), making available to the
|
||||||
|
public, and in some countries other activities as well.
|
||||||
|
|
||||||
|
To "convey" a work means any kind of propagation that enables other
|
||||||
|
parties to make or receive copies. Mere interaction with a user through
|
||||||
|
a computer network, with no transfer of a copy, is not conveying.
|
||||||
|
|
||||||
|
An interactive user interface displays "Appropriate Legal Notices"
|
||||||
|
to the extent that it includes a convenient and prominently visible
|
||||||
|
feature that (1) displays an appropriate copyright notice, and (2)
|
||||||
|
tells the user that there is no warranty for the work (except to the
|
||||||
|
extent that warranties are provided), that licensees may convey the
|
||||||
|
work under this License, and how to view a copy of this License. If
|
||||||
|
the interface presents a list of user commands or options, such as a
|
||||||
|
menu, a prominent item in the list meets this criterion.
|
||||||
|
|
||||||
|
1. Source Code.
|
||||||
|
|
||||||
|
The "source code" for a work means the preferred form of the work
|
||||||
|
for making modifications to it. "Object code" means any non-source
|
||||||
|
form of a work.
|
||||||
|
|
||||||
|
A "Standard Interface" means an interface that either is an official
|
||||||
|
standard defined by a recognized standards body, or, in the case of
|
||||||
|
interfaces specified for a particular programming language, one that
|
||||||
|
is widely used among developers working in that language.
|
||||||
|
|
||||||
|
The "System Libraries" of an executable work include anything, other
|
||||||
|
than the work as a whole, that (a) is included in the normal form of
|
||||||
|
packaging a Major Component, but which is not part of that Major
|
||||||
|
Component, and (b) serves only to enable use of the work with that
|
||||||
|
Major Component, or to implement a Standard Interface for which an
|
||||||
|
implementation is available to the public in source code form. A
|
||||||
|
"Major Component", in this context, means a major essential component
|
||||||
|
(kernel, window system, and so on) of the specific operating system
|
||||||
|
(if any) on which the executable work runs, or a compiler used to
|
||||||
|
produce the work, or an object code interpreter used to run it.
|
||||||
|
|
||||||
|
The "Corresponding Source" for a work in object code form means all
|
||||||
|
the source code needed to generate, install, and (for an executable
|
||||||
|
work) run the object code and to modify the work, including scripts to
|
||||||
|
control those activities. However, it does not include the work's
|
||||||
|
System Libraries, or general-purpose tools or generally available free
|
||||||
|
programs which are used unmodified in performing those activities but
|
||||||
|
which are not part of the work. For example, Corresponding Source
|
||||||
|
includes interface definition files associated with source files for
|
||||||
|
the work, and the source code for shared libraries and dynamically
|
||||||
|
linked subprograms that the work is specifically designed to require,
|
||||||
|
such as by intimate data communication or control flow between those
|
||||||
|
subprograms and other parts of the work.
|
||||||
|
|
||||||
|
The Corresponding Source need not include anything that users
|
||||||
|
can regenerate automatically from other parts of the Corresponding
|
||||||
|
Source.
|
||||||
|
|
||||||
|
The Corresponding Source for a work in source code form is that
|
||||||
|
same work.
|
||||||
|
|
||||||
|
2. Basic Permissions.
|
||||||
|
|
||||||
|
All rights granted under this License are granted for the term of
|
||||||
|
copyright on the Program, and are irrevocable provided the stated
|
||||||
|
conditions are met. This License explicitly affirms your unlimited
|
||||||
|
permission to run the unmodified Program. The output from running a
|
||||||
|
covered work is covered by this License only if the output, given its
|
||||||
|
content, constitutes a covered work. This License acknowledges your
|
||||||
|
rights of fair use or other equivalent, as provided by copyright law.
|
||||||
|
|
||||||
|
You may make, run and propagate covered works that you do not
|
||||||
|
convey, without conditions so long as your license otherwise remains
|
||||||
|
in force. You may convey covered works to others for the sole purpose
|
||||||
|
of having them make modifications exclusively for you, or provide you
|
||||||
|
with facilities for running those works, provided that you comply with
|
||||||
|
the terms of this License in conveying all material for which you do
|
||||||
|
not control copyright. Those thus making or running the covered works
|
||||||
|
for you must do so exclusively on your behalf, under your direction
|
||||||
|
and control, on terms that prohibit them from making any copies of
|
||||||
|
your copyrighted material outside their relationship with you.
|
||||||
|
|
||||||
|
Conveying under any other circumstances is permitted solely under
|
||||||
|
the conditions stated below. Sublicensing is not allowed; section 10
|
||||||
|
makes it unnecessary.
|
||||||
|
|
||||||
|
3. Protecting Users' Legal Rights From Anti-Circumvention Law.
|
||||||
|
|
||||||
|
No covered work shall be deemed part of an effective technological
|
||||||
|
measure under any applicable law fulfilling obligations under article
|
||||||
|
11 of the WIPO copyright treaty adopted on 20 December 1996, or
|
||||||
|
similar laws prohibiting or restricting circumvention of such
|
||||||
|
measures.
|
||||||
|
|
||||||
|
When you convey a covered work, you waive any legal power to forbid
|
||||||
|
circumvention of technological measures to the extent such circumvention
|
||||||
|
is effected by exercising rights under this License with respect to
|
||||||
|
the covered work, and you disclaim any intention to limit operation or
|
||||||
|
modification of the work as a means of enforcing, against the work's
|
||||||
|
users, your or third parties' legal rights to forbid circumvention of
|
||||||
|
technological measures.
|
||||||
|
|
||||||
|
4. Conveying Verbatim Copies.
|
||||||
|
|
||||||
|
You may convey verbatim copies of the Program's source code as you
|
||||||
|
receive it, in any medium, provided that you conspicuously and
|
||||||
|
appropriately publish on each copy an appropriate copyright notice;
|
||||||
|
keep intact all notices stating that this License and any
|
||||||
|
non-permissive terms added in accord with section 7 apply to the code;
|
||||||
|
keep intact all notices of the absence of any warranty; and give all
|
||||||
|
recipients a copy of this License along with the Program.
|
||||||
|
|
||||||
|
You may charge any price or no price for each copy that you convey,
|
||||||
|
and you may offer support or warranty protection for a fee.
|
||||||
|
|
||||||
|
5. Conveying Modified Source Versions.
|
||||||
|
|
||||||
|
You may convey a work based on the Program, or the modifications to
|
||||||
|
produce it from the Program, in the form of source code under the
|
||||||
|
terms of section 4, provided that you also meet all of these conditions:
|
||||||
|
|
||||||
|
a) The work must carry prominent notices stating that you modified
|
||||||
|
it, and giving a relevant date.
|
||||||
|
|
||||||
|
b) The work must carry prominent notices stating that it is
|
||||||
|
released under this License and any conditions added under section
|
||||||
|
7. This requirement modifies the requirement in section 4 to
|
||||||
|
"keep intact all notices".
|
||||||
|
|
||||||
|
c) You must license the entire work, as a whole, under this
|
||||||
|
License to anyone who comes into possession of a copy. This
|
||||||
|
License will therefore apply, along with any applicable section 7
|
||||||
|
additional terms, to the whole of the work, and all its parts,
|
||||||
|
regardless of how they are packaged. This License gives no
|
||||||
|
permission to license the work in any other way, but it does not
|
||||||
|
invalidate such permission if you have separately received it.
|
||||||
|
|
||||||
|
d) If the work has interactive user interfaces, each must display
|
||||||
|
Appropriate Legal Notices; however, if the Program has interactive
|
||||||
|
interfaces that do not display Appropriate Legal Notices, your
|
||||||
|
work need not make them do so.
|
||||||
|
|
||||||
|
A compilation of a covered work with other separate and independent
|
||||||
|
works, which are not by their nature extensions of the covered work,
|
||||||
|
and which are not combined with it such as to form a larger program,
|
||||||
|
in or on a volume of a storage or distribution medium, is called an
|
||||||
|
"aggregate" if the compilation and its resulting copyright are not
|
||||||
|
used to limit the access or legal rights of the compilation's users
|
||||||
|
beyond what the individual works permit. Inclusion of a covered work
|
||||||
|
in an aggregate does not cause this License to apply to the other
|
||||||
|
parts of the aggregate.
|
||||||
|
|
||||||
|
6. Conveying Non-Source Forms.
|
||||||
|
|
||||||
|
You may convey a covered work in object code form under the terms
|
||||||
|
of sections 4 and 5, provided that you also convey the
|
||||||
|
machine-readable Corresponding Source under the terms of this License,
|
||||||
|
in one of these ways:
|
||||||
|
|
||||||
|
a) Convey the object code in, or embodied in, a physical product
|
||||||
|
(including a physical distribution medium), accompanied by the
|
||||||
|
Corresponding Source fixed on a durable physical medium
|
||||||
|
customarily used for software interchange.
|
||||||
|
|
||||||
|
b) Convey the object code in, or embodied in, a physical product
|
||||||
|
(including a physical distribution medium), accompanied by a
|
||||||
|
written offer, valid for at least three years and valid for as
|
||||||
|
long as you offer spare parts or customer support for that product
|
||||||
|
model, to give anyone who possesses the object code either (1) a
|
||||||
|
copy of the Corresponding Source for all the software in the
|
||||||
|
product that is covered by this License, on a durable physical
|
||||||
|
medium customarily used for software interchange, for a price no
|
||||||
|
more than your reasonable cost of physically performing this
|
||||||
|
conveying of source, or (2) access to copy the
|
||||||
|
Corresponding Source from a network server at no charge.
|
||||||
|
|
||||||
|
c) Convey individual copies of the object code with a copy of the
|
||||||
|
written offer to provide the Corresponding Source. This
|
||||||
|
alternative is allowed only occasionally and noncommercially, and
|
||||||
|
only if you received the object code with such an offer, in accord
|
||||||
|
with subsection 6b.
|
||||||
|
|
||||||
|
d) Convey the object code by offering access from a designated
|
||||||
|
place (gratis or for a charge), and offer equivalent access to the
|
||||||
|
Corresponding Source in the same way through the same place at no
|
||||||
|
further charge. You need not require recipients to copy the
|
||||||
|
Corresponding Source along with the object code. If the place to
|
||||||
|
copy the object code is a network server, the Corresponding Source
|
||||||
|
may be on a different server (operated by you or a third party)
|
||||||
|
that supports equivalent copying facilities, provided you maintain
|
||||||
|
clear directions next to the object code saying where to find the
|
||||||
|
Corresponding Source. Regardless of what server hosts the
|
||||||
|
Corresponding Source, you remain obligated to ensure that it is
|
||||||
|
available for as long as needed to satisfy these requirements.
|
||||||
|
|
||||||
|
e) Convey the object code using peer-to-peer transmission, provided
|
||||||
|
you inform other peers where the object code and Corresponding
|
||||||
|
Source of the work are being offered to the general public at no
|
||||||
|
charge under subsection 6d.
|
||||||
|
|
||||||
|
A separable portion of the object code, whose source code is excluded
|
||||||
|
from the Corresponding Source as a System Library, need not be
|
||||||
|
included in conveying the object code work.
|
||||||
|
|
||||||
|
A "User Product" is either (1) a "consumer product", which means any
|
||||||
|
tangible personal property which is normally used for personal, family,
|
||||||
|
or household purposes, or (2) anything designed or sold for incorporation
|
||||||
|
into a dwelling. In determining whether a product is a consumer product,
|
||||||
|
doubtful cases shall be resolved in favor of coverage. For a particular
|
||||||
|
product received by a particular user, "normally used" refers to a
|
||||||
|
typical or common use of that class of product, regardless of the status
|
||||||
|
of the particular user or of the way in which the particular user
|
||||||
|
actually uses, or expects or is expected to use, the product. A product
|
||||||
|
is a consumer product regardless of whether the product has substantial
|
||||||
|
commercial, industrial or non-consumer uses, unless such uses represent
|
||||||
|
the only significant mode of use of the product.
|
||||||
|
|
||||||
|
"Installation Information" for a User Product means any methods,
|
||||||
|
procedures, authorization keys, or other information required to install
|
||||||
|
and execute modified versions of a covered work in that User Product from
|
||||||
|
a modified version of its Corresponding Source. The information must
|
||||||
|
suffice to ensure that the continued functioning of the modified object
|
||||||
|
code is in no case prevented or interfered with solely because
|
||||||
|
modification has been made.
|
||||||
|
|
||||||
|
If you convey an object code work under this section in, or with, or
|
||||||
|
specifically for use in, a User Product, and the conveying occurs as
|
||||||
|
part of a transaction in which the right of possession and use of the
|
||||||
|
User Product is transferred to the recipient in perpetuity or for a
|
||||||
|
fixed term (regardless of how the transaction is characterized), the
|
||||||
|
Corresponding Source conveyed under this section must be accompanied
|
||||||
|
by the Installation Information. But this requirement does not apply
|
||||||
|
if neither you nor any third party retains the ability to install
|
||||||
|
modified object code on the User Product (for example, the work has
|
||||||
|
been installed in ROM).
|
||||||
|
|
||||||
|
The requirement to provide Installation Information does not include a
|
||||||
|
requirement to continue to provide support service, warranty, or updates
|
||||||
|
for a work that has been modified or installed by the recipient, or for
|
||||||
|
the User Product in which it has been modified or installed. Access to a
|
||||||
|
network may be denied when the modification itself materially and
|
||||||
|
adversely affects the operation of the network or violates the rules and
|
||||||
|
protocols for communication across the network.
|
||||||
|
|
||||||
|
Corresponding Source conveyed, and Installation Information provided,
|
||||||
|
in accord with this section must be in a format that is publicly
|
||||||
|
documented (and with an implementation available to the public in
|
||||||
|
source code form), and must require no special password or key for
|
||||||
|
unpacking, reading or copying.
|
||||||
|
|
||||||
|
7. Additional Terms.
|
||||||
|
|
||||||
|
"Additional permissions" are terms that supplement the terms of this
|
||||||
|
License by making exceptions from one or more of its conditions.
|
||||||
|
Additional permissions that are applicable to the entire Program shall
|
||||||
|
be treated as though they were included in this License, to the extent
|
||||||
|
that they are valid under applicable law. If additional permissions
|
||||||
|
apply only to part of the Program, that part may be used separately
|
||||||
|
under those permissions, but the entire Program remains governed by
|
||||||
|
this License without regard to the additional permissions.
|
||||||
|
|
||||||
|
When you convey a copy of a covered work, you may at your option
|
||||||
|
remove any additional permissions from that copy, or from any part of
|
||||||
|
it. (Additional permissions may be written to require their own
|
||||||
|
removal in certain cases when you modify the work.) You may place
|
||||||
|
additional permissions on material, added by you to a covered work,
|
||||||
|
for which you have or can give appropriate copyright permission.
|
||||||
|
|
||||||
|
Notwithstanding any other provision of this License, for material you
|
||||||
|
add to a covered work, you may (if authorized by the copyright holders of
|
||||||
|
that material) supplement the terms of this License with terms:
|
||||||
|
|
||||||
|
a) Disclaiming warranty or limiting liability differently from the
|
||||||
|
terms of sections 15 and 16 of this License; or
|
||||||
|
|
||||||
|
b) Requiring preservation of specified reasonable legal notices or
|
||||||
|
author attributions in that material or in the Appropriate Legal
|
||||||
|
Notices displayed by works containing it; or
|
||||||
|
|
||||||
|
c) Prohibiting misrepresentation of the origin of that material, or
|
||||||
|
requiring that modified versions of such material be marked in
|
||||||
|
reasonable ways as different from the original version; or
|
||||||
|
|
||||||
|
d) Limiting the use for publicity purposes of names of licensors or
|
||||||
|
authors of the material; or
|
||||||
|
|
||||||
|
e) Declining to grant rights under trademark law for use of some
|
||||||
|
trade names, trademarks, or service marks; or
|
||||||
|
|
||||||
|
f) Requiring indemnification of licensors and authors of that
|
||||||
|
material by anyone who conveys the material (or modified versions of
|
||||||
|
it) with contractual assumptions of liability to the recipient, for
|
||||||
|
any liability that these contractual assumptions directly impose on
|
||||||
|
those licensors and authors.
|
||||||
|
|
||||||
|
All other non-permissive additional terms are considered "further
|
||||||
|
restrictions" within the meaning of section 10. If the Program as you
|
||||||
|
received it, or any part of it, contains a notice stating that it is
|
||||||
|
governed by this License along with a term that is a further
|
||||||
|
restriction, you may remove that term. If a license document contains
|
||||||
|
a further restriction but permits relicensing or conveying under this
|
||||||
|
License, you may add to a covered work material governed by the terms
|
||||||
|
of that license document, provided that the further restriction does
|
||||||
|
not survive such relicensing or conveying.
|
||||||
|
|
||||||
|
If you add terms to a covered work in accord with this section, you
|
||||||
|
must place, in the relevant source files, a statement of the
|
||||||
|
additional terms that apply to those files, or a notice indicating
|
||||||
|
where to find the applicable terms.
|
||||||
|
|
||||||
|
Additional terms, permissive or non-permissive, may be stated in the
|
||||||
|
form of a separately written license, or stated as exceptions;
|
||||||
|
the above requirements apply either way.
|
||||||
|
|
||||||
|
8. Termination.
|
||||||
|
|
||||||
|
You may not propagate or modify a covered work except as expressly
|
||||||
|
provided under this License. Any attempt otherwise to propagate or
|
||||||
|
modify it is void, and will automatically terminate your rights under
|
||||||
|
this License (including any patent licenses granted under the third
|
||||||
|
paragraph of section 11).
|
||||||
|
|
||||||
|
However, if you cease all violation of this License, then your
|
||||||
|
license from a particular copyright holder is reinstated (a)
|
||||||
|
provisionally, unless and until the copyright holder explicitly and
|
||||||
|
finally terminates your license, and (b) permanently, if the copyright
|
||||||
|
holder fails to notify you of the violation by some reasonable means
|
||||||
|
prior to 60 days after the cessation.
|
||||||
|
|
||||||
|
Moreover, your license from a particular copyright holder is
|
||||||
|
reinstated permanently if the copyright holder notifies you of the
|
||||||
|
violation by some reasonable means, this is the first time you have
|
||||||
|
received notice of violation of this License (for any work) from that
|
||||||
|
copyright holder, and you cure the violation prior to 30 days after
|
||||||
|
your receipt of the notice.
|
||||||
|
|
||||||
|
Termination of your rights under this section does not terminate the
|
||||||
|
licenses of parties who have received copies or rights from you under
|
||||||
|
this License. If your rights have been terminated and not permanently
|
||||||
|
reinstated, you do not qualify to receive new licenses for the same
|
||||||
|
material under section 10.
|
||||||
|
|
||||||
|
9. Acceptance Not Required for Having Copies.
|
||||||
|
|
||||||
|
You are not required to accept this License in order to receive or
|
||||||
|
run a copy of the Program. Ancillary propagation of a covered work
|
||||||
|
occurring solely as a consequence of using peer-to-peer transmission
|
||||||
|
to receive a copy likewise does not require acceptance. However,
|
||||||
|
nothing other than this License grants you permission to propagate or
|
||||||
|
modify any covered work. These actions infringe copyright if you do
|
||||||
|
not accept this License. Therefore, by modifying or propagating a
|
||||||
|
covered work, you indicate your acceptance of this License to do so.
|
||||||
|
|
||||||
|
10. Automatic Licensing of Downstream Recipients.
|
||||||
|
|
||||||
|
Each time you convey a covered work, the recipient automatically
|
||||||
|
receives a license from the original licensors, to run, modify and
|
||||||
|
propagate that work, subject to this License. You are not responsible
|
||||||
|
for enforcing compliance by third parties with this License.
|
||||||
|
|
||||||
|
An "entity transaction" is a transaction transferring control of an
|
||||||
|
organization, or substantially all assets of one, or subdividing an
|
||||||
|
organization, or merging organizations. If propagation of a covered
|
||||||
|
work results from an entity transaction, each party to that
|
||||||
|
transaction who receives a copy of the work also receives whatever
|
||||||
|
licenses to the work the party's predecessor in interest had or could
|
||||||
|
give under the previous paragraph, plus a right to possession of the
|
||||||
|
Corresponding Source of the work from the predecessor in interest, if
|
||||||
|
the predecessor has it or can get it with reasonable efforts.
|
||||||
|
|
||||||
|
You may not impose any further restrictions on the exercise of the
|
||||||
|
rights granted or affirmed under this License. For example, you may
|
||||||
|
not impose a license fee, royalty, or other charge for exercise of
|
||||||
|
rights granted under this License, and you may not initiate litigation
|
||||||
|
(including a cross-claim or counterclaim in a lawsuit) alleging that
|
||||||
|
any patent claim is infringed by making, using, selling, offering for
|
||||||
|
sale, or importing the Program or any portion of it.
|
||||||
|
|
||||||
|
11. Patents.
|
||||||
|
|
||||||
|
A "contributor" is a copyright holder who authorizes use under this
|
||||||
|
License of the Program or a work on which the Program is based. The
|
||||||
|
work thus licensed is called the contributor's "contributor version".
|
||||||
|
|
||||||
|
A contributor's "essential patent claims" are all patent claims
|
||||||
|
owned or controlled by the contributor, whether already acquired or
|
||||||
|
hereafter acquired, that would be infringed by some manner, permitted
|
||||||
|
by this License, of making, using, or selling its contributor version,
|
||||||
|
but do not include claims that would be infringed only as a
|
||||||
|
consequence of further modification of the contributor version. For
|
||||||
|
purposes of this definition, "control" includes the right to grant
|
||||||
|
patent sublicenses in a manner consistent with the requirements of
|
||||||
|
this License.
|
||||||
|
|
||||||
|
Each contributor grants you a non-exclusive, worldwide, royalty-free
|
||||||
|
patent license under the contributor's essential patent claims, to
|
||||||
|
make, use, sell, offer for sale, import and otherwise run, modify and
|
||||||
|
propagate the contents of its contributor version.
|
||||||
|
|
||||||
|
In the following three paragraphs, a "patent license" is any express
|
||||||
|
agreement or commitment, however denominated, not to enforce a patent
|
||||||
|
(such as an express permission to practice a patent or covenant not to
|
||||||
|
sue for patent infringement). To "grant" such a patent license to a
|
||||||
|
party means to make such an agreement or commitment not to enforce a
|
||||||
|
patent against the party.
|
||||||
|
|
||||||
|
If you convey a covered work, knowingly relying on a patent license,
|
||||||
|
and the Corresponding Source of the work is not available for anyone
|
||||||
|
to copy, free of charge and under the terms of this License, through a
|
||||||
|
publicly available network server or other readily accessible means,
|
||||||
|
then you must either (1) cause the Corresponding Source to be so
|
||||||
|
available, or (2) arrange to deprive yourself of the benefit of the
|
||||||
|
patent license for this particular work, or (3) arrange, in a manner
|
||||||
|
consistent with the requirements of this License, to extend the patent
|
||||||
|
license to downstream recipients. "Knowingly relying" means you have
|
||||||
|
actual knowledge that, but for the patent license, your conveying the
|
||||||
|
covered work in a country, or your recipient's use of the covered work
|
||||||
|
in a country, would infringe one or more identifiable patents in that
|
||||||
|
country that you have reason to believe are valid.
|
||||||
|
|
||||||
|
If, pursuant to or in connection with a single transaction or
|
||||||
|
arrangement, you convey, or propagate by procuring conveyance of, a
|
||||||
|
covered work, and grant a patent license to some of the parties
|
||||||
|
receiving the covered work authorizing them to use, propagate, modify
|
||||||
|
or convey a specific copy of the covered work, then the patent license
|
||||||
|
you grant is automatically extended to all recipients of the covered
|
||||||
|
work and works based on it.
|
||||||
|
|
||||||
|
A patent license is "discriminatory" if it does not include within
|
||||||
|
the scope of its coverage, prohibits the exercise of, or is
|
||||||
|
conditioned on the non-exercise of one or more of the rights that are
|
||||||
|
specifically granted under this License. You may not convey a covered
|
||||||
|
work if you are a party to an arrangement with a third party that is
|
||||||
|
in the business of distributing software, under which you make payment
|
||||||
|
to the third party based on the extent of your activity of conveying
|
||||||
|
the work, and under which the third party grants, to any of the
|
||||||
|
parties who would receive the covered work from you, a discriminatory
|
||||||
|
patent license (a) in connection with copies of the covered work
|
||||||
|
conveyed by you (or copies made from those copies), or (b) primarily
|
||||||
|
for and in connection with specific products or compilations that
|
||||||
|
contain the covered work, unless you entered into that arrangement,
|
||||||
|
or that patent license was granted, prior to 28 March 2007.
|
||||||
|
|
||||||
|
Nothing in this License shall be construed as excluding or limiting
|
||||||
|
any implied license or other defenses to infringement that may
|
||||||
|
otherwise be available to you under applicable patent law.
|
||||||
|
|
||||||
|
12. No Surrender of Others' Freedom.
|
||||||
|
|
||||||
|
If conditions are imposed on you (whether by court order, agreement or
|
||||||
|
otherwise) that contradict the conditions of this License, they do not
|
||||||
|
excuse you from the conditions of this License. If you cannot convey a
|
||||||
|
covered work so as to satisfy simultaneously your obligations under this
|
||||||
|
License and any other pertinent obligations, then as a consequence you may
|
||||||
|
not convey it at all. For example, if you agree to terms that obligate you
|
||||||
|
to collect a royalty for further conveying from those to whom you convey
|
||||||
|
the Program, the only way you could satisfy both those terms and this
|
||||||
|
License would be to refrain entirely from conveying the Program.
|
||||||
|
|
||||||
|
13. Use with the GNU Affero General Public License.
|
||||||
|
|
||||||
|
Notwithstanding any other provision of this License, you have
|
||||||
|
permission to link or combine any covered work with a work licensed
|
||||||
|
under version 3 of the GNU Affero General Public License into a single
|
||||||
|
combined work, and to convey the resulting work. The terms of this
|
||||||
|
License will continue to apply to the part which is the covered work,
|
||||||
|
but the special requirements of the GNU Affero General Public License,
|
||||||
|
section 13, concerning interaction through a network will apply to the
|
||||||
|
combination as such.
|
||||||
|
|
||||||
|
14. Revised Versions of this License.
|
||||||
|
|
||||||
|
The Free Software Foundation may publish revised and/or new versions of
|
||||||
|
the GNU General Public License from time to time. Such new versions will
|
||||||
|
be similar in spirit to the present version, but may differ in detail to
|
||||||
|
address new problems or concerns.
|
||||||
|
|
||||||
|
Each version is given a distinguishing version number. If the
|
||||||
|
Program specifies that a certain numbered version of the GNU General
|
||||||
|
Public License "or any later version" applies to it, you have the
|
||||||
|
option of following the terms and conditions either of that numbered
|
||||||
|
version or of any later version published by the Free Software
|
||||||
|
Foundation. If the Program does not specify a version number of the
|
||||||
|
GNU General Public License, you may choose any version ever published
|
||||||
|
by the Free Software Foundation.
|
||||||
|
|
||||||
|
If the Program specifies that a proxy can decide which future
|
||||||
|
versions of the GNU General Public License can be used, that proxy's
|
||||||
|
public statement of acceptance of a version permanently authorizes you
|
||||||
|
to choose that version for the Program.
|
||||||
|
|
||||||
|
Later license versions may give you additional or different
|
||||||
|
permissions. However, no additional obligations are imposed on any
|
||||||
|
author or copyright holder as a result of your choosing to follow a
|
||||||
|
later version.
|
||||||
|
|
||||||
|
15. Disclaimer of Warranty.
|
||||||
|
|
||||||
|
THERE IS NO WARRANTY FOR THE PROGRAM, TO THE EXTENT PERMITTED BY
|
||||||
|
APPLICABLE LAW. EXCEPT WHEN OTHERWISE STATED IN WRITING THE COPYRIGHT
|
||||||
|
HOLDERS AND/OR OTHER PARTIES PROVIDE THE PROGRAM "AS IS" WITHOUT WARRANTY
|
||||||
|
OF ANY KIND, EITHER EXPRESSED OR IMPLIED, INCLUDING, BUT NOT LIMITED TO,
|
||||||
|
THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR
|
||||||
|
PURPOSE. THE ENTIRE RISK AS TO THE QUALITY AND PERFORMANCE OF THE PROGRAM
|
||||||
|
IS WITH YOU. SHOULD THE PROGRAM PROVE DEFECTIVE, YOU ASSUME THE COST OF
|
||||||
|
ALL NECESSARY SERVICING, REPAIR OR CORRECTION.
|
||||||
|
|
||||||
|
16. Limitation of Liability.
|
||||||
|
|
||||||
|
IN NO EVENT UNLESS REQUIRED BY APPLICABLE LAW OR AGREED TO IN WRITING
|
||||||
|
WILL ANY COPYRIGHT HOLDER, OR ANY OTHER PARTY WHO MODIFIES AND/OR CONVEYS
|
||||||
|
THE PROGRAM AS PERMITTED ABOVE, BE LIABLE TO YOU FOR DAMAGES, INCLUDING ANY
|
||||||
|
GENERAL, SPECIAL, INCIDENTAL OR CONSEQUENTIAL DAMAGES ARISING OUT OF THE
|
||||||
|
USE OR INABILITY TO USE THE PROGRAM (INCLUDING BUT NOT LIMITED TO LOSS OF
|
||||||
|
DATA OR DATA BEING RENDERED INACCURATE OR LOSSES SUSTAINED BY YOU OR THIRD
|
||||||
|
PARTIES OR A FAILURE OF THE PROGRAM TO OPERATE WITH ANY OTHER PROGRAMS),
|
||||||
|
EVEN IF SUCH HOLDER OR OTHER PARTY HAS BEEN ADVISED OF THE POSSIBILITY OF
|
||||||
|
SUCH DAMAGES.
|
||||||
|
|
||||||
|
17. Interpretation of Sections 15 and 16.
|
||||||
|
|
||||||
|
If the disclaimer of warranty and limitation of liability provided
|
||||||
|
above cannot be given local legal effect according to their terms,
|
||||||
|
reviewing courts shall apply local law that most closely approximates
|
||||||
|
an absolute waiver of all civil liability in connection with the
|
||||||
|
Program, unless a warranty or assumption of liability accompanies a
|
||||||
|
copy of the Program in return for a fee.
|
||||||
|
|
||||||
|
END OF TERMS AND CONDITIONS
|
||||||
|
|
||||||
|
How to Apply These Terms to Your New Programs
|
||||||
|
|
||||||
|
If you develop a new program, and you want it to be of the greatest
|
||||||
|
possible use to the public, the best way to achieve this is to make it
|
||||||
|
free software which everyone can redistribute and change under these terms.
|
||||||
|
|
||||||
|
To do so, attach the following notices to the program. It is safest
|
||||||
|
to attach them to the start of each source file to most effectively
|
||||||
|
state the exclusion of warranty; and each file should have at least
|
||||||
|
the "copyright" line and a pointer to where the full notice is found.
|
||||||
|
|
||||||
|
<one line to give the program's name and a brief idea of what it does.>
|
||||||
|
Copyright (C) <year> <name of author>
|
||||||
|
|
||||||
|
This program is free software: you can redistribute it and/or modify
|
||||||
|
it under the terms of the GNU General Public License as published by
|
||||||
|
the Free Software Foundation, either version 3 of the License, or
|
||||||
|
(at your option) any later version.
|
||||||
|
|
||||||
|
This program is distributed in the hope that it will be useful,
|
||||||
|
but WITHOUT ANY WARRANTY; without even the implied warranty of
|
||||||
|
MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
|
||||||
|
GNU General Public License for more details.
|
||||||
|
|
||||||
|
You should have received a copy of the GNU General Public License
|
||||||
|
along with this program. If not, see <http://www.gnu.org/licenses/>.
|
||||||
|
|
||||||
|
Also add information on how to contact you by electronic and paper mail.
|
||||||
|
|
||||||
|
If the program does terminal interaction, make it output a short
|
||||||
|
notice like this when it starts in an interactive mode:
|
||||||
|
|
||||||
|
<program> Copyright (C) <year> <name of author>
|
||||||
|
This program comes with ABSOLUTELY NO WARRANTY; for details type `show w'.
|
||||||
|
This is free software, and you are welcome to redistribute it
|
||||||
|
under certain conditions; type `show c' for details.
|
||||||
|
|
||||||
|
The hypothetical commands `show w' and `show c' should show the appropriate
|
||||||
|
parts of the General Public License. Of course, your program's commands
|
||||||
|
might be different; for a GUI interface, you would use an "about box".
|
||||||
|
|
||||||
|
You should also get your employer (if you work as a programmer) or school,
|
||||||
|
if any, to sign a "copyright disclaimer" for the program, if necessary.
|
||||||
|
For more information on this, and how to apply and follow the GNU GPL, see
|
||||||
|
<http://www.gnu.org/licenses/>.
|
||||||
|
|
||||||
|
The GNU General Public License does not permit incorporating your program
|
||||||
|
into proprietary programs. If your program is a subroutine library, you
|
||||||
|
may consider it more useful to permit linking proprietary applications with
|
||||||
|
the library. If this is what you want to do, use the GNU Lesser General
|
||||||
|
Public License instead of this License. But first, please read
|
||||||
|
<http://www.gnu.org/philosophy/why-not-lgpl.html>.
|
||||||
Symlink
+1
@@ -0,0 +1 @@
|
|||||||
|
doc/index.rst
|
||||||
@@ -0,0 +1,79 @@
|
|||||||
|
# This file is part of Tryton. The COPYRIGHT file at the top level of
|
||||||
|
# this repository contains the full copyright notices and license terms.
|
||||||
|
|
||||||
|
import os
|
||||||
|
|
||||||
|
base_url = os.environ.get('DOC_BASE_URL')
|
||||||
|
if base_url:
|
||||||
|
modules_url = base_url + '/modules-{module}/'
|
||||||
|
trytond_url = base_url + '/server/'
|
||||||
|
else:
|
||||||
|
modules_url = 'https://docs.tryton.org/{series}/modules-{module}/'
|
||||||
|
trytond_url = 'https://docs.tryton.org/{series}/server/'
|
||||||
|
|
||||||
|
|
||||||
|
def get_info():
|
||||||
|
import json
|
||||||
|
import subprocess
|
||||||
|
|
||||||
|
module_dir = os.path.dirname(os.path.dirname(__file__))
|
||||||
|
|
||||||
|
info = dict()
|
||||||
|
|
||||||
|
metadata_cmd = 'python3 -m build -qq --metadata'
|
||||||
|
if os.environ.get('DOC_NO_ISOLATION'):
|
||||||
|
metadata_cmd += ' --no-isolation'
|
||||||
|
metadata = subprocess.check_output(
|
||||||
|
metadata_cmd, shell=True, encoding='utf-8', cwd=module_dir).strip()
|
||||||
|
metadata = json.loads(metadata)
|
||||||
|
info['name'] = metadata['name']
|
||||||
|
info['description'] = metadata['summary']
|
||||||
|
major_version, minor_version, _ = metadata['version'].split('.', 2)
|
||||||
|
major_version = int(major_version)
|
||||||
|
minor_version = int(minor_version)
|
||||||
|
if minor_version % 2:
|
||||||
|
info['series'] = 'latest'
|
||||||
|
info['branch'] = 'branch/default'
|
||||||
|
else:
|
||||||
|
info['series'] = '.'.join(version.split('.', 2)[:2])
|
||||||
|
info['branch'] = 'branch/' + info['series']
|
||||||
|
|
||||||
|
return info
|
||||||
|
|
||||||
|
|
||||||
|
info = get_info()
|
||||||
|
|
||||||
|
html_theme = 'sphinx_book_theme'
|
||||||
|
html_theme_options = {
|
||||||
|
'logo': {
|
||||||
|
'alt_text': "Tryton Documentation",
|
||||||
|
'image_light': 'https://docs.tryton.org/logo-light.svg',
|
||||||
|
'image_dark': 'https://docs.tryton.org/logo-dark.svg',
|
||||||
|
'link': base_url,
|
||||||
|
},
|
||||||
|
'home_page_in_toc': True,
|
||||||
|
'repository_provider': 'gitlab',
|
||||||
|
'repository_url': 'https://code.tryton.org/tryton',
|
||||||
|
'repository_branch': info['branch'],
|
||||||
|
'use_source_button': True,
|
||||||
|
'use_edit_page_button': True,
|
||||||
|
'use_repository_button': True,
|
||||||
|
'use_download_button': False,
|
||||||
|
'path_to_docs': 'naiad/doc',
|
||||||
|
}
|
||||||
|
html_title = info['description']
|
||||||
|
master_doc = 'index'
|
||||||
|
project = info['name']
|
||||||
|
release = version = info['series']
|
||||||
|
default_role = 'ref'
|
||||||
|
highlight_language = 'none'
|
||||||
|
extensions = [
|
||||||
|
'sphinx_copybutton',
|
||||||
|
'sphinx.ext.intersphinx',
|
||||||
|
]
|
||||||
|
intersphinx_mapping = {
|
||||||
|
'python': ('https://docs.python.org/', None),
|
||||||
|
}
|
||||||
|
linkcheck_ignore = [r'/.*', r'https://demo.tryton.org/*']
|
||||||
|
|
||||||
|
del get_info, info, base_url, modules_url, trytond_url
|
||||||
@@ -0,0 +1,60 @@
|
|||||||
|
==================
|
||||||
|
Tryton REST Client
|
||||||
|
==================
|
||||||
|
|
||||||
|
A library to access Tryton's REST API.
|
||||||
|
|
||||||
|
Example of usage
|
||||||
|
----------------
|
||||||
|
|
||||||
|
>>> from naiad import Client, Record
|
||||||
|
|
||||||
|
Configuration
|
||||||
|
~~~~~~~~~~~~~
|
||||||
|
|
||||||
|
>>> import os
|
||||||
|
>>> url = os.environ.get('NAIAD_URL', 'https://localhost:8000/:memory:')
|
||||||
|
>>> client = Client(url, os.getenv('NAIAD_KEY'))
|
||||||
|
|
||||||
|
Creating a new group
|
||||||
|
~~~~~~~~~~~~~~~~~~~~
|
||||||
|
|
||||||
|
>>> group = Record('res.group')
|
||||||
|
>>> group.name = "New Group"
|
||||||
|
>>> group = client.store(group)
|
||||||
|
>>> group.id >= 0
|
||||||
|
True
|
||||||
|
|
||||||
|
Searching a user
|
||||||
|
~~~~~~~~~~~~~~~~
|
||||||
|
|
||||||
|
>>> admin, = client.search(
|
||||||
|
... 'res.user', [('login', '=', 'admin')], fields=['login'])
|
||||||
|
>>> admin.login
|
||||||
|
'admin'
|
||||||
|
|
||||||
|
Modifying a user
|
||||||
|
~~~~~~~~~~~~~~~~
|
||||||
|
|
||||||
|
>>> admin.signature = "Administrator"
|
||||||
|
>>> admin.groups = [group]
|
||||||
|
>>> admin = client.store(admin, fields=['signature', 'groups.id'])
|
||||||
|
>>> admin.signature
|
||||||
|
'Administrator'
|
||||||
|
>>> group in admin.groups
|
||||||
|
True
|
||||||
|
|
||||||
|
Calling an action
|
||||||
|
~~~~~~~~~~~~~~~~~
|
||||||
|
|
||||||
|
>>> _ = client.action(admin, 'reset_password')
|
||||||
|
|
||||||
|
Fetching a report
|
||||||
|
~~~~~~~~~~~~~~~~~
|
||||||
|
|
||||||
|
>>> filename, content = client.report('res.user.email_reset_password', admin.id)
|
||||||
|
|
||||||
|
.. toctree::
|
||||||
|
:maxdepth: 2
|
||||||
|
|
||||||
|
releases
|
||||||
@@ -0,0 +1,7 @@
|
|||||||
|
.. _releases-index:
|
||||||
|
|
||||||
|
=============
|
||||||
|
Release notes
|
||||||
|
=============
|
||||||
|
|
||||||
|
.. include:: ../CHANGELOG
|
||||||
@@ -0,0 +1,3 @@
|
|||||||
|
build
|
||||||
|
sphinx_book_theme
|
||||||
|
sphinx_copybutton
|
||||||
@@ -0,0 +1,544 @@
|
|||||||
|
# This file is part of Tryton. The COPYRIGHT file at the top level of
|
||||||
|
# this repository contains the full copyright notices and license terms.
|
||||||
|
"""
|
||||||
|
A library to access Tryton's REST API
|
||||||
|
"""
|
||||||
|
import json
|
||||||
|
import threading
|
||||||
|
import time
|
||||||
|
from base64 import urlsafe_b64encode
|
||||||
|
from contextlib import contextmanager
|
||||||
|
from email.message import Message
|
||||||
|
from functools import partial, total_ordering
|
||||||
|
|
||||||
|
import httpx
|
||||||
|
|
||||||
|
from ._json import JSONDecoder, JSONEncoder
|
||||||
|
|
||||||
|
__version__ = "7.9.0"
|
||||||
|
__all__ = ['Client', 'Record', 'set_delete', 'set_remove']
|
||||||
|
_json_decoder = JSONDecoder()
|
||||||
|
|
||||||
|
_dumps = partial(json.dumps, cls=JSONEncoder, separators=(',', ':'))
|
||||||
|
|
||||||
|
|
||||||
|
class Client:
|
||||||
|
"""A client for REST API of Tryton based on httpx.Client.
|
||||||
|
|
||||||
|
Parameters:
|
||||||
|
- base_url: The URL to use to connect to the Tryton server including
|
||||||
|
the database.
|
||||||
|
- key: The Tryton application key used for user authentication.
|
||||||
|
- usages: An optional iterable containing the usage strings.
|
||||||
|
- context: An optional dictionary for setting the context.
|
||||||
|
- languages: An optional iterable containing language code strings or
|
||||||
|
combination of language code and quality.
|
||||||
|
- timeout: An optional httpx.Timeout configuration.
|
||||||
|
- limits: An optional httpx.Limits configuration.
|
||||||
|
- max_retries: The maximum number of retries.
|
||||||
|
"""
|
||||||
|
def __init__(
|
||||||
|
self, base_url, key, usages=None, context=None, languages=None,
|
||||||
|
timeout=httpx.Timeout(timeout=5),
|
||||||
|
limits=httpx.Limits(
|
||||||
|
max_connections=100, max_keepalive_connections=20),
|
||||||
|
max_retries=5):
|
||||||
|
self.base_url = base_url
|
||||||
|
self.max_retries = max_retries
|
||||||
|
headers = {
|
||||||
|
'User-Agent': f'naiad/{__version__}',
|
||||||
|
}
|
||||||
|
if context:
|
||||||
|
headers['X-Tryton-Context'] = (
|
||||||
|
urlsafe_b64encode(_dumps(context).encode()).decode())
|
||||||
|
if languages:
|
||||||
|
headers['Accept-Language'] = _format_accept_language(languages)
|
||||||
|
if usages:
|
||||||
|
headers['X-Tryton-Usage'] = ','.join(usages)
|
||||||
|
self.client = httpx.Client(
|
||||||
|
base_url=self.base_url + '/rest',
|
||||||
|
auth=Auth(key),
|
||||||
|
headers=headers,
|
||||||
|
timeout=timeout,
|
||||||
|
limits=limits)
|
||||||
|
|
||||||
|
def _request(self, method, endpoint, **kwargs):
|
||||||
|
retries = 0
|
||||||
|
exception = None
|
||||||
|
while retries <= self.max_retries:
|
||||||
|
try:
|
||||||
|
response = self.client.request(method, endpoint, **kwargs)
|
||||||
|
response.raise_for_status()
|
||||||
|
if response.headers['Content-Type'] == 'application/json':
|
||||||
|
content = response.json(object_hook=_json_decoder)
|
||||||
|
else:
|
||||||
|
content = response.content
|
||||||
|
return response, content
|
||||||
|
except httpx.ConnectError as e:
|
||||||
|
retries += 1
|
||||||
|
wait_time = 2 ** (retries - 1)
|
||||||
|
time.sleep(wait_time)
|
||||||
|
exception = e
|
||||||
|
raise exception
|
||||||
|
|
||||||
|
def search(
|
||||||
|
self, model, domain=None, order=None, range_=None,
|
||||||
|
limit=None, offset=0, fields=None):
|
||||||
|
"""Make a search and returns a list of Record instances.
|
||||||
|
|
||||||
|
Parameters:
|
||||||
|
- model: The name of the model to search on.
|
||||||
|
- domain: An optional Tryton domain.
|
||||||
|
- order: An optional Tryton order clause.
|
||||||
|
- range_: An optional pair consisting of the start and end
|
||||||
|
positions of the records to retrieve.
|
||||||
|
- limit: An optional size limit for the number of records to
|
||||||
|
retrieve.
|
||||||
|
- offset: An optional offset to start retrieving records.
|
||||||
|
- fields: An optional list of fields to read.
|
||||||
|
|
||||||
|
Note: If range_ is set, limit and offset are ignored and the result is
|
||||||
|
a couple containing start, end and size and the records.
|
||||||
|
"""
|
||||||
|
assert range_ is None or (limit is None and offset == 0)
|
||||||
|
params = {}
|
||||||
|
if domain is not None:
|
||||||
|
params['d'] = urlsafe_b64encode(_dumps(domain).encode()).decode()
|
||||||
|
if order is not None:
|
||||||
|
params['o'] = urlsafe_b64encode(_dumps(order).encode()).decode()
|
||||||
|
headers = {}
|
||||||
|
if range_ is not None:
|
||||||
|
start, end = range_
|
||||||
|
headers['Range'] = f'records={start}-{end}'
|
||||||
|
else:
|
||||||
|
if offset != 0:
|
||||||
|
params['p'] = offset
|
||||||
|
if limit is not None:
|
||||||
|
params['s'] = limit
|
||||||
|
if fields:
|
||||||
|
params['f'] = fields
|
||||||
|
response, content = self._request(
|
||||||
|
'GET', f'/model/{model}', params=params, headers=headers)
|
||||||
|
records = [Record(**d) for d in content]
|
||||||
|
if range_:
|
||||||
|
start = end = size = None
|
||||||
|
if range_ := response.headers.get('Content-Range'):
|
||||||
|
unit, range_ = range_.split(' ', 1)
|
||||||
|
if unit == 'records' and '/' in range_:
|
||||||
|
range_, size = range_.split('/', 1)
|
||||||
|
try:
|
||||||
|
start, end = map(int, range_.split('-'))
|
||||||
|
except ValueError:
|
||||||
|
pass
|
||||||
|
try:
|
||||||
|
size = int(size)
|
||||||
|
except ValueError:
|
||||||
|
pass
|
||||||
|
return (start, end, size), records
|
||||||
|
return records
|
||||||
|
|
||||||
|
def get(self, model, id, fields=None):
|
||||||
|
"""Fetch and return a record.
|
||||||
|
|
||||||
|
Parameters:
|
||||||
|
- model: The name of the model.
|
||||||
|
- id: The ID of the record to fetch.
|
||||||
|
- fields: An optional list of fields to retrieve instead of the
|
||||||
|
defaults.
|
||||||
|
"""
|
||||||
|
params = {}
|
||||||
|
if fields is not None:
|
||||||
|
params['f'] = fields
|
||||||
|
_, content = self._request(
|
||||||
|
'GET', f'/model/{model}/{id}', params=params)
|
||||||
|
return Record(**content)
|
||||||
|
|
||||||
|
def create(self, model, values, fields=None):
|
||||||
|
"""Create and return the new record.
|
||||||
|
|
||||||
|
Parameters:
|
||||||
|
- model: The name of the model.
|
||||||
|
- values: A dictionary containing the values of the fields.
|
||||||
|
- fields: An optional list of fields to retrieve instead of the
|
||||||
|
defaults.
|
||||||
|
"""
|
||||||
|
params = {}
|
||||||
|
if fields is not None:
|
||||||
|
params['f'] = fields
|
||||||
|
content = _dumps(values)
|
||||||
|
response, content = self._request(
|
||||||
|
'POST', f'/model/{model}',
|
||||||
|
headers={
|
||||||
|
'Content-Type': 'application/json',
|
||||||
|
},
|
||||||
|
params=params,
|
||||||
|
content=content)
|
||||||
|
return Record(**content)
|
||||||
|
|
||||||
|
def update(self, model, id, values, fields=None):
|
||||||
|
"""Update and return the updated record.
|
||||||
|
|
||||||
|
Parameters:
|
||||||
|
- model: The name of the model.
|
||||||
|
- id: The ID of the record to update.
|
||||||
|
- values: A dictionary containing the values of the fields.
|
||||||
|
- fields: An optional list of fields to retrieve instead of the
|
||||||
|
defaults.
|
||||||
|
"""
|
||||||
|
params = {}
|
||||||
|
if fields is not None:
|
||||||
|
params['f'] = fields
|
||||||
|
content = _dumps(values)
|
||||||
|
response, content = self._request(
|
||||||
|
'PUT', f'/model/{model}/{id}',
|
||||||
|
headers={
|
||||||
|
'Content-Type': 'application/json',
|
||||||
|
},
|
||||||
|
params=params,
|
||||||
|
content=content)
|
||||||
|
return Record(**content)
|
||||||
|
|
||||||
|
def delete(self, model, id=None):
|
||||||
|
"""Delete a record.
|
||||||
|
|
||||||
|
Parameters:
|
||||||
|
- model: The name of the model or the Record instance to be
|
||||||
|
deleted.
|
||||||
|
- id: The ID of the record to delete.
|
||||||
|
|
||||||
|
Note: If a Record instance is specified, the ID must not be specified.
|
||||||
|
"""
|
||||||
|
if id is None:
|
||||||
|
record = model
|
||||||
|
model = record._model
|
||||||
|
id = record.id
|
||||||
|
self._request('DELETE', f'/model/{model}/{id}')
|
||||||
|
|
||||||
|
def store(self, record, fields=None):
|
||||||
|
"""Store a record and return the new/updated record.
|
||||||
|
|
||||||
|
It the record instance has no id, a new one is created otherwise it is
|
||||||
|
updated.
|
||||||
|
|
||||||
|
Parameters:
|
||||||
|
- record: The Record instance to store.
|
||||||
|
- fields: An optional list of fields to retrieve instead of the
|
||||||
|
defaults.
|
||||||
|
"""
|
||||||
|
if record.id is None:
|
||||||
|
return self.create(
|
||||||
|
record._model, record.to_values(), fields=fields)
|
||||||
|
else:
|
||||||
|
return self.update(
|
||||||
|
record._model, record.id, record.to_values(), fields=fields)
|
||||||
|
|
||||||
|
def action(self, model, name, id=None, fields=None, kwargs=None):
|
||||||
|
"""Launch an action and return the result
|
||||||
|
|
||||||
|
Parameters:
|
||||||
|
- model: The name of the model.
|
||||||
|
- name: The name of the action on the model.
|
||||||
|
- id: An optional ID for the record on which to perform the action.
|
||||||
|
- fields: An optional list of fields to retrieve instead of the
|
||||||
|
defaults if the action returns a Record.
|
||||||
|
- kwargs: An optional dictionary of additional arguments to pass to
|
||||||
|
the action.
|
||||||
|
"""
|
||||||
|
if isinstance(model, Record):
|
||||||
|
record = model
|
||||||
|
model = record._model
|
||||||
|
if id is None:
|
||||||
|
id = record.id
|
||||||
|
params = {}
|
||||||
|
if fields is not None:
|
||||||
|
params['f'] = fields
|
||||||
|
content = _dumps(kwargs if kwargs is not None else {})
|
||||||
|
if id is None:
|
||||||
|
url = f'/model/{model}/{name}'
|
||||||
|
else:
|
||||||
|
url = f'/model/{model}/{id}/{name}'
|
||||||
|
response, content = self._request(
|
||||||
|
'POST', url,
|
||||||
|
headers={
|
||||||
|
'Content-Type': 'application/json',
|
||||||
|
},
|
||||||
|
params=params,
|
||||||
|
content=content)
|
||||||
|
if (id is not None
|
||||||
|
and isinstance(content, dict)
|
||||||
|
and content.get('__name__') == model):
|
||||||
|
return Record(**content)
|
||||||
|
return content
|
||||||
|
|
||||||
|
def report(self, name, id=None, data=None):
|
||||||
|
"""Render a report and return the couple of file name and content.
|
||||||
|
|
||||||
|
Parameters:
|
||||||
|
- name: The name of the report.
|
||||||
|
- id: An option ID for the record on which to render the report.
|
||||||
|
- data: An optional dictionary containing additional data to be
|
||||||
|
passed to the report.
|
||||||
|
"""
|
||||||
|
id = int(id)
|
||||||
|
content = _dumps(data or {})
|
||||||
|
response, content = self._request(
|
||||||
|
'GET', f'/report/{name}/{id}',
|
||||||
|
headers={
|
||||||
|
'Content-Type': 'application/json',
|
||||||
|
},
|
||||||
|
content=content)
|
||||||
|
if content_disposition := response.headers['Content-Disposition']:
|
||||||
|
msg = Message()
|
||||||
|
msg['content-disposition'] = content_disposition
|
||||||
|
filename = msg.get_filename()
|
||||||
|
else:
|
||||||
|
filename = 'data.bin'
|
||||||
|
return filename, content
|
||||||
|
|
||||||
|
|
||||||
|
class Auth(httpx.Auth):
|
||||||
|
def __init__(self, token):
|
||||||
|
self.token = token
|
||||||
|
|
||||||
|
def auth_flow(self, request):
|
||||||
|
request.headers['Authorization'] = f'bearer {self.token}'
|
||||||
|
yield request
|
||||||
|
|
||||||
|
|
||||||
|
class _ThreadLocal:
|
||||||
|
def __init__(self):
|
||||||
|
self._local = threading.local()
|
||||||
|
|
||||||
|
@property
|
||||||
|
def deleted(self):
|
||||||
|
if not hasattr(self._local, 'deleted'):
|
||||||
|
self._local.deleted = set()
|
||||||
|
return self._local.deleted
|
||||||
|
|
||||||
|
@property
|
||||||
|
def removed(self):
|
||||||
|
if not hasattr(self._local, 'removed'):
|
||||||
|
self._local.removed = set()
|
||||||
|
return self._local.removed
|
||||||
|
|
||||||
|
|
||||||
|
_thread_local = _ThreadLocal()
|
||||||
|
|
||||||
|
|
||||||
|
@contextmanager
|
||||||
|
def set_delete(model, field):
|
||||||
|
"""Return context manager to delete the missing records from relational
|
||||||
|
fields when storing a record.
|
||||||
|
|
||||||
|
Parameters:
|
||||||
|
- model: the name of the model.
|
||||||
|
- field: the name of the field.
|
||||||
|
"""
|
||||||
|
_thread_local.deleted.add((model, field))
|
||||||
|
_thread_local.removed.discard((model, field))
|
||||||
|
try:
|
||||||
|
yield
|
||||||
|
finally:
|
||||||
|
_thread_local.deleted.discard((model, field))
|
||||||
|
|
||||||
|
|
||||||
|
@contextmanager
|
||||||
|
def set_remove(model, field):
|
||||||
|
"""Return context manager to remove the missing records from relational
|
||||||
|
fields when storing a record.
|
||||||
|
|
||||||
|
Parameters:
|
||||||
|
- model: the name of the model.
|
||||||
|
- field: the name of the field.
|
||||||
|
"""
|
||||||
|
_thread_local.deleted.discard((model, field))
|
||||||
|
_thread_local.removed.add((model, field))
|
||||||
|
try:
|
||||||
|
yield
|
||||||
|
finally:
|
||||||
|
_thread_local.removed.discard((model, field))
|
||||||
|
|
||||||
|
|
||||||
|
@total_ordering
|
||||||
|
class Record:
|
||||||
|
"""A container that stores data from a Tryton record.
|
||||||
|
|
||||||
|
Parameters:
|
||||||
|
- __name__: The name of the model.
|
||||||
|
- id: An option ID of the record.
|
||||||
|
"""
|
||||||
|
__slots__ = ('_model', 'id', '_raw', '_stored', '_modified')
|
||||||
|
|
||||||
|
def __init__(self, __name__=None, **kwargs):
|
||||||
|
self._model = __name__ or kwargs.pop('__name__')
|
||||||
|
self.id = kwargs.pop('id', None)
|
||||||
|
self._stored = {}
|
||||||
|
self._modified = {}
|
||||||
|
if self.id is None:
|
||||||
|
self._raw = {}
|
||||||
|
for name, value in kwargs.items():
|
||||||
|
setattr(self, name, value)
|
||||||
|
else:
|
||||||
|
self._raw = kwargs or {}
|
||||||
|
|
||||||
|
def __repr__(self):
|
||||||
|
return (
|
||||||
|
f'{self.__class__.__qualname__}'
|
||||||
|
f'({self._model!r}, id={self.id!r})')
|
||||||
|
|
||||||
|
def __contains__(self, name):
|
||||||
|
return name in dir(self)
|
||||||
|
|
||||||
|
def __int__(self):
|
||||||
|
return self.id
|
||||||
|
|
||||||
|
def __str__(self):
|
||||||
|
try:
|
||||||
|
return self.rec_name
|
||||||
|
except AttributeError:
|
||||||
|
return str(self.id) if self.id is not None else ''
|
||||||
|
|
||||||
|
def __eq__(self, other):
|
||||||
|
if isinstance(other, int):
|
||||||
|
return self.id == other
|
||||||
|
elif isinstance(other, Record):
|
||||||
|
return (self._model, self.id) == (other._model, other.id)
|
||||||
|
return NotImplemented
|
||||||
|
|
||||||
|
def __lt__(self, other):
|
||||||
|
if not isinstance(other, Record) or self._model != other._model:
|
||||||
|
return NotImplemented
|
||||||
|
return self.id < other.id
|
||||||
|
|
||||||
|
def __ne__(self, other):
|
||||||
|
return not self == other
|
||||||
|
|
||||||
|
def __hash__(self):
|
||||||
|
return hash((self._model, self.id))
|
||||||
|
|
||||||
|
def __bool__(self):
|
||||||
|
return True
|
||||||
|
|
||||||
|
@classmethod
|
||||||
|
def _convert(cls, value):
|
||||||
|
if isinstance(value, dict) and value.get('__name__'):
|
||||||
|
value = cls(**value)
|
||||||
|
elif (isinstance(value, list)
|
||||||
|
and value
|
||||||
|
and isinstance(value[0], dict)
|
||||||
|
and value[0].get('__name__')):
|
||||||
|
value = tuple(cls(**v) for v in value)
|
||||||
|
return value
|
||||||
|
|
||||||
|
def __getattr__(self, name):
|
||||||
|
if name.startswith('__') and name.endswith('__'):
|
||||||
|
return super().__getattr__(name)
|
||||||
|
elif name in self._modified:
|
||||||
|
value = self._modified[name]
|
||||||
|
elif name in self._stored:
|
||||||
|
value = self._stored[name]
|
||||||
|
else:
|
||||||
|
try:
|
||||||
|
value = self._convert(self._raw.pop(name))
|
||||||
|
self._stored[name] = value
|
||||||
|
except KeyError:
|
||||||
|
raise AttributeError(name) from None
|
||||||
|
return value
|
||||||
|
|
||||||
|
def __setattr__(self, name, value):
|
||||||
|
if name in self.__slots__:
|
||||||
|
super().__setattr__(name, value)
|
||||||
|
elif value != getattr(self, name, None):
|
||||||
|
self._modified[name] = self._convert(value)
|
||||||
|
|
||||||
|
def __dir__(self):
|
||||||
|
return list(
|
||||||
|
self._modified.keys() | self._stored.keys() | self._raw.keys())
|
||||||
|
|
||||||
|
def to_dict(self):
|
||||||
|
"Return the record as dictionary"
|
||||||
|
result = {
|
||||||
|
'__name__': self._model,
|
||||||
|
'id': self.id,
|
||||||
|
}
|
||||||
|
for name in dir(self):
|
||||||
|
value = getattr(self, name)
|
||||||
|
if (isinstance(value, (list, tuple))
|
||||||
|
and value and isinstance(value[0], Record)):
|
||||||
|
value = [v.to_dict() for v in value]
|
||||||
|
elif isinstance(value, Record):
|
||||||
|
value = value.to_dict()
|
||||||
|
result[name] = value
|
||||||
|
return result
|
||||||
|
|
||||||
|
def to_values(self):
|
||||||
|
"""Return a dictionary of the modified data to be used for create or
|
||||||
|
update."""
|
||||||
|
result = {}
|
||||||
|
for name in dir(self):
|
||||||
|
value = getattr(self, name)
|
||||||
|
stored_value = self._stored.get(name)
|
||||||
|
if (
|
||||||
|
(isinstance(value, (list, tuple))
|
||||||
|
and value and isinstance(value[0], Record))
|
||||||
|
or (isinstance(stored_value, (list, tuple))
|
||||||
|
and stored_value
|
||||||
|
and isinstance(stored_value[0], Record))):
|
||||||
|
actions = []
|
||||||
|
to_create, to_add, to_write = [], [], []
|
||||||
|
for record in value:
|
||||||
|
if record.id is None:
|
||||||
|
to_create.append(record.to_values())
|
||||||
|
else:
|
||||||
|
if record not in (stored_value or []):
|
||||||
|
to_add.append(record.id)
|
||||||
|
if save_value := record.to_values():
|
||||||
|
to_write.append(('write', [record.id], save_value))
|
||||||
|
if stored_value:
|
||||||
|
to_delete, to_remove = [], []
|
||||||
|
for record in stored_value:
|
||||||
|
if record in value:
|
||||||
|
continue
|
||||||
|
if (self._model, name) in _thread_local.deleted:
|
||||||
|
to_delete.append(record.id)
|
||||||
|
elif (self._model, name) in _thread_local.removed:
|
||||||
|
to_remove.append(record.id)
|
||||||
|
else:
|
||||||
|
raise ValueError(
|
||||||
|
f'missing deleted or removed for {name}')
|
||||||
|
if to_delete:
|
||||||
|
actions.append(('delete', to_delete))
|
||||||
|
if to_remove:
|
||||||
|
actions.append(('remove', to_remove))
|
||||||
|
if to_add:
|
||||||
|
actions.append(('add', to_add))
|
||||||
|
if to_create:
|
||||||
|
actions.append(('create', to_create))
|
||||||
|
if to_write:
|
||||||
|
actions.extend(to_write)
|
||||||
|
value = actions
|
||||||
|
if not value:
|
||||||
|
continue
|
||||||
|
elif value != stored_value:
|
||||||
|
if isinstance(value, Record):
|
||||||
|
value = value.id
|
||||||
|
else:
|
||||||
|
continue
|
||||||
|
result[name] = value
|
||||||
|
return result
|
||||||
|
|
||||||
|
|
||||||
|
def _format_accept_language(languages):
|
||||||
|
result = []
|
||||||
|
for value in languages:
|
||||||
|
if isinstance(value, str):
|
||||||
|
language, quality = value, 1
|
||||||
|
else:
|
||||||
|
try:
|
||||||
|
language, quality = value
|
||||||
|
except ValueError:
|
||||||
|
quality = 1
|
||||||
|
if quality != 1:
|
||||||
|
value = f'{language};q={quality}'
|
||||||
|
result.append(value)
|
||||||
|
return ','.join(result)
|
||||||
@@ -0,0 +1,107 @@
|
|||||||
|
# This file is part of Tryton. The COPYRIGHT file at the top level of
|
||||||
|
# this repository contains the full copyright notices and license terms.
|
||||||
|
|
||||||
|
import base64
|
||||||
|
import datetime as dt
|
||||||
|
import json
|
||||||
|
from decimal import Decimal
|
||||||
|
|
||||||
|
|
||||||
|
class JSONDecoder(object):
|
||||||
|
|
||||||
|
decoders = {}
|
||||||
|
|
||||||
|
@classmethod
|
||||||
|
def register(cls, klass, decoder):
|
||||||
|
assert klass not in cls.decoders
|
||||||
|
cls.decoders[klass] = decoder
|
||||||
|
|
||||||
|
def __call__(self, dct):
|
||||||
|
if dct.get('__class__') in self.decoders:
|
||||||
|
return self.decoders[dct['__class__']](dct)
|
||||||
|
return dct
|
||||||
|
|
||||||
|
|
||||||
|
JSONDecoder.register('datetime',
|
||||||
|
lambda dct: dt.datetime(dct['year'], dct['month'], dct['day'],
|
||||||
|
dct['hour'], dct['minute'], dct['second'], dct['microsecond']))
|
||||||
|
JSONDecoder.register('date',
|
||||||
|
lambda dct: dt.date(dct['year'], dct['month'], dct['day']))
|
||||||
|
JSONDecoder.register('time',
|
||||||
|
lambda dct: dt.time(dct['hour'], dct['minute'], dct['second'],
|
||||||
|
dct['microsecond']))
|
||||||
|
JSONDecoder.register('timedelta',
|
||||||
|
lambda dct: dt.timedelta(seconds=dct['seconds']))
|
||||||
|
|
||||||
|
|
||||||
|
def _bytes_decoder(dct):
|
||||||
|
cast = bytearray if bytes == str else bytes
|
||||||
|
return cast(base64.decodebytes(dct['base64'].encode('utf-8')))
|
||||||
|
|
||||||
|
|
||||||
|
JSONDecoder.register('bytes', _bytes_decoder)
|
||||||
|
JSONDecoder.register('Decimal', lambda dct: Decimal(dct['decimal']))
|
||||||
|
|
||||||
|
|
||||||
|
class JSONEncoder(json.JSONEncoder):
|
||||||
|
|
||||||
|
serializers = {}
|
||||||
|
|
||||||
|
@classmethod
|
||||||
|
def register(cls, klass, encoder):
|
||||||
|
assert klass not in cls.serializers
|
||||||
|
cls.serializers[klass] = encoder
|
||||||
|
|
||||||
|
def default(self, obj):
|
||||||
|
marshaller = self.serializers.get(type(obj),
|
||||||
|
super(JSONEncoder, self).default)
|
||||||
|
return marshaller(obj)
|
||||||
|
|
||||||
|
|
||||||
|
JSONEncoder.register(dt.datetime,
|
||||||
|
lambda o: {
|
||||||
|
'__class__': 'datetime',
|
||||||
|
'year': o.year,
|
||||||
|
'month': o.month,
|
||||||
|
'day': o.day,
|
||||||
|
'hour': o.hour,
|
||||||
|
'minute': o.minute,
|
||||||
|
'second': o.second,
|
||||||
|
'microsecond': o.microsecond,
|
||||||
|
})
|
||||||
|
JSONEncoder.register(dt.date,
|
||||||
|
lambda o: {
|
||||||
|
'__class__': 'date',
|
||||||
|
'year': o.year,
|
||||||
|
'month': o.month,
|
||||||
|
'day': o.day,
|
||||||
|
})
|
||||||
|
JSONEncoder.register(dt.time,
|
||||||
|
lambda o: {
|
||||||
|
'__class__': 'time',
|
||||||
|
'hour': o.hour,
|
||||||
|
'minute': o.minute,
|
||||||
|
'second': o.second,
|
||||||
|
'microsecond': o.microsecond,
|
||||||
|
})
|
||||||
|
JSONEncoder.register(dt.timedelta,
|
||||||
|
lambda o: {
|
||||||
|
'__class__': 'timedelta',
|
||||||
|
'seconds': o.total_seconds(),
|
||||||
|
})
|
||||||
|
|
||||||
|
|
||||||
|
def _bytes_encoder(o):
|
||||||
|
return {
|
||||||
|
'__class__': 'bytes',
|
||||||
|
'base64': base64.encodebytes(o).decode('utf-8'),
|
||||||
|
}
|
||||||
|
|
||||||
|
|
||||||
|
JSONEncoder.register(bytes, _bytes_encoder)
|
||||||
|
JSONEncoder.register(bytearray, _bytes_encoder)
|
||||||
|
JSONEncoder.register(Decimal,
|
||||||
|
lambda o: {
|
||||||
|
'__class__': 'Decimal',
|
||||||
|
'decimal': str(o),
|
||||||
|
})
|
||||||
@@ -0,0 +1,2 @@
|
|||||||
|
# This file is part of Tryton. The COPYRIGHT file at the top level of
|
||||||
|
# this repository contains the full copyright notices and license terms.
|
||||||
@@ -0,0 +1,45 @@
|
|||||||
|
# This file is part of Tryton. The COPYRIGHT file at the top level of
|
||||||
|
# this repository contains the full copyright notices and license terms.
|
||||||
|
|
||||||
|
from urllib.parse import urljoin
|
||||||
|
|
||||||
|
import respx
|
||||||
|
|
||||||
|
from naiad import Client
|
||||||
|
from trytond.pool import Pool
|
||||||
|
from trytond.tests.test_tryton import RouteTestCase, app
|
||||||
|
|
||||||
|
__all__ = ['NaiadTestCase', 'app']
|
||||||
|
|
||||||
|
|
||||||
|
class NaiadTestCase(RouteTestCase):
|
||||||
|
module = 'res'
|
||||||
|
base_url = 'http://localhost:8000'
|
||||||
|
|
||||||
|
@classmethod
|
||||||
|
def setUpDatabase(cls):
|
||||||
|
pool = Pool()
|
||||||
|
User = pool.get('res.user')
|
||||||
|
UserApplication = pool.get('res.user.application')
|
||||||
|
admin, = User.search([('login', '=', 'admin')])
|
||||||
|
admin.email = 'admin@tryton.org'
|
||||||
|
admin.save()
|
||||||
|
application = UserApplication(user=admin, application='rest')
|
||||||
|
application.save()
|
||||||
|
cls.key = application.key
|
||||||
|
|
||||||
|
@property
|
||||||
|
def url(self):
|
||||||
|
return urljoin(self.base_url, self.db_name)
|
||||||
|
|
||||||
|
def setUp(self):
|
||||||
|
super().setUp()
|
||||||
|
self.respx_mock = respx.mock(base_url=self.base_url)
|
||||||
|
self.respx_mock.start()
|
||||||
|
self.respx_mock.route().mock(side_effect=respx.WSGIHandler(app))
|
||||||
|
self.addCleanup(self.respx_mock.stop)
|
||||||
|
|
||||||
|
def client(self, usages=None, context=None, languages=None):
|
||||||
|
return Client(
|
||||||
|
self.url, self.key,
|
||||||
|
usages=usages, context=context, languages=languages)
|
||||||
@@ -0,0 +1,41 @@
|
|||||||
|
# This file is part of Tryton. The COPYRIGHT file at the top level of
|
||||||
|
# this repository contains the full copyright notices and license terms.
|
||||||
|
|
||||||
|
from unittest.mock import patch
|
||||||
|
|
||||||
|
from naiad import Record
|
||||||
|
|
||||||
|
from .common import NaiadTestCase
|
||||||
|
|
||||||
|
|
||||||
|
class ActionTestCase(NaiadTestCase):
|
||||||
|
|
||||||
|
def setUp(self):
|
||||||
|
super().setUp()
|
||||||
|
patcher = patch('trytond.res.user._send_email')
|
||||||
|
patcher.start()
|
||||||
|
self.addCleanup(patcher.stop)
|
||||||
|
|
||||||
|
def test_action(self):
|
||||||
|
"Test action"
|
||||||
|
preferences = self.client().action('res.user', 'get_preferences')
|
||||||
|
|
||||||
|
self.assertIsInstance(preferences, dict)
|
||||||
|
|
||||||
|
def test_action_record(self):
|
||||||
|
"Test action on record"
|
||||||
|
record = Record('res.user', id=1)
|
||||||
|
record = self.client().action(
|
||||||
|
record, 'reset_password', fields=['password_reset'])
|
||||||
|
|
||||||
|
self.assertIsNotNone(record.password_reset)
|
||||||
|
|
||||||
|
def test_action_arguments(self):
|
||||||
|
"Test action with arguments"
|
||||||
|
record = self.client().action(
|
||||||
|
'res.user', 'reset_password', id=1, fields=['password_reset'],
|
||||||
|
kwargs={
|
||||||
|
'length': 12,
|
||||||
|
})
|
||||||
|
|
||||||
|
self.assertEqual(len(record.password_reset), 12)
|
||||||
@@ -0,0 +1,26 @@
|
|||||||
|
# This file is part of Tryton. The COPYRIGHT file at the top level of
|
||||||
|
# this repository contains the full copyright notices and license terms.
|
||||||
|
|
||||||
|
from .common import NaiadTestCase
|
||||||
|
|
||||||
|
|
||||||
|
class CreateTestCase(NaiadTestCase):
|
||||||
|
|
||||||
|
def test_create(self):
|
||||||
|
"Test create"
|
||||||
|
record = self.client().create('res.group', {
|
||||||
|
'name': "Test",
|
||||||
|
})
|
||||||
|
|
||||||
|
self.assertEqual(record._model, 'res.group')
|
||||||
|
self.assertGreaterEqual(record.id, 0)
|
||||||
|
|
||||||
|
def test_create_fields(self):
|
||||||
|
"Test create with fields"
|
||||||
|
record = self.client().create('res.group', {
|
||||||
|
'name': "Test w/ fields",
|
||||||
|
}, fields=['name'])
|
||||||
|
|
||||||
|
self.assertEqual(record._model, 'res.group')
|
||||||
|
self.assertEqual(record.name, "Test w/ fields")
|
||||||
|
self.assertGreaterEqual(record.id, 0)
|
||||||
@@ -0,0 +1,23 @@
|
|||||||
|
# This file is part of Tryton. The COPYRIGHT file at the top level of
|
||||||
|
# this repository contains the full copyright notices and license terms.
|
||||||
|
|
||||||
|
from naiad import Record
|
||||||
|
from trytond.pool import Pool
|
||||||
|
|
||||||
|
from .common import NaiadTestCase
|
||||||
|
|
||||||
|
|
||||||
|
class DeleteTestCase(NaiadTestCase):
|
||||||
|
|
||||||
|
@classmethod
|
||||||
|
def setUpDatabase(cls):
|
||||||
|
pool = Pool()
|
||||||
|
Group = pool.get('res.group')
|
||||||
|
super().setUpDatabase()
|
||||||
|
group = Group(name="Group to delete")
|
||||||
|
group.save()
|
||||||
|
cls.group_id = group.id
|
||||||
|
|
||||||
|
def test_delete(self):
|
||||||
|
record = Record('res.group', id=self.group_id)
|
||||||
|
self.client().delete(record)
|
||||||
@@ -0,0 +1,22 @@
|
|||||||
|
# This file is part of Tryton. The COPYRIGHT file at the top level of
|
||||||
|
# this repository contains the full copyright notices and license terms.
|
||||||
|
|
||||||
|
from naiad import Record
|
||||||
|
|
||||||
|
from .common import NaiadTestCase
|
||||||
|
|
||||||
|
|
||||||
|
class GetTestCase(NaiadTestCase):
|
||||||
|
|
||||||
|
def test_get(self):
|
||||||
|
"Test get"
|
||||||
|
record = self.client().get('res.user', 1)
|
||||||
|
|
||||||
|
self.assertEqual(record, Record('res.user', id=1))
|
||||||
|
|
||||||
|
def test_get_fields(self):
|
||||||
|
"Test get fields"
|
||||||
|
record = self.client().get('res.user', 1, fields=['name'])
|
||||||
|
|
||||||
|
self.assertEqual(
|
||||||
|
record, Record('res.user', id=1, name="Administrator"))
|
||||||
@@ -0,0 +1,48 @@
|
|||||||
|
# This file is part of Tryton. The COPYRIGHT file at the top level of
|
||||||
|
# this repository contains the full copyright notices and license terms.
|
||||||
|
|
||||||
|
from unittest import TestCase
|
||||||
|
from unittest.mock import patch
|
||||||
|
|
||||||
|
from naiad import Client, __version__, _format_accept_language
|
||||||
|
|
||||||
|
|
||||||
|
class HeadersTestCase(TestCase):
|
||||||
|
|
||||||
|
def test_format_accept_language(self):
|
||||||
|
"Test format accept language"
|
||||||
|
languages = ['fr', ('en', .5)]
|
||||||
|
|
||||||
|
header = _format_accept_language(languages)
|
||||||
|
|
||||||
|
self.assertEqual(header, 'fr,en;q=0.5')
|
||||||
|
|
||||||
|
@patch('httpx.Client')
|
||||||
|
def test_context_header(self, httpx_client):
|
||||||
|
"Test context header"
|
||||||
|
Client('http://localhost/', 'secret', context={'foo': 'bar'})
|
||||||
|
|
||||||
|
self.assertEqual(httpx_client.call_args.kwargs['headers'], {
|
||||||
|
'User-Agent': f'naiad/{__version__}',
|
||||||
|
'X-Tryton-Context': 'eyJmb28iOiJiYXIifQ==',
|
||||||
|
})
|
||||||
|
|
||||||
|
@patch('httpx.Client')
|
||||||
|
def test_language_header(self, httpx_client):
|
||||||
|
"Test language header"
|
||||||
|
Client('http://localhost/', 'secret', languages=['fr', ('en', .5)])
|
||||||
|
|
||||||
|
self.assertEqual(httpx_client.call_args.kwargs['headers'], {
|
||||||
|
'User-Agent': f'naiad/{__version__}',
|
||||||
|
'Accept-Language': 'fr,en;q=0.5',
|
||||||
|
})
|
||||||
|
|
||||||
|
@patch('httpx.Client')
|
||||||
|
def test_usage_header(self, httpx_client):
|
||||||
|
"Test usage header"
|
||||||
|
Client('http://localhost/', 'secret', usages=['foo', 'bar'])
|
||||||
|
|
||||||
|
self.assertEqual(httpx_client.call_args.kwargs['headers'], {
|
||||||
|
'User-Agent': f'naiad/{__version__}',
|
||||||
|
'X-Tryton-Usage': 'foo,bar',
|
||||||
|
})
|
||||||
@@ -0,0 +1,41 @@
|
|||||||
|
# This file is part of Tryton. The COPYRIGHT file at the top level of
|
||||||
|
# this repository contains the full copyright notices and license terms.
|
||||||
|
import doctest
|
||||||
|
import os
|
||||||
|
from unittest.mock import patch
|
||||||
|
|
||||||
|
import respx
|
||||||
|
|
||||||
|
from trytond.tests.test_tryton import DB_NAME, app
|
||||||
|
|
||||||
|
from .common import NaiadTestCase
|
||||||
|
|
||||||
|
here = os.path.dirname(__file__)
|
||||||
|
readme = os.path.normpath(os.path.join(here, '..', '..', 'README.rst'))
|
||||||
|
respx_mock = respx.mock(base_url=NaiadTestCase.base_url)
|
||||||
|
patcher = patch('trytond.res.user._send_email')
|
||||||
|
|
||||||
|
|
||||||
|
def doctest_setup(test):
|
||||||
|
NaiadTestCase.setUpClass()
|
||||||
|
os.environ['NAIAD_KEY'] = NaiadTestCase.key
|
||||||
|
os.environ['NAIAD_URL'] = f'{NaiadTestCase.base_url}/{DB_NAME}'
|
||||||
|
respx_mock.start()
|
||||||
|
respx_mock.route().mock(side_effect=respx.WSGIHandler(app))
|
||||||
|
patcher.start()
|
||||||
|
|
||||||
|
|
||||||
|
def doctest_teardown(test):
|
||||||
|
patcher.stop()
|
||||||
|
respx_mock.stop()
|
||||||
|
NaiadTestCase.tearDownClass()
|
||||||
|
|
||||||
|
|
||||||
|
def load_tests(loader, tests, pattern):
|
||||||
|
if os.path.isfile(readme):
|
||||||
|
tests.addTest(doctest.DocFileSuite(
|
||||||
|
readme, module_relative=False,
|
||||||
|
setUp=doctest_setup, tearDown=doctest_teardown,
|
||||||
|
encoding='utf-8',
|
||||||
|
optionflags=doctest.REPORT_ONLY_FIRST_FAILURE))
|
||||||
|
return tests
|
||||||
@@ -0,0 +1,189 @@
|
|||||||
|
# This file is part of Tryton. The COPYRIGHT file at the top level of
|
||||||
|
# this repository contains the full copyright notices and license terms.
|
||||||
|
|
||||||
|
from unittest import TestCase
|
||||||
|
|
||||||
|
from naiad import Record, set_delete, set_remove
|
||||||
|
|
||||||
|
|
||||||
|
class RecordTestCase(TestCase):
|
||||||
|
|
||||||
|
def test_repr(self):
|
||||||
|
"Test repr"
|
||||||
|
string = repr(Record('res.user', id=42))
|
||||||
|
|
||||||
|
self.assertEqual(string, "Record('res.user', id=42)")
|
||||||
|
|
||||||
|
def test_contains(self):
|
||||||
|
"Test contains"
|
||||||
|
record = Record('res.user', login='foo')
|
||||||
|
self.assertIn('login', record)
|
||||||
|
|
||||||
|
def test_int(self):
|
||||||
|
"Test int"
|
||||||
|
record = Record('res.user', id=42)
|
||||||
|
self.assertEqual(int(record), 42)
|
||||||
|
|
||||||
|
def test_int_no_id(self):
|
||||||
|
"Test int without id"
|
||||||
|
record = Record('res.user')
|
||||||
|
with self.assertRaises(TypeError):
|
||||||
|
int(record)
|
||||||
|
|
||||||
|
def test_str(self):
|
||||||
|
"Test str"
|
||||||
|
record = Record('res.user', id=42)
|
||||||
|
self.assertEqual(str(record), '42')
|
||||||
|
|
||||||
|
def test_str_no_id(self):
|
||||||
|
"Test str without id"
|
||||||
|
record = Record('res.user')
|
||||||
|
self.assertEqual(str(record), '')
|
||||||
|
|
||||||
|
def test_str_rec_name(self):
|
||||||
|
"Test str with rec_name"
|
||||||
|
record = Record('res.user', id=42, rec_name="Foo")
|
||||||
|
self.assertEqual(str(record), "Foo")
|
||||||
|
|
||||||
|
def test_equality(self):
|
||||||
|
"Test equality"
|
||||||
|
record1 = Record('res.user', id=42, login='foo')
|
||||||
|
record2 = Record('res.user', id=42, name='bar')
|
||||||
|
|
||||||
|
self.assertEqual(record1, record2)
|
||||||
|
self.assertEqual(record1, 42)
|
||||||
|
|
||||||
|
def test_inequality(self):
|
||||||
|
"Test inequality"
|
||||||
|
record1 = Record('res.user', id=42)
|
||||||
|
record2 = Record('res.user', id=1)
|
||||||
|
record3 = Record('res.group', id=42)
|
||||||
|
|
||||||
|
self.assertNotEqual(record1, record2)
|
||||||
|
self.assertNotEqual(record1, record3)
|
||||||
|
|
||||||
|
def test_order(self):
|
||||||
|
"Test order"
|
||||||
|
record1 = Record('res.user', id=1)
|
||||||
|
record2 = Record('res.user', id=2)
|
||||||
|
|
||||||
|
self.assertLess(record1, record2)
|
||||||
|
|
||||||
|
def test_hashable(self):
|
||||||
|
"Test hashable"
|
||||||
|
record = Record('res.user', id=42)
|
||||||
|
|
||||||
|
self.assertIn(record, {record: None})
|
||||||
|
|
||||||
|
def test_boolean(self):
|
||||||
|
"Test boolean"
|
||||||
|
self.assertTrue(Record('res.user'))
|
||||||
|
|
||||||
|
def test_to_dict(self):
|
||||||
|
"Test to dict"
|
||||||
|
record = Record(
|
||||||
|
'res.user', id=1,
|
||||||
|
name="User",
|
||||||
|
groups=[{'__name__': 'res.group', 'id': 2, 'name': "Group"}])
|
||||||
|
|
||||||
|
self.assertDictEqual(record.to_dict(), {
|
||||||
|
'__name__': 'res.user',
|
||||||
|
'id': 1,
|
||||||
|
'name': "User",
|
||||||
|
'groups': [{
|
||||||
|
'__name__': 'res.group',
|
||||||
|
'id': 2,
|
||||||
|
'name': "Group",
|
||||||
|
}],
|
||||||
|
})
|
||||||
|
|
||||||
|
def test_to_dict_instance(self):
|
||||||
|
"Test to dict with instance"
|
||||||
|
record = Record('res.user', id=1)
|
||||||
|
record.groups = [Record('res.group', id=2)]
|
||||||
|
|
||||||
|
self.assertDictEqual(record.to_dict(), {
|
||||||
|
'__name__': 'res.user',
|
||||||
|
'id': 1,
|
||||||
|
'groups': [{
|
||||||
|
'__name__': 'res.group',
|
||||||
|
'id': 2,
|
||||||
|
}],
|
||||||
|
})
|
||||||
|
|
||||||
|
def test_to_values(self):
|
||||||
|
"Test to values"
|
||||||
|
record = Record('res.user', id=1)
|
||||||
|
record.name = "Name"
|
||||||
|
|
||||||
|
self.assertDictEqual(record.to_values(), {
|
||||||
|
'name': "Name",
|
||||||
|
})
|
||||||
|
|
||||||
|
def test_to_values_not_modified(self):
|
||||||
|
"Test to values not modified"
|
||||||
|
record = Record('res.user', id=1, name="Name")
|
||||||
|
record.name = "Name"
|
||||||
|
|
||||||
|
self.assertDictEqual(record.to_values(), {})
|
||||||
|
|
||||||
|
def test_to_values_list_create(self):
|
||||||
|
"Test to values with list to create"
|
||||||
|
record = Record('res.user', id=1)
|
||||||
|
record.groups = [Record('res.group', name="Group")]
|
||||||
|
|
||||||
|
self.assertDictEqual(record.to_values(), {
|
||||||
|
'groups': [('create', [{'name': "Group"}])],
|
||||||
|
})
|
||||||
|
|
||||||
|
def test_to_values_list_add(self):
|
||||||
|
"Test to values with list to add"
|
||||||
|
record = Record('res.user', id=1)
|
||||||
|
record.groups = [Record('res.group', id=2)]
|
||||||
|
|
||||||
|
self.assertDictEqual(record.to_values(), {
|
||||||
|
'groups': [('add', [2])],
|
||||||
|
})
|
||||||
|
|
||||||
|
def test_to_values_list_add_write(self):
|
||||||
|
"Test to values with list to add and write"
|
||||||
|
record = Record('res.user', id=1)
|
||||||
|
record2 = Record('res.group', id=2)
|
||||||
|
record.groups = [record2]
|
||||||
|
record2.name = "Group"
|
||||||
|
|
||||||
|
self.assertDictEqual(record.to_values(), {
|
||||||
|
'groups': [('add', [2]), ('write', [2], {'name': "Group"})],
|
||||||
|
})
|
||||||
|
|
||||||
|
def test_to_values_list_write(self):
|
||||||
|
"Test to values with list to write"
|
||||||
|
record = Record(
|
||||||
|
'res.user', id=1, groups=[{'__name__': 'res.group', 'id': 2}])
|
||||||
|
record.groups[0].name = "Group"
|
||||||
|
|
||||||
|
self.assertDictEqual(record.to_values(), {
|
||||||
|
'groups': [('write', [2], {'name': "Group"})],
|
||||||
|
})
|
||||||
|
|
||||||
|
def test_to_values_list_delete(self):
|
||||||
|
"Test to values with list to delete"
|
||||||
|
record = Record(
|
||||||
|
'res.user', id=1, groups=[{'__name__': 'res.group', 'id': 2}])
|
||||||
|
record.groups = ()
|
||||||
|
|
||||||
|
with set_delete('res.user', 'groups'):
|
||||||
|
self.assertDictEqual(record.to_values(), {
|
||||||
|
'groups': [('delete', [2])],
|
||||||
|
})
|
||||||
|
|
||||||
|
def test_to_values_list_remove(self):
|
||||||
|
"Test to values with list to remove"
|
||||||
|
record = Record(
|
||||||
|
'res.user', id=1, groups=[{'__name__': 'res.group', 'id': 2}])
|
||||||
|
record.groups = ()
|
||||||
|
|
||||||
|
with set_remove('res.user', 'groups'):
|
||||||
|
self.assertDictEqual(record.to_values(), {
|
||||||
|
'groups': [('remove', [2])],
|
||||||
|
})
|
||||||
@@ -0,0 +1,26 @@
|
|||||||
|
# This file is part of Tryton. The COPYRIGHT file at the top level of
|
||||||
|
# this repository contains the full copyright notices and license terms.
|
||||||
|
|
||||||
|
from unittest.mock import patch
|
||||||
|
|
||||||
|
from .common import NaiadTestCase
|
||||||
|
|
||||||
|
|
||||||
|
class ActionTestCase(NaiadTestCase):
|
||||||
|
|
||||||
|
def setUp(self):
|
||||||
|
super().setUp()
|
||||||
|
patcher = patch('trytond.res.user._send_email')
|
||||||
|
patcher.start()
|
||||||
|
self.addCleanup(patcher.stop)
|
||||||
|
|
||||||
|
def test_report(self):
|
||||||
|
"Test report"
|
||||||
|
c = self.client()
|
||||||
|
|
||||||
|
c.action('res.user', 'reset_password', 1)
|
||||||
|
filename, content = c.report(
|
||||||
|
'res.user.email_reset_password', 1)
|
||||||
|
|
||||||
|
self.assertRegex(filename, r'.*\.html')
|
||||||
|
self.assertIsInstance(content, bytes)
|
||||||
@@ -0,0 +1,66 @@
|
|||||||
|
# This file is part of Tryton. The COPYRIGHT file at the top level of
|
||||||
|
# this repository contains the full copyright notices and license terms.
|
||||||
|
|
||||||
|
from operator import attrgetter
|
||||||
|
|
||||||
|
from naiad import Record
|
||||||
|
|
||||||
|
from .common import NaiadTestCase
|
||||||
|
|
||||||
|
|
||||||
|
class SearchTestCase(NaiadTestCase):
|
||||||
|
|
||||||
|
def test_search(self):
|
||||||
|
"Test search"
|
||||||
|
records = self.client().search('res.user')
|
||||||
|
self.assertEqual(records, [Record('res.user', id=1)])
|
||||||
|
|
||||||
|
def test_search_domain(self):
|
||||||
|
"Test search with domain"
|
||||||
|
record, = self.client().search(
|
||||||
|
'res.user', domain=[('login', '=', 'admin')], fields=['login'])
|
||||||
|
self.assertEqual(record.login, 'admin')
|
||||||
|
|
||||||
|
def test_search_order(self):
|
||||||
|
"Test search with order"
|
||||||
|
records = self.client().search(
|
||||||
|
'res.user',
|
||||||
|
domain=[('active', 'in', [True, False])],
|
||||||
|
order=[('login', 'DESC')],
|
||||||
|
fields=['login'])
|
||||||
|
self.assertEqual(
|
||||||
|
records, sorted(records, key=attrgetter('login'), reverse=True))
|
||||||
|
|
||||||
|
def test_search_range(self):
|
||||||
|
"Test search with range"
|
||||||
|
all_records = self.client().search('ir.model')
|
||||||
|
(start, end, size), records = self.client().search(
|
||||||
|
'ir.model', range_=(5, 10))
|
||||||
|
|
||||||
|
self.assertEqual(start, 5)
|
||||||
|
self.assertEqual(end, 10)
|
||||||
|
self.assertEqual(size, len(all_records))
|
||||||
|
self.assertEqual(len(records), 5)
|
||||||
|
self.assertEqual(records, all_records[5:10])
|
||||||
|
|
||||||
|
def test_search_limit(self):
|
||||||
|
"Test search with limit"
|
||||||
|
all_records = self.client().search('ir.model')
|
||||||
|
records = self.client().search('ir.model', limit=5)
|
||||||
|
|
||||||
|
self.assertEqual(len(records), 5)
|
||||||
|
self.assertEqual(records, all_records[:5])
|
||||||
|
|
||||||
|
def test_search_offset(self):
|
||||||
|
"Test search with offset"
|
||||||
|
all_records = self.client().search('ir.model')
|
||||||
|
records = self.client().search('ir.model', offset=5)
|
||||||
|
|
||||||
|
self.assertEqual(records, all_records[5:])
|
||||||
|
|
||||||
|
def test_search_fields(self):
|
||||||
|
"Test search with fields"
|
||||||
|
record, = self.client().search(
|
||||||
|
'res.user', domain=[('login', '=', 'admin')], fields=['name'])
|
||||||
|
|
||||||
|
self.assertEqual(record.name, "Administrator")
|
||||||
@@ -0,0 +1,28 @@
|
|||||||
|
# This file is part of Tryton. The COPYRIGHT file at the top level of
|
||||||
|
# this repository contains the full copyright notices and license terms.
|
||||||
|
|
||||||
|
from naiad import Record
|
||||||
|
|
||||||
|
from .common import NaiadTestCase
|
||||||
|
|
||||||
|
|
||||||
|
class StoreTestCase(NaiadTestCase):
|
||||||
|
|
||||||
|
def test_store_create(self):
|
||||||
|
"Test store with creation"
|
||||||
|
record = Record('res.group', name="Test store")
|
||||||
|
record = self.client().store(record, fields=['name'])
|
||||||
|
|
||||||
|
self.assertEqual(record._model, 'res.group')
|
||||||
|
self.assertEqual(record.name, "Test store")
|
||||||
|
self.assertGreaterEqual(record.id, 0)
|
||||||
|
|
||||||
|
def test_store_update(self):
|
||||||
|
"Test store with creation"
|
||||||
|
record = Record('res.user', id=1)
|
||||||
|
record.signature = "Admin"
|
||||||
|
record = self.client().store(record, fields=['signature'])
|
||||||
|
|
||||||
|
self.assertEqual(record._model, 'res.user')
|
||||||
|
self.assertEqual(record.signature, "Admin")
|
||||||
|
self.assertEqual(record.id, 1)
|
||||||
@@ -0,0 +1,26 @@
|
|||||||
|
# This file is part of Tryton. The COPYRIGHT file at the top level of
|
||||||
|
# this repository contains the full copyright notices and license terms.
|
||||||
|
|
||||||
|
from .common import NaiadTestCase
|
||||||
|
|
||||||
|
|
||||||
|
class UpdateTestCase(NaiadTestCase):
|
||||||
|
|
||||||
|
def test_update(self):
|
||||||
|
"Test update"
|
||||||
|
record = self.client().update('res.user', 1, {
|
||||||
|
'signature': "Admin",
|
||||||
|
})
|
||||||
|
|
||||||
|
self.assertEqual(record._model, 'res.user')
|
||||||
|
self.assertGreaterEqual(record.id, 0)
|
||||||
|
|
||||||
|
def test_update_fields(self):
|
||||||
|
"Test update with fields"
|
||||||
|
record = self.client().update('res.user', 1, {
|
||||||
|
'signature': "Admin",
|
||||||
|
}, fields=['signature'])
|
||||||
|
|
||||||
|
self.assertEqual(record._model, 'res.user')
|
||||||
|
self.assertEqual(record.signature, "Admin")
|
||||||
|
self.assertGreaterEqual(record.id, 0)
|
||||||
@@ -0,0 +1,51 @@
|
|||||||
|
[build-system]
|
||||||
|
requires = ['hatchling >= 1', 'hatch-tryton']
|
||||||
|
build-backend = 'hatchling.build'
|
||||||
|
|
||||||
|
[project]
|
||||||
|
name = 'naiad'
|
||||||
|
dynamic = ['version', 'dependencies', 'optional-dependencies', 'authors', 'readme']
|
||||||
|
requires-python = '>=3.10'
|
||||||
|
maintainers = [
|
||||||
|
{name = "Tryton", email = "foundation@tryton.org"},
|
||||||
|
]
|
||||||
|
description = "Library to access Tryton's REST API"
|
||||||
|
license = 'LGPL-3.0-or-later'
|
||||||
|
license-files = ['LICENSE', 'COPYRIGHT']
|
||||||
|
keywords = ["tryton", "cli", "REST"]
|
||||||
|
classifiers = [
|
||||||
|
"Development Status :: 5 - Production/Stable",
|
||||||
|
"Environment :: Plugins",
|
||||||
|
"Framework :: Tryton",
|
||||||
|
"Intended Audience :: Developers",
|
||||||
|
"Topic :: Office/Business",
|
||||||
|
"Topic :: Software Development :: Libraries :: Python Modules",
|
||||||
|
]
|
||||||
|
|
||||||
|
[project.urls]
|
||||||
|
homepage = "https://www.tryton.org/"
|
||||||
|
documentation = "https://docs.tryton.org/client-rest/"
|
||||||
|
changelog = "https://docs.tryton.org/client-library/releases.html"
|
||||||
|
forum = "https://discuss.tryton.org/tags/naiad"
|
||||||
|
issues = "https://bugs.tryton.org/tryton"
|
||||||
|
repository = "https://code.tryton.org/tryton"
|
||||||
|
funding = "https://www.tryton.org/donate"
|
||||||
|
|
||||||
|
[tool.hatch.version]
|
||||||
|
path = 'naiad/__init__.py'
|
||||||
|
|
||||||
|
[tool.hatch.build]
|
||||||
|
packages = ['naiad']
|
||||||
|
|
||||||
|
[tool.hatch.metadata.hooks.tryton]
|
||||||
|
dependencies = [
|
||||||
|
'httpx',
|
||||||
|
]
|
||||||
|
copyright = 'COPYRIGHT'
|
||||||
|
readme = 'README.rst'
|
||||||
|
|
||||||
|
[tool.hatch.metadata.hooks.tryton.optional-dependencies]
|
||||||
|
test = ['respx']
|
||||||
|
|
||||||
|
[tool.hatch.metadata.hooks.tryton.tryton-optional-dependencies]
|
||||||
|
test = ['trytond']
|
||||||
@@ -0,0 +1,21 @@
|
|||||||
|
[tox]
|
||||||
|
envlist = py310,py311,py312,py313,py314
|
||||||
|
|
||||||
|
[testenv]
|
||||||
|
changedir = {env_site_packages_dir}
|
||||||
|
extras = test
|
||||||
|
commands =
|
||||||
|
coverage run --rcfile={toxinidir}/tox.ini --source=naiad --omit=*/tests/* -m xmlrunner discover -s naiad.tests {posargs}
|
||||||
|
commands_post =
|
||||||
|
coverage report --rcfile={toxinidir}/tox.ini
|
||||||
|
coverage xml --rcfile={toxinidir}/tox.ini -o {package_root}/coverage.xml
|
||||||
|
deps =
|
||||||
|
coverage
|
||||||
|
unittest-xml-reporting
|
||||||
|
passenv = *
|
||||||
|
setenv =
|
||||||
|
TRYTOND_DATABASE_URI={env:TRYTOND_DATBASE_URI:sqlite://}
|
||||||
|
DB_NAME={env:DB_NAME::memory:}
|
||||||
|
|
||||||
|
[coverage:run]
|
||||||
|
relative_files = true
|
||||||
@@ -412,7 +412,7 @@ def user_application(name, json=True):
|
|||||||
try:
|
try:
|
||||||
response = func(request, *args, **kwargs)
|
response = func(request, *args, **kwargs)
|
||||||
except (UserError, UserWarning) as e:
|
except (UserError, UserWarning) as e:
|
||||||
response = JSONBadRequest(e)
|
raise JSONBadRequest(e)
|
||||||
if not isinstance(response, Response) and json:
|
if not isinstance(response, Response) and json:
|
||||||
response = Response(json_.dumps(response, cls=JSONEncoder),
|
response = Response(json_.dumps(response, cls=JSONEncoder),
|
||||||
content_type='application/json')
|
content_type='application/json')
|
||||||
|
|||||||
Reference in New Issue
Block a user