openff-toolkit 0.18.0__py3-none-any.whl

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
Files changed (231) hide show
  1. devtools/scripts/build_cookiecutter_json.py +22 -0
  2. docs/conf.py +296 -0
  3. docs/conftest.py +23 -0
  4. examples/conformer_energies/conformer_energies.py +143 -0
  5. examples/deprecated/SMIRNOFF_comparison/compare_molecule_energies.py +48 -0
  6. examples/deprecated/SMIRNOFF_comparison/compare_set_energies.py +58 -0
  7. examples/deprecated/liquid_box/create_mol2_pdb/create_mol2_pdb.py +193 -0
  8. examples/deprecated/liquid_box/openff_simulation.py +72 -0
  9. examples/deprecated/mixedFF_structure/generate_mixedFF_complex.py +56 -0
  10. examples/deprecated/testing/test_impropers/tleap_tools.py +120 -0
  11. examples/examples_helper.py +61 -0
  12. openff/toolkit/__init__.py +101 -0
  13. openff/toolkit/_tests/__init__.py +0 -0
  14. openff/toolkit/_tests/_stale_tests.py +146 -0
  15. openff/toolkit/_tests/conftest.py +108 -0
  16. openff/toolkit/_tests/create_molecules.py +494 -0
  17. openff/toolkit/_tests/mocking.py +145 -0
  18. openff/toolkit/_tests/molecule/__init__.py +1 -0
  19. openff/toolkit/_tests/molecule/test_state_enumeration.py +302 -0
  20. openff/toolkit/_tests/test_energies.py +136 -0
  21. openff/toolkit/_tests/test_examples.py +109 -0
  22. openff/toolkit/_tests/test_forcefield.py +3864 -0
  23. openff/toolkit/_tests/test_interchange.py +19 -0
  24. openff/toolkit/_tests/test_io.py +19 -0
  25. openff/toolkit/_tests/test_links.py +73 -0
  26. openff/toolkit/_tests/test_mm_molecule.py +404 -0
  27. openff/toolkit/_tests/test_molecule.py +4246 -0
  28. openff/toolkit/_tests/test_nagl.py +169 -0
  29. openff/toolkit/_tests/test_parameter_plugins.py +89 -0
  30. openff/toolkit/_tests/test_parameters.py +2898 -0
  31. openff/toolkit/_tests/test_toolkit_io.py +1088 -0
  32. openff/toolkit/_tests/test_toolkits.py +4418 -0
  33. openff/toolkit/_tests/test_topology.py +2485 -0
  34. openff/toolkit/_tests/test_utils.py +101 -0
  35. openff/toolkit/_tests/test_utils_callback.py +178 -0
  36. openff/toolkit/_tests/test_utils_collections.py +263 -0
  37. openff/toolkit/_tests/test_utils_serialization.py +168 -0
  38. openff/toolkit/_tests/utils.py +1747 -0
  39. openff/toolkit/data/README.md +8 -0
  40. openff/toolkit/data/molecules/AlkEthOH_test_filt1_ff.mol2 +2026 -0
  41. openff/toolkit/data/molecules/AlkEthOH_test_filt1_tripos.mol2 +2026 -0
  42. openff/toolkit/data/molecules/AlkEthOH_tripos.tar.gz +0 -0
  43. openff/toolkit/data/molecules/CID20742535_anion.sdf +50 -0
  44. openff/toolkit/data/molecules/CID20742535_neutral.sdf +51 -0
  45. openff/toolkit/data/molecules/FreeSolv.tar.gz +0 -0
  46. openff/toolkit/data/molecules/MiniDrugBank.sdf +33988 -0
  47. openff/toolkit/data/molecules/MiniDrugBank_tripos.mol2 +35462 -0
  48. openff/toolkit/data/molecules/PT2385.sdf +90 -0
  49. openff/toolkit/data/molecules/QL8.sdf +401 -0
  50. openff/toolkit/data/molecules/README.md +21 -0
  51. openff/toolkit/data/molecules/benzene.crd +8 -0
  52. openff/toolkit/data/molecules/benzene.mol2 +34 -0
  53. openff/toolkit/data/molecules/benzene.top +166 -0
  54. openff/toolkit/data/molecules/butane_multi.sdf +231 -0
  55. openff/toolkit/data/molecules/cyclohexane.mol2 +44 -0
  56. openff/toolkit/data/molecules/ethanol.mol2 +25 -0
  57. openff/toolkit/data/molecules/ethanol.sdf +23 -0
  58. openff/toolkit/data/molecules/ethanol_partial_charges.sdf +26 -0
  59. openff/toolkit/data/molecules/ethanol_reordered.mol2 +25 -0
  60. openff/toolkit/data/molecules/ethanol_reordered.sdf +23 -0
  61. openff/toolkit/data/molecules/ethene_rdkit.sdf +17 -0
  62. openff/toolkit/data/molecules/laromustine_ff.mol2 +71 -0
  63. openff/toolkit/data/molecules/laromustine_tripos.mol2 +71 -0
  64. openff/toolkit/data/molecules/methane_multiconformer.sdf +32 -0
  65. openff/toolkit/data/molecules/methane_multiconformer_properties.sdf +45 -0
  66. openff/toolkit/data/molecules/nh4.pdb +7 -0
  67. openff/toolkit/data/molecules/po4_phenylphosphate.pdb +46 -0
  68. openff/toolkit/data/molecules/ruxolitinib_conformers.sdf +910 -0
  69. openff/toolkit/data/molecules/toluene.mol2 +38 -0
  70. openff/toolkit/data/molecules/toluene.mol2.gz +0 -0
  71. openff/toolkit/data/molecules/toluene.pdb +30 -0
  72. openff/toolkit/data/molecules/toluene.sdf +36 -0
  73. openff/toolkit/data/molecules/toluene_charged.mol2 +38 -0
  74. openff/toolkit/data/molecules/z_3_hydroxy_propenal.sdf +23 -0
  75. openff/toolkit/data/proteins/5tbm_complex_solv.pdb +1928 -0
  76. openff/toolkit/data/proteins/5tbm_complex_solv_box.pdb +19563 -0
  77. openff/toolkit/data/proteins/CTerminal_ALA.pdb +20 -0
  78. openff/toolkit/data/proteins/CTerminal_ALA.sdf +43 -0
  79. openff/toolkit/data/proteins/CTerminal_ALA_ALA.pdb +30 -0
  80. openff/toolkit/data/proteins/CTerminal_ALA_ALA_misnamedH.pdb +30 -0
  81. openff/toolkit/data/proteins/CTerminal_ARG.pdb +34 -0
  82. openff/toolkit/data/proteins/CTerminal_TRP.pdb +34 -0
  83. openff/toolkit/data/proteins/MainChain_ALA.pdb +25 -0
  84. openff/toolkit/data/proteins/MainChain_ALA.sdf +52 -0
  85. openff/toolkit/data/proteins/MainChain_ALA_ALA.pdb +35 -0
  86. openff/toolkit/data/proteins/MainChain_ALA_ALA.sdf +69 -0
  87. openff/toolkit/data/proteins/MainChain_ALA_ALA_icodes.pdb +35 -0
  88. openff/toolkit/data/proteins/MainChain_ALA_ALA_no_hydrogens.pdb +17 -0
  89. openff/toolkit/data/proteins/MainChain_ARG.pdb +39 -0
  90. openff/toolkit/data/proteins/MainChain_ARG.sdf +81 -0
  91. openff/toolkit/data/proteins/MainChain_CYM.pdb +25 -0
  92. openff/toolkit/data/proteins/MainChain_CYS.pdb +26 -0
  93. openff/toolkit/data/proteins/MainChain_CYX.pdb +48 -0
  94. openff/toolkit/data/proteins/MainChain_CYX.sdf +96 -0
  95. openff/toolkit/data/proteins/MainChain_GLH.sdf +64 -0
  96. openff/toolkit/data/proteins/MainChain_GLU.sdf +63 -0
  97. openff/toolkit/data/proteins/MainChain_HID.pdb +32 -0
  98. openff/toolkit/data/proteins/MainChain_HIE.pdb +32 -0
  99. openff/toolkit/data/proteins/MainChain_HIE.sdf +67 -0
  100. openff/toolkit/data/proteins/MainChain_HIP.pdb +33 -0
  101. openff/toolkit/data/proteins/MainChain_HIP.sdf +70 -0
  102. openff/toolkit/data/proteins/MainChain_PRO.pdb +29 -0
  103. openff/toolkit/data/proteins/MainChain_TRP.pdb +39 -0
  104. openff/toolkit/data/proteins/NTerminal_ALA.pdb +21 -0
  105. openff/toolkit/data/proteins/NTerminal_ALA.sdf +45 -0
  106. openff/toolkit/data/proteins/NTerminal_ALA_ALA.pdb +31 -0
  107. openff/toolkit/data/proteins/NTerminal_ARG.pdb +35 -0
  108. openff/toolkit/data/proteins/NTerminal_TRP.pdb +35 -0
  109. openff/toolkit/data/proteins/T4-protein-unprocessed-4w51.pdb +1892 -0
  110. openff/toolkit/data/proteins/T4-protein.mol2 +5461 -0
  111. openff/toolkit/data/proteins/T4-protein.pdb +2637 -0
  112. openff/toolkit/data/proteins/T4-protein.sdf +5318 -0
  113. openff/toolkit/data/proteins/T4_protein_waters.pdb +2965 -0
  114. openff/toolkit/data/proteins/TwoMol_SER_CYS.pdb +50 -0
  115. openff/toolkit/data/proteins/aa_residues_substructures_explicit_bond_orders_with_caps.json +6435 -0
  116. openff/toolkit/data/proteins/aa_residues_substructures_explicit_bond_orders_with_caps_explicit_connectivity.json +6675 -0
  117. openff/toolkit/data/proteins/aa_residues_substructures_with_caps.json +6297 -0
  118. openff/toolkit/data/proteins/ace-ZZZ-gly-nme.pdb +78 -0
  119. openff/toolkit/data/proteins/ace-ZZZ-gly-nme.sdf +98 -0
  120. openff/toolkit/data/proteins/ace-a10-nme.sdf +229 -0
  121. openff/toolkit/data/proteins/ace-ala-nh2.pdb +21 -0
  122. openff/toolkit/data/proteins/fluoresceine_dyed_helix_capped.pdb +338 -0
  123. openff/toolkit/data/proteins/neutral_arginine.pdb +31 -0
  124. openff/toolkit/data/proteins/split_chain.pdb +74 -0
  125. openff/toolkit/data/proteins/split_chain_reordered.pdb +74 -0
  126. openff/toolkit/data/reference_energies/README.md +6 -0
  127. openff/toolkit/data/reference_energies/reference_0.8.0.json +1 -0
  128. openff/toolkit/data/reference_energies/reference_0.8.0.json.txt +180 -0
  129. openff/toolkit/data/reference_energies/reference_after_1007.json +1 -0
  130. openff/toolkit/data/reference_energies/reference_after_1007.json.txt +350 -0
  131. openff/toolkit/data/reference_energies/reference_after_802.json +1 -0
  132. openff/toolkit/data/reference_energies/reference_after_802.json.txt +291 -0
  133. openff/toolkit/data/systems/README.md +3 -0
  134. openff/toolkit/data/systems/amber/cyclohexane_ethanol_0.4_0.6.inpcrd +1511 -0
  135. openff/toolkit/data/systems/amber/cyclohexane_ethanol_0.4_0.6.prmtop +13367 -0
  136. openff/toolkit/data/systems/monomers/butanol.mol2 +38 -0
  137. openff/toolkit/data/systems/monomers/butanol.sdf +88 -0
  138. openff/toolkit/data/systems/monomers/cyclohexane.mol2 +45 -0
  139. openff/toolkit/data/systems/monomers/cyclohexane.sdf +105 -0
  140. openff/toolkit/data/systems/monomers/ethanol.mol2 +26 -0
  141. openff/toolkit/data/systems/monomers/ethanol.sdf +58 -0
  142. openff/toolkit/data/systems/monomers/methane.mol2 +18 -0
  143. openff/toolkit/data/systems/monomers/methane.sdf +38 -0
  144. openff/toolkit/data/systems/monomers/propane.mol2 +30 -0
  145. openff/toolkit/data/systems/monomers/propane.sdf +68 -0
  146. openff/toolkit/data/systems/monomers/tip3p_water.mol2 +14 -0
  147. openff/toolkit/data/systems/monomers/water.mol2 +14 -0
  148. openff/toolkit/data/systems/monomers/water.sdf +28 -0
  149. openff/toolkit/data/systems/packmol_boxes/cyclohexane_ethanol_0.4_0.6.pdb +6272 -0
  150. openff/toolkit/data/systems/packmol_boxes/cyclohexane_water.pdb +5524 -0
  151. openff/toolkit/data/systems/packmol_boxes/ethanol_water.pdb +5174 -0
  152. openff/toolkit/data/systems/packmol_boxes/propane_methane_butanol_0.2_0.3_0.5.pdb +7959 -0
  153. openff/toolkit/data/systems/test_systems/1_cyclohexane_1_ethanol.pdb +61 -0
  154. openff/toolkit/data/systems/test_systems/1_ethanol.pdb +24 -0
  155. openff/toolkit/data/systems/test_systems/1_ethanol_no_conect.pdb +15 -0
  156. openff/toolkit/data/systems/test_systems/1_ethanol_reordered.pdb +24 -0
  157. openff/toolkit/data/systems/test_systems/PE.pdb +67 -0
  158. openff/toolkit/data/systems/test_systems/README.md +3 -0
  159. openff/toolkit/data/systems/test_systems/T4_lysozyme_water_ions.pdb +29240 -0
  160. openff/toolkit/data/test_forcefields/Frosst_AlkEthOH.offxml +61 -0
  161. openff/toolkit/data/test_forcefields/Frosst_AlkEthOH_GBSA.offxml +78 -0
  162. openff/toolkit/data/test_forcefields/Frosst_AlkEthOH_MDL.offxml +62 -0
  163. openff/toolkit/data/test_forcefields/Frosst_AlkEthOH_parmAtFrosst.offxml +64 -0
  164. openff/toolkit/data/test_forcefields/GBSA_HCT-1.0.offxml +21 -0
  165. openff/toolkit/data/test_forcefields/GBSA_OBC1-1.0.offxml +18 -0
  166. openff/toolkit/data/test_forcefields/GBSA_OBC2-1.0.offxml +18 -0
  167. openff/toolkit/data/test_forcefields/README.md +23 -0
  168. openff/toolkit/data/test_forcefields/ammonia_minimal.offxml +27 -0
  169. openff/toolkit/data/test_forcefields/benzene_minimal.offxml +29 -0
  170. openff/toolkit/data/test_forcefields/chargeincrement-test.offxml +16 -0
  171. openff/toolkit/data/test_forcefields/frcmod.Frosst_AlkEthOH_withIDs +85 -0
  172. openff/toolkit/data/test_forcefields/ion_charges.offxml +18 -0
  173. openff/toolkit/data/test_forcefields/mangled.offxml +9 -0
  174. openff/toolkit/data/test_forcefields/old/README.md +9 -0
  175. openff/toolkit/data/test_forcefields/old/hbonds.offxml +11 -0
  176. openff/toolkit/data/test_forcefields/old/test_ff_0_0_2_spec_0_1.offxml +332 -0
  177. openff/toolkit/data/test_forcefields/old/test_ff_0_0_2_spec_0_2.offxml +338 -0
  178. openff/toolkit/data/test_forcefields/old/test_ff_0_0_2_spec_0_3.offxml +329 -0
  179. openff/toolkit/data/test_forcefields/old/test_ff_0_0_4_fixed_spec_0_1.offxml +342 -0
  180. openff/toolkit/data/test_forcefields/old/test_ff_0_0_4_fixed_spec_0_2.offxml +348 -0
  181. openff/toolkit/data/test_forcefields/old/test_ff_0_0_4_fixed_spec_0_3.offxml +337 -0
  182. openff/toolkit/data/test_forcefields/old/test_ff_0_0_4_spec_0_1.offxml +340 -0
  183. openff/toolkit/data/test_forcefields/old/test_ff_0_0_4_spec_0_2.offxml +346 -0
  184. openff/toolkit/data/test_forcefields/old/test_ff_0_0_4_spec_0_3.offxml +337 -0
  185. openff/toolkit/data/test_forcefields/smirff99Frosst_reference_0_1_spec.offxml +349 -0
  186. openff/toolkit/data/test_forcefields/smirnoff99Frosst_experimental.offxml +343 -0
  187. openff/toolkit/data/test_forcefields/smirnoff99Frosst_reference_0_1_spec.offxml +349 -0
  188. openff/toolkit/data/test_forcefields/smirnoff99Frosst_reference_0_2_spec.offxml +356 -0
  189. openff/toolkit/data/test_forcefields/test_forcefield.offxml +346 -0
  190. openff/toolkit/data/test_forcefields/tip3p.offxml +22 -0
  191. openff/toolkit/data/test_forcefields/unsupported_smirnoff_version.offxml +9 -0
  192. openff/toolkit/topology/__init__.py +43 -0
  193. openff/toolkit/topology/_mm_molecule.py +663 -0
  194. openff/toolkit/topology/molecule.py +6102 -0
  195. openff/toolkit/topology/topology.py +2555 -0
  196. openff/toolkit/typing/__init__.py +1 -0
  197. openff/toolkit/typing/engines/__init__.py +1 -0
  198. openff/toolkit/typing/engines/smirnoff/__init__.py +31 -0
  199. openff/toolkit/typing/engines/smirnoff/forcefield.py +1440 -0
  200. openff/toolkit/typing/engines/smirnoff/io.py +234 -0
  201. openff/toolkit/typing/engines/smirnoff/parameters.py +3839 -0
  202. openff/toolkit/typing/engines/smirnoff/plugins.py +91 -0
  203. openff/toolkit/utils/__init__.py +57 -0
  204. openff/toolkit/utils/_viz.py +104 -0
  205. openff/toolkit/utils/ambertools_wrapper.py +507 -0
  206. openff/toolkit/utils/base_wrapper.py +268 -0
  207. openff/toolkit/utils/builtin_wrapper.py +136 -0
  208. openff/toolkit/utils/callback.py +187 -0
  209. openff/toolkit/utils/collections.py +247 -0
  210. openff/toolkit/utils/constants.py +18 -0
  211. openff/toolkit/utils/exceptions.py +766 -0
  212. openff/toolkit/utils/nagl_wrapper.py +164 -0
  213. openff/toolkit/utils/openeye_wrapper.py +2750 -0
  214. openff/toolkit/utils/rdkit_wrapper.py +3302 -0
  215. openff/toolkit/utils/serialization.py +466 -0
  216. openff/toolkit/utils/toolkit_registry.py +509 -0
  217. openff/toolkit/utils/toolkits.py +217 -0
  218. openff/toolkit/utils/utils.py +805 -0
  219. openff_toolkit-0.18.0.dist-info/METADATA +109 -0
  220. openff_toolkit-0.18.0.dist-info/RECORD +231 -0
  221. openff_toolkit-0.18.0.dist-info/WHEEL +5 -0
  222. openff_toolkit-0.18.0.dist-info/licenses/LICENSE +21 -0
  223. openff_toolkit-0.18.0.dist-info/top_level.txt +5 -0
  224. utilities/deprecated/convert_frosst/convert_frcmod_0.1.py +251 -0
  225. utilities/deprecated/convert_frosst/convert_frcmod_0.2.py +249 -0
  226. utilities/deprecated/convert_frosst/convert_frcmod_0.3.py +249 -0
  227. utilities/make_substructure_dict/_cif_to_substructure_dict.py +955 -0
  228. utilities/make_substructure_dict/_make_chemical_substructures.py +46 -0
  229. utilities/make_substructure_dict/_make_metadata_assignment_substructures.py +35 -0
  230. utilities/test_plugins/custom_plugins/handler_plugins.py +48 -0
  231. utilities/test_plugins/setup.py +19 -0
@@ -0,0 +1,509 @@
1
+ "Registry for ToolkitWrapper objects"
2
+
3
+ __all__ = ("ToolkitRegistry", "toolkit_registry_manager")
4
+
5
+ import inspect
6
+ import logging
7
+ from collections.abc import Callable
8
+ from contextlib import contextmanager
9
+
10
+ from openff.toolkit.utils.ambertools_wrapper import AmberToolsToolkitWrapper
11
+ from openff.toolkit.utils.base_wrapper import ToolkitWrapper
12
+ from openff.toolkit.utils.builtin_wrapper import BuiltInToolkitWrapper
13
+ from openff.toolkit.utils.exceptions import (
14
+ InvalidToolkitError,
15
+ LicenseError,
16
+ ToolkitUnavailableException,
17
+ )
18
+ from openff.toolkit.utils.openeye_wrapper import OpenEyeToolkitWrapper
19
+ from openff.toolkit.utils.rdkit_wrapper import RDKitToolkitWrapper
20
+ from openff.toolkit.utils.utils import all_subclasses
21
+
22
+ logger = logging.getLogger(__name__)
23
+
24
+
25
+ class ToolkitRegistry:
26
+ """
27
+ A registry and precedence list for :py:class:`ToolkitWrapper` objects.
28
+
29
+ ``ToolkitRegistry`` allows the OpenFF Toolkit to provide a concise,
30
+ universal API that can call out to other well-established libraries rather
31
+ than re-implement algorithms with well-established implementations, while
32
+ still giving users control over dependencies. It contains a list of
33
+ :py:class:`ToolkitWrapper` objects, each of which provides some collection
34
+ of methods that may be requested from the registry. The :py:meth:`call`
35
+ method takes a name and calls the method of that name on each wrapper until
36
+ it finds a working implementation, whose result it returns. For details on
37
+ how this search is conducted and what counts as a working implementation,
38
+ see that method's API docs.
39
+
40
+ Examples
41
+ --------
42
+
43
+ Register toolkits in a specified order, skipping if unavailable
44
+
45
+ >>> from openff.toolkit.utils.toolkits import ToolkitRegistry
46
+ >>> toolkit_precedence = [OpenEyeToolkitWrapper, RDKitToolkitWrapper, AmberToolsToolkitWrapper]
47
+ >>> toolkit_registry = ToolkitRegistry(toolkit_precedence)
48
+ >>> toolkit_registry
49
+ <ToolkitRegistry containing OpenEye Toolkit, The RDKit, AmberTools>
50
+
51
+ Register all available toolkits (in the order OpenEye, RDKit, AmberTools,
52
+ built-in)
53
+
54
+ >>> toolkits = [OpenEyeToolkitWrapper, RDKitToolkitWrapper, AmberToolsToolkitWrapper, BuiltInToolkitWrapper]
55
+ >>> toolkit_registry = ToolkitRegistry(toolkit_precedence=toolkits)
56
+ >>> toolkit_registry
57
+ <ToolkitRegistry containing OpenEye Toolkit, The RDKit, AmberTools, Built-in Toolkit>
58
+
59
+ Retrieve the global singleton toolkit registry, which is created when this
60
+ module is imported from all available toolkits:
61
+
62
+ >>> from openff.toolkit.utils.toolkits import GLOBAL_TOOLKIT_REGISTRY
63
+ >>> GLOBAL_TOOLKIT_REGISTRY
64
+ <ToolkitRegistry containing OpenEye Toolkit, The RDKit, AmberTools, Built-in Toolkit>
65
+
66
+ Note that this will contain different ToolkitWrapper objects based on what
67
+ toolkits are currently installed.
68
+
69
+ Call a method on the registered toolkit wrapper with the highest precedence:
70
+
71
+ >>> molecule = toolkit_registry.call('from_smiles', 'Cc1ccccc1')
72
+
73
+ For more, see the :py:meth:`call` method.
74
+
75
+ .. warning :: This API is experimental and subject to change.
76
+ """
77
+
78
+ _toolkits: list[ToolkitWrapper]
79
+
80
+ def __init__(
81
+ self,
82
+ toolkit_precedence: list[type[ToolkitWrapper]] | None = None,
83
+ exception_if_unavailable: bool = True,
84
+ _register_imported_toolkit_wrappers: bool = False,
85
+ ):
86
+ """
87
+ Create an empty toolkit registry.
88
+
89
+ Parameters
90
+ ----------
91
+ toolkit_precedence
92
+ List of toolkit wrapper classes, in order of desired precedence when performing molecule operations. If
93
+ None, no toolkits will be registered.
94
+
95
+ exception_if_unavailable
96
+ If True, an exception will be raised if the toolkit is unavailable
97
+
98
+ _register_imported_toolkit_wrappers
99
+ If True, will attempt to register all imported ToolkitWrapper subclasses that can be
100
+ found in the order of toolkit_precedence, if specified. If toolkit_precedence is not
101
+ specified, the default order is [OpenEyeToolkitWrapper, RDKitToolkitWrapper,
102
+ AmberToolsToolkitWrapper, BuiltInToolkitWrapper].
103
+
104
+ """
105
+ self._toolkits = list()
106
+
107
+ toolkit_classes_to_register: list[type[ToolkitWrapper]] = list()
108
+
109
+ if _register_imported_toolkit_wrappers:
110
+ if toolkit_precedence is None:
111
+ toolkit_precedence = [
112
+ OpenEyeToolkitWrapper,
113
+ RDKitToolkitWrapper,
114
+ AmberToolsToolkitWrapper,
115
+ BuiltInToolkitWrapper,
116
+ ]
117
+ all_importable_toolkit_wrappers = all_subclasses(ToolkitWrapper)
118
+ for toolkit in toolkit_precedence:
119
+ if toolkit in all_importable_toolkit_wrappers:
120
+ toolkit_classes_to_register.append(toolkit)
121
+ else:
122
+ if toolkit_precedence is not None:
123
+ toolkit_classes_to_register = toolkit_precedence
124
+
125
+ if toolkit_classes_to_register:
126
+ for toolkit in toolkit_classes_to_register:
127
+ self.register_toolkit(
128
+ toolkit_wrapper=toolkit,
129
+ exception_if_unavailable=exception_if_unavailable,
130
+ )
131
+
132
+ @property
133
+ def registered_toolkits(self) -> list[ToolkitWrapper]:
134
+ """
135
+ List registered toolkits.
136
+
137
+ .. warning :: This API is experimental and subject to change.
138
+
139
+ .. todo :: Should this return a generator? Deep copies? Classes? Toolkit names?
140
+
141
+ Returns
142
+ -------
143
+ toolkits
144
+ """
145
+ return list(self._toolkits)
146
+
147
+ @property
148
+ def registered_toolkit_versions(self) -> dict[str, str]:
149
+ """
150
+ Return a dict containing the version of each registered toolkit.
151
+
152
+ .. warning :: This API is experimental and subject to change.
153
+
154
+ Returns
155
+ -------
156
+ toolkit_versions
157
+ A dictionary mapping names and versions of wrapped toolkits
158
+
159
+ """
160
+ return {tk.toolkit_name: tk.toolkit_version for tk in self.registered_toolkits}
161
+
162
+ # TODO: Can we instead register available methods directly with `ToolkitRegistry`,
163
+ # so we can just use `ToolkitRegistry.method()`?
164
+ def call(
165
+ self,
166
+ method_name: str,
167
+ *args,
168
+ raise_exception_types: list[type[Exception]] | None = None,
169
+ **kwargs,
170
+ ):
171
+ """
172
+ Execute a method with the first registered toolkits that supports it.
173
+
174
+ This method searches the registry's precedence list for the first
175
+ wrapper that has an attribute named ``method_name`` and attempts to
176
+ call it as a method using the arguments in ``*args`` and ``**kwargs``.
177
+ If that method raises no exception, its return value is returned.
178
+
179
+ By default, if a wrapper with an appropriately-named method raises an
180
+ exception of any type, then iteration over the registered toolkits
181
+ stops early and that exception is raised. To limit this behavior to only
182
+ certain exceptions and otherwise continue iteration, customize this
183
+ behavior using the optional ``raise_exception_types`` keyword argument.
184
+ If iteration finishes without finding a wrapper that can successfully
185
+ call the requested method, a ``ValueError`` is raised, containing a
186
+ message listing the registered toolkits and any exceptions that
187
+ occurred.
188
+
189
+ Parameters
190
+ ----------
191
+ method_name
192
+ The name of the method to execute
193
+ raise_exception_types
194
+ A list of exception-derived types to catch and raise immediately. If
195
+ ``None``, the first exception encountered will be raised. To ignore
196
+ all exceptions, set this to the empty list ``[]``.
197
+
198
+ Raises
199
+ ------
200
+ ValueError
201
+ If no suitable toolkit wrapper was found in the registry.
202
+
203
+ Exception
204
+ Other forms of exceptions are possible if raise_exception_types is
205
+ specified. These are defined by the ``ToolkitWrapper`` method being
206
+ called.
207
+
208
+ Examples
209
+ --------
210
+
211
+ Create a molecule, and call the toolkit ``to_smiles()`` method directly
212
+
213
+ >>> from openff.toolkit import (
214
+ ... Molecule,
215
+ ... ToolkitRegistry,
216
+ ... AmberToolsToolkitWrapper,
217
+ ... RDKitToolkitWrapper,
218
+ ... )
219
+ >>> molecule = Molecule.from_smiles('Cc1ccccc1')
220
+ >>> toolkit_registry = ToolkitRegistry([
221
+ ... AmberToolsToolkitWrapper,
222
+ ... RDKitToolkitWrapper,
223
+ ... ])
224
+ >>> smiles = toolkit_registry.call('to_smiles', molecule)
225
+
226
+ Stop if a partial charge assignment method encounters an error during
227
+ the partial charge calculation (:py:exc:`ChargeCalculationError`), but
228
+ proceed to the next wrapper for any other exception such as the wrapper
229
+ not supporting the charge method:
230
+
231
+ >>> from openff.toolkit import GLOBAL_TOOLKIT_REGISTRY
232
+ >>> from openff.toolkit.utils.exceptions import ChargeCalculationError
233
+ >>> GLOBAL_TOOLKIT_REGISTRY.call(
234
+ ... "assign_partial_charges",
235
+ ... molecule=Molecule.from_smiles('C'),
236
+ ... partial_charge_method="gasteiger",
237
+ ... raise_exception_types=[ChargeCalculationError],
238
+ ... )
239
+
240
+ Calling a method that exists on none of the wrappers raises a
241
+ ``ValueError``:
242
+
243
+ >>> from openff.toolkit import ToolkitRegistry, RDKitToolkitWrapper
244
+ >>> toolkit_registry = ToolkitRegistry([RDKitToolkitWrapper])
245
+ >>> toolkit_registry.call("there_is_no_spoon") # doctest: +ELLIPSIS +NORMALIZE_WHITESPACE
246
+ Traceback (most recent call last):
247
+ ...
248
+ ValueError: No registered toolkits can provide the capability
249
+ "there_is_no_spoon" for args "()" and kwargs "{}"
250
+ Available toolkits are: [ToolkitWrapper around The RDKit version ...]
251
+ <BLANKLINE>
252
+
253
+ """
254
+ if raise_exception_types is None:
255
+ raise_exception_types = [Exception]
256
+
257
+ errors = list()
258
+ for toolkit in self._toolkits:
259
+ if hasattr(toolkit, method_name):
260
+ method = getattr(toolkit, method_name)
261
+ try:
262
+ return method(*args, **kwargs)
263
+ except Exception as e:
264
+ for exception_type in raise_exception_types:
265
+ if isinstance(e, exception_type):
266
+ raise e
267
+ errors.append((toolkit, e))
268
+
269
+ # No toolkit was found to provide the requested capability
270
+ # TODO: Can we help developers by providing a check for typos in expected method names?
271
+ msg = (
272
+ f'No registered toolkits can provide the capability "{method_name}" '
273
+ f'for args "{args}" and kwargs "{kwargs}"\n'
274
+ )
275
+
276
+ msg += f"Available toolkits are: {self.registered_toolkits}\n"
277
+ # Append information about toolkits that implemented the method, but could not handle the provided parameters
278
+ for toolkit, error in errors:
279
+ msg += f" {toolkit} {type(error)} : {error}\n"
280
+ raise ValueError(msg)
281
+
282
+ def __repr__(self):
283
+ return f"<ToolkitRegistry containing {', '.join([tk.toolkit_name for tk in self._toolkits])}>"
284
+
285
+ def register_toolkit(
286
+ self,
287
+ toolkit_wrapper: ToolkitWrapper | type[ToolkitWrapper],
288
+ exception_if_unavailable: bool = True,
289
+ ):
290
+ """
291
+ Register the provided toolkit wrapper class, instantiating an object of it.
292
+
293
+ .. warning :: This API is experimental and subject to change.
294
+
295
+ .. todo ::
296
+
297
+ This method should raise an exception if the toolkit is unavailable, unless an optional argument
298
+ is specified that silently avoids registration of toolkits that are unavailable.
299
+
300
+ Parameters
301
+ ----------
302
+ toolkit_wrapper
303
+ The toolkit wrapper to register or its class.
304
+ exception_if_unavailable
305
+ If True, an exception will be raised if the toolkit is unavailable
306
+
307
+ """
308
+ # Instantiate class if class, or just add if already instantiated.
309
+ if isinstance(toolkit_wrapper, ToolkitWrapper):
310
+ self._toolkits.append(toolkit_wrapper)
311
+
312
+ elif issubclass(toolkit_wrapper, ToolkitWrapper):
313
+ try:
314
+ _toolkit_wrapper = toolkit_wrapper()
315
+
316
+ # This exception can be raised by OpenEyeToolkitWrapper
317
+ except LicenseError as license_exception:
318
+ if exception_if_unavailable:
319
+ raise ToolkitUnavailableException(license_exception.msg)
320
+ else:
321
+ logger.warning(license_exception)
322
+ return
323
+ except ToolkitUnavailableException:
324
+ if exception_if_unavailable:
325
+ raise ToolkitUnavailableException(f"Unable to load toolkit '{toolkit_wrapper}'. ")
326
+ return
327
+
328
+ self._toolkits.append(_toolkit_wrapper)
329
+
330
+ else:
331
+ raise ValueError(f"Given unexpected argument {type(toolkit_wrapper)=}")
332
+
333
+ def deregister_toolkit(self, toolkit_wrapper: ToolkitWrapper):
334
+ """
335
+ Remove a ToolkitWrapper from the list of toolkits in this ToolkitRegistry
336
+
337
+ .. warning :: This API is experimental and subject to change.
338
+
339
+ Parameters
340
+ ----------
341
+ toolkit_wrapper
342
+ The toolkit wrapper to remove from the registry
343
+
344
+ Raises
345
+ ------
346
+ InvalidToolkitError
347
+ If toolkit_wrapper is not a ToolkitWrapper or subclass
348
+ ToolkitUnavailableException
349
+ If toolkit_wrapper is not found in the registry
350
+ """
351
+ # If passed a class, instantiate it
352
+ if inspect.isclass(toolkit_wrapper):
353
+ toolkit_wrapper = toolkit_wrapper()
354
+
355
+ if not isinstance(toolkit_wrapper, ToolkitWrapper):
356
+ msg = (
357
+ f"Argument {toolkit_wrapper} must an ToolkitWrapper "
358
+ f"or subclass of it. Found type {type(toolkit_wrapper)}."
359
+ )
360
+ raise InvalidToolkitError(msg)
361
+
362
+ toolkits_to_remove = []
363
+
364
+ for toolkit in self._toolkits:
365
+ if type(toolkit) is type(toolkit_wrapper):
366
+ toolkits_to_remove.append(toolkit)
367
+
368
+ if not toolkits_to_remove:
369
+ msg = f"Did not find {toolkit_wrapper} in registry. Currently registered toolkits are {self._toolkits}"
370
+ raise ToolkitUnavailableException(msg)
371
+
372
+ for toolkit_to_remove in toolkits_to_remove:
373
+ self._toolkits.remove(toolkit_to_remove)
374
+
375
+ def add_toolkit(self, toolkit_wrapper: ToolkitWrapper):
376
+ """
377
+ Append a ToolkitWrapper onto the list of toolkits in this ToolkitRegistry
378
+
379
+ .. warning :: This API is experimental and subject to change.
380
+
381
+ Parameters
382
+ ----------
383
+ toolkit_wrapper
384
+ The ToolkitWrapper object to add to the list of registered toolkits
385
+
386
+ Raises
387
+ ------
388
+ InvalidToolkitError
389
+ If toolkit_wrapper is not a ToolkitWrapper or subclass
390
+ """
391
+ if not isinstance(toolkit_wrapper, ToolkitWrapper):
392
+ raise InvalidToolkitError(
393
+ "Something other than a ToolkitWrapper object was passed to ToolkitRegistry.add_toolkit()\n"
394
+ f"Given object {toolkit_wrapper} of type {type(toolkit_wrapper)}"
395
+ )
396
+
397
+ self._toolkits.append(toolkit_wrapper)
398
+
399
+ # TODO: Can we automatically resolve calls to methods that are not explicitly defined using some Python magic?
400
+
401
+ def resolve(self, method_name: str) -> Callable:
402
+ """
403
+ Get a method with the given name from the first registered toolkit that provides it.
404
+
405
+ Resolve the requested method name by checking all registered toolkits in
406
+ order of precedence for one that provides the requested method. Note
407
+ that this may not be the method used by :py:meth:`call` if the
408
+ ``raise_exception_types`` argument is passed.
409
+
410
+
411
+ Parameters
412
+ ----------
413
+ method_name
414
+ The name of the method to resolve
415
+
416
+ Returns
417
+ -------
418
+ method
419
+ The method of the first registered toolkit that provides the
420
+ requested method name
421
+
422
+ Raises
423
+ ------
424
+ NotImplementedError
425
+ if the requested method cannot be found among the registered toolkits
426
+
427
+ Examples
428
+ --------
429
+
430
+ Create a molecule, and call the toolkit ``to_smiles()`` method directly
431
+
432
+ >>> from openff.toolkit import Molecule
433
+ >>> molecule = Molecule.from_smiles('Cc1ccccc1')
434
+ >>> toolkit_registry = ToolkitRegistry([
435
+ ... OpenEyeToolkitWrapper,
436
+ ... RDKitToolkitWrapper,
437
+ ... AmberToolsToolkitWrapper
438
+ ... ])
439
+ >>> method = toolkit_registry.resolve('to_smiles')
440
+ >>> smiles = method(molecule)
441
+
442
+ .. todo :: Is there a better way to figure out which toolkits implement given methods by introspection?
443
+
444
+ """
445
+ for toolkit in self._toolkits:
446
+ if hasattr(toolkit, method_name):
447
+ method = getattr(toolkit, method_name)
448
+ return method
449
+
450
+ # No toolkit was found to provide the requested capability
451
+ # TODO: Can we help developers by providing a check for typos in expected method names?
452
+ raise NotImplementedError(
453
+ f'No registered toolkits can provide the capability "{method_name}".\n'
454
+ f"Available toolkits are: {self.registered_toolkits}\n"
455
+ )
456
+
457
+
458
+ # Copied from https://github.com/openforcefield/openff-fragmenter/blob/4a290b866a8ed43eabcbd3231c62b01f0c6d7df6
459
+ # /openff/fragmenter/utils.py#L97-L123
460
+ @contextmanager
461
+ def toolkit_registry_manager(toolkit_registry: ToolkitRegistry | ToolkitWrapper):
462
+ """
463
+ A context manager that temporarily changes the :py:data:`GLOBAL_TOOLKIT_REGISTRY`.
464
+
465
+ This can be useful in cases where one would otherwise need to otherwise
466
+ manually specify the use of a specific :py:class:`ToolkitWrapper` or
467
+ :py:class:`ToolkitRegistry` repeatedly in a block of code, or in cases where
468
+ there isn't another way to switch the ``ToolkitWrapper`` used for a
469
+ particular operation.
470
+
471
+ Examples
472
+ --------
473
+ >>> from openff.toolkit import Molecule, RDKitToolkitWrapper, AmberToolsToolkitWrapper
474
+ >>> from openff.toolkit.utils import toolkit_registry_manager, ToolkitRegistry
475
+ >>> mol = Molecule.from_smiles("CCO")
476
+ >>> print(mol.to_smiles()) # This will use the OpenEye backend (if installed and licensed)
477
+ [H]C([H])([H])C([H])([H])O[H]
478
+ >>> with toolkit_registry_manager(ToolkitRegistry([RDKitToolkitWrapper()])):
479
+ ... print(mol.to_smiles())
480
+ [H][O][C]([H])([H])[C]([H])([H])[H]
481
+
482
+ """
483
+ from openff.toolkit.utils.toolkits import GLOBAL_TOOLKIT_REGISTRY
484
+
485
+ if isinstance(toolkit_registry, ToolkitRegistry):
486
+ context_toolkits = toolkit_registry.registered_toolkits
487
+ elif isinstance(toolkit_registry, ToolkitWrapper):
488
+ context_toolkits = [toolkit_registry]
489
+ else:
490
+ raise NotImplementedError("Only ``ToolkitRegistry`` and ``ToolkitWrapper`` are supported.")
491
+
492
+ original_toolkits = GLOBAL_TOOLKIT_REGISTRY.registered_toolkits
493
+
494
+ for toolkit in original_toolkits:
495
+ GLOBAL_TOOLKIT_REGISTRY.deregister_toolkit(toolkit)
496
+
497
+ for toolkit in context_toolkits:
498
+ GLOBAL_TOOLKIT_REGISTRY.register_toolkit(toolkit)
499
+
500
+ try:
501
+ yield
502
+ finally:
503
+ for toolkit in context_toolkits:
504
+ GLOBAL_TOOLKIT_REGISTRY.deregister_toolkit(toolkit)
505
+ for toolkit in original_toolkits:
506
+ GLOBAL_TOOLKIT_REGISTRY.register_toolkit(toolkit)
507
+
508
+
509
+ _toolkit_registry_manager = toolkit_registry_manager