如何在Python Luigi中使用参数

时间:2017-01-26 15:23:00

标签: python luigi

如何将参数传递给Luigi?如果我有一个名为FileFinder.py的python文件,其名为getFIles:

class getFiles(luigi.Task):

我希望将目录传递给此类,例如:

C://Documents//fileName

然后在我的run方法中使用此参数

def run(self):

如何在命令行中运行此命令并添加参数以便在我的代码中使用?我习惯于在命令行中运行这个文件,如下所示:

python FileFinder.py getFiles --local-scheduler

我在代码中添加什么来使用参数,如何将该参数添加到命令行参数?

另外,作为这个问题的扩展,我将如何使用多个参数?或不同数据类型的参数,如字符串或列表?

3 个答案:

答案 0 :(得分:5)

正如您已经想到的那样,您可以通过

将参数传递给luigi
--param-name param-value

在命令行中。在代码中,您必须通过实例化Parameter类或其中一个子类来声明这些变量。子类用于告诉luigi变量是否具有非字符串的数据类型。下面是一个使用两个命令行参数的示例,一个Int和一个List

import luigi

class testClass(luigi.Task):
  int_var = luigi.IntParameter()
  list_var = luigi.ListParameter()

  def run(self):
      print('Integer Param + 1 = %i' % (self.int_var + 1))

      list_var = list(self.list_var)
      list_var.append('new_elem')
      print('List Param with added element: ' + str(list_var))

请注意,ListParams实际上是由luigi转换为元组的,所以如果你想对它们进行列表操作,你必须先将它们转换回来(这是known issue,但看起来不像它很快修好。

您可以从命令行调用上述模块(我已将代码保存为名为“testmodule.py”的文件,并从同一目录中调用):

luigi --module testmodule testClass --int-var 3 --list-var '[1,2,3]'  --local-scheduler

请注意,对于包含_的变量,必须将其替换为-。 通话产生(以及许多状态消息):

Integer Param + 1 = 4
List Param with added element: [1, 2, 3, 'new_elem']

答案 1 :(得分:3)

所以我觉得这很有效,在我添加的代码中:

fileName = luigi.Parameter()

如果我在命令行中运行它:

python FileFinder.py getFiles --local-scheduler --getFiles-fileName C://Documents//fileName

但如果有人对不同类型的参数以及如何使用它们有任何建议,特别是数字和列表,请告诉我。

答案 2 :(得分:0)

添加Toterich的回答。
将字符串参数列表作为ListParameter()传递时:

python file_name.py --local-scheduler TaskName --arg '["a","b"]'  

字符串参数必须用双引号括起来,而不是单引号,否则它会给出JSONParsing错误。