--- /dev/null
+ GNU GENERAL PUBLIC LICENSE
+ Version 3, 29 June 2007
+
+ Copyright (C) 2007 Free Software Foundation, Inc. <http://fsf.org/>
+ Everyone is permitted to copy and distribute verbatim copies
+ of this license document, but changing it is not allowed.
+
+ Preamble
+
+ The GNU General Public License is a free, copyleft license for
+software and other kinds of works.
+
+ The licenses for most software and other practical works are designed
+to take away your freedom to share and change the works. By contrast,
+the GNU General Public License is intended to guarantee your freedom to
+share and change all versions of a program--to make sure it remains free
+software for all its users. We, the Free Software Foundation, use the
+GNU General Public License for most of our software; it applies also to
+any other work released this way by its authors. You can apply it to
+your programs, too.
+
+ When we speak of free software, we are referring to freedom, 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
+them if you wish), that you receive source code or can get it if you
+want it, that you can change the software or use pieces of it in new
+free programs, and that you know you can do these things.
+
+ To protect your rights, we need to prevent others from denying you
+these rights or asking you to surrender the rights. Therefore, you have
+certain responsibilities if you distribute copies of the software, or if
+you modify it: responsibilities to respect the freedom of others.
+
+ For example, if you distribute copies of such a program, whether
+gratis or for a fee, you must pass on to the recipients the same
+freedoms that you received. You must make sure that they, too, receive
+or can get the source code. And you must show them these terms so they
+know their rights.
+
+ Developers that use the GNU GPL protect your rights with two steps:
+(1) assert copyright on the software, and (2) offer you this License
+giving you legal permission to copy, distribute and/or modify it.
+
+ For the developers' and authors' protection, the GPL clearly explains
+that there is no warranty for this free software. For both users' and
+authors' sake, the GPL requires that modified versions be marked as
+changed, so that their problems will not be attributed erroneously to
+authors of previous versions.
+
+ Some devices are designed to deny users access to install or run
+modified versions of the software inside them, although the manufacturer
+can do so. This is fundamentally incompatible with the aim of
+protecting users' freedom to change the software. The systematic
+pattern of such abuse occurs in the area of products for individuals to
+use, which is precisely where it is most unacceptable. Therefore, we
+have designed this version of the GPL to prohibit the practice for those
+products. If such problems arise substantially in other domains, we
+stand ready to extend this provision to those domains in future versions
+of the GPL, as needed to protect the freedom of users.
+
+ Finally, every program is threatened constantly by software patents.
+States should not allow patents to restrict development and use of
+software on general-purpose computers, but in those that do, we wish to
+avoid the special danger that patents applied to a free program could
+make it effectively proprietary. To prevent this, the GPL assures that
+patents cannot be used to render the program non-free.
+
+ The precise terms and conditions for copying, distribution and
+modification follow.
+
+ TERMS AND CONDITIONS
+
+ 0. Definitions.
+
+ "This License" refers to version 3 of the GNU General Public License.
+
+ "Copyright" also means copyright-like laws that apply to other kinds of
+works, such as semiconductor masks.
+
+ "The Program" refers to any copyrightable work licensed under this
+License. Each licensee is addressed as "you". "Licensees" and
+"recipients" may be individuals or organizations.
+
+ To "modify" a work means to copy from or adapt all or part of the work
+in a fashion requiring copyright permission, other than the making of an
+exact copy. The resulting work is called a "modified version" of the
+earlier work or a work "based on" the earlier work.
+
+ A "covered work" means either the unmodified Program or a work based
+on the Program.
+
+ To "propagate" a work means to do anything with it that, without
+permission, would make you directly or secondarily liable for
+infringement under applicable copyright law, except executing it on a
+computer or modifying a private copy. Propagation includes copying,
+distribution (with or without modification), making available to the
+public, and in some countries other activities as well.
+
+ To "convey" a work means any kind of propagation that enables other
+parties to make or receive copies. Mere interaction with a user through
+a computer network, with no transfer of a copy, is not conveying.
+
+ An interactive user interface displays "Appropriate Legal Notices"
+to the extent that it includes a convenient and prominently visible
+feature that (1) displays an appropriate copyright notice, and (2)
+tells the user that there is no warranty for the work (except to the
+extent that warranties are provided), that licensees may convey the
+work under this License, and how to view a copy of this License. If
+the interface presents a list of user commands or options, such as a
+menu, a prominent item in the list meets this criterion.
+
+ 1. Source Code.
+
+ The "source code" for a work means the preferred form of the work
+for making modifications to it. "Object code" means any non-source
+form of a work.
+
+ A "Standard Interface" means an interface that either is an official
+standard defined by a recognized standards body, or, in the case of
+interfaces specified for a particular programming language, one that
+is widely used among developers working in that language.
+
+ The "System Libraries" of an executable work include anything, other
+than the work as a whole, that (a) is included in the normal form of
+packaging a Major Component, but which is not part of that Major
+Component, and (b) serves only to enable use of the work with that
+Major Component, or to implement a Standard Interface for which an
+implementation is available to the public in source code form. A
+"Major Component", in this context, means a major essential component
+(kernel, window system, and so on) of the specific operating system
+(if any) on which the executable work runs, or a compiler used to
+produce the work, or an object code interpreter used to run it.
+
+ The "Corresponding Source" for a work in object code form means all
+the source code needed to generate, install, and (for an executable
+work) run the object code and to modify the work, including scripts to
+control those activities. However, it does not include the work's
+System Libraries, or general-purpose tools or generally available free
+programs which are used unmodified in performing those activities but
+which are not part of the work. For example, Corresponding Source
+includes interface definition files associated with source files for
+the work, and the source code for shared libraries and dynamically
+linked subprograms that the work is specifically designed to require,
+such as by intimate data communication or control flow between those
+subprograms and other parts of the work.
+
+ The Corresponding Source need not include anything that users
+can regenerate automatically from other parts of the Corresponding
+Source.
+
+ The Corresponding Source for a work in source code form is that
+same work.
+
+ 2. Basic Permissions.
+
+ All rights granted under this License are granted for the term of
+copyright on the Program, and are irrevocable provided the stated
+conditions are met. This License explicitly affirms your unlimited
+permission to run the unmodified Program. The output from running a
+covered work is covered by this License only if the output, given its
+content, constitutes a covered work. This License acknowledges your
+rights of fair use or other equivalent, as provided by copyright law.
+
+ You may make, run and propagate covered works that you do not
+convey, without conditions so long as your license otherwise remains
+in force. You may convey covered works to others for the sole purpose
+of having them make modifications exclusively for you, or provide you
+with facilities for running those works, provided that you comply with
+the terms of this License in conveying all material for which you do
+not control copyright. Those thus making or running the covered works
+for you must do so exclusively on your behalf, under your direction
+and control, on terms that prohibit them from making any copies of
+your copyrighted material outside their relationship with you.
+
+ Conveying under any other circumstances is permitted solely under
+the conditions stated below. Sublicensing is not allowed; section 10
+makes it unnecessary.
+
+ 3. Protecting Users' Legal Rights From Anti-Circumvention Law.
+
+ No covered work shall be deemed part of an effective technological
+measure under any applicable law fulfilling obligations under article
+11 of the WIPO copyright treaty adopted on 20 December 1996, or
+similar laws prohibiting or restricting circumvention of such
+measures.
+
+ When you convey a covered work, you waive any legal power to forbid
+circumvention of technological measures to the extent such circumvention
+is effected by exercising rights under this License with respect to
+the covered work, and you disclaim any intention to limit operation or
+modification of the work as a means of enforcing, against the work's
+users, your or third parties' legal rights to forbid circumvention of
+technological measures.
+
+ 4. Conveying Verbatim Copies.
+
+ You may convey verbatim copies of the Program's source code as you
+receive it, in any medium, provided that you conspicuously and
+appropriately publish on each copy an appropriate copyright notice;
+keep intact all notices stating that this License and any
+non-permissive terms added in accord with section 7 apply to the code;
+keep intact all notices of the absence of any warranty; and give all
+recipients a copy of this License along with the Program.
+
+ You may charge any price or no price for each copy that you convey,
+and you may offer support or warranty protection for a fee.
+
+ 5. Conveying Modified Source Versions.
+
+ You may convey a work based on the Program, or the modifications to
+produce it from the Program, in the form of source code under the
+terms of section 4, provided that you also meet all of these conditions:
+
+ a) The work must carry prominent notices stating that you modified
+ it, and giving a relevant date.
+
+ b) The work must carry prominent notices stating that it is
+ released under this License and any conditions added under section
+ 7. This requirement modifies the requirement in section 4 to
+ "keep intact all notices".
+
+ c) You must license the entire work, as a whole, under this
+ License to anyone who comes into possession of a copy. This
+ License will therefore apply, along with any applicable section 7
+ additional terms, to the whole of the work, and all its parts,
+ regardless of how they are packaged. This License gives no
+ permission to license the work in any other way, but it does not
+ invalidate such permission if you have separately received it.
+
+ d) If the work has interactive user interfaces, each must display
+ Appropriate Legal Notices; however, if the Program has interactive
+ interfaces that do not display Appropriate Legal Notices, your
+ work need not make them do so.
+
+ A compilation of a covered work with other separate and independent
+works, which are not by their nature extensions of the covered work,
+and which are not combined with it such as to form a larger program,
+in or on a volume of a storage or distribution medium, is called an
+"aggregate" if the compilation and its resulting copyright are not
+used to limit the access or legal rights of the compilation's users
+beyond what the individual works permit. Inclusion of a covered work
+in an aggregate does not cause this License to apply to the other
+parts of the aggregate.
+
+ 6. Conveying Non-Source Forms.
+
+ You may convey a covered work in object code form under the terms
+of sections 4 and 5, provided that you also convey the
+machine-readable Corresponding Source under the terms of this License,
+in one of these ways:
+
+ a) Convey the object code in, or embodied in, a physical product
+ (including a physical distribution medium), accompanied by the
+ Corresponding Source fixed on a durable physical medium
+ customarily used for software interchange.
+
+ b) Convey the object code in, or embodied in, a physical product
+ (including a physical distribution medium), accompanied by a
+ written offer, valid for at least three years and valid for as
+ long as you offer spare parts or customer support for that product
+ model, to give anyone who possesses the object code either (1) a
+ copy of the Corresponding Source for all the software in the
+ product that is covered by this License, on a durable physical
+ medium customarily used for software interchange, for a price no
+ more than your reasonable cost of physically performing this
+ conveying of source, or (2) access to copy the
+ Corresponding Source from a network server at no charge.
+
+ c) Convey individual copies of the object code with a copy of the
+ written offer to provide the Corresponding Source. This
+ alternative is allowed only occasionally and noncommercially, and
+ only if you received the object code with such an offer, in accord
+ with subsection 6b.
+
+ d) Convey the object code by offering access from a designated
+ place (gratis or for a charge), and offer equivalent access to the
+ Corresponding Source in the same way through the same place at no
+ further charge. You need not require recipients to copy the
+ Corresponding Source along with the object code. If the place to
+ copy the object code is a network server, the Corresponding Source
+ may be on a different server (operated by you or a third party)
+ that supports equivalent copying facilities, provided you maintain
+ clear directions next to the object code saying where to find the
+ Corresponding Source. Regardless of what server hosts the
+ Corresponding Source, you remain obligated to ensure that it is
+ available for as long as needed to satisfy these requirements.
+
+ e) Convey the object code using peer-to-peer transmission, provided
+ you inform other peers where the object code and Corresponding
+ Source of the work are being offered to the general public at no
+ charge under subsection 6d.
+
+ A separable portion of the object code, whose source code is excluded
+from the Corresponding Source as a System Library, need not be
+included in conveying the object code work.
+
+ A "User Product" is either (1) a "consumer product", which means any
+tangible personal property which is normally used for personal, family,
+or household purposes, or (2) anything designed or sold for incorporation
+into a dwelling. In determining whether a product is a consumer product,
+doubtful cases shall be resolved in favor of coverage. For a particular
+product received by a particular user, "normally used" refers to a
+typical or common use of that class of product, regardless of the status
+of the particular user or of the way in which the particular user
+actually uses, or expects or is expected to use, the product. A product
+is a consumer product regardless of whether the product has substantial
+commercial, industrial or non-consumer uses, unless such uses represent
+the only significant mode of use of the product.
+
+ "Installation Information" for a User Product means any methods,
+procedures, authorization keys, or other information required to install
+and execute modified versions of a covered work in that User Product from
+a modified version of its Corresponding Source. The information must
+suffice to ensure that the continued functioning of the modified object
+code is in no case prevented or interfered with solely because
+modification has been made.
+
+ If you convey an object code work under this section in, or with, or
+specifically for use in, a User Product, and the conveying occurs as
+part of a transaction in which the right of possession and use of the
+User Product is transferred to the recipient in perpetuity or for a
+fixed term (regardless of how the transaction is characterized), the
+Corresponding Source conveyed under this section must be accompanied
+by the Installation Information. But this requirement does not apply
+if neither you nor any third party retains the ability to install
+modified object code on the User Product (for example, the work has
+been installed in ROM).
+
+ The requirement to provide Installation Information does not include a
+requirement to continue to provide support service, warranty, or updates
+for a work that has been modified or installed by the recipient, or for
+the User Product in which it has been modified or installed. Access to a
+network may be denied when the modification itself materially and
+adversely affects the operation of the network or violates the rules and
+protocols for communication across the network.
+
+ Corresponding Source conveyed, and Installation Information provided,
+in accord with this section must be in a format that is publicly
+documented (and with an implementation available to the public in
+source code form), and must require no special password or key for
+unpacking, reading or copying.
+
+ 7. Additional Terms.
+
+ "Additional permissions" are terms that supplement the terms of this
+License by making exceptions from one or more of its conditions.
+Additional permissions that are applicable to the entire Program shall
+be treated as though they were included in this License, to the extent
+that they are valid under applicable law. If additional permissions
+apply only to part of the Program, that part may be used separately
+under those permissions, but the entire Program remains governed by
+this License without regard to the additional permissions.
+
+ When you convey a copy of a covered work, you may at your option
+remove any additional permissions from that copy, or from any part of
+it. (Additional permissions may be written to require their own
+removal in certain cases when you modify the work.) You may place
+additional permissions on material, added by you to a covered work,
+for which you have or can give appropriate copyright permission.
+
+ Notwithstanding any other provision of this License, for material you
+add to a covered work, you may (if authorized by the copyright holders of
+that material) supplement the terms of this License with terms:
+
+ a) Disclaiming warranty or limiting liability differently from the
+ terms of sections 15 and 16 of this License; or
+
+ b) Requiring preservation of specified reasonable legal notices or
+ author attributions in that material or in the Appropriate Legal
+ Notices displayed by works containing it; or
+
+ c) Prohibiting misrepresentation of the origin of that material, or
+ requiring that modified versions of such material be marked in
+ reasonable ways as different from the original version; or
+
+ d) Limiting the use for publicity purposes of names of licensors or
+ authors of the material; or
+
+ e) Declining to grant rights under trademark law for use of some
+ trade names, trademarks, or service marks; or
+
+ f) Requiring indemnification of licensors and authors of that
+ material by anyone who conveys the material (or modified versions of
+ it) with contractual assumptions of liability to the recipient, for
+ any liability that these contractual assumptions directly impose on
+ those licensors and authors.
+
+ All other non-permissive additional terms are considered "further
+restrictions" within the meaning of section 10. If the Program as you
+received it, or any part of it, contains a notice stating that it is
+governed by this License along with a term that is a further
+restriction, you may remove that term. If a license document contains
+a further restriction but permits relicensing or conveying under this
+License, you may add to a covered work material governed by the terms
+of that license document, provided that the further restriction does
+not survive such relicensing or conveying.
+
+ If you add terms to a covered work in accord with this section, you
+must place, in the relevant source files, a statement of the
+additional terms that apply to those files, or a notice indicating
+where to find the applicable terms.
+
+ Additional terms, permissive or non-permissive, may be stated in the
+form of a separately written license, or stated as exceptions;
+the above requirements apply either way.
+
+ 8. Termination.
+
+ You may not propagate or modify a covered work except as expressly
+provided under this License. Any attempt otherwise to propagate or
+modify it is void, and will automatically terminate your rights under
+this License (including any patent licenses granted under the third
+paragraph of section 11).
+
+ However, if you cease all violation of this License, then your
+license from a particular copyright holder is reinstated (a)
+provisionally, unless and until the copyright holder explicitly and
+finally terminates your license, and (b) permanently, if the copyright
+holder fails to notify you of the violation by some reasonable means
+prior to 60 days after the cessation.
+
+ Moreover, your license from a particular copyright holder is
+reinstated permanently if the copyright holder notifies you of the
+violation by some reasonable means, this is the first time you have
+received notice of violation of this License (for any work) from that
+copyright holder, and you cure the violation prior to 30 days after
+your receipt of the notice.
+
+ Termination of your rights under this section does not terminate the
+licenses of parties who have received copies or rights from you under
+this License. If your rights have been terminated and not permanently
+reinstated, you do not qualify to receive new licenses for the same
+material under section 10.
+
+ 9. Acceptance Not Required for Having Copies.
+
+ You are not required to accept this License in order to receive or
+run a copy of the Program. Ancillary propagation of a covered work
+occurring solely as a consequence of using peer-to-peer transmission
+to receive a copy likewise does not require acceptance. However,
+nothing other than this License grants you permission to propagate or
+modify any covered work. These actions infringe copyright if you do
+not accept this License. Therefore, by modifying or propagating a
+covered work, you indicate your acceptance of this License to do so.
+
+ 10. Automatic Licensing of Downstream Recipients.
+
+ Each time you convey a covered work, the recipient automatically
+receives a license from the original licensors, to run, modify and
+propagate that work, subject to this License. You are not responsible
+for enforcing compliance by third parties with this License.
+
+ An "entity transaction" is a transaction transferring control of an
+organization, or substantially all assets of one, or subdividing an
+organization, or merging organizations. If propagation of a covered
+work results from an entity transaction, each party to that
+transaction who receives a copy of the work also receives whatever
+licenses to the work the party's predecessor in interest had or could
+give under the previous paragraph, plus a right to possession of the
+Corresponding Source of the work from the predecessor in interest, if
+the predecessor has it or can get it with reasonable efforts.
+
+ You may not impose any further restrictions on the exercise of the
+rights granted or affirmed under this License. For example, you may
+not impose a license fee, royalty, or other charge for exercise of
+rights granted under this License, and you may not initiate litigation
+(including a cross-claim or counterclaim in a lawsuit) alleging that
+any patent claim is infringed by making, using, selling, offering for
+sale, or importing the Program or any portion of it.
+
+ 11. Patents.
+
+ A "contributor" is a copyright holder who authorizes use under this
+License of the Program or a work on which the Program is based. The
+work thus licensed is called the contributor's "contributor version".
+
+ A contributor's "essential patent claims" are all patent claims
+owned or controlled by the contributor, whether already acquired or
+hereafter acquired, that would be infringed by some manner, permitted
+by this License, of making, using, or selling its contributor version,
+but do not include claims that would be infringed only as a
+consequence of further modification of the contributor version. For
+purposes of this definition, "control" includes the right to grant
+patent sublicenses in a manner consistent with the requirements of
+this License.
+
+ Each contributor grants you a non-exclusive, worldwide, royalty-free
+patent license under the contributor's essential patent claims, to
+make, use, sell, offer for sale, import and otherwise run, modify and
+propagate the contents of its contributor version.
+
+ In the following three paragraphs, a "patent license" is any express
+agreement or commitment, however denominated, not to enforce a patent
+(such as an express permission to practice a patent or covenant not to
+sue for patent infringement). To "grant" such a patent license to a
+party means to make such an agreement or commitment not to enforce a
+patent against the party.
+
+ If you convey a covered work, knowingly relying on a patent license,
+and the Corresponding Source of the work is not available for anyone
+to copy, free of charge and under the terms of this License, through a
+publicly available network server or other readily accessible means,
+then you must either (1) cause the Corresponding Source to be so
+available, or (2) arrange to deprive yourself of the benefit of the
+patent license for this particular work, or (3) arrange, in a manner
+consistent with the requirements of this License, to extend the patent
+license to downstream recipients. "Knowingly relying" means you have
+actual knowledge that, but for the patent license, your conveying the
+covered work in a country, or your recipient's use of the covered work
+in a country, would infringe one or more identifiable patents in that
+country that you have reason to believe are valid.
+
+ If, pursuant to or in connection with a single transaction or
+arrangement, you convey, or propagate by procuring conveyance of, a
+covered work, and grant a patent license to some of the parties
+receiving the covered work authorizing them to use, propagate, modify
+or convey a specific copy of the covered work, then the patent license
+you grant is automatically extended to all recipients of the covered
+work and works based on it.
+
+ A patent license is "discriminatory" if it does not include within
+the scope of its coverage, prohibits the exercise of, or is
+conditioned on the non-exercise of one or more of the rights that are
+specifically granted under this License. You may not convey a covered
+work if you are a party to an arrangement with a third party that is
+in the business of distributing software, under which you make payment
+to the third party based on the extent of your activity of conveying
+the work, and under which the third party grants, to any of the
+parties who would receive the covered work from you, a discriminatory
+patent license (a) in connection with copies of the covered work
+conveyed by you (or copies made from those copies), or (b) primarily
+for and in connection with specific products or compilations that
+contain the covered work, unless you entered into that arrangement,
+or that patent license was granted, prior to 28 March 2007.
+
+ Nothing in this License shall be construed as excluding or limiting
+any implied license or other defenses to infringement that may
+otherwise be available to you under applicable patent law.
+
+ 12. No Surrender of Others' Freedom.
+
+ If 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 convey a
+covered work so as to satisfy simultaneously your obligations under this
+License and any other pertinent obligations, then as a consequence you may
+not convey it at all. For example, if you agree to terms that obligate you
+to collect a royalty for further conveying from those to whom you convey
+the Program, the only way you could satisfy both those terms and this
+License would be to refrain entirely from conveying the Program.
+
+ 13. Use with the GNU Affero General Public License.
+
+ Notwithstanding any other provision of this License, you have
+permission to link or combine any covered work with a work licensed
+under version 3 of the GNU Affero General Public License into a single
+combined work, and to convey the resulting work. The terms of this
+License will continue to apply to the part which is the covered work,
+but the special requirements of the GNU Affero General Public License,
+section 13, concerning interaction through a network will apply to the
+combination as such.
+
+ 14. Revised Versions of this License.
+
+ The Free Software Foundation may publish revised and/or new versions of
+the GNU 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
+Program specifies that a certain numbered version of the GNU General
+Public License "or any later version" applies to it, you have the
+option of following the terms and conditions either of that numbered
+version or of any later version published by the Free Software
+Foundation. If the Program does not specify a version number of the
+GNU General Public License, you may choose any version ever published
+by the Free Software Foundation.
+
+ If the Program specifies that a proxy can decide which future
+versions of the GNU General Public License can be used, that proxy's
+public statement of acceptance of a version permanently authorizes you
+to choose that version for the Program.
+
+ Later license versions may give you additional or different
+permissions. However, no additional obligations are imposed on any
+author or copyright holder as a result of your choosing to follow a
+later version.
+
+ 15. Disclaimer of Warranty.
+
+ THERE IS NO WARRANTY FOR THE PROGRAM, TO THE EXTENT PERMITTED BY
+APPLICABLE LAW. EXCEPT WHEN OTHERWISE STATED IN WRITING THE COPYRIGHT
+HOLDERS AND/OR OTHER PARTIES PROVIDE THE PROGRAM "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 PROGRAM
+IS WITH YOU. SHOULD THE PROGRAM PROVE DEFECTIVE, YOU ASSUME THE COST OF
+ALL NECESSARY SERVICING, REPAIR OR CORRECTION.
+
+ 16. Limitation of Liability.
+
+ IN NO EVENT UNLESS REQUIRED BY APPLICABLE LAW OR AGREED TO IN WRITING
+WILL ANY COPYRIGHT HOLDER, OR ANY OTHER PARTY WHO MODIFIES AND/OR CONVEYS
+THE PROGRAM 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 PROGRAM (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 PROGRAM TO OPERATE WITH ANY OTHER PROGRAMS),
+EVEN IF SUCH HOLDER OR OTHER PARTY HAS BEEN ADVISED OF THE POSSIBILITY OF
+SUCH DAMAGES.
+
+ 17. Interpretation of Sections 15 and 16.
+
+ If the disclaimer of warranty and limitation of liability provided
+above cannot be given local legal effect according to their terms,
+reviewing courts shall apply local law that most closely approximates
+an absolute waiver of all civil liability in connection with the
+Program, unless a warranty or assumption of liability accompanies a
+copy of the Program in return for a fee.
+
+ END OF TERMS AND CONDITIONS
+
+ How to Apply These Terms to Your New Programs
+
+ If you develop a new program, and you want it to be of the greatest
+possible use to the public, the best way to achieve this is to make it
+free software which everyone can redistribute and change under these terms.
+
+ To do so, attach the following notices to the program. It is safest
+to attach them to the start of each source file to most effectively
+state the exclusion of warranty; and each file should have at least
+the "copyright" line and a pointer to where the full notice is found.
+
+ <one line to give the program's name and a brief idea of what it does.>
+ Copyright (C) <year> <name of author>
+
+ This program is free software: you can redistribute it and/or modify
+ it under the terms of the GNU 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 General Public License
+ along with this program. If not, see <http://www.gnu.org/licenses/>.
+
+Also add information on how to contact you by electronic and paper mail.
+
+ If the program does terminal interaction, make it output a short
+notice like this when it starts in an interactive mode:
+
+ <program> Copyright (C) <year> <name of author>
+ This program comes with ABSOLUTELY NO WARRANTY; for details type `show w'.
+ This is free software, and you are welcome to redistribute it
+ under certain conditions; type `show c' for details.
+
+The hypothetical commands `show w' and `show c' should show the appropriate
+parts of the General Public License. Of course, your program's commands
+might be different; for a GUI interface, you would use an "about box".
+
+ You should also get your employer (if you work as a programmer) or school,
+if any, to sign a "copyright disclaimer" for the program, if necessary.
+For more information on this, and how to apply and follow the GNU GPL, see
+<http://www.gnu.org/licenses/>.
+
+ The GNU General Public License does not permit incorporating your program
+into proprietary programs. If your program is a subroutine library, you
+may consider it more useful to permit linking proprietary applications with
+the library. If this is what you want to do, use the GNU Lesser General
+Public License instead of this License. But first, please read
+<http://www.gnu.org/philosophy/why-not-lgpl.html>.
--- /dev/null
+H5config
+=======
+
+H5config is a Python package for conviniently saving and loading
+configuration classes from disk. After populating base configuration
+classes with parameters, h5config automatically generates HDF5 and
+YAML backends for saving and loading that class. Yes, all this
+information could go into a single database, but if you like the
+flexibility of having a bunch of individual files that you can peek
+into one at a time, this module is for you.
+
+I wrote the module to support my experiment-control infrastructure,
+and one of the key goals was to easily embed control parameters in the
+saved data::
+
+ experiment.h5
+ |-- raw/
+ | |-- thermocouple: [32757, 32731, 32796, 32789, 32809, ...]
+ | `-- deflection: [29808, 29793, 29782, 29817, 29775, ...]
+ |-- timeseries-config/
+ | |-- frequency: 0.1
+ | |-- run-time: 100
+ | |-- thermocouple-channel/
+ | | |-- conversion-coefficients: [-10.0, 0.000305180437934]
+ | | `-- conversion-origin: [0.0]
+ | |-- deflection-channel/
+ | | |-- conversion-coefficients: [-10.0, 0.000305180437934]
+ | | `-- conversion-origin: [0.0]
+ | `-- thermocouple-calibration: [25.08355e3, 7.860106e4]
+ `-- environment-config/
+ |-- temperature: 20
+ `-- timestamp: 1311851980.750180
+
+Storing all of the calibration and conversion factors can get
+complicated quickly. h5config will keep you organized, and allow you
+to focus on defining the config options without getting bogged down in
+the bookkeeping.
+
+As a side effect, h5config also provides some tools to support system-
+and user-wide configuration files. For example, the pypiezo_ package
+uses h5config to automatically detect and load the following config
+file::
+
+ $ cat ~/.pypiezorc.yaml
+ log-level: debug
+ matplotlib: no
+
+
+Installation
+============
+
+Packages
+--------
+
+Gentoo
+~~~~~~
+
+I've packaged h5config for Gentoo. You need layman_ and my `wtk
+overlay`_. Install with::
+
+ # emerge -av app-portage/layman
+ # layman --add wtk
+ # emerge -av dev-python/h5config
+
+
+Dependencies
+------------
+
+If you're installing by hand or packaging h5config for another
+distribution, you'll need the following dependencies:
+
+=========== ================= =====================
+Package Debian_ Gentoo_
+=========== ================= =====================
+H5Py_ python-h5py dev-python/h5py
+Nose_ python-nose dev-python/nose
+PyYAML_ python-pyyaml dev-python/pyyaml
+=========== ================= =====================
+
+
+Installing by hand
+------------------
+
+H5config is available as a Git_ repository::
+
+ $ git clone http://physics.drexel.edu/~wking/code/git/h5config.git
+
+See the homepage_ for details. To install the checkout, run the
+standard::
+
+ $ python setup.py install
+
+
+Usage
+=====
+
+See the module docstrings for simple examples.
+
+
+Testing
+=======
+
+Run internal unit tests with::
+
+ $ nosetests --with-doctest --doctest-tests h5config
+
+
+Licence
+=======
+
+This project is distributed under the `GNU General Public License
+Version 3`_ or greater.
+
+
+Author
+======
+
+W. Trevor King
+wking@drexel.edu
+Copyright 2011
+
+
+,, _pypiezo:
+ http://physics.drexel.edu/~wking/unfolding-disasters/posts/pypiezo/
+.. _layman: http://layman.sourceforge.net/
+.. _wtk overlay:
+ http://physics.drexel.edu/~wking/unfolding-disasters/posts/Gentoo_overlay
+.. _Debian: http://www.debian.org/
+.. _Gentoo: http://www.gentoo.org/
+.. _H5Py: http://code.google.com/p/h5py/
+.. _Nose: http://somethingaboutorange.com/mrl/projects/nose/
+.. _PyYAML: http://pyyaml.org/wiki/PyYAML
+.. _Git: http://git-scm.com/
+.. _homepage:
+ http://physics.drexel.edu/~wking/unfolding-disasters/posts/h5config/
+.. _GNU General Public License Version 3: http://www.gnu.org/licenses/gpl.txt
--- /dev/null
+# Copyright (C) 2011 W. Trevor King <wking@drexel.edu>
+#
+# This file is part of h5config.
+#
+# h5config is free software; you can redistribute it and/or modify it
+# under the terms of the GNU General Public License as published by the
+# Free Software Foundation, either version 3 of the License, or (at your
+# option) any later version.
+#
+# h5config 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 General Public License
+# along with h5config. If not, see <http://www.gnu.org/licenses/>.
+
+from .log import get_basic_logger as _get_basic_logger
+
+
+__version__ = '0.1'
+
+LOG = _get_basic_logger(__name__)
+
+from .tools import _PackageConfig
+
+
+package_config = _PackageConfig(package_name=__name__, logger=LOG)
+package_config.load_system()
--- /dev/null
+# Copyright (C) 2011 W. Trevor King <wking@drexel.edu>
+#
+# This file is part of h5config.
+#
+# h5config is free software; you can redistribute it and/or modify it
+# under the terms of the GNU General Public License as published by the
+# Free Software Foundation, either version 3 of the License, or (at your
+# option) any later version.
+#
+# h5config 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 General Public License
+# along with h5config. If not, see <http://www.gnu.org/licenses/>.
+
+"""The basic h5config classes
+"""
+
+
+class _Setting (object):
+ "A named setting with arbitrart text values."
+ def __init__(self, name, help='', default=None):
+ self.name = name
+ self._help = help
+ self.default = default
+
+ def __str__(self):
+ return '<%s %s>' % (self.__class__.__name__, self.name)
+
+ def __repr__(self):
+ return self.__str__()
+
+ def help(self):
+ ret = '%s Default: %s.' % (
+ self._help, self.convert_to_text(self.default))
+ return ret.strip()
+
+ def convert_from_text(self, value):
+ return value
+
+ def convert_to_text(self, value):
+ return value
+
+
+class _ChoiceSetting (_Setting):
+ """A named setting with a limited number of possible values.
+
+ `choices` should be a list of `(config_file_value, Python value)`
+ pairs. For example
+
+ >>> s = _ChoiceSetting(name='bool',
+ ... choices=[('yes', True), ('no', False)])
+ >>> s.convert_from_text('yes')
+ True
+ >>> s.convert_to_text(True)
+ 'yes'
+ >>> s.convert_to_text('invalid')
+ Traceback (most recent call last):
+ ...
+ ValueError: invalid
+ >>> s.help()
+ 'Default: yes. Choices: yes, no'
+ """
+ def __init__(self, choices=None, **kwargs):
+ if 'default' not in kwargs:
+ if None not in [keyval[1] for keyval in choices]:
+ kwargs['default'] = choices[0][1]
+ super(_ChoiceSetting, self).__init__(**kwargs)
+ if choices == None:
+ choices = []
+ self.choices = choices
+
+ def help(self):
+ ret = '%s Choices: %s' % (
+ super(_ChoiceSetting, self).help(),
+ ', '.join([key for key,value in self.choices]))
+ return ret.strip()
+
+ def convert_from_text(self, value):
+ return dict(self.choices)[value]
+
+ def convert_to_text(self, value):
+ for keyval in self.choices:
+ key,val = keyval
+ if val == value:
+ return key
+ raise ValueError(value)
+
+
+class _BooleanSetting (_ChoiceSetting):
+ """A named settubg that can be either true or false.
+
+ >>> s = _BooleanSetting(name='bool')
+
+ >>> s.convert_from_text('yes')
+ True
+ >>> s.convert_to_text(True)
+ 'yes'
+ >>> s.convert_to_text('invalid')
+ Traceback (most recent call last):
+ ...
+ ValueError: invalid
+ >>> s.help()
+ 'Default: no. Choices: yes, no'
+ """
+ def __init__(self, **kwargs):
+ assert 'choices' not in kwargs
+ if 'default' not in kwargs:
+ kwargs['default'] = False
+ super(_BooleanSetting, self).__init__(
+ choices=[('yes', True), ('no', False)], **kwargs)
+
+
+class _NumericSetting (_Setting):
+ """A named setting with numeric values.
+
+ Don't use this setting class. Use a more specific subclass, such
+ as `_IntegerSetting`.
+
+ >>> s = _NumericSetting(name='float')
+ >>> s.default
+ 0
+ >>> s.convert_to_text(13)
+ '13'
+ """
+ _default_value = 0
+
+ def __init__(self, **kwargs):
+ if 'default' not in kwargs:
+ kwargs['default'] = self._default_value
+ super(_NumericSetting, self).__init__(**kwargs)
+
+ def convert_to_text(self, value):
+ return str(value)
+
+ def convert_from_text(self, value):
+ if value in [None, 'None']:
+ return None
+ return self._convert_from_text(value)
+
+ def _convert_from_text(self, value):
+ raise NotImplementedError()
+
+
+class _IntegerSetting (_NumericSetting):
+ """A named setting with integer values.
+
+ >>> s = _IntegerSetting(name='int')
+ >>> s.default
+ 1
+ >>> s.convert_from_text('8')
+ 8
+ """
+ _default_value = 1
+
+ def _convert_from_text(self, value):
+ return int(value)
+
+
+class _FloatSetting (_NumericSetting):
+ """A named setting with floating point values.
+
+ >>> s = _FloatSetting(name='float')
+ >>> s.default
+ 1.0
+ >>> s.convert_from_text('8')
+ 8.0
+ >>> try:
+ ... s.convert_from_text('invalid')
+ ... except ValueError, e:
+ ... print 'caught a ValueError'
+ caught a ValueError
+ """
+ _default_value = 1.0
+
+ def _convert_from_text(self, value):
+ return float(value)
+
+
+class _FloatListSetting (_Setting):
+ """A named setting with a list of floating point values.
+
+ >>> s = _FloatListSetting(name='floatlist')
+ >>> s.default
+ []
+ >>> s.convert_to_text([1, 2.3])
+ '1, 2.3'
+ >>> s.convert_from_text('4.5, -6.7') # doctest: +ELLIPSIS
+ [4.5, -6.7...]
+ >>> s.convert_to_text([])
+ ''
+ >>> s.convert_from_text('')
+ []
+ """
+ def __init__(self, **kwargs):
+ if 'default' not in kwargs:
+ kwargs['default'] = []
+ super(_FloatListSetting, self).__init__(**kwargs)
+
+ def _convert_from_text(self, value):
+ if value is None:
+ return value
+ return float(value)
+
+ def convert_from_text(self, value):
+ if value is None:
+ return None
+ elif value == '':
+ return []
+ return [self._convert_from_text(x) for x in value.split(',')]
+
+ def convert_to_text(self, value):
+ if value is None:
+ return None
+ return ', '.join([str(x) for x in value])
+
+
+class _Config (dict):
+ "A class with a list `._keys` of `_Setting`\s."
+ settings = []
+
+ def __init__(self):
+ for s in self.settings:
+ self[s.name] = s.default
+
+ def dump(self, help=False):
+ """Return all settings and their values as a string
+
+ >>> class _MyConfig (_Config):
+ ... settings = [
+ ... _ChoiceSetting(
+ ... name='number',
+ ... help='I have a number behind my back...',
+ ... default=1,
+ ... choices=[('one', 1), ('two', 2),
+ ... ]),
+ ... _BooleanSetting(
+ ... name='odd',
+ ... help='The number behind my back is odd.',
+ ... default=True),
+ ... _IntegerSetting(
+ ... name='guesses',
+ ... help='Number of guesses before epic failure.',
+ ... default=2),
+ ... ]
+ >>> c = _MyConfig()
+ >>> print c.dump()
+ number: one
+ odd: yes
+ guesses: 2
+ >>> print c.dump(help=True) # doctest: +NORMALIZE_WHITESPACE
+ number: one (I have a number behind my back... Default: one.
+ Choices: one, two)
+ odd: yes (The number behind my back is odd. Default: yes.
+ Choices: yes, no)
+ guesses: 2 (Number of guesses before epic failure. Default: 2.)
+ """
+ lines = []
+ for setting in self.settings:
+ name = setting.name
+ value_string = setting.convert_to_text(self[name])
+ if help:
+ help_string = '\t({})'.format(setting.help())
+ else:
+ help_string = ''
+ lines.append('{}: {}{}'.format(name, value_string, help_string))
+ return '\n'.join(lines)
+
+
+class _BackedConfig (_Config):
+ "A `_Config` instance with some kind of storage interface"
+ def load(self):
+ raise NotImplementedError()
+
+ def save(self):
+ raise NotImplementedError()
--- /dev/null
+# Copyright (C) 2011 W. Trevor King <wking@drexel.edu>
+#
+# This file is part of h5config.
+#
+# h5config is free software; you can redistribute it and/or modify it
+# under the terms of the GNU General Public License as published by the
+# Free Software Foundation, either version 3 of the License, or (at your
+# option) any later version.
+#
+# h5config 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 General Public License
+# along with h5config. If not, see <http://www.gnu.org/licenses/>.
+
+"""HDF5 backend implementation
+"""
+
+import h5py as _h5py
+
+from . import LOG as _LOG
+from . import config as _config
+
+
+def pprint_HDF5(*args, **kwargs):
+ print pformat_HDF5(*args, **kwargs)
+
+def pformat_HDF5(filename, group='/'):
+ f = _h5py.File(filename, 'r')
+ cwg = f[group]
+ return '\n'.join(_pformat_hdf5(cwg))
+
+def _pformat_hdf5(cwg, depth=0):
+ lines = []
+ lines.append(' '*depth + cwg.name)
+ depth += 1
+ for key,value in cwg.iteritems():
+ if isinstance(value, _h5py.Group):
+ lines.extend(_pformat_hdf5(value, depth))
+ elif isinstance(value, _h5py.Dataset):
+ lines.append(' '*depth + str(value))
+ lines.append(' '*(depth+1) + str(value[...]))
+ else:
+ lines.append(' '*depth + str(value))
+ return lines
+
+
+class _HDF5Config (_config._BackedConfig):
+ """Mixin to back a `_Config` class with an HDF5 file.
+
+ TODO: Special handling for Choice (enums), FloatList (arrays), etc.?
+
+ The `.save` and `.load` methods have an optional `group` argument
+ that allows you to save and load settings from an externally
+ opened HDF5 file. This can make it easier to stash several
+ related `_Config` classes in a single file. For example
+
+ >>> import os
+ >>> import tempfile
+ >>> from .test import HDF5_TestConfig
+ >>> fd,filename = tempfile.mkstemp(suffix='.h5', prefix='pypiezo-')
+ >>> os.close(fd)
+
+ >>> f = _h5py.File(filename, 'a')
+ >>> c = HDF5_TestConfig(filename='untouched_file.h5',
+ ... group='/untouched/group')
+ >>> c['syslog'] = True
+ >>> group = f.create_group('base')
+ >>> c.save(group)
+ >>> pprint_HDF5(filename)
+ /
+ /base
+ <HDF5 dataset "age": shape (), type "|S3">
+ 1.3
+ <HDF5 dataset "alive": shape (), type "|S2">
+ no
+ <HDF5 dataset "bids": shape (), type "|S11">
+ 5.4, 3.2, 1
+ <HDF5 dataset "daisies": shape (), type "|S2">
+ 13
+ <HDF5 dataset "species": shape (), type "|S14">
+ Norwegian Blue
+ >>> d = HDF5_TestConfig(filename='untouched_file.h5',
+ ... group='/untouched/group')
+ >>> d.load(group)
+ >>> d['alive']
+ False
+
+ >>> f.close()
+ >>> os.remove(filename)
+ """
+ def __init__(self, filename=None, group='/', **kwargs):
+ super(_HDF5Config, self).__init__(**kwargs)
+ self.filename = filename
+ assert group.startswith('/'), group
+ if not group.endswith('/'):
+ group += '/'
+ self.group = group
+ self._file_checked = False
+
+ def _check_file(self):
+ if self._file_checked:
+ return
+ self._setup_file()
+ self._file_checked = True
+
+ def _setup_file(self):
+ f = _h5py.File(self.filename, 'a')
+ cwg = f # current working group
+
+ # Create the group where the settings are stored (if necessary)
+ gpath = ['']
+ for group in self.group.strip('/').split('/'):
+ if not group:
+ break
+ gpath.append(group)
+ if group not in cwg.keys():
+ _LOG.debug('creating group %s in %s'
+ % ('/'.join(gpath), self.filename))
+ cwg.create_group(group)
+ cwg = cwg[group]
+ f.close()
+
+ def dump(self, help=False, from_file=False):
+ """Return the relevant group in `self.filename` as a string
+
+ Extends the base :meth:`dump` by adding the `from_file`
+ option. If `from_file` is true, dump all entries that
+ currently exist in the relevant group, rather than listing all
+ settings defined in the instance dictionary.
+ """
+ if from_file:
+ self._check_file()
+ f = _h5py.File(self.filename, 'r')
+ cwg = f[self.group]
+ lines = []
+ settings = dict([(s.name, s) for s in self.settings])
+ for key,value in cwg.iteritems():
+ if help and key in settings:
+ help_string = '\t(%s)' % settings[key].help()
+ else:
+ help_string = ''
+ lines.append('%s: %s%s' % (key, value[...], help_string))
+ return '\n'.join(lines)
+ return super(_HDF5Config, self).dump(help=help)
+
+ def load(self, group=None):
+ if group is None:
+ self._check_file()
+ f = _h5py.File(self.filename, 'r')
+ group = f[self.group]
+ else:
+ f = None
+ for s in self.settings:
+ if s.name not in group.keys():
+ continue
+ self[s.name] = s.convert_from_text(group[s.name][...])
+ if f:
+ f.close()
+
+ def save(self, group=None):
+ if group is None:
+ self._check_file()
+ f = _h5py.File(self.filename, 'a')
+ group = f[self.group]
+ else:
+ f = None
+ for s in self.settings:
+ value = s.convert_to_text(self[s.name])
+ try:
+ del group[s.name]
+ except KeyError:
+ pass
+ group[s.name] = value
+ if f:
+ f.close()
--- /dev/null
+# Copyright (C) 2011 W. Trevor King <wking@drexel.edu>
+#
+# This file is part of h5config.
+#
+# h5config is free software; you can redistribute it and/or modify it
+# under the terms of the GNU General Public License as published by the
+# Free Software Foundation, either version 3 of the License, or (at your
+# option) any later version.
+#
+# h5config 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 General Public License
+# along with h5config. If not, see <http://www.gnu.org/licenses/>.
+
+"""Tools for setting up a package logging.
+
+This module is separate from `tools` to avoid module dependency
+cycles. This module has no internal dependencies, while `tools`
+depends on many of the other modules. With this module separate, the
+other internal modules have access to the default logger before the
+package configuration is built up enough to configure it according to
+your external specifications.
+"""
+
+import logging as _logging
+
+
+def get_basic_logger(name, level=_logging.WARN):
+ """Create and return a basic logger
+
+ This utility function encapsulates a bunch of `logging`
+ boilerplate that I use in several packages.
+ """
+ log = _logging.getLogger(name)
+ log.setLevel(level)
+ formatter = _logging.Formatter(
+ '%(asctime)s - %(name)s - %(levelname)s - %(message)s')
+ stream_handler = _logging.StreamHandler()
+ stream_handler.setLevel(_logging.DEBUG)
+ stream_handler.setFormatter(formatter)
+ log.addHandler(stream_handler)
+ # Cache handlers for easy swapping depending on config settings
+ log._handler_cache = {'stream': stream_handler}
+ return log
--- /dev/null
+# Copyright (C) 2011 W. Trevor King <wking@drexel.edu>
+#
+# This file is part of h5config.
+#
+# h5config is free software; you can redistribute it and/or modify it
+# under the terms of the GNU General Public License as published by the
+# Free Software Foundation, either version 3 of the License, or (at your
+# option) any later version.
+#
+# h5config 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 General Public License
+# along with h5config. If not, see <http://www.gnu.org/licenses/>.
+
+"""Define a test config object using all the setting types
+
+Ensure that `build_backend_classes` worked properly for this module:
+
+>>> print '\\n'.join([obj for obj in sorted(locals().keys())
+... if obj.endswith('Config')
+... and not obj.startswith('_')])
+HDF5_TestConfig
+YAML_TestConfig
+
+
+The first time you use them, the file they create will probably be
+empty or not exist.
+
+>>> import os
+>>> import tempfile
+>>> from hdf5 import pprint_HDF5
+
+>>> fd,filename = tempfile.mkstemp(suffix='.h5', prefix='h5config-')
+>>> os.close(fd)
+
+>>> c = HDF5_TestConfig(filename=filename, group='/base')
+>>> c.load()
+
+Loading will create a stub group group if it hadn't existed before.
+
+>>> pprint_HDF5(filename)
+/
+ /base
+>>> print c.dump(from_file=True)
+<BLANKLINE>
+
+Saving fills in all the config values.
+
+>>> c['syslog'] = True
+>>> c.save()
+>>> pprint_HDF5(filename) # doctest: +REPORT_UDIFF
+/
+ /base
+ <HDF5 dataset "age": shape (), type "|S3">
+ 1.3
+ <HDF5 dataset "alive": shape (), type "|S2">
+ no
+ <HDF5 dataset "bids": shape (), type "|S11">
+ 5.4, 3.2, 1
+ <HDF5 dataset "daisies": shape (), type "|S2">
+ 13
+ <HDF5 dataset "species": shape (), type "|S14">
+ Norwegian Blue
+>>> print c.dump(from_file=True)
+age: 1.3
+alive: no
+bids: 5.4, 3.2, 1
+daisies: 13
+species: Norwegian Blue
+
+If you want more details, you can dump with help strings.
+
+>>> print c.dump(help=True, from_file=True) # doctest: +NORMALIZE_WHITESPACE
+age: 1.3 (Parrot age in years Default: 1.3.)
+alive: no (The parrot is alive. Default: no. Choices: yes, no)
+bids: 5.4, 3.2, 1 (Prices offered for parrot. Default: 5.4, 3.2, 1.)
+daisies: 13 (Number of daisies pushed up by the parrot.
+ Default: 13.)
+species: Norwegian Blue (Type of parrot. Default: Norwegian Blue.
+ Choices: Norwegian Blue, Macaw)
+
+As you can see from the `age` setting, settings also support `None`,
+even if they have numeric types.
+
+Cleanup our temporary config file.
+
+>>> os.remove(filename)
+"""
+
+import os as _os
+import sys as _sys
+import tempfile as _tempfile
+
+from . import LOG as _LOG
+from . import config as _config
+from . import util as _util
+from .hdf5 import _HDF5Config
+from .yaml import _YAMLConfig
+
+
+_ALTERNATIVES = { # alternative settings for testing
+ 'species': 1,
+ 'alive': True,
+ 'daisies': None,
+ 'age': None,
+ 'bids': [],
+ }
+
+
+class _TestConfig (_config._Config):
+ "Test all the setting types for the h5config module"
+ settings = [
+ _config._ChoiceSetting(
+ name='species',
+ help='Type of parrot.',
+ default=0,
+ choices=[('Norwegian Blue', 0), ('Macaw', 1)]),
+ _config._BooleanSetting(
+ name='alive',
+ help='The parrot is alive.',
+ default=False),
+ _config._IntegerSetting(
+ name='daisies',
+ help="Number of daisies pushed up by the parrot.",
+ default=13),
+ _config._FloatSetting(
+ name='age',
+ help='Parrot age in years',
+ default=1.3),
+ _config._FloatListSetting(
+ name='bids',
+ help='Prices offered for parrot.',
+ default=[5.4, 3.2, 1]),
+ ]
+
+
+_util.build_backend_classes(_sys.modules[__name__])
+
+
+def test(test_class=None):
+ if test_class is None:
+ classes = []
+ for name,obj in sorted(globals().items()):
+ try:
+ if issubclass(obj, _TestConfig):
+ classes.append(obj)
+ except TypeError:
+ pass
+ for class_ in classes:
+ test(test_class=class_)
+ return
+ _LOG.debug('testing {}'.format(test_class))
+ _basic_tests(test_class)
+ if issubclass(test_class, (_HDF5Config, _YAMLConfig)):
+ _uses_file_tests(test_class)
+
+def _basic_tests(test_class):
+ pass
+
+def _uses_file_tests(test_class):
+ fd,filename = _tempfile.mkstemp(suffix='.tmp', prefix='h5config-')
+ _os.close(fd)
+ kwargs = {'filename': filename}
+ try:
+ x = test_class(**kwargs)
+ y = test_class(**kwargs)
+ x.dump()
+ x.save()
+ y.load()
+ nd = list(_non_defaults(y))
+ assert not nd, nd
+ for key,value in _ALTERNATIVES.items():
+ x[key] = value
+ x.save()
+ y.load()
+ nd = dict(_non_defaults(y))
+ assert nd == _ALTERNATIVES, nd
+ finally:
+ _os.remove(filename)
+
+def _non_defaults(test_instance):
+ for setting in _TestConfig.settings:
+ value = test_instance[setting.name]
+ if value != setting.default:
+ yield (setting.name, value)
--- /dev/null
+# Copyright (C) 2011 W. Trevor King <wking@drexel.edu>
+#
+# This file is part of h5config.
+#
+# h5config is free software; you can redistribute it and/or modify it
+# under the terms of the GNU General Public License as published by the
+# Free Software Foundation, either version 3 of the License, or (at your
+# option) any later version.
+#
+# h5config 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 General Public License
+# along with h5config. If not, see <http://www.gnu.org/licenses/>.
+
+"""Tools for setting up a package using config files.
+
+The benefit of subclassing `_PackageConfig` over using something like
+`configparser` is that you can easily store default `h5config` values
+in the configuration file. Consider the following example:
+
+TODO
+> class _MyConfig
+"""
+
+import logging as _logging
+import os.path as _os_path
+import sys as _sys
+
+from . import config as _config
+from . import log as _log
+from . import util as _util
+
+
+class _PackageConfig (_config._Config):
+ """Configure package operation
+
+ This basic implementation just creates and manages a package-wide
+ `LOG` instance. If you create this instance on your own (for
+ example, to work around bootstrapping issues), just pass your
+ instance in as `logger` when you initialize this class.
+
+ Because this class occasionally replaces itself, you should always
+ work with the version in the package namespace and not with a
+ local reference (which may be stale).
+
+ Things get a bit interesting because we want to configure the
+ package from an internal class. This leads to TODO
+ """
+ _backed_subclasses = ()
+ settings = [
+ _config._ChoiceSetting(
+ name='log-level',
+ help='Module logging level.',
+ default=_logging.WARN,
+ choices=[
+ ('critical', _logging.CRITICAL),
+ ('error', _logging.ERROR),
+ ('warn', _logging.WARN),
+ ('info', _logging.INFO),
+ ('debug', _logging.DEBUG),
+ ]),
+ _config._BooleanSetting(
+ name='syslog',
+ help='Log to syslog (otherwise log to stderr).',
+ default=False),
+ ]
+
+ def __init__(self, package_name, namespace=None, logger=None, **kwargs):
+ super(_PackageConfig, self).__init__(**kwargs)
+ self._package_name = package_name
+ if not namespace:
+ namespace = _sys.modules[package_name]
+ self._namespace = namespace
+ if not logger:
+ logger = _log.get_basic_logger(name, level=_logging.WARN)
+ self._logger = logger
+
+ def _name(self):
+ "Find this instance's name in the bound namespace"
+ for attr_name in dir(self._namespace):
+ attr = getattr(self._namespace, attr_name, None)
+ if id(attr) == id(self):
+ return attr_name
+ raise IndexError('{} not found in the {} namespace'.format(
+ self, self._namespace))
+
+ def _replace_self(self, new_config):
+ self._logger.debug('replacing {} package config {} with {}'.format(
+ self._package_name, self, new_config))
+ new_config.setup()
+ name = self._name()
+ setattr(self._namespace, name, new_config)
+
+ def setup(self):
+ self._logger.setLevel(self['log-level'])
+ if self['syslog']:
+ if 'syslog' not in self._logger._handler_cache:
+ _syslog_handler = _logging_handlers.SysLogHandler()
+ _syslog_handler.setLevel(_logging.DEBUG)
+ self._logger._handler_cache['syslog'] = _syslog_handler
+ self._logger.handlers = [self._logger._handler_cache['syslog']]
+ else:
+ self._logger.handlers = [self._logger._handler_cache['stream']]
+ self._logger.info('setup {} packge config:\n{}'.format(
+ self._package_name, self.dump()))
+
+ def clear(self):
+ "Replace self with a non-backed version with default settings."
+ replacement = self._clear_class(
+ package_name=self._package_name,
+ namespace=self._namespace,
+ logger = self._logger)
+ self._replace_self(replacement)
+
+ def _base_paths(self):
+ user_basepath = _os_path.join(
+ _os_path.expanduser('~'), '.{}rc'.format(self._package_name))
+ system_basepath = _os_path.join('/etc', self._package_name, 'config')
+ distributed_basepath = _os_path.join(
+ '/usr', 'share', self._package_name, 'config')
+ return [user_basepath, system_basepath, distributed_basepath]
+
+ def load_system(self):
+ "Return the best `_PackageConfig` match after scanning the filesystem"
+ self._logger.info('looking for package config file')
+ basepaths = self._base_paths()
+ for basepath in basepaths:
+ for extension,config in self._backed_subclasses:
+ filename = basepath + extension
+ if _os_path.exists(filename):
+ self._logger.info(
+ 'base_config file found at {}'.format(filename))
+ replacement = config(
+ filename=filename,
+ package_name=self._package_name,
+ namespace=self._namespace,
+ logger = self._logger)
+ replacement.load()
+ self._replace_self(replacement)
+ return
+ else:
+ self._logger.debug(
+ 'no base_config file at {}'.format(filename))
+ # create (but don't save) the preferred file
+ basepath = basepaths[0]
+ extension,config = self._backed_subclasses[0]
+ filename = basepath + extension
+ self._logger.info('new base_config file at {}'.format(filename))
+ replacement = config(
+ filename=filename,
+ package_name=self._package_name,
+ namespace=self._namespace,
+ logger = self._logger)
+ self._replace_self(replacement)
+
+
+_PackageConfig._clear_class = _PackageConfig
+
+
+_util.build_backend_classes(_sys.modules[__name__])
+
+_PackageConfig._backed_subclasses = [
+ ('.h5', HDF5_PackageConfig),
+ ('.yaml', YAML_PackageConfig)
+ ]
--- /dev/null
+# Copyright (C) 2011 W. Trevor King <wking@drexel.edu>
+#
+# This file is part of h5config.
+#
+# h5config is free software; you can redistribute it and/or modify it
+# under the terms of the GNU General Public License as published by the
+# Free Software Foundation, either version 3 of the License, or (at your
+# option) any later version.
+#
+# h5config 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 General Public License
+# along with h5config. If not, see <http://www.gnu.org/licenses/>.
+
+"""Utilities for building your own config classes
+"""
+
+import os.path as _os_path
+
+from . import LOG as _LOG
+from .config import _Config, _BackedConfig
+from .hdf5 import _HDF5Config
+from .yaml import _YAMLConfig
+
+
+def build_backend_classes(namespace, objects=None):
+ """Define HDF5- and YAML-backed subclasses of the basic _Config types
+
+ At the end of your class-defining module, you should build the
+ particular backends. You'll need to pass in a namespace to attach
+ the new classes to. I generally use `sys.modules[__name__]` to
+ attach the classes to the current module. By default
+ `build_backend_classes` will search for base `_Config` classes in
+ the namespace you pass it. If that doesn't work for you, you can
+ explicitly pass it an iterable of `name, object)` tuples.
+ """
+ if objects is None:
+ objects = [(name,getattr(namespace, name, None))
+ for name in dir(namespace)]
+ for name,obj in objects:
+ if (obj != _Config and
+ type(obj) == type and
+ issubclass(obj, _Config) and
+ not issubclass(obj, _BackedConfig)):
+ for prefix,base in [('HDF5', _HDF5Config), ('YAML', _YAMLConfig)]:
+ _LOG.debug(
+ 'creating {} backend for {} in the {} namespace'.format(
+ prefix, name, namespace))
+ name_ = '%s%s' % (prefix, name)
+ bases = (base, obj)
+ dict_ = {}
+ class_ = type(name_, bases, dict_)
+ setattr(namespace, name_, class_)
--- /dev/null
+# Copyright (C) 2011 W. Trevor King <wking@drexel.edu>
+#
+# This file is part of h5config.
+#
+# h5config is free software; you can redistribute it and/or modify it
+# under the terms of the GNU General Public License as published by the
+# Free Software Foundation, either version 3 of the License, or (at your
+# option) any later version.
+#
+# h5config 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 General Public License
+# along with h5config. If not, see <http://www.gnu.org/licenses/>.
+
+"""HDF5 backend implementation
+"""
+
+from __future__ import absolute_import
+
+import os.path as _os_path
+
+import yaml as _yaml # global PyYAML module
+
+from . import LOG as _LOG
+from . import config as _config
+
+
+class _YAMLDumper (_yaml.SafeDumper):
+ def represent_bool(self, data):
+ "Use yes/no instead of the default true/false"
+ if data:
+ value = u'yes'
+ else:
+ value = u'no'
+ return self.represent_scalar(u'tag:yaml.org,2002:bool', value)
+
+
+_YAMLDumper.add_representer(bool, _YAMLDumper.represent_bool)
+
+
+class _YAMLConfig (_config._BackedConfig):
+ """Mixin to back a `_Config` class with a YAML file.
+
+ TODO: Special handling for Choice (enums), FloatList (arrays), etc.?
+
+
+ >>> import os
+ >>> from .test import YAML_TestConfig
+ >>> import os.path
+ >>> import tempfile
+ >>> fd,filename = tempfile.mkstemp(suffix='.yaml', prefix='pypiezo-')
+ >>> os.close(fd)
+
+ >>> c = YAML_TestConfig(filename=filename)
+ >>> c.load()
+
+ Saving writes all the config values to disk.
+
+ >>> c['syslog'] = True
+ >>> c.save()
+ >>> print open(c.filename, 'r').read()
+ age: '1.3'
+ alive: no
+ bids: 5.4, 3.2, 1
+ daisies: '13'
+ species: Norwegian Blue
+ <BLANKLINE>
+
+ Loading reads the config files from disk.
+
+ >>> c = YAML_TestConfig(filename=filename)
+ >>> c.load()
+ >>> print c.dump()
+ species: Norwegian Blue
+ alive: no
+ daisies: 13
+ age: 1.3
+ bids: 5.4, 3.2, 1.0
+
+ Cleanup our temporary config file.
+
+ >>> os.remove(filename)
+ """
+ dumper = _YAMLDumper
+
+ def __init__(self, filename=None, **kwargs):
+ super(_YAMLConfig, self).__init__(**kwargs)
+ self.filename = filename
+
+ def load(self):
+ if not _os_path.exists(self.filename):
+ open(self.filename, 'a').close()
+ with open(self.filename, 'r') as f:
+ data = _yaml.safe_load(f)
+ if data == None:
+ return # empty file
+ settings = dict([(s.name, s) for s in self.settings])
+ for key,value in data.iteritems():
+ setting = settings[key]
+ if isinstance(setting, _config._BooleanSetting):
+ v = value
+ else:
+ v = setting.convert_from_text(value)
+ self[key] = v
+
+ def save(self):
+ data = {}
+ settings = dict([(s.name, s) for s in self.settings])
+ for key,value in self.iteritems():
+ if key in settings:
+ setting = settings[key]
+ if isinstance(setting, _config._BooleanSetting):
+ v = value
+ else:
+ v = setting.convert_to_text(value)
+ data[key] = v
+ with open(self.filename, 'w') as f:
+ _yaml.dump(data, stream=f, Dumper=self.dumper,
+ default_flow_style=False)
--- /dev/null
+# Copyright (C) 2009-2011 W. Trevor King <wking@drexel.edu>
+#
+# This file is part of h5config.
+#
+# h5config is free software; you can redistribute it and/or modify it
+# under the terms of the GNU General Public License as published by the
+# Free Software Foundation, either version 3 of the License, or (at your
+# option) any later version.
+#
+# h5config 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 General Public License
+# along with h5config. If not, see <http://www.gnu.org/licenses/>.
+
+"Conveniently save and load config-options from HDF5 and YAML files."
+
+from distutils.core import setup
+import os.path
+
+from h5config import __version__
+
+
+package_name = 'h5config'
+base_url = 'http://www.physics.drexel.edu/~wking'
+_this_dir = os.path.dirname(__file__)
+
+setup(name=package_name,
+ version=__version__,
+ maintainer='W. Trevor King',
+ maintainer_email='wking@drexel.edu',
+ url='{}/unfolding-disasters/posts/{}/'.format(base_url, package_name),
+ download_url='{}/code/python/%s-%s.tar.gz'.format(
+ base_url, package_name, __version__),
+ license='GNU General Public License (GPL)',
+ platforms=['all'],
+ description=__doc__,
+ long_description=open(os.path.join(_this_dir, 'README'), 'r').read(),
+ classifiers=[
+ 'Development Status :: 2 - Pre-Alpha',
+ 'Intended Audience :: Developers',
+ 'Intended Audience :: Science/Research',
+ 'Operating System :: OS Independent',
+ 'License :: OSI Approved :: GNU General Public License (GPL)',
+ 'Programming Language :: Python',
+ 'Topic :: Scientific/Engineering',
+ 'Topic :: Software Development :: Libraries :: Python Modules',
+ ]
+ packages=['h5config'],
+ provides=['{} ({})'.format(package_name, __version__)],
+ )
projects / h5config.git / commitdiff