For a long time now, I’ve been hindered by the issue of utilities, or snippets. These are convenience functions and classes that are too small or too incomplete to justify a library, yet are useful enough to be used.
I’ve posted a few on my blog: Namespaces, X and now FileDict. Others I didn’t post, and include a priority queue, an A* implementation, a lazy-list, an LRU memoizer, etc. You probably have a few of those. I know because I see them on snippet sites.
However, I rarely actually use these in my code. I really want to. But once your code spans more than one file, you usually need to make a proper installation, or at least trouble your “users” a bit more. Usually saving a few lines just isn’t worth the trouble. Copy-pasting the snippet into the file is sometimes the solution, but it really pains me that I’ll have to re-paste it every time I improve my snippet.
I’m sure some of you looked at my snippets, or other people’s, thought “cool”, but never used them, simply because it was too much trouble.
Paradoxically, this is especially true when writing snippets. They are just one small file, and using another snippet would probably make them too hard to distribute. This is a magic-circle, for-ever limiting our snippets to a low level of sophistication, and discouraging re-use.
I want to break that circle. I want to create an economy of snippets, increasingly building on each other, eventually creating a “standard library” of their own. But how would one do that? I have one suggestion, along with a proof-of-concept, which I will present here.
PySnippets is my attempt of making snippets usable. It’s comprised of two solutions – a server and a client.
- Server – A website for uploading snippets. Simple enough. You can rate them, tag them, discuss them, offer some documentation and of-course post newer versions.
- Client – A python module that automagically imports snippets from the web. Essentially, it downloads the snippets you request to a cache, imports them if they’re already there, and periodically searches for updates.
The server is structured in a predictable way, so that the client knows how to fetch a snippet just by its name.
Here’s a usage example with my current client implementation, I creatively call “snippets”:
import snippets antigravity = snippets.get('antigravity') # "snippet-import" antigravity.start(mode='xkcd')
Easy as that!
The snippets.get function looks for the module in the local snippets-cache. If it’s there, get just imports it and returns the module. If it’s not, it queries the server for a snippet called “antigravity” (names are unique), stores it in the cache, and the imports it. What the user notices is a 2-second pause the first time he ever imports that snippet, and nothing else from then on.
You can specify to download a specific version, like this:
filedict = snippets.get('filedict', version=0.1)
The current implementation also includes an “auto-update” feature: Periodically, before importing a module, the client surveys the server for a newer version of it. If a newer version exists, it downloads it to the cache and continues with the import.
Auto-updates can be disabled in a parameter to get.
The server is yet another service to upload snippets, however it has a slightly unusual design (which no other snippet site I know of has):
- A URL to a snippet is easy to deduce given its name.
- There is a conscious (though simple) support for versions.
- To increase reliability and trust (more on that later), uploaded snippets cannot be altered (but a new version can be issued)
Since I know very little about administration and server-maintenance, I chose wikidot.com to host my POC web-site. They have an elaborate support for permissions and most of the features I need, such as the ability to rate, tag and discuss snippets.
Perhaps the biggest issue with such a system is trust. Since you’re running code which resides online, you have to trust me not to maliciously alter the snippets, and also you have to trust the author of the snippet not to do so.
Perhaps higher-ups in the Python community would like to take some sponsorship of the project, removing the remaining trust-issues with the administrator (that’s me).
- To distribute your snippets, all you need is for the reciever to have an internet connection, and the snippets client.
- If you’re sending someone code, you can attach the client (it’s rather small, too), and just import away. The reciever will benefit from improvements and bugfixes to your snippets.
- You can use other people’s snippets just as easily, as long as you trust them.
- Snippets can now build on each other without worrying too much.
What if my user is offline?
Then probably PySnippets isn’t for him.
However, I do have some ideas, and might implement them if there is sufficient demand.
PySnippets is my humble attempt at solving the utility/snippet reuse problems. I hope you like it and find it useful.
Please try it!