numat / RASPA2

NO LONGER UPDATED. Use the official repository.
https://github.com/iraspa/RASPA2
Other
77 stars 72 forks source link

Overarching Architecture #9

Open patrickfuller opened 10 years ago

patrickfuller commented 10 years ago

The scope of the other issues calls into question the overall architecture of this program. Namely, RASPA should 1. have an API and 2. be thread safe (no segfaults!).

The existing usage method of input/output files should be decoupled from the core logic and instead use a programmatic API.

API methods should be minimalist. Sensible defaults for every parameter, output minimum information unless specifically asked for.

In [1]: import this
The Zen of Python, by Tim Peters

Beautiful is better than ugly.
Explicit is better than implicit.
Simple is better than complex.
Complex is better than complicated.
Flat is better than nested.
Sparse is better than dense.
Readability counts.
Special cases aren't special enough to break the rules.
Although practicality beats purity.
Errors should never pass silently.
Unless explicitly silenced.
In the face of ambiguity, refuse the temptation to guess.
There should be one-- and preferably only one --obvious way to do it.
Although that way may not be obvious at first unless you're Dutch.
Now is better than never.
Although never is often better than *right* now.
If the implementation is hard to explain, it's a bad idea.
If the implementation is easy to explain, it may be a good idea.
Namespaces are one honking great idea -- let's do more of those!