From: Christian Jurk Date: Mon, 10 Aug 2015 16:38:49 +0000 (+0200) Subject: Updates X-Git-Url: http://git.ipfire.org/?a=commitdiff_plain;h=ea7bad6d260b7d841c76a748865e656165a6ac97;p=people%2Fms%2Fpython-rrdtool.git Updates --- diff --git a/ACKNOWLEDGEMENT b/ACKNOWLEDGEMENT new file mode 100644 index 0000000..515cd4d --- /dev/null +++ b/ACKNOWLEDGEMENT @@ -0,0 +1,5 @@ +This is a list of people who have made contributions to this project. + +Hye-Shik Chang +Matthew W. Samsonoff +Brian E. Gallew \ No newline at end of file diff --git a/LICENSE b/LICENSE index 65c5ca8..4e9bf49 100644 --- a/LICENSE +++ b/LICENSE @@ -1,165 +1,502 @@ - GNU LESSER GENERAL PUBLIC LICENSE - Version 3, 29 June 2007 + GNU LESSER GENERAL PUBLIC LICENSE + Version 2.1, February 1999 - Copyright (C) 2007 Free Software Foundation, Inc. + Copyright (C) 1991, 1999 Free Software Foundation, Inc. + 59 Temple Place, Suite 330, Boston, MA 02111-1307 USA Everyone is permitted to copy and distribute verbatim copies of this license document, but changing it is not allowed. - - This version of the GNU Lesser General Public License incorporates -the terms and conditions of version 3 of the GNU General Public -License, supplemented by the additional permissions listed below. - - 0. Additional Definitions. - - As used herein, "this License" refers to version 3 of the GNU Lesser -General Public License, and the "GNU GPL" refers to version 3 of the GNU -General Public License. - - "The Library" refers to a covered work governed by this License, -other than an Application or a Combined Work as defined below. - - An "Application" is any work that makes use of an interface provided -by the Library, but which is not otherwise based on the Library. -Defining a subclass of a class defined by the Library is deemed a mode -of using an interface provided by the Library. - - A "Combined Work" is a work produced by combining or linking an -Application with the Library. The particular version of the Library -with which the Combined Work was made is also called the "Linked -Version". - - The "Minimal Corresponding Source" for a Combined Work means the -Corresponding Source for the Combined Work, excluding any source code -for portions of the Combined Work that, considered in isolation, are -based on the Application, and not on the Linked Version. - - The "Corresponding Application Code" for a Combined Work means the -object code and/or source code for the Application, including any data -and utility programs needed for reproducing the Combined Work from the -Application, but excluding the System Libraries of the Combined Work. - - 1. Exception to Section 3 of the GNU GPL. - - You may convey a covered work under sections 3 and 4 of this License -without being bound by section 3 of the GNU GPL. - - 2. Conveying Modified Versions. - - If you modify a copy of the Library, and, in your modifications, a -facility refers to a function or data to be supplied by an Application -that uses the facility (other than as an argument passed when the -facility is invoked), then you may convey a copy of the modified -version: - - a) under this License, provided that you make a good faith effort to - ensure that, in the event an Application does not supply the - function or data, the facility still operates, and performs - whatever part of its purpose remains meaningful, or - - b) under the GNU GPL, with none of the additional permissions of - this License applicable to that copy. - - 3. Object Code Incorporating Material from Library Header Files. - - The object code form of an Application may incorporate material from -a header file that is part of the Library. You may convey such object -code under terms of your choice, provided that, if the incorporated -material is not limited to numerical parameters, data structure -layouts and accessors, or small macros, inline functions and templates -(ten or fewer lines in length), you do both of the following: - - a) Give prominent notice with each copy of the object code that the - Library is used in it and that the Library and its use are - covered by this License. - - b) Accompany the object code with a copy of the GNU GPL and this license - document. - - 4. Combined Works. - - You may convey a Combined Work under terms of your choice that, -taken together, effectively do not restrict modification of the -portions of the Library contained in the Combined Work and reverse -engineering for debugging such modifications, if you also do each of -the following: - - a) Give prominent notice with each copy of the Combined Work that - the Library is used in it and that the Library and its use are - covered by this License. - - b) Accompany the Combined Work with a copy of the GNU GPL and this license - document. - - c) For a Combined Work that displays copyright notices during - execution, include the copyright notice for the Library among - these notices, as well as a reference directing the user to the - copies of the GNU GPL and this license document. - - d) Do one of the following: - - 0) Convey the Minimal Corresponding Source under the terms of this - License, and the Corresponding Application Code in a form - suitable for, and under terms that permit, the user to - recombine or relink the Application with a modified version of - the Linked Version to produce a modified Combined Work, in the - manner specified by section 6 of the GNU GPL for conveying - Corresponding Source. - - 1) Use a suitable shared library mechanism for linking with the - Library. A suitable mechanism is one that (a) uses at run time - a copy of the Library already present on the user's computer - system, and (b) will operate properly with a modified version - of the Library that is interface-compatible with the Linked - Version. - - e) Provide Installation Information, but only if you would otherwise - be required to provide such information under section 6 of the - GNU GPL, and only to the extent that such information is - necessary to install and execute a modified version of the - Combined Work produced by recombining or relinking the - Application with a modified version of the Linked Version. (If - you use option 4d0, the Installation Information must accompany - the Minimal Corresponding Source and Corresponding Application - Code. If you use option 4d1, you must provide the Installation - Information in the manner specified by section 6 of the GNU GPL - for conveying Corresponding Source.) - - 5. Combined Libraries. - - You may place library facilities that are a work based on the -Library side by side in a single library together with other library -facilities that are not Applications and are not covered by this -License, and convey such a combined library under terms of your -choice, if you do both of the following: - - a) Accompany the combined library with a copy of the same work based - on the Library, uncombined with any other library facilities, - conveyed under the terms of this License. - - b) Give prominent notice with the combined library that part of it - is a work based on the Library, and explaining where to find the - accompanying uncombined form of the same work. - - 6. Revised Versions of the GNU Lesser General Public License. - - The Free Software Foundation may publish revised and/or new versions -of the GNU Lesser General Public License from time to time. Such new -versions will be similar in spirit to the present version, but may -differ in detail to address new problems or concerns. - - Each version is given a distinguishing version number. If the -Library as you received it specifies that a certain numbered version -of the GNU Lesser General Public License "or any later version" -applies to it, you have the option of following the terms and -conditions either of that published version or of any later version -published by the Free Software Foundation. If the Library as you -received it does not specify a version number of the GNU Lesser -General Public License, you may choose any version of the GNU Lesser -General Public License ever published by the Free Software Foundation. - - If the Library as you received it specifies that a proxy can decide -whether future versions of the GNU Lesser General Public License shall -apply, that proxy's public statement of acceptance of any version is -permanent authorization for you to choose that version for the +[This is the first released version of the Lesser GPL. It also counts + as the successor of the GNU Library Public License, version 2, hence + the version number 2.1.] + + Preamble + + The licenses for most software are designed to take away your +freedom to share and change it. By contrast, the GNU General Public +Licenses are intended to guarantee your freedom to share and change +free software--to make sure the software is free for all its users. + + This license, the Lesser General Public License, applies to some +specially designated software packages--typically libraries--of the +Free Software Foundation and other authors who decide to use it. You +can use it too, but we suggest you first think carefully about whether +this license or the ordinary General Public License is the better +strategy to use in any particular case, based on the explanations below. + + When we speak of free software, we are referring to freedom of use, +not price. Our General Public Licenses are designed to make sure that +you have the freedom to distribute copies of free software (and charge +for this service if you wish); that you receive source code or can get +it if you want it; that you can change the software and use pieces of +it in new free programs; and that you are informed that you can do +these things. + + To protect your rights, we need to make restrictions that forbid +distributors to deny you these rights or to ask you to surrender these +rights. These restrictions translate to certain responsibilities for +you if you distribute copies of the library or if you modify it. + + For example, if you distribute copies of the library, whether gratis +or for a fee, you must give the recipients all the rights that we gave +you. You must make sure that they, too, receive or can get the source +code. If you link other code with the library, you must provide +complete object files to the recipients, so that they can relink them +with the library after making changes to the library and recompiling +it. And you must show them these terms so they know their rights. + + We protect your rights with a two-step method: (1) we copyright the +library, and (2) we offer you this license, which gives you legal +permission to copy, distribute and/or modify the library. + + To protect each distributor, we want to make it very clear that +there is no warranty for the free library. Also, if the library is +modified by someone else and passed on, the recipients should know +that what they have is not the original version, so that the original +author's reputation will not be affected by problems that might be +introduced by others. + + Finally, software patents pose a constant threat to the existence of +any free program. We wish to make sure that a company cannot +effectively restrict the users of a free program by obtaining a +restrictive license from a patent holder. Therefore, we insist that +any patent license obtained for a version of the library must be +consistent with the full freedom of use specified in this license. + + Most GNU software, including some libraries, is covered by the +ordinary GNU General Public License. This license, the GNU Lesser +General Public License, applies to certain designated libraries, and +is quite different from the ordinary General Public License. We use +this license for certain libraries in order to permit linking those +libraries into non-free programs. + + When a program is linked with a library, whether statically or using +a shared library, the combination of the two is legally speaking a +combined work, a derivative of the original library. The ordinary +General Public License therefore permits such linking only if the +entire combination fits its criteria of freedom. The Lesser General +Public License permits more lax criteria for linking other code with +the library. + + We call this license the "Lesser" General Public License because it +does Less to protect the user's freedom than the ordinary General +Public License. It also provides other free software developers Less +of an advantage over competing non-free programs. These disadvantages +are the reason we use the ordinary General Public License for many +libraries. However, the Lesser license provides advantages in certain +special circumstances. + + For example, on rare occasions, there may be a special need to +encourage the widest possible use of a certain library, so that it becomes +a de-facto standard. To achieve this, non-free programs must be +allowed to use the library. A more frequent case is that a free +library does the same job as widely used non-free libraries. In this +case, there is little to gain by limiting the free library to free +software only, so we use the Lesser General Public License. + + In other cases, permission to use a particular library in non-free +programs enables a greater number of people to use a large body of +free software. For example, permission to use the GNU C Library in +non-free programs enables many more people to use the whole GNU +operating system, as well as its variant, the GNU/Linux operating +system. + + Although the Lesser General Public License is Less protective of the +users' freedom, it does ensure that the user of a program that is +linked with the Library has the freedom and the wherewithal to run +that program using a modified version of the Library. + + The precise terms and conditions for copying, distribution and +modification follow. Pay close attention to the difference between a +"work based on the library" and a "work that uses the library". The +former contains code derived from the library, whereas the latter must +be combined with the library in order to run. + + GNU LESSER GENERAL PUBLIC LICENSE + TERMS AND CONDITIONS FOR COPYING, DISTRIBUTION AND MODIFICATION + + 0. This License Agreement applies to any software library or other +program which contains a notice placed by the copyright holder or +other authorized party saying it may be distributed under the terms of +this Lesser General Public License (also called "this License"). +Each licensee is addressed as "you". + + A "library" means a collection of software functions and/or data +prepared so as to be conveniently linked with application programs +(which use some of those functions and data) to form executables. + + The "Library", below, refers to any such software library or work +which has been distributed under these terms. A "work based on the +Library" means either the Library or any derivative work under +copyright law: that is to say, a work containing the Library or a +portion of it, either verbatim or with modifications and/or translated +straightforwardly into another language. (Hereinafter, translation is +included without limitation in the term "modification".) + + "Source code" for a work means the preferred form of the work for +making modifications to it. For a library, complete source code means +all the source code for all modules it contains, plus any associated +interface definition files, plus the scripts used to control compilation +and installation of the library. + + Activities other than copying, distribution and modification are not +covered by this License; they are outside its scope. The act of +running a program using the Library is not restricted, and output from +such a program is covered only if its contents constitute a work based +on the Library (independent of the use of the Library in a tool for +writing it). Whether that is true depends on what the Library does +and what the program that uses the Library does. + + 1. You may copy and distribute verbatim copies of the Library's +complete source code as you receive it, in any medium, provided that +you conspicuously and appropriately publish on each copy an +appropriate copyright notice and disclaimer of warranty; keep intact +all the notices that refer to this License and to the absence of any +warranty; and distribute a copy of this License along with the Library. + + You may charge a fee for the physical act of transferring a copy, +and you may at your option offer warranty protection in exchange for a +fee. + + 2. You may modify your copy or copies of the Library or any portion +of it, thus forming a work based on the Library, and copy and +distribute such modifications or work under the terms of Section 1 +above, provided that you also meet all of these conditions: + + a) The modified work must itself be a software library. + + b) You must cause the files modified to carry prominent notices + stating that you changed the files and the date of any change. + + c) You must cause the whole of the work to be licensed at no + charge to all third parties under the terms of this License. + + d) If a facility in the modified Library refers to a function or a + table of data to be supplied by an application program that uses + the facility, other than as an argument passed when the facility + is invoked, then you must make a good faith effort to ensure that, + in the event an application does not supply such function or + table, the facility still operates, and performs whatever part of + its purpose remains meaningful. + + (For example, a function in a library to compute square roots has + a purpose that is entirely well-defined independent of the + application. Therefore, Subsection 2d requires that any + application-supplied function or table used by this function must + be optional: if the application does not supply it, the square + root function must still compute square roots.) + +These requirements apply to the modified work as a whole. If +identifiable sections of that work are not derived from the Library, +and can be reasonably considered independent and separate works in +themselves, then this License, and its terms, do not apply to those +sections when you distribute them as separate works. But when you +distribute the same sections as part of a whole which is a work based +on the Library, the distribution of the whole must be on the terms of +this License, whose permissions for other licensees extend to the +entire whole, and thus to each and every part regardless of who wrote +it. + +Thus, it is not the intent of this section to claim rights or contest +your rights to work written entirely by you; rather, the intent is to +exercise the right to control the distribution of derivative or +collective works based on the Library. + +In addition, mere aggregation of another work not based on the Library +with the Library (or with a work based on the Library) on a volume of +a storage or distribution medium does not bring the other work under +the scope of this License. + + 3. You may opt to apply the terms of the ordinary GNU General Public +License instead of this License to a given copy of the Library. To do +this, you must alter all the notices that refer to this License, so +that they refer to the ordinary GNU General Public License, version 2, +instead of to this License. (If a newer version than version 2 of the +ordinary GNU General Public License has appeared, then you can specify +that version instead if you wish.) Do not make any other change in +these notices. + + Once this change is made in a given copy, it is irreversible for +that copy, so the ordinary GNU General Public License applies to all +subsequent copies and derivative works made from that copy. + + This option is useful when you wish to copy part of the code of +the Library into a program that is not a library. + + 4. You may copy and distribute the Library (or a portion or +derivative of it, under Section 2) in object code or executable form +under the terms of Sections 1 and 2 above provided that you accompany +it with the complete corresponding machine-readable source code, which +must be distributed under the terms of Sections 1 and 2 above on a +medium customarily used for software interchange. + + If distribution of object code is made by offering access to copy +from a designated place, then offering equivalent access to copy the +source code from the same place satisfies the requirement to +distribute the source code, even though third parties are not +compelled to copy the source along with the object code. + + 5. A program that contains no derivative of any portion of the +Library, but is designed to work with the Library by being compiled or +linked with it, is called a "work that uses the Library". Such a +work, in isolation, is not a derivative work of the Library, and +therefore falls outside the scope of this License. + + However, linking a "work that uses the Library" with the Library +creates an executable that is a derivative of the Library (because it +contains portions of the Library), rather than a "work that uses the +library". The executable is therefore covered by this License. +Section 6 states terms for distribution of such executables. + + When a "work that uses the Library" uses material from a header file +that is part of the Library, the object code for the work may be a +derivative work of the Library even though the source code is not. +Whether this is true is especially significant if the work can be +linked without the Library, or if the work is itself a library. The +threshold for this to be true is not precisely defined by law. + + If such an object file uses only numerical parameters, data +structure layouts and accessors, and small macros and small inline +functions (ten lines or less in length), then the use of the object +file is unrestricted, regardless of whether it is legally a derivative +work. (Executables containing this object code plus portions of the +Library will still fall under Section 6.) + + Otherwise, if the work is a derivative of the Library, you may +distribute the object code for the work under the terms of Section 6. +Any executables containing that work also fall under Section 6, +whether or not they are linked directly with the Library itself. + + 6. As an exception to the Sections above, you may also combine or +link a "work that uses the Library" with the Library to produce a +work containing portions of the Library, and distribute that work +under terms of your choice, provided that the terms permit +modification of the work for the customer's own use and reverse +engineering for debugging such modifications. + + You must give prominent notice with each copy of the work that the +Library is used in it and that the Library and its use are covered by +this License. You must supply a copy of this License. If the work +during execution displays copyright notices, you must include the +copyright notice for the Library among them, as well as a reference +directing the user to the copy of this License. Also, you must do one +of these things: + + a) Accompany the work with the complete corresponding + machine-readable source code for the Library including whatever + changes were used in the work (which must be distributed under + Sections 1 and 2 above); and, if the work is an executable linked + with the Library, with the complete machine-readable "work that + uses the Library", as object code and/or source code, so that the + user can modify the Library and then relink to produce a modified + executable containing the modified Library. (It is understood + that the user who changes the contents of definitions files in the + Library will not necessarily be able to recompile the application + to use the modified definitions.) + + b) Use a suitable shared library mechanism for linking with the + Library. A suitable mechanism is one that (1) uses at run time a + copy of the library already present on the user's computer system, + rather than copying library functions into the executable, and (2) + will operate properly with a modified version of the library, if + the user installs one, as long as the modified version is + interface-compatible with the version that the work was made with. + + c) Accompany the work with a written offer, valid for at + least three years, to give the same user the materials + specified in Subsection 6a, above, for a charge no more + than the cost of performing this distribution. + + d) If distribution of the work is made by offering access to copy + from a designated place, offer equivalent access to copy the above + specified materials from the same place. + + e) Verify that the user has already received a copy of these + materials or that you have already sent this user a copy. + + For an executable, the required form of the "work that uses the +Library" must include any data and utility programs needed for +reproducing the executable from it. However, as a special exception, +the materials to be distributed need not include anything that is +normally distributed (in either source or binary form) with the major +components (compiler, kernel, and so on) of the operating system on +which the executable runs, unless that component itself accompanies +the executable. + + It may happen that this requirement contradicts the license +restrictions of other proprietary libraries that do not normally +accompany the operating system. Such a contradiction means you cannot +use both them and the Library together in an executable that you +distribute. + + 7. You may place library facilities that are a work based on the +Library side-by-side in a single library together with other library +facilities not covered by this License, and distribute such a combined +library, provided that the separate distribution of the work based on +the Library and of the other library facilities is otherwise +permitted, and provided that you do these two things: + + a) Accompany the combined library with a copy of the same work + based on the Library, uncombined with any other library + facilities. This must be distributed under the terms of the + Sections above. + + b) Give prominent notice with the combined library of the fact + that part of it is a work based on the Library, and explaining + where to find the accompanying uncombined form of the same work. + + 8. You may not copy, modify, sublicense, link with, or distribute +the Library except as expressly provided under this License. Any +attempt otherwise to copy, modify, sublicense, link with, or +distribute the Library is void, and will automatically terminate your +rights under this License. However, parties who have received copies, +or rights, from you under this License will not have their licenses +terminated so long as such parties remain in full compliance. + + 9. You are not required to accept this License, since you have not +signed it. However, nothing else grants you permission to modify or +distribute the Library or its derivative works. These actions are +prohibited by law if you do not accept this License. Therefore, by +modifying or distributing the Library (or any work based on the +Library), you indicate your acceptance of this License to do so, and +all its terms and conditions for copying, distributing or modifying +the Library or works based on it. + + 10. Each time you redistribute the Library (or any work based on the +Library), the recipient automatically receives a license from the +original licensor to copy, distribute, link with or modify the Library +subject to these terms and conditions. You may not impose any further +restrictions on the recipients' exercise of the rights granted herein. +You are not responsible for enforcing compliance by third parties with +this License. + + 11. If, as a consequence of a court judgment or allegation of patent +infringement or for any other reason (not limited to patent issues), +conditions are imposed on you (whether by court order, agreement or +otherwise) that contradict the conditions of this License, they do not +excuse you from the conditions of this License. If you cannot +distribute so as to satisfy simultaneously your obligations under this +License and any other pertinent obligations, then as a consequence you +may not distribute the Library at all. For example, if a patent +license would not permit royalty-free redistribution of the Library by +all those who receive copies directly or indirectly through you, then +the only way you could satisfy both it and this License would be to +refrain entirely from distribution of the Library. + +If any portion of this section is held invalid or unenforceable under any +particular circumstance, the balance of the section is intended to apply, +and the section as a whole is intended to apply in other circumstances. + +It is not the purpose of this section to induce you to infringe any +patents or other property right claims or to contest validity of any +such claims; this section has the sole purpose of protecting the +integrity of the free software distribution system which is +implemented by public license practices. Many people have made +generous contributions to the wide range of software distributed +through that system in reliance on consistent application of that +system; it is up to the author/donor to decide if he or she is willing +to distribute software through any other system and a licensee cannot +impose that choice. + +This section is intended to make thoroughly clear what is believed to +be a consequence of the rest of this License. + + 12. If the distribution and/or use of the Library is restricted in +certain countries either by patents or by copyrighted interfaces, the +original copyright holder who places the Library under this License may add +an explicit geographical distribution limitation excluding those countries, +so that distribution is permitted only in or among countries not thus +excluded. In such case, this License incorporates the limitation as if +written in the body of this License. + + 13. The Free Software Foundation may publish revised and/or new +versions of the Lesser General Public License from time to time. +Such new versions will be similar in spirit to the present version, +but may differ in detail to address new problems or concerns. + +Each version is given a distinguishing version number. If the Library +specifies a version number of this License which applies to it and +"any later version", you have the option of following the terms and +conditions either of that version or of any later version published by +the Free Software Foundation. If the Library does not specify a +license version number, you may choose any version ever published by +the Free Software Foundation. + + 14. If you wish to incorporate parts of the Library into other free +programs whose distribution conditions are incompatible with these, +write to the author to ask for permission. For software which is +copyrighted by the Free Software Foundation, write to the Free +Software Foundation; we sometimes make exceptions for this. Our +decision will be guided by the two goals of preserving the free status +of all derivatives of our free software and of promoting the sharing +and reuse of software generally. + + NO WARRANTY + + 15. BECAUSE THE LIBRARY IS LICENSED FREE OF CHARGE, THERE IS NO +WARRANTY FOR THE LIBRARY, TO THE EXTENT PERMITTED BY APPLICABLE LAW. +EXCEPT WHEN OTHERWISE STATED IN WRITING THE COPYRIGHT HOLDERS AND/OR +OTHER PARTIES PROVIDE THE LIBRARY "AS IS" WITHOUT WARRANTY OF ANY +KIND, EITHER EXPRESSED OR IMPLIED, INCLUDING, BUT NOT LIMITED TO, THE +IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR +PURPOSE. THE ENTIRE RISK AS TO THE QUALITY AND PERFORMANCE OF THE +LIBRARY IS WITH YOU. SHOULD THE LIBRARY PROVE DEFECTIVE, YOU ASSUME +THE COST OF ALL NECESSARY SERVICING, REPAIR OR CORRECTION. + + 16. IN NO EVENT UNLESS REQUIRED BY APPLICABLE LAW OR AGREED TO IN +WRITING WILL ANY COPYRIGHT HOLDER, OR ANY OTHER PARTY WHO MAY MODIFY +AND/OR REDISTRIBUTE THE LIBRARY AS PERMITTED ABOVE, BE LIABLE TO YOU +FOR DAMAGES, INCLUDING ANY GENERAL, SPECIAL, INCIDENTAL OR +CONSEQUENTIAL DAMAGES ARISING OUT OF THE USE OR INABILITY TO USE THE +LIBRARY (INCLUDING BUT NOT LIMITED TO LOSS OF DATA OR DATA BEING +RENDERED INACCURATE OR LOSSES SUSTAINED BY YOU OR THIRD PARTIES OR A +FAILURE OF THE LIBRARY TO OPERATE WITH ANY OTHER SOFTWARE), EVEN IF +SUCH HOLDER OR OTHER PARTY HAS BEEN ADVISED OF THE POSSIBILITY OF SUCH +DAMAGES. + + END OF TERMS AND CONDITIONS + + How to Apply These Terms to Your New Libraries + + If you develop a new library, and you want it to be of the greatest +possible use to the public, we recommend making it free software that +everyone can redistribute and change. You can do so by permitting +redistribution under these terms (or, alternatively, under the terms of the +ordinary General Public License). + + To apply these terms, attach the following notices to the library. It is +safest to attach them to the start of each source file to most effectively +convey the exclusion of warranty; and each file should have at least the +"copyright" line and a pointer to where the full notice is found. + + + Copyright (C) + + This library is free software; you can redistribute it and/or + modify it under the terms of the GNU Lesser General Public + License as published by the Free Software Foundation; either + version 2.1 of the License, or (at your option) any later version. + + This library is distributed in the hope that it will be useful, + but WITHOUT ANY WARRANTY; without even the implied warranty of + MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU + Lesser General Public License for more details. + + You should have received a copy of the GNU Lesser General Public + License along with this library; if not, write to the Free Software + Foundation, Inc., 59 Temple Place, Suite 330, Boston, MA 02111-1307 USA + +Also add information on how to contact you by electronic and paper mail. + +You should also get your employer (if you work as a programmer) or your +school, if any, to sign a "copyright disclaimer" for the library, if +necessary. Here is a sample; alter the names: + + Yoyodyne, Inc., hereby disclaims all copyright interest in the + library `Frob' (a library for tweaking knobs) written by James Random Hacker. + + , 1 April 1990 + Ty Coon, President of Vice + +That's all there is to it! \ No newline at end of file diff --git a/README.md b/README.md index 20bf7af..5a62a74 100644 --- a/README.md +++ b/README.md @@ -17,10 +17,6 @@ In case you'd like to build the module on your own, you can obtain a copy of the Usage ----- -You can either use the low-level `rrdtool` module (which offers almost the same functions as the old Python 2 bindings for rrdtool provided), or the `RRDtool` module, which represents a object-oriented interface to rrdtool. - -### Using the low-level `rrdtool` module - ```python import rrdtool @@ -31,30 +27,21 @@ rrdtool.create('test.rrd', '--start', 'now', '--step', '300', 'RRA:AVERAGE:0.5:1 rrdtool.update('test.rrd', 'N:32') ``` -### Using the high-level `RRDtool` module - -```python -import RRDtool - -# Create a Round Robin Database -rrd = RRDtool.create('test.rrd', '--start', 'now', '--step', '300', 'RRA:AVERAGE:0.5:1:1200', 'DS:temp:GAUGE:600:-273:5000') - -# Update the RRD -rrd.update([(None, 32)]) +Changes +------- -# Create a graph from it -rrd.graph('test.png', '--end', 'now', '--start', 'end-5minutes', '--width', '400', 'DEF:ds0a=test.rrd:temp:AVERAGE', 'LINE1:ds0a#0000FF:"temperature\l"') -# Same, but keep data in memory. -imgdata = rrd.graph(None, '--end', 'now', '--start', 'end-5minutes', '--width', '400', 'DEF:ds0a=test.rrd:temp:AVERAGE', 'LINE1:ds0a#0000FF:"temperature\l"') +## 0.1.2 -# You can also use file-like objects -from io import BytesIO -rrd.graph(io, ...) -``` +*Released 2015-08-10* -Changes -------- +* Added: xport command +* Added: lastupdate command +* Removed: High-level interface (RRDtool module) +* Improved documentation of functions +* Code cleanup by using convenience macros +* Fixed: On Python 2.x, str objects are returned instead of unicode ones +* Merged changes from upstream ## 0.1.1 diff --git a/RRDtool.py b/RRDtool.py deleted file mode 100644 index 93b3c90..0000000 --- a/RRDtool.py +++ /dev/null @@ -1,121 +0,0 @@ -#!/usr/bin/env python -# -*- coding: utf-8 -*- -# -# python-rrdtool, rrdtool bindings for Python. -# Based on the rrdtool Python bindings for Python 2 from -# Hye-Shik Chang . -# -# Copyright 2012 Christian Jurk -# -# This program is free software; you can redistribute it and/or modify -# it under the terms of the GNU Lesser General Public License as -# published by the Free Software Foundation; either version 3 of the -# License, or (at your option) any later version. -# -# This program is distributed in the hope that it will be useful, -# but WITHOUT ANY WARRANTY; without even the implied warranty of -# MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the -# GNU General Public License for more details. -# -# You should have received a copy of the GNU Lesser General Public License -# along with this program; if not, write to the Free Software -# Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston, -# MA 02110-1301, USA. -# -# - -import io -import os -import rrdtool - -from datetime import datetime -from time import mktime - -def create(filename, *args): - "Create a Round Robin Database and return a RRD object on success." - rrdtool.create(filename, *args) - - if not os.access(filename, os.F_OK): - raise rrdtool.OperationalError('RRD file was not created') - - return RRD(filename) - -class RRD: - """An object-based interface to the rrdtool module.""" - - def __init__(self, filename, check_type=True): - "Initialize the class instance with a filename." - - if not os.access(filename, os.F_OK | os.R_OK): - raise rrdtool.OperationalError('RRD {!s} cannot be opened.' \ - .format(filename)) - - # Use rrdinfo to test whether the file is a valid RRD file - if check_type is True: - rrdtool.info(filename) - - self.readonly = not os.access(filename, os.W_OK) - self.filename = filename - - def graph(self, output_file, *args): - """ - Generate a graph based on the arguments passed to this function. - - If output_file is None, "-" will be used as the output filename. - In that case, rrdtool returns the image bytes within its info dict. - """ - outfile = '-' if output_file is None else output_file - - # when writing to a file-like object, use output buffering - if isinstance(output_file, io.IOBase): - outfile = '-' - - info = rrdtool.graphv(outfile, *args) - - if isinstance(info, dict) and 'image' in info: - if isinstance(output_file, io.IOBase): - output_file.write(info['image']) - elif output_file is None: - return info['image'] - - return info - - def info(self): - return rrdtool.info(self.filename) - - def update(self, values, *args): - vl = [] - - if self.readonly: - raise rrdtool.OperationalError('RRD file is read-only: {!s}' \ - .format(self.filename)) - elif not isinstance(values, (list, tuple)): - raise rrdtool.ProgrammingError('The values parameter must be a ' \ - 'list or tuple') - else: - for row in values: - if isinstance(row, str): - vl.append(row) - elif isinstance(row, (list, tuple)): - if len(row) < 2: - raise rrdtool.ProgrammingError('Value {!r} has too ' \ - 'few elements in sequence object'.format(row)) - else: - ts = row[0] - if ts is None: - ts = 'N' - elif isinstance(ts, datetime): - ts = int(mktime(ts.timetuple())) - elif isinstance(ts, str): - ts = int(ts) - elif not isinstance(ts, int): - raise ValueError('Unsupported type') - - v = '{}:{}'.format(ts, ':'.join([str(x) for x in row[1:]])) - vl.append(v) - - arglist = tuple(vl + list(args)) - return rrdtool.update(self.filename, *arglist) - - def __repr__(self): - return ''.format(self.filename) diff --git a/rrdtoolmodule.c b/rrdtoolmodule.c index 9dececf..6248b3b 100644 --- a/rrdtoolmodule.c +++ b/rrdtoolmodule.c @@ -23,46 +23,66 @@ */ #include +#include #include -static const char *_version = "0.1.1"; +/* Some macros to maintain compatibility between Python 2.x and 3.x */ +#if PY_MAJOR_VERSION >= 3 +#define HAVE_PY3K +#define PyRRD_String_Check(x) PyUnicode_Check(x) +#define PyRRD_String_FromString(x) PyUnicode_FromString(x) +#define PyRRD_String_AS_STRING(x) PyBytes_AsString(PyUnicode_AsUTF8String(o)) +#define PyRRD_String_FromStringAndSize(x, y) PyBytes_FromStringAndSize(x, y) +#define PyRRD_Int_FromLong(x) PyLong_FromLong(x) +#else +#define PyRRD_String_Check(x) PyString_Check(x) +#define PyRRD_String_FromString(x) PyString_FromString(x) +#define PyRRD_String_AS_STRING(x) PyString_AS_STRING(x) +#define PyRRD_String_FromStringAndSize(x, y) PyString_FromStringAndSize(x, y) +#define PyRRD_Int_FromLong(x) PyInt_FromLong(x) +#endif + +/** Binding version. */ +static const char *_version = "0.1.2"; -/* Exception types */ +/** Exception types. */ static PyObject *rrdtool_OperationalError; static PyObject *rrdtool_ProgrammingError; static char **rrdtool_argv = NULL; static int rrdtool_argc = 0; -static void -destroy_args(void) -{ - PyMem_Del(rrdtool_argv); - rrdtool_argv = NULL; -} +/* extern getopt state */ +extern int optind, opterr; -/* Helper function to convert Python objects into a representation that the + +/** + * Helper function to convert Python objects into a representation that the * rrdtool functions can work with. + * + * @param command RRDtool command name + * @param args Command arguments + * @return Zero if the function succeeds, otherwise -1 */ static int convert_args(char *command, PyObject *args) { PyObject *o, *lo; - int i, j, args_count, argv_count, element_count; + int i, j, args_count, argv_count = 0, element_count = 0; args_count = PyTuple_Size(args); - element_count = 0; + for (i = 0; i < args_count; i++) { o = PyTuple_GET_ITEM(args, i); - if (PyUnicode_Check(o) || PyBytes_Check(o)) + + if (PyRRD_String_Check(o)) element_count++; else if (PyList_CheckExact(o)) element_count += PyList_Size(o); else { PyErr_Format(rrdtool_ProgrammingError, - "Argument %d must be string, bytes or list of " \ - "string/bytes", i); + "Argument %d must be str or a list of str", i); return -1; } } @@ -72,34 +92,28 @@ convert_args(char *command, PyObject *args) if (rrdtool_argv == NULL) return -1; - argv_count = 0; - for (i = 0; i < args_count; i++) { + for (i = 0, args_count = 0; i < args_count; i++) { o = PyTuple_GET_ITEM(args, i); - if (PyUnicode_Check(o)) - rrdtool_argv[++argv_count] = PyBytes_AsString( - PyUnicode_AsUTF8String(o)); - else if (PyBytes_Check(o)) - rrdtool_argv[++argv_count] = PyBytes_AS_STRING(o); + if (PyRRD_String_Check(o)) + rrdtool_argv[++argv_count] = PyRRD_String_AS_STRING(o); else if (PyList_CheckExact(o)) { for (j = 0; j < PyList_Size(o); j++) { lo = PyList_GetItem(o, j); - if (PyUnicode_Check(lo)) - rrdtool_argv[++argv_count] = PyBytes_AS_STRING( - PyUnicode_AsUTF8String(lo)); - else if (PyBytes_Check(lo)) - rrdtool_argv[++argv_count] = PyBytes_AS_STRING(lo); + + if (PyRRD_String_Check(o)) + rrdtool_argv[++argv_count] = PyRRD_String_AS_STRING(o); else { PyMem_Del(rrdtool_argv); PyErr_Format(rrdtool_ProgrammingError, - "Element %d in argument %d must be string", j, i); + "Element %d in argument %d must be str", j, i); return -1; } } } else { PyMem_Del(rrdtool_argv); PyErr_Format(rrdtool_ProgrammingError, - "Argument %d must be string or list of strings", i); + "Argument %d must be str or list of str", i); return -1; } } @@ -107,9 +121,32 @@ convert_args(char *command, PyObject *args) rrdtool_argv[0] = command; rrdtool_argc = element_count + 1; + for (i = 0; i < rrdtool_argc; i++) { + fprintf(stderr, "argv[%d] = '%s'\n", i, rrdtool_argv[i]); + } + + /* reset getopt state */ + opterr = optind = 0; + return 0; } +/** + * Destroy argument vector. + */ +static void +destroy_args(void) +{ + PyMem_Del(rrdtool_argv); + rrdtool_argv = NULL; +} + +/** + * Convert RRDtool info to dict. + * + * @param data RRDtool info object + * @return Python dict object + */ static PyObject * _rrdtool_util_info2dict(const rrd_info_t *data) { @@ -138,17 +175,13 @@ _rrdtool_util_info2dict(const rrd_info_t *data) break; case RD_I_STR: - val = PyUnicode_FromString(data->value.u_str); + val = PyRRD_String_FromString(data->value.u_str); break; case RD_I_BLO: -#if PY_MAJOR_VERSION >= 3 - val = PyBytes_FromStringAndSize( - (char *)data->value.u_blo.ptr, data->value.u_blo.size); -#else - val = PyString_FromStringAndSize( - (char *)data->value.u_blo.ptr, data->value.u_blo.size); -#endif + val = PyRRD_String_FromStringAndSize( + (char *)data->value.u_blo.ptr, + data->value.u_blo.size); break; default: break; @@ -169,9 +202,13 @@ static char _rrdtool_create__doc__[] = "Create a new Round Robin Database.\n\n\ Usage: create(args...)\n\ Arguments:\n\n\ filename\n\ - [--start|-b start time]\n\ - [--step|-s step]\n\ - [DS:ds-name:DST:heartbeat:min:max]\n\ + [-b|--start start time]\n\ + [-s|--step step]\n\ + [-t|--template temolate-file]\n\ + [-r|--source source-file]\n\ + [-O|--no-overwrite]\n\ + [-d|--daemon address]\n\ + [DS:ds-name[=mapped-ds-name[source-index]]:DST:heartbeat:min:max]\n\ [RRA:CF:xff:steps:rows]\n\n\ Full documentation can be found at:\n\ http://oss.oetiker.ch/rrdtool/doc/rrdcreate.en.html"; @@ -201,7 +238,8 @@ static char _rrdtool_dump__doc__[] = "Dump an RRD to XML.\n\n\ Usage: dump(args..)\n\ Arguments:\n\n\ [-h|--header {none,xsd,dtd}\n\ - [--no-header]\n\ + [-n|--no-header]\n\ + [-d|--daemon address]\n\ file.rrd\n\ [file.xml]\n\n\ Full documentation can be found at:\n\ @@ -292,9 +330,11 @@ static char _rrdtool_fetch__doc__[] = "Fetch data from an RRD.\n\n\ Arguments:\n\n\ filename\n\ CF\n\ - [--resolution|-r resolution]\n\ - [--start|-s start]\n\ - [--end|-e end]\n\n\ + [-r|--resolution resolution]\n\ + [-s|--start start]\n\ + [-e|--end end]\n\ + [-a|--align-start]\n\ + [-d|--daemon address]\n\n\ Full documentation can be found at:\n\ http://oss.oetiker.ch/rrdtool/doc/rrdfetch.en.html"; @@ -328,12 +368,12 @@ _rrdtool_fetch(PyObject *self, PyObject *args) datai = data; - PyTuple_SET_ITEM(range_tup, 0, PyLong_FromLong((long)start)); - PyTuple_SET_ITEM(range_tup, 1, PyLong_FromLong((long)end)); - PyTuple_SET_ITEM(range_tup, 2, PyLong_FromLong((long)step)); + PyTuple_SET_ITEM(range_tup, 0, PyRRD_Int_FromLong((long) start)); + PyTuple_SET_ITEM(range_tup, 1, PyRRD_Int_FromLong((long) end)); + PyTuple_SET_ITEM(range_tup, 2, PyRRD_Int_FromLong((long) step)); for (i = 0; i < ds_cnt; i++) - PyTuple_SET_ITEM(dsnam_tup, i, PyUnicode_FromString(ds_namv[i])); + PyTuple_SET_ITEM(dsnam_tup, i, PyRRD_String_FromString(ds_namv[i])); for (i = 0; i < row; i++) { t = PyTuple_New(ds_cnt); @@ -345,7 +385,7 @@ _rrdtool_fetch(PyObject *self, PyObject *args) PyTuple_SET_ITEM(t, j, Py_None); Py_INCREF(Py_None); } else - PyTuple_SET_ITEM(t, j, PyFloat_FromDouble((double)dv)); + PyTuple_SET_ITEM(t, j, PyFloat_FromDouble((double) dv)); } } @@ -363,7 +403,7 @@ _rrdtool_fetch(PyObject *self, PyObject *args) static char _rrdtool_flushcached__doc__[] = "Flush RRD files from memory.\n\n\ Usage: flushcached(args..)\n\ Arguments:\n\n\ - [--daemon address]\n\ + [-d|--daemon address]\n\ filename\n\ [filename ...]\n\n\ Full documentation can be found at:\n\ @@ -390,6 +430,7 @@ _rrdtool_flushcached(PyObject *self, PyObject *args) return ret; } +#ifdef HAVE_RRD_GRAPH static char _rrdtool_graph__doc__[] = "Create a graph based on one or more " \ "RRDs.\n\n\ Usage: graph(args..)\n\ @@ -413,6 +454,9 @@ static char _rrdtool_graph__doc__[] = "Create a graph based on one or more " \ [-N|--no-gridfit]\n\ [-x|--x-grid (GTM:GST:MTM:MST:LTM:LST:LPR:LFM|none)]\n\ [-y|--y-grid (grid step:label factor|none)]\n\ + [--week-fmt strftime format string]\n\ + [--left-axis-formatter formatter-name]\n\ + [--left-axis-format format-string]\n\ [-Y|--alt-y-grid]\n\ [-o|--logarithmic]\n\ [-X|--units-exponent value]\n\ @@ -426,7 +470,7 @@ static char _rrdtool_graph__doc__[] = "Create a graph based on one or more " \ [--legend-position=(north|south|west|east)]\n\ [--legend-direction=(topdown|bottomup)]\n\ [-z|--lazy]\n\ - [--daemon address]\n\ + [-d|--daemon address]\n\ [-f|--imginfo printfstr]\n\ [-c|--color COLORTAG#rrggbb[aa]]\n\ [--grid-dash on:off]\n\ @@ -439,10 +483,12 @@ static char _rrdtool_graph__doc__[] = "Create a graph based on one or more " \ [-P|--pango-markup]\n\ [-G|--graph-render-mode {normal,mono}]\n\ [-E|--slope-mode]\n\ - [-a|--imgformat {PNG,SVG,EPS,PDF}]\n\ + [-a|--imgformat {PNG,SVG,EPS,PDF,XML,XMLENUM,JSON,JSONTIME,CSV,TSV,SSV}]\n\ + [-i|--interlaced]\n\ [-T|--tabwidth value]\n\ [-b|--base value]\n\ [-W|--watermark string]\n\ + [-Z|--use-nan-for-all-missing-data]\n\ DEF:vname=rrdfile:ds-name:CF[:step=step][:start=time][:end=time]\n\ CDEF:vname=RPN expression\n\ VDEF=vname:RPN expression\n\n\ @@ -468,8 +514,8 @@ _rrdtool_graph(PyObject *self, PyObject *args, PyObject *kwargs) } else { ret = PyTuple_New(3); - PyTuple_SET_ITEM(ret, 0, PyLong_FromLong((long)xsize)); - PyTuple_SET_ITEM(ret, 1, PyLong_FromLong((long)ysize)); + PyTuple_SET_ITEM(ret, 0, PyRRD_Int_FromLong((long) xsize)); + PyTuple_SET_ITEM(ret, 1, PyRRD_Int_FromLong((long) ysize)); if (calcpr) { PyObject *e, *t; @@ -478,7 +524,7 @@ _rrdtool_graph(PyObject *self, PyObject *args, PyObject *kwargs) PyTuple_SET_ITEM(ret, 2, e); for (i = 0; calcpr[i]; i++) { - t = PyUnicode_FromString(calcpr[i]); + t = PyRRD_String_FromString(calcpr[i]); PyList_Append(e, t); Py_DECREF(t); rrd_freemem(calcpr[i]); @@ -493,10 +539,12 @@ _rrdtool_graph(PyObject *self, PyObject *args, PyObject *kwargs) return ret; } -static char _rrdtool_graphv__doc__[] = "Create a graph based on one or more "\ - "RRDs and return header information.\n\n\ - This function works in the same manner as 'graph', but will return a info\n\ - dictionary instead of None."; +static char _rrdtool_graphv__doc__[] = "Create a graph based on one or more " \ + "RRDs and return data in RRDtool info format.\n\n\ + This function works the same way as 'graph', but will return a info\n\ + dictionary instead of None.\n\n\ + Full documentation can be found at (graphv section):\n\ + http://oss.oetiker.ch/rrdtool/doc/rrdgraph.en.html"; static PyObject * _rrdtool_graphv(PyObject *self, PyObject *args) @@ -520,6 +568,107 @@ _rrdtool_graphv(PyObject *self, PyObject *args) return ret; } +static char _rrdtool_xport__doc__[] = "Dictionary representation of data " \ + "stored in RRDs.\n\n\ + Usage: xport(args..)\n\ + Arguments:\n\n\ + [-s[--start seconds]\n\ + [-e|--end seconds]\n\ + [-m|--maxrows rows]\n\ + [--step value]\n\ + [--json]\n\ + [--enumds]\n\ + [--daemon address]\n\ + [DEF:vname=rrd:ds-name:CF]\n\ + [CDEF:vname=rpn-expression]\n\ + [XPORT:vname[:legend]]\n\n\ + Full documentation can be found at:\n\ + http://oss.oetiker.ch/rrdtool/doc/rrdxport.en.html"; + +static PyObject * +_rrdtool_xport(PyObject *self, PyObject *args) +{ + PyObject *ret; + int xsize; + char **legend_v; + time_t start, end; + unsigned long step, col_cnt; + rrd_value_t *data, *datai; + + if (convert_args("xport", args) == -1) + return NULL; + + if (rrd_xport(rrdtool_argc, rrdtool_argv, &xsize, &start, &end, &step, + &col_cnt, &legend_v, &data) == -1) { + PyErr_SetString(rrdtool_OperationalError, rrd_get_error()); + rrd_clear_error(); + ret = NULL; + } else { + PyObject *meta_dict, *data_list, *legend_list, *t; + rrd_value_t dv; + unsigned long i, j, row_cnt = (end - start) / step; + + ret = PyDict_New(); + meta_dict = PyDict_New(); + legend_list = PyList_New(col_cnt); + data_list = PyList_New(row_cnt); + + PyDict_SetItem(ret, PyRRD_String_FromString("meta"), meta_dict); + PyDict_SetItem(ret, PyRRD_String_FromString("data"), data_list); + + datai = data; + + PyDict_SetItem(meta_dict, + PyRRD_String_FromString("start"), + PyRRD_Int_FromLong((long) start)); + PyDict_SetItem(meta_dict, + PyRRD_String_FromString("end"), + PyRRD_Int_FromLong((long) end)); + PyDict_SetItem(meta_dict, + PyRRD_String_FromString("step"), + PyRRD_Int_FromLong((long) step)); + PyDict_SetItem(meta_dict, + PyRRD_String_FromString("rows"), + PyRRD_Int_FromLong((long) row_cnt)); + PyDict_SetItem(meta_dict, + PyRRD_String_FromString("columns"), + PyRRD_Int_FromLong((long) col_cnt)); + PyDict_SetItem(meta_dict, + PyRRD_String_FromString("legend"), + legend_list); + + for (i = 0; i < col_cnt; i++) + PyList_SET_ITEM(legend_list, i, PyRRD_String_FromString(legend_v[i])); + + for (i = 0; i < row_cnt; i++) { + t = PyTuple_New(col_cnt); + PyList_SET_ITEM(data_list, i, t); + + for (j = 0; j < col_cnt; j++) { + dv = *(datai++); + + if (isnan(dv)) { + PyTuple_SET_ITEM(t, j, Py_None); + Py_INCREF(Py_None); + } else { + PyTuple_SET_ITEM(t, j, PyFloat_FromDouble((double) dv)); + } + } + } + + for (i = 0; i < col_cnt; i++) + rrd_freemem(legend_v[i]); + + rrd_freemem(legend_v); + rrd_freemem(data); + } + + destroy_args(); + + return ret; +} +#endif /* HAVE_RRD_GRAPH */ + static char _rrdtool_tune__doc__[] = "Modify some basic properties of a " \ "Round Robin Database.\n\n\ Usage: tune(args..)\n\ @@ -559,7 +708,8 @@ static char _rrdtool_first__doc__[] = "Get the first UNIX timestamp of the "\ Usage: first(args..)\n\ Arguments:\n\n\ filename\n\ - [--rraindex number]\n\n\ + [--rraindex number]\n\ + [-d|--daemon address]\n\n\ Full documentation can be found at:\n\ http://oss.oetiker.ch/rrdtool/doc/rrdfirst.en.html"; @@ -577,7 +727,7 @@ _rrdtool_first(PyObject *self, PyObject *args) rrd_clear_error(); ret = NULL; } else - ret = PyLong_FromLong((long)ts); + ret = PyRRD_Int_FromLong((long) ts); destroy_args(); return ret; @@ -588,7 +738,7 @@ static char _rrdtool_last__doc__[] = "Get the UNIX timestamp of the most "\ Usage: last(args..)\n\ Arguments:\n\n\ filename\n\ - [--daemon address]\n\n\ + [-d|--daemon address]\n\n\ Full documentation can be found at:\n\ http://oss.oetiker.ch/rrdtool/doc/rrdlast.en.html"; @@ -606,7 +756,7 @@ _rrdtool_last(PyObject *self, PyObject *args) rrd_clear_error(); ret = NULL; } else - ret = PyLong_FromLong((long)ts); + ret = PyRRD_Int_FromLong((long) ts); destroy_args(); return ret; @@ -647,9 +797,11 @@ _rrdtool_resize(PyObject *self, PyObject *args) static char _rrdtool_info__doc__[] = "Extract header information from an "\ "Round Robin Database.\n\n\ - Usage: info(filename)\n\ + Usage: info(filename, ...)\n\ Arguments:\n\n\ - filename\n\n\ + filename\n\ + [-d|--daemon address]\n\ + [-F|--noflush]\n\n\ Full documentation can be found at:\n\ http://oss.oetiker.ch/rrdtool/doc/rrdinfo.en.html"; @@ -675,15 +827,97 @@ _rrdtool_info(PyObject *self, PyObject *args) return ret; } +static char _rrdtool_lastupdate__doc__[] = "Returns datetime and value stored "\ + "for each datum in the most recent update of an RRD.\n\n\ + Usage: lastupdate(filename, ...)\n\ + Arguments:\n\n\ + filename\n\ + [-d|--daemon address]\n\n\ + Full documentation can be found at:\n\ + http://oss.oetiker.ch/rrdtool/doc/rrdlastupdate.en.html"; + +static PyObject * +_rrdtool_lastupdate(PyObject *self, PyObject *args) +{ + PyObject *ret, *ds_dict; + rrd_info_t *data; + int status; + time_t last_update; + char **ds_names, **last_ds; + unsigned long ds_cnt, i; + + if (convert_args("lastupdate", args) == -1) + return NULL; + else if (rrdtool_argc < 2) { + PyErr_SetString(rrdtool_ProgrammingError, "Required arguments missing"); + return NULL; + } + + printf("Using '%s'\n", rrdtool_argv[1]); + + status = rrd_lastupdate_r(rrdtool_argv[1], + &last_update, + &ds_cnt, + &ds_names, + &last_ds); + + if (status != 0) { + PyErr_SetString(rrdtool_OperationalError, rrd_get_error()); + rrd_clear_error(); + ret = NULL; + } else { + /* convert last_update to Python datetime object */ + struct tm *ts = localtime(&last_update); + ret = PyDict_New(); + ds_dict = PyDict_New(); + + PyDict_SetItemString(ret, + PyRRD_String_FromString("date"), + PyDateTime_FromDateAndTime( + ts->tm_year + 1900, + ts->tm_mon + 1, + ts->tm_mday, + ts->tm_hour, + ts->tm_min, + ts->tm_sec, + 0)); + PyDict_SetItemString(ret, + PyRRD_String_FromString("ds"), + ds_dict); + + for (i = 0; i < ds_cnt; i++) { + PyDict_SetItemString(ds_dict, + PyRRD_String_FromString(ds_names[i]), + PyLong_FromString(last_ds[i], NULL, 10)); + free(last_ds[i]); + free(ds_names[i]); + } + + free(last_ds); + free(ds_names); + + } + + destroy_args(); + + return ret; +} + static char _rrdtool_lib_version__doc__[] = "Get the version this binding "\ "was compiled against."; +/** + * Returns a str object that contains the librrd version. + * + * @return librrd version (Python str object) + */ static PyObject * _rrdtool_lib_version(PyObject *self, PyObject *args) { - return PyUnicode_FromString(rrd_strversion()); + return PyRRD_String_FromString(rrd_strversion()); } +/** Method table. */ static PyMethodDef rrdtool_methods[] = { {"create", (PyCFunction)_rrdtool_create, METH_VARARGS, _rrdtool_create__doc__}, @@ -697,10 +931,14 @@ static PyMethodDef rrdtool_methods[] = { METH_VARARGS, _rrdtool_fetch__doc__}, {"flushcached", (PyCFunction)_rrdtool_flushcached, METH_VARARGS, _rrdtool_flushcached__doc__}, +#ifdef HAVE_RRD_GRAPH {"graph", (PyCFunction)_rrdtool_graph, METH_VARARGS, _rrdtool_graph__doc__}, {"graphv", (PyCFunction)_rrdtool_graphv, METH_VARARGS, _rrdtool_graphv__doc__}, + {"xport", (PyCFunction)_rrdtool_xport, + METH_VARARGS, _rrdtool_xport__doc__}, +#endif {"tune", (PyCFunction)_rrdtool_tune, METH_VARARGS, _rrdtool_tune__doc__}, {"first", (PyCFunction)_rrdtool_first, @@ -711,24 +949,26 @@ static PyMethodDef rrdtool_methods[] = { METH_VARARGS, _rrdtool_resize__doc__}, {"info", (PyCFunction)_rrdtool_info, METH_VARARGS, _rrdtool_info__doc__}, + {"lastupdate", (PyCFunction)_rrdtool_lastupdate, + METH_VARARGS, _rrdtool_lastupdate__doc__}, {"lib_version", (PyCFunction)_rrdtool_lib_version, METH_VARARGS, _rrdtool_lib_version__doc__}, {NULL, NULL, 0, NULL} }; -#if PY_MAJOR_VERSION >= 3 - +/** Library init function. */ +#ifdef HAVE_PY3K static struct PyModuleDef rrdtoolmodule = { PyModuleDef_HEAD_INIT, "rrdtool", - "rrdtool bindings for Python 3", + "rrdtool bindings for Python", -1, rrdtool_methods }; #endif -#if PY_MAJOR_VERSION >= 3 +#ifdef HAVE_PY3K PyMODINIT_FUNC PyInit_rrdtool(void) #else @@ -738,7 +978,9 @@ initrrdtool(void) { PyObject *m; -#if PY_MAJOR_VERSION >= 3 + PyDateTime_IMPORT; /* initialize PyDateTime_ functions */ + +#ifdef HAVE_PY3K m = PyModule_Create(&rrdtoolmodule); #else m = Py_InitModule3("rrdtool", @@ -747,7 +989,7 @@ initrrdtool(void) #endif if (m == NULL) -#if PY_MAJOR_VERSION >= 3 +#ifdef HAVE_PY3K return NULL; #else return; @@ -762,9 +1004,9 @@ initrrdtool(void) NULL, NULL); Py_INCREF(rrdtool_OperationalError); PyModule_AddObject(m, "OperationalError", rrdtool_OperationalError); - PyModule_AddObject(m, "__version__", PyUnicode_FromString(_version)); + PyModule_AddObject(m, "__version__", PyRRD_String_FromString(_version)); -#if PY_MAJOR_VERSION >= 3 - return m; +#ifdef HAVE_PY3K + return m; #endif } diff --git a/setup.py b/setup.py index 7637dac..0dc81cf 100644 --- a/setup.py +++ b/setup.py @@ -1,4 +1,8 @@ -from distutils.core import setup, Extension +try: + from setuptools import setup + from setuptools.extension import Extension +except ImportError: + from distutils.core import setup, Extension def main(): module = Extension('rrdtool', @@ -8,13 +12,14 @@ def main(): kwargs = dict( name='python-rrdtool', - version='0.1.1', + version='0.1.2', description='rrdtool bindings for Python', keywords=['rrdtool'], author='Christian Jurk, Hye-Shik Chang', author_email='commx@commx.ws', + license='GPL', + url='https://github.com/commx/python-rrdtool', ext_modules=[module], - py_modules=['RRDtool'] ) setup(**kwargs)