summaryrefslogtreecommitdiff
path: root/pkgs/development/python-modules/deal/default.nix
blob: 6b09fba641e81500c3dc2f090f6322a7bea3d8cd (plain)
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
{
  lib,
  astroid,
  buildPythonPackage,
  deal-solver,
  docstring-parser,
  fetchFromGitHub,
  flit-core,
  hypothesis,
  marshmallow,
  pygments,
  pytest-cov-stub,
  pytestCheckHook,
  pythonAtLeast,
  sphinx,
  typeguard,
  urllib3,
  vaa,
}:

buildPythonPackage rec {
  pname = "deal";
  version = "4.24.6";
  pyproject = true;

  src = fetchFromGitHub {
    owner = "life4";
    repo = "deal";
    tag = version;
    hash = "sha256-nLZ06Xfa9Q+Saf8qPXG1Xo6y6oO6kifhfK/gryZ6q90=";
  };

  build-system = [ flit-core ];

  dependencies = [
    astroid
    deal-solver
    pygments
    typeguard
  ];

  nativeCheckInputs = [
    docstring-parser
    hypothesis
    marshmallow
    pytest-cov-stub
    pytestCheckHook
    sphinx
    urllib3
    vaa
  ];

  disabledTests = [
    # Tests need internet access
    "test_smoke_has"
    "test_pure_offline"
    "test_raises_doesnt_override_another_contract"
    "test_raises_doesnt_override_another_contract_async"
    "test_raises_generator"
    # AttributeError: module 'vaa' has no attribute 'Error'
    "test_source_vaa_scheme"
    "test_vaa_scheme_and_custom_exception"
    "test_scheme_string_validation_args_correct"
    "test_method_chain_decorator_with_scheme_is_fulfilled"
    "test_scheme_contract_is_satisfied_when_setting_arg"
    "test_scheme_contract_is_satisfied_within_chain"
    "test_scheme_errors_rewrite_message"
    # assert errors
    "test_doctest"
    "test_no_violations"
    "test_source_get_lambda_multiline_splitted_dec"
    # assert basically correct but fails in string match due to '' removed
    "test_unknown_command"
  ]
  ++ lib.optional (pythonAtLeast "3.13") [
    # assert basically correct but string match fails in due to
    # ('pathlib._local', 'Path.write_text') != ('pathlib', 'Path.write_text')
    "test_infer"
  ];

  disabledTestPaths = [
    # Test needs internet access
    "tests/test_runtime/test_offline.py"
    # depends on typeguard <4.0.0 for tests, but >=4.0.0 seems fine for runtime
    # https://github.com/life4/deal/blob/9be70fa1c5a0635880619b2cea83a9f6631eb236/pyproject.toml#L40
    "tests/test_testing.py"
  ];

  pythonImportsCheck = [ "deal" ];

  meta = {
    description = "Library for design by contract (DbC) and checking values, exceptions, and side-effects";
    longDescription = ''
      In a nutshell, deal empowers you to write bug-free code.
      By adding a few decorators to your code, you get for free tests, static analysis, formal verification,
      and much more.
    '';
    homepage = "https://github.com/life4/deal";
    changelog = "https://github.com/life4/deal/releases/tag/${version}";
    license = lib.licenses.mit;
    maintainers = with lib.maintainers; [ gador ];
  };
}