Colon nella parte anteriore: sintassi YAML

Question

Attualmente sto usando Sidekiq in un progetto e ho il seguente file YAML di configurazione:

:concurrency: 5 
:pidfile: /tmp/pids/sidekiq.pid 
:logfile: log/sidekiq.log 
staging: 
    :concurrency: 10 
production: 
    :concurrency: 20 
queues: 
    - default 

non ho visto avere due punti di fronte a una chiave di prima, ma omettendo quel colon produce risultati interessanti. Nel caso del :pidfile:, ad esempio, con i due punti in primo piano crea/sostituisce il file di destinazione dove è senza, utilizza quello già lì e non scrive su di esso.

Questo documento è documentato da qualche parte o semplicemente come Sidekiq si aspetta determinate chiavi?

Answer 1

chiavi YAML che iniziano con i due punti generare chiavi in ​​Ruby simboleggiavano, mentre le chiavi senza i due punti saranno generare chiavi stringata:

require 'yaml' 

string =<<-END_OF_YAML 
:concurrency: 5 
:pidfile: /tmp/pids/sidekiq.pid 
:logfile: log/sidekiq.log 
staging: 
    :concurrency: 10 
production: 
    :concurrency: 20 
queues: 
    - default 
END_OF_YAML 

YAML.load(string) 
# { 
#  :concurrency => 5, 
#  :pidfile  => "/tmp/pids/sidekiq.pid", 
#  :logfile  => "log/sidekiq.log", 
#  "staging" => { 
#   :concurrency => 10 
#  }, 
#  "production" => { 
#   :concurrency => 20 
#  }, 
#  "queues"  => [ 
#   [0] "default" 
#  ] 
# } 

Nota: Se una gemma dipende da chiavi simbolizzate, le chiavi non saranno sovrascritte dai valori predefiniti.

Answer 2

In realtà non è sidekiq specifico. I due punti di fronte a una chiave fa solo questa chiave un simbolo invece di una stringa:

# example.yml 
a: 
    value: 1 
:b: 
    value: 2 


yaml = YAML.load_file('example.yml') 

yaml["a"] => { "value" => 1 } 
yaml[:b] => { "value" => 1 } 

Quindi, se il codice accede alla configurazione con i simboli dei tasti, si dovrebbe aggiungere una colon davanti alla chiave nella yaml file o utilizzare alcuni conversione di tasti come #with_indifferent_access per l'hash risultato (dopo l'analisi del file YAML)