python adv/adj 动词的命名约定?
python naming convention for verb with adv/adj?
也许这不是一个有效的问题,但我找不到任何相关信息。
我定义了一个函数来匹配 dict
、return 值中的键,如果给定的键部分包含在任何键中:
def partially_get(d: dict, key: str, default: Optional[Any] = None):
for k, v in d.items():
if key in k:
return v
return default
这种函数名称是否有任何“适当的”命名约定?
我应该使用“verb_adj”、“verb_adv”、“adj_verb”还是“adv_verb”?
==============
更新
正如@August 所建议的那样,以名词结尾似乎更清楚。
get_partially_matched_item
太长了,所以我会用 partially_matched_item
。
这是相当主观的。但是为了与 getattr
、isinstance
等内置函数保持一致,我可能会使用 get_partial
.
之类的东西
我建议:
get_partial_key
partial_name
我会选择 patially_matched_item
。一般来说,当你想命名一个没有副作用的函数时(只有 returns 个结果),最好在结果 returns 之后命名它。因此,您需要一个名词作为最后一个词,并以形容词为前缀,这些形容词在给定的上下文中以足够的精度描述结果。在最一般的意义上,结果是 item。因为它匹配一个键,所以它是一个 匹配项 并且因为它部分匹配一个键,我们最终得到名称 partially_matched_item
.
也许这不是一个有效的问题,但我找不到任何相关信息。
我定义了一个函数来匹配 dict
、return 值中的键,如果给定的键部分包含在任何键中:
def partially_get(d: dict, key: str, default: Optional[Any] = None):
for k, v in d.items():
if key in k:
return v
return default
这种函数名称是否有任何“适当的”命名约定?
我应该使用“verb_adj”、“verb_adv”、“adj_verb”还是“adv_verb”?
==============
更新
正如@August 所建议的那样,以名词结尾似乎更清楚。
get_partially_matched_item
太长了,所以我会用 partially_matched_item
。
这是相当主观的。但是为了与 getattr
、isinstance
等内置函数保持一致,我可能会使用 get_partial
.
我建议:
get_partial_key
partial_name
我会选择 patially_matched_item
。一般来说,当你想命名一个没有副作用的函数时(只有 returns 个结果),最好在结果 returns 之后命名它。因此,您需要一个名词作为最后一个词,并以形容词为前缀,这些形容词在给定的上下文中以足够的精度描述结果。在最一般的意义上,结果是 item。因为它匹配一个键,所以它是一个 匹配项 并且因为它部分匹配一个键,我们最终得到名称 partially_matched_item
.