Migrate to pyproject.toml and modernize a little bit the CI #540
Conversation
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 way we can also test: * if the package can be built * if the package built can be installed * if the package imports are correct
The generated packages are equivalent except some minor changes in the METADATA file: * The "Home-Page" directive is not supported in pyproject.toml for setuptools, the equivalent now is the "homepage" value in the "urls" section. See pypa/setuptools#3318 * The "Author" directive it's not an array of strings but two strings separated by comma, hope it's equivalent to an array.
Python 3.6 doesn't support building packages using pyproject.toml, given that Python 3.6 reached EOL in 2021-12-23 I think it's safe to drop it.
Function based tests have various advantages over class based tests, mainly prevent coupling between tests and reduce indentation level. Also we can stop using `TestCase` and their `self.assertX` and use instead `assert` and have pytest assert rewrite output, which is much more helpful.
This way the CI pipeline will not be marked as error when some tests fails with this error message. While this introduces the risk that a failing test may pass with a 429 error, the probability is low and with some luck this will not be here for long.
emlazzarin
reviewed
Oct 28, 2022
pyproject.toml
Outdated
Comment on lines
20
to
23
| "Programming Language :: Python :: 3.3", | ||
| "Programming Language :: Python :: 3.4", | ||
| "Programming Language :: Python :: 3.5", | ||
| "Programming Language :: Python :: 3.6", |
There was a problem hiding this comment.
I'm okay with removing these.
There was a problem hiding this comment.
Oops, an oversight, I'll update them.
There was a problem hiding this comment.
I fixed more things in the pyproject.toml:
- updated the license classifier to match with the
LICENSEfile. - updated the version to match the latest release at pypi (4.8.0).
|
Personally I prefer smaller releases but I'll adapt to your decisions. However before doing release, please consider doing version tagging (starting with tagging the current v4.8.0) and doing releases; if you want we can start using a My next step is writing unit tests that cover the whole library functionality and doesn't call to the backend at every CI execution. |
The Python versions was very obsolete, and the license classifier wasn't in sync with the real license described in the `LICENSE` file.
In pypi the latest version is 4.8.0.
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
This PR arises from a discussion at #503.
Changes summary:
requirements-dev.txtfile with the requirements needed for development.TooManyRequestsErrorand mark all the tests as xfail to prevent the CI failing when Google decides we're not worthy.@emlazzarin This is the first big step before starting to create a more robust unit test suite that doesn't call always the backend API in every test execution.
The plan was just migrate to pyproject.toml but I got a bit carried away :)
Comments are more than welcome.
Edit: Oh I forgot to add something important, there are some differences in the
METADATAfile generated:dreyco676to any on the two authors?