Clojure Spec для карты с ключами, не являющимися ключевыми словами

Давайте посмотрим на реальный пример карт проекта Leiningen :global-vars:

 ;; Sets the values of global vars within Clojure. This example
 ;; disables all pre- and post-conditions and emits warnings on
 ;; reflective calls. See the Clojure documentation for the list of
 ;; valid global variables to set (and their meaningful values).
 :global-vars {*warn-on-reflection* true
               *assert* false}

Это позволяет пользователю leiningen переопределить значения по умолчанию глобальных переменных Clojures для области своего проекта.

Теперь, если бы ключи этой карты состояли из ключевых слов, мы бы использовали clojure.spec/keys, чтобы сначала указать, какие ключи могут быть частью карты, а затем отдельно определить значения, ожидаемые для этих ключей. Но поскольку clojure.spec/keys молча игнорирует неключевые слова в :req и :req-un и выдает исключение для :opt и :opt-un (начиная с alpha15), нам придется каким-то образом обойти это.

Мы можем получить тип большинства этих глобальных переменных через

(for [[sym varr] (ns-publics 'clojure.core)
      :when (re-matches #"\*.+\*" (name sym))]
  [varr (type @varr)])
  =>
[*print-namespace-maps*     java.lang.Boolean]
[*source-path*              java.lang.String]
[*command-line-args*        clojure.lang.ArraySeq]
[*read-eval*                java.lang.Boolean]
[*verbose-defrecords*       java.lang.Boolean]
[*print-level*              nil]
[*suppress-read*            nil]
[*print-length*             nil]
[*file*                     java.lang.String]
[*use-context-classloader*  java.lang.Boolean]
[*err*                      java.io.PrintWriter]
[*default-data-reader-fn*   nil]
[*allow-unresolved-vars*    java.lang.Boolean]
[*print-meta*               java.lang.Boolean]
[*compile-files*            java.lang.Boolean]
[*math-context*             nil]
[*data-readers*             clojure.lang.PersistentArrayMap]
[*clojure-version*          clojure.lang.PersistentArrayMap]
[*unchecked-math*           java.lang.Boolean]
[*out*                      java.io.PrintWriter]
[*warn-on-reflection*       nil]
[*compile-path*             java.lang.String]
[*in*                       clojure.lang.LineNumberingPushbackReader]
[*ns*                       clojure.lang.Namespace]
[*assert*                   java.lang.Boolean]
[*print-readably*           java.lang.Boolean]
[*flush-on-newline*         java.lang.Boolean]
[*agent*                    nil]
[*fn-loader*                nil]
[*compiler-options*         nil]
[*print-dup*                java.lang.Boolean]

а остальное мы можем заполнить, прочитав документы. Но мой вопрос к вам: как нам написать спецификацию, которая гарантирует, что если карта содержит ключ '*assert*, она будет содержать только логические значения?


clojure clojure.spec
person Rovanion    schedule 17.04.2017    source источник

Ответы (1)


arrow_upward
7
arrow_downward

К вашему сведению, в настоящее время нет планов по поддержке неключевых слов в s/keys.

Есть несколько способов сделать это (один из них — сделать что-то вроде clojure.walk/keywordize-keys до проверки или в ведущем конформере, а затем использовать s/keys).

Другой путь — рассматривать карту как набор кортежей записей карты (некоторые макросы могут значительно очистить это):

(defn warn-on-reflection? [s] #(= % '*warn-on-reflection*))
(s/def ::warn-on-reflection (s/tuple warn-on-reflection? boolean?))
(defn assert? [s] #(= % '*assert*))
(s/def ::assert (s/tuple assert? boolean?))

(s/def ::global-vars
  (s/coll-of (s/or :wor ::warn-on-reflection, :assert ::assert) :kind map?))

И, наконец, было бы интересно попробовать s/multi-spec вместо s/or выше — это сделало бы эту спецификацию открытой, и ее можно было бы добавить позже. Так или иначе, вероятно, полезно сделать эту спецификацию открытой (поэтому также примите (s/tuple any? any?) — так как в будущем могут быть добавлены новые вещи или не перечисленные здесь (например, есть динамические переменные из других пространств имен).

Кроме того, будьте осторожны с некоторыми спецификациями атрибутов. Например, *unchecked-math* рассматривается как логически истинное значение и, в частности, принимает специальное значение :warn-on-boxed, которое является логическим истинным, но также вызывает дополнительное поведение.

person Alex Miller    schedule 17.04.2017