-
Notifications
You must be signed in to change notification settings - Fork 1
Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
This commit relaxes our dependency constraints by removing the lockfiles and replacing them by broad ranges for our supported dependency versions. To test that the SDK works with each version, the test matrix was adapted to run each test for each `(python_version,resolution_strategy)` tuple, where `resolution_strategy` is how UV will choose each dependency. - By using `resolution_strategy=lowest`, we will test the lowest version of our dependencies. - By using `resolution_strategy=lowest-direct`, we will test the lowest version of our direct dependencies, and the highest version of transitive dependencies. - By using `resolution_strategy=highest`, we will test the highest version of all dependencies. Due to some transitive dependencies not working in certain Python versions, a new `constraints/` directory was created, which contains `.txt` files that specify our dependency ranges for transitive dependencies. These constraints files are not shipped with the library and are used only for testing. Users are expected to define their transitive constraints themselves depending on the Python version.
- Loading branch information
1 parent
5e52e1c
commit 13f7682
Showing
23 changed files
with
119 additions
and
296 deletions.
There are no files selected for viewing
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
|
@@ -28,10 +28,12 @@ Hatch will manage your environments for you. Check out the list of available env | |
|
||
For most use cases, you probably want to use the `dev` environment by running `hatch shell dev`. | ||
|
||
If you're having problems with your environment, check out the [troubleshooting](#troubleshooting) section. | ||
|
||
|
||
### Upgrading dependencies | ||
|
||
We use locked `requirements.txt` files for dependency management. If you want to upgrade, remove or add a dependency, change the `deps/*.in` files and run `hatch run lock`. Don't edit `.txt` files manually, since those are autogenerated by [uv](https://github.com/astral-sh/uv/). | ||
We use `requirements.txt` files for dependency management. If you want to upgrade, remove or add a dependency, change the `deps/*.txt` files. | ||
|
||
|
||
### Making code changes | ||
|
@@ -43,9 +45,9 @@ We use [changie](https://changie.dev/) to manage our [`CHANGELOG.md`](./CHANGELO | |
|
||
### Running tests | ||
|
||
Run tests by using `hatch run test:all`. This will run all our tests in all supported Python versions. Make sure they pass before you submit a PR. | ||
Run tests by using `hatch run test:all`. This will run all our tests in all supported Python versions and with a variety of dependency versions. Make sure they pass before you submit a PR. | ||
|
||
If you want to run unit test separately, run `hatch run test:unit`. For integration tests, run `hatch run test.py3.12:integration` to avoid running slow tests in all python versions. | ||
If you want to run unit test separately, run `hatch run test:unit`. For integration tests, run `hatch run test.py3.12-highest:integration` to avoid running slow tests in all python versions. | ||
|
||
The unit test suite requires a `tests/server_schema.gql` file to exist, since it checks that all GraphQL queries from the SDK will work against the server. That file must contain the schema of the GraphQL API, and you can obtain it by running our introspection script with `hatch run dev:fetch-schema`. | ||
|
||
|
@@ -63,3 +65,17 @@ We don't require every commit to be perfect, but your pull-request as a whole mu | |
|
||
If you think you've found a security vulnerability (i.e something that could leak customer data, compromise API keys, gain access to unauthorized resources), **do not open an issue in GitHub**. In that case, contact us directly at `[email protected]`, and wait until the vulnerability has been patched before publicly disclosing it. | ||
|
||
|
||
## Troubleshooting | ||
|
||
Here's a non-exhaustive list of problems that might occur during development. | ||
|
||
### `clang: error: the clang compiler does not support 'faltivec', please use -maltivec and include altivec.h explicitly` | ||
|
||
For compatibility issues, we support older versions of libraries such as PyArrow. However, those older versions might not compile properly in MacOS with the error above. This issue might arise especially when running tests in the environment with older versions. | ||
|
||
To solve it, you need to install [OpenBLAS](https://www.openblas.net/) and tell the compiler where it is: | ||
``` | ||
brew install openblas | ||
export OPENBLAS=$(brew --prefix openblas) | ||
``` |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,7 @@ | ||
# Dependency constraints and overrides | ||
|
||
All files in this directory specify transitive dependency constraints for usage in our test environments. The files in this directory are _not_ shipped with the package, and users should specify those constraints themselves, according to what works in their own system. Learn more about pip constraints [here](https://pip.pypa.io/en/stable/user_guide/#constraints-files). | ||
|
||
This is useful for specifying different minimum versions of a package for Python 3.12 and 3.9, since older versions might not support the newest Python and vice-versa. | ||
|
||
For direct dependencies, we solve this by using the `python_version` [environment marker](https://peps.python.org/pep-0508/#environment-markers) in our dependencies. |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,3 @@ | ||
cython>=3.0.11 | ||
setuptools>=72.1.0 | ||
wheel>=0.43.0 |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,6 @@ | ||
numpy>=1.26.0 | ||
requests>=2.32.0 | ||
urllib3>=1.26.8 | ||
yarl>=1.9.3 | ||
frozenlist>=1.4.0 | ||
aiohttp>=3.9.0 |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1 @@ | ||
pyarrow>=0.14.0 |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,3 @@ | ||
numpy>=1.21.3,<2.0.0 | ||
requests>=2.27.0 | ||
urllib3>=1.26.0 |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,6 @@ | ||
numpy>=1.24.0,<2.0.0 | ||
requests>=2.28.0 | ||
urllib3>=1.26.8 | ||
yarl>=1.8.2 | ||
frozenlist>=1.3.1 | ||
aiohttp>=3.8.2 |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,6 @@ | ||
numpy>=1.26.0,<2.0.0 | ||
requests>=2.32.0 | ||
urllib3>=1.26.8 | ||
yarl>=1.9.3 | ||
frozenlist>=1.4.0 | ||
aiohttp>=3.9.0 |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1 @@ | ||
numpy>=1.21.0,<2.0.0 |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file was deleted.
Oops, something went wrong.
This file was deleted.
Oops, something went wrong.
This file was deleted.
Oops, something went wrong.
This file was deleted.
Oops, something went wrong.
This file was deleted.
Oops, something went wrong.
This file was deleted.
Oops, something went wrong.
This file was deleted.
Oops, something went wrong.
This file was deleted.
Oops, something went wrong.
This file was deleted.
Oops, something went wrong.
This file was deleted.
Oops, something went wrong.
Oops, something went wrong.