PYL-W0212 · Protected member accessed from outside the class

Sbozzolo / kuibit

Active

Protected member accessed from outside the class PYL-W0212

Bug risk

Minor

8 days ago — 4 years old

Access to a protected member __x0 of a client class

620        copied = self.copy()
621
622        # We only need to shift x0 because x1 is computed from x0 using dx
623        copied.__x0 = copied.__x0 + shift624        return copied
625
626    def copy(self):

Access to a protected member __x0 of a client class

kuibit/uniform_grid.py

620        copied = self.copy()
621
622        # We only need to shift x0 because x1 is computed from x0 using dx
623        copied.__x0 = copied.__x0 + shift624        return copied
625
626    def copy(self):

Access to a protected member __num_ghost of a client class

kuibit/uniform_grid.py

600        copied.__shape = self.shape - 2 * self.num_ghost
601        # We "push x0 inside the grid"
602        copied.__x0 = copied.__x0 + self.num_ghost * self.dx
603        copied.__num_ghost = np.zeros_like(copied.shape)604        return copied
605
606    def shifted(self, shift):

Access to a protected member __x0 of a client class

kuibit/uniform_grid.py

599        # lower and upper ghostzones
600        copied.__shape = self.shape - 2 * self.num_ghost
601        # We "push x0 inside the grid"
602        copied.__x0 = copied.__x0 + self.num_ghost * self.dx603        copied.__num_ghost = np.zeros_like(copied.shape)
604        return copied
605

Access to a protected member __x0 of a client class

kuibit/uniform_grid.py

599        # lower and upper ghostzones
600        copied.__shape = self.shape - 2 * self.num_ghost
601        # We "push x0 inside the grid"
602        copied.__x0 = copied.__x0 + self.num_ghost * self.dx603        copied.__num_ghost = np.zeros_like(copied.shape)
604        return copied
605

Description

Accessing a protected member (a member prefixed with _) of a class from outside that class is not recommended, since the creator of that class did not intend this member to be exposed. If accesing this attribute outside of the class is absolutely needed, refactor it such that it becomes part of the public interface of the class.

Bad practice

class Rectangle(object):
    def __init__(self, height, width):
        self._height = height
        self._width = width

r = Rectangle(4, 8)
area = r._height * r._width

Preferred:

class Rectangle(object):
    def __init__(self, height, width):
        self._height = height
        self._width = width

    def area():
        return self._height * self._width

r = Rectangle(4, 8)
area = r.area()