renamed some flaggers

README.md

@@ -125,7 +125,7 @@ In order to make your test available for the system you need to:
        (i.e. a column index into `data` and `columns`).
        The data and flags for this variable are available via `data[field]` and 
        `flags[field]` respectively
-    + `flagger: flagger.CategoricalBaseFlagger`: An instance of the `CategoricalBaseFlagger` class
+    + `flagger: flagger.CategoricalFlagger`: An instance of the `CategoricalFlagger` class
        (more likely one of its subclasses). To initialize, create or check
        against existing flags you should use the respective `flagger`-methods
        (`flagger.empytFlags`, `flagger.isFlagged` and `flagger.setFlag`)

saqc/core/core.py

@@ -9,7 +9,7 @@ from saqc.core.reader import readConfig, prepareConfig, checkConfig
 from saqc.core.config import Fields
 from saqc.core.evaluator import evalExpression
 from saqc.lib.plotting import plotHook, plotAllHook
-from saqc.flagger import BaseFlagger, CategoricalBaseFlagger, SimpleFlagger, DmpFlagger
+from saqc.flagger import BaseFlagger, CategoricalFlagger, SimpleFlagger, DmpFlagger
 
 
 def _collectVariables(meta, data):
@@ -39,7 +39,7 @@ def _checkInput(data, flags, flagger):
         raise TypeError("the columns of data is not allowed to be a multiindex")
 
     if not isinstance(flagger, BaseFlagger):
-        flaggerlist = [CategoricalBaseFlagger, SimpleFlagger, DmpFlagger]
+        flaggerlist = [CategoricalFlagger, SimpleFlagger, DmpFlagger]
         raise TypeError(
             f"flagger must be of type {flaggerlist} or any inherit class from {BaseFlagger}"
         )

saqc/flagger/__init__.py

@@ -2,7 +2,7 @@
 # -*- coding: utf-8 -*-
 
 from saqc.flagger.baseflagger import BaseFlagger
-from saqc.flagger.categoricalflagger import CategoricalBaseFlagger
+from saqc.flagger.categoricalflagger import CategoricalFlagger
 from saqc.flagger.simpleflagger import SimpleFlagger
 from saqc.flagger.dmpflagger import DmpFlagger
-from saqc.flagger.continuousflagger import ContinuousBaseFlagger
+from saqc.flagger.continuousflagger import ContinuousFlagger

saqc/flagger/categoricalflagger.py

@@ -20,7 +20,7 @@ class Flags(pd.CategoricalDtype):
         super().__init__(flags, ordered=True)
 
 
-class CategoricalBaseFlagger(BaseFlagger):
+class CategoricalFlagger(BaseFlagger):
     def __init__(self, flags):
         super().__init__(dtype=Flags(flags))
         self._categories = self.dtype.categories

saqc/flagger/continuousflagger.py

@@ -8,7 +8,7 @@ import intervals
 from saqc.flagger.baseflagger import BaseFlagger
 
 
-class ContinuousBaseFlagger(BaseFlagger):
+class ContinuousFlagger(BaseFlagger):
     def __init__(self, min_=0.0, max_=1.0, unflagged=-1.0):
         assert unflagged < 0 <= min_ < max_
         super().__init__(dtype=np.float64)

saqc/flagger/dmpflagger.py

@@ -8,7 +8,7 @@ from typing import Union, Sequence
 
 import pandas as pd
 
-from saqc.flagger.categoricalflagger import CategoricalBaseFlagger
+from saqc.flagger.categoricalflagger import CategoricalFlagger
 from saqc.lib.tools import assertDataFrame, toSequence, assertScalar
 
 
@@ -30,7 +30,7 @@ class ColumnLevels:
 FLAGS = ["NIL", "OK", "DOUBTFUL", "BAD"]
 
 
-class DmpFlagger(CategoricalBaseFlagger):
+class DmpFlagger(CategoricalFlagger):
     def __init__(self):
         super().__init__(FLAGS)
         self.flags_fields = [FlagFields.FLAG, FlagFields.CAUSE, FlagFields.COMMENT]

saqc/flagger/simpleflagger.py

 #! /usr/bin/env python
 # -*- coding: utf-8 -*-
 
+"""
+TODO: remove
+"""
 
-from saqc.flagger.categoricalflagger import CategoricalBaseFlagger
+from saqc.flagger.categoricalflagger import CategoricalFlagger
 
 
 FLAGS = [-1, 0, 1]
 
 
-class SimpleFlagger(CategoricalBaseFlagger):
+class SimpleFlagger(CategoricalFlagger):
     def __init__(self):
         super().__init__(FLAGS)

test/common.py

@@ -9,8 +9,8 @@ import pandas as pd
 
 from saqc.core.core import prepareConfig, readConfig
 from saqc.flagger import (
-    ContinuousBaseFlagger,
-    CategoricalBaseFlagger,
+    ContinuousFlagger,
+    CategoricalFlagger,
     SimpleFlagger,
     DmpFlagger,
 )
@@ -20,10 +20,10 @@ TESTNODATA = (np.nan, -9999)
 
 
 TESTFLAGGER = (
-    CategoricalBaseFlagger(["NIL", "GOOD", "BAD"]),
+    CategoricalFlagger(["NIL", "GOOD", "BAD"]),
     SimpleFlagger(),
     DmpFlagger(),
-    ContinuousBaseFlagger(),
+    ContinuousFlagger(),
 )