Ignore self interaction

[cbouy]

Fixes #305

Adds an ignore parameter to the run methods to bypass specific residue pairs (defaults to lambda res1.resid == res2.resid).
Mostly useful when calculating a residue interaction network.

TODO:

• update changelog

[github-actions]

Type-checking report

No changes in type-hints coverage 🎉

Overview

.
├── prolif
│   ├── [x] __init__.py
│   ├── [x] _version.py
│   ├── [x] datafiles.py
│   ├── [x] exceptions.py
│   ├── [x] fingerprint.py
│   ├── [x] ifp.py
│   ├── interactions
│   │   ├── [x] __init__.py
│   │   ├── [x] base.py
│   │   ├── [x] constants.py
│   │   ├── [x] interactions.py
│   │   ├── [x] utils.py
│   │   └── [x] water_bridge.py
│   ├── io
│   │   ├── [x] __init__.py
│   │   ├── [x] cif.py
│   │   ├── [x] constants.py
│   │   ├── [x] molecule_standardizer.py
│   │   ├── [x] template_engine.py
│   │   └── [x] xml.py
│   ├── [x] molecule.py
│   ├── [x] parallel.py
│   ├── [x] pickling.py
│   ├── plotting
│   │   ├── [x] __init__.py
│   │   ├── [x] barcode.py
│   │   ├── [x] complex3d.py
│   │   ├── network
│   │   │   ├── [x] __init__.py
│   │   │   └── [x] lignetwork.py
│   │   ├── [x] residues.py
│   │   └── [x] utils.py
│   ├── [x] rdkitmol.py
│   ├── [x] residue.py
│   ├── [x] typeshed.py
│   └── [x] utils.py
├── scripts
│   ├── [x] check_types.py
│   └── [x] test_build.py
└── tests
    ├── [x] __init__.py
    ├── [x] conftest.py
    ├── plotting
    │   ├── [x] __init__.py
    │   ├── [x] test_barcode.py
    │   ├── [x] test_complex3d.py
    │   ├── [x] test_network.py
    │   └── [x] test_residues.py
    ├── [x] test_constants.py
    ├── [x] test_fingerprint.py
    ├── [x] test_ifp.py
    ├── [x] test_interactions.py
    ├── [x] test_io.py
    ├── [x] test_molecule.py
    ├── [x] test_parallel.py
    ├── [x] test_pickling.py
    ├── [x] test_residues.py
    └── [x] test_utils.py

Summary: 51/51 files have complete type hints (100.0%)

Remaining errors

Poe => mypy .
Success: no issues found in 51 source files

[codecov]

Codecov Report

✅ All modified and coverable lines are covered by tests.
✅ Project coverage is 95.99%. Comparing base (50e95a0) to head (40e338d).

Additional details and impacted files

@@            Coverage Diff             @@
##           master     #357      +/-   ##
==========================================
+ Coverage   95.98%   95.99%   +0.01%     
==========================================
  Files          29       29              
  Lines        2342     2349       +7     
==========================================
+ Hits         2248     2255       +7     
  Misses         94       94              

☔ View full report in Codecov by Harness.
📢 Have feedback on the report? Share it here.

🚀 New features to boost your workflow:

• ❄️ Test Analytics: Detect flaky tests, report on failures, and find test suite problems.
• 📦 JS Bundle Analysis: Save yourself from yourself by tracking and limiting bundle sizes in JS merges.