Geek Answers Handbook

Clojure equivalent of Python doctrine?

Python doctrines associate simple tests with source code (in Python they are in the function documentation). Additional information and examples here .

Is there anything similar for Clojure?

I know about unit tests with clojure.test , but you are looking for something more closely integrated with the source (usually unit tests are in different files, here I want to get "inside" defn ).

Search around I found this one , but it seems very insincere (the tests are in real text, for example Python - certainly a macro that extends defn would be preferable?).

Or maybe there is another way to solve the general problem, namely that I have some tests (usually simple things that demonstrate the basic properties of the function) that would be best included in the documentation (I use marginalia ) than in separate unit files test.

update Here is an example: I have a function that calculates (manhattan) the distance (in pixels) from the rectangle of pixels to the center of the image. It sounds simple, but complicated by things like the difference in the "center" value for images with an odd or even number of pixels on the sides or with which part of the block you are measuring. So I had to write some tests to get the code directly. And now I look at the documents, and in fact it would be better if the documents included these tests, because they explained better than words what the function does ...

+7
source share
2 answers

and check flag in metadata http://clojure.org/special_forms

 (defn ^{:doc "mymax [xs+] gets the maximum value in xs using > " :test (fn [] (assert (= 42 (mymax 2 42 5 4)))) :user/comment "this is the best fn ever!"} mymax ([x] x) ([xy] (if (> xy) xy)) ([xy & more] (reduce mymax (mymax xy) more))) user=> (test #'mymax) :ok user=> (doc test) ------------------------- clojure.core/test ([v]) test [v] finds fn at key :test in var metadata and calls it, presuming failure will throw exception nil
+10
source

How about: pre and: post expressions? http://blog.fogus.me/2009/12/21/clojures-pre-and-post/

+1
source

More articles:


All Articles