asset-0.6.13/0000775000175000017500000000000013566560742014022 5ustar grabnergrabner00000000000000asset-0.6.13/LICENSE.txt0000664000175000017500000007733012303446764015652 0ustar grabnergrabner00000000000000 GNU GENERAL PUBLIC LICENSE Version 3, 29 June 2007 Copyright (C) 2007 Free Software Foundation, Inc. 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 asset-0.6.13/VERSION.txt0000664000175000017500000000000713566557501015704 0ustar grabnergrabner000000000000000.6.13 asset-0.6.13/asset/0000775000175000017500000000000013566560742015141 5ustar grabnergrabner00000000000000asset-0.6.13/asset/test.py0000664000175000017500000002217613074236337016474 0ustar grabnergrabner00000000000000# -*- coding: utf-8 -*- #------------------------------------------------------------------------------ # file: $Id$ # auth: metagriffin # date: 2013/09/22 # copy: (C) Copyright 2013-EOT metagriffin -- see LICENSE.txt #------------------------------------------------------------------------------ # This software 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 software 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/. #------------------------------------------------------------------------------ import unittest import os.path import xml.etree.ElementTree as ET import pxml import six import pkg_resources from aadict import aadict import asset #------------------------------------------------------------------------------ def isEgg(pkg): dist = pkg_resources.get_distribution(pkg) return os.path.isfile(dist.location) #------------------------------------------------------------------------------ class TestAsset(unittest.TestCase, pxml.XmlTestMixin): maxDiff = None #---------------------------------------------------------------------------- def test_version(self): self.assertRegexpMatches(asset.version('pxml'), r'^\d+.\d+.\d+$') #---------------------------------------------------------------------------- def test_count(self): self.assertEqual(asset.load('asset:test/data/file1.nl').count(), 1) self.assertEqual(len(asset.load('asset:test/data/file1.nl')), 1) self.assertEqual(asset.load('asset:test/data/**.nl').count(), 3) self.assertEqual(len(asset.load('asset:test/data/**.nl')), 3) #---------------------------------------------------------------------------- def test_exists(self): self.assertEqual(asset.load('asset:test/data/file1.nl').exists(), True) self.assertEqual(asset.load('asset:test/data/**.nl').exists(), True) self.assertEqual(asset.load('asset:no-such-file.ext').exists(), False) #---------------------------------------------------------------------------- def test_load_multi(self): self.assertEqual(len(asset.load('asset:test/data/file1.nl')), 1) self.assertEqual( [str(ast) for ast in asset.load('asset:test/data/file1.nl')], ['asset:test/data/file1.nl']) self.assertEqual( [str(ast) for ast in asset.load('asset:test/data/**.nl')], ['asset:test/data/file1.nl', 'asset:test/data/file2.nl', 'asset:test/data/subdir/subfile1.nl']) self.assertEqual( [ast.read() for ast in asset.load('asset:test/data/**.nl')], [b'line-1\nline-2', b'line-3\n', b'sub-file-line-1\n']) #---------------------------------------------------------------------------- def test_load_single(self): loaded = [] for item in asset.load('asset:test/data/file1.nl'): loaded.append(item) self.assertEqual(len(loaded), 1) self.assertEqual(loaded[0].package, 'asset') self.assertEqual(loaded[0].name, 'test/data/file1.nl') with self.assertRaises(asset.NoSuchAsset) as cm: asset.load('asset:no-such-file.ext').peek() #---------------------------------------------------------------------------- def test_load_group_read(self): self.assertEqual( asset.load('asset:test/data/file1.nl').read(), b'line-1\nline-2') self.assertEqual( asset.load('asset:test/data/file2.nl').read(), b'line-3\n') self.assertEqual( asset.load('asset:test/data/*.nl').read(), b'line-1\nline-2line-3\n') ag = asset.load('asset:test/data/*.nl') self.assertEqual(ag.readline(), b'line-1\n') self.assertEqual(ag.readline(), b'line-2') self.assertEqual(ag.readline(), b'line-3\n') #---------------------------------------------------------------------------- def test_load_example(self): out = ET.Element('nodes') for item in asset.load('asset:test/data/**.nl'): cur = ET.SubElement(out, 'node', name=item.name) cur.text = item.read().decode() out = ET.tostring(out) chk = b'''\ line-1 line-2 line-3 sub-file-line-1 ''' self.assertXmlEqual(out, chk) #---------------------------------------------------------------------------- def test_listres(self): self.assertEqual( list(asset.listres('asset', 'test/data', showDirs=True)), [ 'test/data/file1.nl', 'test/data/file2.nl', 'test/data/subdir/', 'test/data/subdir/subfile1.nl', ]) #---------------------------------------------------------------------------- def test_filename_egg(self): # NOTE: this requires that `pxml` be installed as a zipped egg, i.e.: # easy_install --zip-ok pxml if not isEgg('pxml'): raise unittest.SkipTest('package "pxml" must be installed as a zipped egg') for item in asset.load('pxml:__init__.py'): self.assertIsNone(item.filename) #---------------------------------------------------------------------------- def test_filename_noegg(self): # NOTE: this requires that `globre` be installed as an UNzipped pkg, i.e.: # easy_install --always-unzip globre if isEgg('globre'): raise unittest.SkipTest('package "globre" must not be installed as a zipped egg') for item in asset.load('globre:__init__.py'): self.assertIsNotNone(item.filename) #---------------------------------------------------------------------------- def test_readWithSize(self): self.assertEqual( asset.load('asset:test/data/file**').stream().read(), b'line-1\nline-2line-3\n') self.assertEqual( asset.load('asset:test/data/file**').stream().read(1024), b'line-1\nline-2line-3\n') stream = asset.load('asset:test/data/file**').stream() self.assertEqual(stream.read(5), b'line-') self.assertEqual(stream.read(5), b'1\nlin') self.assertEqual(stream.read(5), b'e-2li') self.assertEqual(stream.read(3), b'ne-') self.assertEqual(stream.read(3), b'3\n') self.assertEqual(stream.read(3), b'') #---------------------------------------------------------------------------- def test_streamIteration(self): stream = asset.load('asset:test/data/file**').stream() self.assertEqual(stream.readline(), b'line-1\n') self.assertEqual(stream.readline(), b'line-2') self.assertEqual(stream.readline(), b'line-3\n') self.assertEqual(stream.readline(), b'') stream = asset.load('asset:test/data/file**').stream() chk = list(reversed([ b'line-1\n', b'line-2', b'line-3\n', ])) for line in stream: self.assertEqual(line, chk.pop()) #---------------------------------------------------------------------------- def test_csv(self): import csv lines = [line.decode() for line in asset.load('asset:test/data.csv').stream()] reader = csv.reader(lines) self.assertEqual(six.next(reader), ['a', 'b', 'c']) self.assertEqual(six.next(reader), ['1', '2', '3']) with self.assertRaises(StopIteration): six.next(reader) #---------------------------------------------------------------------------- def test_chunks_bytes(self): src = six.BytesIO('foo-1\nbar\nzig') self.assertEqual( list(asset.chunks(src, 3)), ['foo', '-1\n', 'bar', '\nzi', 'g']) self.assertEqual( list(asset.chunks(asset.load('asset:test/data/file1.nl').stream(), 3)), ['lin', 'e-1', '\nli', 'ne-', '2']) self.assertEqual( list(asset.chunks(asset.load('asset:test/data/file**').stream(), 3)), ['lin', 'e-1', '\nli', 'ne-', '2li', 'ne-', '3\n']) self.assertEqual( list(asset.load('asset:test/data/file1.nl').chunks(3)), ['lin', 'e-1', '\nli', 'ne-', '2']) self.assertEqual( list(asset.load('asset:test/data/file**').chunks(3)), ['lin', 'e-1', '\nli', 'ne-', '2li', 'ne-', '3\n']) #---------------------------------------------------------------------------- def test_chunks_lines(self): src = six.BytesIO('foo-1\nbar\nzig') self.assertEqual( list(asset.chunks(src, 'lines')), ['foo-1\n', 'bar\n', 'zig']) self.assertEqual( list(asset.chunks(asset.load('asset:test/data/file1.nl').stream(), 'lines')), ['line-1\n', 'line-2']) self.assertEqual( list(asset.chunks(asset.load('asset:test/data/file**').stream(), 'lines')), ['line-1\n', 'line-2', 'line-3\n']) self.assertEqual( list(asset.load('asset:test/data/file1.nl').chunks('lines')), ['line-1\n', 'line-2']) self.assertEqual( list(asset.load('asset:test/data/file**').chunks('lines')), ['line-1\n', 'line-2', 'line-3\n']) #------------------------------------------------------------------------------ # end of $Id$ # $ChangeLog$ #------------------------------------------------------------------------------ asset-0.6.13/asset/symbol.py0000664000175000017500000000546212755410424017015 0ustar grabnergrabner00000000000000# -*- coding: utf-8 -*- #------------------------------------------------------------------------------ # file: $Id$ # auth: metagriffin # date: 2013/09/22 # copy: (C) Copyright 2013-EOT metagriffin -- see LICENSE.txt #------------------------------------------------------------------------------ # This software 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 software 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/. #------------------------------------------------------------------------------ import pkg_resources, inspect, six from .isstr import isstr #------------------------------------------------------------------------------ def version(package, default=None): try: return pkg_resources.get_distribution(package).version except: return default #------------------------------------------------------------------------------ def symbol(spec): if not isstr(spec): return spec if ':' in spec: spec, attr = spec.split(':', 1) return getattr(symbol(spec), attr) spec = spec.split('.') used = spec.pop(0) found = __import__(used) for cur in spec: used += '.' + cur try: found = getattr(found, cur) except AttributeError: __import__(used) found = getattr(found, cur) return found #------------------------------------------------------------------------------ def caller(ignore=None): if ignore is None: ignore = [] elif isinstance(ignore, basestring): ignore = [ignore] else: ignore = ignore[:] stack = inspect.stack() record = None one = False try: for record in stack: if not record or not record[0]: continue mod = inspect.getmodule(record[0]) if not mod: continue mod = getattr(mod, '__package__', None) or getattr(mod, '__name__', None) if mod == 'asset' or mod.startswith('asset.'): continue if not one: # we've finally hit the module that actually called `caller`: # ignore it, since we need to return the caller's caller. one = True continue if mod not in ignore: return mod return None finally: del record del stack #------------------------------------------------------------------------------ # end of $Id$ #------------------------------------------------------------------------------ asset-0.6.13/asset/test_plugin.py0000664000175000017500000003706512642300406020042 0ustar grabnergrabner00000000000000# -*- coding: utf-8 -*- #------------------------------------------------------------------------------ # file: $Id$ # auth: metagriffin # date: 2016/01/03 # copy: (C) Copyright 2016-EOT metagriffin -- see LICENSE.txt #------------------------------------------------------------------------------ # This software 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 software 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/. #------------------------------------------------------------------------------ import unittest from aadict import aadict import asset #------------------------------------------------------------------------------ class TestPlugins(unittest.TestCase): maxDiff = None @staticmethod @asset.plugin('test-group', 'test-name') def method(): pass #---------------------------------------------------------------------------- def test_plugin_sorting_intra(self): from .plugin import _sort_plugins self.assertEqual( list(_sort_plugins('myext', [ aadict(name='foo', after=None, before=None, order=8, replace=False, final=True), aadict(name='foo', after=None, before=None, order=2, replace=False, final=False), aadict(name='foo', after=None, before=None, order=9, replace=False, final=False), aadict(name='foo', after=None, before=None, order=5, replace=True, final=False), ])), [ aadict(name='foo', after=None, before=None, order=5, replace=True, final=False), aadict(name='foo', after=None, before=None, order=8, replace=False, final=True), ]) #---------------------------------------------------------------------------- def test_plugin_sorting_inter(self): from .plugin import _sort_plugins self.assertEqual( list(_sort_plugins('myext', [ aadict(name='a', after=None, before=None, order=8, replace=False, final=False), aadict(name='b', after=None, before=None, order=9, replace=False, final=False), aadict(name='b', after=None, before=None, order=2, replace=False, final=True), aadict(name='a', after='b', before=None, order=5, replace=False, final=True), aadict(name='c', after=None, before='a', order=0, replace=False, final=False), ])), [ aadict(name='b', after=None, before=None, order=2, replace=False, final=True), aadict(name='c', after=None, before='a', order=0, replace=False, final=False), aadict(name='a', after='b', before=None, order=5, replace=False, final=True), ]) #---------------------------------------------------------------------------- def test_plugin_sorting_spec_valid(self): from .plugin import _sort_plugins self.assertEqual( list(_sort_plugins('myext', [ aadict(name='a', after=None, before=None, order=8, replace=False, final=False), aadict(name='b', after=None, before=None, order=9, replace=False, final=False), aadict(name='b', after=None, before=None, order=2, replace=False, final=True), aadict(name='a', after='b', before=None, order=5, replace=False, final=True), aadict(name='c', after=None, before='a', order=0, replace=False, final=False), ], 'c,b,a')), [ aadict(name='c', after=None, before='a', order=0, replace=False, final=False), aadict(name='b', after=None, before=None, order=2, replace=False, final=True), aadict(name='a', after='b', before=None, order=5, replace=False, final=True), ]) self.assertEqual( list(_sort_plugins('myext', [ aadict(name='a', after=None, before=None, order=8, replace=False, final=False), aadict(name='b', after=None, before=None, order=9, replace=False, final=False), aadict(name='b', after=None, before=None, order=2, replace=False, final=True), aadict(name='a', after='b', before=None, order=5, replace=False, final=True), aadict(name='c', after=None, before='a', order=0, replace=False, final=False), ], '-c')), [ aadict(name='b', after=None, before=None, order=2, replace=False, final=True), aadict(name='a', after='b', before=None, order=5, replace=False, final=True), ]) #---------------------------------------------------------------------------- def test_plugin_sorting_spec_invalid(self): from .plugin import _sort_plugins with self.assertRaises(TypeError) as cm: list(_sort_plugins('myext', [ aadict(name='a', after=None, before=None, order=8, replace=False, final=False), aadict(name='b', after=None, before=None, order=9, replace=False, final=False), aadict(name='b', after=None, before=None, order=2, replace=False, final=True), aadict(name='a', after='b', before=None, order=5, replace=False, final=True), aadict(name='c', after=None, before='a', order=0, replace=False, final=False), ], '-c,-b')) self.assertEqual( str(cm.exception), "myext plugin type 'a' specified unavailable 'after' dependency 'b'") #---------------------------------------------------------------------------- def test_plugin_sorting_unavailable(self): from .plugin import _sort_plugins with self.assertRaises(TypeError) as cm: list(_sort_plugins('myext', [ aadict(name='bar', after='foo', before=None, order=0, replace=False, final=False), ])) self.assertEqual( str(cm.exception), "myext plugin type 'bar' specified unavailable 'after' dependency 'foo'") with self.assertRaises(TypeError) as cm: list(_sort_plugins('myext', [ aadict(name='bar', after=None, before='foo', order=0, replace=False, final=False), ])) self.assertEqual( str(cm.exception), "myext plugin type 'bar' specified unavailable 'before' dependency 'foo'") with self.assertRaises(TypeError) as cm: list(_sort_plugins('myext', [ aadict(name='foo', after=None, before='bar', order=0, replace=False, final=False), aadict(name='bar', after=None, before='foo', order=0, replace=False, final=False), ])) self.assertEqual( str(cm.exception), "myext has cyclical dependencies in plugins ['bar', 'foo']") #---------------------------------------------------------------------------- def test_plugin_spec_valid(self): import re from .plugin import _parse_spec self.assertEqual(_parse_spec(None), ()) self.assertEqual(_parse_spec('*'), ()) self.assertEqual(_parse_spec('-foo,+bar'), (aadict(op='-', target='foo'), aadict(op='+', target='bar'))) self.assertEqual(_parse_spec('-foo,-bar'), (aadict(op='-', target='foo'), aadict(op='-', target='bar'))) self.assertEqual(_parse_spec(' - foo, - bar'), (aadict(op='-', target='foo'), aadict(op='-', target='bar'))) self.assertEqual(_parse_spec(' - foo - bar '), (aadict(op='-', target='foo'), aadict(op='-', target='bar'))) self.assertEqual(_parse_spec('foo,?bar'), (aadict(op=' ', target='foo'), aadict(op='?', target='bar'))) self.assertEqual(_parse_spec('foo,?bar'), (aadict(op=' ', target='foo'), aadict(op='?', target='bar'))) self.assertEqual( _parse_spec('/(foo|bar)/'), (aadict(op='/', target=re.compile('(foo|bar)')),)) self.assertEqual( _parse_spec('+zig,/(foo|bar)/'), (aadict(op='+', target='zig'), aadict(op='/', target=re.compile('(foo|bar)')))) self.assertEqual( _parse_spec('/zig,/(foo|bar)/'), (aadict(op='/', target=re.compile('zig,/(foo|bar)')),)) #---------------------------------------------------------------------------- def test_plugin_spec_invalid(self): from .plugin import _parse_spec with self.assertRaises(ValueError) as cm: _parse_spec('foo,-bar') self.assertEqual( str(cm.exception), "invalid mixing of relative (['-']) and absolute ([' ']) prefixes in plugin specification") with self.assertRaises(ValueError) as cm: _parse_spec('-foo,bar') self.assertEqual( str(cm.exception), "invalid mixing of relative (['-']) and absolute ([' ']) prefixes in plugin specification") with self.assertRaises(ValueError) as cm: _parse_spec('-foo,?bar') self.assertEqual( str(cm.exception), "invalid mixing of relative (['-']) and absolute (['?']) prefixes in plugin specification") with self.assertRaises(ValueError) as cm: _parse_spec('/foo') self.assertEqual( str(cm.exception), 'regex plugin loading expression must start and end with "/"') #---------------------------------------------------------------------------- def test_plugin_spec_match(self): from .plugin import _parse_spec, _match_spec self.assertTrue(_match_spec(_parse_spec('*'), 'foo')) self.assertTrue(_match_spec(_parse_spec('/foo/'), 'foo')) self.assertFalse(_match_spec(_parse_spec('/foo/'), 'bar')) self.assertTrue(_match_spec(_parse_spec('/(foo|bar)/'), 'foo')) self.assertTrue(_match_spec(_parse_spec('/(foo|bar)/'), 'bar')) self.assertTrue(_match_spec(_parse_spec('foo,?bar'), 'foo')) self.assertTrue(_match_spec(_parse_spec('foo,?bar'), 'bar')) self.assertTrue(_match_spec(_parse_spec('-foo'), 'bar')) self.assertFalse(_match_spec(_parse_spec('-foo'), 'foo')) self.assertFalse(_match_spec(_parse_spec('foo,?bar'), 'zog')) self.assertTrue(_match_spec(_parse_spec('+foo'), 'foo')) self.assertTrue(_match_spec(_parse_spec('+foo'), 'bar')) #---------------------------------------------------------------------------- def test_plugin_asset_load(self): from .plugin import plugins, _load_asset_plugin self.assertEqual( _load_asset_plugin(aadict(target='asset.test_plugin.TestPlugins.method')).handle, self.method) plugs = list(plugins('test-group', 'asset.test_plugin.TestPlugins.method')) self.assertEqual( [plin.handle for plin in plugs], [self.method]) with self.assertRaises(ValueError) as cm: list(plugins('test-group', 'asset.test_plugin.TestPlugins.no_such_method')) self.assertEqual( str(cm.exception), "could not load plugin 'asset.test_plugin.TestPlugins.no_such_method'") #---------------------------------------------------------------------------- def test_plugin_asset_mixed(self): from .plugin import _sort_plugins self.assertEqual( list(_sort_plugins('myext', [ aadict(name='a', after=None, before=None, order=8, replace=False, final=False), aadict(name='b', after=None, before=None, order=9, replace=False, final=False), aadict(name='b', after=None, before=None, order=2, replace=False, final=True), aadict(name='a', after='b', before=None, order=5, replace=False, final=True), aadict(name='c', after=None, before='b', order=0, replace=False, final=False), aadict(name='d.e', after='b', before='a', order=0, replace=False, final=False), ], '+d.e')), [ aadict(name='c', after=None, before='b', order=0, replace=False, final=False), aadict(name='b', after=None, before=None, order=2, replace=False, final=True), aadict(name='d.e', after='b', before='a', order=0, replace=False, final=False), aadict(name='a', after='b', before=None, order=5, replace=False, final=True), ]) #---------------------------------------------------------------------------- def test_plugin_decorator(self): from .plugin import plugin @plugin('asset.example', 'foo', before='bar') def my_foo_plugin(): pass @plugin('asset.example', 'bar', after='foo', order=3, replace=True, final=True) def my_bar_plugin(): pass self.assertEqual(my_foo_plugin.plugin_group, 'asset.example') self.assertEqual(my_foo_plugin.plugin_name, 'foo') self.assertEqual(my_foo_plugin.before, 'bar') self.assertFalse(hasattr(my_foo_plugin, 'after')) self.assertFalse(hasattr(my_foo_plugin, 'order')) self.assertFalse(hasattr(my_foo_plugin, 'replace')) self.assertFalse(hasattr(my_foo_plugin, 'final')) self.assertEqual(my_bar_plugin.plugin_group, 'asset.example') self.assertEqual(my_bar_plugin.plugin_name, 'bar') self.assertEqual(my_bar_plugin.after, 'foo') self.assertFalse(hasattr(my_bar_plugin, 'before')) self.assertEqual(my_bar_plugin.order, 3) self.assertEqual(my_bar_plugin.replace, True) self.assertEqual(my_bar_plugin.final, True) #---------------------------------------------------------------------------- def test_plugin_can_declare_name(self): pset = asset.plugins( 'test-group', 'asset.test_plugin.TestPlugins.method') self.assertEqual(pset.plugins[0].name, 'test-name') #------------------------------------------------------------------------------ class TestPluginSet(unittest.TestCase): maxDiff = None @staticmethod def increment(value, counter=None, **kw): if counter: counter() if 'abort' in kw and value == kw['abort']: return None if value is None: return None return value + 1 @staticmethod @asset.plugin('test-group', 'decrement') def decrement(value): return value - 1 #---------------------------------------------------------------------------- def test_filter_empty(self): self.assertEqual( 'foo', asset.PluginSet('group', None, []).filter('foo')) #---------------------------------------------------------------------------- def test_handle_empty(self): with self.assertRaises(ValueError) as cm: asset.PluginSet('group', None, []).handle('foo') self.assertEqual( str(cm.exception), "No plugins available in group 'group'") #---------------------------------------------------------------------------- def test_filter_aborts(self): count = dict(value=0) def counter(): count['value'] = count['value'] + 1 pset = asset.plugins( 'test-group', ','.join(['asset.test_plugin.TestPluginSet.increment'] * 5)) self.assertEqual(pset.filter(0, abort=2, counter=counter), None) self.assertEqual(count['value'], 3) #---------------------------------------------------------------------------- def test_handle_perseveres(self): count = dict(value=0) def counter(): count['value'] = count['value'] + 1 pset = asset.plugins( 'test-group', ','.join(['asset.test_plugin.TestPluginSet.increment'] * 5)) self.assertEqual(pset.handle(0, abort=2, counter=counter), None) self.assertEqual(count['value'], 5) #---------------------------------------------------------------------------- def test_select(self): pset = asset.plugins( 'test-group', ','.join([ 'asset.test_plugin.TestPluginSet.increment', 'asset.test_plugin.TestPluginSet.decrement'])) pset2 = pset.select('decrement') self.assertEqual( [p.handle for p in pset.plugins], [self.increment, self.decrement]) self.assertEqual( [p.handle for p in pset2.plugins], [self.decrement]) #---------------------------------------------------------------------------- def test_repr(self): self.assertEqual( repr(asset.plugins( 'test-group', 'asset.test_plugin.TestPluginSet.decrement')), "") #------------------------------------------------------------------------------ # end of $Id$ # $ChangeLog$ #------------------------------------------------------------------------------ asset-0.6.13/asset/__init__.py0000664000175000017500000000246012641645537017253 0ustar grabnergrabner00000000000000# -*- coding: utf-8 -*- #------------------------------------------------------------------------------ # file: $Id$ # auth: metagriffin # date: 2013/09/21 # copy: (C) Copyright 2013-EOT metagriffin -- see LICENSE.txt #------------------------------------------------------------------------------ # This software 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 software 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/. #------------------------------------------------------------------------------ from .symbol import * from .resource import * from .isstr import isstr from .plugin import plugin, plugins, PluginSet #------------------------------------------------------------------------------ # end of $Id$ #------------------------------------------------------------------------------ asset-0.6.13/asset/test/0000775000175000017500000000000013566560742016120 5ustar grabnergrabner00000000000000asset-0.6.13/asset/test/data/0000775000175000017500000000000013566560742017031 5ustar grabnergrabner00000000000000asset-0.6.13/asset/test/data/subdir/0000775000175000017500000000000013566560742020321 5ustar grabnergrabner00000000000000asset-0.6.13/asset/test/data/subdir/subfile1.nl0000664000175000017500000000002012234011116022327 0ustar grabnergrabner00000000000000sub-file-line-1 asset-0.6.13/asset/test/data/file1.nl0000664000175000017500000000001512233676644020357 0ustar grabnergrabner00000000000000line-1 line-2asset-0.6.13/asset/test/data/file2.nl0000664000175000017500000000000712233676644020361 0ustar grabnergrabner00000000000000line-3 asset-0.6.13/asset/test/data.csv0000664000175000017500000000001412272523461017527 0ustar grabnergrabner00000000000000a,b,c 1,2,3 asset-0.6.13/asset/resource.py0000664000175000017500000002313213566560454017343 0ustar grabnergrabner00000000000000# -*- coding: utf-8 -*- #------------------------------------------------------------------------------ # file: $Id$ # auth: metagriffin # date: 2013/09/22 # copy: (C) Copyright 2013-EOT metagriffin -- see LICENSE.txt #------------------------------------------------------------------------------ # This software 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 software 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/. #------------------------------------------------------------------------------ import re import os import functools import pkg_resources import six import globre from .symbol import symbol #------------------------------------------------------------------------------ MAXBUF = 8192 #------------------------------------------------------------------------------ class NoSuchAsset(Exception): pass #------------------------------------------------------------------------------ class AssetGroupStream(object): # TODO: implement all expected file-like methods... def __init__(self, group): self.group = group self.assets = iter(group) self._cur = None def read(self, size=-1): ret = b'' if self._cur is None else self._cur.read(size) if size >= 0 and len(ret) >= size: return ret while True: try: self._cur = six.next(self.assets) except StopIteration: self._cur = None return ret ret += self._cur.read(( size - len(ret) ) if size > 0 else -1) if size >= 0 and len(ret) >= size: return ret def readline(self): if self._cur is None: try: self._cur = six.next(self.assets) except StopIteration: self._cur = None return b'' while True: ret = self._cur.readline() if ret: return ret try: self._cur = six.next(self.assets) except StopIteration: self._cur = None return b'' def chunks(self, *args, **kws): return chunks(self, *args, **kws) def close(self): pass def __iter__(self): while True: line = self.readline() if not line: return yield line #------------------------------------------------------------------------------ class AssetGroup(object): # TODO: implement all expected file-like methods... def __init__(self, package, package_dir, regex, spec): # todo: remove `package_dir` -- it should be inferred... self.package = package self.pkgdir = package_dir self.regex = regex self.spec = spec self._fp = None def peek(self): for pkg, res in self.resources(): return self def count(self): return len(self) def exists(self): try: self.peek() return True except NoSuchAsset: return False def resources(self): count = 0 for resource in listres(self.package, self.pkgdir): if not self.regex.match(resource): continue count += 1 yield (self.package, resource) if count <= 0: raise NoSuchAsset('No asset matched "%s"' % (self.spec,)) def chunks(self, *args, **kws): return self._stream().chunks(*args, **kws) def __len__(self): return len(list(self.resources())) def __iter__(self): for pkg, res in self.resources(): yield Asset(self, pkg, res) def stream(self): return AssetGroupStream(self) def _stream(self): if self._fp is None: self._fp = self.stream() return self._fp def read(self, size=-1): return self._stream().read(size) def readline(self): return self._stream().readline() #------------------------------------------------------------------------------ class AssetStream(object): # TODO: implement all expected file-like methods... def __init__(self, stream, asset): self.stream = stream self.asset = asset def read(self, size=-1): return self.stream.read(size) def readline(self): return self.stream.readline() def close(self): pass def chunks(self, *args, **kws): return chunks(self.stream, *args, **kws) def __iter__(self): while True: line = self.readline() if not line: return yield line #------------------------------------------------------------------------------ class Asset(object): # todo: should all returned streams be "AssetStream"s that provide # a .asset attribute, like TransformerStream does? # TODO: implement all expected file-like methods... def __init__(self, group, package, name): self.group = group self.package = package self.name = name self._fp = None def __str__(self): return '%s:%s' % (self.package, self.name) def stream(self): return AssetStream( pkg_resources.resource_stream(self.package, self.name), self) def _stream(self): if self._fp is None: self._fp = self.stream() return self._fp def read(self, size=-1): return self._stream().read(size) def readline(self): return self._stream().readline() # compatibility with AssetGroup() API... def peek(self): if pkg_resources.resource_exists(self.package, self.name): return self raise NoSuchAsset('No asset matched "%s:%s"' % (self.package, self.name)) def count(self): return len(self) def exists(self): try: self.peek() return True except NoSuchAsset: return False def resources(self): self.peek() yield (self.package, self.name) def chunks(self, *args, **kws): return self._stream().chunks(*args, **kws) def __len__(self): self.peek() return 1 def __iter__(self): self.peek() yield self def __repr__(self): return ''.format(self.package, self.name) @property def filename(self): prov = pkg_resources.get_provider(self.package) if isinstance(prov, pkg_resources.ZipProvider): return None return pkg_resources.resource_filename(self.package, self.name) defaultExclude = ('.rcs', '.svn', '.git', '.hg') #------------------------------------------------------------------------------ def listres(pkgname, pkgdir, recursive=True, depthFirst=False, exclude=defaultExclude, showDirs=False, ): reslist = [os.path.join(pkgdir, cur) for cur in pkg_resources.resource_listdir(pkgname, pkgdir) if cur not in exclude] dirs = [] for cur in sorted(reslist): if pkg_resources.resource_isdir(pkgname, cur): if showDirs: yield cur + '/' if recursive: if depthFirst: for subcur in listres(pkgname, cur): yield subcur else: dirs.append(cur) else: yield cur for cur in dirs: for subcur in listres(pkgname, cur): yield subcur #------------------------------------------------------------------------------ def load(pattern, *args, **kws): ''' Given a package asset-spec glob-pattern `pattern`, returns an :class:`AssetGroup` object, which in turn can act as a generator of :class:`Asset` objects that match the pattern. Example: .. code-block:: python import asset # concatenate all 'css' files into one string: css = asset.load('mypackage:static/style/**.css').read() NOTE: currently, any extra parameters and keywords beyond `pattern` are ignored. ''' # todo: why are `args` and `kws` being ignored?... spec = pattern if ':' not in pattern: raise ValueError('`pattern` must be in the format "PACKAGE:GLOB"') pkgname, pkgpat = pattern.split(':', 1) pkgdir, pattern = globre.compile(pkgpat, split_prefix=True, flags=globre.EXACT) if pkgdir: idx = pkgdir.rfind('/') pkgdir = pkgdir[:idx] if idx >= 0 else '' group = AssetGroup(pkgname, pkgdir, pattern, spec) if globre.iswild(pkgpat): return group return Asset(group, pkgname, pkgpat) #------------------------------------------------------------------------------ def exists(pattern, *args, **kws): ''' Helper method to check to see if a `load` will be successful, effectively identical to:: from asset import load, NoSuchAsset try: load(pattern).peek() return True except NoSuchAsset: return False ''' return load(pattern, *args, **kws).exists() #------------------------------------------------------------------------------ def chunks(stream, size=None): ''' Returns a generator of chunks from the `stream` with a maximum size of `size`. I don't know why this isn't part of core Python. :Parameters: stream : file-like object The stream to fetch the chunks from. Note that the stream will not be repositioned in any way. size : int | 'lines'; default: null If a integer, the size of the chunks to return. If the string ``"lines"``, then behaves the same as `file.read()`. If unspecified or null, defaults to the package default MAXBUF size (usually 8 KiB). ''' if size == 'lines': for item in stream: # for item in stream.readline(): yield item return if size is None: size = MAXBUF while True: buf = stream.read(size) if not buf: return yield buf #------------------------------------------------------------------------------ # end of $Id$ # $ChangeLog$ #------------------------------------------------------------------------------ asset-0.6.13/asset/plugin.py0000664000175000017500000004011012715147755017005 0ustar grabnergrabner00000000000000# -*- coding: utf-8 -*- #------------------------------------------------------------------------------ # file: $Id$ # auth: metagriffin # date: 2015/11/12 # copy: (C) Copyright 2015-EOT metagriffin -- see LICENSE.txt #------------------------------------------------------------------------------ # This software 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 software 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/. #------------------------------------------------------------------------------ import re import logging import six import pkg_resources from aadict import aadict from .symbol import symbol #------------------------------------------------------------------------------ log = logging.getLogger(__name__) #------------------------------------------------------------------------------ class PluginSet(object): ''' A PluginSet is a list of `Plugin` objects that can be iterated over to get each Plugin, but it also has some methods that operate on all plugins together. ''' #---------------------------------------------------------------------------- def __init__(self, group, spec, plugins, *args, **kw): super(PluginSet, self).__init__(*args, **kw) self.group = group self.spec = spec self.plugins = plugins or [] #---------------------------------------------------------------------------- def handle(self, object, *args, **kw): ''' Calls each plugin in this PluginSet with the specified object, arguments, and keywords in the standard group plugin order. The return value from each successive invoked plugin is passed as the first parameter to the next plugin. The final return value is the object returned from the last plugin. If this plugin set is empty (i.e. no plugins exist or matched the spec), then a ValueError exception is thrown. ''' if not bool(self): if not self.spec or self.spec == SPEC_ALL: raise ValueError('No plugins available in group %r' % (self.group,)) raise ValueError( 'No plugins in group %r matched %r' % (self.group, self.spec)) for plugin in self.plugins: object = plugin.handle(object, *args, **kw) return object #---------------------------------------------------------------------------- def filter(self, object, *args, **kw): ''' Identical to `PluginSet.handle`, except: #. If this plugin set is empty, `object` is returned as-is. #. If any plugin returns ``None``, it is returned without calling any further plugins. ''' for plugin in self.plugins: object = plugin.handle(object, *args, **kw) if object is None: return object return object #---------------------------------------------------------------------------- def select(self, name): ''' Returns a new PluginSet that has only the plugins in this that are named `name`. ''' return PluginSet(self.group, name, [ plug for plug in self.plugins if plug.name == name]) #---------------------------------------------------------------------------- def __bool__(self): return bool(self.plugins) #---------------------------------------------------------------------------- def __len__(self): return len(self.plugins) #---------------------------------------------------------------------------- def __iter__(self): return iter(self.plugins) #---------------------------------------------------------------------------- def __repr__(self): return '' % ( self.group, [plug.name for plug in self.plugins]) #------------------------------------------------------------------------------ def plugins(group, spec=None): # TODO: share this documentation with `../doc/plugin.rst`... ''' Returns a `PluginSet` object for the specified setuptools-style entrypoint `group`. This is just a wrapper around `pkg_resources.iter_entry_points` that allows the plugins to sort and override themselves. The optional `spec` parameter controls how and what plugins are loaded. If it is ``None`` or the special value ``'*'``, then the normal plugin loading will occur, i.e. all registered plugins will be loaded and their self-declared ordering and dependencies will be applied. Otherwise, the `spec` is taken as a comma- or whitespace-separated list of plugins to load. In this mode, the `spec` can either specify an exact list of plugins to load, in the specified order, referred to as an "absolute" spec. Otherwise, it is a "relative" spec, which indicates that it only adjusts the standard registered plugin loading. A spec is a list of either absolute or relative instructions, and they cannot be mixed. In either mode, a plugin is identified either by name for registered plugins (e.g. ``foo``), or by fully-qualified Python module and symbol name for unregistered plugins (e.g. ``package.module.symbol``). Plugins in an absolute spec are loaded in the order specified and can be optionally prefixed with the following special characters: * ``'?'`` : the specified plugin should be loaded if available. If it is not registered, cannot be found, or cannot be loaded, then it is ignored (a DEBUG log message will be emitted, however). Plugins in a relative spec are always prefixed with at least one of the following special characters: * ``'-'`` : removes the specified plugin; this does not affect plugin ordering, it only removes the plugin from the loaded list. If the plugin does not exist, no error is thrown. * ``'+'`` : adds or requires the specified plugin to the loaded set. If the plugin is not a named/registered plugin, then it will be loaded as an asset-symbol, i.e. a Python-dotted module and symbol name. If the plugin does not exist or cannot be loaded, this will throw an error. It does not affect the plugin ordering of registered plugins. * ``'/'`` : the plugin name is taken as a regular expression that will be used to match plugin names and it must terminate in a slash. Note that this must be the **last** element in the spec list. Examples: * ``'*'`` : load all registered plugins. * ``'foo,bar'`` : load the "foo" plugin, then the "bar" plugin. * ``'foo,?bar'`` : load the "foo" plugin and if the "bar" plugin exists, load it too. * ``'-zig'`` : load all registered plugins except the "zig" plugin. * ``'+pkg.foo.bar'`` : load all registered plugins and then load the "pkg.foo.bar" Python symbol. * ``'pkg.foo.bar'`` : load only the "pkg.foo.bar" Python symbol. ''' pspec = _parse_spec(spec) plugs = list(_get_registered_plugins(group, pspec)) plugs += list(_get_unregistered_plugins(group, plugs, pspec)) return PluginSet(group, spec, list(_sort_plugins(group, plugs, pspec, spec))) #------------------------------------------------------------------------------ # relative specs: SPEC_ADD = '+' SPEC_REM = '-' SPEC_RE = '/' # absolute specs: SPEC_SET = ' ' SPEC_OPT = '?' SPEC_ALL = '*' _specsep_cre = re.compile(r'(^|\s+)([-+?])\s*') _specname_cre = re.compile(r'^[a-zA-Z_]') _spec_rel = set((SPEC_ADD, SPEC_REM, SPEC_RE)) _spec_abs = set((SPEC_SET, SPEC_OPT)) #------------------------------------------------------------------------------ def _parse_spec(spec): if isinstance(spec, tuple): return spec wspec = spec.strip() if spec else None if not wspec or wspec == SPEC_ALL: return () respec = None if wspec.endswith('/'): if len(wspec.split('/')) <= 2: raise ValueError( 'regex plugin loading expression must start and end with "/"') wspec, respec = wspec.split('/', 1) respec = respec[:-1] if wspec.strip() \ and not ( wspec.strip().endswith(',') or wspec != wspec.rstrip() ): raise ValueError( 'regex plugin loading expression must start and end with "/"') wspec = wspec.replace(',', ' ') wspec = _specsep_cre.sub(r' \2', wspec) wspec = [e.strip() for e in wspec.split()] ret = [] for item in wspec: if not item.strip(): continue item = aadict(op=SPEC_SET, target=item) if item.target and item.target[0] in (SPEC_ADD, SPEC_REM, SPEC_OPT): item = aadict(op=item.target[0], target=item.target[1:].strip()) if item.target and item.target[0] in (SPEC_RE,): raise ValueError( 'regex plugin loading expression must start and end with "/"') if not _specname_cre.match(item.target): raise ValueError( 'invalid plugin name in specification expression: %r' % (item.target,)) ret.append(item) if respec: ret.append(aadict(op=SPEC_RE, target=re.compile(respec))) ops = set([item.op for item in ret]) rel = ops & _spec_rel abs = ops & _spec_abs if bool(ops & rel) and bool(ops & abs): raise ValueError( 'invalid mixing of relative (%r) and absolute (%r) prefixes in plugin specification' % (list(rel), list(abs))) return tuple(ret) #------------------------------------------------------------------------------ def _match_spec(spec, name): if not spec: return True for idx, item in enumerate(spec): if item.op == SPEC_RE: if item.target.match(name): return True if ( idx + 1 ) >= len(spec): return False continue if item.target != name: continue if item.op == SPEC_REM: return False return True if spec[0].op in _spec_rel: return True return False #------------------------------------------------------------------------------ def _decorate_plugin(plugin): plugin.after = getattr(plugin.handle, 'after', None) plugin.before = getattr(plugin.handle, 'before', None) plugin.order = getattr(plugin.handle, 'order', 0) plugin.replace = getattr(plugin.handle, 'replace', False) plugin.final = getattr(plugin.handle, 'final', False) plugin.name = getattr(plugin.handle, 'plugin_name', plugin.name) #------------------------------------------------------------------------------ def _get_registered_plugins(group, spec=None): spec = _parse_spec(spec) for entrypoint in pkg_resources.iter_entry_points(group): plugin = aadict( name = entrypoint.name, entrypoint = entrypoint, ) if _match_spec(spec, plugin.name): try: plugin.handle = entrypoint.load() except ImportError as err: log.exception( 'Could not load plugin "%s" in group "%s": %s', entrypoint.name, group, str(err)) raise _decorate_plugin(plugin) yield plugin #------------------------------------------------------------------------------ def _load_asset_plugin(spec): plugin = aadict( name = spec.target, entrypoint = None, handle = symbol(spec.target), ) _decorate_plugin(plugin) if plugin.name != spec.target: # todo: this is a hack so that plugins can be loaded by their # dotted path, BUT they can declare themselves with a different # name. the effect here is that `_load_asset_plugin` has the side # effect of updating the spec to the declared name... # this is only needed in *very* odd circumstances... # the "right" way to do this is for the `spec` to only be applied # once, during load, so that if it specifies the load of a # dotted path, it will never be re-tested... ugh. spec.target = plugin.name return plugin #------------------------------------------------------------------------------ def _get_unregistered_plugins(group, plugins, spec=None): spec = _parse_spec(spec) names = [plug.name for plug in plugins] for item in spec: if item.op in (SPEC_REM, SPEC_RE) or item.target in names: continue try: yield _load_asset_plugin(item) except Exception: if item.op in (SPEC_OPT,): log.debug('could not load optional plugin %r', item.target) continue raise ValueError('could not load plugin %r' % (item.target,)) #------------------------------------------------------------------------------ def _sort_plugins(group, plugins, spec=None, ospec=None): spec = _parse_spec(spec) lut = dict() for plugin in plugins: if plugin.name not in lut: lut[plugin.name] = [] lut[plugin.name].append(plugin) # order the plugins within each named group by order/replace/final for name, plugs in list(lut.items()): plugs = sorted(plugs, key=lambda plug: plug.order) for idx, plug in enumerate(plugs): if plug.final: plugs = plugs[:idx + 1] break for idx, plug in enumerate(reversed(plugs)): if plug.replace: plugs = plugs[len(plugs) - idx - 1:] lut[name] = plugs # apply `spec` names = sorted(set( [name for name in lut.keys() if _match_spec(spec, name)])) if spec and spec[0].op not in _spec_rel: snames = [] for item in spec: if item.target in names: if item.target not in snames: snames.append(item.target) continue if item.op == SPEC_OPT: continue raise TypeError( '%s plugin spec %r specified unavailable dependency %r' % (group, ospec or spec, item.target)) for name in snames: for plug in lut[name]: yield plug return # order the named groups by after/before reqs = dict() for name in names: reqs[name] = aadict(after=[], before=[]) for plug in lut[name]: if plug.after: reqs[name].after += [p.strip() for p in plug.after.split(',')] if plug.before: reqs[name].before += [p.strip() for p in plug.before.split(',')] reqs[name].after = [aft for aft in reqs[name].after if aft] reqs[name].before = [bef for bef in reqs[name].before if bef] # simplify after/before evaluation by pushing before's into after's for name in names: for aft in reqs[name].after: opt = aft.startswith(SPEC_OPT) if not opt and aft not in names: raise TypeError( '%s plugin type %r specified unavailable \'after\' dependency %r' % (group, name, aft)) for bef in reqs[name].before: opt = bef.startswith(SPEC_OPT) if opt: bef = bef[1:] if bef not in names: if not opt: raise TypeError( '%s plugin type %r specified unavailable \'before\' dependency %r' % (group, name, bef)) continue reqs[bef].after.append(name) # created the ordered list obeying the 'after' rules snames = [] while len(snames) < len(names): cur = len(snames) for name in names: if name in snames: continue ok = True for aft in reqs[name].after: opt = aft.startswith(SPEC_OPT) if opt: aft = aft[1:] if aft not in snames and aft in names: ok = False if ok: snames.append(name) if len(snames) == cur: raise TypeError( '%s has cyclical dependencies in plugins %r' % (group, sorted(list(set(names) - set(snames))),)) for name in snames: for plug in lut[name]: yield plug #------------------------------------------------------------------------------ def plugin(group, name, after=None, before=None, order=None, replace=None, final=None): def _wrapper(func): func.plugin_group = group func.plugin_name = name if after is not None: func.after = after if before is not None: func.before = before if order is not None: func.order = order if replace is not None: func.replace = replace if final is not None: func.final = final return func return _wrapper #------------------------------------------------------------------------------ # end of $Id$ # $ChangeLog$ #------------------------------------------------------------------------------ asset-0.6.13/asset/isstr.py0000664000175000017500000000250312510017172016635 0ustar grabnergrabner00000000000000# -*- coding: utf-8 -*- #------------------------------------------------------------------------------ # file: $Id$ # auth: metagriffin # date: 2013/09/22 # copy: (C) Copyright 2013-EOT metagriffin -- see LICENSE.txt #------------------------------------------------------------------------------ # This software 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 software 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/. #------------------------------------------------------------------------------ import six if six.PY3: def isstr(obj): return isinstance(obj, str) else: def isstr(obj): return isinstance(obj, basestring) #------------------------------------------------------------------------------ # end of $Id$ #------------------------------------------------------------------------------ asset-0.6.13/README.rst0000664000175000017500000001105113074240237015473 0ustar grabnergrabner00000000000000================================ Generalized Package Asset Loader ================================ Loads resources and symbols from a python package, whether installed as a directory, an egg, or in source form. Also provides some other package-related helper methods, including ``asset.version()``, ``asset.caller()``, and ``asset.chunks()``. TL;DR ===== Install: .. code:: bash $ pip install asset Load symbols (e.g. functions, classes, or variables) from a package by name: .. code:: python import asset # load the 'mypackage.foo.myfunc' function and call it with some parameter retval = asset.symbol('mypackage.foo.myfunc')(param='value') Load data files from a package: .. code:: python # load the file 'mypackage/templates/data.txt' into string data = asset.load('mypackage:templates/data.txt').read() # or as a file-like stream stream = asset.load('mypackage:templates/data.txt').stream() data = stream.read() Multiple files can be operated on at once by using `globre `_ style wildcards: .. code:: python # concatenate all 'css' files into one string: css = asset.load('mypackage:static/style/**.css').read() # load all '.txt' files, XML-escaping the data and wrapping # each file in an ... element. import xml.etree.ElementTree as ET data = ET.Element('nodes') for item in asset.load('asset:**.txt'): cur = ET.SubElement(data, 'node', name=item.name) cur.text = item.read() data = ET.tostring(data) Query the installed version of a package: .. code:: python asset.version('asset') # ==> '0.0.5' asset.version('python') # ==> '2.7' asset.version('no-such-package') # ==> None Find out what package is calling the current function: .. code:: python # assuming the call stack is: # in package "zig" a function "x", which calls # in package "bar" a function "y", which calls # in package "foo" a function "callfoo" defined as: def callfoo(): asset.caller() # ==> 'bar' asset.caller(ignore='bar') # ==> 'zig' asset.caller(ignore=['bar', 'zig']) # ==> None Call all the plugins for a given group: .. code:: python for plugin in asset.plugins('mypackage.plugins'): plugin.handle() Filter an object through all the plugins for a given group (if there are no plugins, this will simply return `thing`): .. code:: python result = asset.plugins('mypackage.plugins').filter(thing) Load all registered plugins, select the ones named `foo` and invoke them (this will fail if there is no `foo` plugin): .. code:: python result = asset.plugins('mypackage.plugins').select('foo').handle(thing) Chunk a file (or any file-like object) into 1 KiB chunks: .. code:: python with open('/var/binary/data', 'rb') as fp: for chunk in asset.chunks(fp, 1024): # ... do something with `chunk` ... Chunk an Asset stream (here using the `.chunks` alias method): .. code:: python for chunk in asset.load('mypackage:data/**.bin').chunks(): # ... using the default chunk size (usually 8 KiB) ... Testing ======= In order to run the unit tests correctly, the `pxml` package needs to be installed as a zipped package (i.e. an "egg") and the `globre` package needs to be installed unzipped. To accomplish that, do: .. code:: bash $ easy_install --zip-ok pxml $ easy_install --always-unzip globre The reason is that the unit tests confirm that `asset` can load assets from both zipped and unzipped packages, and can also identify in which mode it is operating. Details ======= TODO: add detailed docs... * ``Asset.filename``: If the asset represents a file on the filesystem, is the absolute path to the specified file. Otherwise is ``None``. * ``AssetGroupStream.readline()``: Returns the next line from the aggregate asset group stream, as if the assets had been concatenate into a single asset. **IMPORTANT**: if an asset ends with content that is not terminated by an EOL token, it is returned as-is, i.e. it does NOT append the first line from the next asset. Note: because ``asset.load()`` does lazy-loading, it only throws a `NoSuchAsset` exception when you actually attempt to use the AssetGroup! If you need an immediate error, use the `peek()` method. Note that it returns itself, so you can do something like: .. code:: python import asset def my_function_that_returns_an_iterable(): return asset.load(my_spec).peek() # this returns exactly the same thing as the following: # # return asset.load(my_spec) # # but throws an exception early if there are no matching assets. asset-0.6.13/TODO.txt0000664000175000017500000000563613566557511015342 0ustar grabnergrabner00000000000000* make this work:: from nitro.utils import csviter import asset for record in csviter(asset.load('{ASSETSPEC}')): ... currently, it results in:: TypeError: expected string or Unicode object, Asset found * make it easy to create a plugin helper, eg instead of: @asset.plugin('jstc.precompilers.plugins', 'text/x-easytpl') ...def-my-plugin... make it possible to do: @jstc.precompilers.plugin('text/x-easytpl') ...def-my-plugin... * add a context manager for ``with asset.load(...) as fp: ...`` * when you load relative plugins, they should default to the end unless explicit ordering is defined by the plugin. eg, given a standard plugin set of ('a', 'b') where 'b' specifies ``after='a'``, and the plugin spec '+foo.bar.method' is loaded, then the result is:: 'a', 'foo.bar.method', 'b' instead of:: 'a', 'b', 'foo.bar.method' * make a setup directive that can find and populate all `asset.plugin()` calls * make `asset.plugin()` calls check that the `group` starts with the caller's package for namespacing and if not issue a log.warning() * make NoSuchAsset subclass IOError?... * add support for "file://" paths so that asset() can be used agnostically to whether the asset is on the filesystem or in a python package... * add shortcuts... asset.read(*) == asset.load(*).read() * make .load() optimize for no-wildcards specs by returning an Asset. ==> Asset's must behave like AssetGroups though! (i.e. listable) * make import errors better, e.g. an asset.symbol('asset.badmodule.BadClass') fails with: ImportError: No module named badmodule or if badmodule exists, but not BadClass, then: ImportError: No module named BadClass it should: ImportError: No module named asset.badmodule for the former, and: ImportError: No module or attribute named asset.badmodule.BadClass for the latter. ==> perhaps return an AssetError which is subclass of both ImportError and AttributeError? no. just ImportError unless the asset-spec specifies an attribute... * make asset.load() complain on unknown keywords, such as `transformer` * convert the `peek()` method into a .load(lazy=True) parameter. * add helpers: * `isspec` * `isresource` * `issymbol` base it on:: import re isResourceSpec = re.compile('^[a-z][a-z0-9_]*:', re.IGNORECASE) def isresource(spec): return isstr(spec) and bool(isResourceSpec.match(spec)) * make the stream returned by asset.load(SPEC).stream() behave like a stream... not whatever this is: Traceback (most recent call last): File "/media/raspi-local/raspi-door.git/raspi_door/trap.py", line 59, in trigger target[2](*args, topic=topic, event=event, **kw) File "/media/raspi-local/raspi-door.git/raspi_door/sensor.py", line 120, in onSense self.sounds[evt] = pygame.mixer.Sound(play) error: OGG bitstream is not valid Vorbis stream! asset-0.6.13/setup.py0000775000175000017500000000641313074240757015536 0ustar grabnergrabner00000000000000#!/usr/bin/env python # -*- coding: utf-8 -*- #------------------------------------------------------------------------------ # file: $Id$ # auth: metagriffin # date: 2013/10/29 # copy: (C) Copyright 2013-EOT metagriffin -- see LICENSE.txt #------------------------------------------------------------------------------ # This software 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 software 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/. #------------------------------------------------------------------------------ import os, sys, setuptools from setuptools import setup, find_packages # require python 2.7+ if sys.hexversion < 0x02070000: raise RuntimeError('This package requires python 2.7 or better') heredir = os.path.abspath(os.path.dirname(__file__)) def read(*parts, **kw): try: return open(os.path.join(heredir, *parts)).read() except: return kw.get('default', '') test_dependencies = [ 'nose >= 1.3.0', 'coverage >= 3.5.3', # note: `pxml` should be installed as an egg, i.e.: # easy_install --zip-ok pxml # for the unit tests to be able to test that. 'pxml >= 0.2.13', ] dependencies = [ # note: `globre` should be installed unzipped, i.e.: # easy_install --always-unzip globre # for the unit tests to be able to test that. 'globre >= 0.1.5', 'six >= 1.10.0', 'aadict >= 0.2.2', ] entrypoints = None classifiers = [ 'Development Status :: 5 - Production/Stable', 'Intended Audience :: Developers', 'Programming Language :: Python', 'Operating System :: OS Independent', 'Natural Language :: English', 'License :: OSI Approved :: GNU General Public License v3 or later (GPLv3+)', ] setup( name = 'asset', version = read('VERSION.txt', default='0.0.1').strip(), description = 'A package resource and symbol loading helper library.', long_description = read('README.rst'), classifiers = classifiers, author = 'metagriffin', author_email = 'mg.pypi@uberdev.org', url = 'http://github.com/metagriffin/asset', keywords = 'python package pkg_resources asset resolve lookup loader', packages = find_packages(), platforms = ['any'], include_package_data = True, zip_safe = True, install_requires = dependencies, tests_require = test_dependencies, test_suite = 'asset', entry_points = entrypoints, license = 'GPLv3+', ) #------------------------------------------------------------------------------ # end of $Id$ #------------------------------------------------------------------------------ asset-0.6.13/test-requirements.txt0000664000175000017500000000037613074241236020255 0ustar grabnergrabner00000000000000nose == 1.3.0 coverage == 3.5.3 globre == 0.1.5 six == 1.10.0 aadict == 0.2.2 # NOTE: pxml must be installed with ``easy_install --zip-ok pxml``... # pxml == 0.2.13 asset-0.6.13/CHANGELOG.rst0000664000175000017500000000305513566560611016041 0ustar grabnergrabner00000000000000========= ChangeLog ========= v0.6.13 ======= * Added `exists()` top-level module helper function v0.6.12 ======= * Added `chunks()` helper function and Asset methods for binary- or line-oriented stream chunking v0.6.11 ======= * Added `Asset.count()` helper function (alias to ``len(Asset)``) * Added `Asset.exists()` helper function (non-exception-based version of ``Asset.peek()``) v0.6.10 ======= * Added plugin loading error logging * Fixed symbol loading bug when using ':' separator v0.6.9 ====== * Added `PluginSet.select(name)` plugin selection method. v0.6.8 ====== * Enhanced return value from `asset.plugins` to be a first-class object (`PluginSet`) that has aggregate plugin operation methods `PluginSet.handle` and `PluginSet.filter`. v0.6.7 ====== * Added initial implementation of `asset.plugin` helper decorator v0.6.6 ====== * Corrected regex negative handling v0.6.5 ====== * Updated `asset.plugins` to support loading of unregistered plugins * Changed ``'!'`` `asset.plugins` prefix to ``'-'`` v0.6.4 ====== * Added `asset.plugins` plugin loading mechanism that supports simple ordering and overriding of plugins v0.6.3 ====== * Added check for egg vs. not-egg in unit tests v0.6.2 ====== * Removed distribute dependency (thanks jlec) v0.6.1 ====== * Added Python 3 support v0.6 ==== * Added more standard file object compatibility (stream iteration, reading with size, and closing) v0.0.5 ====== * Promoted to "stable" development status * First tagged release * Added `asset.version()` helper function asset-0.6.13/MANIFEST.in0000664000175000017500000000005312242233576015546 0ustar grabnergrabner00000000000000include *.txt *.cfg *.rst graft asset/test asset-0.6.13/PKG-INFO0000664000175000017500000001511313566560742015120 0ustar grabnergrabner00000000000000Metadata-Version: 1.1 Name: asset Version: 0.6.13 Summary: A package resource and symbol loading helper library. Home-page: http://github.com/metagriffin/asset Author: metagriffin Author-email: mg.pypi@uberdev.org License: GPLv3+ Description: ================================ Generalized Package Asset Loader ================================ Loads resources and symbols from a python package, whether installed as a directory, an egg, or in source form. Also provides some other package-related helper methods, including ``asset.version()``, ``asset.caller()``, and ``asset.chunks()``. TL;DR ===== Install: .. code:: bash $ pip install asset Load symbols (e.g. functions, classes, or variables) from a package by name: .. code:: python import asset # load the 'mypackage.foo.myfunc' function and call it with some parameter retval = asset.symbol('mypackage.foo.myfunc')(param='value') Load data files from a package: .. code:: python # load the file 'mypackage/templates/data.txt' into string data = asset.load('mypackage:templates/data.txt').read() # or as a file-like stream stream = asset.load('mypackage:templates/data.txt').stream() data = stream.read() Multiple files can be operated on at once by using `globre `_ style wildcards: .. code:: python # concatenate all 'css' files into one string: css = asset.load('mypackage:static/style/**.css').read() # load all '.txt' files, XML-escaping the data and wrapping # each file in an ... element. import xml.etree.ElementTree as ET data = ET.Element('nodes') for item in asset.load('asset:**.txt'): cur = ET.SubElement(data, 'node', name=item.name) cur.text = item.read() data = ET.tostring(data) Query the installed version of a package: .. code:: python asset.version('asset') # ==> '0.0.5' asset.version('python') # ==> '2.7' asset.version('no-such-package') # ==> None Find out what package is calling the current function: .. code:: python # assuming the call stack is: # in package "zig" a function "x", which calls # in package "bar" a function "y", which calls # in package "foo" a function "callfoo" defined as: def callfoo(): asset.caller() # ==> 'bar' asset.caller(ignore='bar') # ==> 'zig' asset.caller(ignore=['bar', 'zig']) # ==> None Call all the plugins for a given group: .. code:: python for plugin in asset.plugins('mypackage.plugins'): plugin.handle() Filter an object through all the plugins for a given group (if there are no plugins, this will simply return `thing`): .. code:: python result = asset.plugins('mypackage.plugins').filter(thing) Load all registered plugins, select the ones named `foo` and invoke them (this will fail if there is no `foo` plugin): .. code:: python result = asset.plugins('mypackage.plugins').select('foo').handle(thing) Chunk a file (or any file-like object) into 1 KiB chunks: .. code:: python with open('/var/binary/data', 'rb') as fp: for chunk in asset.chunks(fp, 1024): # ... do something with `chunk` ... Chunk an Asset stream (here using the `.chunks` alias method): .. code:: python for chunk in asset.load('mypackage:data/**.bin').chunks(): # ... using the default chunk size (usually 8 KiB) ... Testing ======= In order to run the unit tests correctly, the `pxml` package needs to be installed as a zipped package (i.e. an "egg") and the `globre` package needs to be installed unzipped. To accomplish that, do: .. code:: bash $ easy_install --zip-ok pxml $ easy_install --always-unzip globre The reason is that the unit tests confirm that `asset` can load assets from both zipped and unzipped packages, and can also identify in which mode it is operating. Details ======= TODO: add detailed docs... * ``Asset.filename``: If the asset represents a file on the filesystem, is the absolute path to the specified file. Otherwise is ``None``. * ``AssetGroupStream.readline()``: Returns the next line from the aggregate asset group stream, as if the assets had been concatenate into a single asset. **IMPORTANT**: if an asset ends with content that is not terminated by an EOL token, it is returned as-is, i.e. it does NOT append the first line from the next asset. Note: because ``asset.load()`` does lazy-loading, it only throws a `NoSuchAsset` exception when you actually attempt to use the AssetGroup! If you need an immediate error, use the `peek()` method. Note that it returns itself, so you can do something like: .. code:: python import asset def my_function_that_returns_an_iterable(): return asset.load(my_spec).peek() # this returns exactly the same thing as the following: # # return asset.load(my_spec) # # but throws an exception early if there are no matching assets. Keywords: python package pkg_resources asset resolve lookup loader Platform: any Classifier: Development Status :: 5 - Production/Stable Classifier: Intended Audience :: Developers Classifier: Programming Language :: Python Classifier: Operating System :: OS Independent Classifier: Natural Language :: English Classifier: License :: OSI Approved :: GNU General Public License v3 or later (GPLv3+) asset-0.6.13/setup.cfg0000664000175000017500000000037013566560742015643 0ustar grabnergrabner00000000000000[easy_install] zip_ok = true [nosetests] match = ^test nocapture = 1 cover-branches = 1 cover-package = asset cover-erase = 1 [register] repository = pypi-metagriffin [upload] repository = pypi-metagriffin [egg_info] tag_build = tag_date = 0 asset-0.6.13/asset.egg-info/0000775000175000017500000000000013566560742016633 5ustar grabnergrabner00000000000000asset-0.6.13/asset.egg-info/requires.txt0000664000175000017500000000013313566560742021230 0ustar grabnergrabner00000000000000globre >= 0.1.5 six >= 1.10.0 aadict >= 0.2.2 asset-0.6.13/asset.egg-info/dependency_links.txt0000664000175000017500000000000113566560742022701 0ustar grabnergrabner00000000000000 asset-0.6.13/asset.egg-info/zip-safe0000664000175000017500000000000112642554705020257 0ustar grabnergrabner00000000000000 asset-0.6.13/asset.egg-info/top_level.txt0000664000175000017500000000000613566560742021361 0ustar grabnergrabner00000000000000asset asset-0.6.13/asset.egg-info/PKG-INFO0000664000175000017500000001511313566560742017731 0ustar grabnergrabner00000000000000Metadata-Version: 1.1 Name: asset Version: 0.6.13 Summary: A package resource and symbol loading helper library. Home-page: http://github.com/metagriffin/asset Author: metagriffin Author-email: mg.pypi@uberdev.org License: GPLv3+ Description: ================================ Generalized Package Asset Loader ================================ Loads resources and symbols from a python package, whether installed as a directory, an egg, or in source form. Also provides some other package-related helper methods, including ``asset.version()``, ``asset.caller()``, and ``asset.chunks()``. TL;DR ===== Install: .. code:: bash $ pip install asset Load symbols (e.g. functions, classes, or variables) from a package by name: .. code:: python import asset # load the 'mypackage.foo.myfunc' function and call it with some parameter retval = asset.symbol('mypackage.foo.myfunc')(param='value') Load data files from a package: .. code:: python # load the file 'mypackage/templates/data.txt' into string data = asset.load('mypackage:templates/data.txt').read() # or as a file-like stream stream = asset.load('mypackage:templates/data.txt').stream() data = stream.read() Multiple files can be operated on at once by using `globre `_ style wildcards: .. code:: python # concatenate all 'css' files into one string: css = asset.load('mypackage:static/style/**.css').read() # load all '.txt' files, XML-escaping the data and wrapping # each file in an ... element. import xml.etree.ElementTree as ET data = ET.Element('nodes') for item in asset.load('asset:**.txt'): cur = ET.SubElement(data, 'node', name=item.name) cur.text = item.read() data = ET.tostring(data) Query the installed version of a package: .. code:: python asset.version('asset') # ==> '0.0.5' asset.version('python') # ==> '2.7' asset.version('no-such-package') # ==> None Find out what package is calling the current function: .. code:: python # assuming the call stack is: # in package "zig" a function "x", which calls # in package "bar" a function "y", which calls # in package "foo" a function "callfoo" defined as: def callfoo(): asset.caller() # ==> 'bar' asset.caller(ignore='bar') # ==> 'zig' asset.caller(ignore=['bar', 'zig']) # ==> None Call all the plugins for a given group: .. code:: python for plugin in asset.plugins('mypackage.plugins'): plugin.handle() Filter an object through all the plugins for a given group (if there are no plugins, this will simply return `thing`): .. code:: python result = asset.plugins('mypackage.plugins').filter(thing) Load all registered plugins, select the ones named `foo` and invoke them (this will fail if there is no `foo` plugin): .. code:: python result = asset.plugins('mypackage.plugins').select('foo').handle(thing) Chunk a file (or any file-like object) into 1 KiB chunks: .. code:: python with open('/var/binary/data', 'rb') as fp: for chunk in asset.chunks(fp, 1024): # ... do something with `chunk` ... Chunk an Asset stream (here using the `.chunks` alias method): .. code:: python for chunk in asset.load('mypackage:data/**.bin').chunks(): # ... using the default chunk size (usually 8 KiB) ... Testing ======= In order to run the unit tests correctly, the `pxml` package needs to be installed as a zipped package (i.e. an "egg") and the `globre` package needs to be installed unzipped. To accomplish that, do: .. code:: bash $ easy_install --zip-ok pxml $ easy_install --always-unzip globre The reason is that the unit tests confirm that `asset` can load assets from both zipped and unzipped packages, and can also identify in which mode it is operating. Details ======= TODO: add detailed docs... * ``Asset.filename``: If the asset represents a file on the filesystem, is the absolute path to the specified file. Otherwise is ``None``. * ``AssetGroupStream.readline()``: Returns the next line from the aggregate asset group stream, as if the assets had been concatenate into a single asset. **IMPORTANT**: if an asset ends with content that is not terminated by an EOL token, it is returned as-is, i.e. it does NOT append the first line from the next asset. Note: because ``asset.load()`` does lazy-loading, it only throws a `NoSuchAsset` exception when you actually attempt to use the AssetGroup! If you need an immediate error, use the `peek()` method. Note that it returns itself, so you can do something like: .. code:: python import asset def my_function_that_returns_an_iterable(): return asset.load(my_spec).peek() # this returns exactly the same thing as the following: # # return asset.load(my_spec) # # but throws an exception early if there are no matching assets. Keywords: python package pkg_resources asset resolve lookup loader Platform: any Classifier: Development Status :: 5 - Production/Stable Classifier: Intended Audience :: Developers Classifier: Programming Language :: Python Classifier: Operating System :: OS Independent Classifier: Natural Language :: English Classifier: License :: OSI Approved :: GNU General Public License v3 or later (GPLv3+) asset-0.6.13/asset.egg-info/SOURCES.txt0000664000175000017500000000076513566560742020527 0ustar grabnergrabner00000000000000CHANGELOG.rst LICENSE.txt MANIFEST.in README.rst TODO.txt VERSION.txt setup.cfg setup.py test-requirements.txt asset/__init__.py asset/isstr.py asset/plugin.py asset/resource.py asset/symbol.py asset/test.py asset/test_plugin.py asset.egg-info/PKG-INFO asset.egg-info/SOURCES.txt asset.egg-info/dependency_links.txt asset.egg-info/requires.txt asset.egg-info/top_level.txt asset.egg-info/zip-safe asset/test/data.csv asset/test/data/file1.nl asset/test/data/file2.nl asset/test/data/subdir/subfile1.nl