PYL-W0212 · Protected member accessed from outside the class

sanketsaurav / lore

Active

Protected member accessed from outside the class PYL-W0212

Bug risk

Minor

4 years ago — 5 years old

Access to a protected member _db_reader of a client class

314    def get_latitude(ip):
315        import geoip2
316        try:
317            return GeoIP.reader._db_reader.get(ip)['location']['latitude']318        except (KeyError, TypeError, ValueError, geoip2.errors.AddressNotFoundError):
319            return float('nan')
320

Access to a protected member _db_reader of a client class

lore/transformers.py

322    def get_longitude(ip):
323        import geoip2
324        try:
325            return GeoIP.reader._db_reader.get(ip)['location']['longitude']326        except (KeyError, TypeError, ValueError, geoip2.errors.AddressNotFoundError):
327            return float('nan')
328

Access to a protected member _db_reader of a client class

lore/transformers.py

330    def get_accuracy(ip):
331        import geoip2
332        try:
333            return GeoIP.reader._db_reader.get(ip)['location']['accuracy_radius']334        except (KeyError, TypeError, ValueError, geoip2.errors.AddressNotFoundError):
335            return float('nan')
336

Access to a protected member _engine of a client class

lore/metadata/__init__.py

 17logger = logging.getLogger(__name__)
 18Base = declarative_base()
 19adapter = lore.io.metadata.adapter
 20engine = lore.io.metadata._engine 21Session = scoped_session(sessionmaker(bind=engine))
 22
 23

Access to a protected member _sections of a client class

lore/io/__init__.py

 28        if section == 'DATABASES':
 29            continue
 30
 31        options = config._sections[section] 32        if options.get('url') == '$DATABASE_URL':
 33            logger.error('$DATABASE_URL is not set, but is used in config/database.cfg. Skipping connection.')
 34        else:

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()