Add method is_clipping to CigarOp (#54)

* Added is_clipping() to CigarOp
fulcrumgenomics · Aug 28, 2023 · 42d8ead · 42d8ead
1 parent 0289d8d
commit 42d8ead
Show file tree

Hide file tree

Showing 2 changed files with 8 additions and 0 deletions.
diff --git a/fgpyo/sam/__init__.py b/fgpyo/sam/__init__.py
@@ -374,6 +374,11 @@ def is_indel(self) -> bool:
         """Returns true if the operator is an indel, false otherwise."""
         return self == CigarOp.I or self == CigarOp.D
 
+    @property
+    def is_clipping(self) -> bool:
+        """Returns true if the operator is a soft/hard clip, false otherwise."""
+        return self == CigarOp.S or self == CigarOp.H
+
 
 @attr.s(frozen=True, slots=True)
 class CigarElement:

diff --git a/fgpyo/sam/tests/test_sam.py b/fgpyo/sam/tests/test_sam.py
@@ -280,6 +280,9 @@ def test_is_indel() -> None:
     indels = [op for op in CigarOp if op.is_indel]
     assert indels == [CigarOp.I, CigarOp.D]
 
+def test_is_clipping() -> None:
+    clips = [op for op in CigarOp if op.is_clipping]
+    assert clips == [CigarOp.S, CigarOp.H]
 
 def test_isize() -> None:
     builder = SamBuilder()