草庐IT

python - 采用单个对象或可迭代对象的 Python 函数中的参数名称

coder 2023-08-20 原文

我的代码中有一些函数接受一个对象或一个可迭代的对象作为输入。我被教导要为所有事物使用有意义的名称，但我不确定如何遵守这里的规定。我应该怎么称呼一个可以是单一对象或可迭代对象的参数？我提出了两个想法，但我都不喜欢其中任何一个:

  1. FooOrManyFoos - 这表达了正在发生的事情，但我可以想象不习惯它的人可能无法立即理解它的含义
  2. param - 一些通用名称。这清楚地表明它可以是几件事，但没有解释参数的用途。

通常我将对象的可迭代称为单个对象的复数形式。我知道这可能看起来有点强制性，但 Python 应该(除其他外)与可读性有关。

最佳答案

I have some functions in my code that accept either an object or an iterable of objects as input.

这是一件非常特殊且通常非常糟糕的事情。这是可以避免的。

即调用此函数时传递 [foo] 而不是 foo。

唯一可以证明这样做是合理的情况是 (1) 您已经安装了期望一种形式(可迭代或单例)的软件，并且 (2) 您必须扩展它以支持其他用例。所以。您仅在扩展具有现有代码库的现有功能时执行此操作。

如果这是新开发的，请不要这样做。

I have come up with two ideas, but I don't like either of them:

[只有两个？]

FooOrManyFoos - This expresses what goes on, but I could imagine that someone not used to it could have trouble understanding what it means right away

什么？你是说你没有提供其他文件，也没有其他培训？没有支持？没有建议？谁是“不习惯的人”？跟他们讲话。不要假设或想象关于他们的事情。

此外，不要使用前导大写名称。

param - Some generic name. This makes clear that it can be several things, but does explain nothing about what the parameter is used for.

太可怕了。绝不。做。这个。

我在 Python 库中查找示例。大多数执行此操作的函数都有简单的描述。

http://docs.python.org/library/functions.html#isinstance

是实例(对象，类信息)

他们称之为“classinfo”，它可以是一个类或类的元组。

你也可以这样做。

您必须考虑常见用例和异常(exception)情况。遵循 80/20 法则。

  1. 80% 的情况下，您可以将其替换为可迭代对象而不会出现此问题。

  2. 在剩下的 20% 的情况下，您有一个围绕假设(可迭代或单个项目)构建的软件安装基础，您需要添加其他情况。不要更改名称，只需更改文档即可。如果它曾经说“foo”，它仍然说“foo”，但你让它接受一个可迭代的“foo's”而不对参数做任何更改。如果它曾经说“foo_list”或“foo_iter”，那么它仍然会说“foo_list”或“foo_iter”，但它会安静地容忍一个单例而不会中断。

    • 80% 的代码是遗留的(“foo”或“foo_list”)

    • 20% 的代码是新功能(“foo”可以是可迭代的，或者“foo_list”可以是单个对象。)

关于python - 采用单个对象或可迭代对象的 Python 函数中的参数名称，我们在Stack Overflow上找到一个类似的问题： https://stackoverflow.com/questions/3683116/

pythonblockquotesectionfoonaming-conventions

有关python - 采用单个对象或可迭代对象的 Python 函数中的参数名称的更多相关文章

  1. ruby - 如何从 ruby​​ 中的字符串运行任意对象方法？ - 2

    总的来说，我对ruby​​还比较陌生，我正在为我正在创建的对象编写一些rspec测试用例。许多测试用例都非常基础，我只是想确保正确填充和返回值。我想知道是否有办法使用循环结构来执行此操作。不必为我要测试的每个方法都设置一个assertEquals。例如:describeitem,"TestingtheItem"doit"willhaveanullvaluetostart"doitem=Item.new#HereIcoulddotheitem.name.shouldbe_nil#thenIcoulddoitem.category.shouldbe_nilendend但我想要一些方法来使用

  2. ruby - 其他文件中的 Rake 任务 - 2

    我试图在一个项目中使用rake，如果我把所有东西都放到Rakefile中，它会很大并且很难读取/找到东西，所以我试着将每个命名空间放在lib/rake中它自己的文件中，我添加了这个到我的rake文件的顶部:Dir['#{File.dirname(__FILE__)}/lib/rake/*.rake'].map{|f|requiref}它加载文件没问题，但没有任务。我现在只有一个.rake文件作为测试，名为“servers.rake”，它看起来像这样:namespace:serverdotask:testdoputs"test"endend所以当我运行rakeserver:testid时

  3. ruby-on-rails - Ruby net/ldap 模块中的内存泄漏 - 2

    作为我的Rails应用程序的一部分，我编写了一个小导入程序，它从我们的LDAP系统中吸取数据并将其塞入一个用户表中。不幸的是，与LDAP相关的代码在遍历我们的32K用户时泄漏了大量内存，我一直无法弄清楚如何解决这个问题。这个问题似乎在某种程度上与LDAP库有关，因为当我删除对LDAP内容的调用时，内存使用情况会很好地稳定下来。此外，不断增加的对象是Net::BER::BerIdentifiedString和Net::BER::BerIdentifiedArray，它们都是LDAP库的一部分。当我运行导入时，内存使用量最终达到超过1GB的峰值。如果问题存在，我需要找到一些方法来更正我的代

  4. python - 如何使用 Ruby 或 Python 创建一系列高音调和低音调的蜂鸣声？ - 2

    关闭。这个问题是opinion-based.它目前不接受答案。想要改进这个问题？更新问题，以便editingthispost可以用事实和引用来回答它.关闭4年前。Improvethisquestion我想在固定时间创建一系列低音和高音调的哔哔声。例如:在150毫秒时发出高音调的蜂鸣声在151毫秒时发出低音调的蜂鸣声200毫秒时发出低音调的蜂鸣声250毫秒的高音调蜂鸣声有没有办法在Ruby或Python中做到这一点？我真的不在乎输出编码是什么(.wav、.mp3、.ogg等等)，但我确实想创建一个输出文件。

  5. ruby-on-rails - Rails 3 中的多个路由文件 - 2

    Rails2.3可以选择随时使用RouteSet#add_configuration_file添加更多路由。是否可以在Rails3项目中做同样的事情？ 最佳答案 在config/application.rb中:config.paths.config.routes在Rails3.2(也可能是Rails3.1)中，使用:config.paths["config/routes"] 关于ruby-on-rails-Rails3中的多个路由文件，我们在StackOverflow上找到一个类似的问题

  6. ruby-on-rails - 按天对 Mongoid 对象进行分组 - 2

    在控制台中反复尝试之后，我想到了这种方法，可以按发生日期对类似activerecord的(Mongoid)对象进行分组。我不确定这是完成此任务的最佳方法，但它确实有效。有没有人有更好的建议，或者这是一个很好的方法？#eventsisanarrayofactiverecord-likeobjectsthatincludeatimeattributeevents.map{|event|#converteventsarrayintoanarrayofhasheswiththedayofthemonthandtheevent{:number=>event.time.day,:event=>ev

  7. ruby-on-rails - Rails - 一个 View 中的多个模型 - 2

    我需要从一个View访问多个模型。以前，我的links_controller仅用于提供以不同方式排序的链接资源。现在我想包括一个部分(我假设)显示按分数排序的顶级用户(@users=User.all.sort_by(&:score))我知道我可以将此代码插入每个链接操作并从View访问它，但这似乎不是“ruby方式”，我将需要在不久的将来访问更多模型。这可能会变得很脏，是否有针对这种情况的任何技术？注意事项:我认为我的应用程序正朝着单一格式和动态页面内容的方向发展，本质上是一个典型的网络应用程序。我知道before_filter但考虑到我希望应用程序进入的方向，这似乎很麻烦。最终从任何

  8. ruby-on-rails - Rails 3.2.1 中 ActionMailer 中的未定义方法 'default_content_type=' - 2

    我在我的项目中添加了一个系统来重置用户密码并通过电子邮件将密码发送给他，以防他忘记密码。昨天它运行良好(当我实现它时)。当我今天尝试启动服务器时，出现以下错误。=>BootingWEBrick=>Rails3.2.1applicationstartingindevelopmentonhttp://0.0.0.0:3000=>Callwith-dtodetach=>Ctrl-CtoshutdownserverExiting/Users/vinayshenoy/.rvm/gems/ruby-1.9.3-p0/gems/actionmailer-3.2.1/lib/action_mailer

  9. ruby-on-rails - 如何在 ruby​​ 中使用两个参数异步运行 exe？ - 2

    exe应该在我打开页面时运行。异步进程需要运行。有什么方法可以在ruby​​中使用两个参数异步运行exe吗？我已经尝试过ruby​​命令-system()、exec()但它正在等待过程完成。我需要用参数启动exe，无需等待进程完成是否有任何ruby​​gems会支持我的问题？ 最佳答案 您可以使用Process.spawn和Process.wait2:pid=Process.spawn'your.exe','--option'#Later...pid,status=Process.wait2pid您的程序将作为解释器的子进程执行。除

  10. ruby - RSpec - 使用测试替身作为 block 参数 - 2

    我有一些Ruby代码，如下所示:Something.createdo|x|x.foo=barend我想编写一个测试，它使用double代替block参数x，这样我就可以调用:x_double.should_receive(:foo).with("whatever").这可能吗？ 最佳答案 specify'something'dox=doublex.should_receive(:foo=).with("whatever")Something.should_receive(:create).and_yield(x)#callthere

随机推荐