Document the RequiresPython fields (#4798)

This commit is contained in:
konsti 2024-07-04 14:27:02 +02:00 committed by GitHub
parent 576ba9c522
commit d178d97a40
No known key found for this signature in database
GPG key ID: B5690EEEBB952194

View file

@ -25,7 +25,14 @@ pub enum RequiresPythonError {
/// See: <https://packaging.python.org/en/latest/guides/dropping-older-python-versions/> /// See: <https://packaging.python.org/en/latest/guides/dropping-older-python-versions/>
#[derive(Debug, Clone, Eq, PartialEq, Hash)] #[derive(Debug, Clone, Eq, PartialEq, Hash)]
pub struct RequiresPython { pub struct RequiresPython {
/// The supported Python versions as provides by the user, usually through the `requires-python`
/// field in `pyproject.toml`.
///
/// For a workspace, it's the union of all `requires-python` fields in the workspace. If no
/// bound was provided by the user, it's greater equal the current Python version.
specifiers: VersionSpecifiers, specifiers: VersionSpecifiers,
/// The lower bound from the `specifiers` field, i.e. greater or greater equal the lowest
/// version allowed by `specifiers`.
bound: RequiresPythonBound, bound: RequiresPythonBound,
} }