在 __init__ 中定义 class 属性 而不是在另一个 class 方法中定义 -- python
Defining a class property within __init__ as opposed to within another class method -- python
编辑
请注意,我注意到 Instance attribute attribute_name defined outside __init__ 可能是重复的,我基本同意这一点(我没有想到这个,因为我不知道要搜索 pylint)。但是,我想保留这个问题,因为我希望能够使用相同的方法重新初始化我的 class。上一个问题的普遍共识是 return 来自 loadData
脚本的每个参数,然后将其解析为 self 对象。这很好,但是,我仍然必须在另一种方法中再次执行此操作才能重新初始化我的 class 实例,这似乎仍然是额外的工作,只是为了提高一点可读性。也许问题是我的例子。在现实生活中,loadData
例程读取了大约 30 个参数,这就是为什么我不愿意在两个不同的位置解析它们。
如果这里的普遍共识是return输入参数是可行的方法,那么我们可以继续将这个问题作为重复问题关闭;但是,与此同时,我想等一下,看看是否还有其他人 ideas/a 很好地解释了原因。
原创
这是一个 "best practices" 的问题。我最近一直在学习 python(部分是为了学习新东西,部分是为了摆脱 MATLAB)。在 python 中工作时,我创建了一个结构如下的 class:
class exampleClass:
"""
This is an example class to demonstrate my question to stack exchange
"""
def __init__( self, fileName ):
exampleClass.loadData( self, fileName )
def loadData( self, fileName ):
"""
This function reads the data specified in the fileName into the
current instance of exampleClass.
:param fileName: The file that the data is to be loaded from
"""
with open(fileName,'r') as sumFile:
self.name = sumFile.readLine().strip(' \n\r\t')
现在这对我来说很有意义。我有一个 init class,它通过调用填充函数来填充 class 的当前实例。我还有 population 函数,如果出于某种原因我需要重新初始化这个 class 的给定实例(例如,如果 class 占用大量内存而不是创建单独的class 我只想覆盖一个实例。
但是,当我将此代码放入我的 IDE (pycharm) 时,它会发出警告,指出实例属性是在 __init__
之外定义的。现在显然这不会影响代码的运行,一切正常,但我想知道在这种情况下是否有任何理由要注意警告。我可以做一些事情,在调用 loadData method
之前在 init 方法中将所有属性初始化为某个默认值,但这对我来说似乎是不必要的工作,并且它会减慢执行速度(尽管只是非常小的数量) ).我基本上也可以拥有 loadData 方法的两个副本,一个在 __init__
方法中,另一个作为实际方法,但这又似乎是不必要的额外工作。
总的来说,我的问题是在这种情况下最佳做法是什么。是否有任何理由我应该按照我在上一段中提到的方式之一重组代码,或者这只是一个 IDE 的实例,代码检查警告过于宽泛。我显然可以看到一些需要考虑此警告的情况,但根据我目前的经验,在这种情况下它看起来不像是个问题。
我认为最好预先定义所有属性,即使您稍后要重新定义它们也是如此。当我阅读您的代码时,我希望能够看到您的数据结构。如果某个方法中隐藏了某些仅在特定情况下才定义的属性,就会使代码更难理解。
如果不方便或无法赋予属性最终值,我建议至少将其初始化为 None
。这向 reader 发出信号,表明该对象包含该属性,即使稍后重新定义它也是如此。
class exampleClass:
"""
This is an example class to demonstrate my question to stack exchange
"""
def __init__( self, fileName ):
# Note: this will be modified when a file is loaded
self.name = None
exampleClass.loadData( self, fileName )
另一种选择是 loadData
到 return 的值而不是设置它,所以你的 init 可能看起来像:
def __init__(self, fileName):
self.name = self.loadData(fileName)
我倾向于认为第二种方法更好,但两种方法都可以。重点是,让您的 类 和对象尽可能易于理解。
编辑
请注意,我注意到 Instance attribute attribute_name defined outside __init__ 可能是重复的,我基本同意这一点(我没有想到这个,因为我不知道要搜索 pylint)。但是,我想保留这个问题,因为我希望能够使用相同的方法重新初始化我的 class。上一个问题的普遍共识是 return 来自 loadData
脚本的每个参数,然后将其解析为 self 对象。这很好,但是,我仍然必须在另一种方法中再次执行此操作才能重新初始化我的 class 实例,这似乎仍然是额外的工作,只是为了提高一点可读性。也许问题是我的例子。在现实生活中,loadData
例程读取了大约 30 个参数,这就是为什么我不愿意在两个不同的位置解析它们。
如果这里的普遍共识是return输入参数是可行的方法,那么我们可以继续将这个问题作为重复问题关闭;但是,与此同时,我想等一下,看看是否还有其他人 ideas/a 很好地解释了原因。
原创
这是一个 "best practices" 的问题。我最近一直在学习 python(部分是为了学习新东西,部分是为了摆脱 MATLAB)。在 python 中工作时,我创建了一个结构如下的 class:
class exampleClass:
"""
This is an example class to demonstrate my question to stack exchange
"""
def __init__( self, fileName ):
exampleClass.loadData( self, fileName )
def loadData( self, fileName ):
"""
This function reads the data specified in the fileName into the
current instance of exampleClass.
:param fileName: The file that the data is to be loaded from
"""
with open(fileName,'r') as sumFile:
self.name = sumFile.readLine().strip(' \n\r\t')
现在这对我来说很有意义。我有一个 init class,它通过调用填充函数来填充 class 的当前实例。我还有 population 函数,如果出于某种原因我需要重新初始化这个 class 的给定实例(例如,如果 class 占用大量内存而不是创建单独的class 我只想覆盖一个实例。
但是,当我将此代码放入我的 IDE (pycharm) 时,它会发出警告,指出实例属性是在 __init__
之外定义的。现在显然这不会影响代码的运行,一切正常,但我想知道在这种情况下是否有任何理由要注意警告。我可以做一些事情,在调用 loadData method
之前在 init 方法中将所有属性初始化为某个默认值,但这对我来说似乎是不必要的工作,并且它会减慢执行速度(尽管只是非常小的数量) ).我基本上也可以拥有 loadData 方法的两个副本,一个在 __init__
方法中,另一个作为实际方法,但这又似乎是不必要的额外工作。
总的来说,我的问题是在这种情况下最佳做法是什么。是否有任何理由我应该按照我在上一段中提到的方式之一重组代码,或者这只是一个 IDE 的实例,代码检查警告过于宽泛。我显然可以看到一些需要考虑此警告的情况,但根据我目前的经验,在这种情况下它看起来不像是个问题。
我认为最好预先定义所有属性,即使您稍后要重新定义它们也是如此。当我阅读您的代码时,我希望能够看到您的数据结构。如果某个方法中隐藏了某些仅在特定情况下才定义的属性,就会使代码更难理解。
如果不方便或无法赋予属性最终值,我建议至少将其初始化为 None
。这向 reader 发出信号,表明该对象包含该属性,即使稍后重新定义它也是如此。
class exampleClass:
"""
This is an example class to demonstrate my question to stack exchange
"""
def __init__( self, fileName ):
# Note: this will be modified when a file is loaded
self.name = None
exampleClass.loadData( self, fileName )
另一种选择是 loadData
到 return 的值而不是设置它,所以你的 init 可能看起来像:
def __init__(self, fileName):
self.name = self.loadData(fileName)
我倾向于认为第二种方法更好,但两种方法都可以。重点是,让您的 类 和对象尽可能易于理解。