PyMark Python flavoured object markup
Download

PyMark Ranking & Summary

PyMark Tags

Python library Python object markup

PyMark Description

PyMark is a module that uses Python as a powerful front end to markup and compiles data to a simple binary format for fast serialisation into an application.AdvantagesHaving a focus on a powerful front end has many benefits lacking in other object markup techniques:- Bad syntax in markup is caught at compile time.- A whole programming language to help you!- Lists, Tuples, Dictionaries are all first class structures.- Not everything has to be a tree of strings.- More expression and freedom in markup.- Structure manipulation/patching can be done easily and early.And having a simple back end has some benefits too.- Lightweight parser written in less than 200 lines of C.- Reads/Writes/Streams data quickly.- If required, obfuscation is possible.DisadvantagesHaving so much happen in the front end makes the system somewhat one-directional.While the human readable source can be reconstructed in some sense, data such as comments and other markup is lost in the compilation. For distribution and collaboration it is important to also share the source files.Data EntryThe first task is to actually enter your data. For this you create a python module with an object the same name as the file. You can structure this how you please. If you are a JSON fan you might write something like this:""" My Favourite Pets - A basic example """pets_one = { "benny" : { "type" : "Dog", "name" : "Benny Boos", "color" : "Brown", "toys" : }, "roger" : { "type" : "Horse", "name" : "Roger Horse", "color" : "White", "toys" : }, "catherine" : { "type" : "Cat", "name" : "Catherine", "color" : "Ginger", "toys" : }}But having Python allows you to be much more expressive. You can adjust the data entry in many different ways to make it simpler, more explicit, or more aesthetic.""" My Favourite Pets - Another example """from pymark.util import enum, module, struct""" Functions """def pet(**kwargs): return kwargsdef color(r, g, b): return (r, g, b)""" Constants """Types = enum("Dog", "Horse", "Cat")Toys = enum("String", "Mouse", "Brush", "Bone", "Ball")Colors = struct( Brown = color(94, 83, 51), White = color(255, 255, 255), Ginger = color(237, 133, 14),)""" Module """pets_two = module( benny = pet( type = Types.Dog, name = "Benny Boos", color = Colors.Brown, toys = ), roger = pet( type = Types.Horse, name = "Roger Horse", color = Colors.White, toys = ), catherine = pet( type = Types.Cat, name = "Catherine", color = Colors.Ginger, toys = ))Perhaps the above example looks like a bit of a mess, but it does show off some of the potential. I have no real preference for either style but in using Python you have the option to adapt your markup depending on preference or domain.CompilingOnce you have the module written just feed it into pymark.pymark pets_two.py > pets_two.pmkApplicationI have tried to make the API fairly simplistic and clear.Loading data at runtime and making it easy to access in a type safe language is always going to be horrible. It is one of the major issues with doing object markup in a separate language and there is little way around it. In C you can do something like this.#include < stdio.h >#include "PyMark.h"int main(int argc, char** argv) { PyMarkObject* pets = PyMark_Unpack("pets_two.pmk"); PyMarkObject* cath = pets->get(pets, "catherine"); PyMarkObject* cath_color = cath->get(cath, "color"); PyMarkObject* cath_toys = cath->get(cath, "toys"); printf("TypeID: %i\n", cath->get(cath, "type")->as_int); printf("Name: %s\n", cath->get(cath, "name")->as_string); printf("Color: (%i, %i, %i)", cath_color->items.as_int, cath_color->items.as_int, cath_color->items.as_int); printf("ToyIDs: "); for(int i = 0; i < cath_toys->length; i++) { printf("%i, ", cath_toys->items->as_int); } printf("\n"); PyMark_Delete(pets); return 0;}The C++ syntax is a little more sane though the implementation not much cleaner on the whole.#include < stdio.h >#include "PyMark.hpp"int main(int argc, char** argv) { PyMark::PyMarkObject* pets = PyMark::Unpack("pets_two.pmk"); PyMark::PyMarkObject* cath = pets->Get("catherine"); printf("TypeID: %i\n", cath->Get("type")->AsInt()); printf("Name: %s\n", cath->Get("name")->AsString()); printf("Color: (%i, %i, %i)\n", cath->Get("color")->At(0)->AsInt(), cath->Get("color")->At(1)->AsInt(), cath->Get("color")->At(2)->AsInt()); delete pets; return 0;}Hopefully more languages supported soon...Product's homepage

PyMark Related Software