summaryrefslogtreecommitdiff
path: root/python
diff options
context:
space:
mode:
Diffstat (limited to 'python')
-rw-r--r--python/acquire-item.cc39
-rw-r--r--python/acquire.cc50
-rw-r--r--python/apt_instmodule.cc2
-rw-r--r--python/apt_pkgmodule.cc52
-rw-r--r--python/arfile.cc28
-rw-r--r--python/cache.cc71
-rw-r--r--python/cdrom.cc9
-rw-r--r--python/configuration.cc41
-rw-r--r--python/depcache.cc32
-rw-r--r--python/hashes.cc5
-rw-r--r--python/indexrecords.cc6
-rw-r--r--python/lock.cc8
-rw-r--r--python/metaindex.cc5
-rw-r--r--python/pkgmanager.cc4
-rw-r--r--python/pkgsrcrecords.cc6
-rw-r--r--python/policy.cc6
-rw-r--r--python/tag.cc23
-rw-r--r--python/tarfile.cc10
18 files changed, 223 insertions, 174 deletions
diff --git a/python/acquire-item.cc b/python/acquire-item.cc
index d8185ff1..4b7dc34d 100644
--- a/python/acquire-item.cc
+++ b/python/acquire-item.cc
@@ -130,24 +130,28 @@ static PyGetSetDef acquireitem_getset[] = {
{"desc_uri",acquireitem_get_desc_uri,NULL,
"A string describing the URI from which the item is acquired."},
{"destfile",acquireitem_get_destfile,NULL,
- "The path to the file where the item will be stored"},
+ "The path to the file where the item will be stored."},
{"error_text",acquireitem_get_error_text,NULL,
"If an error occured, a string describing the error; empty string\n"
- "otherwise"},
+ "otherwise."},
{"filesize",acquireitem_get_filesize,NULL,
- "The size of the file. If unknown, it is set to 0."},
+ "The size of the file (number of bytes). If unknown, it is set to 0."},
{"id",acquireitem_get_id,acquireitem_set_id,
"The ID of the item. An integer which can be set by progress classes."},
{"mode",acquireitem_get_mode,NULL,
- "A string indicating the current mode e.g. 'Fetching'."},
+ "A localized string such as 'Fetching' which indicates the current\n"
+ "mode."},
{"is_trusted",acquireitem_get_is_trusted,NULL,
- "Whether the item is trusted or not."},
+ "Whether the item is trusted or not. Only True for packages\n"
+ "which come from a repository signed with one of the keys in\n"
+ "APT's keyring."},
{"local",acquireitem_get_local,NULL,
"Whether we are fetching a local item (copy:/) or not."},
{"partialsize",acquireitem_get_partialsize,NULL,
- "The amount of data which has already been fetched."},
+ "The amount of data which has already been fetched (number of bytes)."},
{"status",acquireitem_get_status,NULL,
- "The status of the item."},
+ "An integer representing the item's status which can be compared\n"
+ "against one of the STAT_* constants defined in this class."},
{}
};
@@ -172,9 +176,11 @@ static void acquireitem_dealloc(PyObject *self)
}
static const char *acquireitem_doc =
- "Representation of an Acquire item. It is not possible to create\n"
- "instances of this class, but it is possible to create instances\n"
- "of the AcquireFile subclass.";
+ "Represent a single item to be fetched by an Acquire object.\n\n"
+ "It is not possible to construct instances of this class directly.\n"
+ "Prospective users should construct instances of a subclass such as\n"
+ "AcquireFile instead. It is not possible to create subclasses on the\n"
+ "Python level, only on the C++ level.";
PyTypeObject PyAcquireItem_Type = {
PyVarObject_HEAD_INIT(&PyType_Type, 0)
"apt_pkg.AcquireItem", // tp_name
@@ -246,13 +252,18 @@ static char *acquirefile_doc =
"destfile])\n\n"
"Represent a file to be fetched. The parameter 'owner' points to\n"
"an apt_pkg.Acquire object and the parameter 'uri' to the source\n"
- "location. The destination can be specified by either 'destdir'\n"
- "for specifying the destination directory or 'destfile' for\n"
- "specifying the path to the destination file.\n"
+ "location. Normally, the file will be stored in the current directory\n"
+ "using the file name given in the URI. This directory can be changed\n"
+ "by passing the name of a directory to the 'destdir' parameter. It is\n"
+ "also possible to set a path to a file using the 'destfile' parameter,\n"
+ "but both cannot be specified together.\n"
"\n"
"The parameters 'short_descr' and 'descr' can be used to specify\n"
"a short description and a longer description for the item. This\n"
- "information is used by progress classes to refer to the item.\n"
+ "information is used by progress classes to refer to the item and\n"
+ "should be short, for example, package name as 'short_descr' and\n"
+ "and something like 'http://localhost sid/main python-apt 0.7.94.2'\n"
+ "as 'descr'."
"\n"
"The parameters 'md5' and 'size' are used to verify the resulting\n"
"file. The parameter 'size' is also to calculate the total amount\n"
diff --git a/python/acquire.cc b/python/acquire.cc
index 27e592bc..6f9a1412 100644
--- a/python/acquire.cc
+++ b/python/acquire.cc
@@ -66,23 +66,24 @@ static PyObject *acquireworker_get_resumepoint(PyObject *self, void *closure)
static PyGetSetDef acquireworker_getset[] = {
{"current_item",acquireworker_get_current_item,0,
- "The item currently fetched, as an apt_pkg.AcquireItemDesc object."},
+ "The item currently being fetched, as an apt_pkg.AcquireItemDesc object."},
{"status",acquireworker_get_status,0,
"The status of the worker, as a string."},
{"current_size",acquireworker_get_current_size,0,
- "The amount of data fetched for the item."},
+ "The amount of data fetched so far for the current item."},
{"total_size",acquireworker_get_total_size,0,
"The total size of the item."},
{"resumepoint",acquireworker_get_resumepoint,0,
- "The amount of data which was already fetched prior to resuming the\n"
- "download."},
+ "The amount of data which was already available when the download was\n"
+ "started."},
{NULL}
};
static const char *acquireworker_doc =
- "Acquire workers represent exactly one subprocess used for fetching\n"
- "files. This subprocess is created from the methods stored in\n"
- "Dir::Bin::Methods.\n\n";
+ "Represent a sub-process responsible for fetching files from\n"
+ "remote locations. This sub-process uses 'methods' located in\n"
+ "the directory specified by the configuration option\n"
+ "Dir::Bin::Methods.";
PyTypeObject PyAcquireWorker_Type = {
PyVarObject_HEAD_INIT(&PyType_Type, 0)
"apt_pkg.AcquireWorker", // tp_name
@@ -157,7 +158,7 @@ static PyObject *acquireitemdesc_get_owner(CppPyObject<pkgAcquire::ItemDesc*> *s
static PyGetSetDef acquireitemdesc_getset[] = {
{"uri",acquireitemdesc_get_uri,0,
- "The URI from which to download this item."},
+ "The URI from which this item would be downloaded."},
{"description",acquireitemdesc_get_description,0,
"A string describing the item."},
{"shortdesc",acquireitemdesc_get_shortdesc,0,
@@ -168,9 +169,9 @@ static PyGetSetDef acquireitemdesc_getset[] = {
};
static char *acquireitemdesc_doc =
- "Describe an AcquireItem. This class provides the description of the\n"
- "item and the uri the item is fetched from. It is used in progress\n"
- "classes to get the descriptions to display.";
+ "Provide the description of an item and the URI the item is\n"
+ "fetched from. Progress classes make use of such objects to\n"
+ "retrieve description and other information about an item.";
PyTypeObject PyAcquireItemDesc_Type = {
PyVarObject_HEAD_INIT(&PyType_Type, 0)
"apt_pkg.AcquireItemDesc", // tp_name
@@ -243,10 +244,15 @@ static PyObject *PkgAcquireShutdown(PyObject *Self,PyObject *Args)
static PyMethodDef PkgAcquireMethods[] = {
{"run",PkgAcquireRun,METH_VARARGS,
"run() -> int\n\nRun the fetcher and return one of RESULT_CANCELLED,\n"
- "RESULT_CONTINUE, RESULT_FAILED."},
+ "RESULT_CONTINUE, RESULT_FAILED. RESULT_CONTINUE means that all items\n"
+ "which where queued prior to calling run() have been fetched\n"
+ "successfully. RESULT_CANCELLED means that the process was canceled\n"
+ "by the progress class. And RESULT_FAILED means a generic failure."},
{"shutdown",PkgAcquireShutdown, METH_VARARGS,
"shutdown()\n\n"
- "Shut the fetcher down, removing all items from it."},
+ "Shut the fetcher down, removing all items from it. Future access to\n"
+ "queued AcquireItem objects will cause a segfault. The partial result\n"
+ "is kept on the disk and not removed and APT might reuse it."},
{}
};
@@ -294,16 +300,17 @@ static PyObject *PkgAcquireGetItems(PyObject *Self,void*)
static PyGetSetDef PkgAcquireGetSet[] = {
{"fetch_needed",PkgAcquireGetFetchNeeded,0,
- "The total amount of data to be fetched."},
+ "The total amount of data to be fetched (number of bytes)."},
{"items",PkgAcquireGetItems,0,
- "A list of all items as apt_pkg.AcquireItem objects."},
+ "A list of all items as apt_pkg.AcquireItem objects, including already\n"
+ "fetched ones and to be fetched ones."},
{"workers",PkgAcquireGetWorkers,0,
"A list of all active workers as apt_pkg.AcquireWorker objects."},
{"partial_present",PkgAcquireGetPartialPresent,0,
- "The amount of data which is already available."},
+ "The amount of data which is already available (number of bytes)."},
{"total_needed",PkgAcquireGetTotalNeeded,0,
"The amount of data that needs to fetched plus the amount of data\n"
- "which has already been fetched."},
+ "which has already been fetched (number of bytes)."},
{}
};
@@ -345,10 +352,11 @@ PyObject *PyAcquire_FromCpp(pkgAcquire *fetcher, bool Delete, PyObject *owner) {
}
static char *doc_PkgAcquire =
- "Acquire(progress: apt_pkg.AcquireProgress) -> Acquire()\n\n"
- "Create a new Acquire object. The parameter 'progress' can be used to\n"
- "specify an apt_pkg.AcquireProgress() object, which will display the\n"
- "progress of the fetching.";
+ "Acquire([progress: apt.progress.base.AcquireProgress])\n\n"
+ "Coordinate the retrieval of files via network or local file system\n"
+ "(using 'copy:/path/to/file' style URIs). The optional argument\n"
+ "'progress' takes an apt.progress.base.AcquireProgress object\n"
+ "which may report progress information.";
PyTypeObject PyAcquire_Type = {
PyVarObject_HEAD_INIT(&PyType_Type, 0)
diff --git a/python/apt_instmodule.cc b/python/apt_instmodule.cc
index b1038474..732f1bd0 100644
--- a/python/apt_instmodule.cc
+++ b/python/apt_instmodule.cc
@@ -168,7 +168,7 @@ static PyMethodDef *methods = 0;
static const char *apt_inst_doc =
- "Functions for working with AR,tar archives and .deb packages.\n\n"
+ "Functions for working with ar/tar archives and .deb packages.\n\n"
"This module provides useful classes and functions to work with\n"
"archives, modelled after the 'TarFile' class in the 'tarfile' module.";
#define ADDTYPE(mod,name,type) { \
diff --git a/python/apt_pkgmodule.cc b/python/apt_pkgmodule.cc
index e7023e4a..a1e9ada0 100644
--- a/python/apt_pkgmodule.cc
+++ b/python/apt_pkgmodule.cc
@@ -91,8 +91,8 @@ static char *doc_CheckDep =
"Check that the given requirement is fulfilled; i.e. that the version\n"
"string given by 'pkg_ver' matches the version string 'dep_ver' under\n"
"the condition specified by the operator 'dep_op' (<,<=,=,>=,>).\n\n"
- "This functions returns True if 'pkg_ver' matches 'dep_ver' under the\n"
- "condition 'dep_op'; e.g. this returns True:\n\n"
+ "Return True if 'pkg_ver' matches 'dep_ver' under the\n"
+ "condition 'dep_op'; for example, this returns True:\n\n"
" apt_pkg.check_dep('1', '<=', '2')";
static PyObject *CheckDep(PyObject *Self,PyObject *Args)
{
@@ -163,19 +163,21 @@ static const char *doc_ParseDepends =
"parse_depends(s: str) -> list\n"
"\n"
"Parse the dependencies given by 's' and return a list of lists. Each of\n"
-"these lists represents one or more options for an or-dependency in the form\n"
-"of tuples ``(pkg, ver, comptype)``. In this tuple, the element 'pkg' is the\n"
-"name of the package, the element 'ver' the version [or '' if no version was\n"
-"requested. The element 'ver' is a comparison operator such as <,<=,=,>=,>.";
+"these lists represents one or more options for an 'or' dependency in\n"
+"the form of '(pkg, ver, comptype)' tuples. The tuple element 'pkg'\n"
+"is the name of the package; the element 'ver' is the version, or ''\n"
+"if no version was requested. The element 'ver' is a comparison\n"
+"operator ('<', '<=', '=', '>=', or '>').";
static const char *parse_src_depends_doc =
"parse_src_depends(s: str) -> list\n"
"\n"
"Parse the dependencies given by 's' and return a list of lists. Each of\n"
-"these lists represents one or more options for an or-dependency in the form\n"
-"of tuples ``(pkg, ver, comptype)``. In this tuple, the element 'pkg' is the\n"
-"name of the package, the element 'ver' the version [or '' if no version was\n"
-"requested. The element 'ver' is a comparison operator such as <,<=,=,>=,>."
+"these lists represents one or more options for an 'or' dependency in\n"
+"the form of '(pkg, ver, comptype)' tuples. The tuple element 'pkg'\n"
+"is the name of the package; the element 'ver' is the version, or ''\n"
+"if no version was requested. The element 'ver' is a comparison\n"
+"operator ('<', '<=', '=', '>=', or '>')."
"\n\n"
"Dependencies may be restricted to certain architectures and the result\n"
"only contains those dependencies for the architecture set in the\n"
@@ -392,7 +394,7 @@ static PyObject *sha256sum(PyObject *Self,PyObject *Args)
// ---------------------------------------------------------------------
static char *doc_Init =
"init()\n\n"
-"Short hand for doing init_config() and init_system(). When working\n"
+"Shorthand for doing init_config() and init_system(). When working\n"
"with command line arguments, first call init_config() then parse\n"
"the command line and finally call init_system().";
static PyObject *Init(PyObject *Self,PyObject *Args)
@@ -423,7 +425,7 @@ static PyObject *InitConfig(PyObject *Self,PyObject *Args)
static char *doc_InitSystem =
"init_system()\n\n"
-"Construct the underlying system.";
+"Construct the apt_pkg system.";
static PyObject *InitSystem(PyObject *Self,PyObject *Args)
{
if (PyArg_ParseTuple(Args,"") == 0)
@@ -503,8 +505,8 @@ static PyMethodDef methods[] =
// Internationalization.
{"gettext",py_gettext,METH_VARARGS,
"gettext(msg: str[, domain: str = 'python-apt']) -> str\n\n"
- "Translate the given string. Much Faster than Python's version and only\n"
- "does translations after setlocale() has been called."},
+ "Translate the given string. This is much faster than Python's version\n"
+ "and only does translations after setlocale() has been called."},
// Tag File
{"rewrite_section",RewriteSection,METH_VARARGS,doc_RewriteSection},
@@ -544,13 +546,13 @@ static PyMethodDef methods[] =
"which would return True because alioth belongs to debian.org."},
{"quote_string",StrQuoteString,METH_VARARGS,
"quote_string(string: str, repl: str) -> str\n\n"
- "Quote the string 'string' by encoding a standard set of characters\n"
- "plus the characters given 'repl' using their HTTP value, e.g.\n"
- "'%20' for ' '."},
+ "Escape the string 'string', replacing any character not allowed in a URL"
+ "or specified by 'repl' with its ASCII value preceded by a percent sign"
+ "(so for example ' ' becomes '%20')."},
{"dequote_string",StrDeQuote,METH_VARARGS,
"dequote_string(string: str) -> str\n\n"
"Dequote the given string by replacing all HTTP encoded values such\n"
- "as '%20' with their decoded value (e.g. ' ')."},
+ "as '%20' with their decoded value (in this case, ' ')."},
{"size_to_str",StrSizeToStr,METH_VARARGS,
"size_to_str(bytes: int) -> str\n\n"
"Return a string describing the size in a human-readable manner using\n"
@@ -565,12 +567,12 @@ static PyMethodDef methods[] =
"parts not suited for filenames (e.g. '/')."},
{"base64_encode",StrBase64Encode,METH_VARARGS,
"base64_encode(value: bytes) -> str\n\n"
- "Encode the given bytestring using the Base64. The input may not\n"
- "contain '\0' (use the base64 module for this)."},
+ "Encode the given bytestring into Base64. The input may not\n"
+ "contain a null byte character (use the base64 module for this)."},
{"string_to_bool",StrStringToBool,METH_VARARGS,
"string_to_bool(string: str) -> int\n\n"
"Return 1 if the string is a value such as 'yes', 'true', '1';\n"
- "0 if the string is a value such as 'no', 'false','0'; -1 if\n"
+ "0 if the string is a value such as 'no', 'false', '0'; -1 if\n"
"the string is not recognized."},
{"time_rfc1123",StrTimeRFC1123,METH_VARARGS,
"time_rfc1123(unixtime: int) -> str\n\n"
@@ -578,7 +580,7 @@ static PyMethodDef methods[] =
"RFC 1123."},
{"str_to_time",StrStrToTime,METH_VARARGS,
"str_to_time(rfc_time: str) -> int\n\n"
- "Convert the given RFC 1123 formatted string to an Unix timestamp."},
+ "Convert the given RFC 1123 formatted string to a Unix timestamp."},
// DEPRECATED
#ifdef COMPAT_0_7
@@ -740,9 +742,9 @@ static struct _PyAptPkgAPIStruct API = {
static const char *apt_pkg_doc =
"Classes and functions wrapping the apt-pkg library.\n\n"
"The apt_pkg module provides several classes and functions for accessing\n"
- "the functionality provided by the apt-pkg library. It allows parsing of\n"
- "index files, configuration files, installation/removal of packages and\n"
- "much more";
+ "the functionality provided by the apt-pkg library. Typical uses might\n"
+ "include reading APT index files and configuration files and installing\n"
+ "or removing packages.";
#if PY_MAJOR_VERSION >= 3
static struct PyModuleDef moduledef = {
diff --git a/python/arfile.cc b/python/arfile.cc
index 7ebf51f9..a279807d 100644
--- a/python/arfile.cc
+++ b/python/arfile.cc
@@ -82,12 +82,12 @@ static PyGetSetDef armember_getset[] = {
{"size",armember_get_size,0,"The size of the files."},
{"start",armember_get_start,0,
"The offset in the archive where the file starts."},
- {"uid",armember_get_uid,0,"The user id of the owner."},
+ {"uid",armember_get_uid,0,"The user ID of the owner."},
{NULL}
};
static const char *armember_doc =
- "An ArMember object represents a single file within an AR archive. For\n"
+ "Represent a single file within an AR archive. For\n"
"Debian packages this can be e.g. control.tar.gz. This class provides\n"
"information about this file, such as the mode and size.";
PyTypeObject PyArMember_Type = {
@@ -141,7 +141,7 @@ struct PyArArchiveObject : public CppPyObject<PyARArchiveHack*> {
static const char *ararchive_getmember_doc =
"getmember(name: str) -> ArMember\n\n"
- "Return a ArMember object for the member given by name. Raise\n"
+ "Return an ArMember object for the member given by 'name'. Raise\n"
"LookupError if there is no ArMember with the given name.";
static PyObject *ararchive_getmember(PyArArchiveObject *self, PyObject *arg)
{
@@ -239,7 +239,7 @@ static PyObject *_extract(FileFd &Fd, const ARArchive::Member *member,
static const char *ararchive_extract_doc =
"extract(name: str[, target: str]) -> bool\n\n"
"Extract the member given by 'name' into the directory given\n"
- "by 'target'. If the extraction failed, raise OSError. In case\n"
+ "by 'target'. If the extraction fails, raise OSError. In case\n"
"of success, return True if the file owner could be set or\n"
"False if this was not possible. If the requested member\n"
"does not exist, raise LookupError.";
@@ -261,9 +261,9 @@ static PyObject *ararchive_extract(PyArArchiveObject *self, PyObject *args)
static const char *ararchive_extractall_doc =
"extractall([target: str]) -> bool\n\n"
- "Extract all into the directory given by 'target'. If the extraction\n"
- "failed, raise an error. Otherwise, return True if the owner could\n"
- "be set or False if the owner could not be changed.";
+ "Extract all archive contents into the directory given by 'target'. If\n"
+ "the extraction fails, raise an error. Otherwise, return True if the\n"
+ "owner could be set or False if the owner could not be changed.";
static PyObject *ararchive_extractall(PyArArchiveObject *self, PyObject *args)
{
@@ -310,7 +310,7 @@ static PyObject *ararchive_gettar(PyArArchiveObject *self, PyObject *args)
static const char *ararchive_getmembers_doc =
"getmembers() -> list\n\n"
- "Return a list of all members in the AR archive.";
+ "Return a list of all members in the archive.";
static PyObject *ararchive_getmembers(PyArArchiveObject *self)
{
PyObject *list = PyList_New(0);
@@ -328,7 +328,7 @@ static PyObject *ararchive_getmembers(PyArArchiveObject *self)
static const char *ararchive_getnames_doc =
"getnames() -> list\n\n"
- "Return a list of the names of all members in the AR archive.";
+ "Return a list of the names of all members in the archive.";
static PyObject *ararchive_getnames(PyArArchiveObject *self)
{
PyObject *list = PyList_New(0);
@@ -423,12 +423,12 @@ static PyMappingMethods ararchive_as_mapping = {
static const char *ararchive_doc =
"ArArchive(file: str/int/file)\n\n"
- "An ArArchive object represents an archive in the 4.4 BSD AR format, \n"
+ "Represent an archive in the 4.4 BSD ar format,\n"
"which is used for e.g. deb packages.\n\n"
"The parameter 'file' may be a string specifying the path of a file, or\n"
"a file-like object providing the fileno() method. It may also be an int\n"
"specifying a file descriptor (returned by e.g. os.open()).\n"
- "The recommended way is to pass in the path to the file.";
+ "The recommended way of using it is to pass in the path to the file.";
PyTypeObject PyArArchive_Type = {
PyVarObject_HEAD_INIT(&PyType_Type, 0)
@@ -598,10 +598,10 @@ static const char *debfile_doc =
"The parameter 'file' may be a string specifying the path of a file, or\n"
"a file-like object providing the fileno() method. It may also be an int\n"
"specifying a file descriptor (returned by e.g. os.open()).\n"
- "The recommended way is to pass in the path to the file.\n\n"
+ "The recommended way of using it is to pass in the path to the file.\n\n"
"It differs from ArArchive by providing the members 'control', 'data'\n"
- "and 'version' for accessing the control.tar.gz,data.tar.{gz,bz2,lzma}\n"
- ",debian-binary members in the archive.";
+ "and 'version' for accessing the control.tar.gz, data.tar.{gz,bz2,lzma},\n"
+ "and debian-binary members in the archive.";
PyTypeObject PyDebFile_Type = {
PyVarObject_HEAD_INIT(&PyType_Type, 0)
diff --git a/python/cache.cc b/python/cache.cc
index 4d7c347a..e31f6a65 100644
--- a/python/cache.cc
+++ b/python/cache.cc
@@ -85,6 +85,20 @@ static PyObject *CreateProvides(PyObject *Owner,pkgCache::PrvIterator I)
// Cache Class /*{{{*/
// ---------------------------------------------------------------------
+
+static const char *cache_update_doc =
+ "update(progress, sources: SourceList, pulse_interval: int) -> bool\n\n"
+ "Update the index files used by the cache. A call to this method\n"
+ "does not affect the current Cache object; instead, a new one\n"
+ "should be created in order to use the changed index files.\n\n"
+ "The parameter 'progress' can be used to specify an\n"
+ "apt.progress.base.AcquireProgress() object , which will report\n"
+ "progress information while the index files are being fetched.\n"
+ "The parameter 'sources', if provided, is an apt_pkg.SourcesList\n"
+ "object listing the remote repositories to be used.\n"
+ "The 'pulse_interval' parameter indicates how long (in microseconds)\n"
+ "to wait between calls to the pulse() method of the 'progress' object.\n"
+ "The default is 500000 microseconds.";
static PyObject *PkgCacheUpdate(PyObject *Self,PyObject *Args)
{
PyObject *pyFetchProgressInst = 0;
@@ -152,18 +166,7 @@ static PyObject *PkgCacheOpen(PyObject *Self,PyObject *Args)
static PyMethodDef PkgCacheMethods[] =
{
- {"update",PkgCacheUpdate,METH_VARARGS,
- "update(progress, sources: SourceList, pulse_interval: int) -> bool\n\n"
- "Update the index files used by the cache. A call to this method\n"
- "does not affect the current Cache object, instead a new one\n"
- "should be created in order to use the changed index files.\n\n"
- "The parameter 'progress' takes an apt.progress.base.AcquireProgress\n"
- "object as its argument which will display the progress of fetching\n"
- "the index files. The parameter 'sources' takes an apt_pkg.SourceList\n"
- "object which lists the sources. The parameter 'progress' takes an\n"
- "integer describing the interval (in microseconds) in which the\n"
- "pulse() method of the 'progress' object will be called."
- },
+ {"update",PkgCacheUpdate,METH_VARARGS,cache_update_doc},
#ifdef COMPAT_0_7
{"Open", PkgCacheOpen, METH_VARARGS,
"Open the cache; deprecated and unsafe"},
@@ -231,7 +234,7 @@ static PyGetSetDef PkgCacheGetSet[] = {
{"packages",PkgCacheGetPackages,0,
"A list of apt_pkg.Package objects stored in the cache."},
{"provides_count",PkgCacheGetProvidesCount,0,
- "The number of provided packages."},
+ "Number of Provides relations described in the cache."},
{"ver_file_count",PkgCacheGetVerFileCount,0,
"The number of (Version, PackageFile) relations."},
{"version_count",PkgCacheGetVersionCount,0,
@@ -331,13 +334,17 @@ static Py_ssize_t CacheMapLen(PyObject *Self)
}
static char *doc_PkgCache = "Cache([progress]) -> Cache() object.\n\n"
- "The cache provides access to the packages and other stuff.\n\n"
+ "The APT cache file contains a hash table mapping names of binary\n"
+ "packages to their metadata. A Cache object is the in-core\n"
+ "representation of the same. It provides access to APT’s idea of the\n"
+ "list of available packages.\n"
"The optional parameter *progress* can be used to specify an \n"
- "apt.progress.OpProgress() object (or similar) which displays\n"
- "the opening progress. If not specified, the progress is\n"
- "displayed in simple text form.\n\n"
- "The cache can be used like a mapping of package names to Package\n"
- "objects.";
+ "apt.progress.base.OpProgress() object (or similar) which reports\n"
+ "progress information while the cache is being opened. If this\n"
+ "parameter is not supplied, the progress will be reported in simple,\n"
+ "human-readable text to standard output.\n\n"
+ "The cache can be used like a mapping from package names to Package\n"
+ "objects (although only getting items is supported).";
static PySequenceMethods CacheSeq = {0,0,0,0,0,0,0,CacheContains,0,0};
static PyMappingMethods CacheMap = {CacheMapLen,CacheMapOp,0};
PyTypeObject PyCache_Type =
@@ -568,17 +575,17 @@ static PyGetSetDef PackageGetSet[] = {
{"provides_list",PackageGetProvidesList,0,
"A list of all packages providing this package. The list contains\n"
"tuples in the format (providesname, providesver, version)\n"
- "whereas 'version' is an apt_pkg.Version object."},
+ "where 'version' is an apt_pkg.Version object."},
{"selected_state",PackageGetSelectedState,0,
- "The state of the selection; can be compared against the constants\n"
+ "The state of the selection, which can be compared against the constants\n"
"SELSTATE_DEINSTALL, SELSTATE_HOLD, SELSTATE_INSTALL, SELSTATE_PURGE,\n"
"SELSTATE_UNKNOWN of the apt_pkg module."},
{"inst_state",PackageGetInstState,0,
- "The state of the install, can be compared against the constants\n"
+ "The state of the install, which be compared against the constants\n"
"INSTSTATE_HOLD, INSTSTATE_HOLD_REINSTREQ, INSTSTATE_OK,\n"
"INSTSTATE_REINSTREQ of the apt_pkg module."},
{"current_state",PackageGetCurrentState,0,
- "The current state, can be compared against the constants\n"
+ "The current state, which can be compared against the constants\n"
"CURSTATE_CONFIG_FILES, CURSTATE_HALF_CONFIGURED,\n"
"CURSTATE_HALF_INSTALLED, CURSTATE_INSTALLED, CURSTATE_NOT_INSTALLED,\n"
"CURSTATE_UNPACKED of the apt_pkg module."},
@@ -591,7 +598,7 @@ static PyGetSetDef PackageGetSet[] = {
"Boolean value determining whether the package is essential."},
{"important",PackageGetImportant,0,
"Boolean value determining whether the package has the 'important'\n"
- "flag set ('Important: yes' in the Packages file). Not used anymore."},
+ "flag set ('Important: yes' in the Packages file). No longer used."},
{"version_list",PackageGetVersionList,0,
"A list of all apt_pkg.Version objects for this package."},
{"current_ver",PackageGetCurrentVer,0,
@@ -949,12 +956,12 @@ static PyGetSetDef VersionGetSet[] = {
"like 'a || b'."},
{"depends_list_str",VersionGetDependsListStr,0,
"Same as depends_list, except that the apt_pkg.Dependency objects\n"
- "are 3-tuples of the form (name, version, operator); whereas operator\n"
+ "are 3-tuples of the form (name, version, operator); where operator\n"
"is one of '<', '<=', '=', '>=', '>'."},
{"downloadable",VersionGetDownloadable,0,
"Whether the version can be downloaded."},
{"file_list",VersionGetFileList,0,
- "A list of tuples (pf: apt_pkg.PackageFile, index: int) for the\n"
+ "A list of tuples (packagefile: apt_pkg.PackageFile, index: int) for the\n"
"PackageFile objects related to this package. The index can be used\n"
"to retrieve the record of this package version."},
{"hash",VersionGetHash,0,
@@ -966,13 +973,13 @@ static PyGetSetDef VersionGetSet[] = {
{"parent_pkg",VersionGetParentPkg,0,
"The parent package of this version."},
{"priority",VersionGetPriority,0,
- "The priority of the package as an integer, can be compared against\n"
+ "The priority of the package as an integer, which can be compared to\n"
"the constants PRI_EXTRA, PRI_IMPORTANT, PRI_OPTIONAL, PRI_REQUIRED,\n"
"PRI_STANDARD of the apt_pkg module."},
{"priority_str",VersionGetPriorityStr,0,
"The priority of the package, as a string."},
{"provides_list",VersionGetProvidesList,0,
- "A list of all packages provides by this version. See\n"
+ "A list of all packages provided by this version. See\n"
"Package.provides_list for a description of the format."},
{"section",VersionGetSection,0,
"The section of this package version."},
@@ -1138,8 +1145,8 @@ static PyGetSetDef PackageFileGetSet[] = {
{"not_automatic",PackageFile_GetNotAutomatic,0,
"Whether the NotAutomatic flag is set in the Release file."},
{"not_source",PackageFile_GetNotSource,0,
- "Whether there is no source this file comes from; i.e. whether packages\n"
- "listed in this file can not be downloaded." },
+ "Whether this package file lacks an active (sources.list) source;"
+ "packages listed in such a file cannot be downloaded."},
{"origin",PackageFile_GetOrigin,0,
"The origin set in the release file."},
{"site",PackageFile_GetSite,0,
@@ -1147,7 +1154,7 @@ static PyGetSetDef PackageFileGetSet[] = {
{"size",PackageFile_GetSize,0,
"The size of the file."},
{"version",PackageFile_GetVersion,0,
- "The version set in the release file (e.g. '5.0.X' for lenny, where X is\n"
+ "The version set in the release file (e.g. '5.0.X' for lenny, where X\n"
"is a point release)."},
{}
};
@@ -1320,7 +1327,7 @@ static PyGetSetDef DependencyGetSet[] = {
{"comp_type",DependencyGetCompType,0,
"The type of comparison, as a string (one of '<', '<=', '=', '>=', '>')."},
{"dep_type",DependencyGetDepType,0,
- "The type of the dependency, may be translated"},
+ "The type of the dependency; may be translated"},
{"dep_type_untranslated",DependencyGetDepTypeUntranslated,0,
"Same as dep_type, but guaranteed to be untranslated."},
{"dep_type_enum",DependencyGetDepTypeEnum,0,
diff --git a/python/cdrom.cc b/python/cdrom.cc
index 022a4b00..7f89e9d3 100644
--- a/python/cdrom.cc
+++ b/python/cdrom.cc
@@ -30,7 +30,7 @@
static char *cdrom_add_doc =
"add(progress: apt_pkg.CdromProgress) -> bool\n\n"
- "Add the given CD-ROM to the sources.list. Returns True on success, may\n"
+ "Add the given CD-ROM to the sources.list. Return True on success;\n"
"raise an error on failure or return False.";
static PyObject *cdrom_add(PyObject *Self,PyObject *Args)
{
@@ -51,8 +51,11 @@ static PyObject *cdrom_add(PyObject *Self,PyObject *Args)
static char *cdrom_ident_doc =
"ident(progress: apt_pkg.CdromProgress) -> str\n\n"
- "Try to identify the CD-ROM and if successful return the identity as a\n"
- "string. Otherwise, return None or raise an error.";
+ "Try to identify the CD-ROM and if successful return the hexadecimal\n"
+ "CDROM-ID (and a integer version suffix seperated by -) as a\n"
+ "string. Otherwise, return None or raise an error.\n\n"
+ "The ID is created by hashing all file and directory names on the\n"
+ "CD-ROM and appending the version.";
static PyObject *cdrom_ident(PyObject *Self,PyObject *Args)
{
pkgCdrom &Cdrom = GetCpp<pkgCdrom>(Self);
diff --git a/python/configuration.cc b/python/configuration.cc
index 1aff56fb..7c9ed7bc 100644
--- a/python/configuration.cc
+++ b/python/configuration.cc
@@ -51,7 +51,7 @@ static const char *doc_FindFile =
"Same as find(), but for filenames. In the APT configuration, there\n"
"is a special section Dir:: for storing filenames. find_file() locates\n"
"the given key and then goes up and prepends the directory names to the\n"
- "return value, e.g. for:\n"
+ "return value. For example, for:\n"
"\n"
" apt_pkg.config['Dir'] = 'a'\n"
" apt_pkg.config['Dir::D'] = 'b'\n"
@@ -85,7 +85,7 @@ static PyObject *CnfFindDir(PyObject *Self,PyObject *Args)
static const char *doc_FindI =
"find_i(key: str[, default: int = 0]) -> int\n\n"
- "Same as find, but only for integer values.";
+ "Same as find, but for integer values.";
static PyObject *CnfFindI(PyObject *Self,PyObject *Args)
{
char *Name = 0;
@@ -97,7 +97,7 @@ static PyObject *CnfFindI(PyObject *Self,PyObject *Args)
static const char *doc_FindB =
"find_i(key: str[, default: bool = False]) -> bool\n\n"
- "Same as find, but only for boolean values.";
+ "Same as find, but for boolean values; returns False on unknown values.";
static PyObject *CnfFindB(PyObject *Self,PyObject *Args)
{
char *Name = 0;
@@ -110,7 +110,7 @@ static PyObject *CnfFindB(PyObject *Self,PyObject *Args)
static const char *doc_Set =
"set(key: str, value: str)\n\n"
"Set the given key to the given value. To set int or bool values,\n"
- "encode them using str(value). One can then use find_i()/find_b()\n"
+ "encode them using str(value) and then use find_i()/find_b()\n"
"to retrieve their value again.";
static PyObject *CnfSet(PyObject *Self,PyObject *Args)
{
@@ -142,7 +142,7 @@ static int CnfContains(PyObject *Self,PyObject *Arg)
static const char *doc_Clear =
"clear(key: str)\n\n"
- "Unset the option at the given key and all sub options.";
+ "Remove the specified option and all sub-options.";
static PyObject *CnfClear(PyObject *Self,PyObject *Args)
{
char *Name = 0;
@@ -158,8 +158,9 @@ static PyObject *CnfClear(PyObject *Self,PyObject *Args)
// The amazing narrowing search ability!
static const char *doc_SubTree =
"sub_tree(key: str) -> apt_pkg.Configuration\n\n"
- "Return a new apt_pkg.Configuration objects which starts at the\n"
- "given option. Example:\n\n"
+
+ "Return a new apt_pkg.Configuration object with the given option\n"
+ "as its root. Example:\n\n"
" apttree = config.subtree('APT')\n"
" apttree['Install-Suggests'] = config['APT::Install-Suggests']";
static PyObject *CnfSubTree(PyObject *Self,PyObject *Args)
@@ -181,7 +182,12 @@ static PyObject *CnfSubTree(PyObject *Self,PyObject *Args)
// Return a list of items at a specific level
static char *doc_List =
"list([root: str]) -> list\n\n"
- "Return a list of all items at the given root.";
+ "Return a list of all items at the given root, using their full\n"
+ "name. For example, in a configuration object where the options A,\n"
+ "B, and B::C are set, the following expressions evaluate to True:\n\n"
+ " conf.list() == ['A', 'B']\n"
+ " conf.list('A') == ['']\n"
+ " conf.list('B') == ['B::C']\n";
static PyObject *CnfList(PyObject *Self,PyObject *Args)
{
char *RootName = 0;
@@ -324,8 +330,8 @@ static int CnfMapSet(PyObject *Self,PyObject *Arg,PyObject *Val)
// Config file loaders /*{{{*/
char *doc_LoadConfig =
"read_config_file(configuration: apt_pkg.Configuration, filename: str)\n\n"
- "Read the configuration file given by filename and set the options\n"
- "defined therein in the configuration object.";
+ "Read the configuration file 'filename' and set the appropriate\n"
+ "options in the configuration object.";
PyObject *LoadConfig(PyObject *Self,PyObject *Args)
{
char *Name = 0;
@@ -403,7 +409,8 @@ char *doc_ParseCommandLine =
"configuration option the result will be stored in and type is one of\n"
"'HasArg', 'IntLevel', 'Boolean', 'InvBoolean', 'ConfigFile',\n"
"'ArbItem'. The default type is 'Boolean'. Read the online documentation\n"
-"and the tutorial therin about writing an apt-cdrom clone for more details.";
+"in python-apt-doc and its tutorial on writing an apt-cdrom clone for more\n"
+"details.";
PyObject *ParseCommandLine(PyObject *Self,PyObject *Args)
{
PyObject *POList;
@@ -531,11 +538,13 @@ static PyMappingMethods ConfigurationMap = {0,CnfMap,CnfMapSet};
static const char *configuration_doc =
"Configuration()\n\n"
- "Configuration objects represent the configuration of apt. They map\n"
- "keys to values and store configuration parsed from files like\n"
- "/etc/apt/apt.conf. The most important object is apt_pkg.config\n"
- "which points to the global configuration object. Additional objects\n"
- "can be created, but this is normally not needed.";
+ "Represent the configuration of APT by mapping option keys to\n"
+ "values and storing configuration parsed from files like\n"
+ "/etc/apt/apt.conf. The most important Configuration object\n"
+ "is apt_pkg.config which points to the global configuration\n"
+ "object. Other top-level Configuration objects can be created\n"
+ "by calling the constructor, but there is usually no reason to.";
+
PyTypeObject PyConfiguration_Type =
{
PyVarObject_HEAD_INIT(&PyType_Type, 0)
diff --git a/python/depcache.cc b/python/depcache.cc
index a9627037..cd098f2f 100644
--- a/python/depcache.cc
+++ b/python/depcache.cc
@@ -380,7 +380,6 @@ static PyObject *PkgDepCacheMarkAuto(PyObject *Self,PyObject *Args)
return HandleErrors(Py_None);
}
-
static PyObject *PkgDepCacheIsUpgradable(PyObject *Self,PyObject *Args)
{
pkgDepCache *depcache = GetCpp<pkgDepCache *>(Self);
@@ -544,7 +543,8 @@ static PyMethodDef PkgDepCacheMethods[] =
{
{"init",PkgDepCacheInit,METH_VARARGS,
"init(progress: apt.progress.base.OpProgress)\n\n"
- "Initialize the depcache (done on construct automatically)"},
+ "Initialize the depcache (done automatically when constructing\n"
+ "the object)."},
{"get_candidate_ver",PkgDepCacheGetCandidateVer,METH_VARARGS,
"get_candidate_ver(pkg: apt_pkg.Package) -> apt_pkg.Version\n\n"
"Return the candidate version for the package, normally the version\n"
@@ -574,7 +574,7 @@ static PyMethodDef PkgDepCacheMethods[] =
// Manipulators
{"mark_keep",PkgDepCacheMarkKeep,METH_VARARGS,
"mark_keep(pkg: apt_pkg.Package)\n\n"
- "Mark package for keep"},
+ "Mark package to be kept."},
{"mark_delete",PkgDepCacheMarkDelete,METH_VARARGS,
"mark_delete(pkg: apt_pkg.Package[, purge: bool = False])\n\n"
"Mark package for deletion, and if 'purge' is True also for purging."},
@@ -590,7 +590,7 @@ static PyMethodDef PkgDepCacheMethods[] =
"or as not automatically installed (if auto=False)."},
{"set_reinstall",PkgDepCacheSetReInstall,METH_VARARGS,
"set_reinstall(pkg: apt_pkg.Package, reinstall: bool)\n\n"
- "Set if the package should be reinstalled (reinstall = True or False)."},
+ "Set whether the package should be reinstalled (reinstall = True or False)."},
// state information
{"is_upgradable",PkgDepCacheIsUpgradable,METH_VARARGS,
"is_upgradable(pkg: apt_pkg.Package) -> bool\n\n"
@@ -684,7 +684,7 @@ static PyGetSetDef PkgDepCacheGetSet[] = {
{"usr_size",PkgDepCacheGetUsrSize,0,
"The amount of space required for installing/removing the packages,\n"
"i.e. the Installed-Size of all packages marked for installation\n"
- "minus the Installed-Size of all packages for for removal."},
+ "minus the Installed-Size of all packages for removal."},
{"policy",PkgDepCacheGetPolicy,0,
"The apt_pkg.Policy object used by this cache."},
{}
@@ -967,7 +967,11 @@ PyTypeObject PyProblemResolver_Type =
// pkgActionGroup Class /*{{{*/
// ---------------------------------------------------------------------
-
+static const char *actiongroup_release_doc =
+ "release()\n\n"
+ "End the scope of this action group. If this is the only action\n"
+ "group bound to the cache, this will cause any deferred cleanup\n"
+ "actions to be performed.";
static PyObject *PkgActionGroupRelease(PyObject *Self,PyObject *Args)
{
pkgDepCache::ActionGroup *ag = GetCpp<pkgDepCache::ActionGroup*>(Self);
@@ -978,11 +982,19 @@ static PyObject *PkgActionGroupRelease(PyObject *Self,PyObject *Args)
return HandleErrors(Py_None);
}
+static const char *actiongroup__enter__doc =
+ "__enter__() -> ActionGroup\n\n"
+ "A dummy action which just returns the object itself, so it can\n"
+ "be used as a context manager.";
static PyObject *PkgActionGroupEnter(PyObject *Self,PyObject *Args) {
if (PyArg_ParseTuple(Args,"") == 0)
return 0;
return Self;
}
+
+static const char *actiongroup__exit__doc =
+ "__exit__(*excinfo) -> bool\n\n"
+ "Same as release(), but for use as a context manager.";
static PyObject *PkgActionGroupExit(PyObject *Self,PyObject *Args) {
pkgDepCache::ActionGroup *ag = GetCpp<pkgDepCache::ActionGroup*>(Self);
ag->release();
@@ -991,11 +1003,9 @@ static PyObject *PkgActionGroupExit(PyObject *Self,PyObject *Args) {
static PyMethodDef PkgActionGroupMethods[] =
{
- {"release", PkgActionGroupRelease, METH_VARARGS, "release()"},
- {"__exit__", PkgActionGroupExit, METH_VARARGS, "__exit__(...) -> "
- "Release the action group, for 'with' statement."},
- {"__enter__", PkgActionGroupEnter, METH_VARARGS, "__enter__() -> "
- "Enter, for the 'with' statement. Does nothing."},
+ {"release", PkgActionGroupRelease, METH_VARARGS, actiongroup_release_doc},
+ {"__enter__", PkgActionGroupEnter, METH_VARARGS, actiongroup__enter__doc},
+ {"__exit__", PkgActionGroupExit, METH_VARARGS, actiongroup__exit__doc},
{}
};
diff --git a/python/hashes.cc b/python/hashes.cc
index d0b0fb0c..8cc86f4e 100644
--- a/python/hashes.cc
+++ b/python/hashes.cc
@@ -88,9 +88,8 @@ static char *hashes_doc =
"Hashes([object: (bytes, file)])\n\n"
"Calculate hashes for the given object. It can be used to create all\n"
"supported hashes for a file.\n\n"
- "The parameter *object* can be a bytes (3.X) / str (2.X) object, or an\n"
- "object providing the fileno() method or an integer describing a file\n"
- "descriptor.";
+ "The parameter 'object' can be a bytestring, an object providing the\n"
+ "fileno() method, or an integer describing a file descriptor.";
PyTypeObject PyHashes_Type = {
PyVarObject_HEAD_INIT(&PyType_Type, 0)
diff --git a/python/indexrecords.cc b/python/indexrecords.cc
index c5ebcfbc..d6a3263c 100644
--- a/python/indexrecords.cc
+++ b/python/indexrecords.cc
@@ -46,9 +46,9 @@ static PyObject *indexrecords_load(PyObject *self,PyObject *args)
static char *indexrecords_lookup_doc =
"lookup(key: str) -> (HashString, int)\n\n"
- "Lookup the filename given by 'key', return a tuple (hash, size),\n"
- "whereas the first element 'hash' is an apt_pkg.HashString object\n"
- "and the second element 'size' an int object.";
+ "Look up the filename given by 'key' and return a tuple (hash, size),\n"
+ "where the first element 'hash' is an apt_pkg.HashString object\n"
+ "and the second element 'size' is an int object.";
static PyObject *indexrecords_lookup(PyObject *self,PyObject *args)
{
const char *keyname;
diff --git a/python/lock.cc b/python/lock.cc
index fc78c0cb..2c957df1 100644
--- a/python/lock.cc
+++ b/python/lock.cc
@@ -78,11 +78,11 @@ static char *systemlock_doc = "SystemLock()\n\n"
"Context manager for locking the package system. The lock is established\n"
"as soon as the method __enter__() is called. It is released when\n"
"__exit__() is called.\n\n"
- "This should be used via the 'with' statement, e.g.::\n\n"
+ "This should be used via the 'with' statement, for example:\n\n"
" with apt_pkg.SystemLock():\n"
" ...\n\n"
"Once the block is left, the lock is released automatically. The object\n"
- "can be used multiple times::\n\n"
+ "can be used multiple times:\n\n"
" lock = apt_pkg.SystemLock()\n"
" with lock:\n"
" ...\n"
@@ -210,11 +210,11 @@ static char *filelock_doc = "SystemLock(filename: str)\n\n"
"Context manager for locking using a file. The lock is established\n"
"as soon as the method __enter__() is called. It is released when\n"
"__exit__() is called.\n\n"
- "This should be used via the 'with' statement, e.g.::\n\n"
+ "This should be used via the 'with' statement, for example:\n\n"
" with apt_pkg.FileLock(filename):\n"
" ...\n\n"
"Once the block is left, the lock is released automatically. The object\n"
- "can be used multiple times::\n\n"
+ "can be used multiple times:\n\n"
" lock = apt_pkg.FileLock(filename)\n"
" with lock:\n"
" ...\n"
diff --git a/python/metaindex.cc b/python/metaindex.cc
index 66aa76fb..a00cf04e 100644
--- a/python/metaindex.cc
+++ b/python/metaindex.cc
@@ -71,9 +71,8 @@ static PyObject *MetaIndexRepr(PyObject *Self)
static const char *metaindex_doc =
- "Represent a meta index, i.e. a Release file. This class provides\n"
- "some information about those release files, e.g. whether they\n"
- "are signed or not.";
+ "Provide information on meta-indexes (i.e. Release files), such as\n"
+ "whether they are trusted or their URI.";
PyTypeObject PyMetaIndex_Type =
{
diff --git a/python/pkgmanager.cc b/python/pkgmanager.cc
index b501ee1a..95e8c27e 100644
--- a/python/pkgmanager.cc
+++ b/python/pkgmanager.cc
@@ -105,9 +105,9 @@ static PyMethodDef PkgManagerMethods[] =
"do_install(status_fd: int) -> int\n\n"
"Install the packages and return one of the class constants\n"
"RESULT_COMPLETED, RESULT_FAILED, RESULT_INCOMPLETE. The argument\n"
- "status_fd can be used to specify a file descriptor where APT will\n"
+ "status_fd can be used to specify a file descriptor that APT will\n"
"write status information on (see README.progress-reporting in the\n"
- "apt source code for information what is written there)."},
+ "apt source code for information on what will be written there)."},
{"fix_missing",PkgManagerFixMissing,METH_VARARGS,
"fix_missing() -> bool\n\n"
"Fix the installation if a package could not be downloaded."},
diff --git a/python/pkgsrcrecords.cc b/python/pkgsrcrecords.cc
index 108eff7f..aad3ef7e 100644
--- a/python/pkgsrcrecords.cc
+++ b/python/pkgsrcrecords.cc
@@ -36,9 +36,9 @@ struct PkgSrcRecordsStruct
static char *doc_PkgSrcRecordsLookup =
"lookup(name: str) -> bool\n\n"
- "Lookup the source package with the given name. Each call moves\n"
+ "Look up the source package with the given name. Each call moves\n"
"the position of the records parser forward. If there are no\n"
- "records anymore, return None. If the lookup failed this way,\n"
+ "more records, return None. If the lookup failed this way,\n"
"access to any of the attributes will result in an AttributeError.";
static PyObject *PkgSrcRecordsLookup(PyObject *Self,PyObject *Args)
{
@@ -231,7 +231,7 @@ static PyGetSetDef PkgSrcRecordsGetSet[] = {
{"binaries",PkgSrcRecordsGetBinaries,0,
"A list of the names of the binaries produced by this source package."},
{"build_depends",PkgSrcRecordsGetBuildDepends,0,
- "A dictionary describing the build-time dependencies of the package,\n"
+ "A dictionary describing the build-time dependencies of the package;\n"
"the format is the same as used for apt_pkg.Version.depends_list_str."},
{"files",PkgSrcRecordsGetFiles,0,
"A list of tuples (md5: str, size: int, path: str, type: str), whereas\n"
diff --git a/python/policy.cc b/python/policy.cc
index 40da931f..7eccb30c 100644
--- a/python/policy.cc
+++ b/python/policy.cc
@@ -115,9 +115,9 @@ static PyObject *policy_read_pindir(PyObject *self, PyObject *arg) {
static char *policy_create_pin_doc =
"create_pin(type: str, pkg: str, data: str, priority: int)\n\n"
"Create a pin for the policy. The parameter 'type' refers to one of the\n"
- "following strings: 'Version', 'Release', 'Origin'. The argument 'pkg'\n"
- "is the name of the package, the parameter 'data' refers to the value\n"
- "e.g. unstable for type='Release' and the other possible options. \n"
+ "strings 'Version', 'Release', or 'Origin'. The argument 'pkg' is the\n"
+ "name of the package. The parameter 'data' refers to the value\n"
+ "(e.g. 'unstable' for type='Release') and the other possible options.\n"
"The parameter 'priority' gives the priority of the pin.";
static PyObject *policy_create_pin(PyObject *self, PyObject *args) {
diff --git a/python/tag.cc b/python/tag.cc
index 99bb9b55..9fe12a1a 100644
--- a/python/tag.cc
+++ b/python/tag.cc
@@ -113,7 +113,7 @@ static PyObject *TagSecFind(PyObject *Self,PyObject *Args)
static char *doc_FindRaw =
"find_raw(name: str[, default = None] -> str\n\n"
- "Same as find(), but returns the complete key : value field; instead of\n"
+ "Same as find(), but returns the complete 'key: value' field; instead of\n"
"just the value.";
static PyObject *TagSecFindRaw(PyObject *Self,PyObject *Args)
{
@@ -139,7 +139,7 @@ static PyObject *TagSecFindRaw(PyObject *Self,PyObject *Args)
static char *doc_FindFlag =
"find_flag(name: str) -> int\n\n"
- "Return 1 if the value at the key is 'yes' or a similar value describing\n"
+ "Return 1 if the key's value is 'yes' or a similar value describing\n"
"a boolean true. If the field does not exist, or does not have such a\n"
"value, return 0.";
static PyObject *TagSecFindFlag(PyObject *Self,PyObject *Args)
@@ -324,9 +324,9 @@ static PyObject *TagFileOffset(PyObject *Self,PyObject *Args)
static char *doc_Jump =
"jump(offset: int) -> bool\n\n"
- "Jump to the given offset, returns True on success. Note that jumping to\n"
- "an offset is not very reliable, and the 'section' attribute does not\n"
- "always point to the section one would expect it to.";
+ "Jump to the given offset; return True on success. Note that jumping to\n"
+ "an offset is not very reliable, and the 'section' attribute may point\n"
+ "to an unexpected section.";
static PyObject *TagFileJump(PyObject *Self,PyObject *Args)
{
int Offset;
@@ -431,7 +431,7 @@ char *doc_RewriteSection =
"apt_pkg.REWRITE_PACKAGE_ORDER and apt_pkg.REWRITE_SOURCE_ORDER are two\n"
"predefined lists for rewriting package and source sections, respectively\n\n"
"The parameter 'rewrite_list' is a list of tuples of the form\n"
-"``(tag, newvalue[, renamed_to])``, whereas 'tag' describes the field which\n"
+"'(tag, newvalue[, renamed_to])', where 'tag' describes the field which\n"
"should be changed, 'newvalue' the value which should be inserted or None\n"
"to delete the field, and the optional renamed_to can be used to rename the\n"
"field.";
@@ -511,8 +511,8 @@ PyMappingMethods TagSecMapMeth = {TagSecLength,TagSecMap,0};
static char *doc_TagSec = "TagSection(text: str)\n\n"
- "TagSection() objects provide methods to access rfc822-style formatted\n"
- "header sections, like those in debian/control or Packages files.\n\n"
+ "Provide methods to access RFC822-style header sections, like those\n"
+ "found in debian/control or Packages files.\n\n"
"TagSection() behave like read-only dictionaries and also provide access\n"
"to the functions provided by the C++ class (e.g. find)";
PyTypeObject PyTagSection_Type =
@@ -586,13 +586,14 @@ static PyGetSetDef TagFileGetSet[] = {
static char *doc_TagFile = "TagFile(file)\n\n"
- "TagFile() objects provide access to debian control files, which consists\n"
- "of multiple RFC822-like formatted sections.\n\n"
+ "TagFile() objects provide access to debian control files, which consist\n"
+ "of multiple RFC822-style sections.\n\n"
"To provide access to those sections, TagFile objects provide an iterator\n"
"which yields TagSection objects for each section.\n\n"
"TagFile objects also provide another API which uses a shared TagSection\n"
"object in the 'section' member. The functions step() and jump() can be\n"
- "used to navigate in the file; and offset() tells the current position.\n\n"
+ "used to navigate within the file; offset() returns the current\n"
+ "position.\n\n"
"It is important to not mix the use of both APIs, because this can have\n"
"unwanted effects.\n\n"
"The parameter 'file' refers to an object providing a fileno() method or\n"
diff --git a/python/tarfile.cc b/python/tarfile.cc
index 6363af0f..215d3a8c 100644
--- a/python/tarfile.cc
+++ b/python/tarfile.cc
@@ -235,7 +235,7 @@ static PyMethodDef tarmember_methods[] = {
{"ischr",tarmember_ischr,METH_NOARGS,
"Determine whether the member is a character device."},
{"isdev",tarmember_isdev,METH_NOARGS,
- "Determine whether the member is a device (block,character or FIFO)."},
+ "Determine whether the member is a device (block, character or FIFO)."},
{"isdir",tarmember_isdir,METH_NOARGS,
"Determine whether the member is a directory."},
{"isfifo",tarmember_isfifo,METH_NOARGS,
@@ -252,7 +252,7 @@ static PyMethodDef tarmember_methods[] = {
};
static PyGetSetDef tarmember_getset[] = {
- {"gid",tarmember_get_gid,0,"The owner's group id"},
+ {"gid",tarmember_get_gid,0,"The owner's group ID."},
{"linkname",tarmember_get_linkname,0,"The target of the link."},
{"major",tarmember_get_major,0,"The major ID of the device."},
{"minor",tarmember_get_minor,0,"The minor ID of the device."},
@@ -260,7 +260,7 @@ static PyGetSetDef tarmember_getset[] = {
{"mtime",tarmember_get_mtime,0,"Last time of modification."},
{"name",tarmember_get_name,0,"The name of the file."},
{"size",tarmember_get_size,0,"The size of the file."},
- {"uid",tarmember_get_uid,0,"The owner's user id."},
+ {"uid",tarmember_get_uid,0,"The owner's user ID."},
{NULL}
};
@@ -375,11 +375,11 @@ static PyObject *tarfile_extractall(PyObject *self, PyObject *args)
static const char *tarfile_go_doc =
"go(callback: callable[, member: str]) -> True\n\n"
- "Go through the archive and call the callable callback for each\n"
+ "Go through the archive and call the callable 'callback' for each\n"
"member with 2 arguments. The first argument is the TarMember and\n"
"the second one is the data, as bytes.\n\n"
"The optional parameter 'member' can be used to specify the member for\n"
- "which call the callback. If not specified, it will be called for all\n"
+ "which to call the callback. If not specified, it will be called for all\n"
"members. If specified and not found, LookupError will be raised.";
static PyObject *tarfile_go(PyObject *self, PyObject *args)
{
generated by cgit v1.2.3 (git 2.46.0) at 2026-05-10 20:05:40 +0000