Update

Author: cthoyt

docs/source/converter_with_preprocessing.rst

@@ -1,8 +1,29 @@
 Converter with Preprocessing
 ============================
 
-When simple expansion and contraction aren't enough, and you want to
-inject global or context-specific rewrite rules, you can wrap a :class:`curies.Converter`
-and preprocessing rules encoded in an instance of :class:`curies.PreprocessingRules` inside
+When simple expansion and contraction aren't enough, and you want to inject global or
+context-specific rewrite rules, you can wrap a :class:`curies.Converter` and
+preprocessing rules encoded in an instance of :class:`curies.PreprocessingRules` inside
 a :class:`curies.PreprocessingConverter`.
 
+For example, you always want to fix legacy references to the ``OBO_REL`` namespace:
+
+.. code-block:: python
+
+    import curies
+    from curies import PreprocessingRules, PreprocessingConverter
+    from curies.wrapped import Rewrites
+
+    rules = PreprocessingRules(
+        rewrites=Rewrites(
+            full={"OBO_REL:is_a": "rdfs:subClassOf"}
+        )
+    )
+
+    converter = curies.get_obo_converter()
+    converter = PreprocessingConverter.from_converter(
+        converter, rules=rules
+    )
+
+    >>> converter.parse_curie("OBO_REL:is_a")
+    ReferenceTuple('rdfs', 'subClassOf')

src/curies/__init__.py

@@ -35,7 +35,12 @@
 )
 from .triples import Triple
 from .version import get_version
-from .wrapped import PreprocessingConverter, PreprocessingRules
+from .preprocessing import (
+    PreprocessingConverter,
+    PreprocessingRules,
+    PreprocessingRewrites,
+    PreprocessingBlacklist,
+)
 
 __all__ = [
     "Converter",
@@ -48,6 +53,8 @@
     "PrefixMap",
     "PreprocessingConverter",
     "PreprocessingRules",
+    "PreprocessingRewrites",
+    "PreprocessingBlacklist",
     "Record",
     "Records",
     "Reference",

src/curies/wrapped.py src/curies/preprocessing.pysrc/curies/wrapped.py renamed to src/curies/preprocessing.py

@@ -12,17 +12,17 @@
 from .api import Converter, Reference, ReferenceTuple
 
 __all__ = [
-    "Blacklist",
+    "PreprocessingBlacklist",
     "BlacklistError",
     "PreprocessingConverter",
     "PreprocessingRules",
-    "Rewrites",
+    "PreprocessingRewrites",
 ]
 
 X = TypeVar("X", bound=Reference)
 
 
-class Blacklist(BaseModel):
+class PreprocessingBlacklist(BaseModel):
     """A model for prefix and full blacklists."""
 
     full: list[str] = Field(default_factory=list)
@@ -75,7 +75,7 @@ def str_is_blacklisted(
         )
 
 
-class Rewrites(BaseModel):
+class PreprocessingRewrites(BaseModel):
     """A model for prefix and full rewrites."""
 
     full: dict[str, str] = Field(
@@ -124,8 +124,8 @@ def remap_prefix(self, str_or_curie_or_uri: str, ontology_prefix: str | None = N
 class PreprocessingRules(BaseModel):
     """A model for blacklists and rewrites."""
 
-    blacklists: Blacklist
-    rewrites: Rewrites
+    blacklists: PreprocessingBlacklist
+    rewrites: PreprocessingRewrites
 
     @classmethod
     def lint_file(cls, path: str | Path) -> None:
@@ -191,7 +191,8 @@ def __init__(
 
         :param args: Positional arguments passed to :func:`Converter.__init__`
         :param rules: A set of rules
-        :param reference_cls: The reference class to use. Defaults to :class:`curies.Reference`.
+        :param reference_cls: The reference class to use. Defaults to
+            :class:`curies.Reference`.
         :param kwargs: Keyword arguments passed to :func:`Converter.__init__`
         """
         super().__init__(*args, **kwargs)