polymerist.rdutils.rdprops.bondprops
====================================

.. py:module:: polymerist.rdutils.rdprops.bondprops

.. autoapi-nested-parse::

   For assigning, transferring, and removing properties of RDKit Bonds



Attributes
----------

.. autoapisummary::

   polymerist.rdutils.rdprops.bondprops.T


Functions
---------

.. autoapisummary::

   polymerist.rdutils.rdprops.bondprops.bond_ids_with_prop
   polymerist.rdutils.rdprops.bondprops.aggregate_bond_prop
   polymerist.rdutils.rdprops.bondprops.clear_bond_props
   polymerist.rdutils.rdprops.bondprops.annotate_bond_prop
   polymerist.rdutils.rdprops.bondprops.annotate_bond_ids
   polymerist.rdutils.rdprops.bondprops.clear_bond_annotations


Module Contents
---------------

.. py:data:: T

.. py:function:: bond_ids_with_prop(rdmol: rdkit.Chem.Mol, prop_name: str) -> list[int]

   Returns list of indices of bonds which have a particular property assigned


.. py:function:: aggregate_bond_prop(rdmol: rdkit.Chem.Mol, prop: str, prop_type: T = str) -> dict[int, T]

   Collects the values of a given Prop across all bonds in an RDKit molecule


.. py:function:: clear_bond_props(rdmol: rdkit.Chem.Mol) -> None

   Wipe properties of all bonds in a molecule


.. py:function:: annotate_bond_prop(rdmol: rdkit.Chem.Mol, prop: str, prop_type: T = str, annotate_precision: Optional[int] = None) -> None

   Labels the desired Prop for all bonds in a Mol which have it


.. py:function:: annotate_bond_ids(rdmol: rdkit.Chem.Mol, bond_id_remap: Optional[dict[int, int]] = None) -> None

   Draws bond indices over their positions when displaying a Mol.
   Can optionally provide a dict mapping bond indices to some other integers


.. py:function:: clear_bond_annotations(rdmol: rdkit.Chem.Mol) -> None

   Removes bond annotations over their positions when displaying a Mol