Was ist in Python eine bevorzugte Namenskonvention für den Backing Store einer internen Eigenschaft?

Question

Angenommen, Sie haben eine öffentliche Methode in Python, deren Hauptzweck es ist, den Wert eines zugrunde liegenden Datenattributs (d. H. Interner Sicherungsspeicher) abzurufen. Die Methode kann eine verzögerte Auswertungslogik usw. haben. Eine Eigenschaft ist ein Beispiel für eine solche Methode.

Dann ist es natürlich, den gleichen Namen für die Methode und das Datenattribut zu verwenden, außer für ein Unterstrichpräfix für das Datenattribut. Für example--

class C(object): 
def __init__(self): 
    self._x = None 

@property 
def x(self): 
    """I'm the 'x' property.""" 
    return self._x 

(von Python's "property" documentation)

Aber was sind einige bevorzugte Konventionen, wenn das Verfahren für den internen Gebrauch bestimmt und so wird sich mit einem Unterstrich voran? Wenn Sie den Backing Store mit zwei führenden Unterstrichen vorfixieren, wird der Name Mangling aufgerufen und ist daher nicht ideal.

Zwei Möglichkeiten

def _get_x(self): 
    return self._x 

def _x(self): 
    return self._x_ 

Python-Stil, sagt der zweite (Anfügen eines Unterstrichs) be-- könnte, sollte aber nur mit reservierten Schlüsselwörter um Konflikte zu vermeiden verwendet werden.

Answer 1

Warum würden Sie es zu einer Eigenschaft machen, wenn es für den internen Gebrauch ist? Wenn es für den internen Gebrauch ist, greifen Sie einfach direkt auf das Attribut zu.

Aber dann würden Sie immer noch einen Unterstrich verwenden, aber nennen Sie es etwas anderes. Aber auch hier ist der ganze Sinn, es zum Eigentum zu machen, verloren gegangen.

Answer 2

Die bevorzugte Konvention besteht darin, einen einzelnen führenden Unterstrich zu verwenden.

Dies ist die PEP 8 Empfehlung für private Attribute.

Sehen Sie dieses Beispiel in der docstring für Immobilien():

>>> help(property) 
Help on class property in module builtins: 

class property(object) 
| property(fget=None, fset=None, fdel=None, doc=None) -> property attribute 
| 
| fget is a function to be used for getting an attribute value, and likewise 
| fset is a function for setting, and fdel a function for del'ing, an 
| attribute. Typical use is to define a managed attribute x: 
| class C(object): 
|  def getx(self): return self._x 
|  def setx(self, value): self._x = value 
|  def delx(self): del self._x 
|  x = property(getx, setx, delx, "I'm the 'x' property.") 
| 
| Decorators make defining new properties or modifying existing ones easy: 
| class C(object): 
|  @property 
|  def x(self): return self._x 
|  @x.setter 
|  def x(self, value): self._x = value 
|  @x.deleter 
|  def x(self): del self._x 
|