Puppet Function: has_key

Defined in:
modules/stdlib/lib/puppet/parser/functions/has_key.rb
Function type:
Ruby 3.x API

Overview

has_key()Any

> *Note:* *Deprecated* since Puppet 4.0.0, this can now be achieved in the Puppet language with the following equivalent expression: $my_hash = => 'value_one' if 'key_one' in $my_hash {

notice('this will be printed')

Examples:

Example Usage:


$my_hash = {'key_one' => 'value_one'}
if has_key($my_hash, 'key_two') {
  notice('we will not reach here')
}
if has_key($my_hash, 'key_one') {
  notice('this will be printed')
}

Returns:

  • (Any)

    Boolean value



5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
# File 'modules/stdlib/lib/puppet/parser/functions/has_key.rb', line 5

newfunction(:has_key, :type => :rvalue, :doc => <<-'DOC') do |args|
  @summary
    **Deprecated:** Determine if a hash has a certain key value.

  @return
    Boolean value

  @example Example Usage:

    $my_hash = {'key_one' => 'value_one'}
    if has_key($my_hash, 'key_two') {
      notice('we will not reach here')
    }
    if has_key($my_hash, 'key_one') {
      notice('this will be printed')
    }

  > **Note:** **Deprecated** since Puppet 4.0.0, this can now be achieved in the Puppet
  language with the following equivalent expression:
  $my_hash = {'key_one' => 'value_one'}
  if 'key_one' in $my_hash {
    notice('this will be printed')
  }

  DOC

  unless args.length == 2
    raise Puppet::ParseError, "has_key(): wrong number of arguments (#{args.length}; must be 2)"
  end
  unless args[0].is_a?(Hash)
    raise Puppet::ParseError, "has_key(): expects the first argument to be a hash, got #{args[0].inspect} which is of type #{args[0].class}"
  end
  args[0].key?(args[1])
end