esc

Bloscpack Public API Design

pack()
pack_fp()
unpack()
unpack_fp()
BloscpackFile()

esc

Contents

• Magic Format

Magic Format

magic-format:	(8 byte ASCII string) The data will usually be some kind of binary serialized string data, for example JSON, BSON, YAML or Protocol-Buffers. The format identifier is to be placed in this field.

esc

print "Good-bye World!"

esc

Using Markup

There are three main kinds of markup that should be used: italics, bold and fixed-font. Italics should be used when introducing a new technical term, bold should be used for emphasis and fixed-font for source code

Example

When using object-oriented programming in python you must use the

esc

# Functions to activate/deactivate Continuum Analytics Anaconda Python distribution
# by manipulating the $PATH.
export ANACONDA_PATH="$HOME/anaconda/bin"

function have_anaconda(){
    [[ -n $path[(r)$ANACONDA_PATH] ]]
}

function anaconda_on(){
    if have_anaconda ; then

esc

Basic API (low-level)

• public libgit2 structs should be python objects (classes) - Example: git_repository => Repository()
• nameing convention: strip git_struct_name_* - Example: git_repository_config() => Repository.config()
• iterations should be implemented as a generator, if this is not possible we need to change libgit2 (other bindings will benefit from this as well)
• every method should map to one libgit2 function (exceptions are iterations)
• return values of methods
  • no lists use generators instead
  • no dictionaries use tuples or objects instead
• no instantiation of objects use strings instead (important for generators)

esc

""" Benchmarking two techniques for compressing numpy arrays with python-blosc.
"""

import numpy
import numpy.random
import time
import blosc
import blosc.blosc_extension as ext

esc

gc () {
    LBUFFER="git commit -m \""
    RBUFFER="\""
}
zle -N gc gc
bindkey '^gc' gc

esc

    alias gib="git branch"
    alias branch="git branch"
    alias gil="git log"
    # log is a zsh builtin
    alias gid="git diff"
    alias gidc="git diff --cached"
    alias giw="git wdiff"
    # diff is a unix utility
    alias gis="git status --ignored"
    alias status="git status"

esc

[color]
	ui = auto
	branch = auto
	diff = auto
	status = auto
[core]
	excludesfile = ~/.gitignore
	whitespace = trailing-space,space-before-tab,cr-at-eol
	abbrev = 10
[merge]