Make attirbutes private

heracles/catalog/base.py

@@ -396,12 +396,12 @@ def select(self, selection: TypeVar("Unknown")) -> Iterator[TypeVar("Unknown")]:
 class CatalogBase(metaclass=ABCMeta):
     """Abstract base class for base catalogues (not views)."""
 
-    default_page_size: int = 100_000
+    _default_page_size: int = 100_000
     """Default value for page size"""
 
     def __init__(self) -> None:
         """Create a new catalogue instance."""
-        self._page_size = self.default_page_size
+        self._page_size = self._default_page_size
         self._filters = []
         self._visibility = None
 

heracles/catalog/filters.py

@@ -39,12 +39,13 @@ def __init__(
         If ``warn`` is true, invalid values will emit a warning.
 
         Args:
+            columns: _description_
             weight: _description_
             warn: _description_
         """
-        self.columns = columns
-        self.weight = weight
-        self.warn = warn
+        self._columns = columns
+        self._weight = weight
+        self._warn = warn
 
     def __repr__(self) -> str:
         """_summary_.
@@ -53,8 +54,8 @@ def __repr__(self) -> str:
             _description_
         """
         name = self.__class__.__name__
-        args = list(map(repr, self.columns))
-        args += [f"weight={self.weight!r}", f"warn={self.warn!r}"]
+        args = list(map(repr, self._columns))
+        args += [f"weight={self._weight!r}", f"warn={self._warn!r}"]
         args = ", ".join(args)
         return f"{name}({args})"
 
@@ -65,13 +66,13 @@ def __call__(self, page: TypeVar("Unknown")) -> None:
             page: _description_
         """
         invalid_mask = np.zeros(page.size, dtype=bool)
-        for col in self.columns:
+        for col in self._columns:
             invalid_mask |= np.isnan(page[col])
-        if self.weight is not None:
-            invalid_mask &= page[self.weight] != 0
+        if self._weight is not None:
+            invalid_mask &= page[self._weight] != 0
         invalid = np.where(invalid_mask)[0]
         if len(invalid) > 0:
-            if self.warn:
+            if self._warn:
                 warnings.warn("WARNING: catalog contains invalid values")
             page.delete(invalid)
 

heracles/util.py

@@ -34,11 +34,11 @@ def __init__(self, out: io.IOBase = sys.stdout) -> None:
         Args:
             out: _description_
         """
-        self.out = out
-        self.time = 0
-        self.progress = 0
-        self.total = 0
-        self.title = None
+        self._out = out
+        self._time = 0
+        self._progress = 0
+        self._total = 0
+        self._title = None
 
     def start(
         self,
@@ -51,10 +51,10 @@ def start(
             total: _description_
             title: _description_
         """
-        self.time = time.monotonic()
-        self.progress = 0
-        self.total = total
-        self.title = title
+        self._time = time.monotonic()
+        self._progress = 0
+        self._total = total
+        self._title = title
         self.update(0)
 
     def update(self, step: int = 1) -> None:
@@ -63,22 +63,22 @@ def update(self, step: int = 1) -> None:
         Args:
             step: _description_
         """
-        self.progress = min(self.progress + step, self.total)
-        m = f"{self.title!s}: " if self.title is not None else ""
-        p = self.progress / self.total
+        self._progress = min(self._progress + step, self._total)
+        m = f"{self._title!s}: " if self._title is not None else ""
+        p = self._progress / self._total
         b = "#" * int(20 * p)
-        f = f"{self.progress:_}/{self.total:_}"
-        t = timedelta(seconds=(time.monotonic() - self.time))
+        f = f"{self._progress:_}/{self._total:_}"
+        t = timedelta(seconds=(time.monotonic() - self._time))
         s = f"\r{m}{100*p:3.0f}% |{b:20s}| {f} | {t}"
         try:
-            w, _ = os.get_terminal_size(self.out.fileno())
+            w, _ = os.get_terminal_size(self._out.fileno())
         except (OSError, AttributeError):
             pass
         else:
             if w > 0:
                 s = s[:w]
-        self.out.write(s)
-        self.out.flush()
+        self._out.write(s)
+        self._out.flush()
 
     def stop(self, complete: bool = True) -> None:
         """Stop progress and end line.
@@ -87,5 +87,5 @@ def stop(self, complete: bool = True) -> None:
             complete: _description_
         """
         if complete:
-            self.update(self.total - self.progress)
-        self.out.write("\n")
+            self.update(self._total - self._progress)
+        self._out.write("\n")

tests/test_catalog.py

@@ -167,11 +167,11 @@ def test_catalog_base_properties(catalog):
     assert catalog.base is None
     assert catalog.selection is None
 
-    assert catalog.page_size == CatalogBase.default_page_size
+    assert catalog.page_size == CatalogBase._default_page_size
     catalog.page_size = 1
     assert catalog.page_size == 1
-    catalog.page_size = CatalogBase.default_page_size
-    assert catalog.page_size == CatalogBase.default_page_size
+    catalog.page_size = CatalogBase._default_page_size
+    assert catalog.page_size == CatalogBase._default_page_size
 
     filt = object()
     assert catalog.filters == []