emailnetwork icon indicating copy to clipboard operation
emailnetwork copied to clipboard

get_summary may be potentially broken or should be private

Open onlyphantom opened this issue 3 years ago • 0 comments

To reproduce:

from emailnetwork.summary import DomainSummary
from emailnetwork.extract import MBoxReader

reader = MBoxReader('your-mbox-path')
summary.get_summary()

You get a Counter() call. I suspect your intention was to have get_summary() be called only by its internal methods, if so I suggest you change it to _get_summary().

The underscore prefix is meant as a hint to another programmer that a variable or method starting with a single underscore is intended for internal use. This convention is defined in PEP 8.

class Test:
    def __init__(self):
        self.foo = 11
       # internal attributes
        self._bar = 23

     def _private_cleaner(self):
          # internal use

onlyphantom avatar Mar 23 '21 03:03 onlyphantom