Как передать аргументы командной строки в задачу rake

898

У меня есть задача rake, которая должна вставить значение в несколько баз данных.

Я хотел бы передать это значение в команду rake из командной строки или из другой задачи rake.

Как я могу это сделать?

  • 4
    rakefile rdoc
  • 3
    Документы были отражены SeattleRb.
Показать ещё 1 комментарий
Теги:
command-line
command-line-arguments
rake

17 ответов

174
Лучший ответ

параметры и зависимости должны быть внутри массивов:

namespace :thing do
  desc "it does a thing"
  task :work, [:option, :foo, :bar] => [:environment] do |t, args|
    puts "work", args
  end

  task :another, [:option, :foo, :bar] => [:environment] do |t, args|
    puts "another #{args}"
    Rake::Task["thing:work"].invoke(args[:option], args[:foo], args[:bar])
    # or splat the args
    # Rake::Task["thing:work"].invoke(*args)
  end

end

Тогда

rake thing:work[1,2,3]
=> work: {:option=>"1", :foo=>"2", :bar=>"3"}

rake thing:another[1,2,3]
=> another {:option=>"1", :foo=>"2", :bar=>"3"}
=> work: {:option=>"1", :foo=>"2", :bar=>"3"}

ПРИМЕЧАНИЕ: переменная t не подходит для task. Это объект задачи, не очень полезный, если вы не знаете, что делаете.

  • 5
    Это сработало для меня в августе 2016 года ... обновленный ответ должен быть обновлен до этого, я думаю!
  • 2
    Я обновил это, чтобы быть принятым как ответ на запрос. Однако он не демонстрирует, как передать аргумент в другую задачу rake из самой задачи.
Показать ещё 9 комментариев
1106

Вы можете указать формальные аргументы в графе, добавив аргументы символов к вызову задачи. Например:

require 'rake'

task :my_task, [:arg1, :arg2] do |t, args|
  puts "Args were: #{args}"
end

task :invoke_my_task do
  Rake.application.invoke_task("my_task[1, 2]")
end

# or if you prefer this syntax...
task :invoke_my_task_2 do
  Rake::Task[:my_task].invoke(3, 4)
end

# a task with prerequisites passes its 
# arguments to it prerequisites
task :with_prerequisite, [:arg1, :arg2] => :my_task #<- name of prerequisite task

# to specify default values, 
# we take advantage of args being a Rake::TaskArguments object
task :with_defaults, :arg1, :arg2 do |t, args|
  args.with_defaults(:arg1 => :default_1, :arg2 => :default_2)
  puts "Args with defaults were: #{args}"
end

Затем из командной строки:

> rake my_task[1,2]
Args were: {:arg1=>"1", :arg2=>"2"}

> rake "my_task[1, 2]"
Args were: {:arg1=>"1", :arg2=>"2"}

> rake invoke_my_task
Args were: {:arg1=>"1", :arg2=>"2"}

> rake invoke_my_task_2
Args were: {:arg1=>3, :arg2=>4}

> rake with_prerequisite[5,6]
Args were: {:arg1=>"5", :arg2=>"6"}

> rake with_defaults
Args with defaults were: {:arg1=>:default_1, :arg2=>:default_2}

> rake with_defaults['x','y']
Args with defaults were: {:arg1=>"x", :arg2=>"y"}

Как показано во втором примере, если вы хотите использовать пробелы, кавычки вокруг имени цели необходимы, чтобы оболочка не разделяла аргументы в пространстве.

Рассматривая код в rake.rb, кажется, что rake не анализирует строки задач для извлечения аргументов для предпосылок, поэтому вы не можете сделать task :t1 => "dep[1,2]". Единственный способ указать разные аргументы для предпосылки - это явно вызвать его в рамках действия зависимой задачи, как в :invoke_my_task и :invoke_my_task_2.

Обратите внимание, что некоторые оболочки (например, zsh) требуют от вас скобок: rake my_task\['arg1'\]

  • 0
    Это не говорит мне, как запустить грабли с аргументами из другой задачи. Он охватывает только использование командной строки
  • 5
    Чтобы вызвать задачу в пространстве имен, просто выполните: Rake :: Task ['namespace: task']. Invoke
Показать ещё 12 комментариев
247

В дополнение к ответу kch (я не нашел, как оставить комментарий к этому, извините):

Вам не нужно указывать переменные в качестве переменных ENV перед командой rake. Вы можете просто установить их как обычные параметры командной строки:

rake mytask var=foo

и получить доступ к тем из вашего файла рейка как переменные ENV, например:

p ENV['var'] # => "foo"
  • 1
    Ах, так это то , как Rails это делает. Имеет смысл...
80

Если вы хотите передать именованные аргументы (например, со стандартным OptionParser), вы можете использовать что-то вроде этого:

$ rake user:create -- --user [email protected] --pass 123

обратите внимание на --, что необходимо для обхода стандартных аргументов Rake. Должен работать с Rake 0.9.x, <= 10.3.x.

Newer Rake изменил свой синтаксический анализ --, и теперь вы должны убедиться, что он не передан методу OptionParser#parse, например, с помощью parser.parse!(ARGV[2..-1])

require 'rake'
require 'optparse'
# Rake task for creating an account

namespace :user do |args|
  desc 'Creates user account with given credentials: rake user:create'
  # environment is required to have access to Rails models
  task :create do
    options = {}
    OptionParser.new(args) do |opts|
      opts.banner = "Usage: rake user:create [options]"
      opts.on("-u", "--user {username}","User email address", String) do |user|
        options[:user] = user
      end
      opts.on("-p", "--pass {password}","User password", String) do |pass|
        options[:pass] = pass
      end
    end.parse!

    puts "creating user account..."
    u = Hash.new
    u[:email] = options[:user]
    u[:password] = options[:pass]
    # with some DB layer like ActiveRecord:
    # user = User.new(u); user.save!
    puts "user: " + u.to_s
    puts "account created."
    exit 0
  end
end

exit в конце убедитесь, что дополнительные аргументы не будут интерпретироваться как задача Rake.

Также должен работать ярлык для аргументов:

 rake user:create -- -u [email protected] -p 123

Когда сценарии грабли выглядят так, возможно, пришло время искать другой инструмент, который позволил бы это просто из коробки.

  • 12
    С моей точки зрения это действительно лучший ответ. Обход переменных окружения kludges, странный синтаксис с аргументами задачи, дополнительное преимущество для стандартных --option-names . Единственное, что я могу предложить, - это использовать exit а не abort как abort предоставит вам код возврата 1 для оболочки. Если задача rake является частью сценария более высокого уровня, более распространенным является предположение, что ненулевой выход является ошибкой определенного типа.
  • 1
    Я согласен с Джо, это лучший ответ. Естественно, для передачи параметров в rake используется тот же интерфейс, что и при передаче параметров в сценарий.
Показать ещё 9 комментариев
56

Я нашел ответ на этих двух сайтах: Net Maniac и Aimred.

Для использования этой техники вам понадобится версия > 0.8 рейка

Обычное описание задачи рейка:

desc 'Task Description'
task :task_name => [:depends_on_taskA, :depends_on_taskB] do
  #interesting things
end

Чтобы передать аргументы, выполните три действия:

  • Добавить имена аргументов после имени задачи, разделенные запятыми.
  • Поместите зависимости в конец, используя: needs = > [...]
  • Место | t, args | после сделаем. (t - объект для этой задачи)

Чтобы получить доступ к аргументам в script, используйте args.arg_name

desc 'Takes arguments task'
task :task_name, :display_value, :display_times, :needs => [:depends_on_taskA, :depends_on_taskB] do |t, args|
  args.display_times.to_i.times do
    puts args.display_value
  end
end

Чтобы вызвать эту задачу из командной строки, передайте ей аргументы в [] s

rake task_name['Hello',4]

выводит

Hello
Hello
Hello
Hello

и если вы хотите вызвать эту задачу из другой задачи и передать ее аргументы, используйте invoke

task :caller do
  puts 'In Caller'
  Rake::Task[:task_name].invoke('hi',2)
end

то команда

rake caller

выводит

In Caller
hi
hi

Я не нашел способ передать аргументы как часть зависимости, так как следующий код разбивается:

task :caller => :task_name['hi',2]' do
   puts 'In Caller'
end
  • 14
    Формат этой функциональности изменился, так как в этом предупреждении говорится: 'task :t, arg, :needs => [deps]' is deprecated. Please use 'task :t, [args] => [deps]' instead.
30

Другим широко используемым вариантом является передача переменных окружения. В коде вы читаете их через ENV['VAR'] и можете передать их прямо перед командой rake, например

$ VAR=foo rake mytask
  • 0
    Честно говоря, я надеялся на грабли - эти программы --go --to -a, и моя задача могла получить их от ARGV. К сожалению, я не уверен, возможно ли это, однако в настоящее время я использую ваше решение: rake var1 = val1 var2 = val2
  • 3
    @jhs: rake blah -- --these --go --to --a-program (обратите внимание на -- чтобы сообщить rake, что его переключатели закончились), см. stackoverflow.com/questions/5086224/…
28

На самом деле @Ник Дежардинс ответил идеально. Но только для образования: вы можете использовать грязный подход: используя аргумент ENV

task :my_task do
  myvar = ENV['myvar']
  puts "myvar: #{myvar}"
end 

rake my_task myvar=10
#=> myvar: 10
24

Я не мог понять, как передать аргументы, а также среду: пока я не отработал это:

namespace :db do
  desc 'Export product data'
  task :export, [:file_token, :file_path] => :environment do |t, args|
    args.with_defaults(:file_token => "products", :file_path => "./lib/data/")

       #do stuff [...]

  end
end

И затем я вызываю так:

rake db:export['foo, /tmp/']
21
desc 'an updated version'
task :task_name, [:arg1, :arg2] => [:dependency1, :dependency2] do |t, args|
    puts args[:arg1]
end
  • 0
    Чтобы вызвать это, перейдите: rake task_name[hello, world]
  • 2
    from rake.rubyforge.org/files/doc/rakefile_rdoc.html "Несколько слов предостережения. Имя задачи rake и ее аргументы должны быть одним аргументом командной строки для rake. Обычно это означает отсутствие пробелов. Если нужны пробелы , тогда вся строка rake + аргумент должна быть заключена в кавычки. Примерно так: rake "name [billy bob, smith]" "
12

Я использую обычный аргумент ruby ​​в файле рейка:

DB = ARGV[1]

тогда я удаляю задачи грабли в нижней части файла (так как грабли будут искать задачу на основе этого имени аргумента).

task :database_name1
task :database_name2

:

rake mytask db_name

для меня это становится чище, чем var = foo ENV var и задачи args [blah, blah2].
заглушка немного jenky, но не так уж плохо, если у вас просто несколько сред, которые являются одноразовыми настройками

  • 2
    Чтобы предотвратить проблемы с замороженными строками, в конце используйте dup : db = ARGV [1] .dup
  • 0
    Событие лучше db = ARGV[1].dup unless ARGV[1].nil? чтобы предотвратить исключение дублирования ноль.
9

Я просто хотел запустить:

$ rake some:task arg1 arg2

Простой, не так ли? (Неа!)

Rake интерпретирует arg1 и arg2 как задачи и пытается их запустить. Поэтому мы просто прекращаем работу, прежде чем это произойдет.

namespace :some do
  task task: :environment do
    arg1, arg2 = ARGV

    # your task...

    exit
  end
end

Возьмите это, скобки!

Отказ от ответственности. Я хотел иметь возможность сделать это в довольно маленьком домашнем проекте. Не предназначен для использования в реальном мире, так как вы теряете способность подключать рейк-задачи (т.е. rake task1 task2 task3). ИМО не стоит. Просто используйте уродливый rake task[arg1,arg2].

  • 3
    Необходимо сделать это _, arg1, arg2 = ARGV как первый аргумент был назван как имя задачи rake. Но этот exit - хитрый трюк.
  • 0
    rake task[arg1,arg2] && rake task2 && rake task3 Не уверен, что это менее уродливо, чем rake task[arg1,arg2] task2 task3 . Вероятно, менее эффективно, хотя.
Показать ещё 1 комментарий
4

Способы прохождения аргумента верны в приведенном выше ответе. Однако для запуска задачи rake с аргументами существует небольшая техническая проблема, связанная с более новой версией рельсов

Он будет работать с rake "namespace: taskname ['argument1']"

Обратите внимание на инвертированные кавычки при запуске задачи из командной строки.

2

Мне нравится синтаксис "querystring" для передачи аргументов, особенно когда есть много аргументов, которые нужно передать.

Пример:

rake "mytask[width=10&height=20]"

"querystring":

width=10&height=20

Предупреждение: обратите внимание, что синтаксис rake "mytask[foo=bar]" и NOT rake mytask["foo=bar"]

При анализе внутри задачи рейка с помощью Rack::Utils.parse_nested_query мы получаем Hash:

=> {"width"=>"10", "height"=>"20"}

(Холодно, что вы можете передавать хэши и массивы, более ниже)

Вот как это сделать:

require 'rack/utils'

task :mytask, :args_expr do |t,args|
  args.with_defaults(:args_expr => "width=10&height=10")
  options = Rack::Utils.parse_nested_query(args[:args_expr])
end

Вот более расширенный пример, который я использую с Rails в delayed_job_active_record_threaded gem:

bundle exec rake "dj:start[ebooks[workers_number]=16&ebooks[worker_timeout]=60&albums[workers_number]=32&albums[worker_timeout]=120]"

Разработано так же, как описано выше, с зависимостью среды (чтобы загрузить среду Rails)

namespace :dj do
  task :start, [ :args_expr ] => :environment do |t, args|
    # defaults here...
    options = Rack::Utils.parse_nested_query(args[:args_expr])  
  end
end

Дает следующее в options

=> {"ebooks"=>{"workers_number"=>"16", "worker_timeout"=>"60"}, "albums"=>{"workers_number"=>"32", "worker_timeout"=>"120"}}
  • 0
    Downvoter, хочешь разработать?
2

Чтобы передать аргументы заданию по умолчанию, вы можете сделать что-то вроде этого. Например, скажем "Версия" - это ваш аргумент:

task :default, [:version] => [:build]

task :build, :version do |t,args|
  version = args[:version]
  puts version ? "version is #{version}" : "no version passed"
end

Затем вы можете вызвать его так:

$ rake
no version passed

или

$ rake default[3.2.1]
version is 3.2.1

или

$ rake build[3.2.1]
version is 3.2.1

Однако я не нашел способа избежать указания имени задачи (по умолчанию или сборки) при передаче в аргументах. Хотелось бы услышать, знает ли кто-нибудь об этом.

1

Большинство описанных выше методов не работают для меня, возможно, они устарели в более новых версиях. Последнее руководство можно найти здесь: http://guides.rubyonrails.org/command_line.html#custom-rake-tasks

копия и вставка ans из руководства:

task :task_name, [:arg_1] => [:pre_1, :pre_2] do |t, args|
  # You can use args from here
end

Вызвать это так

bin/rake "task_name[value 1]" # entire argument string should be quoted
0

Если вы не можете беспокоиться о том, какая позиция аргумента для чего и вы хотите сделать что-то вроде хэша аргументов ruby. Вы можете использовать один аргумент для передачи в строке, а затем повторно использовать эту строку в хэш-настройке.

namespace :dummy_data do
  desc "Tests options hash like arguments"
  task :test, [:options] => :environment do |t, args|
    arg_options = args[:options] || '' # nil catch incase no options are provided
    two_d_array = arg_options.scan(/\W*(\w*): (\w*)\W*/)
    puts two_d_array.to_s + ' # options are regexed into a 2d array'
    string_key_hash = two_d_array.to_h
    puts string_key_hash.to_s + ' # options are in a hash with keys as strings'
    options = two_d_array.map {|p| [p[0].to_sym, p[1]]}.to_h
    puts options.to_s + ' # options are in a hash with symbols'
    default_options = {users: '50', friends: '25', colour: 'red', name: 'tom'}
    options = default_options.merge(options)
    puts options.to_s + ' # default option values are merged into options'
  end
end

И в командной строке вы получите.

$ rake dummy_data:test["users: 100 friends: 50 colour: red"]
[["users", "100"], ["friends", "50"], ["colour", "red"]] # options are regexed into a 2d array
{"users"=>"100", "friends"=>"50", "colour"=>"red"} # options are in a hash with keys as strings
{:users=>"100", :friends=>"50", :colour=>"red"} # options are in a hash with symbols
{:users=>"100", :friends=>"50", :colour=>"red", :name=>"tom"} # default option values are merged into options
  • 1
    Ваш код нуждается в нескольких правильно размещенных пустых строках. Я не знаю, как вы читаете эту стену текста.
-4

При передаче параметров лучшим вариантом является входной файл, может ли это быть excel json или что вам нужно, и оттуда читать структуру данных и переменные, которые вам нужны, включая имя переменной, как это необходимо. Для чтения файла может быть следующая структура.

  namespace :name_sapace_task do
    desc "Description task...."
      task :name_task  => :environment do
        data =  ActiveSupport::JSON.decode(File.read(Rails.root+"public/file.json")) if defined?(data)
    # and work whit yoour data, example is data["user_id"]

    end
  end

Пример json

{
  "name_task": "I'm a task",
  "user_id": 389,
  "users_assigned": [389,672,524],
  "task_id": 3
}

Исполнение

rake :name_task 
  • 4
    Если вам нужен файл инструкций JSON для вашей задачи Rake, вы, вероятно, делаете слишком много вещей в своей задаче Rake.
  • 0
    Это способ чрезмерно усложнять то , что это невероятно просто.

Ещё вопросы

Сообщество Overcoder
Наверх
Меню