annotate src/capnproto-git-20161025/doc/_posts/2013-09-04-capnproto-0.3-python-tools-features.md @ 48:9530b331f8c1

Add Cap'n Proto source
author Chris Cannam <cannam@all-day-breakfast.com>
date Tue, 25 Oct 2016 11:17:01 +0100
parents
children
rev   line source
cannam@48 1 ---
cannam@48 2 layout: post
cannam@48 3 title: "Cap'n Proto v0.3: Python, tools, new features"
cannam@48 4 author: kentonv
cannam@48 5 ---
cannam@48 6
cannam@48 7 The first release of Cap'n Proto came three months after the project was announced. The second
cannam@48 8 release came six weeks after that. And the third release is three weeks later. If the pattern
cannam@48 9 holds, there will be an infinite number of releases before the end of this month.
cannam@48 10
cannam@48 11 Version 0.3 is not a paradigm-shifting release, but rather a slew of new features largely made
cannam@48 12 possible by building on the rewritten compiler from the last release. Let's go through the
cannam@48 13 list...
cannam@48 14
cannam@48 15 ### Python Support!
cannam@48 16
cannam@48 17 Thanks to the tireless efforts of contributor [Jason Paryani](https://github.com/jparyani), I can
cannam@48 18 now comfortably claim that Cap'n Proto supports multiple languages. [His Python
cannam@48 19 implementation](http://jparyani.github.io/pycapnp/) wraps the C++ library and exposes
cannam@48 20 most of its features in a nice, easy-to-use way.
cannam@48 21
cannam@48 22 And I have to say, it's _way_ better than the old Python Protobuf implementation that I helped put
cannam@48 23 together at Google. Here's why:
cannam@48 24
cannam@48 25 * Jason's implementation parses Cap'n Proto schema files at runtime. There is no need to run a
cannam@48 26 compiler to generate code every time you update your schema, as with protobufs. So, you get
cannam@48 27 to use Python the way Python was intended to be used. In fact, he's hooked into the Python
cannam@48 28 import mechanism, so you can basically import a `.capnp` schema file as if it were a `.py`
cannam@48 29 module. It's even convenient to load schema files and play with Cap'n Proto messages from the
cannam@48 30 interactive interpreter prompt.
cannam@48 31 * It's _fast_. Whereas the Python Protobuf implementation -- which we made the mistake of
cannam@48 32 implementing in pure-Python -- is _slow_. And while technically there is an experimental
cannam@48 33 C-extension-based Python Protobuf implementation (which isn't enabled by default due to various
cannam@48 34 obscure problems), Jason's Cap'n Proto implementation is faster than that, too.
cannam@48 35
cannam@48 36 Go [check it out](http://jparyani.github.io/pycapnp/)!
cannam@48 37
cannam@48 38 By the way, there is also a budding [Erlang implementation](http://ecapnp.astekk.se/)
cannam@48 39 (by Andreas Stenius), and work
cannam@48 40 continues on [Rust](https://github.com/dwrensha/capnproto-rust) (David Renshaw) and
cannam@48 41 [Ruby](https://github.com/cstrahan/capnp-ruby) (Charles Strahan) implementations.
cannam@48 42
cannam@48 43 ### Tools: Cap'n Proto on the Command Line
cannam@48 44
cannam@48 45 The `capnp` command-line tool previously served mostly to generate code, via the `capnp compile`
cannam@48 46 command. It now additionally supports converting encoded Cap'n Proto messages to a human-readable
cannam@48 47 text format via `capnp decode`, and converting that format back to binary with `capnp encode`.
cannam@48 48 These tools are, of course, critical for debugging.
cannam@48 49
cannam@48 50 You can also use the new `capnp eval` command to do something interesting: given a schema file and
cannam@48 51 the name of a constant defined therein, it will print out the value of that constant, or optionally
cannam@48 52 encode it to binary. This is more interesting than it sounds because the schema language supports
cannam@48 53 variable substitution in the definitions of these constants. This means you can build a large
cannam@48 54 structure by importing smaller bits from many different files. This may make it convenient to
cannam@48 55 use Cap'n Proto schemas as a config format: define your service configuration as a constant in
cannam@48 56 a schema file, importing bits specific to each client from other files that those clients submit
cannam@48 57 to you. Use `capnp eval` to "compile" the whole thing to binary for deployment. (This has always
cannam@48 58 been a common use case for Protobuf text format, which doesn't even support variable substitution
cannam@48 59 or imports.)
cannam@48 60
cannam@48 61 Anyway, check out the [full documentation]({{ site.baseurl }}capnp-tool.html) for
cannam@48 62 more.
cannam@48 63
cannam@48 64 ### New Features
cannam@48 65
cannam@48 66 The core product has been updated as well:
cannam@48 67
cannam@48 68 * Support for unnamed [unions]({{ site.baseurl }}language.html#unions) reduces the
cannam@48 69 need for noise-words, improving code readability. Additionally, the syntax for unions has been
cannam@48 70 simplified by removing the unnecessary ordinal number.
cannam@48 71 * [Groups]({{ site.baseurl }}language.html#groups) pair nicely with unions.
cannam@48 72 * [Constants]({{ site.baseurl }}language.html#constants) are now
cannam@48 73 [implemented in C++]({{ site.baseurl }}cxx.html#constants). Additionally, they
cannam@48 74 can now be defined in terms of other constants (variable substitution), as described earlier.
cannam@48 75 * The schema API and `schema.capnp` have been radically refactored, in particular to take advantage
cannam@48 76 of the new union and group features, making the code more readable.
cannam@48 77 * More and better tests, bug fixes, etc.
cannam@48 78
cannam@48 79 ### Users!
cannam@48 80
cannam@48 81 Some news originating outside of the project itself:
cannam@48 82
cannam@48 83 * [Debian Unstable (sid)](http://www.debian.org/releases/sid/) now features
cannam@48 84 [a Cap'n Proto package](http://packages.debian.org/sid/capnproto), thanks to
cannam@48 85 [Tom Lee](https://github.com/thomaslee). Of course, since package updates take some time, this
cannam@48 86 package is still v0.2.1 as of this writing, but it will be updated to v0.3 soon enough.
cannam@48 87 * Popular OSX-based text editor [TextMate](http://macromates.com/) now
cannam@48 88 [uses Cap'n Proto internally](https://github.com/textmate/textmate/commit/5c02b4ff5cc0c7c319d3d4f127c8ee19b81f80b7),
cannam@48 89 and the developer's feedback lead directly to several usability improvements included in this
cannam@48 90 release.
cannam@48 91 * Many people using Cap'n Proto _haven't bothered to tell us about it_! Please, if you use it,
cannam@48 92 [let us know](https://groups.google.com/group/capnproto) about your experience, both what you like
cannam@48 93 and especially what you don't like. This is the critical time where the system is usable but
cannam@48 94 can still be changed if it's not right, so your feedback is critical to our long-term success.
cannam@48 95 * I have revenue! A whopping [$1.25 per week](https://www.gittip.com/kentonv/)! >_> It's
cannam@48 96 totally worth it; I love this project. (But thanks for the tips!)