X-Git-Url: https://git.octo.it/?a=blobdiff_plain;f=src%2Fpyconfig.c;h=b5c01aaf1d5481256bf872e6d078c6e4b74dc15c;hb=c4e824e456a30e1dc8f750a425472a0955f6b646;hp=a6b4469fa308dd7f62716dffac0e38e5f7ba6600;hpb=045cf31cc5f85b703083da7383410bed4a667817;p=collectd.git diff --git a/src/pyconfig.c b/src/pyconfig.c index a6b4469f..b5c01aaf 100644 --- a/src/pyconfig.c +++ b/src/pyconfig.c @@ -1,3 +1,29 @@ +/** + * collectd - src/pyconfig.c + * Copyright (C) 2009 Sven Trenkel + * + * Permission is hereby granted, free of charge, to any person obtaining a + * copy of this software and associated documentation files (the "Software"), + * to deal in the Software without restriction, including without limitation + * the rights to use, copy, modify, merge, publish, distribute, sublicense, + * and/or sell copies of the Software, and to permit persons to whom the + * Software is furnished to do so, subject to the following conditions: + * + * The above copyright notice and this permission notice shall be included in + * all copies or substantial portions of the Software. + * + * THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR + * IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, + * FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE + * AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER + * LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING + * FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER + * DEALINGS IN THE SOFTWARE. + * + * Authors: + * Sven Trenkel + **/ + #include #include @@ -6,6 +32,29 @@ #include "cpython.h" +static char config_doc[] = "This represents a piece of collectd's config file.\n" + "It is passed to scripts with config callbacks (see \"register_config\")\n" + "and is of little use if created somewhere else.\n" + "\n" + "It has no methods beyond the bare minimum and only exists for its\n" + "data members"; + +static char parent_doc[] = "This represents the parent of this node. On the root node\n" + "of the config tree it will be None.\n"; + +static char key_doc[] = "This is the keyword of this item, ie the first word of any\n" + "given line in the config file. It will always be a string.\n"; + +static char values_doc[] = "This is a tuple (which might be empty) of all value, ie words\n" + "following the keyword in any given line in the config file.\n" + "\n" + "Every item in this tuple will be either a string or a float or a bool,\n" + "depending on the contents of the configuration file.\n"; + +static char children_doc[] = "This is a tuple of child nodes. For most nodes this will be\n" + "empty. If this node represents a block instead of a single line of the config\n" + "file it will contain all nodes in this block.\n"; + static PyObject *Config_new(PyTypeObject *type, PyObject *args, PyObject *kwds) { Config *self; @@ -25,10 +74,17 @@ static int Config_init(PyObject *s, PyObject *args, PyObject *kwds) { Config *self = (Config *) s; static char *kwlist[] = {"key", "parent", "values", "children", NULL}; - if (!PyArg_ParseTupleAndKeywords(args, kwds, "S|OOO", kwlist, + if (!PyArg_ParseTupleAndKeywords(args, kwds, "O|OOO", kwlist, &key, &parent, &values, &children)) return -1; + if (!IS_BYTES_OR_UNICODE(key)) { + PyErr_SetString(PyExc_TypeError, "argument 1 must be str"); + Py_XDECREF(parent); + Py_XDECREF(values); + Py_XDECREF(children); + return -1; + } if (values == NULL) { values = PyTuple_New(0); PyErr_Clear(); @@ -64,8 +120,28 @@ static int Config_init(PyObject *s, PyObject *args, PyObject *kwds) { static PyObject *Config_repr(PyObject *s) { Config *self = (Config *) s; + PyObject *ret = NULL; + static PyObject *node_prefix = NULL, *root_prefix = NULL, *ending = NULL; + + /* This is ok because we have the GIL, so this is thread-save by default. */ + if (node_prefix == NULL) + node_prefix = cpy_string_to_unicode_or_bytes(""); + if (node_prefix == NULL || root_prefix == NULL || ending == NULL) + return NULL; - return PyString_FromFormat("", self->parent == Py_None ? "root " : "", PyString_AsString(PyObject_Str(self->key))); + ret = PyObject_Str(self->key); + CPY_SUBSTITUTE(PyObject_Repr, ret, ret); + if (self->parent == NULL || self->parent == Py_None) + CPY_STRCAT(&ret, root_prefix); + else + CPY_STRCAT(&ret, node_prefix); + CPY_STRCAT(&ret, ending); + + return ret; } static int Config_traverse(PyObject *self, visitproc visit, void *arg) { @@ -74,8 +150,7 @@ static int Config_traverse(PyObject *self, visitproc visit, void *arg) { Py_VISIT(c->key); Py_VISIT(c->values); Py_VISIT(c->children); - return 0; -} + return 0;} static int Config_clear(PyObject *self) { Config *c = (Config *) self; @@ -92,16 +167,15 @@ static void Config_dealloc(PyObject *self) { } static PyMemberDef Config_members[] = { - {"Parent", T_OBJECT, offsetof(Config, parent), 0, "Parent node"}, - {"Key", T_OBJECT_EX, offsetof(Config, key), 0, "Keyword of this node"}, - {"Values", T_OBJECT_EX, offsetof(Config, values), 0, "Values after the key"}, - {"Children", T_OBJECT_EX, offsetof(Config, children), 0, "Childnodes of this node"}, + {"parent", T_OBJECT, offsetof(Config, parent), 0, parent_doc}, + {"key", T_OBJECT_EX, offsetof(Config, key), 0, key_doc}, + {"values", T_OBJECT_EX, offsetof(Config, values), 0, values_doc}, + {"children", T_OBJECT_EX, offsetof(Config, children), 0, children_doc}, {NULL} }; PyTypeObject ConfigType = { - PyObject_HEAD_INIT(NULL) - 0, /* Always 0 */ + CPY_INIT_TYPE "collectd.Config", /* tp_name */ sizeof(Config), /* tp_basicsize */ 0, /* Will be filled in later */ @@ -121,7 +195,7 @@ PyTypeObject ConfigType = { 0, /* tp_setattro */ 0, /* tp_as_buffer */ Py_TPFLAGS_DEFAULT | Py_TPFLAGS_BASETYPE | Py_TPFLAGS_HAVE_GC, /*tp_flags*/ - "Cool help text later", /* tp_doc */ + config_doc, /* tp_doc */ Config_traverse, /* tp_traverse */ Config_clear, /* tp_clear */ 0, /* tp_richcompare */