]>
Commit | Line | Data |
---|---|---|
6abf9225 AG |
1 | This package provides a wrapper for libzfs_core C library. |
2 | ||
3 | libzfs_core is intended to be a stable interface for programmatic | |
4 | administration of ZFS. | |
5 | This wrapper provides one-to-one wrappers for libzfs_core API functions, | |
6 | but the signatures and types are more natural to Python. | |
7 | nvlists are wrapped as dictionaries or lists depending on their usage. | |
8 | Some parameters have default values depending on typical use for | |
9 | increased convenience. | |
10 | Enumerations and bit flags become strings and lists of strings in Python. | |
11 | Errors are reported as exceptions rather than integer errno-style | |
12 | error codes. The wrapper takes care to provide one-to-many mapping | |
13 | of the error codes to the exceptions by interpreting a context | |
14 | in which the error code is produced. | |
15 | ||
16 | Unit tests and automated test for the libzfs_core API are provided | |
17 | with this package. | |
18 | Please note that the API tests perform lots of ZFS dataset level | |
19 | operations and ZFS tries hard to ensure that any modifications | |
20 | do reach stable storage. That means that the operations are done | |
21 | synchronously and that, for example, disk caches are flushed. | |
22 | Thus, the tests can be very slow on real hardware. | |
23 | It is recommended to place the default temporary directory or | |
24 | a temporary directory specified by, for instance, TMP environment | |
25 | variable on a memory backed filesystem. | |
26 | ||
27 | Package documentation: http://pyzfs.readthedocs.org | |
28 | Package development: https://github.com/ClusterHQ/pyzfs |