nixpkgs/pkgs/development/python-modules/pydantic/default.nix
Martin Weinelt 52b9d9ad0e
python3Packages.pydantic Disable docs build for python<3.10
It fails, because the examples require python3.10 to be executed.

```
WARNING: examples for 3.10+ requires python 3.10. They won't be executed
Traceback (most recent call last):
  File "/build/source/docs/build/main.py", line 31, in <module>
    sys.exit(main())
  File "/build/source/docs/build/main.py", line 27, in main
    return exec_examples()
  File "/build/source/docs/build/exec_examples.py", line 354, in exec_examples
    versions.extend(populate_upgraded_versions(file, file_text, lowest_version))
  File "/build/source/docs/build/exec_examples.py", line 294, in populate_upgraded_versions
    new_file.write_text(upgraded_file_text)
  File "/nix/store/9pilxd2znfsj64ybyg8lmgql9vy3fq4g-python3-3.9.16/lib/python3.9/pathlib.py", line 1285, in write_text
    with self.open(mode='w', encoding=encoding, errors=errors) as f:
  File "/nix/store/9pilxd2znfsj64ybyg8lmgql9vy3fq4g-python3-3.9.16/lib/python3.9/pathlib.py", line 1252, in open
    return io.open(self, mode, buffering, encoding, errors, newline,
  File "/nix/store/9pilxd2znfsj64ybyg8lmgql9vy3fq4g-python3-3.9.16/lib/python3.9/pathlib.py", line 1120, in _opener
    return self._accessor.open(self, flags, mode)
FileNotFoundError: [Errno 2] No such file or directory: '/build/source/docs/.tmp_examples/upgraded/dataclasses_default_schema_3_9.py'
make: *** [Makefile:118: docs] Error 1
```
2023-01-15 11:20:19 +01:00

116 lines
2.3 KiB
Nix

{ lib
, stdenv
, buildPythonPackage
, autoflake
, cython
, devtools
, email-validator
, fetchFromGitHub
, pytest-mock
, pytestCheckHook
, python-dotenv
, pythonAtLeast
, pythonOlder
, pyupgrade
, typing-extensions
# dependencies for building documentation.
# docs fail to build in Darwin sandbox: https://github.com/samuelcolvin/pydantic/issues/4245
, withDocs ? (stdenv.hostPlatform == stdenv.buildPlatform && !stdenv.isDarwin && pythonAtLeast "3.10")
, ansi2html
, markdown-include
, mkdocs
, mkdocs-exclude
, mkdocs-material
, mdx-truly-sane-lists
, sqlalchemy
, ujson
, orjson
, hypothesis
}:
buildPythonPackage rec {
pname = "pydantic";
version = "1.10.4";
outputs = [
"out"
] ++ lib.optionals withDocs [
"doc"
];
disabled = pythonOlder "3.7";
src = fetchFromGitHub {
owner = "samuelcolvin";
repo = pname;
rev = "refs/tags/v${version}";
sha256 = "sha256-BFyv1uVq2pLcJeS5955G/pDA3ce9YTqZ6F7kAkwnuvY=";
};
postPatch = ''
sed -i '/flake8/ d' Makefile
'';
nativeBuildInputs = [
cython
] ++ lib.optionals withDocs [
# dependencies for building documentation
autoflake
ansi2html
markdown-include
mdx-truly-sane-lists
mkdocs
mkdocs-exclude
mkdocs-material
sqlalchemy
ujson
orjson
hypothesis
];
propagatedBuildInputs = [
devtools
email-validator
pyupgrade
python-dotenv
typing-extensions
];
checkInputs = [
pytest-mock
pytestCheckHook
];
pytestFlagsArray = [
# https://github.com/pydantic/pydantic/issues/4817
"-W" "ignore::pytest.PytestReturnNotNoneWarning"
];
preCheck = ''
export HOME=$(mktemp -d)
'';
# Must include current directory into PYTHONPATH, since documentation
# building process expects "import pydantic" to work.
preBuild = lib.optionalString withDocs ''
PYTHONPATH=$PWD:$PYTHONPATH make docs
'';
# Layout documentation in same way as "sphinxHook" does.
postInstall = lib.optionalString withDocs ''
mkdir -p $out/share/doc/$name
mv ./site $out/share/doc/$name/html
'';
enableParallelBuilding = true;
pythonImportsCheck = [ "pydantic" ];
meta = with lib; {
homepage = "https://github.com/samuelcolvin/pydantic";
description = "Data validation and settings management using Python type hinting";
license = licenses.mit;
maintainers = with maintainers; [ wd15 ];
};
}