Debian Codegraph @

docs/api/python.md

raw
1 <!--
2 SPDX-FileCopyrightText: Peter Pentchev <[email protected]>
3 SPDX-License-Identifier: BSD-2-Clause
4 -->
5
6 # The feature-check Python API
7
8 ## Commonly-used functions
9
10 ::: feature_check.obtain_features
11
12 ::: feature_check.parse_expr
13
14 ::: feature_check.parser.parse_features_line
15
16 ::: feature_check.parse_version
17
18 ::: feature_check.version.version_compare
19
20 ## Commonly-used functions
21
22 ::: feature_check.obtain.obtain_features
23
24 ## Defaults
25
26 ::: feature_check.defs.DEFAULT_OPTION
27
28 ::: feature_check.defs.DEFAULT_PREFIX
29
30 ::: feature_check.defs.DEFAULT_OUTPUT_FMT
31
32 ## Version strings
33
34 ::: feature_check.version.Version
35
36 ::: feature_check.version.VersionComponent
37
38 ## Expressions
39
40 ::: feature_check.defs.Expr
41
42 ::: feature_check.expr.ExprFeature
43
44 ::: feature_check.expr.ExprVersion
45
46 ::: feature_check.expr.BoolOp
47
48 ::: feature_check.expr.ExprOp
49
50 ::: feature_check.defs.Result
51
52 ::: feature_check.expr.ResultBool
53
54 ::: feature_check.expr.ResultVersion
55
56 ## Errors
57
58 ::: feature_check.defs.FCError
59
60 ::: feature_check.obtain.ObtainError
61
62 ::: feature_check.obtain.ObtainExecError
63
64 ::: feature_check.obtain.ObtainNoFeaturesError
65
66 ::: feature_check.obtain.ObtainNoFeaturesSupportError
67
68 ::: feature_check.parser.ParseError
69
70 ## Main program operating modes
71
72 ::: feature_check.defs.Mode
73
74 ::: feature_check.defs.ModeList
75
76 ::: feature_check.defs.ModeSimple
77
78 ::: feature_check.defs.ModeSingle
79
80 ## Miscellaneous
81
82 ::: feature_check.defs.VERSION