我正在尝试将所有面向用户的字符串放入一个文件中,以便更轻松地更改这些字符串。我正在寻找可读性方面的最佳实践。我现在有同一个文件的两个版本,我看到两个版本的权衡。所以我想知道是否有关于这种情况的最佳实践。
第一个 constants.py 文件
class strings:
esc_statuses = {
"RETURNED": "Returned",
"SUBMITTED": "Submitted",
"DRAFT": "Draft",
"CANCELED": "Canceled",
"ESCALATED": "Escalated"
}
NewEscFieldText = {
"customer_name": "The name of the customer who encountered this bug.",
"summary": "A brief summary of the bug.",
"request": "The request.",
"customer_impact": "How the customer is impacted.",
"severity": "The severity of the bug.",
"component": "The component of this bug.",
"related_bugs": "Bugs which are related to this one.",
"logs": "The logs assosciated with this bug.",
"description": "A detailed discription of the problem and any work \
put into reproducting it.",
"documentation": "Documentation consulted before escalation.",
}
在第一个版本中,我不得不说:
from constants import strings
然后每当我想引用一些东西时,我就不得不说
strings.esc_statuses["RETURNED"]
我认为 constants.py 文件在这种格式下看起来更具可读性,但每次我必须使用一个字符串时,我都会有一个更长的名字来咀嚼。
第二个常量.py 文件。
class strings:
# ------------------------ Escalation status -----------------------------
RETURNED = "Returned"
SUBMITTED = "Submitted"
DRAFT =: "Draft"
CANCELED =: "Canceled"
ESCALATED =: "Escalated"
# ----------------------- New Escalation Field Text ----------------------
customer_name = "The name of the customer who encountered this bug."
summary = "A brief summary of the bug."
request = "The request."
customer_impact = "How the customer is impacted."
severity = "The severity of the bug."
component = "The component of this bug."
related_bugs = "Bugs which are related to this one."
logs = "The logs assosciated with this bug."
description = "A detailed discription of the problem and any work put \
into reproducting it."
documentation = "Documentation consulted before escalation."
在这个版本中,我要说的是
from constants import strings
strings.RETURNED
我认为这使得使用字符串更具可读性,但也使文件本身更难阅读。
那么,是否有任何风格指南涵盖了这一点?有什么我错过的考虑吗?