Как передать аргументы командной строки в команду rake
У меня есть задача rake, которая должна вставить значение в несколько баз данных.
Я хотел бы передать это значение в команду rake из командной строки или из другой задачи rake.
Как я могу это сделать?
Ответы
Ответ 1
параметры и зависимости должны быть внутри массивов:
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
. Это объект задачи, не очень полезный, если вы не знаете, что делаете.
Ответ 2
Вы можете указать формальные аргументы в графе, добавив аргументы символов к вызову задачи. Например:
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'\]
Ответ 3
В дополнение к ответу kch (я не нашел, как оставить комментарий к этому, извините):
Вам не нужно указывать переменные в качестве переменных ENV
перед командой rake
. Вы можете просто установить их как обычные параметры командной строки:
rake mytask var=foo
и получить доступ к тем из вашего файла рейка как переменные ENV, например:
p ENV['var'] # => "foo"
Ответ 4
Если вы хотите передать именованные аргументы (например, со стандартным 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
Когда сценарии грабли выглядят так, возможно, пришло время искать другой инструмент, который позволил бы это просто из коробки.
Ответ 5
Я нашел ответ на этих двух сайтах: 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
Ответ 6
Другим широко используемым вариантом является передача переменных окружения. В коде вы читаете их через ENV['VAR']
и можете передать их прямо перед командой rake
, например
$ VAR=foo rake mytask
Ответ 7
На самом деле @Ник Дежардинс ответил идеально. Но только для образования: вы можете использовать грязный подход: используя аргумент ENV
task :my_task do
myvar = ENV['myvar']
puts "myvar: #{myvar}"
end
rake my_task myvar=10
#=> myvar: 10
Ответ 8
Я не мог понять, как передать аргументы, а также среду: пока я не отработал это:
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/']
Ответ 9
desc 'an updated version'
task :task_name, [:arg1, :arg2] => [:dependency1, :dependency2] do |t, args|
puts args[:arg1]
end
Ответ 10
Я использую обычный аргумент ruby в файле рейка:
DB = ARGV[1]
тогда я удаляю задачи грабли в нижней части файла (так как грабли будут искать задачу на основе этого имени аргумента).
task :database_name1
task :database_name2
:
rake mytask db_name
для меня это становится чище, чем var = foo ENV var и задачи args [blah, blah2].
заглушка немного jenky, но не так уж плохо, если у вас просто несколько сред, которые являются одноразовыми настройками
Ответ 11
Я просто хотел запустить:
$ 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]
.
Ответ 12
Способы прохождения аргумента верны в приведенном выше ответе. Однако для запуска задачи rake с аргументами существует небольшая техническая проблема, связанная с более новой версией рельсов
Он будет работать с rake "namespace: taskname ['argument1']"
Обратите внимание на инвертированные кавычки при запуске задачи из командной строки.
Ответ 13
Чтобы передать аргументы заданию по умолчанию, вы можете сделать что-то вроде этого. Например, скажем
"Версия" - это ваш аргумент:
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
Однако я не нашел способа избежать указания имени задачи (по умолчанию или сборки) при передаче в аргументах. Хотелось бы услышать, знает ли кто-нибудь об этом.
Ответ 14
Мне нравится синтаксис "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"}}
Ответ 15
Большинство описанных выше методов не работают для меня, возможно, они устарели в более новых версиях.
Последнее руководство можно найти здесь: 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
Ответ 16
Если вы не можете беспокоиться о том, какая позиция аргумента для чего и вы хотите сделать что-то вроде хэша аргументов 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
Ответ 17
При передаче параметров лучшим вариантом является входной файл, может ли это быть 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