Skip to content

Commit f3ab4a3

Browse files
thomasballingerConvex, Inc
thomasballinger
authored and
Convex, Inc
committed
Updates to convex-py
GitOrigin-RevId: 41bcd7ec888eed10324a22d61eb0e3d91d5b65cf
1 parent f3b9688 commit f3ab4a3

33 files changed

+3145
-177
lines changed

‎.flake8

Lines changed: 7 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,7 @@
1+
[flake8]
2+
max-line-length = 100
3+
extend_ignore = D105
4+
per_file_ignores =
5+
tests/*.py:D100,D103,D104
6+
*example*.py:D100,D103
7+
exclude = .venv

‎.gitignore

Lines changed: 7 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,7 @@
1+
dist
2+
# dev-specific path to virtualenv, useful for the pyright language server
3+
# unless you are using VSCode which handles it for you.
4+
pyrightconfig.json
5+
6+
# binary output
7+
python/_convex/_convex.*.so

‎.prettierignore

Lines changed: 2 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,2 @@
1+
.mypy_cache/
2+
.pytest_cache/

‎.prettierrc

Lines changed: 2 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,2 @@
1+
proseWrap: "always"
2+
arrowParens: "avoid"

‎CHANGELOG.md

Lines changed: 57 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,57 @@
1+
# Upcoming
2+
3+
# 0.6.0
4+
5+
This is a rewrite adding subscribing to live query updates. The Python client
6+
now wraps the [Convex Rust client](https://docs.rs/convex) using the
7+
PyO3[https://pyo3.rs/].
8+
9+
The API is a superset but if you encounter unexpected incompatibilities consider
10+
the old client, moved to `convex.http_client`.
11+
12+
# 0.5.1
13+
14+
- Expose ConvexInt64 from the top level `convex` module.
15+
16+
# 0.5.0
17+
18+
- Remove ConvexMap and ConvexSet: these types are no longer allowed as arguments
19+
or returned by Convex functions.
20+
21+
See the [NPM version 0.19.0](https://news.convex.dev/announcing-convex-0-19-0)
22+
release notes for more.
23+
24+
If you need to communicate with a backend with functions that accept or return
25+
these types, _stay on version 0.4.0_.
26+
27+
- `ConvexClient.set_debug()` no longer applies to production deployments: logs
28+
from production deployments are no longer sent to clients, only appearing on
29+
the Convex dashboard.
30+
31+
- Add Support for `ConvexError`.
32+
33+
# 0.4.0
34+
35+
- Remove the `Id` class since document IDs are strings for Convex functions
36+
starting from
37+
[NPM version 0.17](https://news.convex.dev/announcing-convex-0-17-0/)
38+
- Add warnings when calling functions on deprecated versions of Convex
39+
40+
# 0.3.0
41+
42+
This release corresponds with Convex npm release 0.13.0.
43+
44+
- `mutation()`, `action()`, and `query()` now take two arguments: the function
45+
name and an (optional) arguments dictionary. See
46+
https://news.convex.dev/announcing-convex-0-13-0/ for more about this change.
47+
48+
If you need to communicate with a Convex backend with functions with
49+
positional arguments instead of a single arguments object, _stay on version
50+
0.2.0_.
51+
52+
# 0.2.0
53+
54+
- Both python `int` and `float` will coerce to a `number` type in Convex's JS
55+
environment. If you need a JS `bigint`, use a python `ConvexInt64`. Convex
56+
functions are written in JavaScript where `number` is used pervasively, so
57+
this change generally simplifies using Convex functions from python.

‎CONTRIBUTING.md

Lines changed: 67 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,67 @@
1+
# Contributing
2+
3+
Contributions are welcome!
4+
5+
Please share any general questions, feature requests, or product feedback in our
6+
[Convex Discord Community](https://convex.dev/community). We're particularly
7+
excited to see what you build on Convex!
8+
9+
Please ensure that python code is formatted with
10+
[black](https://pypi.org/project/black/) and markdown files are formatted with
11+
[prettier](https://prettier.io/).
12+
13+
Run tests with
14+
15+
```
16+
poetry install
17+
poetry run pytest
18+
```
19+
20+
Convex is a fast moving project developed by a dedicated team. We're excited to
21+
contribute to the community by releasing this code, but we want to manage
22+
expectations as well.
23+
24+
- We are a small company with a lot of product surface area.
25+
- We value a cohesive developer experience for folks building applications
26+
across all of our languages and platforms.
27+
- We value transparency in how we operate.
28+
29+
We're excited for community PRs. Be aware we may not get to it for a while.
30+
Smaller PRs that only affect documentation/comments are easier to review and
31+
integrate. For any larger or more fundamental changes, get in touch with us on
32+
Discord before you put in too much work to see if it's consistent with our short
33+
term plan. We think carefully about how our APIs contribute to a cohesive
34+
product, so chatting up front goes a long way.
35+
36+
# Development notes
37+
38+
You'll need a Rust toolchain installed (e.g. through https://rustup.rs/) to
39+
build this library when developing locally.
40+
41+
```sh
42+
# install dependencies
43+
poetry install --no-root
44+
45+
# build _convex
46+
# This is requred to run tests and to use from other local installations (like smoke tests)
47+
poetry run maturin dev
48+
49+
# run a test script
50+
poetry run python simple_example.py
51+
52+
# interactive shell
53+
poetry run python
54+
>>> from convex import ConvexClient
55+
>>> client = ConvexClint("https://flippant-cardinal-923.convex.cloud")
56+
>>> print(client.query("users:list"))
57+
58+
# The wrapped Rust client can also be run in an interactive shell
59+
>>> from _convex import PyConvexClient
60+
>>> client = PyConvexClient("https://flippant-cardinal-923.convex.cloud")
61+
>>> print(client.query("users:list"))
62+
63+
```
64+
65+
This package depends on the [convex](https://crates.io/crates/convex) package on
66+
crates.io. Updating behavior defined in that package requires publishing an
67+
update to that crate and updating the version required in this project.

‎Cargo.toml

Lines changed: 8 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -1,27 +1,30 @@
11
[package]
2-
name = "py_client"
2+
name = "_convex"
33
version = "0.1.0"
44
edition = "2021"
55

66
# See more keys and their definitions at https://doc.rust-lang.org/cargo/reference/manifest.html
77
[lib]
8-
name = "py_client"
8+
name = "_convex"
99
crate-type = ["cdylib"]
1010

1111
[dependencies]
12-
convex = { path = "../convex" }
12+
convex = { version = "=0.6.0" }
1313
futures = { workspace = true }
1414
parking_lot = { workspace = true }
15-
pyo3 = { workspace = true }
15+
pyo3 = { workspace = true, features = ["abi3", "abi3-py39"] }
1616
pyo3-asyncio = { workspace = true }
1717
tokio = { workspace = true, features = ["full"] }
1818
tracing = { workspace = true }
1919
tracing-subscriber = { workspace = true, features = ["env-filter"] }
2020

2121
[dev-dependencies]
22-
convex = { path = "../convex", features = ["testing"] }
22+
convex = { version = "=0.6.0", features = [ "testing" ] }
2323
tracing-subscriber = { workspace = true, features = ["env-filter"] }
2424

25+
[build-dependencies]
26+
pyo3-build-config = { version = "0.20.2", features = ["resolve-config"] }
27+
2528
[features]
2629
default = ["native-tls"]
2730
native-tls = ["convex/native-tls"]

‎LICENSE

Lines changed: 202 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,202 @@
1+
2+
Apache License
3+
Version 2.0, January 2004
4+
http://www.apache.org/licenses/
5+
6+
TERMS AND CONDITIONS FOR USE, REPRODUCTION, AND DISTRIBUTION
7+
8+
1. Definitions.
9+
10+
"License" shall mean the terms and conditions for use, reproduction,
11+
and distribution as defined by Sections 1 through 9 of this document.
12+
13+
"Licensor" shall mean the copyright owner or entity authorized by
14+
the copyright owner that is granting the License.
15+
16+
"Legal Entity" shall mean the union of the acting entity and all
17+
other entities that control, are controlled by, or are under common
18+
control with that entity. For the purposes of this definition,
19+
"control" means (i) the power, direct or indirect, to cause the
20+
direction or management of such entity, whether by contract or
21+
otherwise, or (ii) ownership of fifty percent (50%) or more of the
22+
outstanding shares, or (iii) beneficial ownership of such entity.
23+
24+
"You" (or "Your") shall mean an individual or Legal Entity
25+
exercising permissions granted by this License.
26+
27+
"Source" form shall mean the preferred form for making modifications,
28+
including but not limited to software source code, documentation
29+
source, and configuration files.
30+
31+
"Object" form shall mean any form resulting from mechanical
32+
transformation or translation of a Source form, including but
33+
not limited to compiled object code, generated documentation,
34+
and conversions to other media types.
35+
36+
"Work" shall mean the work of authorship, whether in Source or
37+
Object form, made available under the License, as indicated by a
38+
copyright notice that is included in or attached to the work
39+
(an example is provided in the Appendix below).
40+
41+
"Derivative Works" shall mean any work, whether in Source or Object
42+
form, that is based on (or derived from) the Work and for which the
43+
editorial revisions, annotations, elaborations, or other modifications
44+
represent, as a whole, an original work of authorship. For the purposes
45+
of this License, Derivative Works shall not include works that remain
46+
separable from, or merely link (or bind by name) to the interfaces of,
47+
the Work and Derivative Works thereof.
48+
49+
"Contribution" shall mean any work of authorship, including
50+
the original version of the Work and any modifications or additions
51+
to that Work or Derivative Works thereof, that is intentionally
52+
submitted to Licensor for inclusion in the Work by the copyright owner
53+
or by an individual or Legal Entity authorized to submit on behalf of
54+
the copyright owner. For the purposes of this definition, "submitted"
55+
means any form of electronic, verbal, or written communication sent
56+
to the Licensor or its representatives, including but not limited to
57+
communication on electronic mailing lists, source code control systems,
58+
and issue tracking systems that are managed by, or on behalf of, the
59+
Licensor for the purpose of discussing and improving the Work, but
60+
excluding communication that is conspicuously marked or otherwise
61+
designated in writing by the copyright owner as "Not a Contribution."
62+
63+
"Contributor" shall mean Licensor and any individual or Legal Entity
64+
on behalf of whom a Contribution has been received by Licensor and
65+
subsequently incorporated within the Work.
66+
67+
2. Grant of Copyright License. Subject to the terms and conditions of
68+
this License, each Contributor hereby grants to You a perpetual,
69+
worldwide, non-exclusive, no-charge, royalty-free, irrevocable
70+
copyright license to reproduce, prepare Derivative Works of,
71+
publicly display, publicly perform, sublicense, and distribute the
72+
Work and such Derivative Works in Source or Object form.
73+
74+
3. Grant of Patent License. Subject to the terms and conditions of
75+
this License, each Contributor hereby grants to You a perpetual,
76+
worldwide, non-exclusive, no-charge, royalty-free, irrevocable
77+
(except as stated in this section) patent license to make, have made,
78+
use, offer to sell, sell, import, and otherwise transfer the Work,
79+
where such license applies only to those patent claims licensable
80+
by such Contributor that are necessarily infringed by their
81+
Contribution(s) alone or by combination of their Contribution(s)
82+
with the Work to which such Contribution(s) was submitted. If You
83+
institute patent litigation against any entity (including a
84+
cross-claim or counterclaim in a lawsuit) alleging that the Work
85+
or a Contribution incorporated within the Work constitutes direct
86+
or contributory patent infringement, then any patent licenses
87+
granted to You under this License for that Work shall terminate
88+
as of the date such litigation is filed.
89+
90+
4. Redistribution. You may reproduce and distribute copies of the
91+
Work or Derivative Works thereof in any medium, with or without
92+
modifications, and in Source or Object form, provided that You
93+
meet the following conditions:
94+
95+
(a) You must give any other recipients of the Work or
96+
Derivative Works a copy of this License; and
97+
98+
(b) You must cause any modified files to carry prominent notices
99+
stating that You changed the files; and
100+
101+
(c) You must retain, in the Source form of any Derivative Works
102+
that You distribute, all copyright, patent, trademark, and
103+
attribution notices from the Source form of the Work,
104+
excluding those notices that do not pertain to any part of
105+
the Derivative Works; and
106+
107+
(d) If the Work includes a "NOTICE" text file as part of its
108+
distribution, then any Derivative Works that You distribute must
109+
include a readable copy of the attribution notices contained
110+
within such NOTICE file, excluding those notices that do not
111+
pertain to any part of the Derivative Works, in at least one
112+
of the following places: within a NOTICE text file distributed
113+
as part of the Derivative Works; within the Source form or
114+
documentation, if provided along with the Derivative Works; or,
115+
within a display generated by the Derivative Works, if and
116+
wherever such third-party notices normally appear. The contents
117+
of the NOTICE file are for informational purposes only and
118+
do not modify the License. You may add Your own attribution
119+
notices within Derivative Works that You distribute, alongside
120+
or as an addendum to the NOTICE text from the Work, provided
121+
that such additional attribution notices cannot be construed
122+
as modifying the License.
123+
124+
You may add Your own copyright statement to Your modifications and
125+
may provide additional or different license terms and conditions
126+
for use, reproduction, or distribution of Your modifications, or
127+
for any such Derivative Works as a whole, provided Your use,
128+
reproduction, and distribution of the Work otherwise complies with
129+
the conditions stated in this License.
130+
131+
5. Submission of Contributions. Unless You explicitly state otherwise,
132+
any Contribution intentionally submitted for inclusion in the Work
133+
by You to the Licensor shall be under the terms and conditions of
134+
this License, without any additional terms or conditions.
135+
Notwithstanding the above, nothing herein shall supersede or modify
136+
the terms of any separate license agreement you may have executed
137+
with Licensor regarding such Contributions.
138+
139+
6. Trademarks. This License does not grant permission to use the trade
140+
names, trademarks, service marks, or product names of the Licensor,
141+
except as required for reasonable and customary use in describing the
142+
origin of the Work and reproducing the content of the NOTICE file.
143+
144+
7. Disclaimer of Warranty. Unless required by applicable law or
145+
agreed to in writing, Licensor provides the Work (and each
146+
Contributor provides its Contributions) on an "AS IS" BASIS,
147+
WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or
148+
implied, including, without limitation, any warranties or conditions
149+
of TITLE, NON-INFRINGEMENT, MERCHANTABILITY, or FITNESS FOR A
150+
PARTICULAR PURPOSE. You are solely responsible for determining the
151+
appropriateness of using or redistributing the Work and assume any
152+
risks associated with Your exercise of permissions under this License.
153+
154+
8. Limitation of Liability. In no event and under no legal theory,
155+
whether in tort (including negligence), contract, or otherwise,
156+
unless required by applicable law (such as deliberate and grossly
157+
negligent acts) or agreed to in writing, shall any Contributor be
158+
liable to You for damages, including any direct, indirect, special,
159+
incidental, or consequential damages of any character arising as a
160+
result of this License or out of the use or inability to use the
161+
Work (including but not limited to damages for loss of goodwill,
162+
work stoppage, computer failure or malfunction, or any and all
163+
other commercial damages or losses), even if such Contributor
164+
has been advised of the possibility of such damages.
165+
166+
9. Accepting Warranty or Additional Liability. While redistributing
167+
the Work or Derivative Works thereof, You may choose to offer,
168+
and charge a fee for, acceptance of support, warranty, indemnity,
169+
or other liability obligations and/or rights consistent with this
170+
License. However, in accepting such obligations, You may act only
171+
on Your own behalf and on Your sole responsibility, not on behalf
172+
of any other Contributor, and only if You agree to indemnify,
173+
defend, and hold each Contributor harmless for any liability
174+
incurred by, or claims asserted against, such Contributor by reason
175+
of your accepting any such warranty or additional liability.
176+
177+
END OF TERMS AND CONDITIONS
178+
179+
APPENDIX: How to apply the Apache License to your work.
180+
181+
To apply the Apache License to your work, attach the following
182+
boilerplate notice, with the fields enclosed by brackets "[]"
183+
replaced with your own identifying information. (Don't include
184+
the brackets!) The text should be enclosed in the appropriate
185+
comment syntax for the file format. We also recommend that a
186+
file or class name and description of purpose be included on the
187+
same "printed page" as the copyright notice for easier
188+
identification within third-party archives.
189+
190+
Copyright 2023 Convex, Inc.
191+
192+
Licensed under the Apache License, Version 2.0 (the "License");
193+
you may not use this file except in compliance with the License.
194+
You may obtain a copy of the License at
195+
196+
http://www.apache.org/licenses/LICENSE-2.0
197+
198+
Unless required by applicable law or agreed to in writing, software
199+
distributed under the License is distributed on an "AS IS" BASIS,
200+
WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
201+
See the License for the specific language governing permissions and
202+
limitations under the License.

0 commit comments

Comments
 (0)